1 /******************************************************************************
3 * Module Name: excreate - Named object creation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2007, 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>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("excreate")
53 #ifndef ACPI_NO_METHOD_EXECUTION
54 /*******************************************************************************
56 * FUNCTION: acpi_ex_create_alias
58 * PARAMETERS: walk_state - Current state, contains operands
62 * DESCRIPTION: Create a new named alias
64 ******************************************************************************/
65 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state)
67 struct acpi_namespace_node *target_node;
68 struct acpi_namespace_node *alias_node;
69 acpi_status status = AE_OK;
71 ACPI_FUNCTION_TRACE(ex_create_alias);
73 /* Get the source/alias operands (both namespace nodes) */
75 alias_node = (struct acpi_namespace_node *)walk_state->operands[0];
76 target_node = (struct acpi_namespace_node *)walk_state->operands[1];
78 if ((target_node->type == ACPI_TYPE_LOCAL_ALIAS) ||
79 (target_node->type == ACPI_TYPE_LOCAL_METHOD_ALIAS)) {
81 * Dereference an existing alias so that we don't create a chain
82 * of aliases. With this code, we guarantee that an alias is
83 * always exactly one level of indirection away from the
84 * actual aliased name.
87 ACPI_CAST_PTR(struct acpi_namespace_node,
92 * For objects that can never change (i.e., the NS node will
93 * permanently point to the same object), we can simply attach
94 * the object to the new NS node. For other objects (such as
95 * Integers, buffers, etc.), we have to point the Alias node
96 * to the original Node.
98 switch (target_node->type) {
100 /* For these types, the sub-object can change dynamically via a Store */
102 case ACPI_TYPE_INTEGER:
103 case ACPI_TYPE_STRING:
104 case ACPI_TYPE_BUFFER:
105 case ACPI_TYPE_PACKAGE:
106 case ACPI_TYPE_BUFFER_FIELD:
109 * These types open a new scope, so we need the NS node in order to access
112 case ACPI_TYPE_DEVICE:
113 case ACPI_TYPE_POWER:
114 case ACPI_TYPE_PROCESSOR:
115 case ACPI_TYPE_THERMAL:
116 case ACPI_TYPE_LOCAL_SCOPE:
119 * The new alias has the type ALIAS and points to the original
120 * NS node, not the object itself.
122 alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
124 ACPI_CAST_PTR(union acpi_operand_object, target_node);
127 case ACPI_TYPE_METHOD:
130 * Control method aliases need to be differentiated
132 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
134 ACPI_CAST_PTR(union acpi_operand_object, target_node);
139 /* Attach the original source object to the new Alias Node */
142 * The new alias assumes the type of the target, and it points
143 * to the same object. The reference count of the object has an
144 * additional reference to prevent deletion out from under either the
145 * target node or the alias Node
147 status = acpi_ns_attach_object(alias_node,
148 acpi_ns_get_attached_object
154 /* Since both operands are Nodes, we don't need to delete them */
156 return_ACPI_STATUS(status);
159 /*******************************************************************************
161 * FUNCTION: acpi_ex_create_event
163 * PARAMETERS: walk_state - Current state
167 * DESCRIPTION: Create a new event object
169 ******************************************************************************/
171 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
174 union acpi_operand_object *obj_desc;
176 ACPI_FUNCTION_TRACE(ex_create_event);
178 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
180 status = AE_NO_MEMORY;
185 * Create the actual OS semaphore, with zero initial units -- meaning
186 * that the event is created in an unsignalled state
188 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
189 &obj_desc->event.os_semaphore);
190 if (ACPI_FAILURE(status)) {
194 /* Attach object to the Node */
197 acpi_ns_attach_object((struct acpi_namespace_node *)walk_state->
198 operands[0], obj_desc, ACPI_TYPE_EVENT);
202 * Remove local reference to the object (on error, will cause deletion
203 * of both object and semaphore if present.)
205 acpi_ut_remove_reference(obj_desc);
206 return_ACPI_STATUS(status);
209 /*******************************************************************************
211 * FUNCTION: acpi_ex_create_mutex
213 * PARAMETERS: walk_state - Current state
217 * DESCRIPTION: Create a new mutex object
219 * Mutex (Name[0], sync_level[1])
221 ******************************************************************************/
223 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
225 acpi_status status = AE_OK;
226 union acpi_operand_object *obj_desc;
228 ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
230 /* Create the new mutex object */
232 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
234 status = AE_NO_MEMORY;
238 /* Create the actual OS Mutex */
240 status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex);
241 if (ACPI_FAILURE(status)) {
245 /* Init object and attach to NS node */
247 obj_desc->mutex.sync_level =
248 (u8) walk_state->operands[1]->integer.value;
249 obj_desc->mutex.node =
250 (struct acpi_namespace_node *)walk_state->operands[0];
253 acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
258 * Remove local reference to the object (on error, will cause deletion
259 * of both object and semaphore if present.)
261 acpi_ut_remove_reference(obj_desc);
262 return_ACPI_STATUS(status);
265 /*******************************************************************************
267 * FUNCTION: acpi_ex_create_region
269 * PARAMETERS: aml_start - Pointer to the region declaration AML
270 * aml_length - Max length of the declaration AML
271 * region_space - space_iD for the region
272 * walk_state - Current state
276 * DESCRIPTION: Create a new operation region object
278 ******************************************************************************/
281 acpi_ex_create_region(u8 * aml_start,
283 u8 region_space, struct acpi_walk_state *walk_state)
286 union acpi_operand_object *obj_desc;
287 struct acpi_namespace_node *node;
288 union acpi_operand_object *region_obj2;
290 ACPI_FUNCTION_TRACE(ex_create_region);
292 /* Get the Namespace Node */
294 node = walk_state->op->common.node;
297 * If the region object is already attached to this node,
300 if (acpi_ns_get_attached_object(node)) {
301 return_ACPI_STATUS(AE_OK);
305 * Space ID must be one of the predefined IDs, or in the user-defined
308 if ((region_space >= ACPI_NUM_PREDEFINED_REGIONS) &&
309 (region_space < ACPI_USER_REGION_BEGIN)) {
310 ACPI_ERROR((AE_INFO, "Invalid AddressSpace type %X",
312 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
315 ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (%X)\n",
316 acpi_ut_get_region_name(region_space), region_space));
318 /* Create the region descriptor */
320 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
322 status = AE_NO_MEMORY;
327 * Remember location in AML stream of address & length
328 * operands since they need to be evaluated at run time.
330 region_obj2 = obj_desc->common.next_object;
331 region_obj2->extra.aml_start = aml_start;
332 region_obj2->extra.aml_length = aml_length;
334 /* Init the region from the operands */
336 obj_desc->region.space_id = region_space;
337 obj_desc->region.address = 0;
338 obj_desc->region.length = 0;
339 obj_desc->region.node = node;
341 /* Install the new region object in the parent Node */
343 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
347 /* Remove local reference to the object */
349 acpi_ut_remove_reference(obj_desc);
350 return_ACPI_STATUS(status);
353 /*******************************************************************************
355 * FUNCTION: acpi_ex_create_table_region
357 * PARAMETERS: walk_state - Current state
361 * DESCRIPTION: Create a new data_table_region object
363 ******************************************************************************/
365 acpi_status acpi_ex_create_table_region(struct acpi_walk_state *walk_state)
368 union acpi_operand_object **operand = &walk_state->operands[0];
369 union acpi_operand_object *obj_desc;
370 struct acpi_namespace_node *node;
371 union acpi_operand_object *region_obj2;
372 acpi_native_uint table_index;
373 struct acpi_table_header *table;
375 ACPI_FUNCTION_TRACE(ex_create_table_region);
377 /* Get the Node from the object stack */
379 node = walk_state->op->common.node;
382 * If the region object is already attached to this node,
385 if (acpi_ns_get_attached_object(node)) {
386 return_ACPI_STATUS(AE_OK);
389 /* Find the ACPI table */
391 status = acpi_tb_find_table(operand[1]->string.pointer,
392 operand[2]->string.pointer,
393 operand[3]->string.pointer, &table_index);
394 if (ACPI_FAILURE(status)) {
395 return_ACPI_STATUS(status);
398 /* Create the region descriptor */
400 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
402 return_ACPI_STATUS(AE_NO_MEMORY);
405 region_obj2 = obj_desc->common.next_object;
406 region_obj2->extra.region_context = NULL;
408 status = acpi_get_table_by_index(table_index, &table);
409 if (ACPI_FAILURE(status)) {
410 return_ACPI_STATUS(status);
413 /* Init the region from the operands */
415 obj_desc->region.space_id = REGION_DATA_TABLE;
416 obj_desc->region.address =
417 (acpi_physical_address) ACPI_TO_INTEGER(table);
418 obj_desc->region.length = table->length;
419 obj_desc->region.node = node;
420 obj_desc->region.flags = AOPOBJ_DATA_VALID;
422 /* Install the new region object in the parent Node */
424 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
425 if (ACPI_FAILURE(status)) {
429 status = acpi_ev_initialize_region(obj_desc, FALSE);
430 if (ACPI_FAILURE(status)) {
431 if (status == AE_NOT_EXIST) {
438 obj_desc->region.flags |= AOPOBJ_SETUP_COMPLETE;
442 /* Remove local reference to the object */
444 acpi_ut_remove_reference(obj_desc);
445 return_ACPI_STATUS(status);
448 /*******************************************************************************
450 * FUNCTION: acpi_ex_create_processor
452 * PARAMETERS: walk_state - Current state
456 * DESCRIPTION: Create a new processor object and populate the fields
458 * Processor (Name[0], cpu_iD[1], pblock_addr[2], pblock_length[3])
460 ******************************************************************************/
462 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
464 union acpi_operand_object **operand = &walk_state->operands[0];
465 union acpi_operand_object *obj_desc;
468 ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
470 /* Create the processor object */
472 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
474 return_ACPI_STATUS(AE_NO_MEMORY);
477 /* Initialize the processor object from the operands */
479 obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
480 obj_desc->processor.length = (u8) operand[3]->integer.value;
481 obj_desc->processor.address =
482 (acpi_io_address) operand[2]->integer.value;
484 /* Install the processor object in the parent Node */
486 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
487 obj_desc, ACPI_TYPE_PROCESSOR);
489 /* Remove local reference to the object */
491 acpi_ut_remove_reference(obj_desc);
492 return_ACPI_STATUS(status);
495 /*******************************************************************************
497 * FUNCTION: acpi_ex_create_power_resource
499 * PARAMETERS: walk_state - Current state
503 * DESCRIPTION: Create a new power_resource object and populate the fields
505 * power_resource (Name[0], system_level[1], resource_order[2])
507 ******************************************************************************/
509 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
511 union acpi_operand_object **operand = &walk_state->operands[0];
513 union acpi_operand_object *obj_desc;
515 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
517 /* Create the power resource object */
519 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
521 return_ACPI_STATUS(AE_NO_MEMORY);
524 /* Initialize the power object from the operands */
526 obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
527 obj_desc->power_resource.resource_order =
528 (u16) operand[2]->integer.value;
530 /* Install the power resource object in the parent Node */
532 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
533 obj_desc, ACPI_TYPE_POWER);
535 /* Remove local reference to the object */
537 acpi_ut_remove_reference(obj_desc);
538 return_ACPI_STATUS(status);
542 /*******************************************************************************
544 * FUNCTION: acpi_ex_create_method
546 * PARAMETERS: aml_start - First byte of the method's AML
547 * aml_length - AML byte count for this method
548 * walk_state - Current state
552 * DESCRIPTION: Create a new method object
554 ******************************************************************************/
557 acpi_ex_create_method(u8 * aml_start,
558 u32 aml_length, struct acpi_walk_state *walk_state)
560 union acpi_operand_object **operand = &walk_state->operands[0];
561 union acpi_operand_object *obj_desc;
565 ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
567 /* Create a new method object */
569 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
571 status = AE_NO_MEMORY;
575 /* Save the method's AML pointer and length */
577 obj_desc->method.aml_start = aml_start;
578 obj_desc->method.aml_length = aml_length;
581 * Disassemble the method flags. Split off the Arg Count
584 method_flags = (u8) operand[1]->integer.value;
586 obj_desc->method.method_flags =
587 (u8) (method_flags & ~AML_METHOD_ARG_COUNT);
588 obj_desc->method.param_count =
589 (u8) (method_flags & AML_METHOD_ARG_COUNT);
592 * Get the sync_level. If method is serialized, a mutex will be
593 * created for this method when it is parsed.
595 if (method_flags & AML_METHOD_SERIALIZED) {
597 * ACPI 1.0: sync_level = 0
598 * ACPI 2.0: sync_level = sync_level in method declaration
600 obj_desc->method.sync_level = (u8)
601 ((method_flags & AML_METHOD_SYNCH_LEVEL) >> 4);
604 /* Attach the new object to the method Node */
606 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
607 obj_desc, ACPI_TYPE_METHOD);
609 /* Remove local reference to the object */
611 acpi_ut_remove_reference(obj_desc);
614 /* Remove a reference to the operand */
616 acpi_ut_remove_reference(operand[1]);
617 return_ACPI_STATUS(status);