1 /******************************************************************************
3 * Module Name: aslpredef - support for ACPI predefined names
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
116 #define ACPI_CREATE_PREDEFINED_TABLE
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>
125 #define _COMPONENT ACPI_COMPILER
126 ACPI_MODULE_NAME ("aslpredef")
129 /* Local prototypes */
132 ApCheckForSpecialName (
133 ACPI_PARSE_OBJECT *Op,
138 ACPI_PARSE_OBJECT *Op,
139 UINT32 ExpectedBtypes);
144 UINT32 ExpectedBtypes);
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
151 static const char *AcpiRtypeNames[] =
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)
165 static const ACPI_PREDEFINED_INFO ResourceNames[] = {
187 {{"_RT_", 0, 0}}, /* Acpi 3.0 */
193 {{"_TSF", 0, 0}}, /* Acpi 3.0 */
196 {{{0,0,0,0}, 0, 0}} /* Table terminator */
199 static const ACPI_PREDEFINED_INFO ScopeNames[] = {
203 {{{0,0,0,0}, 0, 0}} /* Table terminator */
207 /*******************************************************************************
209 * FUNCTION: ApCheckForPredefinedMethod
211 * PARAMETERS: Op - A parse node of type "METHOD".
212 * MethodInfo - Saved info about this method
216 * DESCRIPTION: If method is a predefined name, check that the number of
217 * arguments and the return type (returns a value or not)
220 ******************************************************************************/
223 ApCheckForPredefinedMethod (
224 ACPI_PARSE_OBJECT *Op,
225 ASL_METHOD_INFO *MethodInfo)
228 UINT32 RequiredArgsCurrent;
229 UINT32 RequiredArgsOld;
232 /* Check for a match against the predefined name list */
234 Index = ApCheckForPredefinedName (Op, Op->Asl.NameSeg);
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 */
242 /* Just return, nothing to do */
246 case ACPI_EVENT_RESERVED_NAME: /* _Lxx, _Exx, and _Qxx methods */
248 Gbl_ReservedMethods++;
250 /* NumArguments must be zero for all _Lxx, _Exx, and _Qxx methods */
252 if (MethodInfo->NumArguments != 0)
254 sprintf (MsgBuffer, "%s requires %d", Op->Asl.ExternalName, 0);
256 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
264 * Matched a predefined method name
266 * Validate the ASL-defined argument count. Allow two different legal
269 Gbl_ReservedMethods++;
271 RequiredArgsCurrent = PredefinedNames[Index].Info.ParamCount & 0x0F;
272 RequiredArgsOld = PredefinedNames[Index].Info.ParamCount >> 4;
274 if ((MethodInfo->NumArguments != RequiredArgsCurrent) &&
275 (MethodInfo->NumArguments != RequiredArgsOld))
277 sprintf (MsgBuffer, "%4.4s requires %d",
278 PredefinedNames[Index].Info.Name, RequiredArgsCurrent);
280 if (MethodInfo->NumArguments > RequiredArgsCurrent)
282 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
287 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_LO, Op,
293 * Check if method returns no value, but the predefined name is
294 * required to return a value
296 if (MethodInfo->NumReturnNoValue &&
297 PredefinedNames[Index].Info.ExpectedBtypes)
299 ApGetExpectedTypes (StringBuffer,
300 PredefinedNames[Index].Info.ExpectedBtypes);
302 sprintf (MsgBuffer, "%s required for %4.4s",
303 StringBuffer, PredefinedNames[Index].Info.Name);
305 AslError (ASL_WARNING, ASL_MSG_RESERVED_RETURN_VALUE, Op,
313 /*******************************************************************************
315 * FUNCTION: ApCheckPredefinedReturnValue
317 * PARAMETERS: Op - A parse node of type "RETURN".
318 * MethodInfo - Saved info about this method
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.
328 ******************************************************************************/
331 ApCheckPredefinedReturnValue (
332 ACPI_PARSE_OBJECT *Op,
333 ASL_METHOD_INFO *MethodInfo)
336 ACPI_PARSE_OBJECT *ReturnValueOp;
339 /* Check parent method for a match against the predefined name list */
341 Index = ApCheckForPredefinedName (MethodInfo->Op,
342 MethodInfo->Op->Asl.NameSeg);
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, and _Qxx methods */
351 /* Just return, nothing to do */
354 default: /* a real predefined ACPI name */
356 /* Exit if no return value expected */
358 if (!PredefinedNames[Index].Info.ExpectedBtypes)
363 /* Get the object returned, it is the next argument */
365 ReturnValueOp = Op->Asl.Child;
366 switch (ReturnValueOp->Asl.ParseOpcode)
371 case PARSEOP_INTEGER:
372 case PARSEOP_STRING_LITERAL:
374 case PARSEOP_PACKAGE:
376 /* Static data return object - check against expected type */
378 ApCheckObjectType (ReturnValueOp,
379 PredefinedNames[Index].Info.ExpectedBtypes);
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.)
397 /*******************************************************************************
399 * FUNCTION: ApCheckForPredefinedObject
401 * PARAMETERS: Op - A parse node
402 * Name - The ACPI name to be checked
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
413 ******************************************************************************/
416 ApCheckForPredefinedObject (
417 ACPI_PARSE_OBJECT *Op,
424 * Check for a real predefined name -- not a resource descriptor name
425 * or a predefined scope name
427 Index = ApCheckForPredefinedName (Op, Name);
428 if (Index > ACPI_VALID_RESERVED_NAME_MAX)
434 * We found a matching predefind name.
435 * Check if this predefined name requires input arguments
437 if (PredefinedNames[Index].Info.ParamCount > 0)
440 * This predefined name must always be defined as a control
441 * method because it is required to have input arguments.
443 AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
447 /* Typecheck the actual object, it is the next argument */
449 ApCheckObjectType (Op->Asl.Child->Asl.Next,
450 PredefinedNames[Index].Info.ExpectedBtypes);
454 /*******************************************************************************
456 * FUNCTION: ApCheckForPredefinedName
458 * PARAMETERS: Op - A parse node
459 * Name - NameSeg to check
463 * DESCRIPTION: Check a NameSeg against the reserved list.
465 ******************************************************************************/
468 ApCheckForPredefinedName (
469 ACPI_PARSE_OBJECT *Op,
477 AcpiOsPrintf ("Found a null name, external = %s\n",
478 Op->Asl.ExternalName);
481 /* All reserved names are prefixed with a single underscore */
485 return (ACPI_NOT_RESERVED_NAME);
488 /* Check for a standard predefined method name */
490 for (i = 0; PredefinedNames[i].Info.Name[0]; i++)
492 if (ACPI_COMPARE_NAME (Name, PredefinedNames[i].Info.Name))
494 /* Return index into predefined array */
499 /* Check for resource names and predefined scope names */
501 for (i = 0; ResourceNames[i].Info.Name[0]; i++)
503 if (ACPI_COMPARE_NAME (Name, ResourceNames[i].Info.Name))
505 return (ACPI_PREDEFINED_NAME);
509 for (i = 0; ScopeNames[i].Info.Name[0]; i++)
511 if (ACPI_COMPARE_NAME (Name, ScopeNames[i].Info.Name))
513 return (ACPI_PREDEFINED_NAME);
517 /* Check for _Lxx, _Exx, _Qxx, _T_x. Warning if unknown predefined name */
519 return (ApCheckForSpecialName (Op, Name));
523 /*******************************************************************************
525 * FUNCTION: ApCheckForSpecialName
527 * PARAMETERS: Op - A parse node
528 * Name - NameSeg to check
532 * DESCRIPTION: Check for the "special" predefined names -
533 * _Lxx, _Exx, _Qxx, and _T_x
535 ******************************************************************************/
538 ApCheckForSpecialName (
539 ACPI_PARSE_OBJECT *Op,
544 * Check for the "special" predefined names. We know the first char is an
545 * underscore already.
550 if ((Name[1] == 'L') ||
554 /* The next two characters must be hex digits */
556 if ((isxdigit ((int) Name[2])) &&
557 (isxdigit ((int) Name[3])))
559 return (ACPI_EVENT_RESERVED_NAME);
563 /* Check for the names reserved for the compiler itself: _T_x */
565 else if ((Op->Asl.ExternalName[1] == 'T') &&
566 (Op->Asl.ExternalName[2] == '_'))
568 /* Ignore if actually emitted by the compiler */
570 if (Op->Asl.CompileFlags & NODE_COMPILER_EMITTED)
572 return (ACPI_NOT_RESERVED_NAME);
576 * Was not actually emitted by the compiler. This is a special case,
577 * however. If the ASL code being compiled was the result of a
578 * dissasembly, it may possibly contain valid compiler-emitted names
579 * of the form "_T_x". We don't want to issue an error or even a
580 * warning and force the user to manually change the names. So, we
581 * will issue a remark instead.
583 AslError (ASL_REMARK, ASL_MSG_COMPILER_RESERVED, Op, Op->Asl.ExternalName);
584 return (ACPI_COMPILER_RESERVED_NAME);
588 * The name didn't match any of the known predefined names. Flag it as a
589 * warning, since the entire namespace starting with an underscore is
590 * reserved by the ACPI spec.
592 AslError (ASL_WARNING, ASL_MSG_UNKNOWN_RESERVED_NAME, Op,
593 Op->Asl.ExternalName);
595 return (ACPI_NOT_RESERVED_NAME);
599 /*******************************************************************************
601 * FUNCTION: ApCheckObjectType
603 * PARAMETERS: Op - Current parse node
604 * ExpectedBtypes - Bitmap of expected return type(s)
608 * DESCRIPTION: Check if the object type is one of the types that is expected
609 * by the predefined name. Only a limited number of object types
610 * can be returned by the predefined names.
612 ******************************************************************************/
616 ACPI_PARSE_OBJECT *Op,
617 UINT32 ExpectedBtypes)
622 switch (Op->Asl.ParseOpcode)
627 case PARSEOP_INTEGER:
628 ReturnBtype = ACPI_RTYPE_INTEGER;
632 ReturnBtype = ACPI_RTYPE_BUFFER;
635 case PARSEOP_STRING_LITERAL:
636 ReturnBtype = ACPI_RTYPE_STRING;
639 case PARSEOP_PACKAGE:
640 ReturnBtype = ACPI_RTYPE_PACKAGE;
644 /* Not one of the supported object types */
649 /* Exit if the object is one of the expected types */
651 if (ReturnBtype & ExpectedBtypes)
659 /* Format the expected types and emit an error message */
661 ApGetExpectedTypes (StringBuffer, ExpectedBtypes);
663 sprintf (MsgBuffer, "found %s, requires %s",
664 UtGetOpName (Op->Asl.ParseOpcode), StringBuffer);
666 AslError (ASL_ERROR, ASL_MSG_RESERVED_OPERAND_TYPE, Op,
671 /*******************************************************************************
673 * FUNCTION: ApDisplayReservedNames
679 * DESCRIPTION: Dump information about the ACPI predefined names and predefined
680 * resource descriptor names.
682 ******************************************************************************/
685 ApDisplayReservedNames (
688 const ACPI_PREDEFINED_INFO *ThisName;
689 char TypeBuffer[48]; /* Room for 5 types */
694 * Predefined names/methods
696 printf ("\nPredefined Name Information\n\n");
699 ThisName = PredefinedNames;
700 while (ThisName->Info.Name[0])
702 printf ("%4.4s Requires %d arguments, ",
703 ThisName->Info.Name, ThisName->Info.ParamCount & 0x0F);
705 if (ThisName->Info.ExpectedBtypes)
707 ApGetExpectedTypes (TypeBuffer, ThisName->Info.ExpectedBtypes);
708 printf ("Must return: %s\n", TypeBuffer);
712 printf ("No return value\n");
716 * Skip next entry in the table if this name returns a Package
717 * (next entry contains the package info)
719 if (ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE)
728 printf ("%u Predefined Names are recognized\n", Count);
731 * Resource Descriptor names
733 printf ("\nResource Descriptor Predefined Names\n\n");
736 ThisName = ResourceNames;
737 while (ThisName->Info.Name[0])
739 printf ("%4.4s Resource Descriptor\n", ThisName->Info.Name);
744 printf ("%u Resource Descriptor Names are recognized\n", Count);
747 * Predefined scope names
749 printf ("\nPredefined Scope Names\n\n");
751 ThisName = ScopeNames;
752 while (ThisName->Info.Name[0])
754 printf ("%4.4s Scope\n", ThisName->Info.Name);
760 /*******************************************************************************
762 * FUNCTION: ApGetExpectedTypes
764 * PARAMETERS: Buffer - Where the formatted string is returned
765 * ExpectedBTypes - Bitfield of expected data types
767 * RETURN: None, formatted string
769 * DESCRIPTION: Format the expected object types into a printable string.
771 ******************************************************************************/
776 UINT32 ExpectedBtypes)
785 ThisRtype = ACPI_RTYPE_INTEGER;
787 for (i = 0; i < ACPI_NUM_RTYPES; i++)
789 /* If one of the expected types, concatenate the name of this type */
791 if (ExpectedBtypes & ThisRtype)
793 ACPI_STRCAT (Buffer, &AcpiRtypeNames[i][j]);
794 j = 0; /* Use name separator from now on */
796 ThisRtype <<= 1; /* Next Rtype */