xref: /freebsd/sys/contrib/dev/acpica/compiler/aslpredef.c (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
1 /******************************************************************************
2  *
3  * Module Name: aslpredef - support for ACPI predefined names
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2010, 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  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government.  In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #define ACPI_CREATE_PREDEFINED_TABLE
117 
118 #include <contrib/dev/acpica/compiler/aslcompiler.h>
119 #include "aslcompiler.y.h"
120 #include <contrib/dev/acpica/include/amlcode.h>
121 #include <contrib/dev/acpica/include/acparser.h>
122 #include <contrib/dev/acpica/include/acpredef.h>
123 
124 
125 #define _COMPONENT          ACPI_COMPILER
126         ACPI_MODULE_NAME    ("aslpredef")
127 
128 
129 /* Local prototypes */
130 
131 static UINT32
132 ApCheckForSpecialName (
133     ACPI_PARSE_OBJECT       *Op,
134     char                    *Name);
135 
136 static void
137 ApCheckObjectType (
138     ACPI_PARSE_OBJECT       *Op,
139     UINT32                  ExpectedBtypes);
140 
141 static void
142 ApGetExpectedTypes (
143     char                    *Buffer,
144     UINT32                  ExpectedBtypes);
145 
146 
147 /*
148  * Names for the types that can be returned by the predefined objects.
149  * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
150  */
151 static const char   *AcpiRtypeNames[] =
152 {
153     "/Integer",
154     "/String",
155     "/Buffer",
156     "/Package",
157     "/Reference",
158 };
159 
160 /*
161  * Predefined names for use in Resource Descriptors. These names do not
162  * appear in the global Predefined Name table (since these names never
163  * appear in actual AML byte code, only in the original ASL)
164  */
165 static const ACPI_PREDEFINED_INFO      ResourceNames[] = {
166     {{"_ALN",     0,      0}},
167     {{"_ASI",     0,      0}},
168     {{"_ASZ",     0,      0}},
169     {{"_ATT",     0,      0}},
170     {{"_BAS",     0,      0}},
171     {{"_BM_",     0,      0}},
172     {{"_DEC",     0,      0}},
173     {{"_GRA",     0,      0}},
174     {{"_HE_",     0,      0}},
175     {{"_INT",     0,      0}},
176     {{"_LEN",     0,      0}},
177     {{"_LL_",     0,      0}},
178     {{"_MAF",     0,      0}},
179     {{"_MAX",     0,      0}},
180     {{"_MEM",     0,      0}},
181     {{"_MIF",     0,      0}},
182     {{"_MIN",     0,      0}},
183     {{"_MTP",     0,      0}},
184     {{"_RBO",     0,      0}},
185     {{"_RBW",     0,      0}},
186     {{"_RNG",     0,      0}},
187     {{"_RT_",     0,      0}},  /* Acpi 3.0 */
188     {{"_RW_",     0,      0}},
189     {{"_SHR",     0,      0}},
190     {{"_SIZ",     0,      0}},
191     {{"_TRA",     0,      0}},
192     {{"_TRS",     0,      0}},
193     {{"_TSF",     0,      0}},  /* Acpi 3.0 */
194     {{"_TTP",     0,      0}},
195     {{"_TYP",     0,      0}},
196     {{{0,0,0,0},  0,      0}}   /* Table terminator */
197 };
198 
199 static const ACPI_PREDEFINED_INFO      ScopeNames[] = {
200     {{"_SB_",     0,      0}},
201     {{"_SI_",     0,      0}},
202     {{"_TZ_",     0,      0}},
203     {{{0,0,0,0},  0,      0}}   /* Table terminator */
204 };
205 
206 
207 /*******************************************************************************
208  *
209  * FUNCTION:    ApCheckForPredefinedMethod
210  *
211  * PARAMETERS:  Op              - A parse node of type "METHOD".
212  *              MethodInfo      - Saved info about this method
213  *
214  * RETURN:      None
215  *
216  * DESCRIPTION: If method is a predefined name, check that the number of
217  *              arguments and the return type (returns a value or not)
218  *              is correct.
219  *
220  ******************************************************************************/
221 
222 void
223 ApCheckForPredefinedMethod (
224     ACPI_PARSE_OBJECT       *Op,
225     ASL_METHOD_INFO         *MethodInfo)
226 {
227     UINT32                  Index;
228     UINT32                  RequiredArgsCurrent;
229     UINT32                  RequiredArgsOld;
230 
231 
232     /* Check for a match against the predefined name list */
233 
234     Index = ApCheckForPredefinedName (Op, Op->Asl.NameSeg);
235 
236     switch (Index)
237     {
238     case ACPI_NOT_RESERVED_NAME:        /* No underscore or _Txx or _xxx name not matched */
239     case ACPI_PREDEFINED_NAME:          /* Resource Name or reserved scope name */
240     case ACPI_COMPILER_RESERVED_NAME:   /* A _Txx that was not emitted by compiler */
241 
242         /* Just return, nothing to do */
243         break;
244 
245 
246     case ACPI_EVENT_RESERVED_NAME:      /* _Lxx/_Exx/_Wxx/_Qxx methods */
247 
248         Gbl_ReservedMethods++;
249 
250         /* NumArguments must be zero for all _Lxx/_Exx/_Wxx/_Qxx methods */
251 
252         if (MethodInfo->NumArguments != 0)
253         {
254             sprintf (MsgBuffer, "%s requires %u", Op->Asl.ExternalName, 0);
255 
256             AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
257                 MsgBuffer);
258         }
259         break;
260 
261 
262     default:
263         /*
264          * Matched a predefined method name
265          *
266          * Validate the ASL-defined argument count. Allow two different legal
267          * arg counts.
268          */
269         Gbl_ReservedMethods++;
270 
271         RequiredArgsCurrent = PredefinedNames[Index].Info.ParamCount & 0x0F;
272         RequiredArgsOld = PredefinedNames[Index].Info.ParamCount >> 4;
273 
274         if ((MethodInfo->NumArguments != RequiredArgsCurrent) &&
275             (MethodInfo->NumArguments != RequiredArgsOld))
276         {
277             sprintf (MsgBuffer, "%4.4s requires %u",
278                 PredefinedNames[Index].Info.Name, RequiredArgsCurrent);
279 
280             if (MethodInfo->NumArguments > RequiredArgsCurrent)
281             {
282                 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
283                     MsgBuffer);
284             }
285             else
286             {
287                 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_LO, Op,
288                     MsgBuffer);
289             }
290         }
291 
292         /*
293          * Check if method returns no value, but the predefined name is
294          * required to return a value
295          */
296         if (MethodInfo->NumReturnNoValue &&
297             PredefinedNames[Index].Info.ExpectedBtypes)
298         {
299             ApGetExpectedTypes (StringBuffer,
300                 PredefinedNames[Index].Info.ExpectedBtypes);
301 
302             sprintf (MsgBuffer, "%s required for %4.4s",
303                 StringBuffer, PredefinedNames[Index].Info.Name);
304 
305             AslError (ASL_WARNING, ASL_MSG_RESERVED_RETURN_VALUE, Op,
306                 MsgBuffer);
307         }
308         break;
309     }
310 }
311 
312 
313 /*******************************************************************************
314  *
315  * FUNCTION:    ApCheckPredefinedReturnValue
316  *
317  * PARAMETERS:  Op              - A parse node of type "RETURN".
318  *              MethodInfo      - Saved info about this method
319  *
320  * RETURN:      None
321  *
322  * DESCRIPTION: If method is a predefined name, attempt to validate the return
323  *              value. Only "static" types can be validated - a simple return
324  *              of an integer/string/buffer/package or a named reference to
325  *              a static object. Values such as a Localx or Argx or a control
326  *              method invocation are not checked.
327  *
328  ******************************************************************************/
329 
330 void
331 ApCheckPredefinedReturnValue (
332     ACPI_PARSE_OBJECT       *Op,
333     ASL_METHOD_INFO         *MethodInfo)
334 {
335     UINT32                  Index;
336     ACPI_PARSE_OBJECT       *ReturnValueOp;
337 
338 
339     /* Check parent method for a match against the predefined name list */
340 
341     Index = ApCheckForPredefinedName (MethodInfo->Op,
342                 MethodInfo->Op->Asl.NameSeg);
343 
344     switch (Index)
345     {
346     case ACPI_NOT_RESERVED_NAME:        /* No underscore or _Txx or _xxx name not matched */
347     case ACPI_PREDEFINED_NAME:          /* Resource Name or reserved scope name */
348     case ACPI_COMPILER_RESERVED_NAME:   /* A _Txx that was not emitted by compiler */
349     case ACPI_EVENT_RESERVED_NAME:      /* _Lxx/_Exx/_Wxx/_Qxx methods */
350 
351         /* Just return, nothing to do */
352         return;
353 
354     default: /* A standard predefined ACPI name */
355 
356         /* Exit if no return value expected */
357 
358         if (!PredefinedNames[Index].Info.ExpectedBtypes)
359         {
360             return;
361         }
362 
363         /* Get the object returned, it is the next argument */
364 
365         ReturnValueOp = Op->Asl.Child;
366         switch (ReturnValueOp->Asl.ParseOpcode)
367         {
368         case PARSEOP_ZERO:
369         case PARSEOP_ONE:
370         case PARSEOP_ONES:
371         case PARSEOP_INTEGER:
372         case PARSEOP_STRING_LITERAL:
373         case PARSEOP_BUFFER:
374         case PARSEOP_PACKAGE:
375 
376             /* Static data return object - check against expected type */
377 
378             ApCheckObjectType (ReturnValueOp,
379                 PredefinedNames[Index].Info.ExpectedBtypes);
380             break;
381 
382         default:
383 
384             /*
385              * All other ops are very difficult or impossible to typecheck at
386              * compile time. These include all Localx, Argx, and method
387              * invocations. Also, NAMESEG and NAMESTRING because the type of
388              * any named object can be changed at runtime (for example,
389              * CopyObject will change the type of the target object.)
390              */
391             break;
392         }
393     }
394 }
395 
396 
397 /*******************************************************************************
398  *
399  * FUNCTION:    ApCheckForPredefinedObject
400  *
401  * PARAMETERS:  Op              - A parse node
402  *              Name            - The ACPI name to be checked
403  *
404  * RETURN:      None
405  *
406  * DESCRIPTION: Check for a predefined name for a static object (created via
407  *              the ASL Name operator). If it is a predefined ACPI name, ensure
408  *              that the name does not require any arguments (which would
409  *              require a control method implemenation of the name), and that
410  *              the type of the object is one of the expected types for the
411  *              predefined name.
412  *
413  ******************************************************************************/
414 
415 void
416 ApCheckForPredefinedObject (
417     ACPI_PARSE_OBJECT       *Op,
418     char                    *Name)
419 {
420     UINT32                  Index;
421 
422 
423     /*
424      * Check for a real predefined name -- not a resource descriptor name
425      * or a predefined scope name
426      */
427     Index = ApCheckForPredefinedName (Op, Name);
428 
429     switch (Index)
430     {
431     case ACPI_NOT_RESERVED_NAME:        /* No underscore or _Txx or _xxx name not matched */
432     case ACPI_PREDEFINED_NAME:          /* Resource Name or reserved scope name */
433     case ACPI_COMPILER_RESERVED_NAME:   /* A _Txx that was not emitted by compiler */
434 
435         /* Nothing to do */
436         return;
437 
438     case ACPI_EVENT_RESERVED_NAME:      /* _Lxx/_Exx/_Wxx/_Qxx methods */
439 
440         /*
441          * These names must be control methods, by definition in ACPI spec.
442          * Also because they are defined to return no value. None of them
443          * require any arguments.
444          */
445         AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
446             "with zero arguments");
447         return;
448 
449     default: /* A standard predefined ACPI name */
450 
451         /*
452          * If this predefined name requires input arguments, then
453          * it must be implemented as a control method
454          */
455         if (PredefinedNames[Index].Info.ParamCount > 0)
456         {
457             AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
458                 "with arguments");
459             return;
460         }
461 
462         /*
463          * If no return value is expected from this predefined name, then
464          * it follows that it must be implemented as a control method
465          * (with zero args, because the args > 0 case was handled above)
466          * Examples are: _DIS, _INI, _IRC, _OFF, _ON, _PSx
467          */
468         if (!PredefinedNames[Index].Info.ExpectedBtypes)
469         {
470             AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
471                 "with zero arguments");
472             return;
473         }
474 
475         /* Typecheck the actual object, it is the next argument */
476 
477         ApCheckObjectType (Op->Asl.Child->Asl.Next,
478             PredefinedNames[Index].Info.ExpectedBtypes);
479         return;
480     }
481 }
482 
483 
484 /*******************************************************************************
485  *
486  * FUNCTION:    ApCheckForPredefinedName
487  *
488  * PARAMETERS:  Op              - A parse node
489  *              Name            - NameSeg to check
490  *
491  * RETURN:      None
492  *
493  * DESCRIPTION: Check a NameSeg against the reserved list.
494  *
495  ******************************************************************************/
496 
497 UINT32
498 ApCheckForPredefinedName (
499     ACPI_PARSE_OBJECT       *Op,
500     char                    *Name)
501 {
502     UINT32                  i;
503 
504 
505     if (Name[0] == 0)
506     {
507         AcpiOsPrintf ("Found a null name, external = %s\n",
508             Op->Asl.ExternalName);
509     }
510 
511     /* All reserved names are prefixed with a single underscore */
512 
513     if (Name[0] != '_')
514     {
515         return (ACPI_NOT_RESERVED_NAME);
516     }
517 
518     /* Check for a standard predefined method name */
519 
520     for (i = 0; PredefinedNames[i].Info.Name[0]; i++)
521     {
522         if (ACPI_COMPARE_NAME (Name, PredefinedNames[i].Info.Name))
523         {
524             /* Return index into predefined array */
525             return (i);
526         }
527     }
528 
529     /* Check for resource names and predefined scope names */
530 
531     for (i = 0; ResourceNames[i].Info.Name[0]; i++)
532     {
533         if (ACPI_COMPARE_NAME (Name, ResourceNames[i].Info.Name))
534         {
535             return (ACPI_PREDEFINED_NAME);
536         }
537     }
538 
539     for (i = 0; ScopeNames[i].Info.Name[0]; i++)
540     {
541         if (ACPI_COMPARE_NAME (Name, ScopeNames[i].Info.Name))
542         {
543             return (ACPI_PREDEFINED_NAME);
544         }
545     }
546 
547     /* Check for _Lxx/_Exx/_Wxx/_Qxx/_T_x. Warning if unknown predefined name */
548 
549     return (ApCheckForSpecialName (Op, Name));
550 }
551 
552 
553 /*******************************************************************************
554  *
555  * FUNCTION:    ApCheckForSpecialName
556  *
557  * PARAMETERS:  Op              - A parse node
558  *              Name            - NameSeg to check
559  *
560  * RETURN:      None
561  *
562  * DESCRIPTION: Check for the "special" predefined names -
563  *              _Lxx, _Exx, _Qxx, _Wxx, and _T_x
564  *
565  ******************************************************************************/
566 
567 static UINT32
568 ApCheckForSpecialName (
569     ACPI_PARSE_OBJECT       *Op,
570     char                    *Name)
571 {
572 
573     /*
574      * Check for the "special" predefined names. We already know that the
575      * first character is an underscore.
576      *   GPE:  _Lxx
577      *   GPE:  _Exx
578      *   GPE:  _Wxx
579      *   EC:   _Qxx
580      */
581     if ((Name[1] == 'L') ||
582         (Name[1] == 'E') ||
583         (Name[1] == 'W') ||
584         (Name[1] == 'Q'))
585     {
586         /* The next two characters must be hex digits */
587 
588         if ((isxdigit ((int) Name[2])) &&
589             (isxdigit ((int) Name[3])))
590         {
591             return (ACPI_EVENT_RESERVED_NAME);
592         }
593     }
594 
595     /* Check for the names reserved for the compiler itself: _T_x */
596 
597     else if ((Op->Asl.ExternalName[1] == 'T') &&
598              (Op->Asl.ExternalName[2] == '_'))
599     {
600         /* Ignore if actually emitted by the compiler */
601 
602         if (Op->Asl.CompileFlags & NODE_COMPILER_EMITTED)
603         {
604             return (ACPI_NOT_RESERVED_NAME);
605         }
606 
607         /*
608          * Was not actually emitted by the compiler. This is a special case,
609          * however. If the ASL code being compiled was the result of a
610          * dissasembly, it may possibly contain valid compiler-emitted names
611          * of the form "_T_x". We don't want to issue an error or even a
612          * warning and force the user to manually change the names. So, we
613          * will issue a remark instead.
614          */
615         AslError (ASL_REMARK, ASL_MSG_COMPILER_RESERVED, Op, Op->Asl.ExternalName);
616         return (ACPI_COMPILER_RESERVED_NAME);
617     }
618 
619     /*
620      * The name didn't match any of the known predefined names. Flag it as a
621      * warning, since the entire namespace starting with an underscore is
622      * reserved by the ACPI spec.
623      */
624     AslError (ASL_WARNING, ASL_MSG_UNKNOWN_RESERVED_NAME, Op,
625         Op->Asl.ExternalName);
626 
627     return (ACPI_NOT_RESERVED_NAME);
628 }
629 
630 
631 /*******************************************************************************
632  *
633  * FUNCTION:    ApCheckObjectType
634  *
635  * PARAMETERS:  Op              - Current parse node
636  *              ExpectedBtypes  - Bitmap of expected return type(s)
637  *
638  * RETURN:      None
639  *
640  * DESCRIPTION: Check if the object type is one of the types that is expected
641  *              by the predefined name. Only a limited number of object types
642  *              can be returned by the predefined names.
643  *
644  ******************************************************************************/
645 
646 static void
647 ApCheckObjectType (
648     ACPI_PARSE_OBJECT       *Op,
649     UINT32                  ExpectedBtypes)
650 {
651     UINT32                  ReturnBtype;
652 
653 
654     switch (Op->Asl.ParseOpcode)
655     {
656     case PARSEOP_ZERO:
657     case PARSEOP_ONE:
658     case PARSEOP_ONES:
659     case PARSEOP_INTEGER:
660         ReturnBtype = ACPI_RTYPE_INTEGER;
661         break;
662 
663     case PARSEOP_BUFFER:
664         ReturnBtype = ACPI_RTYPE_BUFFER;
665         break;
666 
667     case PARSEOP_STRING_LITERAL:
668         ReturnBtype = ACPI_RTYPE_STRING;
669         break;
670 
671     case PARSEOP_PACKAGE:
672         ReturnBtype = ACPI_RTYPE_PACKAGE;
673         break;
674 
675     default:
676         /* Not one of the supported object types */
677 
678         goto TypeErrorExit;
679     }
680 
681     /* Exit if the object is one of the expected types */
682 
683     if (ReturnBtype & ExpectedBtypes)
684     {
685         return;
686     }
687 
688 
689 TypeErrorExit:
690 
691     /* Format the expected types and emit an error message */
692 
693     ApGetExpectedTypes (StringBuffer, ExpectedBtypes);
694 
695     sprintf (MsgBuffer, "found %s, requires %s",
696         UtGetOpName (Op->Asl.ParseOpcode), StringBuffer);
697 
698     AslError (ASL_ERROR, ASL_MSG_RESERVED_OPERAND_TYPE, Op,
699         MsgBuffer);
700 }
701 
702 
703 /*******************************************************************************
704  *
705  * FUNCTION:    ApDisplayReservedNames
706  *
707  * PARAMETERS:  None
708  *
709  * RETURN:      None
710  *
711  * DESCRIPTION: Dump information about the ACPI predefined names and predefined
712  *              resource descriptor names.
713  *
714  ******************************************************************************/
715 
716 void
717 ApDisplayReservedNames (
718     void)
719 {
720     const ACPI_PREDEFINED_INFO  *ThisName;
721     char                        TypeBuffer[48]; /* Room for 5 types */
722     UINT32                      Count;
723 
724 
725     /*
726      * Predefined names/methods
727      */
728     printf ("\nPredefined Name Information\n\n");
729 
730     Count = 0;
731     ThisName = PredefinedNames;
732     while (ThisName->Info.Name[0])
733     {
734         printf ("%4.4s    Requires %u arguments, ",
735             ThisName->Info.Name, ThisName->Info.ParamCount & 0x0F);
736 
737         if (ThisName->Info.ExpectedBtypes)
738         {
739             ApGetExpectedTypes (TypeBuffer, ThisName->Info.ExpectedBtypes);
740             printf ("Must return: %s\n", TypeBuffer);
741         }
742         else
743         {
744             printf ("No return value\n");
745         }
746 
747         /*
748          * Skip next entry in the table if this name returns a Package
749          * (next entry contains the package info)
750          */
751         if (ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE)
752         {
753             ThisName++;
754         }
755 
756         Count++;
757         ThisName++;
758     }
759 
760     printf ("%u Predefined Names are recognized\n", Count);
761 
762     /*
763      * Resource Descriptor names
764      */
765     printf ("\nResource Descriptor Predefined Names\n\n");
766 
767     Count = 0;
768     ThisName = ResourceNames;
769     while (ThisName->Info.Name[0])
770     {
771         printf ("%4.4s    Resource Descriptor\n", ThisName->Info.Name);
772         Count++;
773         ThisName++;
774     }
775 
776     printf ("%u Resource Descriptor Names are recognized\n", Count);
777 
778     /*
779      * Predefined scope names
780      */
781     printf ("\nPredefined Scope Names\n\n");
782 
783     ThisName = ScopeNames;
784     while (ThisName->Info.Name[0])
785     {
786         printf ("%4.4s    Scope\n", ThisName->Info.Name);
787         ThisName++;
788     }
789 }
790 
791 
792 /*******************************************************************************
793  *
794  * FUNCTION:    ApGetExpectedTypes
795  *
796  * PARAMETERS:  Buffer              - Where the formatted string is returned
797  *              ExpectedBTypes      - Bitfield of expected data types
798  *
799  * RETURN:      None, formatted string
800  *
801  * DESCRIPTION: Format the expected object types into a printable string.
802  *
803  ******************************************************************************/
804 
805 static void
806 ApGetExpectedTypes (
807     char                        *Buffer,
808     UINT32                      ExpectedBtypes)
809 {
810     UINT32                      ThisRtype;
811     UINT32                      i;
812     UINT32                      j;
813 
814 
815     j = 1;
816     Buffer[0] = 0;
817     ThisRtype = ACPI_RTYPE_INTEGER;
818 
819     for (i = 0; i < ACPI_NUM_RTYPES; i++)
820     {
821         /* If one of the expected types, concatenate the name of this type */
822 
823         if (ExpectedBtypes & ThisRtype)
824         {
825             ACPI_STRCAT (Buffer, &AcpiRtypeNames[i][j]);
826             j = 0;              /* Use name separator from now on */
827         }
828         ThisRtype <<= 1;    /* Next Rtype */
829     }
830 }
831 
832