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
.os_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
;
229 /* Create the actual OS Mutex */
231 status
= acpi_os_create_mutex(&obj_desc
->mutex
.os_mutex
);
232 if (ACPI_FAILURE(status
)) {
236 /* Init object and attach to NS node */
238 obj_desc
->mutex
.sync_level
=
239 (u8
) walk_state
->operands
[1]->integer
.value
;
240 obj_desc
->mutex
.node
=
241 (struct acpi_namespace_node
*)walk_state
->operands
[0];
244 acpi_ns_attach_object(obj_desc
->mutex
.node
, obj_desc
,
249 * Remove local reference to the object (on error, will cause deletion
250 * of both object and semaphore if present.)
252 acpi_ut_remove_reference(obj_desc
);
253 return_ACPI_STATUS(status
);
256 /*******************************************************************************
258 * FUNCTION: acpi_ex_create_region
260 * PARAMETERS: aml_start - Pointer to the region declaration AML
261 * aml_length - Max length of the declaration AML
262 * region_space - space_iD for the region
263 * walk_state - Current state
267 * DESCRIPTION: Create a new operation region object
269 ******************************************************************************/
272 acpi_ex_create_region(u8
* aml_start
,
274 u8 region_space
, struct acpi_walk_state
*walk_state
)
277 union acpi_operand_object
*obj_desc
;
278 struct acpi_namespace_node
*node
;
279 union acpi_operand_object
*region_obj2
;
281 ACPI_FUNCTION_TRACE(ex_create_region
);
283 /* Get the Namespace Node */
285 node
= walk_state
->op
->common
.node
;
288 * If the region object is already attached to this node,
291 if (acpi_ns_get_attached_object(node
)) {
292 return_ACPI_STATUS(AE_OK
);
296 * Space ID must be one of the predefined IDs, or in the user-defined
299 if ((region_space
>= ACPI_NUM_PREDEFINED_REGIONS
) &&
300 (region_space
< ACPI_USER_REGION_BEGIN
)) {
301 ACPI_ERROR((AE_INFO
, "Invalid AddressSpace type %X",
303 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID
);
306 ACPI_DEBUG_PRINT((ACPI_DB_LOAD
, "Region Type - %s (%X)\n",
307 acpi_ut_get_region_name(region_space
), region_space
));
309 /* Create the region descriptor */
311 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_REGION
);
313 status
= AE_NO_MEMORY
;
318 * Remember location in AML stream of address & length
319 * operands since they need to be evaluated at run time.
321 region_obj2
= obj_desc
->common
.next_object
;
322 region_obj2
->extra
.aml_start
= aml_start
;
323 region_obj2
->extra
.aml_length
= aml_length
;
325 /* Init the region from the operands */
327 obj_desc
->region
.space_id
= region_space
;
328 obj_desc
->region
.address
= 0;
329 obj_desc
->region
.length
= 0;
330 obj_desc
->region
.node
= node
;
332 /* Install the new region object in the parent Node */
334 status
= acpi_ns_attach_object(node
, obj_desc
, ACPI_TYPE_REGION
);
338 /* Remove local reference to the object */
340 acpi_ut_remove_reference(obj_desc
);
341 return_ACPI_STATUS(status
);
344 /*******************************************************************************
346 * FUNCTION: acpi_ex_create_table_region
348 * PARAMETERS: walk_state - Current state
352 * DESCRIPTION: Create a new data_table_region object
354 ******************************************************************************/
356 acpi_status
acpi_ex_create_table_region(struct acpi_walk_state
*walk_state
)
359 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
360 union acpi_operand_object
*obj_desc
;
361 struct acpi_namespace_node
*node
;
362 struct acpi_table_header
*table
;
363 union acpi_operand_object
*region_obj2
;
365 ACPI_FUNCTION_TRACE(ex_create_table_region
);
367 /* Get the Node from the object stack */
369 node
= walk_state
->op
->common
.node
;
372 * If the region object is already attached to this node,
375 if (acpi_ns_get_attached_object(node
)) {
376 return_ACPI_STATUS(AE_OK
);
379 /* Find the ACPI table */
381 status
= acpi_tb_find_table(operand
[1]->string
.pointer
,
382 operand
[2]->string
.pointer
,
383 operand
[3]->string
.pointer
, &table
);
384 if (ACPI_FAILURE(status
)) {
385 return_ACPI_STATUS(status
);
388 /* Create the region descriptor */
390 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_REGION
);
392 return_ACPI_STATUS(AE_NO_MEMORY
);
395 region_obj2
= obj_desc
->common
.next_object
;
396 region_obj2
->extra
.region_context
= NULL
;
398 /* Init the region from the operands */
400 obj_desc
->region
.space_id
= REGION_DATA_TABLE
;
401 obj_desc
->region
.address
=
402 (acpi_physical_address
) ACPI_TO_INTEGER(table
);
403 obj_desc
->region
.length
= table
->length
;
404 obj_desc
->region
.node
= node
;
405 obj_desc
->region
.flags
= AOPOBJ_DATA_VALID
;
407 /* Install the new region object in the parent Node */
409 status
= acpi_ns_attach_object(node
, obj_desc
, ACPI_TYPE_REGION
);
410 if (ACPI_FAILURE(status
)) {
414 status
= acpi_ev_initialize_region(obj_desc
, FALSE
);
415 if (ACPI_FAILURE(status
)) {
416 if (status
== AE_NOT_EXIST
) {
423 obj_desc
->region
.flags
|= AOPOBJ_SETUP_COMPLETE
;
427 /* Remove local reference to the object */
429 acpi_ut_remove_reference(obj_desc
);
430 return_ACPI_STATUS(status
);
433 /*******************************************************************************
435 * FUNCTION: acpi_ex_create_processor
437 * PARAMETERS: walk_state - Current state
441 * DESCRIPTION: Create a new processor object and populate the fields
443 * Processor (Name[0], cpu_iD[1], pblock_addr[2], pblock_length[3])
445 ******************************************************************************/
447 acpi_status
acpi_ex_create_processor(struct acpi_walk_state
*walk_state
)
449 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
450 union acpi_operand_object
*obj_desc
;
453 ACPI_FUNCTION_TRACE_PTR(ex_create_processor
, walk_state
);
455 /* Create the processor object */
457 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR
);
459 return_ACPI_STATUS(AE_NO_MEMORY
);
462 /* Initialize the processor object from the operands */
464 obj_desc
->processor
.proc_id
= (u8
) operand
[1]->integer
.value
;
465 obj_desc
->processor
.length
= (u8
) operand
[3]->integer
.value
;
466 obj_desc
->processor
.address
=
467 (acpi_io_address
) operand
[2]->integer
.value
;
469 /* Install the processor object in the parent Node */
471 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)operand
[0],
472 obj_desc
, ACPI_TYPE_PROCESSOR
);
474 /* Remove local reference to the object */
476 acpi_ut_remove_reference(obj_desc
);
477 return_ACPI_STATUS(status
);
480 /*******************************************************************************
482 * FUNCTION: acpi_ex_create_power_resource
484 * PARAMETERS: walk_state - Current state
488 * DESCRIPTION: Create a new power_resource object and populate the fields
490 * power_resource (Name[0], system_level[1], resource_order[2])
492 ******************************************************************************/
494 acpi_status
acpi_ex_create_power_resource(struct acpi_walk_state
*walk_state
)
496 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
498 union acpi_operand_object
*obj_desc
;
500 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource
, walk_state
);
502 /* Create the power resource object */
504 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_POWER
);
506 return_ACPI_STATUS(AE_NO_MEMORY
);
509 /* Initialize the power object from the operands */
511 obj_desc
->power_resource
.system_level
= (u8
) operand
[1]->integer
.value
;
512 obj_desc
->power_resource
.resource_order
=
513 (u16
) operand
[2]->integer
.value
;
515 /* Install the power resource object in the parent Node */
517 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)operand
[0],
518 obj_desc
, ACPI_TYPE_POWER
);
520 /* Remove local reference to the object */
522 acpi_ut_remove_reference(obj_desc
);
523 return_ACPI_STATUS(status
);
527 /*******************************************************************************
529 * FUNCTION: acpi_ex_create_method
531 * PARAMETERS: aml_start - First byte of the method's AML
532 * aml_length - AML byte count for this method
533 * walk_state - Current state
537 * DESCRIPTION: Create a new method object
539 ******************************************************************************/
542 acpi_ex_create_method(u8
* aml_start
,
543 u32 aml_length
, struct acpi_walk_state
*walk_state
)
545 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
546 union acpi_operand_object
*obj_desc
;
550 ACPI_FUNCTION_TRACE_PTR(ex_create_method
, walk_state
);
552 /* Create a new method object */
554 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_METHOD
);
556 return_ACPI_STATUS(AE_NO_MEMORY
);
559 /* Save the method's AML pointer and length */
561 obj_desc
->method
.aml_start
= aml_start
;
562 obj_desc
->method
.aml_length
= aml_length
;
565 * Disassemble the method flags. Split off the Arg Count
568 method_flags
= (u8
) operand
[1]->integer
.value
;
570 obj_desc
->method
.method_flags
=
571 (u8
) (method_flags
& ~AML_METHOD_ARG_COUNT
);
572 obj_desc
->method
.param_count
=
573 (u8
) (method_flags
& AML_METHOD_ARG_COUNT
);
576 * Get the sync_level. If method is serialized, a mutex will be
577 * created for this method when it is parsed.
579 if (acpi_gbl_all_methods_serialized
) {
580 obj_desc
->method
.sync_level
= 0;
581 obj_desc
->method
.method_flags
|= AML_METHOD_SERIALIZED
;
582 } else if (method_flags
& AML_METHOD_SERIALIZED
) {
584 * ACPI 1.0: sync_level = 0
585 * ACPI 2.0: sync_level = sync_level in method declaration
587 obj_desc
->method
.sync_level
= (u8
)
588 ((method_flags
& AML_METHOD_SYNCH_LEVEL
) >> 4);
591 /* Attach the new object to the method Node */
593 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)operand
[0],
594 obj_desc
, ACPI_TYPE_METHOD
);
596 /* Remove local reference to the object */
598 acpi_ut_remove_reference(obj_desc
);
600 /* Remove a reference to the operand */
602 acpi_ut_remove_reference(operand
[1]);
603 return_ACPI_STATUS(status
);