1 /******************************************************************************
3 * Module Name: excreate - Named object creation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
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>
50 #define _COMPONENT ACPI_EXECUTER
51 ACPI_MODULE_NAME("excreate")
52 #ifndef ACPI_NO_METHOD_EXECUTION
53 /*******************************************************************************
55 * FUNCTION: acpi_ex_create_alias
57 * PARAMETERS: walk_state - Current state, contains operands
61 * DESCRIPTION: Create a new named alias
63 ******************************************************************************/
64 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state)
66 struct acpi_namespace_node *target_node;
67 struct acpi_namespace_node *alias_node;
68 acpi_status status = AE_OK;
70 ACPI_FUNCTION_TRACE(ex_create_alias);
72 /* Get the source/alias operands (both namespace nodes) */
74 alias_node = (struct acpi_namespace_node *)walk_state->operands[0];
75 target_node = (struct acpi_namespace_node *)walk_state->operands[1];
77 if ((target_node->type == ACPI_TYPE_LOCAL_ALIAS) ||
78 (target_node->type == ACPI_TYPE_LOCAL_METHOD_ALIAS)) {
80 * Dereference an existing alias so that we don't create a chain
81 * of aliases. With this code, we guarantee that an alias is
82 * always exactly one level of indirection away from the
83 * actual aliased name.
86 ACPI_CAST_PTR(struct acpi_namespace_node,
91 * For objects that can never change (i.e., the NS node will
92 * permanently point to the same object), we can simply attach
93 * the object to the new NS node. For other objects (such as
94 * Integers, buffers, etc.), we have to point the Alias node
95 * to the original Node.
97 switch (target_node->type) {
99 /* For these types, the sub-object can change dynamically via a Store */
101 case ACPI_TYPE_INTEGER:
102 case ACPI_TYPE_STRING:
103 case ACPI_TYPE_BUFFER:
104 case ACPI_TYPE_PACKAGE:
105 case ACPI_TYPE_BUFFER_FIELD:
108 * These types open a new scope, so we need the NS node in order to access
111 case ACPI_TYPE_DEVICE:
112 case ACPI_TYPE_POWER:
113 case ACPI_TYPE_PROCESSOR:
114 case ACPI_TYPE_THERMAL:
115 case ACPI_TYPE_LOCAL_SCOPE:
118 * The new alias has the type ALIAS and points to the original
119 * NS node, not the object itself.
121 alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
123 ACPI_CAST_PTR(union acpi_operand_object, target_node);
126 case ACPI_TYPE_METHOD:
129 * Control method aliases need to be differentiated
131 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
133 ACPI_CAST_PTR(union acpi_operand_object, target_node);
138 /* Attach the original source object to the new Alias Node */
141 * The new alias assumes the type of the target, and it points
142 * to the same object. The reference count of the object has an
143 * additional reference to prevent deletion out from under either the
144 * target node or the alias Node
146 status = acpi_ns_attach_object(alias_node,
147 acpi_ns_get_attached_object
153 /* Since both operands are Nodes, we don't need to delete them */
155 return_ACPI_STATUS(status);
158 /*******************************************************************************
160 * FUNCTION: acpi_ex_create_event
162 * PARAMETERS: walk_state - Current state
166 * DESCRIPTION: Create a new event object
168 ******************************************************************************/
170 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
173 union acpi_operand_object *obj_desc;
175 ACPI_FUNCTION_TRACE(ex_create_event);
177 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
179 status = AE_NO_MEMORY;
184 * Create the actual OS semaphore, with zero initial units -- meaning
185 * that the event is created in an unsignalled state
187 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
188 &obj_desc->event.os_semaphore);
189 if (ACPI_FAILURE(status)) {
193 /* Attach object to the Node */
196 acpi_ns_attach_object((struct acpi_namespace_node *)walk_state->
197 operands[0], obj_desc, ACPI_TYPE_EVENT);
201 * Remove local reference to the object (on error, will cause deletion
202 * of both object and semaphore if present.)
204 acpi_ut_remove_reference(obj_desc);
205 return_ACPI_STATUS(status);
208 /*******************************************************************************
210 * FUNCTION: acpi_ex_create_mutex
212 * PARAMETERS: walk_state - Current state
216 * DESCRIPTION: Create a new mutex object
218 * Mutex (Name[0], sync_level[1])
220 ******************************************************************************/
222 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
224 acpi_status status = AE_OK;
225 union acpi_operand_object *obj_desc;
227 ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
229 /* Create the new mutex object */
231 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
233 status = AE_NO_MEMORY;
237 /* Create the actual OS Mutex */
239 status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex);
240 if (ACPI_FAILURE(status)) {
244 /* Init object and attach to NS node */
246 obj_desc->mutex.sync_level =
247 (u8) walk_state->operands[1]->integer.value;
248 obj_desc->mutex.node =
249 (struct acpi_namespace_node *)walk_state->operands[0];
252 acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
257 * Remove local reference to the object (on error, will cause deletion
258 * of both object and semaphore if present.)
260 acpi_ut_remove_reference(obj_desc);
261 return_ACPI_STATUS(status);
264 /*******************************************************************************
266 * FUNCTION: acpi_ex_create_region
268 * PARAMETERS: aml_start - Pointer to the region declaration AML
269 * aml_length - Max length of the declaration AML
270 * region_space - space_iD for the region
271 * walk_state - Current state
275 * DESCRIPTION: Create a new operation region object
277 ******************************************************************************/
280 acpi_ex_create_region(u8 * aml_start,
282 u8 region_space, struct acpi_walk_state *walk_state)
285 union acpi_operand_object *obj_desc;
286 struct acpi_namespace_node *node;
287 union acpi_operand_object *region_obj2;
289 ACPI_FUNCTION_TRACE(ex_create_region);
291 /* Get the Namespace Node */
293 node = walk_state->op->common.node;
296 * If the region object is already attached to this node,
299 if (acpi_ns_get_attached_object(node)) {
300 return_ACPI_STATUS(AE_OK);
304 * Space ID must be one of the predefined IDs, or in the user-defined
307 if ((region_space >= ACPI_NUM_PREDEFINED_REGIONS) &&
308 (region_space < ACPI_USER_REGION_BEGIN)) {
309 ACPI_ERROR((AE_INFO, "Invalid AddressSpace type %X",
311 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
314 ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (%X)\n",
315 acpi_ut_get_region_name(region_space), region_space));
317 /* Create the region descriptor */
319 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
321 status = AE_NO_MEMORY;
326 * Remember location in AML stream of address & length
327 * operands since they need to be evaluated at run time.
329 region_obj2 = obj_desc->common.next_object;
330 region_obj2->extra.aml_start = aml_start;
331 region_obj2->extra.aml_length = aml_length;
333 /* Init the region from the operands */
335 obj_desc->region.space_id = region_space;
336 obj_desc->region.address = 0;
337 obj_desc->region.length = 0;
338 obj_desc->region.node = node;
340 /* Install the new region object in the parent Node */
342 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
346 /* Remove local reference to the object */
348 acpi_ut_remove_reference(obj_desc);
349 return_ACPI_STATUS(status);
352 /*******************************************************************************
354 * FUNCTION: acpi_ex_create_processor
356 * PARAMETERS: walk_state - Current state
360 * DESCRIPTION: Create a new processor object and populate the fields
362 * Processor (Name[0], cpu_iD[1], pblock_addr[2], pblock_length[3])
364 ******************************************************************************/
366 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
368 union acpi_operand_object **operand = &walk_state->operands[0];
369 union acpi_operand_object *obj_desc;
372 ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
374 /* Create the processor object */
376 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
378 return_ACPI_STATUS(AE_NO_MEMORY);
381 /* Initialize the processor object from the operands */
383 obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
384 obj_desc->processor.length = (u8) operand[3]->integer.value;
385 obj_desc->processor.address =
386 (acpi_io_address) operand[2]->integer.value;
388 /* Install the processor object in the parent Node */
390 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
391 obj_desc, ACPI_TYPE_PROCESSOR);
393 /* Remove local reference to the object */
395 acpi_ut_remove_reference(obj_desc);
396 return_ACPI_STATUS(status);
399 /*******************************************************************************
401 * FUNCTION: acpi_ex_create_power_resource
403 * PARAMETERS: walk_state - Current state
407 * DESCRIPTION: Create a new power_resource object and populate the fields
409 * power_resource (Name[0], system_level[1], resource_order[2])
411 ******************************************************************************/
413 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
415 union acpi_operand_object **operand = &walk_state->operands[0];
417 union acpi_operand_object *obj_desc;
419 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
421 /* Create the power resource object */
423 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
425 return_ACPI_STATUS(AE_NO_MEMORY);
428 /* Initialize the power object from the operands */
430 obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
431 obj_desc->power_resource.resource_order =
432 (u16) operand[2]->integer.value;
434 /* Install the power resource object in the parent Node */
436 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
437 obj_desc, ACPI_TYPE_POWER);
439 /* Remove local reference to the object */
441 acpi_ut_remove_reference(obj_desc);
442 return_ACPI_STATUS(status);
446 /*******************************************************************************
448 * FUNCTION: acpi_ex_create_method
450 * PARAMETERS: aml_start - First byte of the method's AML
451 * aml_length - AML byte count for this method
452 * walk_state - Current state
456 * DESCRIPTION: Create a new method object
458 ******************************************************************************/
461 acpi_ex_create_method(u8 * aml_start,
462 u32 aml_length, struct acpi_walk_state *walk_state)
464 union acpi_operand_object **operand = &walk_state->operands[0];
465 union acpi_operand_object *obj_desc;
469 ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
471 /* Create a new method object */
473 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
475 status = AE_NO_MEMORY;
479 /* Save the method's AML pointer and length */
481 obj_desc->method.aml_start = aml_start;
482 obj_desc->method.aml_length = aml_length;
485 * Disassemble the method flags. Split off the Arg Count
488 method_flags = (u8) operand[1]->integer.value;
490 obj_desc->method.method_flags =
491 (u8) (method_flags & ~AML_METHOD_ARG_COUNT);
492 obj_desc->method.param_count =
493 (u8) (method_flags & AML_METHOD_ARG_COUNT);
496 * Get the sync_level. If method is serialized, a mutex will be
497 * created for this method when it is parsed.
499 if (method_flags & AML_METHOD_SERIALIZED) {
501 * ACPI 1.0: sync_level = 0
502 * ACPI 2.0: sync_level = sync_level in method declaration
504 obj_desc->method.sync_level = (u8)
505 ((method_flags & AML_METHOD_SYNC_LEVEL) >> 4);
508 /* Attach the new object to the method Node */
510 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
511 obj_desc, ACPI_TYPE_METHOD);
513 /* Remove local reference to the object */
515 acpi_ut_remove_reference(obj_desc);
518 /* Remove a reference to the operand */
520 acpi_ut_remove_reference(operand[1]);
521 return_ACPI_STATUS(status);