1 /******************************************************************************
3 * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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();
124 * Update GPEs for any new _Lxx/_Exx methods. Ignore errors. The host is
125 * responsible for discovering any new wake GPEs by running _PRW methods
126 * that may have been loaded by this table.
128 status
= acpi_tb_get_owner_id(table_index
, &owner_id
);
129 if (ACPI_SUCCESS(status
)) {
130 acpi_ev_update_gpes(owner_id
);
133 return_ACPI_STATUS(AE_OK
);
136 /*******************************************************************************
138 * FUNCTION: acpi_ex_load_table_op
140 * PARAMETERS: walk_state - Current state with operands
141 * return_desc - Where to store the return object
145 * DESCRIPTION: Load an ACPI table from the RSDT/XSDT
147 ******************************************************************************/
150 acpi_ex_load_table_op(struct acpi_walk_state
*walk_state
,
151 union acpi_operand_object
**return_desc
)
154 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
155 struct acpi_namespace_node
*parent_node
;
156 struct acpi_namespace_node
*start_node
;
157 struct acpi_namespace_node
*parameter_node
= NULL
;
158 union acpi_operand_object
*ddb_handle
;
159 struct acpi_table_header
*table
;
162 ACPI_FUNCTION_TRACE(ex_load_table_op
);
164 /* Validate lengths for the Signature, oem_id, and oem_table_id strings */
166 if ((operand
[0]->string
.length
> ACPI_NAME_SIZE
) ||
167 (operand
[1]->string
.length
> ACPI_OEM_ID_SIZE
) ||
168 (operand
[2]->string
.length
> ACPI_OEM_TABLE_ID_SIZE
)) {
169 return_ACPI_STATUS(AE_BAD_PARAMETER
);
172 /* Find the ACPI table in the RSDT/XSDT */
174 status
= acpi_tb_find_table(operand
[0]->string
.pointer
,
175 operand
[1]->string
.pointer
,
176 operand
[2]->string
.pointer
, &table_index
);
177 if (ACPI_FAILURE(status
)) {
178 if (status
!= AE_NOT_FOUND
) {
179 return_ACPI_STATUS(status
);
182 /* Table not found, return an Integer=0 and AE_OK */
184 ddb_handle
= acpi_ut_create_integer_object((u64
) 0);
186 return_ACPI_STATUS(AE_NO_MEMORY
);
189 *return_desc
= ddb_handle
;
190 return_ACPI_STATUS(AE_OK
);
195 start_node
= walk_state
->scope_info
->scope
.node
;
196 parent_node
= acpi_gbl_root_node
;
198 /* root_path (optional parameter) */
200 if (operand
[3]->string
.length
> 0) {
202 * Find the node referenced by the root_path_string. This is the
203 * location within the namespace where the table will be loaded.
206 acpi_ns_get_node(start_node
, operand
[3]->string
.pointer
,
207 ACPI_NS_SEARCH_PARENT
, &parent_node
);
208 if (ACPI_FAILURE(status
)) {
209 return_ACPI_STATUS(status
);
213 /* parameter_path (optional parameter) */
215 if (operand
[4]->string
.length
> 0) {
216 if ((operand
[4]->string
.pointer
[0] != '\\') &&
217 (operand
[4]->string
.pointer
[0] != '^')) {
219 * Path is not absolute, so it will be relative to the node
220 * referenced by the root_path_string (or the NS root if omitted)
222 start_node
= parent_node
;
225 /* Find the node referenced by the parameter_path_string */
228 acpi_ns_get_node(start_node
, operand
[4]->string
.pointer
,
229 ACPI_NS_SEARCH_PARENT
, ¶meter_node
);
230 if (ACPI_FAILURE(status
)) {
231 return_ACPI_STATUS(status
);
235 /* Load the table into the namespace */
237 status
= acpi_ex_add_table(table_index
, parent_node
, &ddb_handle
);
238 if (ACPI_FAILURE(status
)) {
239 return_ACPI_STATUS(status
);
242 /* Parameter Data (optional) */
244 if (parameter_node
) {
246 /* Store the parameter data into the optional parameter object */
248 status
= acpi_ex_store(operand
[5],
249 ACPI_CAST_PTR(union acpi_operand_object
,
252 if (ACPI_FAILURE(status
)) {
253 (void)acpi_ex_unload_table(ddb_handle
);
255 acpi_ut_remove_reference(ddb_handle
);
256 return_ACPI_STATUS(status
);
260 status
= acpi_get_table_by_index(table_index
, &table
);
261 if (ACPI_SUCCESS(status
)) {
262 ACPI_INFO((AE_INFO
, "Dynamic OEM Table Load:"));
263 acpi_tb_print_table_header(0, table
);
266 /* Invoke table handler if present */
268 if (acpi_gbl_table_handler
) {
269 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
, table
,
270 acpi_gbl_table_handler_context
);
273 *return_desc
= ddb_handle
;
274 return_ACPI_STATUS(status
);
277 /*******************************************************************************
279 * FUNCTION: acpi_ex_region_read
281 * PARAMETERS: obj_desc - Region descriptor
282 * length - Number of bytes to read
283 * buffer - Pointer to where to put the data
287 * DESCRIPTION: Read data from an operation region. The read starts from the
288 * beginning of the region.
290 ******************************************************************************/
293 acpi_ex_region_read(union acpi_operand_object
*obj_desc
, u32 length
, u8
*buffer
)
297 u32 region_offset
= 0;
302 for (i
= 0; i
< length
; i
++) {
304 acpi_ev_address_space_dispatch(obj_desc
, NULL
, ACPI_READ
,
305 region_offset
, 8, &value
);
306 if (ACPI_FAILURE(status
)) {
318 /*******************************************************************************
320 * FUNCTION: acpi_ex_load_op
322 * PARAMETERS: obj_desc - Region or Buffer/Field where the table will be
324 * target - Where a handle to the table will be stored
325 * walk_state - Current state
329 * DESCRIPTION: Load an ACPI table from a field or operation region
331 * NOTE: Region Fields (Field, bank_field, index_fields) are resolved to buffer
332 * objects before this code is reached.
334 * If source is an operation region, it must refer to system_memory, as
335 * per the ACPI specification.
337 ******************************************************************************/
340 acpi_ex_load_op(union acpi_operand_object
*obj_desc
,
341 union acpi_operand_object
*target
,
342 struct acpi_walk_state
*walk_state
)
344 union acpi_operand_object
*ddb_handle
;
345 struct acpi_table_header
*table
;
346 struct acpi_table_desc table_desc
;
351 ACPI_FUNCTION_TRACE(ex_load_op
);
353 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
355 /* Source Object can be either an op_region or a Buffer/Field */
357 switch (obj_desc
->common
.type
) {
358 case ACPI_TYPE_REGION
:
360 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
361 "Load table from Region %p\n", obj_desc
));
363 /* Region must be system_memory (from ACPI spec) */
365 if (obj_desc
->region
.space_id
!= ACPI_ADR_SPACE_SYSTEM_MEMORY
) {
366 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
370 * If the Region Address and Length have not been previously evaluated,
371 * evaluate them now and save the results.
373 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
374 status
= acpi_ds_get_region_arguments(obj_desc
);
375 if (ACPI_FAILURE(status
)) {
376 return_ACPI_STATUS(status
);
380 /* Get the table header first so we can get the table length */
382 table
= ACPI_ALLOCATE(sizeof(struct acpi_table_header
));
384 return_ACPI_STATUS(AE_NO_MEMORY
);
388 acpi_ex_region_read(obj_desc
,
389 sizeof(struct acpi_table_header
),
390 ACPI_CAST_PTR(u8
, table
));
391 length
= table
->length
;
394 if (ACPI_FAILURE(status
)) {
395 return_ACPI_STATUS(status
);
398 /* Must have at least an ACPI table header */
400 if (length
< sizeof(struct acpi_table_header
)) {
401 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
405 * The original implementation simply mapped the table, with no copy.
406 * However, the memory region is not guaranteed to remain stable and
407 * we must copy the table to a local buffer. For example, the memory
408 * region is corrupted after suspend on some machines. Dynamically
409 * loaded tables are usually small, so this overhead is minimal.
411 * The latest implementation (5/2009) does not use a mapping at all.
412 * We use the low-level operation region interface to read the table
413 * instead of the obvious optimization of using a direct mapping.
414 * This maintains a consistent use of operation regions across the
415 * entire subsystem. This is important if additional processing must
416 * be performed in the (possibly user-installed) operation region
417 * handler. For example, acpi_exec and ASLTS depend on this.
420 /* Allocate a buffer for the table */
422 table_desc
.pointer
= ACPI_ALLOCATE(length
);
423 if (!table_desc
.pointer
) {
424 return_ACPI_STATUS(AE_NO_MEMORY
);
427 /* Read the entire table */
429 status
= acpi_ex_region_read(obj_desc
, length
,
431 table_desc
.pointer
));
432 if (ACPI_FAILURE(status
)) {
433 ACPI_FREE(table_desc
.pointer
);
434 return_ACPI_STATUS(status
);
437 table_desc
.address
= obj_desc
->region
.address
;
440 case ACPI_TYPE_BUFFER
: /* Buffer or resolved region_field */
442 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
443 "Load table from Buffer or Field %p\n",
446 /* Must have at least an ACPI table header */
448 if (obj_desc
->buffer
.length
< sizeof(struct acpi_table_header
)) {
449 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
452 /* Get the actual table length from the table header */
455 ACPI_CAST_PTR(struct acpi_table_header
,
456 obj_desc
->buffer
.pointer
);
457 length
= table
->length
;
459 /* Table cannot extend beyond the buffer */
461 if (length
> obj_desc
->buffer
.length
) {
462 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT
);
464 if (length
< sizeof(struct acpi_table_header
)) {
465 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
469 * Copy the table from the buffer because the buffer could be modified
470 * or even deleted in the future
472 table_desc
.pointer
= ACPI_ALLOCATE(length
);
473 if (!table_desc
.pointer
) {
474 return_ACPI_STATUS(AE_NO_MEMORY
);
477 ACPI_MEMCPY(table_desc
.pointer
, table
, length
);
478 table_desc
.address
= ACPI_TO_INTEGER(table_desc
.pointer
);
482 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
485 /* Validate table checksum (will not get validated in tb_add_table) */
487 status
= acpi_tb_verify_checksum(table_desc
.pointer
, length
);
488 if (ACPI_FAILURE(status
)) {
489 ACPI_FREE(table_desc
.pointer
);
490 return_ACPI_STATUS(status
);
493 /* Complete the table descriptor */
495 table_desc
.length
= length
;
496 table_desc
.flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
498 /* Install the new table into the local data structures */
500 status
= acpi_tb_add_table(&table_desc
, &table_index
);
501 if (ACPI_FAILURE(status
)) {
503 /* Delete allocated table buffer */
505 acpi_tb_delete_table(&table_desc
);
506 return_ACPI_STATUS(status
);
510 * Add the table to the namespace.
512 * Note: Load the table objects relative to the root of the namespace.
513 * This appears to go against the ACPI specification, but we do it for
514 * compatibility with other ACPI implementations.
517 acpi_ex_add_table(table_index
, acpi_gbl_root_node
, &ddb_handle
);
518 if (ACPI_FAILURE(status
)) {
520 /* On error, table_ptr was deallocated above */
522 return_ACPI_STATUS(status
);
525 /* Store the ddb_handle into the Target operand */
527 status
= acpi_ex_store(ddb_handle
, target
, walk_state
);
528 if (ACPI_FAILURE(status
)) {
529 (void)acpi_ex_unload_table(ddb_handle
);
531 /* table_ptr was deallocated above */
533 acpi_ut_remove_reference(ddb_handle
);
534 return_ACPI_STATUS(status
);
537 ACPI_INFO((AE_INFO
, "Dynamic OEM Table Load:"));
538 acpi_tb_print_table_header(0, table_desc
.pointer
);
540 /* Remove the reference by added by acpi_ex_store above */
542 acpi_ut_remove_reference(ddb_handle
);
544 /* Invoke table handler if present */
546 if (acpi_gbl_table_handler
) {
547 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
,
549 acpi_gbl_table_handler_context
);
552 return_ACPI_STATUS(status
);
555 /*******************************************************************************
557 * FUNCTION: acpi_ex_unload_table
559 * PARAMETERS: ddb_handle - Handle to a previously loaded table
563 * DESCRIPTION: Unload an ACPI table
565 ******************************************************************************/
567 acpi_status
acpi_ex_unload_table(union acpi_operand_object
*ddb_handle
)
569 acpi_status status
= AE_OK
;
570 union acpi_operand_object
*table_desc
= ddb_handle
;
572 struct acpi_table_header
*table
;
574 ACPI_FUNCTION_TRACE(ex_unload_table
);
577 * Validate the handle
578 * Although the handle is partially validated in acpi_ex_reconfiguration()
579 * when it calls acpi_ex_resolve_operands(), the handle is more completely
582 * Handle must be a valid operand object of type reference. Also, the
583 * ddb_handle must still be marked valid (table has not been previously
587 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle
) != ACPI_DESC_TYPE_OPERAND
) ||
588 (ddb_handle
->common
.type
!= ACPI_TYPE_LOCAL_REFERENCE
) ||
589 (!(ddb_handle
->common
.flags
& AOPOBJ_DATA_VALID
))) {
590 return_ACPI_STATUS(AE_BAD_PARAMETER
);
593 /* Get the table index from the ddb_handle */
595 table_index
= table_desc
->reference
.value
;
597 /* Ensure the table is still loaded */
599 if (!acpi_tb_is_table_loaded(table_index
)) {
600 return_ACPI_STATUS(AE_NOT_EXIST
);
603 /* Invoke table handler if present */
605 if (acpi_gbl_table_handler
) {
606 status
= acpi_get_table_by_index(table_index
, &table
);
607 if (ACPI_SUCCESS(status
)) {
608 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_UNLOAD
,
610 acpi_gbl_table_handler_context
);
614 /* Delete the portion of the namespace owned by this table */
616 status
= acpi_tb_delete_namespace_by_owner(table_index
);
617 if (ACPI_FAILURE(status
)) {
618 return_ACPI_STATUS(status
);
621 (void)acpi_tb_release_owner_id(table_index
);
622 acpi_tb_set_table_loaded_flag(table_index
, FALSE
);
625 * Invalidate the handle. We do this because the handle may be stored
626 * in a named object and may not be actually deleted until much later.
628 ddb_handle
->common
.flags
&= ~AOPOBJ_DATA_VALID
;
629 return_ACPI_STATUS(AE_OK
);