1 /******************************************************************************
3 * Module Name: aslpredef - support for ACPI predefined names
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #define ACPI_CREATE_PREDEFINED_TABLE
45 #define ACPI_CREATE_RESOURCE_TABLE
47 #include <contrib/dev/acpica/compiler/aslcompiler.h>
48 #include "aslcompiler.y.h"
49 #include <contrib/dev/acpica/include/acpredef.h>
50 #include <contrib/dev/acpica/include/acnamesp.h>
53 #define _COMPONENT ACPI_COMPILER
54 ACPI_MODULE_NAME ("aslpredef")
57 /* Local prototypes */
60 ApCheckForUnexpectedReturnValue (
61 ACPI_PARSE_OBJECT *Op,
62 ASL_METHOD_INFO *MethodInfo);
65 ApCheckForSpecialName (
66 ACPI_PARSE_OBJECT *Op,
70 /*******************************************************************************
72 * FUNCTION: ApCheckForPredefinedMethod
74 * PARAMETERS: Op - A parse node of type "METHOD".
75 * MethodInfo - Saved info about this method
79 * DESCRIPTION: If method is a predefined name, check that the number of
80 * arguments and the return type (returns a value or not)
83 ******************************************************************************/
86 ApCheckForPredefinedMethod (
87 ACPI_PARSE_OBJECT *Op,
88 ASL_METHOD_INFO *MethodInfo)
91 UINT32 RequiredArgCount;
92 const ACPI_PREDEFINED_INFO *ThisName;
95 /* Check for a match against the predefined name list */
97 Index = ApCheckForPredefinedName (Op, Op->Asl.NameSeg);
101 case ACPI_NOT_RESERVED_NAME: /* No underscore or _Txx or _xxx name not matched */
102 case ACPI_PREDEFINED_NAME: /* Resource Name or reserved scope name */
103 case ACPI_COMPILER_RESERVED_NAME: /* A _Txx that was not emitted by compiler */
105 /* Just return, nothing to do */
109 case ACPI_EVENT_RESERVED_NAME: /* _Lxx/_Exx/_Wxx/_Qxx methods */
111 Gbl_ReservedMethods++;
113 /* NumArguments must be zero for all _Lxx/_Exx/_Wxx/_Qxx methods */
115 if (MethodInfo->NumArguments != 0)
117 sprintf (MsgBuffer, "%s requires %u", Op->Asl.ExternalName, 0);
119 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
127 * Matched a predefined method name - validate the ASL-defined
128 * argument count against the ACPI specification.
130 * Some methods are allowed to have a "minimum" number of args
131 * (_SCP) because their definition in ACPI has changed over time.
133 Gbl_ReservedMethods++;
134 ThisName = &AcpiGbl_PredefinedMethods[Index];
135 RequiredArgCount = METHOD_GET_ARG_COUNT (ThisName->Info.ArgumentList);
137 if (MethodInfo->NumArguments != RequiredArgCount)
139 sprintf (MsgBuffer, "%4.4s requires %u",
140 ThisName->Info.Name, RequiredArgCount);
142 if (MethodInfo->NumArguments < RequiredArgCount)
144 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_LO, Op,
147 else if ((MethodInfo->NumArguments > RequiredArgCount) &&
148 !(ThisName->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
150 AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
156 * Check if method returns no value, but the predefined name is
157 * required to return a value
159 if (MethodInfo->NumReturnNoValue &&
160 ThisName->Info.ExpectedBtypes)
162 AcpiUtGetExpectedReturnTypes (StringBuffer,
163 ThisName->Info.ExpectedBtypes);
165 sprintf (MsgBuffer, "%s required for %4.4s",
166 StringBuffer, ThisName->Info.Name);
168 AslError (ASL_WARNING, ASL_MSG_RESERVED_RETURN_VALUE, Op,
178 /*******************************************************************************
180 * FUNCTION: ApCheckForUnexpectedReturnValue
182 * PARAMETERS: Op - A parse node of type "RETURN".
183 * MethodInfo - Saved info about this method
187 * DESCRIPTION: Check for an unexpected return value from a predefined method.
188 * Invoked for predefined methods that are defined to not return
189 * any value. If there is a return value, issue a remark, since
190 * the ASL writer may be confused as to the method definition
191 * and/or functionality.
193 * Note: We ignore all return values of "Zero", since this is what a standalone
194 * Return() statement will always generate -- so we ignore it here --
195 * i.e., there is no difference between Return() and Return(Zero).
196 * Also, a null Return() will be disassembled to return(Zero) -- so, we
197 * don't want to generate extraneous remarks/warnings for a disassembled
200 ******************************************************************************/
203 ApCheckForUnexpectedReturnValue (
204 ACPI_PARSE_OBJECT *Op,
205 ASL_METHOD_INFO *MethodInfo)
207 ACPI_PARSE_OBJECT *ReturnValueOp;
210 /* Ignore Return() and Return(Zero) (they are the same) */
212 ReturnValueOp = Op->Asl.Child;
213 if (ReturnValueOp->Asl.ParseOpcode == PARSEOP_ZERO)
218 /* We have a valid return value, but the reserved name did not expect it */
220 AslError (ASL_WARNING, ASL_MSG_RESERVED_NO_RETURN_VAL,
221 Op, MethodInfo->Op->Asl.ExternalName);
225 /*******************************************************************************
227 * FUNCTION: ApCheckPredefinedReturnValue
229 * PARAMETERS: Op - A parse node of type "RETURN".
230 * MethodInfo - Saved info about this method
234 * DESCRIPTION: If method is a predefined name, attempt to validate the return
235 * value. Only "static" types can be validated - a simple return
236 * of an integer/string/buffer/package or a named reference to
237 * a static object. Values such as a Localx or Argx or a control
238 * method invocation are not checked. Issue a warning if there is
239 * a valid return value, but the reserved method defines no
242 ******************************************************************************/
245 ApCheckPredefinedReturnValue (
246 ACPI_PARSE_OBJECT *Op,
247 ASL_METHOD_INFO *MethodInfo)
250 ACPI_PARSE_OBJECT *ReturnValueOp;
251 const ACPI_PREDEFINED_INFO *ThisName;
255 * Check parent method for a match against the predefined name list.
257 * Note: Disable compiler errors/warnings because any errors will be
258 * caught when analyzing the parent method. Eliminates duplicate errors.
260 Gbl_AllExceptionsDisabled = TRUE;
261 Index = ApCheckForPredefinedName (MethodInfo->Op,
262 MethodInfo->Op->Asl.NameSeg);
263 Gbl_AllExceptionsDisabled = FALSE;
267 case ACPI_EVENT_RESERVED_NAME: /* _Lxx/_Exx/_Wxx/_Qxx methods */
269 /* No return value expected, warn if there is one */
271 ApCheckForUnexpectedReturnValue (Op, MethodInfo);
274 case ACPI_NOT_RESERVED_NAME: /* No underscore or _Txx or _xxx name not matched */
275 case ACPI_PREDEFINED_NAME: /* Resource Name or reserved scope name */
276 case ACPI_COMPILER_RESERVED_NAME: /* A _Txx that was not emitted by compiler */
278 /* Just return, nothing to do */
281 default: /* A standard predefined ACPI name */
283 ThisName = &AcpiGbl_PredefinedMethods[Index];
284 if (!ThisName->Info.ExpectedBtypes)
286 /* No return value expected, warn if there is one */
288 ApCheckForUnexpectedReturnValue (Op, MethodInfo);
292 /* Get the object returned, it is the next argument */
294 ReturnValueOp = Op->Asl.Child;
295 switch (ReturnValueOp->Asl.ParseOpcode)
300 case PARSEOP_INTEGER:
301 case PARSEOP_STRING_LITERAL:
303 case PARSEOP_PACKAGE:
305 /* Static data return object - check against expected type */
307 ApCheckObjectType (ThisName->Info.Name, ReturnValueOp,
308 ThisName->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
310 /* For packages, check the individual package elements */
312 if (ReturnValueOp->Asl.ParseOpcode == PARSEOP_PACKAGE)
314 ApCheckPackage (ReturnValueOp, ThisName);
320 * All other ops are very difficult or impossible to typecheck at
321 * compile time. These include all Localx, Argx, and method
322 * invocations. Also, NAMESEG and NAMESTRING because the type of
323 * any named object can be changed at runtime (for example,
324 * CopyObject will change the type of the target object.)
332 /*******************************************************************************
334 * FUNCTION: ApCheckForPredefinedObject
336 * PARAMETERS: Op - A parse node
337 * Name - The ACPI name to be checked
341 * DESCRIPTION: Check for a predefined name for a static object (created via
342 * the ASL Name operator). If it is a predefined ACPI name, ensure
343 * that the name does not require any arguments (which would
344 * require a control method implemenation of the name), and that
345 * the type of the object is one of the expected types for the
348 ******************************************************************************/
351 ApCheckForPredefinedObject (
352 ACPI_PARSE_OBJECT *Op,
356 ACPI_PARSE_OBJECT *ObjectOp;
357 const ACPI_PREDEFINED_INFO *ThisName;
361 * Check for a real predefined name -- not a resource descriptor name
362 * or a predefined scope name
364 Index = ApCheckForPredefinedName (Op, Name);
368 case ACPI_NOT_RESERVED_NAME: /* No underscore or _Txx or _xxx name not matched */
369 case ACPI_PREDEFINED_NAME: /* Resource Name or reserved scope name */
370 case ACPI_COMPILER_RESERVED_NAME: /* A _Txx that was not emitted by compiler */
375 case ACPI_EVENT_RESERVED_NAME: /* _Lxx/_Exx/_Wxx/_Qxx methods */
378 * These names must be control methods, by definition in ACPI spec.
379 * Also because they are defined to return no value. None of them
380 * require any arguments.
382 AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
383 "with zero arguments");
391 /* A standard predefined ACPI name */
394 * If this predefined name requires input arguments, then
395 * it must be implemented as a control method
397 ThisName = &AcpiGbl_PredefinedMethods[Index];
398 if (METHOD_GET_ARG_COUNT (ThisName->Info.ArgumentList) > 0)
400 AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
406 * If no return value is expected from this predefined name, then
407 * it follows that it must be implemented as a control method
408 * (with zero args, because the args > 0 case was handled above)
409 * Examples are: _DIS, _INI, _IRC, _OFF, _ON, _PSx
411 if (!ThisName->Info.ExpectedBtypes)
413 AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
414 "with zero arguments");
418 /* Typecheck the actual object, it is the next argument */
420 ObjectOp = Op->Asl.Child->Asl.Next;
421 ApCheckObjectType (ThisName->Info.Name, Op->Asl.Child->Asl.Next,
422 ThisName->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
424 /* For packages, check the individual package elements */
426 if (ObjectOp->Asl.ParseOpcode == PARSEOP_PACKAGE)
428 ApCheckPackage (ObjectOp, ThisName);
433 /*******************************************************************************
435 * FUNCTION: ApCheckForPredefinedName
437 * PARAMETERS: Op - A parse node
438 * Name - NameSeg to check
442 * DESCRIPTION: Check a NameSeg against the reserved list.
444 ******************************************************************************/
447 ApCheckForPredefinedName (
448 ACPI_PARSE_OBJECT *Op,
452 const ACPI_PREDEFINED_INFO *ThisName;
457 AcpiOsPrintf ("Found a null name, external = %s\n",
458 Op->Asl.ExternalName);
461 /* All reserved names are prefixed with a single underscore */
465 return (ACPI_NOT_RESERVED_NAME);
468 /* Check for a standard predefined method name */
470 ThisName = AcpiGbl_PredefinedMethods;
471 for (i = 0; ThisName->Info.Name[0]; i++)
473 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
475 /* Return index into predefined array */
479 ThisName++; /* Does not account for extra package data, but is OK */
482 /* Check for resource names and predefined scope names */
484 ThisName = AcpiGbl_ResourceNames;
485 while (ThisName->Info.Name[0])
487 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
489 return (ACPI_PREDEFINED_NAME);
495 ThisName = AcpiGbl_ScopeNames;
496 while (ThisName->Info.Name[0])
498 if (ACPI_COMPARE_NAME (Name, ThisName->Info.Name))
500 return (ACPI_PREDEFINED_NAME);
506 /* Check for _Lxx/_Exx/_Wxx/_Qxx/_T_x. Warning if unknown predefined name */
508 return (ApCheckForSpecialName (Op, Name));
512 /*******************************************************************************
514 * FUNCTION: ApCheckForSpecialName
516 * PARAMETERS: Op - A parse node
517 * Name - NameSeg to check
521 * DESCRIPTION: Check for the "special" predefined names -
522 * _Lxx, _Exx, _Qxx, _Wxx, and _T_x
524 ******************************************************************************/
527 ApCheckForSpecialName (
528 ACPI_PARSE_OBJECT *Op,
533 * Check for the "special" predefined names. We already know that the
534 * first character is an underscore.
540 if ((Name[1] == 'L') ||
545 /* The next two characters must be hex digits */
547 if ((isxdigit ((int) Name[2])) &&
548 (isxdigit ((int) Name[3])))
550 return (ACPI_EVENT_RESERVED_NAME);
554 /* Check for the names reserved for the compiler itself: _T_x */
556 else if ((Op->Asl.ExternalName[1] == 'T') &&
557 (Op->Asl.ExternalName[2] == '_'))
559 /* Ignore if actually emitted by the compiler */
561 if (Op->Asl.CompileFlags & NODE_COMPILER_EMITTED)
563 return (ACPI_NOT_RESERVED_NAME);
567 * Was not actually emitted by the compiler. This is a special case,
568 * however. If the ASL code being compiled was the result of a
569 * dissasembly, it may possibly contain valid compiler-emitted names
570 * of the form "_T_x". We don't want to issue an error or even a
571 * warning and force the user to manually change the names. So, we
572 * will issue a remark instead.
574 AslError (ASL_REMARK, ASL_MSG_COMPILER_RESERVED, Op, Op->Asl.ExternalName);
575 return (ACPI_COMPILER_RESERVED_NAME);
579 * The name didn't match any of the known predefined names. Flag it as a
580 * warning, since the entire namespace starting with an underscore is
581 * reserved by the ACPI spec.
583 AslError (ASL_WARNING, ASL_MSG_UNKNOWN_RESERVED_NAME, Op,
584 Op->Asl.ExternalName);
586 return (ACPI_NOT_RESERVED_NAME);
590 /*******************************************************************************
592 * FUNCTION: ApCheckObjectType
594 * PARAMETERS: PredefinedName - Name of the predefined object we are checking
595 * Op - Current parse node
596 * ExpectedBtypes - Bitmap of expected return type(s)
597 * PackageIndex - Index of object within parent package (if
598 * applicable - ACPI_NOT_PACKAGE_ELEMENT
603 * DESCRIPTION: Check if the object type is one of the types that is expected
604 * by the predefined name. Only a limited number of object types
605 * can be returned by the predefined names.
607 ******************************************************************************/
611 const char *PredefinedName,
612 ACPI_PARSE_OBJECT *Op,
613 UINT32 ExpectedBtypes,
625 /* Map the parse opcode to a bitmapped return type (RTYPE) */
627 switch (Op->Asl.ParseOpcode)
632 case PARSEOP_INTEGER:
634 ReturnBtype = ACPI_RTYPE_INTEGER;
635 TypeName = "Integer";
638 case PARSEOP_STRING_LITERAL:
640 ReturnBtype = ACPI_RTYPE_STRING;
646 ReturnBtype = ACPI_RTYPE_BUFFER;
650 case PARSEOP_PACKAGE:
651 case PARSEOP_VAR_PACKAGE:
653 ReturnBtype = ACPI_RTYPE_PACKAGE;
654 TypeName = "Package";
657 case PARSEOP_NAMESEG:
658 case PARSEOP_NAMESTRING:
660 * Ignore any named references within a package object.
662 * For Package objects, references are allowed instead of any of the
663 * standard data types (Integer/String/Buffer/Package). These
664 * references are resolved at runtime. NAMESEG and NAMESTRING are
665 * impossible to typecheck at compile time because the type of
666 * any named object can be changed at runtime (for example,
667 * CopyObject will change the type of the target object).
669 if (PackageIndex != ACPI_NOT_PACKAGE_ELEMENT)
674 ReturnBtype = ACPI_RTYPE_REFERENCE;
675 TypeName = "Reference";
680 /* Not one of the supported object types */
682 TypeName = UtGetOpName (Op->Asl.ParseOpcode);
686 /* Exit if the object is one of the expected types */
688 if (ReturnBtype & ExpectedBtypes)
696 /* Format the expected types and emit an error message */
698 AcpiUtGetExpectedReturnTypes (StringBuffer, ExpectedBtypes);
700 if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT)
702 sprintf (MsgBuffer, "%4.4s: found %s, %s required",
703 PredefinedName, TypeName, StringBuffer);
707 sprintf (MsgBuffer, "%4.4s: found %s at index %u, %s required",
708 PredefinedName, TypeName, PackageIndex, StringBuffer);
711 AslError (ASL_ERROR, ASL_MSG_RESERVED_OPERAND_TYPE, Op, MsgBuffer);
716 /*******************************************************************************
718 * FUNCTION: ApDisplayReservedNames
724 * DESCRIPTION: Dump information about the ACPI predefined names and predefined
725 * resource descriptor names.
727 ******************************************************************************/
730 ApDisplayReservedNames (
733 const ACPI_PREDEFINED_INFO *ThisName;
739 * Predefined names/methods
741 printf ("\nPredefined Name Information\n\n");
744 ThisName = AcpiGbl_PredefinedMethods;
745 while (ThisName->Info.Name[0])
747 AcpiUtDisplayPredefinedMethod (MsgBuffer, ThisName, FALSE);
749 ThisName = AcpiUtGetNextPredefinedMethod (ThisName);
752 printf ("%u Predefined Names are recognized\n", Count);
755 * Resource Descriptor names
757 printf ("\nPredefined Names for Resource Descriptor Fields\n\n");
760 ThisName = AcpiGbl_ResourceNames;
761 while (ThisName->Info.Name[0])
763 NumTypes = AcpiUtGetResourceBitWidth (MsgBuffer,
764 ThisName->Info.ArgumentList);
766 printf ("%4.4s Field is %s bits wide%s\n",
767 ThisName->Info.Name, MsgBuffer,
768 (NumTypes > 1) ? " (depending on descriptor type)" : "");
774 printf ("%u Resource Descriptor Field Names are recognized\n", Count);
777 * Predefined scope names
779 printf ("\nPredefined Scope/Device Names (automatically created at root)\n\n");
781 ThisName = AcpiGbl_ScopeNames;
782 while (ThisName->Info.Name[0])
784 printf ("%4.4s Scope/Device\n", ThisName->Info.Name);