1 /******************************************************************************
3 * Module Name: excreate - Named object creation
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>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("excreate")
54 #ifndef ACPI_NO_METHOD_EXECUTION
55 /*******************************************************************************
57 * FUNCTION: acpi_ex_create_alias
59 * PARAMETERS: walk_state - Current state, contains operands
63 * DESCRIPTION: Create a new named alias
65 ******************************************************************************/
66 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state)
68 struct acpi_namespace_node *target_node;
69 struct acpi_namespace_node *alias_node;
70 acpi_status status = AE_OK;
72 ACPI_FUNCTION_TRACE(ex_create_alias);
74 /* Get the source/alias operands (both namespace nodes) */
76 alias_node = (struct acpi_namespace_node *)walk_state->operands[0];
77 target_node = (struct acpi_namespace_node *)walk_state->operands[1];
79 if ((target_node->type == ACPI_TYPE_LOCAL_ALIAS) ||
80 (target_node->type == ACPI_TYPE_LOCAL_METHOD_ALIAS)) {
82 * Dereference an existing alias so that we don't create a chain
83 * of aliases. With this code, we guarantee that an alias is
84 * always exactly one level of indirection away from the
85 * actual aliased name.
88 ACPI_CAST_PTR(struct acpi_namespace_node,
93 * For objects that can never change (i.e., the NS node will
94 * permanently point to the same object), we can simply attach
95 * the object to the new NS node. For other objects (such as
96 * Integers, buffers, etc.), we have to point the Alias node
97 * to the original Node.
99 switch (target_node->type) {
100 case ACPI_TYPE_INTEGER:
101 case ACPI_TYPE_STRING:
102 case ACPI_TYPE_BUFFER:
103 case ACPI_TYPE_PACKAGE:
104 case ACPI_TYPE_BUFFER_FIELD:
107 * The new alias has the type ALIAS and points to the original
108 * NS node, not the object itself. This is because for these
109 * types, the object can change dynamically via a Store.
111 alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
113 ACPI_CAST_PTR(union acpi_operand_object, target_node);
116 case ACPI_TYPE_METHOD:
119 * The new alias has the type ALIAS and points to the original
120 * NS node, not the object itself. This is because for these
121 * types, the object can change dynamically via a Store.
123 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
125 ACPI_CAST_PTR(union acpi_operand_object, target_node);
130 /* Attach the original source object to the new Alias Node */
133 * The new alias assumes the type of the target, and it points
134 * to the same object. The reference count of the object has an
135 * additional reference to prevent deletion out from under either the
136 * target node or the alias Node
138 status = acpi_ns_attach_object(alias_node,
139 acpi_ns_get_attached_object
145 /* Since both operands are Nodes, we don't need to delete them */
147 return_ACPI_STATUS(status);
150 /*******************************************************************************
152 * FUNCTION: acpi_ex_create_event
154 * PARAMETERS: walk_state - Current state
158 * DESCRIPTION: Create a new event object
160 ******************************************************************************/
162 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
165 union acpi_operand_object *obj_desc;
167 ACPI_FUNCTION_TRACE(ex_create_event);
169 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
171 status = AE_NO_MEMORY;
176 * Create the actual OS semaphore, with zero initial units -- meaning
177 * that the event is created in an unsignalled state
179 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
180 &obj_desc->event.semaphore);
181 if (ACPI_FAILURE(status)) {
185 /* Attach object to the Node */
188 acpi_ns_attach_object((struct acpi_namespace_node *)walk_state->
189 operands[0], obj_desc, ACPI_TYPE_EVENT);
193 * Remove local reference to the object (on error, will cause deletion
194 * of both object and semaphore if present.)
196 acpi_ut_remove_reference(obj_desc);
197 return_ACPI_STATUS(status);
200 /*******************************************************************************
202 * FUNCTION: acpi_ex_create_mutex
204 * PARAMETERS: walk_state - Current state
208 * DESCRIPTION: Create a new mutex object
210 * Mutex (Name[0], sync_level[1])
212 ******************************************************************************/
214 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
216 acpi_status status = AE_OK;
217 union acpi_operand_object *obj_desc;
219 ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
221 /* Create the new mutex object */
223 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
225 status = AE_NO_MEMORY;
230 * Create the actual OS semaphore.
231 * One unit max to make it a mutex, with one initial unit to allow
232 * the mutex to be acquired.
234 status = acpi_os_create_semaphore(1, 1, &obj_desc->mutex.semaphore);
235 if (ACPI_FAILURE(status)) {
239 /* Init object and attach to NS node */
241 obj_desc->mutex.sync_level =
242 (u8) walk_state->operands[1]->integer.value;
243 obj_desc->mutex.node =
244 (struct acpi_namespace_node *)walk_state->operands[0];
247 acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
252 * Remove local reference to the object (on error, will cause deletion
253 * of both object and semaphore if present.)
255 acpi_ut_remove_reference(obj_desc);
256 return_ACPI_STATUS(status);
259 /*******************************************************************************
261 * FUNCTION: acpi_ex_create_region
263 * PARAMETERS: aml_start - Pointer to the region declaration AML
264 * aml_length - Max length of the declaration AML
265 * region_space - space_iD for the region
266 * walk_state - Current state
270 * DESCRIPTION: Create a new operation region object
272 ******************************************************************************/
275 acpi_ex_create_region(u8 * aml_start,
277 u8 region_space, struct acpi_walk_state *walk_state)
280 union acpi_operand_object *obj_desc;
281 struct acpi_namespace_node *node;
282 union acpi_operand_object *region_obj2;
284 ACPI_FUNCTION_TRACE(ex_create_region);
286 /* Get the Namespace Node */
288 node = walk_state->op->common.node;
291 * If the region object is already attached to this node,
294 if (acpi_ns_get_attached_object(node)) {
295 return_ACPI_STATUS(AE_OK);
299 * Space ID must be one of the predefined IDs, or in the user-defined
302 if ((region_space >= ACPI_NUM_PREDEFINED_REGIONS) &&
303 (region_space < ACPI_USER_REGION_BEGIN)) {
304 ACPI_ERROR((AE_INFO, "Invalid AddressSpace type %X",
306 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
309 ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (%X)\n",
310 acpi_ut_get_region_name(region_space), region_space));
312 /* Create the region descriptor */
314 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
316 status = AE_NO_MEMORY;
321 * Remember location in AML stream of address & length
322 * operands since they need to be evaluated at run time.
324 region_obj2 = obj_desc->common.next_object;
325 region_obj2->extra.aml_start = aml_start;
326 region_obj2->extra.aml_length = aml_length;
328 /* Init the region from the operands */
330 obj_desc->region.space_id = region_space;
331 obj_desc->region.address = 0;
332 obj_desc->region.length = 0;
333 obj_desc->region.node = node;
335 /* Install the new region object in the parent Node */
337 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
341 /* Remove local reference to the object */
343 acpi_ut_remove_reference(obj_desc);
344 return_ACPI_STATUS(status);
347 /*******************************************************************************
349 * FUNCTION: acpi_ex_create_table_region
351 * PARAMETERS: walk_state - Current state
355 * DESCRIPTION: Create a new data_table_region object
357 ******************************************************************************/
359 acpi_status acpi_ex_create_table_region(struct acpi_walk_state *walk_state)
362 union acpi_operand_object **operand = &walk_state->operands[0];
363 union acpi_operand_object *obj_desc;
364 struct acpi_namespace_node *node;
365 struct acpi_table_header *table;
366 union acpi_operand_object *region_obj2;
368 ACPI_FUNCTION_TRACE(ex_create_table_region);
370 /* Get the Node from the object stack */
372 node = walk_state->op->common.node;
375 * If the region object is already attached to this node,
378 if (acpi_ns_get_attached_object(node)) {
379 return_ACPI_STATUS(AE_OK);
382 /* Find the ACPI table */
384 status = acpi_tb_find_table(operand[1]->string.pointer,
385 operand[2]->string.pointer,
386 operand[3]->string.pointer, &table);
387 if (ACPI_FAILURE(status)) {
388 return_ACPI_STATUS(status);
391 /* Create the region descriptor */
393 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
395 return_ACPI_STATUS(AE_NO_MEMORY);
398 region_obj2 = obj_desc->common.next_object;
399 region_obj2->extra.region_context = NULL;
401 /* Init the region from the operands */
403 obj_desc->region.space_id = REGION_DATA_TABLE;
404 obj_desc->region.address =
405 (acpi_physical_address) ACPI_TO_INTEGER(table);
406 obj_desc->region.length = table->length;
407 obj_desc->region.node = node;
408 obj_desc->region.flags = AOPOBJ_DATA_VALID;
410 /* Install the new region object in the parent Node */
412 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
413 if (ACPI_FAILURE(status)) {
417 status = acpi_ev_initialize_region(obj_desc, FALSE);
418 if (ACPI_FAILURE(status)) {
419 if (status == AE_NOT_EXIST) {
426 obj_desc->region.flags |= AOPOBJ_SETUP_COMPLETE;
430 /* Remove local reference to the object */
432 acpi_ut_remove_reference(obj_desc);
433 return_ACPI_STATUS(status);
436 /*******************************************************************************
438 * FUNCTION: acpi_ex_create_processor
440 * PARAMETERS: walk_state - Current state
444 * DESCRIPTION: Create a new processor object and populate the fields
446 * Processor (Name[0], cpu_iD[1], pblock_addr[2], pblock_length[3])
448 ******************************************************************************/
450 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
452 union acpi_operand_object **operand = &walk_state->operands[0];
453 union acpi_operand_object *obj_desc;
456 ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
458 /* Create the processor object */
460 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
462 return_ACPI_STATUS(AE_NO_MEMORY);
465 /* Initialize the processor object from the operands */
467 obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
468 obj_desc->processor.length = (u8) operand[3]->integer.value;
469 obj_desc->processor.address =
470 (acpi_io_address) operand[2]->integer.value;
472 /* Install the processor object in the parent Node */
474 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
475 obj_desc, ACPI_TYPE_PROCESSOR);
477 /* Remove local reference to the object */
479 acpi_ut_remove_reference(obj_desc);
480 return_ACPI_STATUS(status);
483 /*******************************************************************************
485 * FUNCTION: acpi_ex_create_power_resource
487 * PARAMETERS: walk_state - Current state
491 * DESCRIPTION: Create a new power_resource object and populate the fields
493 * power_resource (Name[0], system_level[1], resource_order[2])
495 ******************************************************************************/
497 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
499 union acpi_operand_object **operand = &walk_state->operands[0];
501 union acpi_operand_object *obj_desc;
503 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
505 /* Create the power resource object */
507 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
509 return_ACPI_STATUS(AE_NO_MEMORY);
512 /* Initialize the power object from the operands */
514 obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
515 obj_desc->power_resource.resource_order =
516 (u16) operand[2]->integer.value;
518 /* Install the power resource object in the parent Node */
520 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
521 obj_desc, ACPI_TYPE_POWER);
523 /* Remove local reference to the object */
525 acpi_ut_remove_reference(obj_desc);
526 return_ACPI_STATUS(status);
530 /*******************************************************************************
532 * FUNCTION: acpi_ex_create_method
534 * PARAMETERS: aml_start - First byte of the method's AML
535 * aml_length - AML byte count for this method
536 * walk_state - Current state
540 * DESCRIPTION: Create a new method object
542 ******************************************************************************/
545 acpi_ex_create_method(u8 * aml_start,
546 u32 aml_length, struct acpi_walk_state *walk_state)
548 union acpi_operand_object **operand = &walk_state->operands[0];
549 union acpi_operand_object *obj_desc;
553 ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
555 /* Create a new method object */
557 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
559 return_ACPI_STATUS(AE_NO_MEMORY);
562 /* Save the method's AML pointer and length */
564 obj_desc->method.aml_start = aml_start;
565 obj_desc->method.aml_length = aml_length;
568 * Disassemble the method flags. Split off the Arg Count
571 method_flags = (u8) operand[1]->integer.value;
573 obj_desc->method.method_flags =
574 (u8) (method_flags & ~AML_METHOD_ARG_COUNT);
575 obj_desc->method.param_count =
576 (u8) (method_flags & AML_METHOD_ARG_COUNT);
579 * Get the concurrency count. If required, a semaphore will be
580 * created for this method when it is parsed.
582 if (acpi_gbl_all_methods_serialized) {
583 obj_desc->method.concurrency = 1;
584 obj_desc->method.method_flags |= AML_METHOD_SERIALIZED;
585 } else if (method_flags & AML_METHOD_SERIALIZED) {
587 * ACPI 1.0: Concurrency = 1
588 * ACPI 2.0: Concurrency = (sync_level (in method declaration) + 1)
590 obj_desc->method.concurrency = (u8)
591 (((method_flags & AML_METHOD_SYNCH_LEVEL) >> 4) + 1);
593 obj_desc->method.concurrency = ACPI_INFINITE_CONCURRENCY;
596 /* Attach the new object to the method Node */
598 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
599 obj_desc, ACPI_TYPE_METHOD);
601 /* Remove local reference to the object */
603 acpi_ut_remove_reference(obj_desc);
605 /* Remove a reference to the operand */
607 acpi_ut_remove_reference(operand[1]);
608 return_ACPI_STATUS(status);