10d02842fSSascha Wildner /******************************************************************************
20d02842fSSascha Wildner *
30d02842fSSascha Wildner * Module Name: nspredef - Validation of ACPI predefined methods and objects
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
1540d02842fSSascha Wildner #include "acpi.h"
1550d02842fSSascha Wildner #include "accommon.h"
1560d02842fSSascha Wildner #include "acnamesp.h"
1570d02842fSSascha Wildner #include "acpredef.h"
1580d02842fSSascha Wildner
1590d02842fSSascha Wildner
1600d02842fSSascha Wildner #define _COMPONENT ACPI_NAMESPACE
1610d02842fSSascha Wildner ACPI_MODULE_NAME ("nspredef")
1620d02842fSSascha Wildner
1630d02842fSSascha Wildner
1640d02842fSSascha Wildner /*******************************************************************************
1650d02842fSSascha Wildner *
1660d02842fSSascha Wildner * This module validates predefined ACPI objects that appear in the namespace,
1670d02842fSSascha Wildner * at the time they are evaluated (via AcpiEvaluateObject). The purpose of this
1680d02842fSSascha Wildner * validation is to detect problems with BIOS-exposed predefined ACPI objects
1690d02842fSSascha Wildner * before the results are returned to the ACPI-related drivers.
1700d02842fSSascha Wildner *
1710d02842fSSascha Wildner * There are several areas that are validated:
1720d02842fSSascha Wildner *
1730d02842fSSascha Wildner * 1) The number of input arguments as defined by the method/object in the
1740d02842fSSascha Wildner * ASL is validated against the ACPI specification.
1750d02842fSSascha Wildner * 2) The type of the return object (if any) is validated against the ACPI
1760d02842fSSascha Wildner * specification.
1770d02842fSSascha Wildner * 3) For returned package objects, the count of package elements is
1780d02842fSSascha Wildner * validated, as well as the type of each package element. Nested
1790d02842fSSascha Wildner * packages are supported.
1800d02842fSSascha Wildner *
1810d02842fSSascha Wildner * For any problems found, a warning message is issued.
1820d02842fSSascha Wildner *
1830d02842fSSascha Wildner ******************************************************************************/
1840d02842fSSascha Wildner
1850d02842fSSascha Wildner
1860d02842fSSascha Wildner /* Local prototypes */
1870d02842fSSascha Wildner
1880d02842fSSascha Wildner static ACPI_STATUS
1890d02842fSSascha Wildner AcpiNsCheckReference (
1900d02842fSSascha Wildner ACPI_EVALUATE_INFO *Info,
1910d02842fSSascha Wildner ACPI_OPERAND_OBJECT *ReturnObject);
1920d02842fSSascha Wildner
1930d02842fSSascha Wildner static UINT32
1940d02842fSSascha Wildner AcpiNsGetBitmappedType (
1950d02842fSSascha Wildner ACPI_OPERAND_OBJECT *ReturnObject);
1960d02842fSSascha Wildner
1970d02842fSSascha Wildner
1980d02842fSSascha Wildner /*******************************************************************************
1990d02842fSSascha Wildner *
2000d02842fSSascha Wildner * FUNCTION: AcpiNsCheckReturnValue
2010d02842fSSascha Wildner *
2020d02842fSSascha Wildner * PARAMETERS: Node - Namespace node for the method/object
2030d02842fSSascha Wildner * Info - Method execution information block
2040d02842fSSascha Wildner * UserParamCount - Number of parameters actually passed
2050d02842fSSascha Wildner * ReturnStatus - Status from the object evaluation
2060d02842fSSascha Wildner * ReturnObjectPtr - Pointer to the object returned from the
2070d02842fSSascha Wildner * evaluation of a method or object
2080d02842fSSascha Wildner *
2090d02842fSSascha Wildner * RETURN: Status
2100d02842fSSascha Wildner *
2110d02842fSSascha Wildner * DESCRIPTION: Check the value returned from a predefined name.
2120d02842fSSascha Wildner *
2130d02842fSSascha Wildner ******************************************************************************/
2140d02842fSSascha Wildner
2150d02842fSSascha Wildner ACPI_STATUS
AcpiNsCheckReturnValue(ACPI_NAMESPACE_NODE * Node,ACPI_EVALUATE_INFO * Info,UINT32 UserParamCount,ACPI_STATUS ReturnStatus,ACPI_OPERAND_OBJECT ** ReturnObjectPtr)2160d02842fSSascha Wildner AcpiNsCheckReturnValue (
2170d02842fSSascha Wildner ACPI_NAMESPACE_NODE *Node,
2180d02842fSSascha Wildner ACPI_EVALUATE_INFO *Info,
2190d02842fSSascha Wildner UINT32 UserParamCount,
2200d02842fSSascha Wildner ACPI_STATUS ReturnStatus,
2210d02842fSSascha Wildner ACPI_OPERAND_OBJECT **ReturnObjectPtr)
2220d02842fSSascha Wildner {
2230d02842fSSascha Wildner ACPI_STATUS Status;
2240d02842fSSascha Wildner const ACPI_PREDEFINED_INFO *Predefined;
2250d02842fSSascha Wildner
2262b57e6dfSSascha Wildner ACPI_FUNCTION_TRACE (NsCheckReturnValue);
2270d02842fSSascha Wildner
2280d02842fSSascha Wildner /* If not a predefined name, we cannot validate the return object */
2290d02842fSSascha Wildner
2300d02842fSSascha Wildner Predefined = Info->Predefined;
2310d02842fSSascha Wildner if (!Predefined)
2320d02842fSSascha Wildner {
2332b57e6dfSSascha Wildner return_ACPI_STATUS (AE_OK);
2340d02842fSSascha Wildner }
2350d02842fSSascha Wildner
2360d02842fSSascha Wildner /*
2370d02842fSSascha Wildner * If the method failed or did not actually return an object, we cannot
2380d02842fSSascha Wildner * validate the return object
2390d02842fSSascha Wildner */
2400d02842fSSascha Wildner if ((ReturnStatus != AE_OK) &&
2410d02842fSSascha Wildner (ReturnStatus != AE_CTRL_RETURN_VALUE))
2420d02842fSSascha Wildner {
2432b57e6dfSSascha Wildner return_ACPI_STATUS (AE_OK);
2440d02842fSSascha Wildner }
2450d02842fSSascha Wildner
2460d02842fSSascha Wildner /*
2470d02842fSSascha Wildner * Return value validation and possible repair.
2480d02842fSSascha Wildner *
2490d02842fSSascha Wildner * 1) Don't perform return value validation/repair if this feature
2500d02842fSSascha Wildner * has been disabled via a global option.
2510d02842fSSascha Wildner *
2520d02842fSSascha Wildner * 2) We have a return value, but if one wasn't expected, just exit,
2530d02842fSSascha Wildner * this is not a problem. For example, if the "Implicit Return"
2540d02842fSSascha Wildner * feature is enabled, methods will always return a value.
2550d02842fSSascha Wildner *
2560d02842fSSascha Wildner * 3) If the return value can be of any type, then we cannot perform
2570d02842fSSascha Wildner * any validation, just exit.
2580d02842fSSascha Wildner */
2590d02842fSSascha Wildner if (AcpiGbl_DisableAutoRepair ||
2600d02842fSSascha Wildner (!Predefined->Info.ExpectedBtypes) ||
2610d02842fSSascha Wildner (Predefined->Info.ExpectedBtypes == ACPI_RTYPE_ALL))
2620d02842fSSascha Wildner {
2632b57e6dfSSascha Wildner return_ACPI_STATUS (AE_OK);
2640d02842fSSascha Wildner }
2650d02842fSSascha Wildner
2660d02842fSSascha Wildner /*
2670d02842fSSascha Wildner * Check that the type of the main return object is what is expected
2680d02842fSSascha Wildner * for this predefined name
2690d02842fSSascha Wildner */
2700d02842fSSascha Wildner Status = AcpiNsCheckObjectType (Info, ReturnObjectPtr,
2710d02842fSSascha Wildner Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
2720d02842fSSascha Wildner if (ACPI_FAILURE (Status))
2730d02842fSSascha Wildner {
2740d02842fSSascha Wildner goto Exit;
2750d02842fSSascha Wildner }
2760d02842fSSascha Wildner
2770d02842fSSascha Wildner /*
2780d02842fSSascha Wildner *
2790d02842fSSascha Wildner * 4) If there is no return value and it is optional, just return
2800d02842fSSascha Wildner * AE_OK (_WAK).
2810d02842fSSascha Wildner */
2820d02842fSSascha Wildner if (!(*ReturnObjectPtr))
2830d02842fSSascha Wildner {
2840d02842fSSascha Wildner goto Exit;
2850d02842fSSascha Wildner }
2860d02842fSSascha Wildner
2870d02842fSSascha Wildner /*
2880d02842fSSascha Wildner * For returned Package objects, check the type of all sub-objects.
2890d02842fSSascha Wildner * Note: Package may have been newly created by call above.
2900d02842fSSascha Wildner */
2910d02842fSSascha Wildner if ((*ReturnObjectPtr)->Common.Type == ACPI_TYPE_PACKAGE)
2920d02842fSSascha Wildner {
2930d02842fSSascha Wildner Info->ParentPackage = *ReturnObjectPtr;
2940d02842fSSascha Wildner Status = AcpiNsCheckPackage (Info, ReturnObjectPtr);
2950d02842fSSascha Wildner if (ACPI_FAILURE (Status))
2960d02842fSSascha Wildner {
2970d02842fSSascha Wildner /* We might be able to fix some errors */
2980d02842fSSascha Wildner
2990d02842fSSascha Wildner if ((Status != AE_AML_OPERAND_TYPE) &&
3000d02842fSSascha Wildner (Status != AE_AML_OPERAND_VALUE))
3010d02842fSSascha Wildner {
3020d02842fSSascha Wildner goto Exit;
3030d02842fSSascha Wildner }
3040d02842fSSascha Wildner }
3050d02842fSSascha Wildner }
3060d02842fSSascha Wildner
3070d02842fSSascha Wildner /*
3080d02842fSSascha Wildner * The return object was OK, or it was successfully repaired above.
3090d02842fSSascha Wildner * Now make some additional checks such as verifying that package
3100d02842fSSascha Wildner * objects are sorted correctly (if required) or buffer objects have
3110d02842fSSascha Wildner * the correct data width (bytes vs. dwords). These repairs are
3120d02842fSSascha Wildner * performed on a per-name basis, i.e., the code is specific to
3130d02842fSSascha Wildner * particular predefined names.
3140d02842fSSascha Wildner */
3150d02842fSSascha Wildner Status = AcpiNsComplexRepairs (Info, Node, Status, ReturnObjectPtr);
3160d02842fSSascha Wildner
3170d02842fSSascha Wildner Exit:
3180d02842fSSascha Wildner /*
3190d02842fSSascha Wildner * If the object validation failed or if we successfully repaired one
3200d02842fSSascha Wildner * or more objects, mark the parent node to suppress further warning
3210d02842fSSascha Wildner * messages during the next evaluation of the same method/object.
3220d02842fSSascha Wildner */
3230d02842fSSascha Wildner if (ACPI_FAILURE (Status) ||
3240d02842fSSascha Wildner (Info->ReturnFlags & ACPI_OBJECT_REPAIRED))
3250d02842fSSascha Wildner {
3260d02842fSSascha Wildner Node->Flags |= ANOBJ_EVALUATED;
3270d02842fSSascha Wildner }
3280d02842fSSascha Wildner
3292b57e6dfSSascha Wildner return_ACPI_STATUS (Status);
3300d02842fSSascha Wildner }
3310d02842fSSascha Wildner
3320d02842fSSascha Wildner
3330d02842fSSascha Wildner /*******************************************************************************
3340d02842fSSascha Wildner *
3350d02842fSSascha Wildner * FUNCTION: AcpiNsCheckObjectType
3360d02842fSSascha Wildner *
3370d02842fSSascha Wildner * PARAMETERS: Info - Method execution information block
3380d02842fSSascha Wildner * ReturnObjectPtr - Pointer to the object returned from the
3390d02842fSSascha Wildner * evaluation of a method or object
3400d02842fSSascha Wildner * ExpectedBtypes - Bitmap of expected return type(s)
3410d02842fSSascha Wildner * PackageIndex - Index of object within parent package (if
3420d02842fSSascha Wildner * applicable - ACPI_NOT_PACKAGE_ELEMENT
3430d02842fSSascha Wildner * otherwise)
3440d02842fSSascha Wildner *
3450d02842fSSascha Wildner * RETURN: Status
3460d02842fSSascha Wildner *
3470d02842fSSascha Wildner * DESCRIPTION: Check the type of the return object against the expected object
3480d02842fSSascha Wildner * type(s). Use of Btype allows multiple expected object types.
3490d02842fSSascha Wildner *
3500d02842fSSascha Wildner ******************************************************************************/
3510d02842fSSascha Wildner
3520d02842fSSascha Wildner ACPI_STATUS
AcpiNsCheckObjectType(ACPI_EVALUATE_INFO * Info,ACPI_OPERAND_OBJECT ** ReturnObjectPtr,UINT32 ExpectedBtypes,UINT32 PackageIndex)3530d02842fSSascha Wildner AcpiNsCheckObjectType (
3540d02842fSSascha Wildner ACPI_EVALUATE_INFO *Info,
3550d02842fSSascha Wildner ACPI_OPERAND_OBJECT **ReturnObjectPtr,
3560d02842fSSascha Wildner UINT32 ExpectedBtypes,
3570d02842fSSascha Wildner UINT32 PackageIndex)
3580d02842fSSascha Wildner {
3590d02842fSSascha Wildner ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
3600d02842fSSascha Wildner ACPI_STATUS Status = AE_OK;
361c6400d37SSascha Wildner char TypeBuffer[96]; /* Room for 10 types */
3620d02842fSSascha Wildner
3630d02842fSSascha Wildner
3640d02842fSSascha Wildner /* A Namespace node should not get here, but make sure */
3650d02842fSSascha Wildner
3660d02842fSSascha Wildner if (ReturnObject &&
3670d02842fSSascha Wildner ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED)
3680d02842fSSascha Wildner {
3690d02842fSSascha Wildner ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
3700d02842fSSascha Wildner "Invalid return type - Found a Namespace node [%4.4s] type %s",
3710d02842fSSascha Wildner ReturnObject->Node.Name.Ascii,
3720d02842fSSascha Wildner AcpiUtGetTypeName (ReturnObject->Node.Type)));
3730d02842fSSascha Wildner return (AE_AML_OPERAND_TYPE);
3740d02842fSSascha Wildner }
3750d02842fSSascha Wildner
3760d02842fSSascha Wildner /*
3770d02842fSSascha Wildner * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
3780d02842fSSascha Wildner * The bitmapped type allows multiple possible return types.
3790d02842fSSascha Wildner *
3800d02842fSSascha Wildner * Note, the cases below must handle all of the possible types returned
3810d02842fSSascha Wildner * from all of the predefined names (including elements of returned
3820d02842fSSascha Wildner * packages)
3830d02842fSSascha Wildner */
3840d02842fSSascha Wildner Info->ReturnBtype = AcpiNsGetBitmappedType (ReturnObject);
3850d02842fSSascha Wildner if (Info->ReturnBtype == ACPI_RTYPE_ANY)
3860d02842fSSascha Wildner {
3870d02842fSSascha Wildner /* Not one of the supported objects, must be incorrect */
3880d02842fSSascha Wildner goto TypeErrorExit;
3890d02842fSSascha Wildner }
3900d02842fSSascha Wildner
3910d02842fSSascha Wildner /* For reference objects, check that the reference type is correct */
3920d02842fSSascha Wildner
3930d02842fSSascha Wildner if ((Info->ReturnBtype & ExpectedBtypes) == ACPI_RTYPE_REFERENCE)
3940d02842fSSascha Wildner {
3950d02842fSSascha Wildner Status = AcpiNsCheckReference (Info, ReturnObject);
3960d02842fSSascha Wildner return (Status);
3970d02842fSSascha Wildner }
3980d02842fSSascha Wildner
3990d02842fSSascha Wildner /* Attempt simple repair of the returned object if necessary */
4000d02842fSSascha Wildner
4010d02842fSSascha Wildner Status = AcpiNsSimpleRepair (Info, ExpectedBtypes,
4020d02842fSSascha Wildner PackageIndex, ReturnObjectPtr);
4030d02842fSSascha Wildner if (ACPI_SUCCESS (Status))
4040d02842fSSascha Wildner {
4050d02842fSSascha Wildner return (AE_OK); /* Successful repair */
4060d02842fSSascha Wildner }
4070d02842fSSascha Wildner
4080d02842fSSascha Wildner
4090d02842fSSascha Wildner TypeErrorExit:
4100d02842fSSascha Wildner
4110d02842fSSascha Wildner /* Create a string with all expected types for this predefined object */
4120d02842fSSascha Wildner
4130d02842fSSascha Wildner AcpiUtGetExpectedReturnTypes (TypeBuffer, ExpectedBtypes);
4140d02842fSSascha Wildner
4150d02842fSSascha Wildner if (!ReturnObject)
4160d02842fSSascha Wildner {
4170d02842fSSascha Wildner ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
4180d02842fSSascha Wildner "Expected return object of type %s",
4190d02842fSSascha Wildner TypeBuffer));
4200d02842fSSascha Wildner }
4210d02842fSSascha Wildner else if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT)
4220d02842fSSascha Wildner {
4230d02842fSSascha Wildner ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
4240d02842fSSascha Wildner "Return type mismatch - found %s, expected %s",
4250d02842fSSascha Wildner AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
4260d02842fSSascha Wildner }
4270d02842fSSascha Wildner else
4280d02842fSSascha Wildner {
4290d02842fSSascha Wildner ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
4300d02842fSSascha Wildner "Return Package type mismatch at index %u - "
4310d02842fSSascha Wildner "found %s, expected %s", PackageIndex,
4320d02842fSSascha Wildner AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
4330d02842fSSascha Wildner }
4340d02842fSSascha Wildner
4350d02842fSSascha Wildner return (AE_AML_OPERAND_TYPE);
4360d02842fSSascha Wildner }
4370d02842fSSascha Wildner
4380d02842fSSascha Wildner
4390d02842fSSascha Wildner /*******************************************************************************
4400d02842fSSascha Wildner *
4410d02842fSSascha Wildner * FUNCTION: AcpiNsCheckReference
4420d02842fSSascha Wildner *
4430d02842fSSascha Wildner * PARAMETERS: Info - Method execution information block
4440d02842fSSascha Wildner * ReturnObject - Object returned from the evaluation of a
4450d02842fSSascha Wildner * method or object
4460d02842fSSascha Wildner *
4470d02842fSSascha Wildner * RETURN: Status
4480d02842fSSascha Wildner *
4490d02842fSSascha Wildner * DESCRIPTION: Check a returned reference object for the correct reference
4500d02842fSSascha Wildner * type. The only reference type that can be returned from a
4510d02842fSSascha Wildner * predefined method is a named reference. All others are invalid.
4520d02842fSSascha Wildner *
4530d02842fSSascha Wildner ******************************************************************************/
4540d02842fSSascha Wildner
4550d02842fSSascha Wildner static ACPI_STATUS
AcpiNsCheckReference(ACPI_EVALUATE_INFO * Info,ACPI_OPERAND_OBJECT * ReturnObject)4560d02842fSSascha Wildner AcpiNsCheckReference (
4570d02842fSSascha Wildner ACPI_EVALUATE_INFO *Info,
4580d02842fSSascha Wildner ACPI_OPERAND_OBJECT *ReturnObject)
4590d02842fSSascha Wildner {
4600d02842fSSascha Wildner
4610d02842fSSascha Wildner /*
4620d02842fSSascha Wildner * Check the reference object for the correct reference type (opcode).
4630d02842fSSascha Wildner * The only type of reference that can be converted to an ACPI_OBJECT is
4640d02842fSSascha Wildner * a reference to a named object (reference class: NAME)
4650d02842fSSascha Wildner */
4660d02842fSSascha Wildner if (ReturnObject->Reference.Class == ACPI_REFCLASS_NAME)
4670d02842fSSascha Wildner {
4680d02842fSSascha Wildner return (AE_OK);
4690d02842fSSascha Wildner }
4700d02842fSSascha Wildner
4710d02842fSSascha Wildner ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
4720d02842fSSascha Wildner "Return type mismatch - unexpected reference object type [%s] %2.2X",
4730d02842fSSascha Wildner AcpiUtGetReferenceName (ReturnObject),
4740d02842fSSascha Wildner ReturnObject->Reference.Class));
4750d02842fSSascha Wildner
4760d02842fSSascha Wildner return (AE_AML_OPERAND_TYPE);
4770d02842fSSascha Wildner }
4780d02842fSSascha Wildner
4790d02842fSSascha Wildner
4800d02842fSSascha Wildner /*******************************************************************************
4810d02842fSSascha Wildner *
4820d02842fSSascha Wildner * FUNCTION: AcpiNsGetBitmappedType
4830d02842fSSascha Wildner *
4840d02842fSSascha Wildner * PARAMETERS: ReturnObject - Object returned from method/obj evaluation
4850d02842fSSascha Wildner *
4860d02842fSSascha Wildner * RETURN: Object return type. ACPI_RTYPE_ANY indicates that the object
4870d02842fSSascha Wildner * type is not supported. ACPI_RTYPE_NONE indicates that no
4880d02842fSSascha Wildner * object was returned (ReturnObject is NULL).
4890d02842fSSascha Wildner *
4900d02842fSSascha Wildner * DESCRIPTION: Convert object type into a bitmapped object return type.
4910d02842fSSascha Wildner *
4920d02842fSSascha Wildner ******************************************************************************/
4930d02842fSSascha Wildner
4940d02842fSSascha Wildner static UINT32
AcpiNsGetBitmappedType(ACPI_OPERAND_OBJECT * ReturnObject)4950d02842fSSascha Wildner AcpiNsGetBitmappedType (
4960d02842fSSascha Wildner ACPI_OPERAND_OBJECT *ReturnObject)
4970d02842fSSascha Wildner {
4980d02842fSSascha Wildner UINT32 ReturnBtype;
4990d02842fSSascha Wildner
5000d02842fSSascha Wildner
5010d02842fSSascha Wildner if (!ReturnObject)
5020d02842fSSascha Wildner {
5030d02842fSSascha Wildner return (ACPI_RTYPE_NONE);
5040d02842fSSascha Wildner }
5050d02842fSSascha Wildner
5060d02842fSSascha Wildner /* Map ACPI_OBJECT_TYPE to internal bitmapped type */
5070d02842fSSascha Wildner
5080d02842fSSascha Wildner switch (ReturnObject->Common.Type)
5090d02842fSSascha Wildner {
5100d02842fSSascha Wildner case ACPI_TYPE_INTEGER:
5110d02842fSSascha Wildner
5120d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_INTEGER;
5130d02842fSSascha Wildner break;
5140d02842fSSascha Wildner
5150d02842fSSascha Wildner case ACPI_TYPE_BUFFER:
5160d02842fSSascha Wildner
5170d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_BUFFER;
5180d02842fSSascha Wildner break;
5190d02842fSSascha Wildner
5200d02842fSSascha Wildner case ACPI_TYPE_STRING:
5210d02842fSSascha Wildner
5220d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_STRING;
5230d02842fSSascha Wildner break;
5240d02842fSSascha Wildner
5250d02842fSSascha Wildner case ACPI_TYPE_PACKAGE:
5260d02842fSSascha Wildner
5270d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_PACKAGE;
5280d02842fSSascha Wildner break;
5290d02842fSSascha Wildner
5300d02842fSSascha Wildner case ACPI_TYPE_LOCAL_REFERENCE:
5310d02842fSSascha Wildner
5320d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_REFERENCE;
5330d02842fSSascha Wildner break;
5340d02842fSSascha Wildner
5350d02842fSSascha Wildner default:
5360d02842fSSascha Wildner
5370d02842fSSascha Wildner /* Not one of the supported objects, must be incorrect */
5380d02842fSSascha Wildner
5390d02842fSSascha Wildner ReturnBtype = ACPI_RTYPE_ANY;
5400d02842fSSascha Wildner break;
5410d02842fSSascha Wildner }
5420d02842fSSascha Wildner
5430d02842fSSascha Wildner return (ReturnBtype);
5440d02842fSSascha Wildner }
545