1 /******************************************************************************
3 * Module Name: exconfig - Namespace reconfiguration (Load/Unload opcodes)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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>
45 #include <acpi/acinterp.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/acevents.h>
49 #include <acpi/actables.h>
50 #include <acpi/acdispat.h>
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME("exconfig")
55 /* Local prototypes */
57 acpi_ex_add_table(acpi_native_uint table_index
,
58 struct acpi_namespace_node
*parent_node
,
59 union acpi_operand_object
**ddb_handle
);
61 /*******************************************************************************
63 * FUNCTION: acpi_ex_add_table
65 * PARAMETERS: Table - Pointer to raw table
66 * parent_node - Where to load the table (scope)
67 * ddb_handle - Where to return the table handle.
71 * DESCRIPTION: Common function to Install and Load an ACPI table with a
72 * returned table handle.
74 ******************************************************************************/
77 acpi_ex_add_table(acpi_native_uint table_index
,
78 struct acpi_namespace_node
*parent_node
,
79 union acpi_operand_object
**ddb_handle
)
82 union acpi_operand_object
*obj_desc
;
84 ACPI_FUNCTION_TRACE(ex_add_table
);
86 /* Create an object to be the table handle */
88 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE
);
90 return_ACPI_STATUS(AE_NO_MEMORY
);
93 /* Init the table handle */
95 obj_desc
->reference
.opcode
= AML_LOAD_OP
;
96 *ddb_handle
= obj_desc
;
98 /* Install the new table into the local data structures */
100 obj_desc
->reference
.object
= ACPI_CAST_PTR(void, 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
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 acpi_native_uint table_index
;
133 struct acpi_namespace_node
*parent_node
;
134 struct acpi_namespace_node
*start_node
;
135 struct acpi_namespace_node
*parameter_node
= NULL
;
136 union acpi_operand_object
*ddb_handle
;
137 struct acpi_table_header
*table
;
139 ACPI_FUNCTION_TRACE(ex_load_table_op
);
143 * Make sure that the signature does not match one of the tables that
146 status
= acpi_tb_match_signature(operand
[0]->string
.pointer
, NULL
);
147 if (status
== AE_OK
) {
149 /* Signature matched -- don't allow override */
151 return_ACPI_STATUS(AE_ALREADY_EXISTS
);
155 /* Find the ACPI table */
157 status
= acpi_tb_find_table(operand
[0]->string
.pointer
,
158 operand
[1]->string
.pointer
,
159 operand
[2]->string
.pointer
, &table_index
);
160 if (ACPI_FAILURE(status
)) {
161 if (status
!= AE_NOT_FOUND
) {
162 return_ACPI_STATUS(status
);
165 /* Table not found, return an Integer=0 and AE_OK */
167 ddb_handle
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
169 return_ACPI_STATUS(AE_NO_MEMORY
);
172 ddb_handle
->integer
.value
= 0;
173 *return_desc
= ddb_handle
;
175 return_ACPI_STATUS(AE_OK
);
180 start_node
= walk_state
->scope_info
->scope
.node
;
181 parent_node
= acpi_gbl_root_node
;
183 /* root_path (optional parameter) */
185 if (operand
[3]->string
.length
> 0) {
187 * Find the node referenced by the root_path_string. This is the
188 * location within the namespace where the table will be loaded.
191 acpi_ns_get_node(start_node
, operand
[3]->string
.pointer
,
192 ACPI_NS_SEARCH_PARENT
, &parent_node
);
193 if (ACPI_FAILURE(status
)) {
194 return_ACPI_STATUS(status
);
198 /* parameter_path (optional parameter) */
200 if (operand
[4]->string
.length
> 0) {
201 if ((operand
[4]->string
.pointer
[0] != '\\') &&
202 (operand
[4]->string
.pointer
[0] != '^')) {
204 * Path is not absolute, so it will be relative to the node
205 * referenced by the root_path_string (or the NS root if omitted)
207 start_node
= parent_node
;
210 /* Find the node referenced by the parameter_path_string */
213 acpi_ns_get_node(start_node
, operand
[4]->string
.pointer
,
214 ACPI_NS_SEARCH_PARENT
, ¶meter_node
);
215 if (ACPI_FAILURE(status
)) {
216 return_ACPI_STATUS(status
);
220 /* Load the table into the namespace */
222 status
= acpi_ex_add_table(table_index
, parent_node
, &ddb_handle
);
223 if (ACPI_FAILURE(status
)) {
224 return_ACPI_STATUS(status
);
227 /* Parameter Data (optional) */
229 if (parameter_node
) {
231 /* Store the parameter data into the optional parameter object */
233 status
= acpi_ex_store(operand
[5],
234 ACPI_CAST_PTR(union acpi_operand_object
,
237 if (ACPI_FAILURE(status
)) {
238 (void)acpi_ex_unload_table(ddb_handle
);
239 return_ACPI_STATUS(status
);
243 status
= acpi_get_table_by_index(table_index
, &table
);
244 if (ACPI_SUCCESS(status
)) {
246 "Dynamic OEM Table Load - [%4.4s] OemId [%6.6s] OemTableId [%8.8s]",
247 table
->signature
, table
->oem_id
,
248 table
->oem_table_id
));
251 *return_desc
= ddb_handle
;
252 return_ACPI_STATUS(status
);
255 /*******************************************************************************
257 * FUNCTION: acpi_ex_load_op
259 * PARAMETERS: obj_desc - Region or Field where the table will be
261 * Target - Where a handle to the table will be stored
262 * walk_state - Current state
266 * DESCRIPTION: Load an ACPI table from a field or operation region
268 ******************************************************************************/
271 acpi_ex_load_op(union acpi_operand_object
*obj_desc
,
272 union acpi_operand_object
*target
,
273 struct acpi_walk_state
*walk_state
)
276 union acpi_operand_object
*ddb_handle
;
277 union acpi_operand_object
*buffer_desc
= NULL
;
278 struct acpi_table_header
*table_ptr
= NULL
;
279 acpi_native_uint table_index
;
280 acpi_physical_address address
;
281 struct acpi_table_header table_header
;
285 ACPI_FUNCTION_TRACE(ex_load_op
);
287 /* Object can be either an op_region or a Field */
289 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
290 case ACPI_TYPE_REGION
:
292 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Load from Region %p %s\n",
294 acpi_ut_get_object_type_name(obj_desc
)));
297 * If the Region Address and Length have not been previously evaluated,
298 * evaluate them now and save the results.
300 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
301 status
= acpi_ds_get_region_arguments(obj_desc
);
302 if (ACPI_FAILURE(status
)) {
303 return_ACPI_STATUS(status
);
307 /* Get the base physical address of the region */
309 address
= obj_desc
->region
.address
;
311 /* Get part of the table header to get the table length */
313 table_header
.length
= 0;
314 for (i
= 0; i
< 8; i
++) {
316 acpi_ev_address_space_dispatch(obj_desc
, ACPI_READ
,
317 (acpi_physical_address
)
320 if (ACPI_FAILURE(status
)) {
321 return_ACPI_STATUS(status
);
324 /* Get the one valid byte of the returned 64-bit value */
326 ACPI_CAST_PTR(u8
, &table_header
)[i
] = (u8
) temp
;
329 /* Sanity check the table length */
331 if (table_header
.length
< sizeof(struct acpi_table_header
)) {
332 return_ACPI_STATUS(AE_BAD_HEADER
);
335 /* Allocate a buffer for the entire table */
337 table_ptr
= ACPI_ALLOCATE(table_header
.length
);
339 return_ACPI_STATUS(AE_NO_MEMORY
);
342 /* Get the entire table from the op region */
344 for (i
= 0; i
< table_header
.length
; i
++) {
346 acpi_ev_address_space_dispatch(obj_desc
, ACPI_READ
,
347 (acpi_physical_address
)
350 if (ACPI_FAILURE(status
)) {
354 /* Get the one valid byte of the returned 64-bit value */
356 ACPI_CAST_PTR(u8
, table_ptr
)[i
] = (u8
) temp
;
360 case ACPI_TYPE_LOCAL_REGION_FIELD
:
361 case ACPI_TYPE_LOCAL_BANK_FIELD
:
362 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
364 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Load from Field %p %s\n",
366 acpi_ut_get_object_type_name(obj_desc
)));
369 * The length of the field must be at least as large as the table.
370 * Read the entire field and thus the entire table. Buffer is
371 * allocated during the read.
374 acpi_ex_read_data_from_field(walk_state
, obj_desc
,
376 if (ACPI_FAILURE(status
)) {
377 return_ACPI_STATUS(status
);
380 table_ptr
= ACPI_CAST_PTR(struct acpi_table_header
,
381 buffer_desc
->buffer
.pointer
);
383 /* All done with the buffer_desc, delete it */
385 buffer_desc
->buffer
.pointer
= NULL
;
386 acpi_ut_remove_reference(buffer_desc
);
388 /* Sanity check the table length */
390 if (table_ptr
->length
< sizeof(struct acpi_table_header
)) {
391 status
= AE_BAD_HEADER
;
397 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
400 /* The table must be either an SSDT or a PSDT */
402 if ((!ACPI_COMPARE_NAME(table_ptr
->signature
, ACPI_SIG_PSDT
)) &&
403 (!ACPI_COMPARE_NAME(table_ptr
->signature
, ACPI_SIG_SSDT
))) {
405 "Table has invalid signature [%4.4s], must be SSDT or PSDT",
406 table_ptr
->signature
));
407 status
= AE_BAD_SIGNATURE
;
412 * Install the new table into the local data structures
414 status
= acpi_tb_add_table(table_ptr
, &table_index
);
415 if (ACPI_FAILURE(status
)) {
416 return_ACPI_STATUS(status
);
420 acpi_ex_add_table(table_index
, acpi_gbl_root_node
, &ddb_handle
);
421 if (ACPI_FAILURE(status
)) {
423 /* On error, table_ptr was deallocated above */
425 return_ACPI_STATUS(status
);
428 /* Store the ddb_handle into the Target operand */
430 status
= acpi_ex_store(ddb_handle
, target
, walk_state
);
431 if (ACPI_FAILURE(status
)) {
432 (void)acpi_ex_unload_table(ddb_handle
);
434 /* table_ptr was deallocated above */
436 return_ACPI_STATUS(status
);
440 "Dynamic SSDT Load - OemId [%6.6s] OemTableId [%8.8s]",
441 table_ptr
->oem_id
, table_ptr
->oem_table_id
));
444 if (ACPI_FAILURE(status
)) {
445 ACPI_FREE(table_ptr
);
447 return_ACPI_STATUS(status
);
450 /*******************************************************************************
452 * FUNCTION: acpi_ex_unload_table
454 * PARAMETERS: ddb_handle - Handle to a previously loaded table
458 * DESCRIPTION: Unload an ACPI table
460 ******************************************************************************/
462 acpi_status
acpi_ex_unload_table(union acpi_operand_object
*ddb_handle
)
464 acpi_status status
= AE_OK
;
465 union acpi_operand_object
*table_desc
= ddb_handle
;
466 acpi_native_uint table_index
;
468 ACPI_FUNCTION_TRACE(ex_unload_table
);
471 * Validate the handle
472 * Although the handle is partially validated in acpi_ex_reconfiguration(),
473 * when it calls acpi_ex_resolve_operands(), the handle is more completely
477 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle
) != ACPI_DESC_TYPE_OPERAND
) ||
478 (ACPI_GET_OBJECT_TYPE(ddb_handle
) != ACPI_TYPE_LOCAL_REFERENCE
)) {
479 return_ACPI_STATUS(AE_BAD_PARAMETER
);
482 /* Get the table index from the ddb_handle */
484 table_index
= (acpi_native_uint
) table_desc
->reference
.object
;
487 * Delete the entire namespace under this table Node
488 * (Offset contains the table_id)
490 acpi_tb_delete_namespace_by_owner(table_index
);
491 acpi_tb_release_owner_id(table_index
);
493 acpi_tb_set_table_loaded_flag(table_index
, FALSE
);
495 /* Delete the table descriptor (ddb_handle) */
497 acpi_ut_remove_reference(table_desc
);
498 return_ACPI_STATUS(status
);