10d02842fSSascha Wildner /******************************************************************************
20d02842fSSascha Wildner *
30d02842fSSascha Wildner * Module Name: aslpredef - support for ACPI predefined names
40d02842fSSascha Wildner *
50d02842fSSascha Wildner *****************************************************************************/
60d02842fSSascha Wildner
7b4315fc7SSascha Wildner /******************************************************************************
8b4315fc7SSascha Wildner *
9b4315fc7SSascha Wildner * 1. Copyright Notice
10b4315fc7SSascha Wildner *
11*383048acSSascha Wildner * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
120d02842fSSascha Wildner * All rights reserved.
130d02842fSSascha Wildner *
14b4315fc7SSascha Wildner * 2. License
15b4315fc7SSascha Wildner *
16b4315fc7SSascha Wildner * 2.1. This is your license from Intel Corp. under its intellectual property
17b4315fc7SSascha Wildner * rights. You may have additional license terms from the party that provided
18b4315fc7SSascha Wildner * you this software, covering your right to use that party's intellectual
19b4315fc7SSascha Wildner * property rights.
20b4315fc7SSascha Wildner *
21b4315fc7SSascha Wildner * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22b4315fc7SSascha Wildner * copy of the source code appearing in this file ("Covered Code") an
23b4315fc7SSascha Wildner * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24b4315fc7SSascha Wildner * base code distributed originally by Intel ("Original Intel Code") to copy,
25b4315fc7SSascha Wildner * make derivatives, distribute, use and display any portion of the Covered
26b4315fc7SSascha Wildner * Code in any form, with the right to sublicense such rights; and
27b4315fc7SSascha Wildner *
28b4315fc7SSascha Wildner * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29b4315fc7SSascha Wildner * license (with the right to sublicense), under only those claims of Intel
30b4315fc7SSascha Wildner * patents that are infringed by the Original Intel Code, to make, use, sell,
31b4315fc7SSascha Wildner * offer to sell, and import the Covered Code and derivative works thereof
32b4315fc7SSascha Wildner * solely to the minimum extent necessary to exercise the above copyright
33b4315fc7SSascha Wildner * license, and in no event shall the patent license extend to any additions
34b4315fc7SSascha Wildner * to or modifications of the Original Intel Code. No other license or right
35b4315fc7SSascha Wildner * is granted directly or by implication, estoppel or otherwise;
36b4315fc7SSascha Wildner *
37b4315fc7SSascha Wildner * The above copyright and patent license is granted only if the following
38b4315fc7SSascha Wildner * conditions are met:
39b4315fc7SSascha Wildner *
40b4315fc7SSascha Wildner * 3. Conditions
41b4315fc7SSascha Wildner *
42b4315fc7SSascha Wildner * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
44b4315fc7SSascha Wildner * Code or modification with rights to further distribute source must include
45b4315fc7SSascha Wildner * the above Copyright Notice, the above License, this list of Conditions,
46b4315fc7SSascha Wildner * and the following Disclaimer and Export Compliance provision. In addition,
47b4315fc7SSascha Wildner * Licensee must cause all Covered Code to which Licensee contributes to
48b4315fc7SSascha Wildner * contain a file documenting the changes Licensee made to create that Covered
49b4315fc7SSascha Wildner * Code and the date of any change. Licensee must include in that file the
50b4315fc7SSascha Wildner * documentation of any changes made by any predecessor Licensee. Licensee
51b4315fc7SSascha Wildner * must include a prominent statement that the modification is derived,
52b4315fc7SSascha Wildner * directly or indirectly, from Original Intel Code.
53b4315fc7SSascha Wildner *
54b4315fc7SSascha Wildner * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55b4315fc7SSascha Wildner * Redistribution of source code of any substantial portion of the Covered
56b4315fc7SSascha Wildner * Code or modification without rights to further distribute source must
57b4315fc7SSascha Wildner * include the following Disclaimer and Export Compliance provision in the
58b4315fc7SSascha Wildner * documentation and/or other materials provided with distribution. In
59b4315fc7SSascha Wildner * addition, Licensee may not authorize further sublicense of source of any
60b4315fc7SSascha Wildner * portion of the Covered Code, and must include terms to the effect that the
61b4315fc7SSascha Wildner * license from Licensee to its licensee is limited to the intellectual
62b4315fc7SSascha Wildner * property embodied in the software Licensee provides to its licensee, and
63b4315fc7SSascha Wildner * not to intellectual property embodied in modifications its licensee may
64b4315fc7SSascha Wildner * make.
65b4315fc7SSascha Wildner *
66b4315fc7SSascha Wildner * 3.3. Redistribution of Executable. Redistribution in executable form of any
67b4315fc7SSascha Wildner * substantial portion of the Covered Code or modification must reproduce the
68b4315fc7SSascha Wildner * above Copyright Notice, and the following Disclaimer and Export Compliance
69b4315fc7SSascha Wildner * provision in the documentation and/or other materials provided with the
70b4315fc7SSascha Wildner * distribution.
71b4315fc7SSascha Wildner *
72b4315fc7SSascha Wildner * 3.4. Intel retains all right, title, and interest in and to the Original
73b4315fc7SSascha Wildner * Intel Code.
74b4315fc7SSascha Wildner *
75b4315fc7SSascha Wildner * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76b4315fc7SSascha Wildner * Intel shall be used in advertising or otherwise to promote the sale, use or
77b4315fc7SSascha Wildner * other dealings in products derived from or relating to the Covered Code
78b4315fc7SSascha Wildner * without prior written authorization from Intel.
79b4315fc7SSascha Wildner *
80b4315fc7SSascha Wildner * 4. Disclaimer and Export Compliance
81b4315fc7SSascha Wildner *
82b4315fc7SSascha Wildner * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83b4315fc7SSascha Wildner * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84b4315fc7SSascha Wildner * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85b4315fc7SSascha Wildner * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86b4315fc7SSascha Wildner * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87b4315fc7SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88b4315fc7SSascha Wildner * PARTICULAR PURPOSE.
89b4315fc7SSascha Wildner *
90b4315fc7SSascha Wildner * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91b4315fc7SSascha Wildner * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92b4315fc7SSascha Wildner * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93b4315fc7SSascha Wildner * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94b4315fc7SSascha Wildner * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95b4315fc7SSascha Wildner * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96b4315fc7SSascha Wildner * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97b4315fc7SSascha Wildner * LIMITED REMEDY.
98b4315fc7SSascha Wildner *
99b4315fc7SSascha Wildner * 4.3. Licensee shall not export, either directly or indirectly, any of this
100b4315fc7SSascha Wildner * software or system incorporating such software without first obtaining any
101b4315fc7SSascha Wildner * required license or other approval from the U. S. Department of Commerce or
102b4315fc7SSascha Wildner * any other agency or department of the United States Government. In the
103b4315fc7SSascha Wildner * event Licensee exports any such software from the United States or
104b4315fc7SSascha Wildner * re-exports any such software from a foreign destination, Licensee shall
105b4315fc7SSascha Wildner * ensure that the distribution and export/re-export of the software is in
106b4315fc7SSascha Wildner * compliance with all laws, regulations, orders, or other restrictions of the
107b4315fc7SSascha Wildner * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108b4315fc7SSascha Wildner * any of its subsidiaries will export/re-export any technical data, process,
109b4315fc7SSascha Wildner * software, or service, directly or indirectly, to any country for which the
110b4315fc7SSascha Wildner * United States government or any agency thereof requires an export license,
111b4315fc7SSascha Wildner * other governmental approval, or letter of assurance, without first obtaining
112b4315fc7SSascha Wildner * such license, approval or letter.
113b4315fc7SSascha Wildner *
114b4315fc7SSascha Wildner *****************************************************************************
115b4315fc7SSascha Wildner *
116b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
117b4315fc7SSascha Wildner * following license:
118b4315fc7SSascha Wildner *
1190d02842fSSascha Wildner * Redistribution and use in source and binary forms, with or without
1200d02842fSSascha Wildner * modification, are permitted provided that the following conditions
1210d02842fSSascha Wildner * are met:
1220d02842fSSascha Wildner * 1. Redistributions of source code must retain the above copyright
1230d02842fSSascha Wildner * notice, this list of conditions, and the following disclaimer,
1240d02842fSSascha Wildner * without modification.
1250d02842fSSascha Wildner * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1260d02842fSSascha Wildner * substantially similar to the "NO WARRANTY" disclaimer below
1270d02842fSSascha Wildner * ("Disclaimer") and any redistribution must be conditioned upon
1280d02842fSSascha Wildner * including a substantially similar Disclaimer requirement for further
1290d02842fSSascha Wildner * binary redistribution.
1300d02842fSSascha Wildner * 3. Neither the names of the above-listed copyright holders nor the names
1310d02842fSSascha Wildner * of any contributors may be used to endorse or promote products derived
1320d02842fSSascha Wildner * from this software without specific prior written permission.
1330d02842fSSascha Wildner *
134b4315fc7SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135b4315fc7SSascha Wildner * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136b4315fc7SSascha Wildner * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137b4315fc7SSascha Wildner * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138b4315fc7SSascha Wildner * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139b4315fc7SSascha Wildner * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140b4315fc7SSascha Wildner * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141b4315fc7SSascha Wildner * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142b4315fc7SSascha Wildner * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143b4315fc7SSascha Wildner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144b4315fc7SSascha Wildner * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145b4315fc7SSascha Wildner *
146b4315fc7SSascha Wildner * Alternatively, you may choose to be licensed under the terms of the
1470d02842fSSascha Wildner * GNU General Public License ("GPL") version 2 as published by the Free
1480d02842fSSascha Wildner * Software Foundation.
1490d02842fSSascha Wildner *
150b4315fc7SSascha Wildner *****************************************************************************/
1510d02842fSSascha Wildner
1520d02842fSSascha Wildner #define ACPI_CREATE_PREDEFINED_TABLE
1530d02842fSSascha Wildner #define ACPI_CREATE_RESOURCE_TABLE
1540d02842fSSascha Wildner
1550d02842fSSascha Wildner #include "aslcompiler.h"
1560d02842fSSascha Wildner #include "aslcompiler.y.h"
1570d02842fSSascha Wildner #include "acpredef.h"
1580d02842fSSascha Wildner #include "acnamesp.h"
1590d02842fSSascha Wildner
1600d02842fSSascha Wildner
1610d02842fSSascha Wildner #define _COMPONENT ACPI_COMPILER
1620d02842fSSascha Wildner ACPI_MODULE_NAME ("aslpredef")
1630d02842fSSascha Wildner
1640d02842fSSascha Wildner
1650d02842fSSascha Wildner /* Local prototypes */
1660d02842fSSascha Wildner
1670d02842fSSascha Wildner static void
1680d02842fSSascha Wildner ApCheckForUnexpectedReturnValue (
1690d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
1700d02842fSSascha Wildner ASL_METHOD_INFO *MethodInfo);
1710d02842fSSascha Wildner
1720d02842fSSascha Wildner static UINT32
1730d02842fSSascha Wildner ApCheckForSpecialName (
1740d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
1750d02842fSSascha Wildner char *Name);
1760d02842fSSascha Wildner
1770d02842fSSascha Wildner
1780d02842fSSascha Wildner /*******************************************************************************
1790d02842fSSascha Wildner *
1800d02842fSSascha Wildner * FUNCTION: ApCheckForPredefinedMethod
1810d02842fSSascha Wildner *
1820d02842fSSascha Wildner * PARAMETERS: Op - A parse node of type "METHOD".
1830d02842fSSascha Wildner * MethodInfo - Saved info about this method
1840d02842fSSascha Wildner *
1850d02842fSSascha Wildner * RETURN: None
1860d02842fSSascha Wildner *
1870d02842fSSascha Wildner * DESCRIPTION: If method is a predefined name, check that the number of
1880d02842fSSascha Wildner * arguments and the return type (returns a value or not)
1890d02842fSSascha Wildner * is correct.
1900d02842fSSascha Wildner *
1910d02842fSSascha Wildner ******************************************************************************/
1920d02842fSSascha Wildner
1930d02842fSSascha Wildner BOOLEAN
ApCheckForPredefinedMethod(ACPI_PARSE_OBJECT * Op,ASL_METHOD_INFO * MethodInfo)1940d02842fSSascha Wildner ApCheckForPredefinedMethod (
1950d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
1960d02842fSSascha Wildner ASL_METHOD_INFO *MethodInfo)
1970d02842fSSascha Wildner {
1980d02842fSSascha Wildner UINT32 Index;
1990d02842fSSascha Wildner UINT32 RequiredArgCount;
2000d02842fSSascha Wildner const ACPI_PREDEFINED_INFO *ThisName;
2010d02842fSSascha Wildner
2020d02842fSSascha Wildner
2030d02842fSSascha Wildner /* Check for a match against the predefined name list */
2040d02842fSSascha Wildner
2050d02842fSSascha Wildner Index = ApCheckForPredefinedName (Op, Op->Asl.NameSeg);
2060d02842fSSascha Wildner
2070d02842fSSascha Wildner switch (Index)
2080d02842fSSascha Wildner {
2090d02842fSSascha Wildner case ACPI_NOT_RESERVED_NAME: /* No underscore or _Txx or _xxx name not matched */
2100d02842fSSascha Wildner case ACPI_PREDEFINED_NAME: /* Resource Name or reserved scope name */
2110d02842fSSascha Wildner case ACPI_COMPILER_RESERVED_NAME: /* A _Txx that was not emitted by compiler */
2120d02842fSSascha Wildner
2130d02842fSSascha Wildner /* Just return, nothing to do */
2140d02842fSSascha Wildner return (FALSE);
2150d02842fSSascha Wildner
2160d02842fSSascha Wildner
2170d02842fSSascha Wildner case ACPI_EVENT_RESERVED_NAME: /* _Lxx/_Exx/_Wxx/_Qxx methods */
2180d02842fSSascha Wildner
219806343b9SSascha Wildner AslGbl_ReservedMethods++;
2200d02842fSSascha Wildner
2210d02842fSSascha Wildner /* NumArguments must be zero for all _Lxx/_Exx/_Wxx/_Qxx methods */
2220d02842fSSascha Wildner
2230d02842fSSascha Wildner if (MethodInfo->NumArguments != 0)
2240d02842fSSascha Wildner {
2256721db86SSascha Wildner sprintf (AslGbl_MsgBuffer, "%s requires %d", Op->Asl.ExternalName, 0);
2260d02842fSSascha Wildner
2270d02842fSSascha Wildner AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
228806343b9SSascha Wildner AslGbl_MsgBuffer);
2290d02842fSSascha Wildner }
2300d02842fSSascha Wildner break;
2310d02842fSSascha Wildner
2320d02842fSSascha Wildner
2330d02842fSSascha Wildner default:
2340d02842fSSascha Wildner /*
2350d02842fSSascha Wildner * Matched a predefined method name - validate the ASL-defined
2360d02842fSSascha Wildner * argument count against the ACPI specification.
2370d02842fSSascha Wildner *
2380d02842fSSascha Wildner * Some methods are allowed to have a "minimum" number of args
2390d02842fSSascha Wildner * (_SCP) because their definition in ACPI has changed over time.
2400d02842fSSascha Wildner */
241806343b9SSascha Wildner AslGbl_ReservedMethods++;
2420d02842fSSascha Wildner ThisName = &AcpiGbl_PredefinedMethods[Index];
2430d02842fSSascha Wildner RequiredArgCount = METHOD_GET_ARG_COUNT (ThisName->Info.ArgumentList);
2440d02842fSSascha Wildner
2450d02842fSSascha Wildner if (MethodInfo->NumArguments != RequiredArgCount)
2460d02842fSSascha Wildner {
247806343b9SSascha Wildner sprintf (AslGbl_MsgBuffer, "%4.4s requires %u",
2480d02842fSSascha Wildner ThisName->Info.Name, RequiredArgCount);
2490d02842fSSascha Wildner
2500d02842fSSascha Wildner if (MethodInfo->NumArguments < RequiredArgCount)
2510d02842fSSascha Wildner {
2520d02842fSSascha Wildner AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_LO, Op,
253806343b9SSascha Wildner AslGbl_MsgBuffer);
2540d02842fSSascha Wildner }
2550d02842fSSascha Wildner else if ((MethodInfo->NumArguments > RequiredArgCount) &&
2560d02842fSSascha Wildner !(ThisName->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
2570d02842fSSascha Wildner {
2580d02842fSSascha Wildner AslError (ASL_WARNING, ASL_MSG_RESERVED_ARG_COUNT_HI, Op,
259806343b9SSascha Wildner AslGbl_MsgBuffer);
2600d02842fSSascha Wildner }
2610d02842fSSascha Wildner }
2620d02842fSSascha Wildner
2630d02842fSSascha Wildner /*
2640d02842fSSascha Wildner * Check if method returns no value, but the predefined name is
2650d02842fSSascha Wildner * required to return a value
2660d02842fSSascha Wildner */
2670d02842fSSascha Wildner if (MethodInfo->NumReturnNoValue &&
2680d02842fSSascha Wildner ThisName->Info.ExpectedBtypes)
2690d02842fSSascha Wildner {
270806343b9SSascha Wildner AcpiUtGetExpectedReturnTypes (AslGbl_StringBuffer,
2710d02842fSSascha Wildner ThisName->Info.ExpectedBtypes);
2720d02842fSSascha Wildner
273806343b9SSascha Wildner sprintf (AslGbl_MsgBuffer, "%s required for %4.4s",
274806343b9SSascha Wildner AslGbl_StringBuffer, ThisName->Info.Name);
2750d02842fSSascha Wildner
2760d02842fSSascha Wildner AslError (ASL_WARNING, ASL_MSG_RESERVED_RETURN_VALUE, Op,
277806343b9SSascha Wildner AslGbl_MsgBuffer);
2780d02842fSSascha Wildner }
2790d02842fSSascha Wildner break;
2800d02842fSSascha Wildner }
2810d02842fSSascha Wildner
2820d02842fSSascha Wildner return (TRUE);
2830d02842fSSascha Wildner }
2840d02842fSSascha Wildner
2850d02842fSSascha Wildner
2860d02842fSSascha Wildner /*******************************************************************************
2870d02842fSSascha Wildner *
2880d02842fSSascha Wildner * FUNCTION: ApCheckForUnexpectedReturnValue
2890d02842fSSascha Wildner *
2900d02842fSSascha Wildner * PARAMETERS: Op - A parse node of type "RETURN".
2910d02842fSSascha Wildner * MethodInfo - Saved info about this method
2920d02842fSSascha Wildner *
2930d02842fSSascha Wildner * RETURN: None
2940d02842fSSascha Wildner *
2950d02842fSSascha Wildner * DESCRIPTION: Check for an unexpected return value from a predefined method.
2960d02842fSSascha Wildner * Invoked for predefined methods that are defined to not return
2970d02842fSSascha Wildner * any value. If there is a return value, issue a remark, since
2980d02842fSSascha Wildner * the ASL writer may be confused as to the method definition
2990d02842fSSascha Wildner * and/or functionality.
3000d02842fSSascha Wildner *
3010d02842fSSascha Wildner * Note: We ignore all return values of "Zero", since this is what a standalone
3020d02842fSSascha Wildner * Return() statement will always generate -- so we ignore it here --
3030d02842fSSascha Wildner * i.e., there is no difference between Return() and Return(Zero).
3040d02842fSSascha Wildner * Also, a null Return() will be disassembled to return(Zero) -- so, we
3050d02842fSSascha Wildner * don't want to generate extraneous remarks/warnings for a disassembled
3060d02842fSSascha Wildner * ASL file.
3070d02842fSSascha Wildner *
3080d02842fSSascha Wildner ******************************************************************************/
3090d02842fSSascha Wildner
3100d02842fSSascha Wildner static void
ApCheckForUnexpectedReturnValue(ACPI_PARSE_OBJECT * Op,ASL_METHOD_INFO * MethodInfo)3110d02842fSSascha Wildner ApCheckForUnexpectedReturnValue (
3120d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
3130d02842fSSascha Wildner ASL_METHOD_INFO *MethodInfo)
3140d02842fSSascha Wildner {
3150d02842fSSascha Wildner ACPI_PARSE_OBJECT *ReturnValueOp;
3160d02842fSSascha Wildner
3170d02842fSSascha Wildner
3180d02842fSSascha Wildner /* Ignore Return() and Return(Zero) (they are the same) */
3190d02842fSSascha Wildner
3200d02842fSSascha Wildner ReturnValueOp = Op->Asl.Child;
3210d02842fSSascha Wildner if (ReturnValueOp->Asl.ParseOpcode == PARSEOP_ZERO)
3220d02842fSSascha Wildner {
3230d02842fSSascha Wildner return;
3240d02842fSSascha Wildner }
3250d02842fSSascha Wildner
3260d02842fSSascha Wildner /* We have a valid return value, but the reserved name did not expect it */
3270d02842fSSascha Wildner
3280d02842fSSascha Wildner AslError (ASL_WARNING, ASL_MSG_RESERVED_NO_RETURN_VAL,
3290d02842fSSascha Wildner Op, MethodInfo->Op->Asl.ExternalName);
3300d02842fSSascha Wildner }
3310d02842fSSascha Wildner
3320d02842fSSascha Wildner
3330d02842fSSascha Wildner /*******************************************************************************
3340d02842fSSascha Wildner *
3350d02842fSSascha Wildner * FUNCTION: ApCheckPredefinedReturnValue
3360d02842fSSascha Wildner *
3370d02842fSSascha Wildner * PARAMETERS: Op - A parse node of type "RETURN".
3380d02842fSSascha Wildner * MethodInfo - Saved info about this method
3390d02842fSSascha Wildner *
3400d02842fSSascha Wildner * RETURN: None
3410d02842fSSascha Wildner *
3420d02842fSSascha Wildner * DESCRIPTION: If method is a predefined name, attempt to validate the return
3430d02842fSSascha Wildner * value. Only "static" types can be validated - a simple return
3440d02842fSSascha Wildner * of an integer/string/buffer/package or a named reference to
3450d02842fSSascha Wildner * a static object. Values such as a Localx or Argx or a control
3460d02842fSSascha Wildner * method invocation are not checked. Issue a warning if there is
3470d02842fSSascha Wildner * a valid return value, but the reserved method defines no
3480d02842fSSascha Wildner * return value.
3490d02842fSSascha Wildner *
3500d02842fSSascha Wildner ******************************************************************************/
3510d02842fSSascha Wildner
3520d02842fSSascha Wildner void
ApCheckPredefinedReturnValue(ACPI_PARSE_OBJECT * Op,ASL_METHOD_INFO * MethodInfo)3530d02842fSSascha Wildner ApCheckPredefinedReturnValue (
3540d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
3550d02842fSSascha Wildner ASL_METHOD_INFO *MethodInfo)
3560d02842fSSascha Wildner {
3570d02842fSSascha Wildner UINT32 Index;
3580d02842fSSascha Wildner ACPI_PARSE_OBJECT *ReturnValueOp;
3590d02842fSSascha Wildner const ACPI_PREDEFINED_INFO *ThisName;
3600d02842fSSascha Wildner
3610d02842fSSascha Wildner
3626a0135c2SSascha Wildner /*
3636a0135c2SSascha Wildner * Check parent method for a match against the predefined name list.
3646a0135c2SSascha Wildner *
3656a0135c2SSascha Wildner * Note: Disable compiler errors/warnings because any errors will be
3666a0135c2SSascha Wildner * caught when analyzing the parent method. Eliminates duplicate errors.
3676a0135c2SSascha Wildner */
368806343b9SSascha Wildner AslGbl_AllExceptionsDisabled = TRUE;
3690d02842fSSascha Wildner Index = ApCheckForPredefinedName (MethodInfo->Op,
3700d02842fSSascha Wildner MethodInfo->Op->Asl.NameSeg);
371806343b9SSascha Wildner AslGbl_AllExceptionsDisabled = FALSE;
3720d02842fSSascha Wildner
3730d02842fSSascha Wildner switch (Index)
3740d02842fSSascha Wildner {
3750d02842fSSascha Wildner case ACPI_EVENT_RESERVED_NAME: /* _Lxx/_Exx/_Wxx/_Qxx methods */
3760d02842fSSascha Wildner
3770d02842fSSascha Wildner /* No return value expected, warn if there is one */
3780d02842fSSascha Wildner
3790d02842fSSascha Wildner ApCheckForUnexpectedReturnValue (Op, MethodInfo);
3800d02842fSSascha Wildner return;
3810d02842fSSascha Wildner
3820d02842fSSascha Wildner case ACPI_NOT_RESERVED_NAME: /* No underscore or _Txx or _xxx name not matched */
3830d02842fSSascha Wildner case ACPI_PREDEFINED_NAME: /* Resource Name or reserved scope name */
3840d02842fSSascha Wildner case ACPI_COMPILER_RESERVED_NAME: /* A _Txx that was not emitted by compiler */
3850d02842fSSascha Wildner
3860d02842fSSascha Wildner /* Just return, nothing to do */
3870d02842fSSascha Wildner return;
3880d02842fSSascha Wildner
3890d02842fSSascha Wildner default: /* A standard predefined ACPI name */
3900d02842fSSascha Wildner
3910d02842fSSascha Wildner ThisName = &AcpiGbl_PredefinedMethods[Index];
3920d02842fSSascha Wildner if (!ThisName->Info.ExpectedBtypes)
3930d02842fSSascha Wildner {
3940d02842fSSascha Wildner /* No return value expected, warn if there is one */
3950d02842fSSascha Wildner
3960d02842fSSascha Wildner ApCheckForUnexpectedReturnValue (Op, MethodInfo);
3970d02842fSSascha Wildner return;
3980d02842fSSascha Wildner }
3990d02842fSSascha Wildner
4000d02842fSSascha Wildner /* Get the object returned, it is the next argument */
4010d02842fSSascha Wildner
4020d02842fSSascha Wildner ReturnValueOp = Op->Asl.Child;
4030d02842fSSascha Wildner switch (ReturnValueOp->Asl.ParseOpcode)
4040d02842fSSascha Wildner {
4050d02842fSSascha Wildner case PARSEOP_ZERO:
4060d02842fSSascha Wildner case PARSEOP_ONE:
4070d02842fSSascha Wildner case PARSEOP_ONES:
4080d02842fSSascha Wildner case PARSEOP_INTEGER:
4090d02842fSSascha Wildner case PARSEOP_STRING_LITERAL:
4100d02842fSSascha Wildner case PARSEOP_BUFFER:
4110d02842fSSascha Wildner case PARSEOP_PACKAGE:
4120d02842fSSascha Wildner
4130d02842fSSascha Wildner /* Static data return object - check against expected type */
4140d02842fSSascha Wildner
4150d02842fSSascha Wildner ApCheckObjectType (ThisName->Info.Name, ReturnValueOp,
4160d02842fSSascha Wildner ThisName->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
4170d02842fSSascha Wildner
4180d02842fSSascha Wildner /* For packages, check the individual package elements */
4190d02842fSSascha Wildner
4200d02842fSSascha Wildner if (ReturnValueOp->Asl.ParseOpcode == PARSEOP_PACKAGE)
4210d02842fSSascha Wildner {
4220d02842fSSascha Wildner ApCheckPackage (ReturnValueOp, ThisName);
4230d02842fSSascha Wildner }
4240d02842fSSascha Wildner break;
4250d02842fSSascha Wildner
4260d02842fSSascha Wildner default:
4270d02842fSSascha Wildner /*
4280d02842fSSascha Wildner * All other ops are very difficult or impossible to typecheck at
4290d02842fSSascha Wildner * compile time. These include all Localx, Argx, and method
4300d02842fSSascha Wildner * invocations. Also, NAMESEG and NAMESTRING because the type of
4310d02842fSSascha Wildner * any named object can be changed at runtime (for example,
4320d02842fSSascha Wildner * CopyObject will change the type of the target object.)
4330d02842fSSascha Wildner */
4340d02842fSSascha Wildner break;
4350d02842fSSascha Wildner }
4360d02842fSSascha Wildner }
4370d02842fSSascha Wildner }
4380d02842fSSascha Wildner
4390d02842fSSascha Wildner
4400d02842fSSascha Wildner /*******************************************************************************
4410d02842fSSascha Wildner *
4420d02842fSSascha Wildner * FUNCTION: ApCheckForPredefinedObject
4430d02842fSSascha Wildner *
4440d02842fSSascha Wildner * PARAMETERS: Op - A parse node
4450d02842fSSascha Wildner * Name - The ACPI name to be checked
4460d02842fSSascha Wildner *
4470d02842fSSascha Wildner * RETURN: None
4480d02842fSSascha Wildner *
4490d02842fSSascha Wildner * DESCRIPTION: Check for a predefined name for a static object (created via
4500d02842fSSascha Wildner * the ASL Name operator). If it is a predefined ACPI name, ensure
4510d02842fSSascha Wildner * that the name does not require any arguments (which would
45200ffa116SSascha Wildner * require a control method implementation of the name), and that
4530d02842fSSascha Wildner * the type of the object is one of the expected types for the
4540d02842fSSascha Wildner * predefined name.
4550d02842fSSascha Wildner *
4560d02842fSSascha Wildner ******************************************************************************/
4570d02842fSSascha Wildner
4580d02842fSSascha Wildner void
ApCheckForPredefinedObject(ACPI_PARSE_OBJECT * Op,char * Name)4590d02842fSSascha Wildner ApCheckForPredefinedObject (
4600d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
4610d02842fSSascha Wildner char *Name)
4620d02842fSSascha Wildner {
4630d02842fSSascha Wildner UINT32 Index;
4640d02842fSSascha Wildner ACPI_PARSE_OBJECT *ObjectOp;
4650d02842fSSascha Wildner const ACPI_PREDEFINED_INFO *ThisName;
4660d02842fSSascha Wildner
4670d02842fSSascha Wildner
4680d02842fSSascha Wildner /*
4690d02842fSSascha Wildner * Check for a real predefined name -- not a resource descriptor name
4700d02842fSSascha Wildner * or a predefined scope name
4710d02842fSSascha Wildner */
4720d02842fSSascha Wildner Index = ApCheckForPredefinedName (Op, Name);
4730d02842fSSascha Wildner
4740d02842fSSascha Wildner switch (Index)
4750d02842fSSascha Wildner {
4760d02842fSSascha Wildner case ACPI_NOT_RESERVED_NAME: /* No underscore or _Txx or _xxx name not matched */
4770d02842fSSascha Wildner case ACPI_PREDEFINED_NAME: /* Resource Name or reserved scope name */
4780d02842fSSascha Wildner case ACPI_COMPILER_RESERVED_NAME: /* A _Txx that was not emitted by compiler */
4790d02842fSSascha Wildner
4800d02842fSSascha Wildner /* Nothing to do */
4810d02842fSSascha Wildner return;
4820d02842fSSascha Wildner
4830d02842fSSascha Wildner case ACPI_EVENT_RESERVED_NAME: /* _Lxx/_Exx/_Wxx/_Qxx methods */
4840d02842fSSascha Wildner
4850d02842fSSascha Wildner /*
4860d02842fSSascha Wildner * These names must be control methods, by definition in ACPI spec.
4870d02842fSSascha Wildner * Also because they are defined to return no value. None of them
4880d02842fSSascha Wildner * require any arguments.
4890d02842fSSascha Wildner */
4900d02842fSSascha Wildner AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
4910d02842fSSascha Wildner "with zero arguments");
4920d02842fSSascha Wildner return;
4930d02842fSSascha Wildner
4940d02842fSSascha Wildner default:
4950d02842fSSascha Wildner
4960d02842fSSascha Wildner break;
4970d02842fSSascha Wildner }
4980d02842fSSascha Wildner
4990d02842fSSascha Wildner /* A standard predefined ACPI name */
5000d02842fSSascha Wildner
5010d02842fSSascha Wildner /*
5020d02842fSSascha Wildner * If this predefined name requires input arguments, then
5030d02842fSSascha Wildner * it must be implemented as a control method
5040d02842fSSascha Wildner */
5050d02842fSSascha Wildner ThisName = &AcpiGbl_PredefinedMethods[Index];
5060d02842fSSascha Wildner if (METHOD_GET_ARG_COUNT (ThisName->Info.ArgumentList) > 0)
5070d02842fSSascha Wildner {
5080d02842fSSascha Wildner AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
5090d02842fSSascha Wildner "with arguments");
5100d02842fSSascha Wildner return;
5110d02842fSSascha Wildner }
5120d02842fSSascha Wildner
5130d02842fSSascha Wildner /*
5140d02842fSSascha Wildner * If no return value is expected from this predefined name, then
5150d02842fSSascha Wildner * it follows that it must be implemented as a control method
5160d02842fSSascha Wildner * (with zero args, because the args > 0 case was handled above)
5170d02842fSSascha Wildner * Examples are: _DIS, _INI, _IRC, _OFF, _ON, _PSx
5180d02842fSSascha Wildner */
5190d02842fSSascha Wildner if (!ThisName->Info.ExpectedBtypes)
5200d02842fSSascha Wildner {
5210d02842fSSascha Wildner AslError (ASL_ERROR, ASL_MSG_RESERVED_METHOD, Op,
5220d02842fSSascha Wildner "with zero arguments");
5230d02842fSSascha Wildner return;
5240d02842fSSascha Wildner }
5250d02842fSSascha Wildner
5260d02842fSSascha Wildner /* Typecheck the actual object, it is the next argument */
5270d02842fSSascha Wildner
5280d02842fSSascha Wildner ObjectOp = Op->Asl.Child->Asl.Next;
5290d02842fSSascha Wildner ApCheckObjectType (ThisName->Info.Name, Op->Asl.Child->Asl.Next,
5300d02842fSSascha Wildner ThisName->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
5310d02842fSSascha Wildner
5320d02842fSSascha Wildner /* For packages, check the individual package elements */
5330d02842fSSascha Wildner
5340d02842fSSascha Wildner if (ObjectOp->Asl.ParseOpcode == PARSEOP_PACKAGE)
5350d02842fSSascha Wildner {
5360d02842fSSascha Wildner ApCheckPackage (ObjectOp, ThisName);
5370d02842fSSascha Wildner }
5380d02842fSSascha Wildner }
5390d02842fSSascha Wildner
5400d02842fSSascha Wildner
5410d02842fSSascha Wildner /*******************************************************************************
5420d02842fSSascha Wildner *
5430d02842fSSascha Wildner * FUNCTION: ApCheckForPredefinedName
5440d02842fSSascha Wildner *
5450d02842fSSascha Wildner * PARAMETERS: Op - A parse node
5460d02842fSSascha Wildner * Name - NameSeg to check
5470d02842fSSascha Wildner *
5480d02842fSSascha Wildner * RETURN: None
5490d02842fSSascha Wildner *
5500d02842fSSascha Wildner * DESCRIPTION: Check a NameSeg against the reserved list.
5510d02842fSSascha Wildner *
5520d02842fSSascha Wildner ******************************************************************************/
5530d02842fSSascha Wildner
5540d02842fSSascha Wildner UINT32
ApCheckForPredefinedName(ACPI_PARSE_OBJECT * Op,char * Name)5550d02842fSSascha Wildner ApCheckForPredefinedName (
5560d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
5570d02842fSSascha Wildner char *Name)
5580d02842fSSascha Wildner {
5590d02842fSSascha Wildner UINT32 i;
5600d02842fSSascha Wildner const ACPI_PREDEFINED_INFO *ThisName;
5610d02842fSSascha Wildner
5620d02842fSSascha Wildner
5630d02842fSSascha Wildner if (Name[0] == 0)
5640d02842fSSascha Wildner {
5650d27ae55SSascha Wildner AslError (ASL_ERROR, ASL_MSG_COMPILER_INTERNAL, Op,
5660d27ae55SSascha Wildner "zero length name found");
5670d02842fSSascha Wildner }
5680d02842fSSascha Wildner
5690d02842fSSascha Wildner /* All reserved names are prefixed with a single underscore */
5700d02842fSSascha Wildner
5710d02842fSSascha Wildner if (Name[0] != '_')
5720d02842fSSascha Wildner {
5730d02842fSSascha Wildner return (ACPI_NOT_RESERVED_NAME);
5740d02842fSSascha Wildner }
5750d02842fSSascha Wildner
5760d02842fSSascha Wildner /* Check for a standard predefined method name */
5770d02842fSSascha Wildner
5780d02842fSSascha Wildner ThisName = AcpiGbl_PredefinedMethods;
5790d02842fSSascha Wildner for (i = 0; ThisName->Info.Name[0]; i++)
5800d02842fSSascha Wildner {
581c1776041SSascha Wildner if (ACPI_COMPARE_NAMESEG (Name, ThisName->Info.Name))
5820d02842fSSascha Wildner {
5830d02842fSSascha Wildner /* Return index into predefined array */
5840d02842fSSascha Wildner return (i);
5850d02842fSSascha Wildner }
5860d02842fSSascha Wildner
5870d02842fSSascha Wildner ThisName++; /* Does not account for extra package data, but is OK */
5880d02842fSSascha Wildner }
5890d02842fSSascha Wildner
5900d02842fSSascha Wildner /* Check for resource names and predefined scope names */
5910d02842fSSascha Wildner
5920d02842fSSascha Wildner ThisName = AcpiGbl_ResourceNames;
5930d02842fSSascha Wildner while (ThisName->Info.Name[0])
5940d02842fSSascha Wildner {
595c1776041SSascha Wildner if (ACPI_COMPARE_NAMESEG (Name, ThisName->Info.Name))
5960d02842fSSascha Wildner {
5970d02842fSSascha Wildner return (ACPI_PREDEFINED_NAME);
5980d02842fSSascha Wildner }
5990d02842fSSascha Wildner
6000d02842fSSascha Wildner ThisName++;
6010d02842fSSascha Wildner }
6020d02842fSSascha Wildner
6030d02842fSSascha Wildner ThisName = AcpiGbl_ScopeNames;
6040d02842fSSascha Wildner while (ThisName->Info.Name[0])
6050d02842fSSascha Wildner {
606c1776041SSascha Wildner if (ACPI_COMPARE_NAMESEG (Name, ThisName->Info.Name))
6070d02842fSSascha Wildner {
6080d02842fSSascha Wildner return (ACPI_PREDEFINED_NAME);
6090d02842fSSascha Wildner }
6100d02842fSSascha Wildner
6110d02842fSSascha Wildner ThisName++;
6120d02842fSSascha Wildner }
6130d02842fSSascha Wildner
6140d02842fSSascha Wildner /* Check for _Lxx/_Exx/_Wxx/_Qxx/_T_x. Warning if unknown predefined name */
6150d02842fSSascha Wildner
6160d02842fSSascha Wildner return (ApCheckForSpecialName (Op, Name));
6170d02842fSSascha Wildner }
6180d02842fSSascha Wildner
6190d02842fSSascha Wildner
6200d02842fSSascha Wildner /*******************************************************************************
6210d02842fSSascha Wildner *
6220d02842fSSascha Wildner * FUNCTION: ApCheckForSpecialName
6230d02842fSSascha Wildner *
6240d02842fSSascha Wildner * PARAMETERS: Op - A parse node
6250d02842fSSascha Wildner * Name - NameSeg to check
6260d02842fSSascha Wildner *
6270d02842fSSascha Wildner * RETURN: None
6280d02842fSSascha Wildner *
6290d02842fSSascha Wildner * DESCRIPTION: Check for the "special" predefined names -
6300d02842fSSascha Wildner * _Lxx, _Exx, _Qxx, _Wxx, and _T_x
6310d02842fSSascha Wildner *
6320d02842fSSascha Wildner ******************************************************************************/
6330d02842fSSascha Wildner
6340d02842fSSascha Wildner static UINT32
ApCheckForSpecialName(ACPI_PARSE_OBJECT * Op,char * Name)6350d02842fSSascha Wildner ApCheckForSpecialName (
6360d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
6370d02842fSSascha Wildner char *Name)
6380d02842fSSascha Wildner {
6390d02842fSSascha Wildner
6400d02842fSSascha Wildner /*
6410d02842fSSascha Wildner * Check for the "special" predefined names. We already know that the
6420d02842fSSascha Wildner * first character is an underscore.
6430d02842fSSascha Wildner * GPE: _Lxx
6440d02842fSSascha Wildner * GPE: _Exx
6450d02842fSSascha Wildner * GPE: _Wxx
6460d02842fSSascha Wildner * EC: _Qxx
6470d02842fSSascha Wildner */
6480d02842fSSascha Wildner if ((Name[1] == 'L') ||
6490d02842fSSascha Wildner (Name[1] == 'E') ||
6500d02842fSSascha Wildner (Name[1] == 'W') ||
6510d02842fSSascha Wildner (Name[1] == 'Q'))
6520d02842fSSascha Wildner {
6530d02842fSSascha Wildner /* The next two characters must be hex digits */
6540d02842fSSascha Wildner
6550d02842fSSascha Wildner if ((isxdigit ((int) Name[2])) &&
6560d02842fSSascha Wildner (isxdigit ((int) Name[3])))
6570d02842fSSascha Wildner {
6580d02842fSSascha Wildner return (ACPI_EVENT_RESERVED_NAME);
6590d02842fSSascha Wildner }
6600d02842fSSascha Wildner }
6610d02842fSSascha Wildner
6620d02842fSSascha Wildner /* Check for the names reserved for the compiler itself: _T_x */
6630d02842fSSascha Wildner
6640d02842fSSascha Wildner else if ((Op->Asl.ExternalName[1] == 'T') &&
6650d02842fSSascha Wildner (Op->Asl.ExternalName[2] == '_'))
6660d02842fSSascha Wildner {
6670d02842fSSascha Wildner /* Ignore if actually emitted by the compiler */
6680d02842fSSascha Wildner
6691093ca81SSascha Wildner if (Op->Asl.CompileFlags & OP_COMPILER_EMITTED)
6700d02842fSSascha Wildner {
6710d02842fSSascha Wildner return (ACPI_NOT_RESERVED_NAME);
6720d02842fSSascha Wildner }
6730d02842fSSascha Wildner
6740d02842fSSascha Wildner /*
6750d02842fSSascha Wildner * Was not actually emitted by the compiler. This is a special case,
6760d02842fSSascha Wildner * however. If the ASL code being compiled was the result of a
6770f79e681SSascha Wildner * disassembly, it may possibly contain valid compiler-emitted names
6780d02842fSSascha Wildner * of the form "_T_x". We don't want to issue an error or even a
6790d02842fSSascha Wildner * warning and force the user to manually change the names. So, we
6800d02842fSSascha Wildner * will issue a remark instead.
6810d02842fSSascha Wildner */
682820c5b08SSascha Wildner AslError (ASL_REMARK, ASL_MSG_COMPILER_RESERVED,
683820c5b08SSascha Wildner Op, Op->Asl.ExternalName);
6840d02842fSSascha Wildner return (ACPI_COMPILER_RESERVED_NAME);
6850d02842fSSascha Wildner }
6860d02842fSSascha Wildner
6870d02842fSSascha Wildner /*
6880d02842fSSascha Wildner * The name didn't match any of the known predefined names. Flag it as a
6890d02842fSSascha Wildner * warning, since the entire namespace starting with an underscore is
6900d02842fSSascha Wildner * reserved by the ACPI spec.
6910d02842fSSascha Wildner */
692820c5b08SSascha Wildner AslError (ASL_WARNING, ASL_MSG_UNKNOWN_RESERVED_NAME,
693820c5b08SSascha Wildner Op, Op->Asl.ExternalName);
6940d02842fSSascha Wildner
6950d02842fSSascha Wildner return (ACPI_NOT_RESERVED_NAME);
6960d02842fSSascha Wildner }
6970d02842fSSascha Wildner
6980d02842fSSascha Wildner
6990d02842fSSascha Wildner /*******************************************************************************
7000d02842fSSascha Wildner *
7010d02842fSSascha Wildner * FUNCTION: ApCheckObjectType
7020d02842fSSascha Wildner *
7030d02842fSSascha Wildner * PARAMETERS: PredefinedName - Name of the predefined object we are checking
7040d02842fSSascha Wildner * Op - Current parse node
7050d02842fSSascha Wildner * ExpectedBtypes - Bitmap of expected return type(s)
7060d02842fSSascha Wildner * PackageIndex - Index of object within parent package (if
7070d02842fSSascha Wildner * applicable - ACPI_NOT_PACKAGE_ELEMENT
7080d02842fSSascha Wildner * otherwise)
7090d02842fSSascha Wildner *
7100d02842fSSascha Wildner * RETURN: None
7110d02842fSSascha Wildner *
7120d02842fSSascha Wildner * DESCRIPTION: Check if the object type is one of the types that is expected
7130d02842fSSascha Wildner * by the predefined name. Only a limited number of object types
7140d02842fSSascha Wildner * can be returned by the predefined names.
7150d02842fSSascha Wildner *
7160d02842fSSascha Wildner ******************************************************************************/
7170d02842fSSascha Wildner
7180d02842fSSascha Wildner ACPI_STATUS
ApCheckObjectType(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT32 ExpectedBtypes,UINT32 PackageIndex)7190d02842fSSascha Wildner ApCheckObjectType (
7200d02842fSSascha Wildner const char *PredefinedName,
7210d02842fSSascha Wildner ACPI_PARSE_OBJECT *Op,
7220d02842fSSascha Wildner UINT32 ExpectedBtypes,
7230d02842fSSascha Wildner UINT32 PackageIndex)
7240d02842fSSascha Wildner {
7250d02842fSSascha Wildner UINT32 ReturnBtype;
7260d02842fSSascha Wildner char *TypeName;
7270d02842fSSascha Wildner
7280d02842fSSascha Wildner
7290d02842fSSascha Wildner if (!Op)
7300d02842fSSascha Wildner {
7310d02842fSSascha Wildner return (AE_TYPE);
7320d02842fSSascha Wildner }
7330d02842fSSascha Wildner
7340d02842fSSascha Wildner /* Map the parse opcode to a bitmapped return type (RTYPE) */
7350d02842fSSascha Wildner
7360d02842fSSascha Wildner switch (Op->Asl.ParseOpcode)
7370d02842fSSascha Wildner {
7380d02842fSSascha Wildner case PARSEOP_ZERO:
7390d02842fSSascha Wildner case PARSEOP_ONE:
7400d02842fSSascha Wildner case PARSEOP_ONES:
7410d02842fSSascha Wildner case PARSEOP_INTEGER:
7420d02842fSSascha Wildner
7430d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_INTEGER;
7440d02842fSSascha Wildner TypeName = "Integer";
7450d02842fSSascha Wildner break;
7460d02842fSSascha Wildner
7470d02842fSSascha Wildner case PARSEOP_STRING_LITERAL:
7480d02842fSSascha Wildner
7490d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_STRING;
7500d02842fSSascha Wildner TypeName = "String";
7510d02842fSSascha Wildner break;
7520d02842fSSascha Wildner
7530d02842fSSascha Wildner case PARSEOP_BUFFER:
7540d02842fSSascha Wildner
7550d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_BUFFER;
7560d02842fSSascha Wildner TypeName = "Buffer";
7570d02842fSSascha Wildner break;
7580d02842fSSascha Wildner
7590d02842fSSascha Wildner case PARSEOP_PACKAGE:
7600d02842fSSascha Wildner case PARSEOP_VAR_PACKAGE:
7610d02842fSSascha Wildner
7620d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_PACKAGE;
7630d02842fSSascha Wildner TypeName = "Package";
7640d02842fSSascha Wildner break;
7650d02842fSSascha Wildner
7660d02842fSSascha Wildner case PARSEOP_NAMESEG:
7670d02842fSSascha Wildner case PARSEOP_NAMESTRING:
7680d02842fSSascha Wildner /*
7690d02842fSSascha Wildner * Ignore any named references within a package object.
7700d02842fSSascha Wildner *
7710d02842fSSascha Wildner * For Package objects, references are allowed instead of any of the
7720d02842fSSascha Wildner * standard data types (Integer/String/Buffer/Package). These
7730d02842fSSascha Wildner * references are resolved at runtime. NAMESEG and NAMESTRING are
7740d02842fSSascha Wildner * impossible to typecheck at compile time because the type of
7750d02842fSSascha Wildner * any named object can be changed at runtime (for example,
7760d02842fSSascha Wildner * CopyObject will change the type of the target object).
7770d02842fSSascha Wildner */
7780d02842fSSascha Wildner if (PackageIndex != ACPI_NOT_PACKAGE_ELEMENT)
7790d02842fSSascha Wildner {
7800d02842fSSascha Wildner return (AE_OK);
7810d02842fSSascha Wildner }
7820d02842fSSascha Wildner
7830d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_REFERENCE;
7840d02842fSSascha Wildner TypeName = "Reference";
7850d02842fSSascha Wildner break;
7860d02842fSSascha Wildner
7870d02842fSSascha Wildner default:
7880d02842fSSascha Wildner
7890d02842fSSascha Wildner /* Not one of the supported object types */
7900d02842fSSascha Wildner
7910d02842fSSascha Wildner TypeName = UtGetOpName (Op->Asl.ParseOpcode);
7920d02842fSSascha Wildner goto TypeErrorExit;
7930d02842fSSascha Wildner }
7940d02842fSSascha Wildner
7950d02842fSSascha Wildner /* Exit if the object is one of the expected types */
7960d02842fSSascha Wildner
7970d02842fSSascha Wildner if (ReturnBtype & ExpectedBtypes)
7980d02842fSSascha Wildner {
7990d02842fSSascha Wildner return (AE_OK);
8000d02842fSSascha Wildner }
8010d02842fSSascha Wildner
8020d02842fSSascha Wildner
8030d02842fSSascha Wildner TypeErrorExit:
8040d02842fSSascha Wildner
8050d02842fSSascha Wildner /* Format the expected types and emit an error message */
8060d02842fSSascha Wildner
807806343b9SSascha Wildner AcpiUtGetExpectedReturnTypes (AslGbl_StringBuffer, ExpectedBtypes);
8080d02842fSSascha Wildner
8090d02842fSSascha Wildner if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT)
8100d02842fSSascha Wildner {
811806343b9SSascha Wildner sprintf (AslGbl_MsgBuffer, "%4.4s: found %s, %s required",
812806343b9SSascha Wildner PredefinedName, TypeName, AslGbl_StringBuffer);
8130d02842fSSascha Wildner }
8140d02842fSSascha Wildner else
8150d02842fSSascha Wildner {
816806343b9SSascha Wildner sprintf (AslGbl_MsgBuffer, "%4.4s: found %s at index %u, %s required",
817806343b9SSascha Wildner PredefinedName, TypeName, PackageIndex, AslGbl_StringBuffer);
8180d02842fSSascha Wildner }
8190d02842fSSascha Wildner
820806343b9SSascha Wildner AslError (ASL_ERROR, ASL_MSG_RESERVED_OPERAND_TYPE, Op, AslGbl_MsgBuffer);
8210d02842fSSascha Wildner return (AE_TYPE);
8220d02842fSSascha Wildner }
8230d02842fSSascha Wildner
8240d02842fSSascha Wildner
8250d02842fSSascha Wildner /*******************************************************************************
8260d02842fSSascha Wildner *
8270d02842fSSascha Wildner * FUNCTION: ApDisplayReservedNames
8280d02842fSSascha Wildner *
8290d02842fSSascha Wildner * PARAMETERS: None
8300d02842fSSascha Wildner *
8310d02842fSSascha Wildner * RETURN: None
8320d02842fSSascha Wildner *
8330d02842fSSascha Wildner * DESCRIPTION: Dump information about the ACPI predefined names and predefined
8340d02842fSSascha Wildner * resource descriptor names.
8350d02842fSSascha Wildner *
8360d02842fSSascha Wildner ******************************************************************************/
8370d02842fSSascha Wildner
8380d02842fSSascha Wildner void
ApDisplayReservedNames(void)8390d02842fSSascha Wildner ApDisplayReservedNames (
8400d02842fSSascha Wildner void)
8410d02842fSSascha Wildner {
8420d02842fSSascha Wildner const ACPI_PREDEFINED_INFO *ThisName;
8430d02842fSSascha Wildner UINT32 Count;
8440d02842fSSascha Wildner UINT32 NumTypes;
8450d02842fSSascha Wildner
8460d02842fSSascha Wildner
8470d02842fSSascha Wildner /*
8480d02842fSSascha Wildner * Predefined names/methods
8490d02842fSSascha Wildner */
8500d02842fSSascha Wildner printf ("\nPredefined Name Information\n\n");
8510d02842fSSascha Wildner
8520d02842fSSascha Wildner Count = 0;
8530d02842fSSascha Wildner ThisName = AcpiGbl_PredefinedMethods;
8540d02842fSSascha Wildner while (ThisName->Info.Name[0])
8550d02842fSSascha Wildner {
856806343b9SSascha Wildner AcpiUtDisplayPredefinedMethod (AslGbl_MsgBuffer, ThisName, FALSE);
8570d02842fSSascha Wildner Count++;
8580d02842fSSascha Wildner ThisName = AcpiUtGetNextPredefinedMethod (ThisName);
8590d02842fSSascha Wildner }
8600d02842fSSascha Wildner
8610d02842fSSascha Wildner printf ("%u Predefined Names are recognized\n", Count);
8620d02842fSSascha Wildner
8630d02842fSSascha Wildner /*
8640d02842fSSascha Wildner * Resource Descriptor names
8650d02842fSSascha Wildner */
8660d02842fSSascha Wildner printf ("\nPredefined Names for Resource Descriptor Fields\n\n");
8670d02842fSSascha Wildner
8680d02842fSSascha Wildner Count = 0;
8690d02842fSSascha Wildner ThisName = AcpiGbl_ResourceNames;
8700d02842fSSascha Wildner while (ThisName->Info.Name[0])
8710d02842fSSascha Wildner {
872806343b9SSascha Wildner NumTypes = AcpiUtGetResourceBitWidth (AslGbl_MsgBuffer,
8730d02842fSSascha Wildner ThisName->Info.ArgumentList);
8740d02842fSSascha Wildner
8750d02842fSSascha Wildner printf ("%4.4s Field is %s bits wide%s\n",
876806343b9SSascha Wildner ThisName->Info.Name, AslGbl_MsgBuffer,
8770d02842fSSascha Wildner (NumTypes > 1) ? " (depending on descriptor type)" : "");
8780d02842fSSascha Wildner
8790d02842fSSascha Wildner Count++;
8800d02842fSSascha Wildner ThisName++;
8810d02842fSSascha Wildner }
8820d02842fSSascha Wildner
8830d02842fSSascha Wildner printf ("%u Resource Descriptor Field Names are recognized\n", Count);
8840d02842fSSascha Wildner
8850d02842fSSascha Wildner /*
8860d02842fSSascha Wildner * Predefined scope names
8870d02842fSSascha Wildner */
8880d02842fSSascha Wildner printf ("\nPredefined Scope/Device Names (automatically created at root)\n\n");
8890d02842fSSascha Wildner
8900d02842fSSascha Wildner ThisName = AcpiGbl_ScopeNames;
8910d02842fSSascha Wildner while (ThisName->Info.Name[0])
8920d02842fSSascha Wildner {
8930d02842fSSascha Wildner printf ("%4.4s Scope/Device\n", ThisName->Info.Name);
8940d02842fSSascha Wildner ThisName++;
8950d02842fSSascha Wildner }
8960d02842fSSascha Wildner }
897