xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/excreate.c (revision 04a0e9c7b68cbe3a43d38e2bca8e860fd80936fb)
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 - 2013, 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 #define __EXCREATE_C__
118 
119 #include "acpi.h"
120 #include "accommon.h"
121 #include "acinterp.h"
122 #include "amlcode.h"
123 #include "acnamesp.h"
124 
125 
126 #define _COMPONENT          ACPI_EXECUTER
127         ACPI_MODULE_NAME    ("excreate")
128 
129 
130 #ifndef ACPI_NO_METHOD_EXECUTION
131 /*******************************************************************************
132  *
133  * FUNCTION:    AcpiExCreateAlias
134  *
135  * PARAMETERS:  WalkState            - Current state, contains operands
136  *
137  * RETURN:      Status
138  *
139  * DESCRIPTION: Create a new named alias
140  *
141  ******************************************************************************/
142 
143 ACPI_STATUS
144 AcpiExCreateAlias (
145     ACPI_WALK_STATE         *WalkState)
146 {
147     ACPI_NAMESPACE_NODE     *TargetNode;
148     ACPI_NAMESPACE_NODE     *AliasNode;
149     ACPI_STATUS             Status = AE_OK;
150 
151 
152     ACPI_FUNCTION_TRACE (ExCreateAlias);
153 
154 
155     /* Get the source/alias operands (both namespace nodes) */
156 
157     AliasNode =  (ACPI_NAMESPACE_NODE *) WalkState->Operands[0];
158     TargetNode = (ACPI_NAMESPACE_NODE *) WalkState->Operands[1];
159 
160     if ((TargetNode->Type == ACPI_TYPE_LOCAL_ALIAS)  ||
161         (TargetNode->Type == ACPI_TYPE_LOCAL_METHOD_ALIAS))
162     {
163         /*
164          * Dereference an existing alias so that we don't create a chain
165          * of aliases. With this code, we guarantee that an alias is
166          * always exactly one level of indirection away from the
167          * actual aliased name.
168          */
169         TargetNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, TargetNode->Object);
170     }
171 
172     /*
173      * For objects that can never change (i.e., the NS node will
174      * permanently point to the same object), we can simply attach
175      * the object to the new NS node. For other objects (such as
176      * Integers, buffers, etc.), we have to point the Alias node
177      * to the original Node.
178      */
179     switch (TargetNode->Type)
180     {
181 
182     /* For these types, the sub-object can change dynamically via a Store */
183 
184     case ACPI_TYPE_INTEGER:
185     case ACPI_TYPE_STRING:
186     case ACPI_TYPE_BUFFER:
187     case ACPI_TYPE_PACKAGE:
188     case ACPI_TYPE_BUFFER_FIELD:
189     /*
190      * These types open a new scope, so we need the NS node in order to access
191      * any children.
192      */
193     case ACPI_TYPE_DEVICE:
194     case ACPI_TYPE_POWER:
195     case ACPI_TYPE_PROCESSOR:
196     case ACPI_TYPE_THERMAL:
197     case ACPI_TYPE_LOCAL_SCOPE:
198         /*
199          * The new alias has the type ALIAS and points to the original
200          * NS node, not the object itself.
201          */
202         AliasNode->Type = ACPI_TYPE_LOCAL_ALIAS;
203         AliasNode->Object = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, TargetNode);
204         break;
205 
206     case ACPI_TYPE_METHOD:
207         /*
208          * Control method aliases need to be differentiated
209          */
210         AliasNode->Type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
211         AliasNode->Object = ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, TargetNode);
212         break;
213 
214     default:
215 
216         /* Attach the original source object to the new Alias Node */
217 
218         /*
219          * The new alias assumes the type of the target, and it points
220          * to the same object. The reference count of the object has an
221          * additional reference to prevent deletion out from under either the
222          * target node or the alias Node
223          */
224         Status = AcpiNsAttachObject (AliasNode,
225                     AcpiNsGetAttachedObject (TargetNode), TargetNode->Type);
226         break;
227     }
228 
229     /* Since both operands are Nodes, we don't need to delete them */
230 
231     return_ACPI_STATUS (Status);
232 }
233 
234 
235 /*******************************************************************************
236  *
237  * FUNCTION:    AcpiExCreateEvent
238  *
239  * PARAMETERS:  WalkState           - Current state
240  *
241  * RETURN:      Status
242  *
243  * DESCRIPTION: Create a new event object
244  *
245  ******************************************************************************/
246 
247 ACPI_STATUS
248 AcpiExCreateEvent (
249     ACPI_WALK_STATE         *WalkState)
250 {
251     ACPI_STATUS             Status;
252     ACPI_OPERAND_OBJECT     *ObjDesc;
253 
254 
255     ACPI_FUNCTION_TRACE (ExCreateEvent);
256 
257 
258     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_EVENT);
259     if (!ObjDesc)
260     {
261         Status = AE_NO_MEMORY;
262         goto Cleanup;
263     }
264 
265     /*
266      * Create the actual OS semaphore, with zero initial units -- meaning
267      * that the event is created in an unsignalled state
268      */
269     Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0,
270                 &ObjDesc->Event.OsSemaphore);
271     if (ACPI_FAILURE (Status))
272     {
273         goto Cleanup;
274     }
275 
276     /* Attach object to the Node */
277 
278     Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) WalkState->Operands[0],
279                 ObjDesc, ACPI_TYPE_EVENT);
280 
281 Cleanup:
282     /*
283      * Remove local reference to the object (on error, will cause deletion
284      * of both object and semaphore if present.)
285      */
286     AcpiUtRemoveReference (ObjDesc);
287     return_ACPI_STATUS (Status);
288 }
289 
290 
291 /*******************************************************************************
292  *
293  * FUNCTION:    AcpiExCreateMutex
294  *
295  * PARAMETERS:  WalkState           - Current state
296  *
297  * RETURN:      Status
298  *
299  * DESCRIPTION: Create a new mutex object
300  *
301  *              Mutex (Name[0], SyncLevel[1])
302  *
303  ******************************************************************************/
304 
305 ACPI_STATUS
306 AcpiExCreateMutex (
307     ACPI_WALK_STATE         *WalkState)
308 {
309     ACPI_STATUS             Status = AE_OK;
310     ACPI_OPERAND_OBJECT     *ObjDesc;
311 
312 
313     ACPI_FUNCTION_TRACE_PTR (ExCreateMutex, ACPI_WALK_OPERANDS);
314 
315 
316     /* Create the new mutex object */
317 
318     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_MUTEX);
319     if (!ObjDesc)
320     {
321         Status = AE_NO_MEMORY;
322         goto Cleanup;
323     }
324 
325     /* Create the actual OS Mutex */
326 
327     Status = AcpiOsCreateMutex (&ObjDesc->Mutex.OsMutex);
328     if (ACPI_FAILURE (Status))
329     {
330         goto Cleanup;
331     }
332 
333     /* Init object and attach to NS node */
334 
335     ObjDesc->Mutex.SyncLevel = (UINT8) WalkState->Operands[1]->Integer.Value;
336     ObjDesc->Mutex.Node = (ACPI_NAMESPACE_NODE *) WalkState->Operands[0];
337 
338     Status = AcpiNsAttachObject (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, "Invalid/unknown Address Space ID: 0x%2.2X", SpaceId));
407     }
408 
409     ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "Region Type - %s (0x%X)\n",
410         AcpiUtGetRegionName (SpaceId), SpaceId));
411 
412     /* Create the region descriptor */
413 
414     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_REGION);
415     if (!ObjDesc)
416     {
417         Status = AE_NO_MEMORY;
418         goto Cleanup;
419     }
420 
421     /*
422      * Remember location in AML stream of address & length
423      * operands since they need to be evaluated at run time.
424      */
425     RegionObj2 = ObjDesc->Common.NextObject;
426     RegionObj2->Extra.AmlStart = AmlStart;
427     RegionObj2->Extra.AmlLength = AmlLength;
428     if (WalkState->ScopeInfo)
429     {
430         RegionObj2->Extra.ScopeNode = WalkState->ScopeInfo->Scope.Node;
431     }
432     else
433     {
434         RegionObj2->Extra.ScopeNode = Node;
435     }
436 
437     /* Init the region from the operands */
438 
439     ObjDesc->Region.SpaceId = SpaceId;
440     ObjDesc->Region.Address = 0;
441     ObjDesc->Region.Length = 0;
442     ObjDesc->Region.Node = Node;
443 
444     /* Install the new region object in the parent Node */
445 
446     Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_REGION);
447 
448 
449 Cleanup:
450 
451     /* Remove local reference to the object */
452 
453     AcpiUtRemoveReference (ObjDesc);
454     return_ACPI_STATUS (Status);
455 }
456 
457 
458 /*******************************************************************************
459  *
460  * FUNCTION:    AcpiExCreateProcessor
461  *
462  * PARAMETERS:  WalkState           - Current state
463  *
464  * RETURN:      Status
465  *
466  * DESCRIPTION: Create a new processor object and populate the fields
467  *
468  *              Processor (Name[0], CpuID[1], PblockAddr[2], PblockLength[3])
469  *
470  ******************************************************************************/
471 
472 ACPI_STATUS
473 AcpiExCreateProcessor (
474     ACPI_WALK_STATE         *WalkState)
475 {
476     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
477     ACPI_OPERAND_OBJECT     *ObjDesc;
478     ACPI_STATUS             Status;
479 
480 
481     ACPI_FUNCTION_TRACE_PTR (ExCreateProcessor, WalkState);
482 
483 
484     /* Create the processor object */
485 
486     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_PROCESSOR);
487     if (!ObjDesc)
488     {
489         return_ACPI_STATUS (AE_NO_MEMORY);
490     }
491 
492     /* Initialize the processor object from the operands */
493 
494     ObjDesc->Processor.ProcId = (UINT8) Operand[1]->Integer.Value;
495     ObjDesc->Processor.Length = (UINT8) Operand[3]->Integer.Value;
496     ObjDesc->Processor.Address = (ACPI_IO_ADDRESS) Operand[2]->Integer.Value;
497 
498     /* Install the processor object in the parent Node */
499 
500     Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
501                     ObjDesc, ACPI_TYPE_PROCESSOR);
502 
503     /* Remove local reference to the object */
504 
505     AcpiUtRemoveReference (ObjDesc);
506     return_ACPI_STATUS (Status);
507 }
508 
509 
510 /*******************************************************************************
511  *
512  * FUNCTION:    AcpiExCreatePowerResource
513  *
514  * PARAMETERS:  WalkState           - Current state
515  *
516  * RETURN:      Status
517  *
518  * DESCRIPTION: Create a new PowerResource object and populate the fields
519  *
520  *              PowerResource (Name[0], SystemLevel[1], ResourceOrder[2])
521  *
522  ******************************************************************************/
523 
524 ACPI_STATUS
525 AcpiExCreatePowerResource (
526     ACPI_WALK_STATE         *WalkState)
527 {
528     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
529     ACPI_STATUS             Status;
530     ACPI_OPERAND_OBJECT     *ObjDesc;
531 
532 
533     ACPI_FUNCTION_TRACE_PTR (ExCreatePowerResource, WalkState);
534 
535 
536     /* Create the power resource object */
537 
538     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_POWER);
539     if (!ObjDesc)
540     {
541         return_ACPI_STATUS (AE_NO_MEMORY);
542     }
543 
544     /* Initialize the power object from the operands */
545 
546     ObjDesc->PowerResource.SystemLevel = (UINT8) Operand[1]->Integer.Value;
547     ObjDesc->PowerResource.ResourceOrder = (UINT16) Operand[2]->Integer.Value;
548 
549     /* Install the  power resource object in the parent Node */
550 
551     Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
552                     ObjDesc, ACPI_TYPE_POWER);
553 
554     /* Remove local reference to the object */
555 
556     AcpiUtRemoveReference (ObjDesc);
557     return_ACPI_STATUS (Status);
558 }
559 #endif
560 
561 
562 /*******************************************************************************
563  *
564  * FUNCTION:    AcpiExCreateMethod
565  *
566  * PARAMETERS:  AmlStart        - First byte of the method's AML
567  *              AmlLength       - AML byte count for this method
568  *              WalkState       - Current state
569  *
570  * RETURN:      Status
571  *
572  * DESCRIPTION: Create a new method object
573  *
574  ******************************************************************************/
575 
576 ACPI_STATUS
577 AcpiExCreateMethod (
578     UINT8                   *AmlStart,
579     UINT32                  AmlLength,
580     ACPI_WALK_STATE         *WalkState)
581 {
582     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
583     ACPI_OPERAND_OBJECT     *ObjDesc;
584     ACPI_STATUS             Status;
585     UINT8                   MethodFlags;
586 
587 
588     ACPI_FUNCTION_TRACE_PTR (ExCreateMethod, WalkState);
589 
590 
591     /* Create a new method object */
592 
593     ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
594     if (!ObjDesc)
595     {
596        Status = AE_NO_MEMORY;
597        goto Exit;
598     }
599 
600     /* Save the method's AML pointer and length  */
601 
602     ObjDesc->Method.AmlStart = AmlStart;
603     ObjDesc->Method.AmlLength = AmlLength;
604 
605     /*
606      * Disassemble the method flags. Split off the ArgCount, Serialized
607      * flag, and SyncLevel for efficiency.
608      */
609     MethodFlags = (UINT8) Operand[1]->Integer.Value;
610     ObjDesc->Method.ParamCount = (UINT8) (MethodFlags & AML_METHOD_ARG_COUNT);
611 
612     /*
613      * Get the SyncLevel. If method is serialized, a mutex will be
614      * created for this method when it is parsed.
615      */
616     if (MethodFlags & AML_METHOD_SERIALIZED)
617     {
618         ObjDesc->Method.InfoFlags = ACPI_METHOD_SERIALIZED;
619 
620         /*
621          * ACPI 1.0: SyncLevel = 0
622          * ACPI 2.0: SyncLevel = SyncLevel in method declaration
623          */
624         ObjDesc->Method.SyncLevel = (UINT8)
625             ((MethodFlags & AML_METHOD_SYNC_LEVEL) >> 4);
626     }
627 
628     /* Attach the new object to the method Node */
629 
630     Status = AcpiNsAttachObject ((ACPI_NAMESPACE_NODE *) Operand[0],
631                     ObjDesc, ACPI_TYPE_METHOD);
632 
633     /* Remove local reference to the object */
634 
635     AcpiUtRemoveReference (ObjDesc);
636 
637 Exit:
638     /* Remove a reference to the operand */
639 
640     AcpiUtRemoveReference (Operand[1]);
641     return_ACPI_STATUS (Status);
642 }
643