[ACPICA]
[reactos.git] / reactos / drivers / bus / acpi / acpica / executer / excreate.c
1 /******************************************************************************
2 *
3 * Module Name: excreate - Named object creation
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117 #include "acpi.h"
118 #include "accommon.h"
119 #include "acinterp.h"
120 #include "amlcode.h"
121 #include "acnamesp.h"
122
123
124 #define _COMPONENT ACPI_EXECUTER
125 ACPI_MODULE_NAME ("excreate")
126
127
128 #ifndef ACPI_NO_METHOD_EXECUTION
129 /*******************************************************************************
130 *
131 * FUNCTION: AcpiExCreateAlias
132 *
133 * PARAMETERS: WalkState - Current state, contains operands
134 *
135 * RETURN: Status
136 *
137 * DESCRIPTION: Create a new named alias
138 *
139 ******************************************************************************/
140
141 ACPI_STATUS
142 AcpiExCreateAlias (
143 ACPI_WALK_STATE *WalkState)
144 {
145 ACPI_NAMESPACE_NODE *TargetNode;
146 ACPI_NAMESPACE_NODE *AliasNode;
147 ACPI_STATUS Status = AE_OK;
148
149
150 ACPI_FUNCTION_TRACE (ExCreateAlias);
151
152
153 /* Get the source/alias operands (both namespace nodes) */
154
155 AliasNode = (ACPI_NAMESPACE_NODE *) WalkState->Operands[0];
156 TargetNode = (ACPI_NAMESPACE_NODE *) WalkState->Operands[1];
157
158 if ((TargetNode->Type == ACPI_TYPE_LOCAL_ALIAS) ||
159 (TargetNode->Type == ACPI_TYPE_LOCAL_METHOD_ALIAS))
160 {
161 /*
162 * Dereference an existing alias so that we don't create a chain
163 * of aliases. With this code, we guarantee that an alias is
164 * always exactly one level of indirection away from the
165 * actual aliased name.
166 */
167 TargetNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, TargetNode->Object);
168 }
169
170 /*
171 * For objects that can never change (i.e., the NS node will
172 * permanently point to the same object), we can simply attach
173 * the object to the new NS node. For other objects (such as
174 * Integers, buffers, etc.), we have to point the Alias node
175 * to the original Node.
176 */
177 switch (TargetNode->Type)
178 {
179
180 /* For these types, the sub-object can change dynamically via a Store */
181
182 case ACPI_TYPE_INTEGER:
183 case ACPI_TYPE_STRING:
184 case ACPI_TYPE_BUFFER:
185 case ACPI_TYPE_PACKAGE:
186 case ACPI_TYPE_BUFFER_FIELD:
187 /*
188 * These types open a new scope, so we need the NS node in order to access
189 * any children.
190 */
191 case ACPI_TYPE_DEVICE:
192 case ACPI_TYPE_POWER:
193 case ACPI_TYPE_PROCESSOR:
194 case ACPI_TYPE_THERMAL:
195 case ACPI_TYPE_LOCAL_SCOPE:
196 /*
197 * The new alias has the type ALIAS and points to the original
198 * NS node, not the object itself.
199 */
200 AliasNode->Type = ACPI_TYPE_LOCAL_ALIAS;
201 AliasNode->Object = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, TargetNode);
202 break;
203
204 case ACPI_TYPE_METHOD:
205 /*
206 * Control method aliases need to be differentiated
207 */
208 AliasNode->Type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
209 AliasNode->Object = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, TargetNode);
210 break;
211
212 default:
213
214 /* Attach the original source object to the new Alias Node */
215
216 /*
217 * The new alias assumes the type of the target, and it points
218 * to the same object. The reference count of the object has an
219 * additional reference to prevent deletion out from under either the
220 * target node or the alias Node
221 */
222 Status = AcpiNsAttachObject (AliasNode,
223 AcpiNsGetAttachedObject (TargetNode), TargetNode->Type);
224 break;
225 }
226
227 /* Since both operands are Nodes, we don't need to delete them */
228
229 return_ACPI_STATUS (Status);
230 }
231
232
233 /*******************************************************************************
234 *
235 * FUNCTION: AcpiExCreateEvent
236 *
237 * PARAMETERS: WalkState - Current state
238 *
239 * RETURN: Status
240 *
241 * DESCRIPTION: Create a new event object
242 *
243 ******************************************************************************/
244
245 ACPI_STATUS
246 AcpiExCreateEvent (
247 ACPI_WALK_STATE *WalkState)
248 {
249 ACPI_STATUS Status;
250 ACPI_OPERAND_OBJECT *ObjDesc;
251
252
253 ACPI_FUNCTION_TRACE (ExCreateEvent);
254
255
256 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_EVENT);
257 if (!ObjDesc)
258 {
259 Status = AE_NO_MEMORY;
260 goto Cleanup;
261 }
262
263 /*
264 * Create the actual OS semaphore, with zero initial units -- meaning
265 * that the event is created in an unsignalled state
266 */
267 Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0,
268 &ObjDesc->Event.OsSemaphore);
269 if (ACPI_FAILURE (Status))
270 {
271 goto Cleanup;
272 }
273
274 /* Attach object to the Node */
275
276 Status = AcpiNsAttachObject (
277 (ACPI_NAMESPACE_NODE *) WalkState->Operands[0],
278 ObjDesc, ACPI_TYPE_EVENT);
279
280 Cleanup:
281 /*
282 * Remove local reference to the object (on error, will cause deletion
283 * of both object and semaphore if present.)
284 */
285 AcpiUtRemoveReference (ObjDesc);
286 return_ACPI_STATUS (Status);
287 }
288
289
290 /*******************************************************************************
291 *
292 * FUNCTION: AcpiExCreateMutex
293 *
294 * PARAMETERS: WalkState - Current state
295 *
296 * RETURN: Status
297 *
298 * DESCRIPTION: Create a new mutex object
299 *
300 * Mutex (Name[0], SyncLevel[1])
301 *
302 ******************************************************************************/
303
304 ACPI_STATUS
305 AcpiExCreateMutex (
306 ACPI_WALK_STATE *WalkState)
307 {
308 ACPI_STATUS Status = AE_OK;
309 ACPI_OPERAND_OBJECT *ObjDesc;
310
311
312 ACPI_FUNCTION_TRACE_PTR (ExCreateMutex, ACPI_WALK_OPERANDS);
313
314
315 /* Create the new mutex object */
316
317 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
318 if (!ObjDesc)
319 {
320 Status = AE_NO_MEMORY;
321 goto Cleanup;
322 }
323
324 /* Create the actual OS Mutex */
325
326 Status = AcpiOsCreateMutex (&ObjDesc->Mutex.OsMutex);
327 if (ACPI_FAILURE (Status))
328 {
329 goto Cleanup;
330 }
331
332 /* Init object and attach to NS node */
333
334 ObjDesc->Mutex.SyncLevel = (UINT8) WalkState->Operands[1]->Integer.Value;
335 ObjDesc->Mutex.Node = (ACPI_NAMESPACE_NODE *) WalkState->Operands[0];
336
337 Status = AcpiNsAttachObject (
338 ObjDesc->Mutex.Node, ObjDesc, ACPI_TYPE_MUTEX);
339
340
341 Cleanup:
342 /*
343 * Remove local reference to the object (on error, will cause deletion
344 * of both object and semaphore if present.)
345 */
346 AcpiUtRemoveReference (ObjDesc);
347 return_ACPI_STATUS (Status);
348 }
349
350
351 /*******************************************************************************
352 *
353 * FUNCTION: AcpiExCreateRegion
354 *
355 * PARAMETERS: AmlStart - Pointer to the region declaration AML
356 * AmlLength - Max length of the declaration AML
357 * SpaceId - Address space ID for the region
358 * WalkState - Current state
359 *
360 * RETURN: Status
361 *
362 * DESCRIPTION: Create a new operation region object
363 *
364 ******************************************************************************/
365
366 ACPI_STATUS
367 AcpiExCreateRegion (
368 UINT8 *AmlStart,
369 UINT32 AmlLength,
370 UINT8 SpaceId,
371 ACPI_WALK_STATE *WalkState)
372 {
373 ACPI_STATUS Status;
374 ACPI_OPERAND_OBJECT *ObjDesc;
375 ACPI_NAMESPACE_NODE *Node;
376 ACPI_OPERAND_OBJECT *RegionObj2;
377
378
379 ACPI_FUNCTION_TRACE (ExCreateRegion);
380
381
382 /* Get the Namespace Node */
383
384 Node = WalkState->Op->Common.Node;
385
386 /*
387 * If the region object is already attached to this node,
388 * just return
389 */
390 if (AcpiNsGetAttachedObject (Node))
391 {
392 return_ACPI_STATUS (AE_OK);
393 }
394
395 /*
396 * Space ID must be one of the predefined IDs, or in the user-defined
397 * range
398 */
399 if (!AcpiIsValidSpaceId (SpaceId))
400 {
401 /*
402 * Print an error message, but continue. We don't want to abort
403 * a table load for this exception. Instead, if the region is
404 * actually used at runtime, abort the executing method.
405 */
406 ACPI_ERROR ((AE_INFO,
407 "Invalid/unknown Address Space ID: 0x%2.2X", SpaceId));
408 }
409
410 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "Region Type - %s (0x%X)\n",
411 AcpiUtGetRegionName (SpaceId), SpaceId));
412
413 /* Create the region descriptor */
414
415 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_REGION);
416 if (!ObjDesc)
417 {
418 Status = AE_NO_MEMORY;
419 goto Cleanup;
420 }
421
422 /*
423 * Remember location in AML stream of address & length
424 * operands since they need to be evaluated at run time.
425 */
426 RegionObj2 = AcpiNsGetSecondaryObject (ObjDesc);
427 RegionObj2->Extra.AmlStart = AmlStart;
428 RegionObj2->Extra.AmlLength = AmlLength;
429 RegionObj2->Extra.Method_REG = NULL;
430 if (WalkState->ScopeInfo)
431 {
432 RegionObj2->Extra.ScopeNode = WalkState->ScopeInfo->Scope.Node;
433 }
434 else
435 {
436 RegionObj2->Extra.ScopeNode = Node;
437 }
438
439 /* Init the region from the operands */
440
441 ObjDesc->Region.SpaceId = SpaceId;
442 ObjDesc->Region.Address = 0;
443 ObjDesc->Region.Length = 0;
444 ObjDesc->Region.Node = Node;
445 ObjDesc->Region.Handler = NULL;
446 ObjDesc->Common.Flags &=
447 ~(AOPOBJ_SETUP_COMPLETE | AOPOBJ_REG_CONNECTED |
448 AOPOBJ_OBJECT_INITIALIZED);
449
450 /* Install the new region object in the parent Node */
451
452 Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_REGION);
453
454
455 Cleanup:
456
457 /* Remove local reference to the object */
458
459 AcpiUtRemoveReference (ObjDesc);
460 return_ACPI_STATUS (Status);
461 }
462
463
464 /*******************************************************************************
465 *
466 * FUNCTION: AcpiExCreateProcessor
467 *
468 * PARAMETERS: WalkState - Current state
469 *
470 * RETURN: Status
471 *
472 * DESCRIPTION: Create a new processor object and populate the fields
473 *
474 * Processor (Name[0], CpuID[1], PblockAddr[2], PblockLength[3])
475 *
476 ******************************************************************************/
477
478 ACPI_STATUS
479 AcpiExCreateProcessor (
480 ACPI_WALK_STATE *WalkState)
481 {
482 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
483 ACPI_OPERAND_OBJECT *ObjDesc;
484 ACPI_STATUS Status;
485
486
487 ACPI_FUNCTION_TRACE_PTR (ExCreateProcessor, WalkState);
488
489
490 /* Create the processor object */
491
492 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_PROCESSOR);
493 if (!ObjDesc)
494 {
495 return_ACPI_STATUS (AE_NO_MEMORY);
496 }
497
498 /* Initialize the processor object from the operands */
499
500 ObjDesc->Processor.ProcId = (UINT8) Operand[1]->Integer.Value;
501 ObjDesc->Processor.Length = (UINT8) Operand[3]->Integer.Value;
502 ObjDesc->Processor.Address = (ACPI_IO_ADDRESS) Operand[2]->Integer.Value;
503
504 /* Install the processor object in the parent Node */
505
506 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
507 ObjDesc, ACPI_TYPE_PROCESSOR);
508
509 /* Remove local reference to the object */
510
511 AcpiUtRemoveReference (ObjDesc);
512 return_ACPI_STATUS (Status);
513 }
514
515
516 /*******************************************************************************
517 *
518 * FUNCTION: AcpiExCreatePowerResource
519 *
520 * PARAMETERS: WalkState - Current state
521 *
522 * RETURN: Status
523 *
524 * DESCRIPTION: Create a new PowerResource object and populate the fields
525 *
526 * PowerResource (Name[0], SystemLevel[1], ResourceOrder[2])
527 *
528 ******************************************************************************/
529
530 ACPI_STATUS
531 AcpiExCreatePowerResource (
532 ACPI_WALK_STATE *WalkState)
533 {
534 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
535 ACPI_STATUS Status;
536 ACPI_OPERAND_OBJECT *ObjDesc;
537
538
539 ACPI_FUNCTION_TRACE_PTR (ExCreatePowerResource, WalkState);
540
541
542 /* Create the power resource object */
543
544 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_POWER);
545 if (!ObjDesc)
546 {
547 return_ACPI_STATUS (AE_NO_MEMORY);
548 }
549
550 /* Initialize the power object from the operands */
551
552 ObjDesc->PowerResource.SystemLevel = (UINT8) Operand[1]->Integer.Value;
553 ObjDesc->PowerResource.ResourceOrder = (UINT16) Operand[2]->Integer.Value;
554
555 /* Install the power resource object in the parent Node */
556
557 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
558 ObjDesc, ACPI_TYPE_POWER);
559
560 /* Remove local reference to the object */
561
562 AcpiUtRemoveReference (ObjDesc);
563 return_ACPI_STATUS (Status);
564 }
565 #endif
566
567
568 /*******************************************************************************
569 *
570 * FUNCTION: AcpiExCreateMethod
571 *
572 * PARAMETERS: AmlStart - First byte of the method's AML
573 * AmlLength - AML byte count for this method
574 * WalkState - Current state
575 *
576 * RETURN: Status
577 *
578 * DESCRIPTION: Create a new method object
579 *
580 ******************************************************************************/
581
582 ACPI_STATUS
583 AcpiExCreateMethod (
584 UINT8 *AmlStart,
585 UINT32 AmlLength,
586 ACPI_WALK_STATE *WalkState)
587 {
588 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
589 ACPI_OPERAND_OBJECT *ObjDesc;
590 ACPI_STATUS Status;
591 UINT8 MethodFlags;
592
593
594 ACPI_FUNCTION_TRACE_PTR (ExCreateMethod, WalkState);
595
596
597 /* Create a new method object */
598
599 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
600 if (!ObjDesc)
601 {
602 Status = AE_NO_MEMORY;
603 goto Exit;
604 }
605
606 /* Save the method's AML pointer and length */
607
608 ObjDesc->Method.AmlStart = AmlStart;
609 ObjDesc->Method.AmlLength = AmlLength;
610 ObjDesc->Method.Node = Operand[0];
611
612 /*
613 * Disassemble the method flags. Split off the ArgCount, Serialized
614 * flag, and SyncLevel for efficiency.
615 */
616 MethodFlags = (UINT8) Operand[1]->Integer.Value;
617 ObjDesc->Method.ParamCount = (UINT8)
618 (MethodFlags & AML_METHOD_ARG_COUNT);
619
620 /*
621 * Get the SyncLevel. If method is serialized, a mutex will be
622 * created for this method when it is parsed.
623 */
624 if (MethodFlags & AML_METHOD_SERIALIZED)
625 {
626 ObjDesc->Method.InfoFlags = ACPI_METHOD_SERIALIZED;
627
628 /*
629 * ACPI 1.0: SyncLevel = 0
630 * ACPI 2.0: SyncLevel = SyncLevel in method declaration
631 */
632 ObjDesc->Method.SyncLevel = (UINT8)
633 ((MethodFlags & AML_METHOD_SYNC_LEVEL) >> 4);
634 }
635
636 /* Attach the new object to the method Node */
637
638 Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
639 ObjDesc, ACPI_TYPE_METHOD);
640
641 /* Remove local reference to the object */
642
643 AcpiUtRemoveReference (ObjDesc);
644
645 Exit:
646 /* Remove a reference to the operand */
647
648 AcpiUtRemoveReference (Operand[1]);
649 return_ACPI_STATUS (Status);
650 }