1 /******************************************************************************
2 *
3 * Module Name: tbinstal - ACPI table installation and removal
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2004, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44
45 #include <acpi/acpi.h>
46 #include <acpi/actables.h>
47
48
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME ("tbinstal")
51
52
53 /*******************************************************************************
54 *
55 * FUNCTION: acpi_tb_match_signature
56 *
57 * PARAMETERS: Signature - Table signature to match
58 * table_info - Return data
59 *
60 * RETURN: Status
61 *
62 * DESCRIPTION: Compare signature against the list of "ACPI-subsystem-owned"
63 * tables (DSDT/FADT/SSDT, etc.) Returns the table_type_iD on match.
64 *
65 ******************************************************************************/
66
67 acpi_status
acpi_tb_match_signature(char * signature,struct acpi_table_desc * table_info,u8 search_type)68 acpi_tb_match_signature (
69 char *signature,
70 struct acpi_table_desc *table_info,
71 u8 search_type)
72 {
73 acpi_native_uint i;
74
75
76 ACPI_FUNCTION_TRACE ("tb_match_signature");
77
78
79 /*
80 * Search for a signature match among the known table types
81 */
82 for (i = 0; i < NUM_ACPI_TABLE_TYPES; i++) {
83 if (!(acpi_gbl_table_data[i].flags & search_type)) {
84 continue;
85 }
86
87 if (!ACPI_STRNCMP (signature, acpi_gbl_table_data[i].signature,
88 acpi_gbl_table_data[i].sig_length)) {
89 /* Found a signature match, return index if requested */
90
91 if (table_info) {
92 table_info->type = (u8) i;
93 }
94
95 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
96 "Table [%4.4s] is an ACPI table consumed by the core subsystem\n",
97 (char *) acpi_gbl_table_data[i].signature));
98
99 return_ACPI_STATUS (AE_OK);
100 }
101 }
102
103 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
104 "Table [%4.4s] is not an ACPI table consumed by the core subsystem - ignored\n",
105 (char *) signature));
106
107 return_ACPI_STATUS (AE_TABLE_NOT_SUPPORTED);
108 }
109
110
111 /*******************************************************************************
112 *
113 * FUNCTION: acpi_tb_install_table
114 *
115 * PARAMETERS: table_info - Return value from acpi_tb_get_table_body
116 *
117 * RETURN: Status
118 *
119 * DESCRIPTION: Load and validate all tables other than the RSDT. The RSDT must
120 * already be loaded and validated.
121 * Install the table into the global data structs.
122 *
123 ******************************************************************************/
124
125 acpi_status
acpi_tb_install_table(struct acpi_table_desc * table_info)126 acpi_tb_install_table (
127 struct acpi_table_desc *table_info)
128 {
129 acpi_status status;
130
131 ACPI_FUNCTION_TRACE ("tb_install_table");
132
133
134 /* Lock tables while installing */
135
136 status = acpi_ut_acquire_mutex (ACPI_MTX_TABLES);
137 if (ACPI_FAILURE (status)) {
138 ACPI_REPORT_ERROR (("Could not acquire table mutex for [%4.4s], %s\n",
139 table_info->pointer->signature, acpi_format_exception (status)));
140 return_ACPI_STATUS (status);
141 }
142
143 /* Install the table into the global data structure */
144
145 status = acpi_tb_init_table_descriptor (table_info->type, table_info);
146 if (ACPI_FAILURE (status)) {
147 ACPI_REPORT_ERROR (("Could not install ACPI table [%4.4s], %s\n",
148 table_info->pointer->signature, acpi_format_exception (status)));
149 }
150
151 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "%s located at %p\n",
152 acpi_gbl_table_data[table_info->type].name, table_info->pointer));
153
154 (void) acpi_ut_release_mutex (ACPI_MTX_TABLES);
155 return_ACPI_STATUS (status);
156 }
157
158
159 /*******************************************************************************
160 *
161 * FUNCTION: acpi_tb_recognize_table
162 *
163 * PARAMETERS: table_info - Return value from acpi_tb_get_table_body
164 *
165 * RETURN: Status
166 *
167 * DESCRIPTION: Check a table signature for a match against known table types
168 *
169 * NOTE: All table pointers are validated as follows:
170 * 1) Table pointer must point to valid physical memory
171 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
172 * name
173 * 3) Table must be readable for length specified in the header
174 * 4) Table checksum must be valid (with the exception of the FACS
175 * which has no checksum for some odd reason)
176 *
177 ******************************************************************************/
178
179 acpi_status
acpi_tb_recognize_table(struct acpi_table_desc * table_info,u8 search_type)180 acpi_tb_recognize_table (
181 struct acpi_table_desc *table_info,
182 u8 search_type)
183 {
184 struct acpi_table_header *table_header;
185 acpi_status status;
186
187
188 ACPI_FUNCTION_TRACE ("tb_recognize_table");
189
190
191 /* Ensure that we have a valid table pointer */
192
193 table_header = (struct acpi_table_header *) table_info->pointer;
194 if (!table_header) {
195 return_ACPI_STATUS (AE_BAD_PARAMETER);
196 }
197
198 /*
199 * We only "recognize" a limited number of ACPI tables -- namely, the
200 * ones that are used by the subsystem (DSDT, FADT, etc.)
201 *
202 * An AE_TABLE_NOT_SUPPORTED means that the table was not recognized.
203 * This can be any one of many valid ACPI tables, it just isn't one of
204 * the tables that is consumed by the core subsystem
205 */
206 status = acpi_tb_match_signature (table_header->signature, table_info, search_type);
207 if (ACPI_FAILURE (status)) {
208 return_ACPI_STATUS (status);
209 }
210
211 status = acpi_tb_validate_table_header (table_header);
212 if (ACPI_FAILURE (status)) {
213 return_ACPI_STATUS (status);
214 }
215
216 /* Return the table type and length via the info struct */
217
218 table_info->length = (acpi_size) table_header->length;
219
220 return_ACPI_STATUS (status);
221 }
222
223
224 /*******************************************************************************
225 *
226 * FUNCTION: acpi_tb_init_table_descriptor
227 *
228 * PARAMETERS: table_type - The type of the table
229 * table_info - A table info struct
230 *
231 * RETURN: None.
232 *
233 * DESCRIPTION: Install a table into the global data structs.
234 *
235 ******************************************************************************/
236
237 acpi_status
acpi_tb_init_table_descriptor(acpi_table_type table_type,struct acpi_table_desc * table_info)238 acpi_tb_init_table_descriptor (
239 acpi_table_type table_type,
240 struct acpi_table_desc *table_info)
241 {
242 struct acpi_table_list *list_head;
243 struct acpi_table_desc *table_desc;
244
245
246 ACPI_FUNCTION_TRACE_U32 ("tb_init_table_descriptor", table_type);
247
248
249 /* Allocate a descriptor for this table */
250
251 table_desc = ACPI_MEM_CALLOCATE (sizeof (struct acpi_table_desc));
252 if (!table_desc) {
253 return_ACPI_STATUS (AE_NO_MEMORY);
254 }
255
256 /*
257 * Install the table into the global data structure
258 */
259 list_head = &acpi_gbl_table_lists[table_type];
260
261 /*
262 * Two major types of tables: 1) Only one instance is allowed. This
263 * includes most ACPI tables such as the DSDT. 2) Multiple instances of
264 * the table are allowed. This includes SSDT and PSDTs.
265 */
266 if (ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags)) {
267 /*
268 * Only one table allowed, and a table has alread been installed
269 * at this location, so return an error.
270 */
271 if (list_head->next) {
272 return_ACPI_STATUS (AE_ALREADY_EXISTS);
273 }
274
275 table_desc->next = list_head->next;
276 list_head->next = table_desc;
277
278 if (table_desc->next) {
279 table_desc->next->prev = table_desc;
280 }
281
282 list_head->count++;
283 }
284 else {
285 /*
286 * Link the new table in to the list of tables of this type.
287 * Insert at the end of the list, order IS IMPORTANT.
288 *
289 * table_desc->Prev & Next are already NULL from calloc()
290 */
291 list_head->count++;
292
293 if (!list_head->next) {
294 list_head->next = table_desc;
295 }
296 else {
297 table_desc->next = list_head->next;
298
299 while (table_desc->next->next) {
300 table_desc->next = table_desc->next->next;
301 }
302
303 table_desc->next->next = table_desc;
304 table_desc->prev = table_desc->next;
305 table_desc->next = NULL;
306 }
307 }
308
309 /* Finish initialization of the table descriptor */
310
311 table_desc->type = (u8) table_type;
312 table_desc->pointer = table_info->pointer;
313 table_desc->length = table_info->length;
314 table_desc->allocation = table_info->allocation;
315 table_desc->aml_start = (u8 *) (table_desc->pointer + 1),
316 table_desc->aml_length = (u32) (table_desc->length -
317 (u32) sizeof (struct acpi_table_header));
318 table_desc->table_id = acpi_ut_allocate_owner_id (ACPI_OWNER_TYPE_TABLE);
319 table_desc->loaded_into_namespace = FALSE;
320
321 /*
322 * Set the appropriate global pointer (if there is one) to point to the
323 * newly installed table
324 */
325 if (acpi_gbl_table_data[table_type].global_ptr) {
326 *(acpi_gbl_table_data[table_type].global_ptr) = table_info->pointer;
327 }
328
329 /* Return Data */
330
331 table_info->table_id = table_desc->table_id;
332 table_info->installed_desc = table_desc;
333
334 return_ACPI_STATUS (AE_OK);
335 }
336
337
338 /*******************************************************************************
339 *
340 * FUNCTION: acpi_tb_delete_all_tables
341 *
342 * PARAMETERS: None.
343 *
344 * RETURN: None.
345 *
346 * DESCRIPTION: Delete all internal ACPI tables
347 *
348 ******************************************************************************/
349
350 void
acpi_tb_delete_all_tables(void)351 acpi_tb_delete_all_tables (void)
352 {
353 acpi_table_type type;
354
355
356 /*
357 * Free memory allocated for ACPI tables
358 * Memory can either be mapped or allocated
359 */
360 for (type = 0; type < NUM_ACPI_TABLE_TYPES; type++) {
361 acpi_tb_delete_tables_by_type (type);
362 }
363 }
364
365
366 /*******************************************************************************
367 *
368 * FUNCTION: acpi_tb_delete_tables_by_type
369 *
370 * PARAMETERS: Type - The table type to be deleted
371 *
372 * RETURN: None.
373 *
374 * DESCRIPTION: Delete an internal ACPI table
375 * Locks the ACPI table mutex
376 *
377 ******************************************************************************/
378
379 void
acpi_tb_delete_tables_by_type(acpi_table_type type)380 acpi_tb_delete_tables_by_type (
381 acpi_table_type type)
382 {
383 struct acpi_table_desc *table_desc;
384 u32 count;
385 u32 i;
386
387
388 ACPI_FUNCTION_TRACE_U32 ("tb_delete_tables_by_type", type);
389
390
391 if (type > ACPI_TABLE_MAX) {
392 return_VOID;
393 }
394
395 if (ACPI_FAILURE (acpi_ut_acquire_mutex (ACPI_MTX_TABLES))) {
396 return;
397 }
398
399 /* Clear the appropriate "typed" global table pointer */
400
401 switch (type) {
402 case ACPI_TABLE_RSDP:
403 acpi_gbl_RSDP = NULL;
404 break;
405
406 case ACPI_TABLE_DSDT:
407 acpi_gbl_DSDT = NULL;
408 break;
409
410 case ACPI_TABLE_FADT:
411 acpi_gbl_FADT = NULL;
412 break;
413
414 case ACPI_TABLE_FACS:
415 acpi_gbl_FACS = NULL;
416 break;
417
418 case ACPI_TABLE_XSDT:
419 acpi_gbl_XSDT = NULL;
420 break;
421
422 case ACPI_TABLE_SSDT:
423 case ACPI_TABLE_PSDT:
424 default:
425 break;
426 }
427
428 /*
429 * Free the table
430 * 1) Get the head of the list
431 */
432 table_desc = acpi_gbl_table_lists[type].next;
433 count = acpi_gbl_table_lists[type].count;
434
435 /*
436 * 2) Walk the entire list, deleting both the allocated tables
437 * and the table descriptors
438 */
439 for (i = 0; i < count; i++) {
440 table_desc = acpi_tb_uninstall_table (table_desc);
441 }
442
443 (void) acpi_ut_release_mutex (ACPI_MTX_TABLES);
444 return_VOID;
445 }
446
447
448 /*******************************************************************************
449 *
450 * FUNCTION: acpi_tb_delete_single_table
451 *
452 * PARAMETERS: table_info - A table info struct
453 *
454 * RETURN: None.
455 *
456 * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where
457 * the table was allocated a buffer or was mapped.
458 *
459 ******************************************************************************/
460
461 void
acpi_tb_delete_single_table(struct acpi_table_desc * table_desc)462 acpi_tb_delete_single_table (
463 struct acpi_table_desc *table_desc)
464 {
465
466 /* Must have a valid table descriptor and pointer */
467
468 if ((!table_desc) ||
469 (!table_desc->pointer)) {
470 return;
471 }
472
473 /* Valid table, determine type of memory allocation */
474
475 switch (table_desc->allocation) {
476 case ACPI_MEM_NOT_ALLOCATED:
477 break;
478
479 case ACPI_MEM_ALLOCATED:
480
481 ACPI_MEM_FREE (table_desc->pointer);
482 break;
483
484 case ACPI_MEM_MAPPED:
485
486 acpi_os_unmap_memory (table_desc->pointer, table_desc->length);
487 break;
488
489 default:
490 break;
491 }
492 }
493
494
495 /*******************************************************************************
496 *
497 * FUNCTION: acpi_tb_uninstall_table
498 *
499 * PARAMETERS: table_info - A table info struct
500 *
501 * RETURN: Pointer to the next table in the list (of same type)
502 *
503 * DESCRIPTION: Free the memory associated with an internal ACPI table that
504 * is either installed or has never been installed.
505 * Table mutex should be locked.
506 *
507 ******************************************************************************/
508
509 struct acpi_table_desc *
acpi_tb_uninstall_table(struct acpi_table_desc * table_desc)510 acpi_tb_uninstall_table (
511 struct acpi_table_desc *table_desc)
512 {
513 struct acpi_table_desc *next_desc;
514
515
516 ACPI_FUNCTION_TRACE_PTR ("tb_uninstall_table", table_desc);
517
518
519 if (!table_desc) {
520 return_PTR (NULL);
521 }
522
523 /* Unlink the descriptor from the doubly linked list */
524
525 if (table_desc->prev) {
526 table_desc->prev->next = table_desc->next;
527 }
528 else {
529 /* Is first on list, update list head */
530
531 acpi_gbl_table_lists[table_desc->type].next = table_desc->next;
532 }
533
534 if (table_desc->next) {
535 table_desc->next->prev = table_desc->prev;
536 }
537
538 /* Free the memory allocated for the table itself */
539
540 acpi_tb_delete_single_table (table_desc);
541
542 /* Free the table descriptor */
543
544 next_desc = table_desc->next;
545 ACPI_MEM_FREE (table_desc);
546
547 /* Return pointer to the next descriptor */
548
549 return_PTR (next_desc);
550 }
551
552
553