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>
45 #include <acpi/acinterp.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
49 #define _COMPONENT ACPI_EXECUTER
50 ACPI_MODULE_NAME("excreate")
51 #ifndef ACPI_NO_METHOD_EXECUTION
52 /*******************************************************************************
54 * FUNCTION: acpi_ex_create_alias
56 * PARAMETERS: walk_state - Current state, contains operands
60 * DESCRIPTION: Create a new named alias
62 ******************************************************************************/
63 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state)
65 struct acpi_namespace_node *target_node;
66 struct acpi_namespace_node *alias_node;
67 acpi_status status = AE_OK;
69 ACPI_FUNCTION_TRACE(ex_create_alias);
71 /* Get the source/alias operands (both namespace nodes) */
73 alias_node = (struct acpi_namespace_node *)walk_state->operands[0];
74 target_node = (struct acpi_namespace_node *)walk_state->operands[1];
76 if ((target_node->type == ACPI_TYPE_LOCAL_ALIAS) ||
77 (target_node->type == ACPI_TYPE_LOCAL_METHOD_ALIAS)) {
79 * Dereference an existing alias so that we don't create a chain
80 * of aliases. With this code, we guarantee that an alias is
81 * always exactly one level of indirection away from the
82 * actual aliased name.
85 ACPI_CAST_PTR(struct acpi_namespace_node,
90 * For objects that can never change (i.e., the NS node will
91 * permanently point to the same object), we can simply attach
92 * the object to the new NS node. For other objects (such as
93 * Integers, buffers, etc.), we have to point the Alias node
94 * to the original Node.
96 switch (target_node->type) {
98 /* For these types, the sub-object can change dynamically via a Store */
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 * These types open a new scope, so we need the NS node in order to access
110 case ACPI_TYPE_DEVICE:
111 case ACPI_TYPE_POWER:
112 case ACPI_TYPE_PROCESSOR:
113 case ACPI_TYPE_THERMAL:
114 case ACPI_TYPE_LOCAL_SCOPE:
117 * The new alias has the type ALIAS and points to the original
118 * NS node, not the object itself.
120 alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
122 ACPI_CAST_PTR(union acpi_operand_object, target_node);
125 case ACPI_TYPE_METHOD:
128 * Control method aliases need to be differentiated
130 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
132 ACPI_CAST_PTR(union acpi_operand_object, target_node);
137 /* Attach the original source object to the new Alias Node */
140 * The new alias assumes the type of the target, and it points
141 * to the same object. The reference count of the object has an
142 * additional reference to prevent deletion out from under either the
143 * target node or the alias Node
145 status = acpi_ns_attach_object(alias_node,
146 acpi_ns_get_attached_object
152 /* Since both operands are Nodes, we don't need to delete them */
154 return_ACPI_STATUS(status);
157 /*******************************************************************************
159 * FUNCTION: acpi_ex_create_event
161 * PARAMETERS: walk_state - Current state
165 * DESCRIPTION: Create a new event object
167 ******************************************************************************/
169 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
172 union acpi_operand_object *obj_desc;
174 ACPI_FUNCTION_TRACE(ex_create_event);
176 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
178 status = AE_NO_MEMORY;
183 * Create the actual OS semaphore, with zero initial units -- meaning
184 * that the event is created in an unsignalled state
186 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
187 &obj_desc->event.os_semaphore);
188 if (ACPI_FAILURE(status)) {
192 /* Attach object to the Node */
195 acpi_ns_attach_object((struct acpi_namespace_node *)walk_state->
196 operands[0], obj_desc, ACPI_TYPE_EVENT);
200 * Remove local reference to the object (on error, will cause deletion
201 * of both object and semaphore if present.)
203 acpi_ut_remove_reference(obj_desc);
204 return_ACPI_STATUS(status);
207 /*******************************************************************************
209 * FUNCTION: acpi_ex_create_mutex
211 * PARAMETERS: walk_state - Current state
215 * DESCRIPTION: Create a new mutex object
217 * Mutex (Name[0], sync_level[1])
219 ******************************************************************************/
221 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
223 acpi_status status = AE_OK;
224 union acpi_operand_object *obj_desc;
226 ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
228 /* Create the new mutex object */
230 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
232 status = AE_NO_MEMORY;
236 /* Create the actual OS Mutex */
238 status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex);
239 if (ACPI_FAILURE(status)) {
243 /* Init object and attach to NS node */
245 obj_desc->mutex.sync_level =
246 (u8) walk_state->operands[1]->integer.value;
247 obj_desc->mutex.node =
248 (struct acpi_namespace_node *)walk_state->operands[0];
251 acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
256 * Remove local reference to the object (on error, will cause deletion
257 * of both object and semaphore if present.)
259 acpi_ut_remove_reference(obj_desc);
260 return_ACPI_STATUS(status);
263 /*******************************************************************************
265 * FUNCTION: acpi_ex_create_region
267 * PARAMETERS: aml_start - Pointer to the region declaration AML
268 * aml_length - Max length of the declaration AML
269 * region_space - space_iD for the region
270 * walk_state - Current state
274 * DESCRIPTION: Create a new operation region object
276 ******************************************************************************/
279 acpi_ex_create_region(u8 * aml_start,
281 u8 region_space, struct acpi_walk_state *walk_state)
284 union acpi_operand_object *obj_desc;
285 struct acpi_namespace_node *node;
286 union acpi_operand_object *region_obj2;
288 ACPI_FUNCTION_TRACE(ex_create_region);
290 /* Get the Namespace Node */
292 node = walk_state->op->common.node;
295 * If the region object is already attached to this node,
298 if (acpi_ns_get_attached_object(node)) {
299 return_ACPI_STATUS(AE_OK);
303 * Space ID must be one of the predefined IDs, or in the user-defined
306 if ((region_space >= ACPI_NUM_PREDEFINED_REGIONS) &&
307 (region_space < ACPI_USER_REGION_BEGIN)) {
308 ACPI_ERROR((AE_INFO, "Invalid AddressSpace type %X",
310 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
313 ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (%X)\n",
314 acpi_ut_get_region_name(region_space), region_space));
316 /* Create the region descriptor */
318 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
320 status = AE_NO_MEMORY;
325 * Remember location in AML stream of address & length
326 * operands since they need to be evaluated at run time.
328 region_obj2 = obj_desc->common.next_object;
329 region_obj2->extra.aml_start = aml_start;
330 region_obj2->extra.aml_length = aml_length;
332 /* Init the region from the operands */
334 obj_desc->region.space_id = region_space;
335 obj_desc->region.address = 0;
336 obj_desc->region.length = 0;
337 obj_desc->region.node = node;
339 /* Install the new region object in the parent Node */
341 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
345 /* Remove local reference to the object */
347 acpi_ut_remove_reference(obj_desc);
348 return_ACPI_STATUS(status);
351 /*******************************************************************************
353 * FUNCTION: acpi_ex_create_processor
355 * PARAMETERS: walk_state - Current state
359 * DESCRIPTION: Create a new processor object and populate the fields
361 * Processor (Name[0], cpu_iD[1], pblock_addr[2], pblock_length[3])
363 ******************************************************************************/
365 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
367 union acpi_operand_object **operand = &walk_state->operands[0];
368 union acpi_operand_object *obj_desc;
371 ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
373 /* Create the processor object */
375 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
377 return_ACPI_STATUS(AE_NO_MEMORY);
380 /* Initialize the processor object from the operands */
382 obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
383 obj_desc->processor.length = (u8) operand[3]->integer.value;
384 obj_desc->processor.address =
385 (acpi_io_address) operand[2]->integer.value;
387 /* Install the processor object in the parent Node */
389 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
390 obj_desc, ACPI_TYPE_PROCESSOR);
392 /* Remove local reference to the object */
394 acpi_ut_remove_reference(obj_desc);
395 return_ACPI_STATUS(status);
398 /*******************************************************************************
400 * FUNCTION: acpi_ex_create_power_resource
402 * PARAMETERS: walk_state - Current state
406 * DESCRIPTION: Create a new power_resource object and populate the fields
408 * power_resource (Name[0], system_level[1], resource_order[2])
410 ******************************************************************************/
412 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
414 union acpi_operand_object **operand = &walk_state->operands[0];
416 union acpi_operand_object *obj_desc;
418 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
420 /* Create the power resource object */
422 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
424 return_ACPI_STATUS(AE_NO_MEMORY);
427 /* Initialize the power object from the operands */
429 obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
430 obj_desc->power_resource.resource_order =
431 (u16) operand[2]->integer.value;
433 /* Install the power resource object in the parent Node */
435 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
436 obj_desc, ACPI_TYPE_POWER);
438 /* Remove local reference to the object */
440 acpi_ut_remove_reference(obj_desc);
441 return_ACPI_STATUS(status);
445 /*******************************************************************************
447 * FUNCTION: acpi_ex_create_method
449 * PARAMETERS: aml_start - First byte of the method's AML
450 * aml_length - AML byte count for this method
451 * walk_state - Current state
455 * DESCRIPTION: Create a new method object
457 ******************************************************************************/
460 acpi_ex_create_method(u8 * aml_start,
461 u32 aml_length, struct acpi_walk_state *walk_state)
463 union acpi_operand_object **operand = &walk_state->operands[0];
464 union acpi_operand_object *obj_desc;
468 ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
470 /* Create a new method object */
472 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
474 status = AE_NO_MEMORY;
478 /* Save the method's AML pointer and length */
480 obj_desc->method.aml_start = aml_start;
481 obj_desc->method.aml_length = aml_length;
484 * Disassemble the method flags. Split off the Arg Count
487 method_flags = (u8) operand[1]->integer.value;
489 obj_desc->method.method_flags =
490 (u8) (method_flags & ~AML_METHOD_ARG_COUNT);
491 obj_desc->method.param_count =
492 (u8) (method_flags & AML_METHOD_ARG_COUNT);
495 * Get the sync_level. If method is serialized, a mutex will be
496 * created for this method when it is parsed.
498 if (method_flags & AML_METHOD_SERIALIZED) {
500 * ACPI 1.0: sync_level = 0
501 * ACPI 2.0: sync_level = sync_level in method declaration
503 obj_desc->method.sync_level = (u8)
504 ((method_flags & AML_METHOD_SYNCH_LEVEL) >> 4);
507 /* Attach the new object to the method Node */
509 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
510 obj_desc, ACPI_TYPE_METHOD);
512 /* Remove local reference to the object */
514 acpi_ut_remove_reference(obj_desc);
517 /* Remove a reference to the operand */
519 acpi_ut_remove_reference(operand[1]);
520 return_ACPI_STATUS(status);