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>
45 #include <acpi/acinterp.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/actables.h>
49 #include <acpi/acdispat.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
->reference
.opcode
= AML_LOAD_OP
;
95 *ddb_handle
= obj_desc
;
97 /* Install the new table into the local data structures */
99 obj_desc
->reference
.object
= ACPI_CAST_PTR(void,
100 (unsigned long)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
);
233 return_ACPI_STATUS(status
);
237 status
= acpi_get_table_by_index(table_index
, &table
);
238 if (ACPI_SUCCESS(status
)) {
240 "Dynamic OEM Table Load - [%.4s] OemId [%.6s] OemTableId [%.8s]",
241 table
->signature
, table
->oem_id
,
242 table
->oem_table_id
));
245 /* Invoke table handler if present */
247 if (acpi_gbl_table_handler
) {
248 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
, table
,
249 acpi_gbl_table_handler_context
);
252 *return_desc
= ddb_handle
;
253 return_ACPI_STATUS(status
);
256 /*******************************************************************************
258 * FUNCTION: acpi_ex_load_op
260 * PARAMETERS: obj_desc - Region or Buffer/Field where the table will be
262 * Target - Where a handle to the table will be stored
263 * walk_state - Current state
267 * DESCRIPTION: Load an ACPI table from a field or operation region
269 * NOTE: Region Fields (Field, bank_field, index_fields) are resolved to buffer
270 * objects before this code is reached.
272 * If source is an operation region, it must refer to system_memory, as
273 * per the ACPI specification.
275 ******************************************************************************/
278 acpi_ex_load_op(union acpi_operand_object
*obj_desc
,
279 union acpi_operand_object
*target
,
280 struct acpi_walk_state
*walk_state
)
282 union acpi_operand_object
*ddb_handle
;
283 struct acpi_table_desc table_desc
;
288 ACPI_FUNCTION_TRACE(ex_load_op
);
290 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
292 /* Source Object can be either an op_region or a Buffer/Field */
294 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
295 case ACPI_TYPE_REGION
:
297 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Load from Region %p %s\n",
299 acpi_ut_get_object_type_name(obj_desc
)));
301 /* Region must be system_memory (from ACPI spec) */
303 if (obj_desc
->region
.space_id
!= ACPI_ADR_SPACE_SYSTEM_MEMORY
) {
304 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
308 * If the Region Address and Length have not been previously evaluated,
309 * evaluate them now and save the results.
311 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
312 status
= acpi_ds_get_region_arguments(obj_desc
);
313 if (ACPI_FAILURE(status
)) {
314 return_ACPI_STATUS(status
);
319 * We will simply map the memory region for the table. However, the
320 * memory region is technically not guaranteed to remain stable and
321 * we may eventually have to copy the table to a local buffer.
323 table_desc
.address
= obj_desc
->region
.address
;
324 table_desc
.length
= obj_desc
->region
.length
;
325 table_desc
.flags
= ACPI_TABLE_ORIGIN_MAPPED
;
328 case ACPI_TYPE_BUFFER
: /* Buffer or resolved region_field */
330 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
331 "Load from Buffer or Field %p %s\n", obj_desc
,
332 acpi_ut_get_object_type_name(obj_desc
)));
334 length
= obj_desc
->buffer
.length
;
336 /* Must have at least an ACPI table header */
338 if (length
< sizeof(struct acpi_table_header
)) {
339 return_ACPI_STATUS(AE_INVALID_TABLE_LENGTH
);
342 /* Validate checksum here. It won't get validated in tb_add_table */
345 acpi_tb_verify_checksum(ACPI_CAST_PTR
346 (struct acpi_table_header
,
347 obj_desc
->buffer
.pointer
), length
);
348 if (ACPI_FAILURE(status
)) {
349 return_ACPI_STATUS(status
);
353 * We need to copy the buffer since the original buffer could be
354 * changed or deleted in the future
356 table_desc
.pointer
= ACPI_ALLOCATE(length
);
357 if (!table_desc
.pointer
) {
358 return_ACPI_STATUS(AE_NO_MEMORY
);
361 ACPI_MEMCPY(table_desc
.pointer
, obj_desc
->buffer
.pointer
,
363 table_desc
.length
= length
;
364 table_desc
.flags
= ACPI_TABLE_ORIGIN_ALLOCATED
;
368 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
372 * Install the new table into the local data structures
374 status
= acpi_tb_add_table(&table_desc
, &table_index
);
375 if (ACPI_FAILURE(status
)) {
380 * Add the table to the namespace.
382 * Note: We load the table objects relative to the root of the namespace.
383 * This appears to go against the ACPI specification, but we do it for
384 * compatibility with other ACPI implementations.
387 acpi_ex_add_table(table_index
, acpi_gbl_root_node
, &ddb_handle
);
388 if (ACPI_FAILURE(status
)) {
390 /* On error, table_ptr was deallocated above */
392 return_ACPI_STATUS(status
);
395 /* Store the ddb_handle into the Target operand */
397 status
= acpi_ex_store(ddb_handle
, target
, walk_state
);
398 if (ACPI_FAILURE(status
)) {
399 (void)acpi_ex_unload_table(ddb_handle
);
401 /* table_ptr was deallocated above */
403 acpi_ut_remove_reference(ddb_handle
);
404 return_ACPI_STATUS(status
);
407 /* Invoke table handler if present */
409 if (acpi_gbl_table_handler
) {
410 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_LOAD
,
412 acpi_gbl_table_handler_context
);
416 if (ACPI_FAILURE(status
)) {
418 /* Delete allocated buffer or mapping */
420 acpi_tb_delete_table(&table_desc
);
422 return_ACPI_STATUS(status
);
425 /*******************************************************************************
427 * FUNCTION: acpi_ex_unload_table
429 * PARAMETERS: ddb_handle - Handle to a previously loaded table
433 * DESCRIPTION: Unload an ACPI table
435 ******************************************************************************/
437 acpi_status
acpi_ex_unload_table(union acpi_operand_object
*ddb_handle
)
439 acpi_status status
= AE_OK
;
440 union acpi_operand_object
*table_desc
= ddb_handle
;
442 struct acpi_table_header
*table
;
444 ACPI_FUNCTION_TRACE(ex_unload_table
);
447 * Validate the handle
448 * Although the handle is partially validated in acpi_ex_reconfiguration(),
449 * when it calls acpi_ex_resolve_operands(), the handle is more completely
453 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle
) != ACPI_DESC_TYPE_OPERAND
) ||
454 (ACPI_GET_OBJECT_TYPE(ddb_handle
) != ACPI_TYPE_LOCAL_REFERENCE
)) {
455 return_ACPI_STATUS(AE_BAD_PARAMETER
);
458 /* Get the table index from the ddb_handle (acpi_size for 64-bit case) */
460 table_index
= (u32
) (acpi_size
) table_desc
->reference
.object
;
462 /* Invoke table handler if present */
464 if (acpi_gbl_table_handler
) {
465 status
= acpi_get_table_by_index(table_index
, &table
);
466 if (ACPI_SUCCESS(status
)) {
467 (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_UNLOAD
,
469 acpi_gbl_table_handler_context
);
474 * Delete the entire namespace under this table Node
475 * (Offset contains the table_id)
477 acpi_tb_delete_namespace_by_owner(table_index
);
478 (void)acpi_tb_release_owner_id(table_index
);
480 acpi_tb_set_table_loaded_flag(table_index
, FALSE
);
482 return_ACPI_STATUS(AE_OK
);