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(struct acpi_table_header
*table
,
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(struct acpi_table_header
*table
,
78 struct acpi_namespace_node
*parent_node
,
79 union acpi_operand_object
**ddb_handle
)
82 struct acpi_table_desc table_info
;
83 union acpi_operand_object
*obj_desc
;
85 ACPI_FUNCTION_TRACE(ex_add_table
);
87 /* Create an object to be the table handle */
89 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE
);
91 return_ACPI_STATUS(AE_NO_MEMORY
);
94 /* Init the table handle */
96 obj_desc
->reference
.opcode
= AML_LOAD_OP
;
97 *ddb_handle
= obj_desc
;
99 /* Install the new table into the local data structures */
101 ACPI_MEMSET(&table_info
, 0, sizeof(struct acpi_table_desc
));
103 table_info
.type
= ACPI_TABLE_ID_SSDT
;
104 table_info
.pointer
= table
;
105 table_info
.length
= (acpi_size
) table
->length
;
106 table_info
.allocation
= ACPI_MEM_ALLOCATED
;
108 status
= acpi_tb_install_table(&table_info
);
109 obj_desc
->reference
.object
= table_info
.installed_desc
;
111 if (ACPI_FAILURE(status
)) {
112 if (status
== AE_ALREADY_EXISTS
) {
114 /* Table already exists, just return the handle */
116 return_ACPI_STATUS(AE_OK
);
121 /* Add the table to the namespace */
123 status
= acpi_ns_load_table(table_info
.installed_desc
, parent_node
);
124 if (ACPI_FAILURE(status
)) {
126 /* Uninstall table on error */
128 (void)acpi_tb_uninstall_table(table_info
.installed_desc
);
132 return_ACPI_STATUS(AE_OK
);
135 acpi_ut_remove_reference(obj_desc
);
137 return_ACPI_STATUS(status
);
140 /*******************************************************************************
142 * FUNCTION: acpi_ex_load_table_op
144 * PARAMETERS: walk_state - Current state with operands
145 * return_desc - Where to store the return object
149 * DESCRIPTION: Load an ACPI table
151 ******************************************************************************/
154 acpi_ex_load_table_op(struct acpi_walk_state
*walk_state
,
155 union acpi_operand_object
**return_desc
)
158 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
159 struct acpi_table_header
*table
;
160 struct acpi_namespace_node
*parent_node
;
161 struct acpi_namespace_node
*start_node
;
162 struct acpi_namespace_node
*parameter_node
= NULL
;
163 union acpi_operand_object
*ddb_handle
;
165 ACPI_FUNCTION_TRACE(ex_load_table_op
);
169 * Make sure that the signature does not match one of the tables that
172 status
= acpi_tb_match_signature(operand
[0]->string
.pointer
, NULL
);
173 if (status
== AE_OK
) {
175 /* Signature matched -- don't allow override */
177 return_ACPI_STATUS(AE_ALREADY_EXISTS
);
181 /* Find the ACPI table */
183 status
= acpi_tb_find_table(operand
[0]->string
.pointer
,
184 operand
[1]->string
.pointer
,
185 operand
[2]->string
.pointer
, &table
);
186 if (ACPI_FAILURE(status
)) {
187 if (status
!= AE_NOT_FOUND
) {
188 return_ACPI_STATUS(status
);
191 /* Table not found, return an Integer=0 and AE_OK */
193 ddb_handle
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
195 return_ACPI_STATUS(AE_NO_MEMORY
);
198 ddb_handle
->integer
.value
= 0;
199 *return_desc
= ddb_handle
;
201 return_ACPI_STATUS(AE_OK
);
206 start_node
= walk_state
->scope_info
->scope
.node
;
207 parent_node
= acpi_gbl_root_node
;
209 /* root_path (optional parameter) */
211 if (operand
[3]->string
.length
> 0) {
213 * Find the node referenced by the root_path_string. This is the
214 * location within the namespace where the table will be loaded.
217 acpi_ns_get_node_by_path(operand
[3]->string
.pointer
,
218 start_node
, ACPI_NS_SEARCH_PARENT
,
220 if (ACPI_FAILURE(status
)) {
221 return_ACPI_STATUS(status
);
225 /* parameter_path (optional parameter) */
227 if (operand
[4]->string
.length
> 0) {
228 if ((operand
[4]->string
.pointer
[0] != '\\') &&
229 (operand
[4]->string
.pointer
[0] != '^')) {
231 * Path is not absolute, so it will be relative to the node
232 * referenced by the root_path_string (or the NS root if omitted)
234 start_node
= parent_node
;
237 /* Find the node referenced by the parameter_path_string */
240 acpi_ns_get_node_by_path(operand
[4]->string
.pointer
,
241 start_node
, ACPI_NS_SEARCH_PARENT
,
243 if (ACPI_FAILURE(status
)) {
244 return_ACPI_STATUS(status
);
248 /* Load the table into the namespace */
250 status
= acpi_ex_add_table(table
, parent_node
, &ddb_handle
);
251 if (ACPI_FAILURE(status
)) {
252 return_ACPI_STATUS(status
);
255 /* Parameter Data (optional) */
257 if (parameter_node
) {
259 /* Store the parameter data into the optional parameter object */
261 status
= acpi_ex_store(operand
[5],
262 ACPI_CAST_PTR(union acpi_operand_object
,
265 if (ACPI_FAILURE(status
)) {
266 (void)acpi_ex_unload_table(ddb_handle
);
267 return_ACPI_STATUS(status
);
271 *return_desc
= ddb_handle
;
272 return_ACPI_STATUS(status
);
275 /*******************************************************************************
277 * FUNCTION: acpi_ex_load_op
279 * PARAMETERS: obj_desc - Region or Field where the table will be
281 * Target - Where a handle to the table will be stored
282 * walk_state - Current state
286 * DESCRIPTION: Load an ACPI table from a field or operation region
288 ******************************************************************************/
291 acpi_ex_load_op(union acpi_operand_object
*obj_desc
,
292 union acpi_operand_object
*target
,
293 struct acpi_walk_state
*walk_state
)
296 union acpi_operand_object
*ddb_handle
;
297 union acpi_operand_object
*buffer_desc
= NULL
;
298 struct acpi_table_header
*table_ptr
= NULL
;
299 acpi_physical_address address
;
300 struct acpi_table_header table_header
;
303 ACPI_FUNCTION_TRACE(ex_load_op
);
305 /* Object can be either an op_region or a Field */
307 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
308 case ACPI_TYPE_REGION
:
310 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Load from Region %p %s\n",
312 acpi_ut_get_object_type_name(obj_desc
)));
315 * If the Region Address and Length have not been previously evaluated,
316 * evaluate them now and save the results.
318 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
319 status
= acpi_ds_get_region_arguments(obj_desc
);
320 if (ACPI_FAILURE(status
)) {
321 return_ACPI_STATUS(status
);
325 /* Get the base physical address of the region */
327 address
= obj_desc
->region
.address
;
329 /* Get the table length from the table header */
331 table_header
.length
= 0;
332 for (i
= 0; i
< 8; i
++) {
334 acpi_ev_address_space_dispatch(obj_desc
, ACPI_READ
,
335 (acpi_physical_address
)
339 if (ACPI_FAILURE(status
)) {
340 return_ACPI_STATUS(status
);
344 /* Sanity check the table length */
346 if (table_header
.length
< sizeof(struct acpi_table_header
)) {
347 return_ACPI_STATUS(AE_BAD_HEADER
);
350 /* Allocate a buffer for the entire table */
352 table_ptr
= ACPI_ALLOCATE(table_header
.length
);
354 return_ACPI_STATUS(AE_NO_MEMORY
);
357 /* Get the entire table from the op region */
359 for (i
= 0; i
< table_header
.length
; i
++) {
361 acpi_ev_address_space_dispatch(obj_desc
, ACPI_READ
,
362 (acpi_physical_address
)
366 if (ACPI_FAILURE(status
)) {
372 case ACPI_TYPE_LOCAL_REGION_FIELD
:
373 case ACPI_TYPE_LOCAL_BANK_FIELD
:
374 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
376 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
, "Load from Field %p %s\n",
378 acpi_ut_get_object_type_name(obj_desc
)));
381 * The length of the field must be at least as large as the table.
382 * Read the entire field and thus the entire table. Buffer is
383 * allocated during the read.
386 acpi_ex_read_data_from_field(walk_state
, obj_desc
,
388 if (ACPI_FAILURE(status
)) {
389 return_ACPI_STATUS(status
);
392 table_ptr
= ACPI_CAST_PTR(struct acpi_table_header
,
393 buffer_desc
->buffer
.pointer
);
395 /* All done with the buffer_desc, delete it */
397 buffer_desc
->buffer
.pointer
= NULL
;
398 acpi_ut_remove_reference(buffer_desc
);
400 /* Sanity check the table length */
402 if (table_ptr
->length
< sizeof(struct acpi_table_header
)) {
403 status
= AE_BAD_HEADER
;
409 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
412 /* The table must be either an SSDT or a PSDT */
414 if ((!ACPI_COMPARE_NAME(table_ptr
->signature
, PSDT_SIG
)) &&
415 (!ACPI_COMPARE_NAME(table_ptr
->signature
, SSDT_SIG
))) {
417 "Table has invalid signature [%4.4s], must be SSDT or PSDT",
418 table_ptr
->signature
));
419 status
= AE_BAD_SIGNATURE
;
423 /* Install the new table into the local data structures */
425 status
= acpi_ex_add_table(table_ptr
, acpi_gbl_root_node
, &ddb_handle
);
426 if (ACPI_FAILURE(status
)) {
428 /* On error, table_ptr was deallocated above */
430 return_ACPI_STATUS(status
);
433 /* Store the ddb_handle into the Target operand */
435 status
= acpi_ex_store(ddb_handle
, target
, walk_state
);
436 if (ACPI_FAILURE(status
)) {
437 (void)acpi_ex_unload_table(ddb_handle
);
439 /* table_ptr was deallocated above */
441 return_ACPI_STATUS(status
);
445 if (ACPI_FAILURE(status
)) {
446 ACPI_FREE(table_ptr
);
448 return_ACPI_STATUS(status
);
451 /*******************************************************************************
453 * FUNCTION: acpi_ex_unload_table
455 * PARAMETERS: ddb_handle - Handle to a previously loaded table
459 * DESCRIPTION: Unload an ACPI table
461 ******************************************************************************/
463 acpi_status
acpi_ex_unload_table(union acpi_operand_object
*ddb_handle
)
465 acpi_status status
= AE_OK
;
466 union acpi_operand_object
*table_desc
= ddb_handle
;
467 struct acpi_table_desc
*table_info
;
469 ACPI_FUNCTION_TRACE(ex_unload_table
);
472 * Validate the handle
473 * Although the handle is partially validated in acpi_ex_reconfiguration(),
474 * when it calls acpi_ex_resolve_operands(), the handle is more completely
478 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle
) != ACPI_DESC_TYPE_OPERAND
) ||
479 (ACPI_GET_OBJECT_TYPE(ddb_handle
) != ACPI_TYPE_LOCAL_REFERENCE
)) {
480 return_ACPI_STATUS(AE_BAD_PARAMETER
);
483 /* Get the actual table descriptor from the ddb_handle */
485 table_info
= (struct acpi_table_desc
*)table_desc
->reference
.object
;
488 * Delete the entire namespace under this table Node
489 * (Offset contains the table_id)
491 acpi_ns_delete_namespace_by_owner(table_info
->owner_id
);
492 acpi_ut_release_owner_id(&table_info
->owner_id
);
494 /* Delete the table itself */
496 (void)acpi_tb_uninstall_table(table_info
->installed_desc
);
498 /* Delete the table descriptor (ddb_handle) */
500 acpi_ut_remove_reference(table_desc
);
501 return_ACPI_STATUS(status
);