1 /******************************************************************************
3 * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("exconfig")
54 /* Local prototypes */
56 acpi_ex_add_table(u32 table_index
,
57 struct acpi_namespace_node
*parent_node
,
58 union acpi_operand_object
**ddb_handle
);
60 /*******************************************************************************
62 * FUNCTION: acpi_ex_add_table
64 * PARAMETERS: Table - Pointer to raw table
65 * parent_node - Where to load the table (scope)
66 * ddb_handle - Where to return the table handle.
70 * DESCRIPTION: Common function to Install and Load an ACPI table with a
71 * returned table handle.
73 ******************************************************************************/
76 acpi_ex_add_table(u32 table_index
,
77 struct acpi_namespace_node
*parent_node
,
78 union acpi_operand_object
**ddb_handle
)
81 union acpi_operand_object
*obj_desc
;
83 ACPI_FUNCTION_TRACE(ex_add_table
);
85 /* Create an object to be the table handle */
87 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE
);
89 return_ACPI_STATUS(AE_NO_MEMORY
);
92 /* Init the table handle */
94 obj_desc
->common
.flags
|= AOPOBJ_DATA_VALID
;
95 obj_desc
->reference
.class = ACPI_REFCLASS_TABLE
;
96 *ddb_handle
= obj_desc
;
98 /* Install the new table into the local data structures */
100 obj_desc
->reference
.value
= table_index
;
102 /* Add the table to the namespace */
104 status
= acpi_ns_load_table(table_index
, parent_node
);
105 if (ACPI_FAILURE(status
)) {
106 acpi_ut_remove_reference(obj_desc
);
110 return_ACPI_STATUS(status
);
113 /*******************************************************************************
115 * FUNCTION: acpi_ex_load_table_op
117 * PARAMETERS: walk_state - Current state with operands
118 * return_desc - Where to store the return object
122 * DESCRIPTION: Load an ACPI table from the RSDT/XSDT
124 ******************************************************************************/
127 acpi_ex_load_table_op(struct acpi_walk_state
*walk_state
,
128 union acpi_operand_object
**return_desc
)
131 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
132 struct acpi_namespace_node
*parent_node
;
133 struct acpi_namespace_node
*start_node
;
134 struct acpi_namespace_node
*parameter_node
= NULL
;
135 union acpi_operand_object
*ddb_handle
;
136 struct acpi_table_header
*table
;
139 ACPI_FUNCTION_TRACE(ex_load_table_op
);
141 /* Validate lengths for the signature_string, OEMIDString, OEMtable_iD */
143 if ((operand
[0]->string
.length
> ACPI_NAME_SIZE
) ||
144 (operand
[1]->string
.length
> ACPI_OEM_ID_SIZE
) ||
145 (operand
[2]->string
.length
> ACPI_OEM_TABLE_ID_SIZE
)) {
146 return_ACPI_STATUS(AE_BAD_PARAMETER
);
149 /* Find the ACPI table in the RSDT/XSDT */
151 status
= acpi_tb_find_table(operand
[0]->string
.pointer
,
152 operand
[1]->string
.pointer
,
153 operand
[2]->string
.pointer
, &table_index
);
154 if (ACPI_FAILURE(status
)) {
155 if (status
!= AE_NOT_FOUND
) {
156 return_ACPI_STATUS(status
);
159 /* Table not found, return an Integer=0 and AE_OK */
161 ddb_handle
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
163 return_ACPI_STATUS(AE_NO_MEMORY
);
166 ddb_handle
->integer
.value
= 0;
167 *return_desc
= ddb_handle
;
169 return_ACPI_STATUS(AE_OK
);
174 start_node
= walk_state
->scope_info
->scope
.node
;
175 parent_node
= acpi_gbl_root_node
;
177 /* root_path (optional parameter) */
179 if (operand
[3]->string
.length
> 0) {
181 * Find the node referenced by the root_path_string. This is the
182 * location within the namespace where the table will be loaded.
185 acpi_ns_get_node(start_node
, operand
[3]->string
.pointer
,
186 ACPI_NS_SEARCH_PARENT
, &parent_node
);
187 if (ACPI_FAILURE(status
)) {
188 return_ACPI_STATUS(status
);
192 /* parameter_path (optional parameter) */
194 if (operand
[4]->string
.length
> 0) {
195 if ((operand
[4]->string
.pointer
[0] != '\\') &&
196 (operand
[4]->string
.pointer
[0] != '^')) {
198 * Path is not absolute, so it will be relative to the node
199 * referenced by the root_path_string (or the NS root if omitted)
201 start_node
= parent_node
;
204 /* Find the node referenced by the parameter_path_string */
207 acpi_ns_get_node(start_node
, operand
[4]->string
.pointer
,
208 ACPI_NS_SEARCH_PARENT
, ¶meter_node
);
209 if (ACPI_FAILURE(status
)) {
210 return_ACPI_STATUS(status
);
214 /* Load the table into the namespace */
216 status
= acpi_ex_add_table(table_index
, parent_node
, &ddb_handle
);
217 if (ACPI_FAILURE(status
)) {
218 return_ACPI_STATUS(status
);
221 /* Parameter Data (optional) */
223 if (parameter_node
) {
225 /* Store the parameter data into the optional parameter object */
227 status
= acpi_ex_store(operand
[5],
228 ACPI_CAST_PTR(union acpi_operand_object
,
231 if (ACPI_FAILURE(status
)) {
232 (void)acpi_ex_unload_table(ddb_handle
);
234 acpi_ut_remove_reference(ddb_handle
);
235 return_ACPI_STATUS(status
);
239 status
= acpi_get_table_by_index(table_index
, &table
);
240 if (ACPI_SUCCESS(status
)) {
242 "Dynamic OEM Table Load - [%.4s] OemId [%.6s] OemTableId [%.8s]",
243 table
->signature
, table
->oem_id
,
244 table
->oem_table_id
));
247 /* Invoke table handler if present */
249 if (acpi_gbl_table_handler
) {
250 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
, table
,
251 acpi_gbl_table_handler_context
);
254 *return_desc
= ddb_handle
;
255 return_ACPI_STATUS(status
);
258 /*******************************************************************************
260 * FUNCTION: acpi_ex_load_op
262 * PARAMETERS: obj_desc - Region or Buffer/Field where the table will be
264 * Target - Where a handle to the table will be stored
265 * walk_state - Current state
269 * DESCRIPTION: Load an ACPI table from a field or operation region
271 * NOTE: Region Fields (Field, bank_field, index_fields) are resolved to buffer
272 * objects before this code is reached.
274 * If source is an operation region, it must refer to system_memory, as
275 * per the ACPI specification.
277 ******************************************************************************/
280 acpi_ex_load_op(union acpi_operand_object
*obj_desc
,
281 union acpi_operand_object
*target
,
282 struct acpi_walk_state
*walk_state
)
284 union acpi_operand_object
*ddb_handle
;
285 struct acpi_table_header
*table
;
286 struct acpi_table_desc table_desc
;
291 ACPI_FUNCTION_TRACE(ex_load_op
);
293 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
295 /* Source Object can be either an op_region or a Buffer/Field */
297 switch (obj_desc
->common
.type
) {
298 case ACPI_TYPE_REGION
:
300 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
301 "Load table from Region %p\n", obj_desc
));
303 /* Region must be system_memory (from ACPI spec) */
305 if (obj_desc
->region
.space_id
!= ACPI_ADR_SPACE_SYSTEM_MEMORY
) {
306 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
310 * If the Region Address and Length have not been previously evaluated,
311 * evaluate them now and save the results.
313 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
314 status
= acpi_ds_get_region_arguments(obj_desc
);
315 if (ACPI_FAILURE(status
)) {
316 return_ACPI_STATUS(status
);
321 * Map the table header and get the actual table length. The region
322 * length is not guaranteed to be the same as the table length.
324 table
= acpi_os_map_memory(obj_desc
->region
.address
,
325 sizeof(struct acpi_table_header
));
327 return_ACPI_STATUS(AE_NO_MEMORY
);
330 length
= table
->length
;
331 acpi_os_unmap_memory(table
, sizeof(struct acpi_table_header
));
333 /* Must have at least an ACPI table header */
335 if (length
< sizeof(struct acpi_table_header
)) {
336 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
340 * The memory region is not guaranteed to remain stable and we must
341 * copy the table to a local buffer. For example, the memory region
342 * is corrupted after suspend on some machines. Dynamically loaded
343 * tables are usually small, so this overhead is minimal.
346 /* Allocate a buffer for the table */
348 table_desc
.pointer
= ACPI_ALLOCATE(length
);
349 if (!table_desc
.pointer
) {
350 return_ACPI_STATUS(AE_NO_MEMORY
);
353 /* Map the entire table and copy it */
355 table
= acpi_os_map_memory(obj_desc
->region
.address
, length
);
357 ACPI_FREE(table_desc
.pointer
);
358 return_ACPI_STATUS(AE_NO_MEMORY
);
361 ACPI_MEMCPY(table_desc
.pointer
, table
, length
);
362 acpi_os_unmap_memory(table
, length
);
364 table_desc
.address
= obj_desc
->region
.address
;
367 case ACPI_TYPE_BUFFER
: /* Buffer or resolved region_field */
369 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
370 "Load table from Buffer or Field %p\n",
373 /* Must have at least an ACPI table header */
375 if (obj_desc
->buffer
.length
< sizeof(struct acpi_table_header
)) {
376 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
379 /* Get the actual table length from the table header */
382 ACPI_CAST_PTR(struct acpi_table_header
,
383 obj_desc
->buffer
.pointer
);
384 length
= table
->length
;
386 /* Table cannot extend beyond the buffer */
388 if (length
> obj_desc
->buffer
.length
) {
389 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT
);
391 if (length
< sizeof(struct acpi_table_header
)) {
392 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
396 * Copy the table from the buffer because the buffer could be modified
397 * or even deleted in the future
399 table_desc
.pointer
= ACPI_ALLOCATE(length
);
400 if (!table_desc
.pointer
) {
401 return_ACPI_STATUS(AE_NO_MEMORY
);
404 ACPI_MEMCPY(table_desc
.pointer
, table
, length
);
405 table_desc
.address
= ACPI_TO_INTEGER(table_desc
.pointer
);
409 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
412 /* Validate table checksum (will not get validated in tb_add_table) */
414 status
= acpi_tb_verify_checksum(table_desc
.pointer
, length
);
415 if (ACPI_FAILURE(status
)) {
416 ACPI_FREE(table_desc
.pointer
);
417 return_ACPI_STATUS(status
);
420 /* Complete the table descriptor */
422 table_desc
.length
= length
;
423 table_desc
.flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
425 /* Install the new table into the local data structures */
427 status
= acpi_tb_add_table(&table_desc
, &table_index
);
428 if (ACPI_FAILURE(status
)) {
433 * Add the table to the namespace.
435 * Note: Load the table objects relative to the root of the namespace.
436 * This appears to go against the ACPI specification, but we do it for
437 * compatibility with other ACPI implementations.
440 acpi_ex_add_table(table_index
, acpi_gbl_root_node
, &ddb_handle
);
441 if (ACPI_FAILURE(status
)) {
443 /* On error, table_ptr was deallocated above */
445 return_ACPI_STATUS(status
);
448 /* Store the ddb_handle into the Target operand */
450 status
= acpi_ex_store(ddb_handle
, target
, walk_state
);
451 if (ACPI_FAILURE(status
)) {
452 (void)acpi_ex_unload_table(ddb_handle
);
454 /* table_ptr was deallocated above */
456 acpi_ut_remove_reference(ddb_handle
);
457 return_ACPI_STATUS(status
);
460 /* Remove the reference by added by acpi_ex_store above */
462 acpi_ut_remove_reference(ddb_handle
);
464 /* Invoke table handler if present */
466 if (acpi_gbl_table_handler
) {
467 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
,
469 acpi_gbl_table_handler_context
);
473 if (ACPI_FAILURE(status
)) {
475 /* Delete allocated table buffer */
477 acpi_tb_delete_table(&table_desc
);
479 return_ACPI_STATUS(status
);
482 /*******************************************************************************
484 * FUNCTION: acpi_ex_unload_table
486 * PARAMETERS: ddb_handle - Handle to a previously loaded table
490 * DESCRIPTION: Unload an ACPI table
492 ******************************************************************************/
494 acpi_status
acpi_ex_unload_table(union acpi_operand_object
*ddb_handle
)
496 acpi_status status
= AE_OK
;
497 union acpi_operand_object
*table_desc
= ddb_handle
;
499 struct acpi_table_header
*table
;
501 ACPI_FUNCTION_TRACE(ex_unload_table
);
504 * Validate the handle
505 * Although the handle is partially validated in acpi_ex_reconfiguration()
506 * when it calls acpi_ex_resolve_operands(), the handle is more completely
509 * Handle must be a valid operand object of type reference. Also, the
510 * ddb_handle must still be marked valid (table has not been previously
514 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle
) != ACPI_DESC_TYPE_OPERAND
) ||
515 (ddb_handle
->common
.type
!= ACPI_TYPE_LOCAL_REFERENCE
) ||
516 (!(ddb_handle
->common
.flags
& AOPOBJ_DATA_VALID
))) {
517 return_ACPI_STATUS(AE_BAD_PARAMETER
);
520 /* Get the table index from the ddb_handle */
522 table_index
= table_desc
->reference
.value
;
524 /* Ensure the table is still loaded */
526 if (!acpi_tb_is_table_loaded(table_index
)) {
527 return_ACPI_STATUS(AE_NOT_EXIST
);
530 /* Invoke table handler if present */
532 if (acpi_gbl_table_handler
) {
533 status
= acpi_get_table_by_index(table_index
, &table
);
534 if (ACPI_SUCCESS(status
)) {
535 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_UNLOAD
,
537 acpi_gbl_table_handler_context
);
541 /* Delete the portion of the namespace owned by this table */
543 status
= acpi_tb_delete_namespace_by_owner(table_index
);
544 if (ACPI_FAILURE(status
)) {
545 return_ACPI_STATUS(status
);
548 (void)acpi_tb_release_owner_id(table_index
);
549 acpi_tb_set_table_loaded_flag(table_index
, FALSE
);
552 * Invalidate the handle. We do this because the handle may be stored
553 * in a named object and may not be actually deleted until much later.
555 ddb_handle
->common
.flags
&= ~AOPOBJ_DATA_VALID
;
556 return_ACPI_STATUS(AE_OK
);