1 /******************************************************************************
3 * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME("exconfig")
55 /* Local prototypes */
57 acpi_ex_add_table(u32 table_index
,
58 struct acpi_namespace_node
*parent_node
,
59 union acpi_operand_object
**ddb_handle
);
62 acpi_ex_region_read(union acpi_operand_object
*obj_desc
,
63 u32 length
, u8
*buffer
);
65 /*******************************************************************************
67 * FUNCTION: acpi_ex_add_table
69 * PARAMETERS: Table - Pointer to raw table
70 * parent_node - Where to load the table (scope)
71 * ddb_handle - Where to return the table handle.
75 * DESCRIPTION: Common function to Install and Load an ACPI table with a
76 * returned table handle.
78 ******************************************************************************/
81 acpi_ex_add_table(u32 table_index
,
82 struct acpi_namespace_node
*parent_node
,
83 union acpi_operand_object
**ddb_handle
)
85 union acpi_operand_object
*obj_desc
;
87 acpi_owner_id owner_id
;
89 ACPI_FUNCTION_TRACE(ex_add_table
);
91 /* Create an object to be the table handle */
93 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE
);
95 return_ACPI_STATUS(AE_NO_MEMORY
);
98 /* Init the table handle */
100 obj_desc
->common
.flags
|= AOPOBJ_DATA_VALID
;
101 obj_desc
->reference
.class = ACPI_REFCLASS_TABLE
;
102 *ddb_handle
= obj_desc
;
104 /* Install the new table into the local data structures */
106 obj_desc
->reference
.value
= table_index
;
108 /* Add the table to the namespace */
110 status
= acpi_ns_load_table(table_index
, parent_node
);
111 if (ACPI_FAILURE(status
)) {
112 acpi_ut_remove_reference(obj_desc
);
114 return_ACPI_STATUS(status
);
117 /* Execute any module-level code that was found in the table */
119 acpi_ex_exit_interpreter();
120 acpi_ns_exec_module_code_list();
121 acpi_ex_enter_interpreter();
123 /* Update GPEs for any new _Lxx/_Exx methods. Ignore errors */
125 status
= acpi_tb_get_owner_id(table_index
, &owner_id
);
126 if (ACPI_SUCCESS(status
)) {
127 acpi_ev_update_gpes(owner_id
);
130 return_ACPI_STATUS(AE_OK
);
133 /*******************************************************************************
135 * FUNCTION: acpi_ex_load_table_op
137 * PARAMETERS: walk_state - Current state with operands
138 * return_desc - Where to store the return object
142 * DESCRIPTION: Load an ACPI table from the RSDT/XSDT
144 ******************************************************************************/
147 acpi_ex_load_table_op(struct acpi_walk_state
*walk_state
,
148 union acpi_operand_object
**return_desc
)
151 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
152 struct acpi_namespace_node
*parent_node
;
153 struct acpi_namespace_node
*start_node
;
154 struct acpi_namespace_node
*parameter_node
= NULL
;
155 union acpi_operand_object
*ddb_handle
;
156 struct acpi_table_header
*table
;
159 ACPI_FUNCTION_TRACE(ex_load_table_op
);
161 /* Validate lengths for the signature_string, OEMIDString, OEMtable_iD */
163 if ((operand
[0]->string
.length
> ACPI_NAME_SIZE
) ||
164 (operand
[1]->string
.length
> ACPI_OEM_ID_SIZE
) ||
165 (operand
[2]->string
.length
> ACPI_OEM_TABLE_ID_SIZE
)) {
166 return_ACPI_STATUS(AE_BAD_PARAMETER
);
169 /* Find the ACPI table in the RSDT/XSDT */
171 status
= acpi_tb_find_table(operand
[0]->string
.pointer
,
172 operand
[1]->string
.pointer
,
173 operand
[2]->string
.pointer
, &table_index
);
174 if (ACPI_FAILURE(status
)) {
175 if (status
!= AE_NOT_FOUND
) {
176 return_ACPI_STATUS(status
);
179 /* Table not found, return an Integer=0 and AE_OK */
181 ddb_handle
= acpi_ut_create_integer_object((u64
) 0);
183 return_ACPI_STATUS(AE_NO_MEMORY
);
186 *return_desc
= ddb_handle
;
187 return_ACPI_STATUS(AE_OK
);
192 start_node
= walk_state
->scope_info
->scope
.node
;
193 parent_node
= acpi_gbl_root_node
;
195 /* root_path (optional parameter) */
197 if (operand
[3]->string
.length
> 0) {
199 * Find the node referenced by the root_path_string. This is the
200 * location within the namespace where the table will be loaded.
203 acpi_ns_get_node(start_node
, operand
[3]->string
.pointer
,
204 ACPI_NS_SEARCH_PARENT
, &parent_node
);
205 if (ACPI_FAILURE(status
)) {
206 return_ACPI_STATUS(status
);
210 /* parameter_path (optional parameter) */
212 if (operand
[4]->string
.length
> 0) {
213 if ((operand
[4]->string
.pointer
[0] != '\\') &&
214 (operand
[4]->string
.pointer
[0] != '^')) {
216 * Path is not absolute, so it will be relative to the node
217 * referenced by the root_path_string (or the NS root if omitted)
219 start_node
= parent_node
;
222 /* Find the node referenced by the parameter_path_string */
225 acpi_ns_get_node(start_node
, operand
[4]->string
.pointer
,
226 ACPI_NS_SEARCH_PARENT
, ¶meter_node
);
227 if (ACPI_FAILURE(status
)) {
228 return_ACPI_STATUS(status
);
232 /* Load the table into the namespace */
234 status
= acpi_ex_add_table(table_index
, parent_node
, &ddb_handle
);
235 if (ACPI_FAILURE(status
)) {
236 return_ACPI_STATUS(status
);
239 /* Parameter Data (optional) */
241 if (parameter_node
) {
243 /* Store the parameter data into the optional parameter object */
245 status
= acpi_ex_store(operand
[5],
246 ACPI_CAST_PTR(union acpi_operand_object
,
249 if (ACPI_FAILURE(status
)) {
250 (void)acpi_ex_unload_table(ddb_handle
);
252 acpi_ut_remove_reference(ddb_handle
);
253 return_ACPI_STATUS(status
);
257 status
= acpi_get_table_by_index(table_index
, &table
);
258 if (ACPI_SUCCESS(status
)) {
259 ACPI_INFO((AE_INFO
, "Dynamic OEM Table Load:"));
260 acpi_tb_print_table_header(0, table
);
263 /* Invoke table handler if present */
265 if (acpi_gbl_table_handler
) {
266 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
, table
,
267 acpi_gbl_table_handler_context
);
270 *return_desc
= ddb_handle
;
271 return_ACPI_STATUS(status
);
274 /*******************************************************************************
276 * FUNCTION: acpi_ex_region_read
278 * PARAMETERS: obj_desc - Region descriptor
279 * Length - Number of bytes to read
280 * Buffer - Pointer to where to put the data
284 * DESCRIPTION: Read data from an operation region. The read starts from the
285 * beginning of the region.
287 ******************************************************************************/
290 acpi_ex_region_read(union acpi_operand_object
*obj_desc
, u32 length
, u8
*buffer
)
294 u32 region_offset
= 0;
299 for (i
= 0; i
< length
; i
++) {
300 status
= acpi_ev_address_space_dispatch(obj_desc
, ACPI_READ
,
303 if (ACPI_FAILURE(status
)) {
315 /*******************************************************************************
317 * FUNCTION: acpi_ex_load_op
319 * PARAMETERS: obj_desc - Region or Buffer/Field where the table will be
321 * Target - Where a handle to the table will be stored
322 * walk_state - Current state
326 * DESCRIPTION: Load an ACPI table from a field or operation region
328 * NOTE: Region Fields (Field, bank_field, index_fields) are resolved to buffer
329 * objects before this code is reached.
331 * If source is an operation region, it must refer to system_memory, as
332 * per the ACPI specification.
334 ******************************************************************************/
337 acpi_ex_load_op(union acpi_operand_object
*obj_desc
,
338 union acpi_operand_object
*target
,
339 struct acpi_walk_state
*walk_state
)
341 union acpi_operand_object
*ddb_handle
;
342 struct acpi_table_header
*table
;
343 struct acpi_table_desc table_desc
;
348 ACPI_FUNCTION_TRACE(ex_load_op
);
350 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
352 /* Source Object can be either an op_region or a Buffer/Field */
354 switch (obj_desc
->common
.type
) {
355 case ACPI_TYPE_REGION
:
357 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
358 "Load table from Region %p\n", obj_desc
));
360 /* Region must be system_memory (from ACPI spec) */
362 if (obj_desc
->region
.space_id
!= ACPI_ADR_SPACE_SYSTEM_MEMORY
) {
363 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
367 * If the Region Address and Length have not been previously evaluated,
368 * evaluate them now and save the results.
370 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
371 status
= acpi_ds_get_region_arguments(obj_desc
);
372 if (ACPI_FAILURE(status
)) {
373 return_ACPI_STATUS(status
);
377 /* Get the table header first so we can get the table length */
379 table
= ACPI_ALLOCATE(sizeof(struct acpi_table_header
));
381 return_ACPI_STATUS(AE_NO_MEMORY
);
385 acpi_ex_region_read(obj_desc
,
386 sizeof(struct acpi_table_header
),
387 ACPI_CAST_PTR(u8
, table
));
388 length
= table
->length
;
391 if (ACPI_FAILURE(status
)) {
392 return_ACPI_STATUS(status
);
395 /* Must have at least an ACPI table header */
397 if (length
< sizeof(struct acpi_table_header
)) {
398 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
402 * The original implementation simply mapped the table, with no copy.
403 * However, the memory region is not guaranteed to remain stable and
404 * we must copy the table to a local buffer. For example, the memory
405 * region is corrupted after suspend on some machines. Dynamically
406 * loaded tables are usually small, so this overhead is minimal.
408 * The latest implementation (5/2009) does not use a mapping at all.
409 * We use the low-level operation region interface to read the table
410 * instead of the obvious optimization of using a direct mapping.
411 * This maintains a consistent use of operation regions across the
412 * entire subsystem. This is important if additional processing must
413 * be performed in the (possibly user-installed) operation region
414 * handler. For example, acpi_exec and ASLTS depend on this.
417 /* Allocate a buffer for the table */
419 table_desc
.pointer
= ACPI_ALLOCATE(length
);
420 if (!table_desc
.pointer
) {
421 return_ACPI_STATUS(AE_NO_MEMORY
);
424 /* Read the entire table */
426 status
= acpi_ex_region_read(obj_desc
, length
,
428 table_desc
.pointer
));
429 if (ACPI_FAILURE(status
)) {
430 ACPI_FREE(table_desc
.pointer
);
431 return_ACPI_STATUS(status
);
434 table_desc
.address
= obj_desc
->region
.address
;
437 case ACPI_TYPE_BUFFER
: /* Buffer or resolved region_field */
439 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
440 "Load table from Buffer or Field %p\n",
443 /* Must have at least an ACPI table header */
445 if (obj_desc
->buffer
.length
< sizeof(struct acpi_table_header
)) {
446 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
449 /* Get the actual table length from the table header */
452 ACPI_CAST_PTR(struct acpi_table_header
,
453 obj_desc
->buffer
.pointer
);
454 length
= table
->length
;
456 /* Table cannot extend beyond the buffer */
458 if (length
> obj_desc
->buffer
.length
) {
459 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT
);
461 if (length
< sizeof(struct acpi_table_header
)) {
462 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
466 * Copy the table from the buffer because the buffer could be modified
467 * or even deleted in the future
469 table_desc
.pointer
= ACPI_ALLOCATE(length
);
470 if (!table_desc
.pointer
) {
471 return_ACPI_STATUS(AE_NO_MEMORY
);
474 ACPI_MEMCPY(table_desc
.pointer
, table
, length
);
475 table_desc
.address
= ACPI_TO_INTEGER(table_desc
.pointer
);
479 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
482 /* Validate table checksum (will not get validated in tb_add_table) */
484 status
= acpi_tb_verify_checksum(table_desc
.pointer
, length
);
485 if (ACPI_FAILURE(status
)) {
486 ACPI_FREE(table_desc
.pointer
);
487 return_ACPI_STATUS(status
);
490 /* Complete the table descriptor */
492 table_desc
.length
= length
;
493 table_desc
.flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
495 /* Install the new table into the local data structures */
497 status
= acpi_tb_add_table(&table_desc
, &table_index
);
498 if (ACPI_FAILURE(status
)) {
500 /* Delete allocated table buffer */
502 acpi_tb_delete_table(&table_desc
);
503 return_ACPI_STATUS(status
);
507 * Add the table to the namespace.
509 * Note: Load the table objects relative to the root of the namespace.
510 * This appears to go against the ACPI specification, but we do it for
511 * compatibility with other ACPI implementations.
514 acpi_ex_add_table(table_index
, acpi_gbl_root_node
, &ddb_handle
);
515 if (ACPI_FAILURE(status
)) {
517 /* On error, table_ptr was deallocated above */
519 return_ACPI_STATUS(status
);
522 /* Store the ddb_handle into the Target operand */
524 status
= acpi_ex_store(ddb_handle
, target
, walk_state
);
525 if (ACPI_FAILURE(status
)) {
526 (void)acpi_ex_unload_table(ddb_handle
);
528 /* table_ptr was deallocated above */
530 acpi_ut_remove_reference(ddb_handle
);
531 return_ACPI_STATUS(status
);
534 ACPI_INFO((AE_INFO
, "Dynamic OEM Table Load:"));
535 acpi_tb_print_table_header(0, table_desc
.pointer
);
537 /* Remove the reference by added by acpi_ex_store above */
539 acpi_ut_remove_reference(ddb_handle
);
541 /* Invoke table handler if present */
543 if (acpi_gbl_table_handler
) {
544 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
,
546 acpi_gbl_table_handler_context
);
549 return_ACPI_STATUS(status
);
552 /*******************************************************************************
554 * FUNCTION: acpi_ex_unload_table
556 * PARAMETERS: ddb_handle - Handle to a previously loaded table
560 * DESCRIPTION: Unload an ACPI table
562 ******************************************************************************/
564 acpi_status
acpi_ex_unload_table(union acpi_operand_object
*ddb_handle
)
566 acpi_status status
= AE_OK
;
567 union acpi_operand_object
*table_desc
= ddb_handle
;
569 struct acpi_table_header
*table
;
571 ACPI_FUNCTION_TRACE(ex_unload_table
);
574 * Validate the handle
575 * Although the handle is partially validated in acpi_ex_reconfiguration()
576 * when it calls acpi_ex_resolve_operands(), the handle is more completely
579 * Handle must be a valid operand object of type reference. Also, the
580 * ddb_handle must still be marked valid (table has not been previously
584 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle
) != ACPI_DESC_TYPE_OPERAND
) ||
585 (ddb_handle
->common
.type
!= ACPI_TYPE_LOCAL_REFERENCE
) ||
586 (!(ddb_handle
->common
.flags
& AOPOBJ_DATA_VALID
))) {
587 return_ACPI_STATUS(AE_BAD_PARAMETER
);
590 /* Get the table index from the ddb_handle */
592 table_index
= table_desc
->reference
.value
;
594 /* Ensure the table is still loaded */
596 if (!acpi_tb_is_table_loaded(table_index
)) {
597 return_ACPI_STATUS(AE_NOT_EXIST
);
600 /* Invoke table handler if present */
602 if (acpi_gbl_table_handler
) {
603 status
= acpi_get_table_by_index(table_index
, &table
);
604 if (ACPI_SUCCESS(status
)) {
605 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_UNLOAD
,
607 acpi_gbl_table_handler_context
);
611 /* Delete the portion of the namespace owned by this table */
613 status
= acpi_tb_delete_namespace_by_owner(table_index
);
614 if (ACPI_FAILURE(status
)) {
615 return_ACPI_STATUS(status
);
618 (void)acpi_tb_release_owner_id(table_index
);
619 acpi_tb_set_table_loaded_flag(table_index
, FALSE
);
622 * Invalidate the handle. We do this because the handle may be stored
623 * in a named object and may not be actually deleted until much later.
625 ddb_handle
->common
.flags
&= ~AOPOBJ_DATA_VALID
;
626 return_ACPI_STATUS(AE_OK
);