]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/contrib/dev/acpica/exresolv.c
This commit was generated by cvs2svn to compensate for changes in r159952,
[FreeBSD/FreeBSD.git] / sys / contrib / dev / acpica / exresolv.c
1
2 /******************************************************************************
3  *
4  * Module Name: exresolv - AML Interpreter object resolution
5  *              $Revision: 1.132 $
6  *
7  *****************************************************************************/
8
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
14  * All rights reserved.
15  *
16  * 2. License
17  *
18  * 2.1. This is your license from Intel Corp. under its intellectual property
19  * rights.  You may have additional license terms from the party that provided
20  * you this software, covering your right to use that party's intellectual
21  * property rights.
22  *
23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24  * copy of the source code appearing in this file ("Covered Code") an
25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26  * base code distributed originally by Intel ("Original Intel Code") to copy,
27  * make derivatives, distribute, use and display any portion of the Covered
28  * Code in any form, with the right to sublicense such rights; and
29  *
30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31  * license (with the right to sublicense), under only those claims of Intel
32  * patents that are infringed by the Original Intel Code, to make, use, sell,
33  * offer to sell, and import the Covered Code and derivative works thereof
34  * solely to the minimum extent necessary to exercise the above copyright
35  * license, and in no event shall the patent license extend to any additions
36  * to or modifications of the Original Intel Code.  No other license or right
37  * is granted directly or by implication, estoppel or otherwise;
38  *
39  * The above copyright and patent license is granted only if the following
40  * conditions are met:
41  *
42  * 3. Conditions
43  *
44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45  * Redistribution of source code of any substantial portion of the Covered
46  * Code or modification with rights to further distribute source must include
47  * the above Copyright Notice, the above License, this list of Conditions,
48  * and the following Disclaimer and Export Compliance provision.  In addition,
49  * Licensee must cause all Covered Code to which Licensee contributes to
50  * contain a file documenting the changes Licensee made to create that Covered
51  * Code and the date of any change.  Licensee must include in that file the
52  * documentation of any changes made by any predecessor Licensee.  Licensee
53  * must include a prominent statement that the modification is derived,
54  * directly or indirectly, from Original Intel Code.
55  *
56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57  * Redistribution of source code of any substantial portion of the Covered
58  * Code or modification without rights to further distribute source must
59  * include the following Disclaimer and Export Compliance provision in the
60  * documentation and/or other materials provided with distribution.  In
61  * addition, Licensee may not authorize further sublicense of source of any
62  * portion of the Covered Code, and must include terms to the effect that the
63  * license from Licensee to its licensee is limited to the intellectual
64  * property embodied in the software Licensee provides to its licensee, and
65  * not to intellectual property embodied in modifications its licensee may
66  * make.
67  *
68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
69  * substantial portion of the Covered Code or modification must reproduce the
70  * above Copyright Notice, and the following Disclaimer and Export Compliance
71  * provision in the documentation and/or other materials provided with the
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78  * Intel shall be used in advertising or otherwise to promote the sale, use or
79  * other dealings in products derived from or relating to the Covered Code
80  * without prior written authorization from Intel.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90  * PARTICULAR PURPOSE.
91  *
92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99  * LIMITED REMEDY.
100  *
101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
102  * software or system incorporating such software without first obtaining any
103  * required license or other approval from the U. S. Department of Commerce or
104  * any other agency or department of the United States Government.  In the
105  * event Licensee exports any such software from the United States or
106  * re-exports any such software from a foreign destination, Licensee shall
107  * ensure that the distribution and export/re-export of the software is in
108  * compliance with all laws, regulations, orders, or other restrictions of the
109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110  * any of its subsidiaries will export/re-export any technical data, process,
111  * software, or service, directly or indirectly, to any country for which the
112  * United States government or any agency thereof requires an export license,
113  * other governmental approval, or letter of assurance, without first obtaining
114  * such license, approval or letter.
115  *
116  *****************************************************************************/
117
118 #define __EXRESOLV_C__
119
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/amlcode.h>
122 #include <contrib/dev/acpica/acdispat.h>
123 #include <contrib/dev/acpica/acinterp.h>
124 #include <contrib/dev/acpica/acnamesp.h>
125 #include <contrib/dev/acpica/acparser.h>
126
127
128 #define _COMPONENT          ACPI_EXECUTER
129         ACPI_MODULE_NAME    ("exresolv")
130
131 /* Local prototypes */
132
133 static ACPI_STATUS
134 AcpiExResolveObjectToValue (
135     ACPI_OPERAND_OBJECT     **StackPtr,
136     ACPI_WALK_STATE         *WalkState);
137
138
139 /*******************************************************************************
140  *
141  * FUNCTION:    AcpiExResolveToValue
142  *
143  * PARAMETERS:  **StackPtr          - Points to entry on ObjStack, which can
144  *                                    be either an (ACPI_OPERAND_OBJECT *)
145  *                                    or an ACPI_HANDLE.
146  *              WalkState           - Current method state
147  *
148  * RETURN:      Status
149  *
150  * DESCRIPTION: Convert Reference objects to values
151  *
152  ******************************************************************************/
153
154 ACPI_STATUS
155 AcpiExResolveToValue (
156     ACPI_OPERAND_OBJECT     **StackPtr,
157     ACPI_WALK_STATE         *WalkState)
158 {
159     ACPI_STATUS             Status;
160
161
162     ACPI_FUNCTION_TRACE_PTR ("ExResolveToValue", StackPtr);
163
164
165     if (!StackPtr || !*StackPtr)
166     {
167         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - null pointer\n"));
168         return_ACPI_STATUS (AE_AML_NO_OPERAND);
169     }
170
171     /*
172      * The entity pointed to by the StackPtr can be either
173      * 1) A valid ACPI_OPERAND_OBJECT, or
174      * 2) A ACPI_NAMESPACE_NODE (NamedObj)
175      */
176     if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_OPERAND)
177     {
178         Status = AcpiExResolveObjectToValue (StackPtr, WalkState);
179         if (ACPI_FAILURE (Status))
180         {
181             return_ACPI_STATUS (Status);
182         }
183
184         if (!*StackPtr)
185         {
186             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - null pointer\n"));
187             return_ACPI_STATUS (AE_AML_NO_OPERAND);
188         }
189     }
190
191     /*
192      * Object on the stack may have changed if AcpiExResolveObjectToValue()
193      * was called (i.e., we can't use an _else_ here.)
194      */
195     if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_NAMED)
196     {
197         Status = AcpiExResolveNodeToValue (
198                         ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, StackPtr),
199                         WalkState);
200         if (ACPI_FAILURE (Status))
201         {
202             return_ACPI_STATUS (Status);
203         }
204     }
205
206     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Resolved object %p\n", *StackPtr));
207     return_ACPI_STATUS (AE_OK);
208 }
209
210
211 /*******************************************************************************
212  *
213  * FUNCTION:    AcpiExResolveObjectToValue
214  *
215  * PARAMETERS:  StackPtr        - Pointer to an internal object
216  *              WalkState       - Current method state
217  *
218  * RETURN:      Status
219  *
220  * DESCRIPTION: Retrieve the value from an internal object. The Reference type
221  *              uses the associated AML opcode to determine the value.
222  *
223  ******************************************************************************/
224
225 static ACPI_STATUS
226 AcpiExResolveObjectToValue (
227     ACPI_OPERAND_OBJECT     **StackPtr,
228     ACPI_WALK_STATE         *WalkState)
229 {
230     ACPI_STATUS             Status = AE_OK;
231     ACPI_OPERAND_OBJECT     *StackDesc;
232     void                    *TempNode;
233     ACPI_OPERAND_OBJECT     *ObjDesc;
234     UINT16                  Opcode;
235
236
237     ACPI_FUNCTION_TRACE ("ExResolveObjectToValue");
238
239
240     StackDesc = *StackPtr;
241
242     /* This is an ACPI_OPERAND_OBJECT  */
243
244     switch (ACPI_GET_OBJECT_TYPE (StackDesc))
245     {
246     case ACPI_TYPE_LOCAL_REFERENCE:
247
248         Opcode = StackDesc->Reference.Opcode;
249
250         switch (Opcode)
251         {
252         case AML_NAME_OP:
253
254             /*
255              * Convert name reference to a namespace node
256              * Then, AcpiExResolveNodeToValue can be used to get the value
257              */
258             TempNode = StackDesc->Reference.Object;
259
260             /* Delete the Reference Object */
261
262             AcpiUtRemoveReference (StackDesc);
263
264             /* Return the namespace node */
265
266             (*StackPtr) = TempNode;
267             break;
268
269
270         case AML_LOCAL_OP:
271         case AML_ARG_OP:
272
273             /*
274              * Get the local from the method's state info
275              * Note: this increments the local's object reference count
276              */
277             Status = AcpiDsMethodDataGetValue (Opcode,
278                             StackDesc->Reference.Offset, WalkState, &ObjDesc);
279             if (ACPI_FAILURE (Status))
280             {
281                 return_ACPI_STATUS (Status);
282             }
283
284             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Arg/Local %X] ValueObj is %p\n",
285                 StackDesc->Reference.Offset, ObjDesc));
286
287             /*
288              * Now we can delete the original Reference Object and
289              * replace it with the resolved value
290              */
291             AcpiUtRemoveReference (StackDesc);
292             *StackPtr = ObjDesc;
293             break;
294
295
296         case AML_INDEX_OP:
297
298             switch (StackDesc->Reference.TargetType)
299             {
300             case ACPI_TYPE_BUFFER_FIELD:
301
302                 /* Just return - leave the Reference on the stack */
303                 break;
304
305
306             case ACPI_TYPE_PACKAGE:
307
308                 ObjDesc = *StackDesc->Reference.Where;
309                 if (ObjDesc)
310                 {
311                     /*
312                      * Valid obj descriptor, copy pointer to return value
313                      * (i.e., dereference the package index)
314                      * Delete the ref object, increment the returned object
315                      */
316                     AcpiUtRemoveReference (StackDesc);
317                     AcpiUtAddReference (ObjDesc);
318                     *StackPtr = ObjDesc;
319                 }
320                 else
321                 {
322                     /*
323                      * A NULL object descriptor means an unitialized element of
324                      * the package, can't dereference it
325                      */
326                     ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
327                         "Attempt to deref an Index to NULL pkg element Idx=%p\n",
328                         StackDesc));
329                     Status = AE_AML_UNINITIALIZED_ELEMENT;
330                 }
331                 break;
332
333
334             default:
335
336                 /* Invalid reference object */
337
338                 ACPI_REPORT_ERROR ((
339                     "During resolve, Unknown TargetType %X in Index/Reference obj %p\n",
340                     StackDesc->Reference.TargetType, StackDesc));
341                 Status = AE_AML_INTERNAL;
342                 break;
343             }
344             break;
345
346
347         case AML_REF_OF_OP:
348         case AML_DEBUG_OP:
349         case AML_LOAD_OP:
350
351             /* Just leave the object as-is */
352
353             break;
354
355         case AML_INT_NAMEPATH_OP:   /* Reference to a named object */
356
357             /* Get the object pointed to by the namespace node */
358
359             *StackPtr = (StackDesc->Reference.Node)->Object;
360             AcpiUtAddReference (*StackPtr);
361             AcpiUtRemoveReference (StackDesc);
362             break;
363
364         default:
365
366             ACPI_REPORT_ERROR ((
367                 "During resolve, Unknown Reference opcode %X (%s) in %p\n",
368                 Opcode, AcpiPsGetOpcodeName (Opcode), StackDesc));
369             Status = AE_AML_INTERNAL;
370             break;
371         }
372         break;
373
374
375     case ACPI_TYPE_BUFFER:
376
377         Status = AcpiDsGetBufferArguments (StackDesc);
378         break;
379
380
381     case ACPI_TYPE_PACKAGE:
382
383         Status = AcpiDsGetPackageArguments (StackDesc);
384         break;
385
386
387     /* These cases may never happen here, but just in case.. */
388
389     case ACPI_TYPE_BUFFER_FIELD:
390     case ACPI_TYPE_LOCAL_REGION_FIELD:
391     case ACPI_TYPE_LOCAL_BANK_FIELD:
392     case ACPI_TYPE_LOCAL_INDEX_FIELD:
393
394         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "FieldRead SourceDesc=%p Type=%X\n",
395             StackDesc, ACPI_GET_OBJECT_TYPE (StackDesc)));
396
397         Status = AcpiExReadDataFromField (WalkState, StackDesc, &ObjDesc);
398         *StackPtr = (void *) ObjDesc;
399         break;
400
401     default:
402         break;
403     }
404
405     return_ACPI_STATUS (Status);
406 }
407
408
409 /*******************************************************************************
410  *
411  * FUNCTION:    AcpiExResolveMultiple
412  *
413  * PARAMETERS:  WalkState           - Current state (contains AML opcode)
414  *              Operand             - Starting point for resolution
415  *              ReturnType          - Where the object type is returned
416  *              ReturnDesc          - Where the resolved object is returned
417  *
418  * RETURN:      Status
419  *
420  * DESCRIPTION: Return the base object and type.  Traverse a reference list if
421  *              necessary to get to the base object.
422  *
423  ******************************************************************************/
424
425 ACPI_STATUS
426 AcpiExResolveMultiple (
427     ACPI_WALK_STATE         *WalkState,
428     ACPI_OPERAND_OBJECT     *Operand,
429     ACPI_OBJECT_TYPE        *ReturnType,
430     ACPI_OPERAND_OBJECT     **ReturnDesc)
431 {
432     ACPI_OPERAND_OBJECT     *ObjDesc = (void *) Operand;
433     ACPI_NAMESPACE_NODE     *Node;
434     ACPI_OBJECT_TYPE        Type;
435     ACPI_STATUS             Status;
436
437
438     ACPI_FUNCTION_TRACE ("AcpiExResolveMultiple");
439
440
441     /* Operand can be either a namespace node or an operand descriptor */
442
443     switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
444     {
445     case ACPI_DESC_TYPE_OPERAND:
446         Type = ObjDesc->Common.Type;
447         break;
448
449     case ACPI_DESC_TYPE_NAMED:
450         Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
451         ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
452
453         /* If we had an Alias node, use the attached object for type info */
454
455         if (Type == ACPI_TYPE_LOCAL_ALIAS)
456         {
457             Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
458             ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
459         }
460         break;
461
462     default:
463         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
464     }
465
466     /* If type is anything other than a reference, we are done */
467
468     if (Type != ACPI_TYPE_LOCAL_REFERENCE)
469     {
470         goto Exit;
471     }
472
473     /*
474      * For reference objects created via the RefOf or Index operators,
475      * we need to get to the base object (as per the ACPI specification
476      * of the ObjectType and SizeOf operators).  This means traversing
477      * the list of possibly many nested references.
478      */
479     while (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REFERENCE)
480     {
481         switch (ObjDesc->Reference.Opcode)
482         {
483         case AML_REF_OF_OP:
484
485             /* Dereference the reference pointer */
486
487             Node = ObjDesc->Reference.Object;
488
489             /* All "References" point to a NS node */
490
491             if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
492             {
493                 ACPI_REPORT_ERROR ((
494                     "AcpiExResolveMultiple: Not a NS node %p [%s]\n",
495                     Node, AcpiUtGetDescriptorName (Node)));
496                 return_ACPI_STATUS (AE_AML_INTERNAL);
497             }
498
499             /* Get the attached object */
500
501             ObjDesc = AcpiNsGetAttachedObject (Node);
502             if (!ObjDesc)
503             {
504                 /* No object, use the NS node type */
505
506                 Type = AcpiNsGetType (Node);
507                 goto Exit;
508             }
509
510             /* Check for circular references */
511
512             if (ObjDesc == Operand)
513             {
514                 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
515             }
516             break;
517
518
519         case AML_INDEX_OP:
520
521             /* Get the type of this reference (index into another object) */
522
523             Type = ObjDesc->Reference.TargetType;
524             if (Type != ACPI_TYPE_PACKAGE)
525             {
526                 goto Exit;
527             }
528
529             /*
530              * The main object is a package, we want to get the type
531              * of the individual package element that is referenced by
532              * the index.
533              *
534              * This could of course in turn be another reference object.
535              */
536             ObjDesc = *(ObjDesc->Reference.Where);
537             if (!ObjDesc)
538             {
539                 /* NULL package elements are allowed */
540
541                 Type = 0; /* Uninitialized */
542                 goto Exit;
543             }
544             break;
545
546
547         case AML_INT_NAMEPATH_OP:
548
549             /* Dereference the reference pointer */
550
551             Node = ObjDesc->Reference.Node;
552
553             /* All "References" point to a NS node */
554
555             if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
556             {
557                 ACPI_REPORT_ERROR ((
558                     "AcpiExResolveMultiple: Not a NS node %p [%s]\n",
559                     Node, AcpiUtGetDescriptorName (Node)));
560                return_ACPI_STATUS (AE_AML_INTERNAL);
561             }
562
563             /* Get the attached object */
564
565             ObjDesc = AcpiNsGetAttachedObject (Node);
566             if (!ObjDesc)
567             {
568                 /* No object, use the NS node type */
569
570                 Type = AcpiNsGetType (Node);
571                 goto Exit;
572             }
573
574             /* Check for circular references */
575
576             if (ObjDesc == Operand)
577             {
578                 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
579             }
580             break;
581
582
583         case AML_LOCAL_OP:
584         case AML_ARG_OP:
585
586             if (ReturnDesc)
587             {
588                 Status = AcpiDsMethodDataGetValue (ObjDesc->Reference.Opcode,
589                             ObjDesc->Reference.Offset, WalkState, &ObjDesc);
590                 if (ACPI_FAILURE (Status))
591                 {
592                     return_ACPI_STATUS (Status);
593                 }
594                 AcpiUtRemoveReference (ObjDesc);
595             }
596             else
597             {
598                 Status = AcpiDsMethodDataGetNode (ObjDesc->Reference.Opcode,
599                             ObjDesc->Reference.Offset, WalkState, &Node);
600                 if (ACPI_FAILURE (Status))
601                 {
602                     return_ACPI_STATUS (Status);
603                 }
604
605                 ObjDesc = AcpiNsGetAttachedObject (Node);
606                 if (!ObjDesc)
607                 {
608                     Type = ACPI_TYPE_ANY;
609                     goto Exit;
610                 }
611             }
612             break;
613
614
615         case AML_DEBUG_OP:
616
617             /* The Debug Object is of type "DebugObject" */
618
619             Type = ACPI_TYPE_DEBUG_OBJECT;
620             goto Exit;
621
622
623         default:
624
625             ACPI_REPORT_ERROR ((
626                 "AcpiExResolveMultiple: Unknown Reference subtype %X\n",
627                 ObjDesc->Reference.Opcode));
628             return_ACPI_STATUS (AE_AML_INTERNAL);
629         }
630     }
631
632     /*
633      * Now we are guaranteed to have an object that has not been created
634      * via the RefOf or Index operators.
635      */
636     Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
637
638
639 Exit:
640     /* Convert internal types to external types */
641
642     switch (Type)
643     {
644     case ACPI_TYPE_LOCAL_REGION_FIELD:
645     case ACPI_TYPE_LOCAL_BANK_FIELD:
646     case ACPI_TYPE_LOCAL_INDEX_FIELD:
647
648         Type = ACPI_TYPE_FIELD_UNIT;
649         break;
650
651     case ACPI_TYPE_LOCAL_SCOPE:
652
653         /* Per ACPI Specification, Scope is untyped */
654
655         Type = ACPI_TYPE_ANY;
656         break;
657
658     default:
659         /* No change to Type required */
660         break;
661     }
662
663     *ReturnType = Type;
664     if (ReturnDesc)
665     {
666         *ReturnDesc = ObjDesc;
667     }
668     return_ACPI_STATUS (AE_OK);
669 }
670
671