1aa2aa9a6SDana Myers /******************************************************************************
2aa2aa9a6SDana Myers *
3aa2aa9a6SDana Myers * Module Name: nspredef - Validation of ACPI predefined methods and objects
4aa2aa9a6SDana Myers *
5aa2aa9a6SDana Myers *****************************************************************************/
6aa2aa9a6SDana Myers
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12aa2aa9a6SDana Myers * All rights reserved.
13aa2aa9a6SDana Myers *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
11926f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
12026f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
12126f3cdf0SGordon Ross * are met:
12226f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
12326f3cdf0SGordon Ross * notice, this list of conditions, and the following disclaimer,
12426f3cdf0SGordon Ross * without modification.
12526f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12626f3cdf0SGordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
12726f3cdf0SGordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
12826f3cdf0SGordon Ross * including a substantially similar Disclaimer requirement for further
12926f3cdf0SGordon Ross * binary redistribution.
13026f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
13126f3cdf0SGordon Ross * of any contributors may be used to endorse or promote products derived
13226f3cdf0SGordon Ross * from this software without specific prior written permission.
133aa2aa9a6SDana Myers *
13426f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13526f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
13726f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
151aa2aa9a6SDana Myers
15257190917SDana Myers #define ACPI_CREATE_PREDEFINED_TABLE
153aa2aa9a6SDana Myers
154aa2aa9a6SDana Myers #include "acpi.h"
155aa2aa9a6SDana Myers #include "accommon.h"
156aa2aa9a6SDana Myers #include "acnamesp.h"
157aa2aa9a6SDana Myers #include "acpredef.h"
158aa2aa9a6SDana Myers
159aa2aa9a6SDana Myers
160aa2aa9a6SDana Myers #define _COMPONENT ACPI_NAMESPACE
161aa2aa9a6SDana Myers ACPI_MODULE_NAME ("nspredef")
162aa2aa9a6SDana Myers
163aa2aa9a6SDana Myers
164aa2aa9a6SDana Myers /*******************************************************************************
165aa2aa9a6SDana Myers *
166aa2aa9a6SDana Myers * This module validates predefined ACPI objects that appear in the namespace,
167aa2aa9a6SDana Myers * at the time they are evaluated (via AcpiEvaluateObject). The purpose of this
168aa2aa9a6SDana Myers * validation is to detect problems with BIOS-exposed predefined ACPI objects
169aa2aa9a6SDana Myers * before the results are returned to the ACPI-related drivers.
170aa2aa9a6SDana Myers *
171aa2aa9a6SDana Myers * There are several areas that are validated:
172aa2aa9a6SDana Myers *
173aa2aa9a6SDana Myers * 1) The number of input arguments as defined by the method/object in the
1747b1019a6SJerry Jelinek * ASL is validated against the ACPI specification.
175aa2aa9a6SDana Myers * 2) The type of the return object (if any) is validated against the ACPI
1767b1019a6SJerry Jelinek * specification.
177aa2aa9a6SDana Myers * 3) For returned package objects, the count of package elements is
1787b1019a6SJerry Jelinek * validated, as well as the type of each package element. Nested
1797b1019a6SJerry Jelinek * packages are supported.
180aa2aa9a6SDana Myers *
181aa2aa9a6SDana Myers * For any problems found, a warning message is issued.
182aa2aa9a6SDana Myers *
183aa2aa9a6SDana Myers ******************************************************************************/
184aa2aa9a6SDana Myers
18557190917SDana Myers
186aa2aa9a6SDana Myers /* Local prototypes */
187aa2aa9a6SDana Myers
188aa2aa9a6SDana Myers static ACPI_STATUS
189aa2aa9a6SDana Myers AcpiNsCheckReference (
1907b1019a6SJerry Jelinek ACPI_EVALUATE_INFO *Info,
191aa2aa9a6SDana Myers ACPI_OPERAND_OBJECT *ReturnObject);
192aa2aa9a6SDana Myers
1937b1019a6SJerry Jelinek static UINT32
1947b1019a6SJerry Jelinek AcpiNsGetBitmappedType (
1957b1019a6SJerry Jelinek ACPI_OPERAND_OBJECT *ReturnObject);
196aa2aa9a6SDana Myers
197aa2aa9a6SDana Myers
198aa2aa9a6SDana Myers /*******************************************************************************
199aa2aa9a6SDana Myers *
2007b1019a6SJerry Jelinek * FUNCTION: AcpiNsCheckReturnValue
201aa2aa9a6SDana Myers *
202aa2aa9a6SDana Myers * PARAMETERS: Node - Namespace node for the method/object
2037b1019a6SJerry Jelinek * Info - Method execution information block
20457190917SDana Myers * UserParamCount - Number of parameters actually passed
20557190917SDana Myers * ReturnStatus - Status from the object evaluation
206aa2aa9a6SDana Myers * ReturnObjectPtr - Pointer to the object returned from the
207aa2aa9a6SDana Myers * evaluation of a method or object
208aa2aa9a6SDana Myers *
209aa2aa9a6SDana Myers * RETURN: Status
210aa2aa9a6SDana Myers *
2117b1019a6SJerry Jelinek * DESCRIPTION: Check the value returned from a predefined name.
212aa2aa9a6SDana Myers *
213aa2aa9a6SDana Myers ******************************************************************************/
214aa2aa9a6SDana Myers
215aa2aa9a6SDana Myers ACPI_STATUS
AcpiNsCheckReturnValue(ACPI_NAMESPACE_NODE * Node,ACPI_EVALUATE_INFO * Info,UINT32 UserParamCount,ACPI_STATUS ReturnStatus,ACPI_OPERAND_OBJECT ** ReturnObjectPtr)2167b1019a6SJerry Jelinek AcpiNsCheckReturnValue (
217aa2aa9a6SDana Myers ACPI_NAMESPACE_NODE *Node,
2187b1019a6SJerry Jelinek ACPI_EVALUATE_INFO *Info,
219aa2aa9a6SDana Myers UINT32 UserParamCount,
220aa2aa9a6SDana Myers ACPI_STATUS ReturnStatus,
221aa2aa9a6SDana Myers ACPI_OPERAND_OBJECT **ReturnObjectPtr)
222aa2aa9a6SDana Myers {
2237b1019a6SJerry Jelinek ACPI_STATUS Status;
224aa2aa9a6SDana Myers const ACPI_PREDEFINED_INFO *Predefined;
225aa2aa9a6SDana Myers
226aa2aa9a6SDana Myers
227aa2aa9a6SDana Myers /* If not a predefined name, we cannot validate the return object */
228aa2aa9a6SDana Myers
2297b1019a6SJerry Jelinek Predefined = Info->Predefined;
230aa2aa9a6SDana Myers if (!Predefined)
231aa2aa9a6SDana Myers {
2327b1019a6SJerry Jelinek return (AE_OK);
233aa2aa9a6SDana Myers }
234aa2aa9a6SDana Myers
235aa2aa9a6SDana Myers /*
23657190917SDana Myers * If the method failed or did not actually return an object, we cannot
23757190917SDana Myers * validate the return object
238aa2aa9a6SDana Myers */
2397b1019a6SJerry Jelinek if ((ReturnStatus != AE_OK) &&
2407b1019a6SJerry Jelinek (ReturnStatus != AE_CTRL_RETURN_VALUE))
241aa2aa9a6SDana Myers {
2427b1019a6SJerry Jelinek return (AE_OK);
243aa2aa9a6SDana Myers }
244aa2aa9a6SDana Myers
245aa2aa9a6SDana Myers /*
2467b1019a6SJerry Jelinek * Return value validation and possible repair.
247aa2aa9a6SDana Myers *
2487b1019a6SJerry Jelinek * 1) Don't perform return value validation/repair if this feature
2497b1019a6SJerry Jelinek * has been disabled via a global option.
250aa2aa9a6SDana Myers *
2517b1019a6SJerry Jelinek * 2) We have a return value, but if one wasn't expected, just exit,
2527b1019a6SJerry Jelinek * this is not a problem. For example, if the "Implicit Return"
2537b1019a6SJerry Jelinek * feature is enabled, methods will always return a value.
2547b1019a6SJerry Jelinek *
2557b1019a6SJerry Jelinek * 3) If the return value can be of any type, then we cannot perform
2567b1019a6SJerry Jelinek * any validation, just exit.
257aa2aa9a6SDana Myers */
2587b1019a6SJerry Jelinek if (AcpiGbl_DisableAutoRepair ||
2597b1019a6SJerry Jelinek (!Predefined->Info.ExpectedBtypes) ||
26057190917SDana Myers (Predefined->Info.ExpectedBtypes == ACPI_RTYPE_ALL))
261aa2aa9a6SDana Myers {
2627b1019a6SJerry Jelinek return (AE_OK);
26357190917SDana Myers }
26457190917SDana Myers
265aa2aa9a6SDana Myers /*
26626f3cdf0SGordon Ross * Check that the type of the main return object is what is expected
26726f3cdf0SGordon Ross * for this predefined name
268aa2aa9a6SDana Myers */
2697b1019a6SJerry Jelinek Status = AcpiNsCheckObjectType (Info, ReturnObjectPtr,
2707b1019a6SJerry Jelinek Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
271aa2aa9a6SDana Myers if (ACPI_FAILURE (Status))
272aa2aa9a6SDana Myers {
27326f3cdf0SGordon Ross goto Exit;
274aa2aa9a6SDana Myers }
275aa2aa9a6SDana Myers
2767b1019a6SJerry Jelinek /*
2777b1019a6SJerry Jelinek *
2787b1019a6SJerry Jelinek * 4) If there is no return value and it is optional, just return
2797b1019a6SJerry Jelinek * AE_OK (_WAK).
2807b1019a6SJerry Jelinek */
2817b1019a6SJerry Jelinek if (!(*ReturnObjectPtr))
2827b1019a6SJerry Jelinek {
2837b1019a6SJerry Jelinek goto Exit;
2847b1019a6SJerry Jelinek }
2857b1019a6SJerry Jelinek
28626f3cdf0SGordon Ross /*
28726f3cdf0SGordon Ross * For returned Package objects, check the type of all sub-objects.
28826f3cdf0SGordon Ross * Note: Package may have been newly created by call above.
28926f3cdf0SGordon Ross */
29026f3cdf0SGordon Ross if ((*ReturnObjectPtr)->Common.Type == ACPI_TYPE_PACKAGE)
291aa2aa9a6SDana Myers {
2927b1019a6SJerry Jelinek Info->ParentPackage = *ReturnObjectPtr;
2937b1019a6SJerry Jelinek Status = AcpiNsCheckPackage (Info, ReturnObjectPtr);
29426f3cdf0SGordon Ross if (ACPI_FAILURE (Status))
29526f3cdf0SGordon Ross {
2967b1019a6SJerry Jelinek /* We might be able to fix some errors */
2977b1019a6SJerry Jelinek
2987b1019a6SJerry Jelinek if ((Status != AE_AML_OPERAND_TYPE) &&
2997b1019a6SJerry Jelinek (Status != AE_AML_OPERAND_VALUE))
3007b1019a6SJerry Jelinek {
3017b1019a6SJerry Jelinek goto Exit;
3027b1019a6SJerry Jelinek }
30326f3cdf0SGordon Ross }
30457190917SDana Myers }
30557190917SDana Myers
30657190917SDana Myers /*
30726f3cdf0SGordon Ross * The return object was OK, or it was successfully repaired above.
30826f3cdf0SGordon Ross * Now make some additional checks such as verifying that package
30926f3cdf0SGordon Ross * objects are sorted correctly (if required) or buffer objects have
31026f3cdf0SGordon Ross * the correct data width (bytes vs. dwords). These repairs are
31126f3cdf0SGordon Ross * performed on a per-name basis, i.e., the code is specific to
31226f3cdf0SGordon Ross * particular predefined names.
31357190917SDana Myers */
3147b1019a6SJerry Jelinek Status = AcpiNsComplexRepairs (Info, Node, Status, ReturnObjectPtr);
31557190917SDana Myers
31626f3cdf0SGordon Ross Exit:
31757190917SDana Myers /*
31857190917SDana Myers * If the object validation failed or if we successfully repaired one
31957190917SDana Myers * or more objects, mark the parent node to suppress further warning
32057190917SDana Myers * messages during the next evaluation of the same method/object.
32157190917SDana Myers */
3227b1019a6SJerry Jelinek if (ACPI_FAILURE (Status) ||
3237b1019a6SJerry Jelinek (Info->ReturnFlags & ACPI_OBJECT_REPAIRED))
32457190917SDana Myers {
32557190917SDana Myers Node->Flags |= ANOBJ_EVALUATED;
326aa2aa9a6SDana Myers }
32757190917SDana Myers
328aa2aa9a6SDana Myers return (Status);
329aa2aa9a6SDana Myers }
330aa2aa9a6SDana Myers
331aa2aa9a6SDana Myers
332aa2aa9a6SDana Myers /*******************************************************************************
333aa2aa9a6SDana Myers *
334aa2aa9a6SDana Myers * FUNCTION: AcpiNsCheckObjectType
335aa2aa9a6SDana Myers *
3367b1019a6SJerry Jelinek * PARAMETERS: Info - Method execution information block
337aa2aa9a6SDana Myers * ReturnObjectPtr - Pointer to the object returned from the
338aa2aa9a6SDana Myers * evaluation of a method or object
339aa2aa9a6SDana Myers * ExpectedBtypes - Bitmap of expected return type(s)
340aa2aa9a6SDana Myers * PackageIndex - Index of object within parent package (if
34157190917SDana Myers * applicable - ACPI_NOT_PACKAGE_ELEMENT
34257190917SDana Myers * otherwise)
343aa2aa9a6SDana Myers *
344aa2aa9a6SDana Myers * RETURN: Status
345aa2aa9a6SDana Myers *
346aa2aa9a6SDana Myers * DESCRIPTION: Check the type of the return object against the expected object
347aa2aa9a6SDana Myers * type(s). Use of Btype allows multiple expected object types.
348aa2aa9a6SDana Myers *
349aa2aa9a6SDana Myers ******************************************************************************/
350aa2aa9a6SDana Myers
3517b1019a6SJerry Jelinek ACPI_STATUS
AcpiNsCheckObjectType(ACPI_EVALUATE_INFO * Info,ACPI_OPERAND_OBJECT ** ReturnObjectPtr,UINT32 ExpectedBtypes,UINT32 PackageIndex)352aa2aa9a6SDana Myers AcpiNsCheckObjectType (
3537b1019a6SJerry Jelinek ACPI_EVALUATE_INFO *Info,
354aa2aa9a6SDana Myers ACPI_OPERAND_OBJECT **ReturnObjectPtr,
355aa2aa9a6SDana Myers UINT32 ExpectedBtypes,
356aa2aa9a6SDana Myers UINT32 PackageIndex)
357aa2aa9a6SDana Myers {
358aa2aa9a6SDana Myers ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
359aa2aa9a6SDana Myers ACPI_STATUS Status = AE_OK;
3607b1019a6SJerry Jelinek char TypeBuffer[96]; /* Room for 10 types */
361aa2aa9a6SDana Myers
362aa2aa9a6SDana Myers
363aa2aa9a6SDana Myers /* A Namespace node should not get here, but make sure */
364aa2aa9a6SDana Myers
3657b1019a6SJerry Jelinek if (ReturnObject &&
3667b1019a6SJerry Jelinek ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED)
367aa2aa9a6SDana Myers {
3687b1019a6SJerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
36957190917SDana Myers "Invalid return type - Found a Namespace node [%4.4s] type %s",
37057190917SDana Myers ReturnObject->Node.Name.Ascii,
371aa2aa9a6SDana Myers AcpiUtGetTypeName (ReturnObject->Node.Type)));
372aa2aa9a6SDana Myers return (AE_AML_OPERAND_TYPE);
373aa2aa9a6SDana Myers }
374aa2aa9a6SDana Myers
375aa2aa9a6SDana Myers /*
376aa2aa9a6SDana Myers * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
377aa2aa9a6SDana Myers * The bitmapped type allows multiple possible return types.
378aa2aa9a6SDana Myers *
379aa2aa9a6SDana Myers * Note, the cases below must handle all of the possible types returned
380aa2aa9a6SDana Myers * from all of the predefined names (including elements of returned
381aa2aa9a6SDana Myers * packages)
382aa2aa9a6SDana Myers */
3837b1019a6SJerry Jelinek Info->ReturnBtype = AcpiNsGetBitmappedType (ReturnObject);
3847b1019a6SJerry Jelinek if (Info->ReturnBtype == ACPI_RTYPE_ANY)
385aa2aa9a6SDana Myers {
386aa2aa9a6SDana Myers /* Not one of the supported objects, must be incorrect */
387aa2aa9a6SDana Myers goto TypeErrorExit;
388aa2aa9a6SDana Myers }
389aa2aa9a6SDana Myers
3907b1019a6SJerry Jelinek /* For reference objects, check that the reference type is correct */
391aa2aa9a6SDana Myers
3927b1019a6SJerry Jelinek if ((Info->ReturnBtype & ExpectedBtypes) == ACPI_RTYPE_REFERENCE)
393aa2aa9a6SDana Myers {
3947b1019a6SJerry Jelinek Status = AcpiNsCheckReference (Info, ReturnObject);
39526f3cdf0SGordon Ross return (Status);
396aa2aa9a6SDana Myers }
397aa2aa9a6SDana Myers
3987b1019a6SJerry Jelinek /* Attempt simple repair of the returned object if necessary */
399aa2aa9a6SDana Myers
4007b1019a6SJerry Jelinek Status = AcpiNsSimpleRepair (Info, ExpectedBtypes,
4017b1019a6SJerry Jelinek PackageIndex, ReturnObjectPtr);
40226f3cdf0SGordon Ross if (ACPI_SUCCESS (Status))
403aa2aa9a6SDana Myers {
4047b1019a6SJerry Jelinek return (AE_OK); /* Successful repair */
405aa2aa9a6SDana Myers }
406aa2aa9a6SDana Myers
407aa2aa9a6SDana Myers
408aa2aa9a6SDana Myers TypeErrorExit:
409aa2aa9a6SDana Myers
410aa2aa9a6SDana Myers /* Create a string with all expected types for this predefined object */
411aa2aa9a6SDana Myers
4127b1019a6SJerry Jelinek AcpiUtGetExpectedReturnTypes (TypeBuffer, ExpectedBtypes);
413aa2aa9a6SDana Myers
4147b1019a6SJerry Jelinek if (!ReturnObject)
4157b1019a6SJerry Jelinek {
4167b1019a6SJerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
4177b1019a6SJerry Jelinek "Expected return object of type %s",
4187b1019a6SJerry Jelinek TypeBuffer));
4197b1019a6SJerry Jelinek }
4207b1019a6SJerry Jelinek else if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT)
421aa2aa9a6SDana Myers {
4227b1019a6SJerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
42357190917SDana Myers "Return type mismatch - found %s, expected %s",
42457190917SDana Myers AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
425aa2aa9a6SDana Myers }
426aa2aa9a6SDana Myers else
427aa2aa9a6SDana Myers {
4287b1019a6SJerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
42957190917SDana Myers "Return Package type mismatch at index %u - "
43057190917SDana Myers "found %s, expected %s", PackageIndex,
431aa2aa9a6SDana Myers AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
432aa2aa9a6SDana Myers }
433aa2aa9a6SDana Myers
434aa2aa9a6SDana Myers return (AE_AML_OPERAND_TYPE);
435aa2aa9a6SDana Myers }
436aa2aa9a6SDana Myers
437aa2aa9a6SDana Myers
438aa2aa9a6SDana Myers /*******************************************************************************
439aa2aa9a6SDana Myers *
440aa2aa9a6SDana Myers * FUNCTION: AcpiNsCheckReference
441aa2aa9a6SDana Myers *
4427b1019a6SJerry Jelinek * PARAMETERS: Info - Method execution information block
443aa2aa9a6SDana Myers * ReturnObject - Object returned from the evaluation of a
444aa2aa9a6SDana Myers * method or object
445aa2aa9a6SDana Myers *
446aa2aa9a6SDana Myers * RETURN: Status
447aa2aa9a6SDana Myers *
448aa2aa9a6SDana Myers * DESCRIPTION: Check a returned reference object for the correct reference
449aa2aa9a6SDana Myers * type. The only reference type that can be returned from a
450aa2aa9a6SDana Myers * predefined method is a named reference. All others are invalid.
451aa2aa9a6SDana Myers *
452aa2aa9a6SDana Myers ******************************************************************************/
453aa2aa9a6SDana Myers
454aa2aa9a6SDana Myers static ACPI_STATUS
AcpiNsCheckReference(ACPI_EVALUATE_INFO * Info,ACPI_OPERAND_OBJECT * ReturnObject)455aa2aa9a6SDana Myers AcpiNsCheckReference (
4567b1019a6SJerry Jelinek ACPI_EVALUATE_INFO *Info,
457aa2aa9a6SDana Myers ACPI_OPERAND_OBJECT *ReturnObject)
458aa2aa9a6SDana Myers {
459aa2aa9a6SDana Myers
460aa2aa9a6SDana Myers /*
461aa2aa9a6SDana Myers * Check the reference object for the correct reference type (opcode).
462aa2aa9a6SDana Myers * The only type of reference that can be converted to an ACPI_OBJECT is
463aa2aa9a6SDana Myers * a reference to a named object (reference class: NAME)
464aa2aa9a6SDana Myers */
465aa2aa9a6SDana Myers if (ReturnObject->Reference.Class == ACPI_REFCLASS_NAME)
466aa2aa9a6SDana Myers {
467aa2aa9a6SDana Myers return (AE_OK);
468aa2aa9a6SDana Myers }
469aa2aa9a6SDana Myers
4707b1019a6SJerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
47157190917SDana Myers "Return type mismatch - unexpected reference object type [%s] %2.2X",
47257190917SDana Myers AcpiUtGetReferenceName (ReturnObject),
473aa2aa9a6SDana Myers ReturnObject->Reference.Class));
474aa2aa9a6SDana Myers
475aa2aa9a6SDana Myers return (AE_AML_OPERAND_TYPE);
476aa2aa9a6SDana Myers }
477aa2aa9a6SDana Myers
478aa2aa9a6SDana Myers
479aa2aa9a6SDana Myers /*******************************************************************************
480aa2aa9a6SDana Myers *
4817b1019a6SJerry Jelinek * FUNCTION: AcpiNsGetBitmappedType
482aa2aa9a6SDana Myers *
4837b1019a6SJerry Jelinek * PARAMETERS: ReturnObject - Object returned from method/obj evaluation
484aa2aa9a6SDana Myers *
4857b1019a6SJerry Jelinek * RETURN: Object return type. ACPI_RTYPE_ANY indicates that the object
4867b1019a6SJerry Jelinek * type is not supported. ACPI_RTYPE_NONE indicates that no
4877b1019a6SJerry Jelinek * object was returned (ReturnObject is NULL).
488aa2aa9a6SDana Myers *
4897b1019a6SJerry Jelinek * DESCRIPTION: Convert object type into a bitmapped object return type.
490aa2aa9a6SDana Myers *
491aa2aa9a6SDana Myers ******************************************************************************/
492aa2aa9a6SDana Myers
4937b1019a6SJerry Jelinek static UINT32
AcpiNsGetBitmappedType(ACPI_OPERAND_OBJECT * ReturnObject)4947b1019a6SJerry Jelinek AcpiNsGetBitmappedType (
4957b1019a6SJerry Jelinek ACPI_OPERAND_OBJECT *ReturnObject)
496aa2aa9a6SDana Myers {
4977b1019a6SJerry Jelinek UINT32 ReturnBtype;
498aa2aa9a6SDana Myers
499aa2aa9a6SDana Myers
5007b1019a6SJerry Jelinek if (!ReturnObject)
5017b1019a6SJerry Jelinek {
5027b1019a6SJerry Jelinek return (ACPI_RTYPE_NONE);
5037b1019a6SJerry Jelinek }
5047b1019a6SJerry Jelinek
5057b1019a6SJerry Jelinek /* Map ACPI_OBJECT_TYPE to internal bitmapped type */
506aa2aa9a6SDana Myers
5077b1019a6SJerry Jelinek switch (ReturnObject->Common.Type)
50857190917SDana Myers {
5097b1019a6SJerry Jelinek case ACPI_TYPE_INTEGER:
510aa2aa9a6SDana Myers
5117b1019a6SJerry Jelinek ReturnBtype = ACPI_RTYPE_INTEGER;
5127b1019a6SJerry Jelinek break;
5137b1019a6SJerry Jelinek
5147b1019a6SJerry Jelinek case ACPI_TYPE_BUFFER:
5157b1019a6SJerry Jelinek
5167b1019a6SJerry Jelinek ReturnBtype = ACPI_RTYPE_BUFFER;
5177b1019a6SJerry Jelinek break;
5187b1019a6SJerry Jelinek
5197b1019a6SJerry Jelinek case ACPI_TYPE_STRING:
5207b1019a6SJerry Jelinek
5217b1019a6SJerry Jelinek ReturnBtype = ACPI_RTYPE_STRING;
5227b1019a6SJerry Jelinek break;
5237b1019a6SJerry Jelinek
5247b1019a6SJerry Jelinek case ACPI_TYPE_PACKAGE:
5257b1019a6SJerry Jelinek
5267b1019a6SJerry Jelinek ReturnBtype = ACPI_RTYPE_PACKAGE;
5277b1019a6SJerry Jelinek break;
5287b1019a6SJerry Jelinek
5297b1019a6SJerry Jelinek case ACPI_TYPE_LOCAL_REFERENCE:
5307b1019a6SJerry Jelinek
5317b1019a6SJerry Jelinek ReturnBtype = ACPI_RTYPE_REFERENCE;
5327b1019a6SJerry Jelinek break;
5337b1019a6SJerry Jelinek
5347b1019a6SJerry Jelinek default:
5357b1019a6SJerry Jelinek
5367b1019a6SJerry Jelinek /* Not one of the supported objects, must be incorrect */
5377b1019a6SJerry Jelinek
5387b1019a6SJerry Jelinek ReturnBtype = ACPI_RTYPE_ANY;
5397b1019a6SJerry Jelinek break;
540aa2aa9a6SDana Myers }
5417b1019a6SJerry Jelinek
5427b1019a6SJerry Jelinek return (ReturnBtype);
543aa2aa9a6SDana Myers }
544