1 /******************************************************************************
3 * Module Name: excreate - Named object creation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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
:
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
:
116 * The new alias has the type ALIAS and points to the original
117 * NS node, not the object itself.
119 alias_node
->type
= ACPI_TYPE_LOCAL_ALIAS
;
121 ACPI_CAST_PTR(union acpi_operand_object
, target_node
);
124 case ACPI_TYPE_METHOD
:
126 * Control method aliases need to be differentiated
128 alias_node
->type
= ACPI_TYPE_LOCAL_METHOD_ALIAS
;
130 ACPI_CAST_PTR(union acpi_operand_object
, target_node
);
135 /* Attach the original source object to the new Alias Node */
138 * The new alias assumes the type of the target, and it points
139 * to the same object. The reference count of the object has an
140 * additional reference to prevent deletion out from under either the
141 * target node or the alias Node
143 status
= acpi_ns_attach_object(alias_node
,
144 acpi_ns_get_attached_object
150 /* Since both operands are Nodes, we don't need to delete them */
152 return_ACPI_STATUS(status
);
155 /*******************************************************************************
157 * FUNCTION: acpi_ex_create_event
159 * PARAMETERS: walk_state - Current state
163 * DESCRIPTION: Create a new event object
165 ******************************************************************************/
167 acpi_status
acpi_ex_create_event(struct acpi_walk_state
*walk_state
)
170 union acpi_operand_object
*obj_desc
;
172 ACPI_FUNCTION_TRACE(ex_create_event
);
174 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_EVENT
);
176 status
= AE_NO_MEMORY
;
181 * Create the actual OS semaphore, with zero initial units -- meaning
182 * that the event is created in an unsignalled state
184 status
= acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT
, 0,
185 &obj_desc
->event
.os_semaphore
);
186 if (ACPI_FAILURE(status
)) {
190 /* Attach object to the Node */
192 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)
193 walk_state
->operands
[0], obj_desc
,
198 * Remove local reference to the object (on error, will cause deletion
199 * of both object and semaphore if present.)
201 acpi_ut_remove_reference(obj_desc
);
202 return_ACPI_STATUS(status
);
205 /*******************************************************************************
207 * FUNCTION: acpi_ex_create_mutex
209 * PARAMETERS: walk_state - Current state
213 * DESCRIPTION: Create a new mutex object
215 * Mutex (Name[0], sync_level[1])
217 ******************************************************************************/
219 acpi_status
acpi_ex_create_mutex(struct acpi_walk_state
*walk_state
)
221 acpi_status status
= AE_OK
;
222 union acpi_operand_object
*obj_desc
;
224 ACPI_FUNCTION_TRACE_PTR(ex_create_mutex
, ACPI_WALK_OPERANDS
);
226 /* Create the new mutex object */
228 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_MUTEX
);
230 status
= AE_NO_MEMORY
;
234 /* Create the actual OS Mutex */
236 status
= acpi_os_create_mutex(&obj_desc
->mutex
.os_mutex
);
237 if (ACPI_FAILURE(status
)) {
241 /* Init object and attach to NS node */
243 obj_desc
->mutex
.sync_level
= (u8
)walk_state
->operands
[1]->integer
.value
;
244 obj_desc
->mutex
.node
=
245 (struct acpi_namespace_node
*)walk_state
->operands
[0];
248 acpi_ns_attach_object(obj_desc
->mutex
.node
, obj_desc
,
253 * Remove local reference to the object (on error, will cause deletion
254 * of both object and semaphore if present.)
256 acpi_ut_remove_reference(obj_desc
);
257 return_ACPI_STATUS(status
);
260 /*******************************************************************************
262 * FUNCTION: acpi_ex_create_region
264 * PARAMETERS: aml_start - Pointer to the region declaration AML
265 * aml_length - Max length of the declaration AML
266 * space_id - Address space ID for the region
267 * walk_state - Current state
271 * DESCRIPTION: Create a new operation region object
273 ******************************************************************************/
276 acpi_ex_create_region(u8
* aml_start
,
278 u8 space_id
, struct acpi_walk_state
*walk_state
)
281 union acpi_operand_object
*obj_desc
;
282 struct acpi_namespace_node
*node
;
283 union acpi_operand_object
*region_obj2
;
285 ACPI_FUNCTION_TRACE(ex_create_region
);
287 /* Get the Namespace Node */
289 node
= walk_state
->op
->common
.node
;
292 * If the region object is already attached to this node,
295 if (acpi_ns_get_attached_object(node
)) {
296 return_ACPI_STATUS(AE_OK
);
300 * Space ID must be one of the predefined IDs, or in the user-defined
303 if (!acpi_is_valid_space_id(space_id
)) {
305 * Print an error message, but continue. We don't want to abort
306 * a table load for this exception. Instead, if the region is
307 * actually used at runtime, abort the executing method.
310 "Invalid/unknown Address Space ID: 0x%2.2X",
314 ACPI_DEBUG_PRINT((ACPI_DB_LOAD
, "Region Type - %s (0x%X)\n",
315 acpi_ut_get_region_name(space_id
), space_id
));
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
= acpi_ns_get_secondary_object(obj_desc
);
330 region_obj2
->extra
.aml_start
= aml_start
;
331 region_obj2
->extra
.aml_length
= aml_length
;
332 region_obj2
->extra
.method_REG
= NULL
;
333 if (walk_state
->scope_info
) {
334 region_obj2
->extra
.scope_node
=
335 walk_state
->scope_info
->scope
.node
;
337 region_obj2
->extra
.scope_node
= node
;
340 /* Init the region from the operands */
342 obj_desc
->region
.space_id
= space_id
;
343 obj_desc
->region
.address
= 0;
344 obj_desc
->region
.length
= 0;
345 obj_desc
->region
.node
= node
;
346 obj_desc
->region
.handler
= NULL
;
347 obj_desc
->common
.flags
&=
348 ~(AOPOBJ_SETUP_COMPLETE
| AOPOBJ_REG_CONNECTED
|
349 AOPOBJ_OBJECT_INITIALIZED
);
351 /* Install the new region object in the parent Node */
353 status
= acpi_ns_attach_object(node
, obj_desc
, ACPI_TYPE_REGION
);
357 /* Remove local reference to the object */
359 acpi_ut_remove_reference(obj_desc
);
360 return_ACPI_STATUS(status
);
363 /*******************************************************************************
365 * FUNCTION: acpi_ex_create_processor
367 * PARAMETERS: walk_state - Current state
371 * DESCRIPTION: Create a new processor object and populate the fields
373 * Processor (Name[0], cpu_ID[1], pblock_addr[2], pblock_length[3])
375 ******************************************************************************/
377 acpi_status
acpi_ex_create_processor(struct acpi_walk_state
*walk_state
)
379 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
380 union acpi_operand_object
*obj_desc
;
383 ACPI_FUNCTION_TRACE_PTR(ex_create_processor
, walk_state
);
385 /* Create the processor object */
387 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR
);
389 return_ACPI_STATUS(AE_NO_MEMORY
);
392 /* Initialize the processor object from the operands */
394 obj_desc
->processor
.proc_id
= (u8
) operand
[1]->integer
.value
;
395 obj_desc
->processor
.length
= (u8
) operand
[3]->integer
.value
;
396 obj_desc
->processor
.address
=
397 (acpi_io_address
)operand
[2]->integer
.value
;
399 /* Install the processor object in the parent Node */
401 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)operand
[0],
402 obj_desc
, ACPI_TYPE_PROCESSOR
);
404 /* Remove local reference to the object */
406 acpi_ut_remove_reference(obj_desc
);
407 return_ACPI_STATUS(status
);
410 /*******************************************************************************
412 * FUNCTION: acpi_ex_create_power_resource
414 * PARAMETERS: walk_state - Current state
418 * DESCRIPTION: Create a new power_resource object and populate the fields
420 * power_resource (Name[0], system_level[1], resource_order[2])
422 ******************************************************************************/
424 acpi_status
acpi_ex_create_power_resource(struct acpi_walk_state
*walk_state
)
426 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
428 union acpi_operand_object
*obj_desc
;
430 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource
, walk_state
);
432 /* Create the power resource object */
434 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_POWER
);
436 return_ACPI_STATUS(AE_NO_MEMORY
);
439 /* Initialize the power object from the operands */
441 obj_desc
->power_resource
.system_level
= (u8
) operand
[1]->integer
.value
;
442 obj_desc
->power_resource
.resource_order
=
443 (u16
) operand
[2]->integer
.value
;
445 /* Install the power resource object in the parent Node */
447 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)operand
[0],
448 obj_desc
, ACPI_TYPE_POWER
);
450 /* Remove local reference to the object */
452 acpi_ut_remove_reference(obj_desc
);
453 return_ACPI_STATUS(status
);
457 /*******************************************************************************
459 * FUNCTION: acpi_ex_create_method
461 * PARAMETERS: aml_start - First byte of the method's AML
462 * aml_length - AML byte count for this method
463 * walk_state - Current state
467 * DESCRIPTION: Create a new method object
469 ******************************************************************************/
472 acpi_ex_create_method(u8
* aml_start
,
473 u32 aml_length
, struct acpi_walk_state
*walk_state
)
475 union acpi_operand_object
**operand
= &walk_state
->operands
[0];
476 union acpi_operand_object
*obj_desc
;
480 ACPI_FUNCTION_TRACE_PTR(ex_create_method
, walk_state
);
482 /* Create a new method object */
484 obj_desc
= acpi_ut_create_internal_object(ACPI_TYPE_METHOD
);
486 status
= AE_NO_MEMORY
;
490 /* Save the method's AML pointer and length */
492 obj_desc
->method
.aml_start
= aml_start
;
493 obj_desc
->method
.aml_length
= aml_length
;
494 obj_desc
->method
.node
= operand
[0];
497 * Disassemble the method flags. Split off the arg_count, Serialized
498 * flag, and sync_level for efficiency.
500 method_flags
= (u8
)operand
[1]->integer
.value
;
501 obj_desc
->method
.param_count
= (u8
)
502 (method_flags
& AML_METHOD_ARG_COUNT
);
505 * Get the sync_level. If method is serialized, a mutex will be
506 * created for this method when it is parsed.
508 if (method_flags
& AML_METHOD_SERIALIZED
) {
509 obj_desc
->method
.info_flags
= ACPI_METHOD_SERIALIZED
;
512 * ACPI 1.0: sync_level = 0
513 * ACPI 2.0: sync_level = sync_level in method declaration
515 obj_desc
->method
.sync_level
= (u8
)
516 ((method_flags
& AML_METHOD_SYNC_LEVEL
) >> 4);
519 /* Attach the new object to the method Node */
521 status
= acpi_ns_attach_object((struct acpi_namespace_node
*)operand
[0],
522 obj_desc
, ACPI_TYPE_METHOD
);
524 /* Remove local reference to the object */
526 acpi_ut_remove_reference(obj_desc
);
529 /* Remove a reference to the operand */
531 acpi_ut_remove_reference(operand
[1]);
532 return_ACPI_STATUS(status
);