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(start_node, operand[3]->string.pointer,
218 ACPI_NS_SEARCH_PARENT, &parent_node);
219 if (ACPI_FAILURE(status)) {
220 return_ACPI_STATUS(status);
224 /* parameter_path (optional parameter) */
226 if (operand[4]->string.length > 0) {
227 if ((operand[4]->string.pointer[0] != '\\') &&
228 (operand[4]->string.pointer[0] != '^')) {
230 * Path is not absolute, so it will be relative to the node
231 * referenced by the root_path_string (or the NS root if omitted)
233 start_node = parent_node;
236 /* Find the node referenced by the parameter_path_string */
239 acpi_ns_get_node(start_node, operand[4]->string.pointer,
240 ACPI_NS_SEARCH_PARENT, ¶meter_node);
241 if (ACPI_FAILURE(status)) {
242 return_ACPI_STATUS(status);
246 /* Load the table into the namespace */
248 status = acpi_ex_add_table(table, parent_node, &ddb_handle);
249 if (ACPI_FAILURE(status)) {
250 return_ACPI_STATUS(status);
253 /* Parameter Data (optional) */
255 if (parameter_node) {
257 /* Store the parameter data into the optional parameter object */
259 status = acpi_ex_store(operand[5],
260 ACPI_CAST_PTR(union acpi_operand_object,
263 if (ACPI_FAILURE(status)) {
264 (void)acpi_ex_unload_table(ddb_handle);
265 return_ACPI_STATUS(status);
270 "Dynamic OEM Table Load - [%4.4s] OemId [%6.6s] OemTableId [%8.8s]",
271 table->signature, table->oem_id, table->oem_table_id));
273 *return_desc = ddb_handle;
274 return_ACPI_STATUS(status);
277 /*******************************************************************************
279 * FUNCTION: acpi_ex_load_op
281 * PARAMETERS: obj_desc - Region or Field where the table will be
283 * Target - Where a handle to the table will be stored
284 * walk_state - Current state
288 * DESCRIPTION: Load an ACPI table from a field or operation region
290 ******************************************************************************/
293 acpi_ex_load_op(union acpi_operand_object *obj_desc,
294 union acpi_operand_object *target,
295 struct acpi_walk_state *walk_state)
298 union acpi_operand_object *ddb_handle;
299 union acpi_operand_object *buffer_desc = NULL;
300 struct acpi_table_header *table_ptr = NULL;
301 acpi_physical_address address;
302 struct acpi_table_header table_header;
306 ACPI_FUNCTION_TRACE(ex_load_op);
308 /* Object can be either an op_region or a Field */
310 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
311 case ACPI_TYPE_REGION:
313 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Load from Region %p %s\n",
315 acpi_ut_get_object_type_name(obj_desc)));
318 * If the Region Address and Length have not been previously evaluated,
319 * evaluate them now and save the results.
321 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
322 status = acpi_ds_get_region_arguments(obj_desc);
323 if (ACPI_FAILURE(status)) {
324 return_ACPI_STATUS(status);
328 /* Get the base physical address of the region */
330 address = obj_desc->region.address;
332 /* Get part of the table header to get the table length */
334 table_header.length = 0;
335 for (i = 0; i < 8; i++) {
337 acpi_ev_address_space_dispatch(obj_desc, ACPI_READ,
338 (acpi_physical_address)
341 if (ACPI_FAILURE(status)) {
342 return_ACPI_STATUS(status);
345 /* Get the one valid byte of the returned 64-bit value */
347 ACPI_CAST_PTR(u8, &table_header)[i] = (u8) temp;
350 /* Sanity check the table length */
352 if (table_header.length < sizeof(struct acpi_table_header)) {
353 return_ACPI_STATUS(AE_BAD_HEADER);
356 /* Allocate a buffer for the entire table */
358 table_ptr = ACPI_ALLOCATE(table_header.length);
360 return_ACPI_STATUS(AE_NO_MEMORY);
363 /* Get the entire table from the op region */
365 for (i = 0; i < table_header.length; i++) {
367 acpi_ev_address_space_dispatch(obj_desc, ACPI_READ,
368 (acpi_physical_address)
371 if (ACPI_FAILURE(status)) {
375 /* Get the one valid byte of the returned 64-bit value */
377 ACPI_CAST_PTR(u8, table_ptr)[i] = (u8) temp;
381 case ACPI_TYPE_LOCAL_REGION_FIELD:
382 case ACPI_TYPE_LOCAL_BANK_FIELD:
383 case ACPI_TYPE_LOCAL_INDEX_FIELD:
385 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Load from Field %p %s\n",
387 acpi_ut_get_object_type_name(obj_desc)));
390 * The length of the field must be at least as large as the table.
391 * Read the entire field and thus the entire table. Buffer is
392 * allocated during the read.
395 acpi_ex_read_data_from_field(walk_state, obj_desc,
397 if (ACPI_FAILURE(status)) {
398 return_ACPI_STATUS(status);
401 table_ptr = ACPI_CAST_PTR(struct acpi_table_header,
402 buffer_desc->buffer.pointer);
404 /* All done with the buffer_desc, delete it */
406 buffer_desc->buffer.pointer = NULL;
407 acpi_ut_remove_reference(buffer_desc);
409 /* Sanity check the table length */
411 if (table_ptr->length < sizeof(struct acpi_table_header)) {
412 status = AE_BAD_HEADER;
418 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
421 /* The table must be either an SSDT or a PSDT */
423 if ((!ACPI_COMPARE_NAME(table_ptr->signature, PSDT_SIG)) &&
424 (!ACPI_COMPARE_NAME(table_ptr->signature, SSDT_SIG))) {
426 "Table has invalid signature [%4.4s], must be SSDT or PSDT",
427 table_ptr->signature));
428 status = AE_BAD_SIGNATURE;
432 /* Install the new table into the local data structures */
434 status = acpi_ex_add_table(table_ptr, acpi_gbl_root_node, &ddb_handle);
435 if (ACPI_FAILURE(status)) {
437 /* On error, table_ptr was deallocated above */
439 return_ACPI_STATUS(status);
442 /* Store the ddb_handle into the Target operand */
444 status = acpi_ex_store(ddb_handle, target, walk_state);
445 if (ACPI_FAILURE(status)) {
446 (void)acpi_ex_unload_table(ddb_handle);
448 /* table_ptr was deallocated above */
450 return_ACPI_STATUS(status);
454 "Dynamic SSDT Load - OemId [%6.6s] OemTableId [%8.8s]",
455 table_ptr->oem_id, table_ptr->oem_table_id));
458 if (ACPI_FAILURE(status)) {
459 ACPI_FREE(table_ptr);
461 return_ACPI_STATUS(status);
464 /*******************************************************************************
466 * FUNCTION: acpi_ex_unload_table
468 * PARAMETERS: ddb_handle - Handle to a previously loaded table
472 * DESCRIPTION: Unload an ACPI table
474 ******************************************************************************/
476 acpi_status acpi_ex_unload_table(union acpi_operand_object *ddb_handle)
478 acpi_status status = AE_OK;
479 union acpi_operand_object *table_desc = ddb_handle;
480 struct acpi_table_desc *table_info;
482 ACPI_FUNCTION_TRACE(ex_unload_table);
485 * Validate the handle
486 * Although the handle is partially validated in acpi_ex_reconfiguration(),
487 * when it calls acpi_ex_resolve_operands(), the handle is more completely
491 (ACPI_GET_DESCRIPTOR_TYPE(ddb_handle) != ACPI_DESC_TYPE_OPERAND) ||
492 (ACPI_GET_OBJECT_TYPE(ddb_handle) != ACPI_TYPE_LOCAL_REFERENCE)) {
493 return_ACPI_STATUS(AE_BAD_PARAMETER);
496 /* Get the actual table descriptor from the ddb_handle */
498 table_info = (struct acpi_table_desc *)table_desc->reference.object;
501 * Delete the entire namespace under this table Node
502 * (Offset contains the table_id)
504 acpi_ns_delete_namespace_by_owner(table_info->owner_id);
505 acpi_ut_release_owner_id(&table_info->owner_id);
507 /* Delete the table itself */
509 (void)acpi_tb_uninstall_table(table_info->installed_desc);
511 /* Delete the table descriptor (ddb_handle) */
513 acpi_ut_remove_reference(table_desc);
514 return_ACPI_STATUS(status);