xref: /illumos-gate/usr/src/cmd/acpi/iasl/aslprepkg.c (revision 35786f68)
1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts  *
3bc36eafdSMike Gerdts  * Module Name: aslprepkg - support for ACPI predefined name package objects
4bc36eafdSMike Gerdts  *
5bc36eafdSMike Gerdts  *****************************************************************************/
6bc36eafdSMike Gerdts 
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.
12bc36eafdSMike Gerdts  * All rights reserved.
13bc36eafdSMike Gerdts  *
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  *
119bc36eafdSMike Gerdts  * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts  * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts  * are met:
122bc36eafdSMike Gerdts  * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts  *    notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts  *    without modification.
125bc36eafdSMike Gerdts  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts  *    substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts  *    ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts  *    including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts  *    binary redistribution.
130bc36eafdSMike Gerdts  * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts  *    of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts  *    from this software without specific prior written permission.
133bc36eafdSMike Gerdts  *
134bc36eafdSMike Gerdts  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135bc36eafdSMike Gerdts  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137bc36eafdSMike Gerdts  * 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  *****************************************************************************/
151bc36eafdSMike Gerdts 
152bc36eafdSMike Gerdts #include "aslcompiler.h"
153bc36eafdSMike Gerdts #include "aslcompiler.y.h"
154bc36eafdSMike Gerdts #include "acpredef.h"
155bc36eafdSMike Gerdts 
156bc36eafdSMike Gerdts 
157bc36eafdSMike Gerdts #define _COMPONENT          ACPI_COMPILER
158bc36eafdSMike Gerdts         ACPI_MODULE_NAME    ("aslprepkg")
159bc36eafdSMike Gerdts 
160bc36eafdSMike Gerdts 
161bc36eafdSMike Gerdts /* Local prototypes */
162bc36eafdSMike Gerdts 
163bc36eafdSMike Gerdts static ACPI_PARSE_OBJECT *
164bc36eafdSMike Gerdts ApCheckPackageElements (
165bc36eafdSMike Gerdts     const char                  *PredefinedName,
166bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op,
167bc36eafdSMike Gerdts     UINT8                       Type1,
168bc36eafdSMike Gerdts     UINT32                      Count1,
169bc36eafdSMike Gerdts     UINT8                       Type2,
170bc36eafdSMike Gerdts     UINT32                      Count2);
171bc36eafdSMike Gerdts 
172bc36eafdSMike Gerdts static void
173bc36eafdSMike Gerdts ApCheckPackageList (
174bc36eafdSMike Gerdts     const char                  *PredefinedName,
175bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *ParentOp,
176bc36eafdSMike Gerdts     const ACPI_PREDEFINED_INFO  *Package,
177bc36eafdSMike Gerdts     UINT32                      StartIndex,
178bc36eafdSMike Gerdts     UINT32                      Count);
179bc36eafdSMike Gerdts 
180bc36eafdSMike Gerdts static void
181bc36eafdSMike Gerdts ApPackageTooSmall (
182bc36eafdSMike Gerdts     const char                  *PredefinedName,
183bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op,
184bc36eafdSMike Gerdts     UINT32                      Count,
185bc36eafdSMike Gerdts     UINT32                      ExpectedCount);
186bc36eafdSMike Gerdts 
187bc36eafdSMike Gerdts static void
188bc36eafdSMike Gerdts ApZeroLengthPackage (
189bc36eafdSMike Gerdts     const char                  *PredefinedName,
190bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op);
191bc36eafdSMike Gerdts 
192bc36eafdSMike Gerdts static void
193bc36eafdSMike Gerdts ApPackageTooLarge (
194bc36eafdSMike Gerdts     const char                  *PredefinedName,
195bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op,
196bc36eafdSMike Gerdts     UINT32                      Count,
197bc36eafdSMike Gerdts     UINT32                      ExpectedCount);
198bc36eafdSMike Gerdts 
199bc36eafdSMike Gerdts static void
200bc36eafdSMike Gerdts ApCustomPackage (
201bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *ParentOp,
202bc36eafdSMike Gerdts     const ACPI_PREDEFINED_INFO  *Predefined);
203bc36eafdSMike Gerdts 
204bc36eafdSMike Gerdts 
205bc36eafdSMike Gerdts /*******************************************************************************
206bc36eafdSMike Gerdts  *
207bc36eafdSMike Gerdts  * FUNCTION:    ApCheckPackage
208bc36eafdSMike Gerdts  *
209bc36eafdSMike Gerdts  * PARAMETERS:  ParentOp            - Parser op for the package
210bc36eafdSMike Gerdts  *              Predefined          - Pointer to package-specific info for
211bc36eafdSMike Gerdts  *                                    the method
212bc36eafdSMike Gerdts  *
213bc36eafdSMike Gerdts  * RETURN:      None
214bc36eafdSMike Gerdts  *
215bc36eafdSMike Gerdts  * DESCRIPTION: Top-level validation for predefined name return package
216bc36eafdSMike Gerdts  *              objects.
217bc36eafdSMike Gerdts  *
218bc36eafdSMike Gerdts  ******************************************************************************/
219bc36eafdSMike Gerdts 
220bc36eafdSMike Gerdts void
ApCheckPackage(ACPI_PARSE_OBJECT * ParentOp,const ACPI_PREDEFINED_INFO * Predefined)221bc36eafdSMike Gerdts ApCheckPackage (
222bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *ParentOp,
223bc36eafdSMike Gerdts     const ACPI_PREDEFINED_INFO  *Predefined)
224bc36eafdSMike Gerdts {
225bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op;
226bc36eafdSMike Gerdts     const ACPI_PREDEFINED_INFO  *Package;
227bc36eafdSMike Gerdts     ACPI_STATUS                 Status;
228bc36eafdSMike Gerdts     UINT32                      ExpectedCount;
229bc36eafdSMike Gerdts     UINT32                      Count;
230bc36eafdSMike Gerdts     UINT32                      i;
231bc36eafdSMike Gerdts 
232bc36eafdSMike Gerdts 
233bc36eafdSMike Gerdts     /* The package info for this name is in the next table entry */
234bc36eafdSMike Gerdts 
235bc36eafdSMike Gerdts     Package = Predefined + 1;
236bc36eafdSMike Gerdts 
237bc36eafdSMike Gerdts     /* First child is the package length */
238bc36eafdSMike Gerdts 
239bc36eafdSMike Gerdts     Op = ParentOp->Asl.Child;
240bc36eafdSMike Gerdts     Count = (UINT32) Op->Asl.Value.Integer;
241bc36eafdSMike Gerdts 
242bc36eafdSMike Gerdts     /*
243bc36eafdSMike Gerdts      * Many of the variable-length top-level packages are allowed to simply
244bc36eafdSMike Gerdts      * have zero elements. This allows the BIOS to tell the host that even
245bc36eafdSMike Gerdts      * though the predefined name/method exists, the feature is not supported.
246bc36eafdSMike Gerdts      * Other package types require one or more elements. In any case, there
247bc36eafdSMike Gerdts      * is no need to continue validation.
248bc36eafdSMike Gerdts      */
249bc36eafdSMike Gerdts     if (!Count)
250bc36eafdSMike Gerdts     {
251bc36eafdSMike Gerdts         switch (Package->RetInfo.Type)
252bc36eafdSMike Gerdts         {
253bc36eafdSMike Gerdts         case ACPI_PTYPE1_FIXED:
254bc36eafdSMike Gerdts         case ACPI_PTYPE1_OPTION:
255bc36eafdSMike Gerdts         case ACPI_PTYPE2_PKG_COUNT:
256bc36eafdSMike Gerdts         case ACPI_PTYPE2_REV_FIXED:
257bc36eafdSMike Gerdts 
258bc36eafdSMike Gerdts             ApZeroLengthPackage (Predefined->Info.Name, ParentOp);
259bc36eafdSMike Gerdts             break;
260bc36eafdSMike Gerdts 
261bc36eafdSMike Gerdts         case ACPI_PTYPE1_VAR:
262bc36eafdSMike Gerdts         case ACPI_PTYPE2:
263bc36eafdSMike Gerdts         case ACPI_PTYPE2_COUNT:
264bc36eafdSMike Gerdts         case ACPI_PTYPE2_FIXED:
265bc36eafdSMike Gerdts         case ACPI_PTYPE2_MIN:
266bc36eafdSMike Gerdts         case ACPI_PTYPE2_FIX_VAR:
267bc36eafdSMike Gerdts         case ACPI_PTYPE2_VAR_VAR:
268bc36eafdSMike Gerdts         default:
269bc36eafdSMike Gerdts 
270bc36eafdSMike Gerdts             break;
271bc36eafdSMike Gerdts         }
272bc36eafdSMike Gerdts 
273bc36eafdSMike Gerdts         return;
274bc36eafdSMike Gerdts     }
275bc36eafdSMike Gerdts 
276bc36eafdSMike Gerdts     /* Get the first element of the package */
277bc36eafdSMike Gerdts 
278bc36eafdSMike Gerdts     Op = Op->Asl.Next;
279bc36eafdSMike Gerdts 
280bc36eafdSMike Gerdts     /* Decode the package type */
281bc36eafdSMike Gerdts 
282bc36eafdSMike Gerdts     switch (Package->RetInfo.Type)
283bc36eafdSMike Gerdts     {
284bc36eafdSMike Gerdts     case ACPI_PTYPE_CUSTOM:
285bc36eafdSMike Gerdts 
286bc36eafdSMike Gerdts         ApCustomPackage (ParentOp, Predefined);
287bc36eafdSMike Gerdts         break;
288bc36eafdSMike Gerdts 
289bc36eafdSMike Gerdts     case ACPI_PTYPE1_FIXED:
290bc36eafdSMike Gerdts         /*
291bc36eafdSMike Gerdts          * The package count is fixed and there are no subpackages
292bc36eafdSMike Gerdts          *
293bc36eafdSMike Gerdts          * If package is too small, exit.
294bc36eafdSMike Gerdts          * If package is larger than expected, issue warning but continue
295bc36eafdSMike Gerdts          */
296bc36eafdSMike Gerdts         ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
297bc36eafdSMike Gerdts         if (Count < ExpectedCount)
298bc36eafdSMike Gerdts         {
299bc36eafdSMike Gerdts             goto PackageTooSmall;
300bc36eafdSMike Gerdts         }
301bc36eafdSMike Gerdts         else if (Count > ExpectedCount)
302bc36eafdSMike Gerdts         {
303bc36eafdSMike Gerdts             ApPackageTooLarge (Predefined->Info.Name, ParentOp,
304bc36eafdSMike Gerdts                 Count, ExpectedCount);
305bc36eafdSMike Gerdts         }
306bc36eafdSMike Gerdts 
307bc36eafdSMike Gerdts         /* Validate all elements of the package */
308bc36eafdSMike Gerdts 
309bc36eafdSMike Gerdts         ApCheckPackageElements (Predefined->Info.Name, Op,
310bc36eafdSMike Gerdts             Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
311bc36eafdSMike Gerdts             Package->RetInfo.ObjectType2, Package->RetInfo.Count2);
312bc36eafdSMike Gerdts         break;
313bc36eafdSMike Gerdts 
314bc36eafdSMike Gerdts     case ACPI_PTYPE1_VAR:
315bc36eafdSMike Gerdts         /*
316bc36eafdSMike Gerdts          * The package count is variable, there are no subpackages,
317bc36eafdSMike Gerdts          * and all elements must be of the same type
318bc36eafdSMike Gerdts          */
319bc36eafdSMike Gerdts         for (i = 0; i < Count; i++)
320bc36eafdSMike Gerdts         {
321bc36eafdSMike Gerdts             ApCheckObjectType (Predefined->Info.Name, Op,
322bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType1, i);
323bc36eafdSMike Gerdts             Op = Op->Asl.Next;
324bc36eafdSMike Gerdts         }
325bc36eafdSMike Gerdts         break;
326bc36eafdSMike Gerdts 
327bc36eafdSMike Gerdts     case ACPI_PTYPE1_OPTION:
328bc36eafdSMike Gerdts         /*
329bc36eafdSMike Gerdts          * The package count is variable, there are no subpackages.
330bc36eafdSMike Gerdts          * There are a fixed number of required elements, and a variable
331bc36eafdSMike Gerdts          * number of optional elements.
332bc36eafdSMike Gerdts          *
333bc36eafdSMike Gerdts          * Check if package is at least as large as the minimum required
334bc36eafdSMike Gerdts          */
335bc36eafdSMike Gerdts         ExpectedCount = Package->RetInfo3.Count;
336bc36eafdSMike Gerdts         if (Count < ExpectedCount)
337bc36eafdSMike Gerdts         {
338bc36eafdSMike Gerdts             goto PackageTooSmall;
339bc36eafdSMike Gerdts         }
340bc36eafdSMike Gerdts 
341bc36eafdSMike Gerdts         /* Variable number of sub-objects */
342bc36eafdSMike Gerdts 
343bc36eafdSMike Gerdts         for (i = 0; i < Count; i++)
344bc36eafdSMike Gerdts         {
345bc36eafdSMike Gerdts             if (i < Package->RetInfo3.Count)
346bc36eafdSMike Gerdts             {
347bc36eafdSMike Gerdts                 /* These are the required package elements (0, 1, or 2) */
348bc36eafdSMike Gerdts 
349bc36eafdSMike Gerdts                 ApCheckObjectType (Predefined->Info.Name, Op,
350bc36eafdSMike Gerdts                     Package->RetInfo3.ObjectType[i], i);
351bc36eafdSMike Gerdts             }
352bc36eafdSMike Gerdts             else
353bc36eafdSMike Gerdts             {
354bc36eafdSMike Gerdts                 /* These are the optional package elements */
355bc36eafdSMike Gerdts 
356bc36eafdSMike Gerdts                 ApCheckObjectType (Predefined->Info.Name, Op,
357bc36eafdSMike Gerdts                     Package->RetInfo3.TailObjectType, i);
358bc36eafdSMike Gerdts             }
359bc36eafdSMike Gerdts 
360bc36eafdSMike Gerdts             Op = Op->Asl.Next;
361bc36eafdSMike Gerdts         }
362bc36eafdSMike Gerdts         break;
363bc36eafdSMike Gerdts 
364bc36eafdSMike Gerdts     case ACPI_PTYPE2_REV_FIXED:
365bc36eafdSMike Gerdts 
366bc36eafdSMike Gerdts         /* First element is the (Integer) revision */
367bc36eafdSMike Gerdts 
368bc36eafdSMike Gerdts         ApCheckObjectType (Predefined->Info.Name, Op,
369bc36eafdSMike Gerdts             ACPI_RTYPE_INTEGER, 0);
370bc36eafdSMike Gerdts 
371bc36eafdSMike Gerdts         Op = Op->Asl.Next;
372bc36eafdSMike Gerdts         Count--;
373bc36eafdSMike Gerdts 
374bc36eafdSMike Gerdts         /* Examine the subpackages */
375bc36eafdSMike Gerdts 
376bc36eafdSMike Gerdts         ApCheckPackageList (Predefined->Info.Name, Op,
377bc36eafdSMike Gerdts             Package, 1, Count);
378bc36eafdSMike Gerdts         break;
379bc36eafdSMike Gerdts 
380bc36eafdSMike Gerdts     case ACPI_PTYPE2_PKG_COUNT:
381bc36eafdSMike Gerdts 
382bc36eafdSMike Gerdts         /* First element is the (Integer) count of subpackages to follow */
383bc36eafdSMike Gerdts 
384bc36eafdSMike Gerdts         Status = ApCheckObjectType (Predefined->Info.Name, Op,
385bc36eafdSMike Gerdts             ACPI_RTYPE_INTEGER, 0);
386bc36eafdSMike Gerdts 
387bc36eafdSMike Gerdts         /* We must have an integer count from above (otherwise, use Count) */
388bc36eafdSMike Gerdts 
389bc36eafdSMike Gerdts         if (ACPI_SUCCESS (Status))
390bc36eafdSMike Gerdts         {
391bc36eafdSMike Gerdts             /*
392bc36eafdSMike Gerdts              * Count cannot be larger than the parent package length, but
393bc36eafdSMike Gerdts              * allow it to be smaller. The >= accounts for the Integer above.
394bc36eafdSMike Gerdts              */
395bc36eafdSMike Gerdts             ExpectedCount = (UINT32) Op->Asl.Value.Integer;
396bc36eafdSMike Gerdts             if (ExpectedCount >= Count)
397bc36eafdSMike Gerdts             {
398bc36eafdSMike Gerdts                 goto PackageTooSmall;
399bc36eafdSMike Gerdts             }
400bc36eafdSMike Gerdts 
401bc36eafdSMike Gerdts             Count = ExpectedCount;
402bc36eafdSMike Gerdts         }
403bc36eafdSMike Gerdts 
404bc36eafdSMike Gerdts         Op = Op->Asl.Next;
405bc36eafdSMike Gerdts 
406bc36eafdSMike Gerdts         /* Examine the subpackages */
407bc36eafdSMike Gerdts 
408bc36eafdSMike Gerdts         ApCheckPackageList (Predefined->Info.Name, Op,
409bc36eafdSMike Gerdts             Package, 1, Count);
410bc36eafdSMike Gerdts         break;
411bc36eafdSMike Gerdts 
412bc36eafdSMike Gerdts     case ACPI_PTYPE2_UUID_PAIR:
413bc36eafdSMike Gerdts 
414bc36eafdSMike Gerdts         /* The package contains a variable list of UUID Buffer/Package pairs */
415bc36eafdSMike Gerdts 
416bc36eafdSMike Gerdts         /* The length of the package must be even */
417bc36eafdSMike Gerdts 
418bc36eafdSMike Gerdts         if (Count & 1)
419bc36eafdSMike Gerdts         {
420bc36eafdSMike Gerdts             sprintf (MsgBuffer, "%4.4s: Package length, %d, must be even.",
421bc36eafdSMike Gerdts                 Predefined->Info.Name, Count);
422bc36eafdSMike Gerdts 
423bc36eafdSMike Gerdts             AslError (ASL_ERROR, ASL_MSG_RESERVED_PACKAGE_LENGTH,
424bc36eafdSMike Gerdts                 ParentOp->Asl.Child, MsgBuffer);
425bc36eafdSMike Gerdts         }
426bc36eafdSMike Gerdts 
427bc36eafdSMike Gerdts         /* Validate the alternating types */
428bc36eafdSMike Gerdts 
429bc36eafdSMike Gerdts         for (i = 0; i < Count; ++i)
430bc36eafdSMike Gerdts         {
431bc36eafdSMike Gerdts             if (i & 1)
432bc36eafdSMike Gerdts             {
433bc36eafdSMike Gerdts                 ApCheckObjectType (Predefined->Info.Name, Op,
434bc36eafdSMike Gerdts                     Package->RetInfo.ObjectType2, i);
435bc36eafdSMike Gerdts             }
436bc36eafdSMike Gerdts             else
437bc36eafdSMike Gerdts             {
438bc36eafdSMike Gerdts                 ApCheckObjectType (Predefined->Info.Name, Op,
439bc36eafdSMike Gerdts                     Package->RetInfo.ObjectType1, i);
440bc36eafdSMike Gerdts             }
441bc36eafdSMike Gerdts 
442bc36eafdSMike Gerdts             Op = Op->Asl.Next;
443bc36eafdSMike Gerdts         }
444bc36eafdSMike Gerdts 
445bc36eafdSMike Gerdts         break;
446bc36eafdSMike Gerdts 
447bc36eafdSMike Gerdts     case ACPI_PTYPE2_VAR_VAR:
448bc36eafdSMike Gerdts 
449bc36eafdSMike Gerdts         /* Check for minimum size (ints at beginning + 1 subpackage) */
450bc36eafdSMike Gerdts 
451bc36eafdSMike Gerdts         ExpectedCount = Package->RetInfo4.Count1 + 1;
452bc36eafdSMike Gerdts         if (Count < ExpectedCount)
453bc36eafdSMike Gerdts         {
454bc36eafdSMike Gerdts             goto PackageTooSmall;
455bc36eafdSMike Gerdts         }
456bc36eafdSMike Gerdts 
457bc36eafdSMike Gerdts         /* Check the non-package elements at beginning of main package */
458bc36eafdSMike Gerdts 
459bc36eafdSMike Gerdts         for (i = 0; i < Package->RetInfo4.Count1; ++i)
460bc36eafdSMike Gerdts         {
461bc36eafdSMike Gerdts             Status = ApCheckObjectType (Predefined->Info.Name, Op,
462bc36eafdSMike Gerdts                 Package->RetInfo4.ObjectType1, i);
463bc36eafdSMike Gerdts             Op = Op->Asl.Next;
464bc36eafdSMike Gerdts         }
465bc36eafdSMike Gerdts 
466bc36eafdSMike Gerdts         /* Examine the variable-length list of subpackages */
467bc36eafdSMike Gerdts 
468bc36eafdSMike Gerdts         ApCheckPackageList (Predefined->Info.Name, Op,
469bc36eafdSMike Gerdts             Package, Package->RetInfo4.Count1, Count);
470bc36eafdSMike Gerdts 
471bc36eafdSMike Gerdts         break;
472bc36eafdSMike Gerdts 
473bc36eafdSMike Gerdts     case ACPI_PTYPE2:
474bc36eafdSMike Gerdts     case ACPI_PTYPE2_FIXED:
475bc36eafdSMike Gerdts     case ACPI_PTYPE2_MIN:
476bc36eafdSMike Gerdts     case ACPI_PTYPE2_COUNT:
477bc36eafdSMike Gerdts     case ACPI_PTYPE2_FIX_VAR:
478bc36eafdSMike Gerdts         /*
479bc36eafdSMike Gerdts          * These types all return a single Package that consists of a
480bc36eafdSMike Gerdts          * variable number of subpackages.
481bc36eafdSMike Gerdts          */
482bc36eafdSMike Gerdts 
483bc36eafdSMike Gerdts         /* Examine the subpackages */
484bc36eafdSMike Gerdts 
485bc36eafdSMike Gerdts         ApCheckPackageList (Predefined->Info.Name, Op,
486bc36eafdSMike Gerdts             Package, 0, Count);
487bc36eafdSMike Gerdts         break;
488bc36eafdSMike Gerdts 
489bc36eafdSMike Gerdts     default:
490bc36eafdSMike Gerdts         return;
491bc36eafdSMike Gerdts     }
492bc36eafdSMike Gerdts 
493bc36eafdSMike Gerdts     return;
494bc36eafdSMike Gerdts 
495bc36eafdSMike Gerdts PackageTooSmall:
496bc36eafdSMike Gerdts     ApPackageTooSmall (Predefined->Info.Name, ParentOp,
497bc36eafdSMike Gerdts         Count, ExpectedCount);
498bc36eafdSMike Gerdts }
499bc36eafdSMike Gerdts 
500bc36eafdSMike Gerdts 
501bc36eafdSMike Gerdts /*******************************************************************************
502bc36eafdSMike Gerdts  *
503bc36eafdSMike Gerdts  * FUNCTION:    ApCustomPackage
504bc36eafdSMike Gerdts  *
505bc36eafdSMike Gerdts  * PARAMETERS:  ParentOp            - Parse op for the package
506bc36eafdSMike Gerdts  *              Predefined          - Pointer to package-specific info for
507bc36eafdSMike Gerdts  *                                    the method
508bc36eafdSMike Gerdts  *
509bc36eafdSMike Gerdts  * RETURN:      None
510bc36eafdSMike Gerdts  *
511bc36eafdSMike Gerdts  * DESCRIPTION: Validate packages that don't fit into the standard model and
512bc36eafdSMike Gerdts  *              require custom code.
513bc36eafdSMike Gerdts  *
514bc36eafdSMike Gerdts  * NOTE: Currently used for the _BIX method only. When needed for two or more
515bc36eafdSMike Gerdts  * methods, probably a detect/dispatch mechanism will be required.
516bc36eafdSMike Gerdts  *
517bc36eafdSMike Gerdts  ******************************************************************************/
518bc36eafdSMike Gerdts 
519bc36eafdSMike Gerdts static void
ApCustomPackage(ACPI_PARSE_OBJECT * ParentOp,const ACPI_PREDEFINED_INFO * Predefined)520bc36eafdSMike Gerdts ApCustomPackage (
521bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *ParentOp,
522bc36eafdSMike Gerdts     const ACPI_PREDEFINED_INFO  *Predefined)
523bc36eafdSMike Gerdts {
524bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op;
525bc36eafdSMike Gerdts     UINT32                      Count;
526bc36eafdSMike Gerdts     UINT32                      ExpectedCount;
527bc36eafdSMike Gerdts     UINT32                      Version;
528bc36eafdSMike Gerdts 
529bc36eafdSMike Gerdts 
530bc36eafdSMike Gerdts     /* First child is the package length */
531bc36eafdSMike Gerdts 
532bc36eafdSMike Gerdts     Op = ParentOp->Asl.Child;
533bc36eafdSMike Gerdts     Count = (UINT32) Op->Asl.Value.Integer;
534bc36eafdSMike Gerdts 
535bc36eafdSMike Gerdts     /* Get the version number, must be Integer */
536bc36eafdSMike Gerdts 
537bc36eafdSMike Gerdts     Op = Op->Asl.Next;
538bc36eafdSMike Gerdts     Version = (UINT32) Op->Asl.Value.Integer;
539bc36eafdSMike Gerdts     if (Op->Asl.ParseOpcode != PARSEOP_INTEGER)
540bc36eafdSMike Gerdts     {
541bc36eafdSMike Gerdts         AslError (ASL_ERROR, ASL_MSG_RESERVED_OPERAND_TYPE, Op, MsgBuffer);
542bc36eafdSMike Gerdts         return;
543bc36eafdSMike Gerdts     }
544bc36eafdSMike Gerdts 
545bc36eafdSMike Gerdts     /* Validate count (# of elements) */
546bc36eafdSMike Gerdts 
547bc36eafdSMike Gerdts     ExpectedCount = 21;         /* Version 1 */
548bc36eafdSMike Gerdts     if (Version == 0)
549bc36eafdSMike Gerdts     {
550bc36eafdSMike Gerdts         ExpectedCount = 20;     /* Version 0 */
551bc36eafdSMike Gerdts     }
552bc36eafdSMike Gerdts 
553bc36eafdSMike Gerdts     if (Count < ExpectedCount)
554bc36eafdSMike Gerdts     {
555bc36eafdSMike Gerdts         ApPackageTooSmall (Predefined->Info.Name, ParentOp,
556bc36eafdSMike Gerdts             Count, ExpectedCount);
557bc36eafdSMike Gerdts         return;
558bc36eafdSMike Gerdts     }
559bc36eafdSMike Gerdts     else if (Count > ExpectedCount)
560bc36eafdSMike Gerdts     {
561bc36eafdSMike Gerdts         ApPackageTooLarge (Predefined->Info.Name, ParentOp,
562bc36eafdSMike Gerdts             Count, ExpectedCount);
563bc36eafdSMike Gerdts     }
564bc36eafdSMike Gerdts 
565bc36eafdSMike Gerdts     /* Validate all elements of the package */
566bc36eafdSMike Gerdts 
567bc36eafdSMike Gerdts     Op = ApCheckPackageElements (Predefined->Info.Name, Op,
568bc36eafdSMike Gerdts         ACPI_RTYPE_INTEGER, 16,
569bc36eafdSMike Gerdts         ACPI_RTYPE_STRING, 4);
570bc36eafdSMike Gerdts 
571bc36eafdSMike Gerdts     /* Version 1 has a single trailing integer */
572bc36eafdSMike Gerdts 
573bc36eafdSMike Gerdts     if (Version > 0)
574bc36eafdSMike Gerdts     {
575bc36eafdSMike Gerdts         ApCheckPackageElements (Predefined->Info.Name, Op,
576bc36eafdSMike Gerdts             ACPI_RTYPE_INTEGER, 1, 0, 0);
577bc36eafdSMike Gerdts     }
578bc36eafdSMike Gerdts }
579bc36eafdSMike Gerdts 
580bc36eafdSMike Gerdts 
581bc36eafdSMike Gerdts /*******************************************************************************
582bc36eafdSMike Gerdts  *
583bc36eafdSMike Gerdts  * FUNCTION:    ApCheckPackageElements
584bc36eafdSMike Gerdts  *
585bc36eafdSMike Gerdts  * PARAMETERS:  PredefinedName      - Name of the predefined object
586bc36eafdSMike Gerdts  *              Op                  - Parser op for the package
587bc36eafdSMike Gerdts  *              Type1               - Object type for first group
588bc36eafdSMike Gerdts  *              Count1              - Count for first group
589bc36eafdSMike Gerdts  *              Type2               - Object type for second group
590bc36eafdSMike Gerdts  *              Count2              - Count for second group
591bc36eafdSMike Gerdts  *
592bc36eafdSMike Gerdts  * RETURN:      Next Op peer in the parse tree, after all specified elements
593bc36eafdSMike Gerdts  *              have been validated. Used for multiple validations (calls
594bc36eafdSMike Gerdts  *              to this function).
595bc36eafdSMike Gerdts  *
596bc36eafdSMike Gerdts  * DESCRIPTION: Validate all elements of a package. Works with packages that
597bc36eafdSMike Gerdts  *              are defined to contain up to two groups of different object
598bc36eafdSMike Gerdts  *              types.
599bc36eafdSMike Gerdts  *
600bc36eafdSMike Gerdts  ******************************************************************************/
601bc36eafdSMike Gerdts 
602bc36eafdSMike Gerdts static ACPI_PARSE_OBJECT *
ApCheckPackageElements(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT8 Type1,UINT32 Count1,UINT8 Type2,UINT32 Count2)603bc36eafdSMike Gerdts ApCheckPackageElements (
604bc36eafdSMike Gerdts     const char              *PredefinedName,
605bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT       *Op,
606bc36eafdSMike Gerdts     UINT8                   Type1,
607bc36eafdSMike Gerdts     UINT32                  Count1,
608bc36eafdSMike Gerdts     UINT8                   Type2,
609bc36eafdSMike Gerdts     UINT32                  Count2)
610bc36eafdSMike Gerdts {
611bc36eafdSMike Gerdts     UINT32                  i;
612bc36eafdSMike Gerdts 
613bc36eafdSMike Gerdts 
614bc36eafdSMike Gerdts     /*
615bc36eafdSMike Gerdts      * Up to two groups of package elements are supported by the data
616bc36eafdSMike Gerdts      * structure. All elements in each group must be of the same type.
617bc36eafdSMike Gerdts      * The second group can have a count of zero.
618bc36eafdSMike Gerdts      *
619bc36eafdSMike Gerdts      * Aborts check upon a NULL package element, as this means (at compile
620bc36eafdSMike Gerdts      * time) that the remainder of the package elements are also NULL
621bc36eafdSMike Gerdts      * (This is the only way to create NULL package elements.)
622bc36eafdSMike Gerdts      */
623bc36eafdSMike Gerdts     for (i = 0; (i < Count1) && Op; i++)
624bc36eafdSMike Gerdts     {
625bc36eafdSMike Gerdts         ApCheckObjectType (PredefinedName, Op, Type1, i);
626bc36eafdSMike Gerdts         Op = Op->Asl.Next;
627bc36eafdSMike Gerdts     }
628bc36eafdSMike Gerdts 
629bc36eafdSMike Gerdts     for (i = 0; (i < Count2) && Op; i++)
630bc36eafdSMike Gerdts     {
631bc36eafdSMike Gerdts         ApCheckObjectType (PredefinedName, Op, Type2, (i + Count1));
632bc36eafdSMike Gerdts         Op = Op->Asl.Next;
633bc36eafdSMike Gerdts     }
634bc36eafdSMike Gerdts 
635bc36eafdSMike Gerdts     return (Op);
636bc36eafdSMike Gerdts }
637bc36eafdSMike Gerdts 
638bc36eafdSMike Gerdts 
639bc36eafdSMike Gerdts /*******************************************************************************
640bc36eafdSMike Gerdts  *
641bc36eafdSMike Gerdts  * FUNCTION:    ApCheckPackageList
642bc36eafdSMike Gerdts  *
643bc36eafdSMike Gerdts  * PARAMETERS:  PredefinedName      - Name of the predefined object
644bc36eafdSMike Gerdts  *              ParentOp            - Parser op of the parent package
645bc36eafdSMike Gerdts  *              Package             - Package info for this predefined name
646bc36eafdSMike Gerdts  *              StartIndex          - Index in parent package where list begins
647bc36eafdSMike Gerdts  *              ParentCount         - Element count of parent package
648bc36eafdSMike Gerdts  *
649bc36eafdSMike Gerdts  * RETURN:      None
650bc36eafdSMike Gerdts  *
651bc36eafdSMike Gerdts  * DESCRIPTION: Validate the individual package elements for a predefined name.
652bc36eafdSMike Gerdts  *              Handles the cases where the predefined name is defined as a
653bc36eafdSMike Gerdts  *              Package of Packages (subpackages). These are the types:
654bc36eafdSMike Gerdts  *
655bc36eafdSMike Gerdts  *              ACPI_PTYPE2
656bc36eafdSMike Gerdts  *              ACPI_PTYPE2_FIXED
657bc36eafdSMike Gerdts  *              ACPI_PTYPE2_MIN
658bc36eafdSMike Gerdts  *              ACPI_PTYPE2_COUNT
659bc36eafdSMike Gerdts  *              ACPI_PTYPE2_FIX_VAR
660bc36eafdSMike Gerdts  *              ACPI_PTYPE2_VAR_VAR
661bc36eafdSMike Gerdts  *
662bc36eafdSMike Gerdts  ******************************************************************************/
663bc36eafdSMike Gerdts 
664bc36eafdSMike Gerdts static void
ApCheckPackageList(const char * PredefinedName,ACPI_PARSE_OBJECT * ParentOp,const ACPI_PREDEFINED_INFO * Package,UINT32 StartIndex,UINT32 ParentCount)665bc36eafdSMike Gerdts ApCheckPackageList (
666bc36eafdSMike Gerdts     const char                  *PredefinedName,
667bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *ParentOp,
668bc36eafdSMike Gerdts     const ACPI_PREDEFINED_INFO  *Package,
669bc36eafdSMike Gerdts     UINT32                      StartIndex,
670bc36eafdSMike Gerdts     UINT32                      ParentCount)
671bc36eafdSMike Gerdts {
672bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *SubPackageOp = ParentOp;
673bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op;
674bc36eafdSMike Gerdts     ACPI_STATUS                 Status;
675bc36eafdSMike Gerdts     UINT32                      Count;
676bc36eafdSMike Gerdts     UINT32                      ExpectedCount;
677bc36eafdSMike Gerdts     UINT32                      i;
678bc36eafdSMike Gerdts     UINT32                      j;
679bc36eafdSMike Gerdts 
680bc36eafdSMike Gerdts 
681bc36eafdSMike Gerdts     /*
682bc36eafdSMike Gerdts      * Validate each subpackage in the parent Package
683bc36eafdSMike Gerdts      *
684bc36eafdSMike Gerdts      * Note: We ignore NULL package elements on the assumption that
685bc36eafdSMike Gerdts      * they will be initialized by the BIOS or other ASL code.
686bc36eafdSMike Gerdts      */
687bc36eafdSMike Gerdts     for (i = 0; (i < ParentCount) && SubPackageOp; i++)
688bc36eafdSMike Gerdts     {
689bc36eafdSMike Gerdts         /* Each object in the list must be of type Package */
690bc36eafdSMike Gerdts 
691bc36eafdSMike Gerdts         Status = ApCheckObjectType (PredefinedName, SubPackageOp,
692bc36eafdSMike Gerdts             ACPI_RTYPE_PACKAGE, i + StartIndex);
693bc36eafdSMike Gerdts         if (ACPI_FAILURE (Status))
694bc36eafdSMike Gerdts         {
695bc36eafdSMike Gerdts             goto NextSubpackage;
696bc36eafdSMike Gerdts         }
697bc36eafdSMike Gerdts 
698bc36eafdSMike Gerdts         /* Examine the different types of expected subpackages */
699bc36eafdSMike Gerdts 
700bc36eafdSMike Gerdts         Op = SubPackageOp->Asl.Child;
701bc36eafdSMike Gerdts 
702bc36eafdSMike Gerdts         /* First child is the package length */
703bc36eafdSMike Gerdts 
704bc36eafdSMike Gerdts         Count = (UINT32) Op->Asl.Value.Integer;
705bc36eafdSMike Gerdts         Op = Op->Asl.Next;
706bc36eafdSMike Gerdts 
707bc36eafdSMike Gerdts         /*
708bc36eafdSMike Gerdts          * Most subpackage must have at least one element, with
709bc36eafdSMike Gerdts          * only rare exceptions. (_RDI)
710bc36eafdSMike Gerdts          */
711bc36eafdSMike Gerdts         if (!Count &&
712bc36eafdSMike Gerdts             (Package->RetInfo.Type != ACPI_PTYPE2_VAR_VAR))
713bc36eafdSMike Gerdts         {
714bc36eafdSMike Gerdts             ApZeroLengthPackage (PredefinedName, SubPackageOp);
715bc36eafdSMike Gerdts             goto NextSubpackage;
716bc36eafdSMike Gerdts         }
717bc36eafdSMike Gerdts 
718bc36eafdSMike Gerdts         /*
719bc36eafdSMike Gerdts          * Decode the package type.
720bc36eafdSMike Gerdts          * PTYPE2 indicates that a "package of packages" is expected for
721bc36eafdSMike Gerdts          * this name. The various flavors of PTYPE2 indicate the number
722bc36eafdSMike Gerdts          * and format of the subpackages.
723bc36eafdSMike Gerdts          */
724bc36eafdSMike Gerdts         switch (Package->RetInfo.Type)
725bc36eafdSMike Gerdts         {
726bc36eafdSMike Gerdts         case ACPI_PTYPE2:
727bc36eafdSMike Gerdts         case ACPI_PTYPE2_PKG_COUNT:
728bc36eafdSMike Gerdts         case ACPI_PTYPE2_REV_FIXED:
729bc36eafdSMike Gerdts 
730bc36eafdSMike Gerdts             /* Each subpackage has a fixed number of elements */
731bc36eafdSMike Gerdts 
732bc36eafdSMike Gerdts             ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
733bc36eafdSMike Gerdts             if (Count < ExpectedCount)
734bc36eafdSMike Gerdts             {
735bc36eafdSMike Gerdts                 ApPackageTooSmall (PredefinedName, SubPackageOp,
736bc36eafdSMike Gerdts                     Count, ExpectedCount);
737bc36eafdSMike Gerdts                 break;
738bc36eafdSMike Gerdts             }
739bc36eafdSMike Gerdts             if (Count > ExpectedCount)
740bc36eafdSMike Gerdts             {
741bc36eafdSMike Gerdts                 ApPackageTooLarge (PredefinedName, SubPackageOp,
742bc36eafdSMike Gerdts                     Count, ExpectedCount);
743bc36eafdSMike Gerdts                 break;
744bc36eafdSMike Gerdts             }
745bc36eafdSMike Gerdts 
746bc36eafdSMike Gerdts             ApCheckPackageElements (PredefinedName, Op,
747bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
748bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType2, Package->RetInfo.Count2);
749bc36eafdSMike Gerdts             break;
750bc36eafdSMike Gerdts 
751bc36eafdSMike Gerdts         case ACPI_PTYPE2_FIX_VAR:
752bc36eafdSMike Gerdts             /*
753bc36eafdSMike Gerdts              * Each subpackage has a fixed number of elements and an
754bc36eafdSMike Gerdts              * optional element
755bc36eafdSMike Gerdts              */
756bc36eafdSMike Gerdts             ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
757bc36eafdSMike Gerdts             if (Count < ExpectedCount)
758bc36eafdSMike Gerdts             {
759bc36eafdSMike Gerdts                 ApPackageTooSmall (PredefinedName, SubPackageOp,
760bc36eafdSMike Gerdts                     Count, ExpectedCount);
761bc36eafdSMike Gerdts                 break;
762bc36eafdSMike Gerdts             }
763bc36eafdSMike Gerdts 
764bc36eafdSMike Gerdts             ApCheckPackageElements (PredefinedName, Op,
765bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
766bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType2,
767bc36eafdSMike Gerdts                 Count - Package->RetInfo.Count1);
768bc36eafdSMike Gerdts             break;
769bc36eafdSMike Gerdts 
770bc36eafdSMike Gerdts         case ACPI_PTYPE2_VAR_VAR:
771bc36eafdSMike Gerdts             /*
772bc36eafdSMike Gerdts              * Must have at least the minimum number elements.
773bc36eafdSMike Gerdts              * A zero PkgCount means the number of elements is variable.
774bc36eafdSMike Gerdts              */
775bc36eafdSMike Gerdts             ExpectedCount = Package->RetInfo4.PkgCount;
776bc36eafdSMike Gerdts             if (ExpectedCount && (Count < ExpectedCount))
777bc36eafdSMike Gerdts             {
778bc36eafdSMike Gerdts                 ApPackageTooSmall (PredefinedName, SubPackageOp,
779bc36eafdSMike Gerdts                     Count, 1);
780bc36eafdSMike Gerdts                 break;
781bc36eafdSMike Gerdts             }
782bc36eafdSMike Gerdts 
783bc36eafdSMike Gerdts             ApCheckPackageElements (PredefinedName, Op,
784bc36eafdSMike Gerdts                 Package->RetInfo4.SubObjectTypes,
785bc36eafdSMike Gerdts                 Package->RetInfo4.PkgCount,
786bc36eafdSMike Gerdts                 0, 0);
787bc36eafdSMike Gerdts             break;
788bc36eafdSMike Gerdts 
789bc36eafdSMike Gerdts         case ACPI_PTYPE2_FIXED:
790bc36eafdSMike Gerdts 
791bc36eafdSMike Gerdts             /* Each subpackage has a fixed length */
792bc36eafdSMike Gerdts 
793bc36eafdSMike Gerdts             ExpectedCount = Package->RetInfo2.Count;
794bc36eafdSMike Gerdts             if (Count < ExpectedCount)
795bc36eafdSMike Gerdts             {
796bc36eafdSMike Gerdts                 ApPackageTooSmall (PredefinedName, SubPackageOp,
797bc36eafdSMike Gerdts                     Count, ExpectedCount);
798bc36eafdSMike Gerdts                 break;
799bc36eafdSMike Gerdts             }
800bc36eafdSMike Gerdts             if (Count > ExpectedCount)
801bc36eafdSMike Gerdts             {
802bc36eafdSMike Gerdts                 ApPackageTooLarge (PredefinedName, SubPackageOp,
803bc36eafdSMike Gerdts                     Count, ExpectedCount);
804bc36eafdSMike Gerdts                 break;
805bc36eafdSMike Gerdts             }
806bc36eafdSMike Gerdts 
807bc36eafdSMike Gerdts             /* Check each object/type combination */
808bc36eafdSMike Gerdts 
809bc36eafdSMike Gerdts             for (j = 0; j < ExpectedCount; j++)
810bc36eafdSMike Gerdts             {
811bc36eafdSMike Gerdts                 ApCheckObjectType (PredefinedName, Op,
812bc36eafdSMike Gerdts                     Package->RetInfo2.ObjectType[j], j);
813bc36eafdSMike Gerdts 
814bc36eafdSMike Gerdts                 Op = Op->Asl.Next;
815bc36eafdSMike Gerdts             }
816bc36eafdSMike Gerdts             break;
817bc36eafdSMike Gerdts 
818bc36eafdSMike Gerdts         case ACPI_PTYPE2_MIN:
819bc36eafdSMike Gerdts 
820bc36eafdSMike Gerdts             /* Each subpackage has a variable but minimum length */
821bc36eafdSMike Gerdts 
822bc36eafdSMike Gerdts             ExpectedCount = Package->RetInfo.Count1;
823bc36eafdSMike Gerdts             if (Count < ExpectedCount)
824bc36eafdSMike Gerdts             {
825bc36eafdSMike Gerdts                 ApPackageTooSmall (PredefinedName, SubPackageOp,
826bc36eafdSMike Gerdts                     Count, ExpectedCount);
827bc36eafdSMike Gerdts                 break;
828bc36eafdSMike Gerdts             }
829bc36eafdSMike Gerdts 
830bc36eafdSMike Gerdts             /* Check the type of each subpackage element */
831bc36eafdSMike Gerdts 
832bc36eafdSMike Gerdts             ApCheckPackageElements (PredefinedName, Op,
833bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType1, Count, 0, 0);
834bc36eafdSMike Gerdts             break;
835bc36eafdSMike Gerdts 
836bc36eafdSMike Gerdts         case ACPI_PTYPE2_COUNT:
837bc36eafdSMike Gerdts             /*
838bc36eafdSMike Gerdts              * First element is the (Integer) count of elements, including
839bc36eafdSMike Gerdts              * the count field (the ACPI name is NumElements)
840bc36eafdSMike Gerdts              */
841bc36eafdSMike Gerdts             Status = ApCheckObjectType (PredefinedName, Op,
842bc36eafdSMike Gerdts                 ACPI_RTYPE_INTEGER, 0);
843bc36eafdSMike Gerdts 
844bc36eafdSMike Gerdts             /* We must have an integer count from above (otherwise, use Count) */
845bc36eafdSMike Gerdts 
846bc36eafdSMike Gerdts             if (ACPI_SUCCESS (Status))
847bc36eafdSMike Gerdts             {
848bc36eafdSMike Gerdts                 /*
849bc36eafdSMike Gerdts                  * Make sure package is large enough for the Count and is
850bc36eafdSMike Gerdts                  * is as large as the minimum size
851bc36eafdSMike Gerdts                  */
852bc36eafdSMike Gerdts                 ExpectedCount = (UINT32) Op->Asl.Value.Integer;
853bc36eafdSMike Gerdts 
854bc36eafdSMike Gerdts                 if (Count < ExpectedCount)
855bc36eafdSMike Gerdts                 {
856bc36eafdSMike Gerdts                     ApPackageTooSmall (PredefinedName, SubPackageOp,
857bc36eafdSMike Gerdts                         Count, ExpectedCount);
858bc36eafdSMike Gerdts                     break;
859bc36eafdSMike Gerdts                 }
860bc36eafdSMike Gerdts                 else if (Count > ExpectedCount)
861bc36eafdSMike Gerdts                 {
862bc36eafdSMike Gerdts                     ApPackageTooLarge (PredefinedName, SubPackageOp,
863bc36eafdSMike Gerdts                         Count, ExpectedCount);
864bc36eafdSMike Gerdts                 }
865bc36eafdSMike Gerdts 
866bc36eafdSMike Gerdts                 /* Some names of this type have a minimum length */
867bc36eafdSMike Gerdts 
868bc36eafdSMike Gerdts                 if (Count < Package->RetInfo.Count1)
869bc36eafdSMike Gerdts                 {
870bc36eafdSMike Gerdts                     ExpectedCount = Package->RetInfo.Count1;
871bc36eafdSMike Gerdts                     ApPackageTooSmall (PredefinedName, SubPackageOp,
872bc36eafdSMike Gerdts                         Count, ExpectedCount);
873bc36eafdSMike Gerdts                     break;
874bc36eafdSMike Gerdts                 }
875bc36eafdSMike Gerdts 
876bc36eafdSMike Gerdts                 Count = ExpectedCount;
877bc36eafdSMike Gerdts             }
878bc36eafdSMike Gerdts 
879bc36eafdSMike Gerdts             /* Check the type of each subpackage element */
880bc36eafdSMike Gerdts 
881bc36eafdSMike Gerdts             Op = Op->Asl.Next;
882bc36eafdSMike Gerdts             ApCheckPackageElements (PredefinedName, Op,
883bc36eafdSMike Gerdts                 Package->RetInfo.ObjectType1, (Count - 1), 0, 0);
884bc36eafdSMike Gerdts             break;
885bc36eafdSMike Gerdts 
886bc36eafdSMike Gerdts         default:
887bc36eafdSMike Gerdts             break;
888bc36eafdSMike Gerdts         }
889bc36eafdSMike Gerdts 
890bc36eafdSMike Gerdts NextSubpackage:
891bc36eafdSMike Gerdts         SubPackageOp = SubPackageOp->Asl.Next;
892bc36eafdSMike Gerdts     }
893bc36eafdSMike Gerdts }
894bc36eafdSMike Gerdts 
895bc36eafdSMike Gerdts 
896bc36eafdSMike Gerdts /*******************************************************************************
897bc36eafdSMike Gerdts  *
898bc36eafdSMike Gerdts  * FUNCTION:    ApPackageTooSmall
899bc36eafdSMike Gerdts  *
900bc36eafdSMike Gerdts  * PARAMETERS:  PredefinedName      - Name of the predefined object
901bc36eafdSMike Gerdts  *              Op                  - Current parser op
902bc36eafdSMike Gerdts  *              Count               - Actual package element count
903bc36eafdSMike Gerdts  *              ExpectedCount       - Expected package element count
904bc36eafdSMike Gerdts  *
905bc36eafdSMike Gerdts  * RETURN:      None
906bc36eafdSMike Gerdts  *
907bc36eafdSMike Gerdts  * DESCRIPTION: Issue error message for a package that is smaller than
908bc36eafdSMike Gerdts  *              required.
909bc36eafdSMike Gerdts  *
910bc36eafdSMike Gerdts  ******************************************************************************/
911bc36eafdSMike Gerdts 
912bc36eafdSMike Gerdts static void
ApPackageTooSmall(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT32 Count,UINT32 ExpectedCount)913bc36eafdSMike Gerdts ApPackageTooSmall (
914bc36eafdSMike Gerdts     const char                  *PredefinedName,
915bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op,
916bc36eafdSMike Gerdts     UINT32                      Count,
917bc36eafdSMike Gerdts     UINT32                      ExpectedCount)
918bc36eafdSMike Gerdts {
919bc36eafdSMike Gerdts 
920bc36eafdSMike Gerdts     sprintf (MsgBuffer, "%s: length %u, required minimum is %u",
921bc36eafdSMike Gerdts         PredefinedName, Count, ExpectedCount);
922bc36eafdSMike Gerdts 
923bc36eafdSMike Gerdts     AslError (ASL_ERROR, ASL_MSG_RESERVED_PACKAGE_LENGTH, Op, MsgBuffer);
924bc36eafdSMike Gerdts }
925bc36eafdSMike Gerdts 
926bc36eafdSMike Gerdts 
927bc36eafdSMike Gerdts /*******************************************************************************
928bc36eafdSMike Gerdts  *
929bc36eafdSMike Gerdts  * FUNCTION:    ApZeroLengthPackage
930bc36eafdSMike Gerdts  *
931bc36eafdSMike Gerdts  * PARAMETERS:  PredefinedName      - Name of the predefined object
932bc36eafdSMike Gerdts  *              Op                  - Current parser op
933bc36eafdSMike Gerdts  *
934bc36eafdSMike Gerdts  * RETURN:      None
935bc36eafdSMike Gerdts  *
936bc36eafdSMike Gerdts  * DESCRIPTION: Issue error message for a zero-length package (a package that
937bc36eafdSMike Gerdts  *              is required to have a non-zero length). Variable length
938bc36eafdSMike Gerdts  *              packages seem to be allowed to have zero length, however.
939bc36eafdSMike Gerdts  *              Even if not allowed, BIOS code does it.
940bc36eafdSMike Gerdts  *
941bc36eafdSMike Gerdts  ******************************************************************************/
942bc36eafdSMike Gerdts 
943bc36eafdSMike Gerdts static void
ApZeroLengthPackage(const char * PredefinedName,ACPI_PARSE_OBJECT * Op)944bc36eafdSMike Gerdts ApZeroLengthPackage (
945bc36eafdSMike Gerdts     const char                  *PredefinedName,
946bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op)
947bc36eafdSMike Gerdts {
948bc36eafdSMike Gerdts 
949bc36eafdSMike Gerdts     sprintf (MsgBuffer, "%s: length is zero", PredefinedName);
950bc36eafdSMike Gerdts 
951bc36eafdSMike Gerdts     AslError (ASL_ERROR, ASL_MSG_RESERVED_PACKAGE_LENGTH, Op, MsgBuffer);
952bc36eafdSMike Gerdts }
953bc36eafdSMike Gerdts 
954bc36eafdSMike Gerdts 
955bc36eafdSMike Gerdts /*******************************************************************************
956bc36eafdSMike Gerdts  *
957bc36eafdSMike Gerdts  * FUNCTION:    ApPackageTooLarge
958bc36eafdSMike Gerdts  *
959bc36eafdSMike Gerdts  * PARAMETERS:  PredefinedName      - Name of the predefined object
960bc36eafdSMike Gerdts  *              Op                  - Current parser op
961bc36eafdSMike Gerdts  *              Count               - Actual package element count
962bc36eafdSMike Gerdts  *              ExpectedCount       - Expected package element count
963bc36eafdSMike Gerdts  *
964bc36eafdSMike Gerdts  * RETURN:      None
965bc36eafdSMike Gerdts  *
966bc36eafdSMike Gerdts  * DESCRIPTION: Issue a remark for a package that is larger than expected.
967bc36eafdSMike Gerdts  *
968bc36eafdSMike Gerdts  ******************************************************************************/
969bc36eafdSMike Gerdts 
970bc36eafdSMike Gerdts static void
ApPackageTooLarge(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT32 Count,UINT32 ExpectedCount)971bc36eafdSMike Gerdts ApPackageTooLarge (
972bc36eafdSMike Gerdts     const char                  *PredefinedName,
973bc36eafdSMike Gerdts     ACPI_PARSE_OBJECT           *Op,
974bc36eafdSMike Gerdts     UINT32                      Count,
975bc36eafdSMike Gerdts     UINT32                      ExpectedCount)
976bc36eafdSMike Gerdts {
977bc36eafdSMike Gerdts 
978bc36eafdSMike Gerdts     sprintf (MsgBuffer, "%s: length is %u, only %u required",
979bc36eafdSMike Gerdts         PredefinedName, Count, ExpectedCount);
980bc36eafdSMike Gerdts 
981bc36eafdSMike Gerdts     AslError (ASL_REMARK, ASL_MSG_RESERVED_PACKAGE_LENGTH, Op, MsgBuffer);
982bc36eafdSMike Gerdts }
983