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_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) {
113 /* Table already exists, just return the handle */
115 return_ACPI_STATUS(AE_OK);
120 /* Add the table to the namespace */
122 status = acpi_ns_load_table(table_info.installed_desc, parent_node);
123 if (ACPI_FAILURE(status)) {
124 /* Uninstall table on error */
126 (void)acpi_tb_uninstall_table(table_info.installed_desc);
130 return_ACPI_STATUS(AE_OK);
133 acpi_ut_remove_reference(obj_desc);
135 return_ACPI_STATUS(status);
138 /*******************************************************************************
140 * FUNCTION: acpi_ex_load_table_op
142 * PARAMETERS: walk_state - Current state with operands
143 * return_desc - Where to store the return object
147 * DESCRIPTION: Load an ACPI table
149 ******************************************************************************/
152 acpi_ex_load_table_op(struct acpi_walk_state *walk_state,
153 union acpi_operand_object **return_desc)
156 union acpi_operand_object **operand = &walk_state->operands[0];
157 struct acpi_table_header *table;
158 struct acpi_namespace_node *parent_node;
159 struct acpi_namespace_node *start_node;
160 struct acpi_namespace_node *parameter_node = NULL;
161 union acpi_operand_object *ddb_handle;
163 ACPI_FUNCTION_TRACE("ex_load_table_op");
167 * Make sure that the signature does not match one of the tables that
170 status = acpi_tb_match_signature(operand[0]->string.pointer, NULL);
171 if (status == AE_OK) {
172 /* Signature matched -- don't allow override */
174 return_ACPI_STATUS(AE_ALREADY_EXISTS);
178 /* Find the ACPI table */
180 status = acpi_tb_find_table(operand[0]->string.pointer,
181 operand[1]->string.pointer,
182 operand[2]->string.pointer, &table);
183 if (ACPI_FAILURE(status)) {
184 if (status != AE_NOT_FOUND) {
185 return_ACPI_STATUS(status);
188 /* Table not found, return an Integer=0 and AE_OK */
190 ddb_handle = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
192 return_ACPI_STATUS(AE_NO_MEMORY);
195 ddb_handle->integer.value = 0;
196 *return_desc = ddb_handle;
198 return_ACPI_STATUS(AE_OK);
203 start_node = walk_state->scope_info->scope.node;
204 parent_node = acpi_gbl_root_node;
206 /* root_path (optional parameter) */
208 if (operand[3]->string.length > 0) {
210 * Find the node referenced by the root_path_string. This is the
211 * location within the namespace where the table will be loaded.
214 acpi_ns_get_node_by_path(operand[3]->string.pointer,
215 start_node, ACPI_NS_SEARCH_PARENT,
217 if (ACPI_FAILURE(status)) {
218 return_ACPI_STATUS(status);
222 /* parameter_path (optional parameter) */
224 if (operand[4]->string.length > 0) {
225 if ((operand[4]->string.pointer[0] != '\\') &&
226 (operand[4]->string.pointer[0] != '^')) {
228 * Path is not absolute, so it will be relative to the node
229 * referenced by the root_path_string (or the NS root if omitted)
231 start_node = parent_node;
234 /* Find the node referenced by the parameter_path_string */
237 acpi_ns_get_node_by_path(operand[4]->string.pointer,
238 start_node, ACPI_NS_SEARCH_PARENT,
240 if (ACPI_FAILURE(status)) {
241 return_ACPI_STATUS(status);
245 /* Load the table into the namespace */
247 status = acpi_ex_add_table(table, parent_node, &ddb_handle);
248 if (ACPI_FAILURE(status)) {
249 return_ACPI_STATUS(status);
252 /* Parameter Data (optional) */
254 if (parameter_node) {
255 /* Store the parameter data into the optional parameter object */
257 status = acpi_ex_store(operand[5],
258 ACPI_CAST_PTR(union acpi_operand_object,
261 if (ACPI_FAILURE(status)) {
262 (void)acpi_ex_unload_table(ddb_handle);
263 return_ACPI_STATUS(status);
267 *return_desc = ddb_handle;
268 return_ACPI_STATUS(status);
271 /*******************************************************************************
273 * FUNCTION: acpi_ex_load_op
275 * PARAMETERS: obj_desc - Region or Field where the table will be
277 * Target - Where a handle to the table will be stored
278 * walk_state - Current state
282 * DESCRIPTION: Load an ACPI table from a field or operation region
284 ******************************************************************************/
287 acpi_ex_load_op(union acpi_operand_object *obj_desc,
288 union acpi_operand_object *target,
289 struct acpi_walk_state *walk_state)
292 union acpi_operand_object *ddb_handle;
293 union acpi_operand_object *buffer_desc = NULL;
294 struct acpi_table_header *table_ptr = NULL;
295 acpi_physical_address address;
296 struct acpi_table_header table_header;
299 ACPI_FUNCTION_TRACE("ex_load_op");
301 /* Object can be either an op_region or a Field */
303 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
304 case ACPI_TYPE_REGION:
306 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Load from Region %p %s\n",
308 acpi_ut_get_object_type_name(obj_desc)));
311 * If the Region Address and Length have not been previously evaluated,
312 * evaluate them now and save the results.
314 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
315 status = acpi_ds_get_region_arguments(obj_desc);
316 if (ACPI_FAILURE(status)) {
317 return_ACPI_STATUS(status);
321 /* Get the base physical address of the region */
323 address = obj_desc->region.address;
325 /* Get the table length from the table header */
327 table_header.length = 0;
328 for (i = 0; i < 8; i++) {
330 acpi_ev_address_space_dispatch(obj_desc, ACPI_READ,
331 (acpi_physical_address)
335 if (ACPI_FAILURE(status)) {
336 return_ACPI_STATUS(status);
340 /* Sanity check the table length */
342 if (table_header.length < sizeof(struct acpi_table_header)) {
343 return_ACPI_STATUS(AE_BAD_HEADER);
346 /* Allocate a buffer for the entire table */
348 table_ptr = ACPI_MEM_ALLOCATE(table_header.length);
350 return_ACPI_STATUS(AE_NO_MEMORY);
353 /* Get the entire table from the op region */
355 for (i = 0; i < table_header.length; i++) {
357 acpi_ev_address_space_dispatch(obj_desc, ACPI_READ,
358 (acpi_physical_address)
362 if (ACPI_FAILURE(status)) {
368 case ACPI_TYPE_LOCAL_REGION_FIELD:
369 case ACPI_TYPE_LOCAL_BANK_FIELD:
370 case ACPI_TYPE_LOCAL_INDEX_FIELD:
372 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Load from Field %p %s\n",
374 acpi_ut_get_object_type_name(obj_desc)));
377 * The length of the field must be at least as large as the table.
378 * Read the entire field and thus the entire table. Buffer is
379 * allocated during the read.
382 acpi_ex_read_data_from_field(walk_state, obj_desc,
384 if (ACPI_FAILURE(status)) {
385 return_ACPI_STATUS(status);
388 table_ptr = ACPI_CAST_PTR(struct acpi_table_header,
389 buffer_desc->buffer.pointer);
391 /* All done with the buffer_desc, delete it */
393 buffer_desc->buffer.pointer = NULL;
394 acpi_ut_remove_reference(buffer_desc);
396 /* Sanity check the table length */
398 if (table_ptr->length < sizeof(struct acpi_table_header)) {
399 status = AE_BAD_HEADER;
405 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
408 /* The table must be either an SSDT or a PSDT */
410 if ((!ACPI_STRNCMP(table_ptr->signature,
411 acpi_gbl_table_data[ACPI_TABLE_PSDT].signature,
412 acpi_gbl_table_data[ACPI_TABLE_PSDT].sig_length)) &&
413 (!ACPI_STRNCMP(table_ptr->signature,
414 acpi_gbl_table_data[ACPI_TABLE_SSDT].signature,
415 acpi_gbl_table_data[ACPI_TABLE_SSDT].sig_length))) {
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)) {
427 /* On error, table_ptr was deallocated above */
429 return_ACPI_STATUS(status);
432 /* Store the ddb_handle into the Target operand */
434 status = acpi_ex_store(ddb_handle, target, walk_state);
435 if (ACPI_FAILURE(status)) {
436 (void)acpi_ex_unload_table(ddb_handle);
438 /* table_ptr was deallocated above */
440 return_ACPI_STATUS(status);
444 if (ACPI_FAILURE(status)) {
445 ACPI_MEM_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 struct acpi_table_desc *table_info;
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 actual table descriptor from the ddb_handle */
484 table_info = (struct acpi_table_desc *)table_desc->reference.object;
487 * Delete the entire namespace under this table Node
488 * (Offset contains the table_id)
490 acpi_ns_delete_namespace_by_owner(table_info->owner_id);
491 acpi_ut_release_owner_id(&table_info->owner_id);
493 /* Delete the table itself */
495 (void)acpi_tb_uninstall_table(table_info->installed_desc);
497 /* Delete the table descriptor (ddb_handle) */
499 acpi_ut_remove_reference(table_desc);
500 return_ACPI_STATUS(status);