1ff4a156dSchristos /******************************************************************************
2ff4a156dSchristos *
3ff4a156dSchristos * Module Name: aslprepkg - support for ACPI predefined name package objects
4ff4a156dSchristos *
5ff4a156dSchristos *****************************************************************************/
6ff4a156dSchristos
7ff4a156dSchristos /*
8*2c7d7e3cSchristos * Copyright (C) 2000 - 2023, Intel Corp.
9ff4a156dSchristos * All rights reserved.
10ff4a156dSchristos *
11ff4a156dSchristos * Redistribution and use in source and binary forms, with or without
12ff4a156dSchristos * modification, are permitted provided that the following conditions
13ff4a156dSchristos * are met:
14ff4a156dSchristos * 1. Redistributions of source code must retain the above copyright
15ff4a156dSchristos * notice, this list of conditions, and the following disclaimer,
16ff4a156dSchristos * without modification.
17ff4a156dSchristos * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18ff4a156dSchristos * substantially similar to the "NO WARRANTY" disclaimer below
19ff4a156dSchristos * ("Disclaimer") and any redistribution must be conditioned upon
20ff4a156dSchristos * including a substantially similar Disclaimer requirement for further
21ff4a156dSchristos * binary redistribution.
22ff4a156dSchristos * 3. Neither the names of the above-listed copyright holders nor the names
23ff4a156dSchristos * of any contributors may be used to endorse or promote products derived
24ff4a156dSchristos * from this software without specific prior written permission.
25ff4a156dSchristos *
26ff4a156dSchristos * Alternatively, this software may be distributed under the terms of the
27ff4a156dSchristos * GNU General Public License ("GPL") version 2 as published by the Free
28ff4a156dSchristos * Software Foundation.
29ff4a156dSchristos *
30ff4a156dSchristos * NO WARRANTY
31ff4a156dSchristos * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32ff4a156dSchristos * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
3398244dcfSchristos * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34ff4a156dSchristos * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35ff4a156dSchristos * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36ff4a156dSchristos * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37ff4a156dSchristos * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38ff4a156dSchristos * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39ff4a156dSchristos * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40ff4a156dSchristos * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41ff4a156dSchristos * POSSIBILITY OF SUCH DAMAGES.
42ff4a156dSchristos */
43ff4a156dSchristos
44ff4a156dSchristos #include "aslcompiler.h"
45ff4a156dSchristos #include "aslcompiler.y.h"
46ff4a156dSchristos #include "acpredef.h"
47ff4a156dSchristos
48ff4a156dSchristos
49ff4a156dSchristos #define _COMPONENT ACPI_COMPILER
50ff4a156dSchristos ACPI_MODULE_NAME ("aslprepkg")
51ff4a156dSchristos
52ff4a156dSchristos
53ff4a156dSchristos /* Local prototypes */
54ff4a156dSchristos
5549c2f1f4Schristos static ACPI_PARSE_OBJECT *
56ff4a156dSchristos ApCheckPackageElements (
57ff4a156dSchristos const char *PredefinedName,
58ff4a156dSchristos ACPI_PARSE_OBJECT *Op,
59ff4a156dSchristos UINT8 Type1,
60ff4a156dSchristos UINT32 Count1,
61ff4a156dSchristos UINT8 Type2,
62ff4a156dSchristos UINT32 Count2);
63ff4a156dSchristos
64ff4a156dSchristos static void
65ff4a156dSchristos ApCheckPackageList (
66ff4a156dSchristos const char *PredefinedName,
67ff4a156dSchristos ACPI_PARSE_OBJECT *ParentOp,
68ff4a156dSchristos const ACPI_PREDEFINED_INFO *Package,
69ff4a156dSchristos UINT32 StartIndex,
70ff4a156dSchristos UINT32 Count);
71ff4a156dSchristos
72ff4a156dSchristos static void
73ff4a156dSchristos ApPackageTooSmall (
74ff4a156dSchristos const char *PredefinedName,
75ff4a156dSchristos ACPI_PARSE_OBJECT *Op,
76ff4a156dSchristos UINT32 Count,
77ff4a156dSchristos UINT32 ExpectedCount);
78ff4a156dSchristos
79ff4a156dSchristos static void
80ff4a156dSchristos ApZeroLengthPackage (
81ff4a156dSchristos const char *PredefinedName,
82ff4a156dSchristos ACPI_PARSE_OBJECT *Op);
83ff4a156dSchristos
84ff4a156dSchristos static void
85ff4a156dSchristos ApPackageTooLarge (
86ff4a156dSchristos const char *PredefinedName,
87ff4a156dSchristos ACPI_PARSE_OBJECT *Op,
88ff4a156dSchristos UINT32 Count,
89ff4a156dSchristos UINT32 ExpectedCount);
90ff4a156dSchristos
9149c2f1f4Schristos static void
9249c2f1f4Schristos ApCustomPackage (
9349c2f1f4Schristos ACPI_PARSE_OBJECT *ParentOp,
9449c2f1f4Schristos const ACPI_PREDEFINED_INFO *Predefined);
9549c2f1f4Schristos
96ff4a156dSchristos
97ff4a156dSchristos /*******************************************************************************
98ff4a156dSchristos *
99ff4a156dSchristos * FUNCTION: ApCheckPackage
100ff4a156dSchristos *
101ff4a156dSchristos * PARAMETERS: ParentOp - Parser op for the package
102ff4a156dSchristos * Predefined - Pointer to package-specific info for
103ff4a156dSchristos * the method
104ff4a156dSchristos *
105ff4a156dSchristos * RETURN: None
106ff4a156dSchristos *
107ff4a156dSchristos * DESCRIPTION: Top-level validation for predefined name return package
108ff4a156dSchristos * objects.
109ff4a156dSchristos *
110ff4a156dSchristos ******************************************************************************/
111ff4a156dSchristos
112ff4a156dSchristos void
ApCheckPackage(ACPI_PARSE_OBJECT * ParentOp,const ACPI_PREDEFINED_INFO * Predefined)113ff4a156dSchristos ApCheckPackage (
114ff4a156dSchristos ACPI_PARSE_OBJECT *ParentOp,
115ff4a156dSchristos const ACPI_PREDEFINED_INFO *Predefined)
116ff4a156dSchristos {
117ff4a156dSchristos ACPI_PARSE_OBJECT *Op;
118ff4a156dSchristos const ACPI_PREDEFINED_INFO *Package;
119ff4a156dSchristos ACPI_STATUS Status;
120ff4a156dSchristos UINT32 ExpectedCount;
121ff4a156dSchristos UINT32 Count;
122ff4a156dSchristos UINT32 i;
123ff4a156dSchristos
124ff4a156dSchristos
125ff4a156dSchristos /* The package info for this name is in the next table entry */
126ff4a156dSchristos
127ff4a156dSchristos Package = Predefined + 1;
128ff4a156dSchristos
129ff4a156dSchristos /* First child is the package length */
130ff4a156dSchristos
131ff4a156dSchristos Op = ParentOp->Asl.Child;
132ff4a156dSchristos Count = (UINT32) Op->Asl.Value.Integer;
133ff4a156dSchristos
134ff4a156dSchristos /*
135ff4a156dSchristos * Many of the variable-length top-level packages are allowed to simply
136ff4a156dSchristos * have zero elements. This allows the BIOS to tell the host that even
137ff4a156dSchristos * though the predefined name/method exists, the feature is not supported.
138ff4a156dSchristos * Other package types require one or more elements. In any case, there
139ff4a156dSchristos * is no need to continue validation.
140ff4a156dSchristos */
141ff4a156dSchristos if (!Count)
142ff4a156dSchristos {
143ff4a156dSchristos switch (Package->RetInfo.Type)
144ff4a156dSchristos {
145ff4a156dSchristos case ACPI_PTYPE1_FIXED:
146ff4a156dSchristos case ACPI_PTYPE1_OPTION:
147ff4a156dSchristos case ACPI_PTYPE2_PKG_COUNT:
148ff4a156dSchristos case ACPI_PTYPE2_REV_FIXED:
149ff4a156dSchristos
150ff4a156dSchristos ApZeroLengthPackage (Predefined->Info.Name, ParentOp);
151ff4a156dSchristos break;
152ff4a156dSchristos
153ff4a156dSchristos case ACPI_PTYPE1_VAR:
154ff4a156dSchristos case ACPI_PTYPE2:
155ff4a156dSchristos case ACPI_PTYPE2_COUNT:
156ff4a156dSchristos case ACPI_PTYPE2_FIXED:
157ff4a156dSchristos case ACPI_PTYPE2_MIN:
158ff4a156dSchristos case ACPI_PTYPE2_FIX_VAR:
1599b9ee194Schristos case ACPI_PTYPE2_VAR_VAR:
160ff4a156dSchristos default:
161ff4a156dSchristos
162ff4a156dSchristos break;
163ff4a156dSchristos }
164ff4a156dSchristos
165ff4a156dSchristos return;
166ff4a156dSchristos }
167ff4a156dSchristos
168ff4a156dSchristos /* Get the first element of the package */
169ff4a156dSchristos
170ff4a156dSchristos Op = Op->Asl.Next;
171ff4a156dSchristos
172ff4a156dSchristos /* Decode the package type */
173ff4a156dSchristos
174ff4a156dSchristos switch (Package->RetInfo.Type)
175ff4a156dSchristos {
17649c2f1f4Schristos case ACPI_PTYPE_CUSTOM:
17749c2f1f4Schristos
17849c2f1f4Schristos ApCustomPackage (ParentOp, Predefined);
17949c2f1f4Schristos break;
18049c2f1f4Schristos
181ff4a156dSchristos case ACPI_PTYPE1_FIXED:
182ff4a156dSchristos /*
183414ef032Schristos * The package count is fixed and there are no subpackages
184ff4a156dSchristos *
185ff4a156dSchristos * If package is too small, exit.
186ff4a156dSchristos * If package is larger than expected, issue warning but continue
187ff4a156dSchristos */
188ff4a156dSchristos ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
189ff4a156dSchristos if (Count < ExpectedCount)
190ff4a156dSchristos {
191ff4a156dSchristos goto PackageTooSmall;
192ff4a156dSchristos }
193ff4a156dSchristos else if (Count > ExpectedCount)
194ff4a156dSchristos {
195ff4a156dSchristos ApPackageTooLarge (Predefined->Info.Name, ParentOp,
196ff4a156dSchristos Count, ExpectedCount);
197ff4a156dSchristos }
198ff4a156dSchristos
199ff4a156dSchristos /* Validate all elements of the package */
200ff4a156dSchristos
201ff4a156dSchristos ApCheckPackageElements (Predefined->Info.Name, Op,
202ff4a156dSchristos Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
203ff4a156dSchristos Package->RetInfo.ObjectType2, Package->RetInfo.Count2);
204ff4a156dSchristos break;
205ff4a156dSchristos
206ff4a156dSchristos case ACPI_PTYPE1_VAR:
207ff4a156dSchristos /*
208414ef032Schristos * The package count is variable, there are no subpackages,
209ff4a156dSchristos * and all elements must be of the same type
210ff4a156dSchristos */
211ff4a156dSchristos for (i = 0; i < Count; i++)
212ff4a156dSchristos {
213b558e860Schristos if (!Op)
214b558e860Schristos {
215b558e860Schristos /*
216b558e860Schristos * If we get to this point, it means that the package length
217b558e860Schristos * is larger than the initializer list. Stop processing the
218b558e860Schristos * package and return because we have run out of package
219b558e860Schristos * elements to analyze.
220b558e860Schristos */
221b558e860Schristos return;
222b558e860Schristos }
223b558e860Schristos
224ff4a156dSchristos ApCheckObjectType (Predefined->Info.Name, Op,
225ff4a156dSchristos Package->RetInfo.ObjectType1, i);
226ff4a156dSchristos Op = Op->Asl.Next;
227ff4a156dSchristos }
228ff4a156dSchristos break;
229ff4a156dSchristos
230ff4a156dSchristos case ACPI_PTYPE1_OPTION:
231ff4a156dSchristos /*
232414ef032Schristos * The package count is variable, there are no subpackages.
233ff4a156dSchristos * There are a fixed number of required elements, and a variable
234ff4a156dSchristos * number of optional elements.
235ff4a156dSchristos *
236ff4a156dSchristos * Check if package is at least as large as the minimum required
237ff4a156dSchristos */
238ff4a156dSchristos ExpectedCount = Package->RetInfo3.Count;
239ff4a156dSchristos if (Count < ExpectedCount)
240ff4a156dSchristos {
241ff4a156dSchristos goto PackageTooSmall;
242ff4a156dSchristos }
243ff4a156dSchristos
244ff4a156dSchristos /* Variable number of sub-objects */
245ff4a156dSchristos
246ff4a156dSchristos for (i = 0; i < Count; i++)
247ff4a156dSchristos {
248ff4a156dSchristos if (i < Package->RetInfo3.Count)
249ff4a156dSchristos {
250ff4a156dSchristos /* These are the required package elements (0, 1, or 2) */
251ff4a156dSchristos
252ff4a156dSchristos ApCheckObjectType (Predefined->Info.Name, Op,
253ff4a156dSchristos Package->RetInfo3.ObjectType[i], i);
254ff4a156dSchristos }
255ff4a156dSchristos else
256ff4a156dSchristos {
257ff4a156dSchristos /* These are the optional package elements */
258ff4a156dSchristos
259ff4a156dSchristos ApCheckObjectType (Predefined->Info.Name, Op,
260ff4a156dSchristos Package->RetInfo3.TailObjectType, i);
261ff4a156dSchristos }
26281bd9c9cSchristos
263ff4a156dSchristos Op = Op->Asl.Next;
264ff4a156dSchristos }
265ff4a156dSchristos break;
266ff4a156dSchristos
267ff4a156dSchristos case ACPI_PTYPE2_REV_FIXED:
268ff4a156dSchristos
269ff4a156dSchristos /* First element is the (Integer) revision */
270ff4a156dSchristos
271ff4a156dSchristos ApCheckObjectType (Predefined->Info.Name, Op,
272ff4a156dSchristos ACPI_RTYPE_INTEGER, 0);
273ff4a156dSchristos
274ff4a156dSchristos Op = Op->Asl.Next;
275ff4a156dSchristos Count--;
276ff4a156dSchristos
277414ef032Schristos /* Examine the subpackages */
278ff4a156dSchristos
279ff4a156dSchristos ApCheckPackageList (Predefined->Info.Name, Op,
280ff4a156dSchristos Package, 1, Count);
281ff4a156dSchristos break;
282ff4a156dSchristos
283ff4a156dSchristos case ACPI_PTYPE2_PKG_COUNT:
284ff4a156dSchristos
285414ef032Schristos /* First element is the (Integer) count of subpackages to follow */
286ff4a156dSchristos
287ff4a156dSchristos Status = ApCheckObjectType (Predefined->Info.Name, Op,
288ff4a156dSchristos ACPI_RTYPE_INTEGER, 0);
289ff4a156dSchristos
290ff4a156dSchristos /* We must have an integer count from above (otherwise, use Count) */
291ff4a156dSchristos
292ff4a156dSchristos if (ACPI_SUCCESS (Status))
293ff4a156dSchristos {
294ff4a156dSchristos /*
295ff4a156dSchristos * Count cannot be larger than the parent package length, but
296ff4a156dSchristos * allow it to be smaller. The >= accounts for the Integer above.
297ff4a156dSchristos */
298ff4a156dSchristos ExpectedCount = (UINT32) Op->Asl.Value.Integer;
299ff4a156dSchristos if (ExpectedCount >= Count)
300ff4a156dSchristos {
301ff4a156dSchristos goto PackageTooSmall;
302ff4a156dSchristos }
303ff4a156dSchristos
304ff4a156dSchristos Count = ExpectedCount;
305ff4a156dSchristos }
306ff4a156dSchristos
307ff4a156dSchristos Op = Op->Asl.Next;
308ff4a156dSchristos
309414ef032Schristos /* Examine the subpackages */
310ff4a156dSchristos
311ff4a156dSchristos ApCheckPackageList (Predefined->Info.Name, Op,
312ff4a156dSchristos Package, 1, Count);
313ff4a156dSchristos break;
314ff4a156dSchristos
315414ef032Schristos case ACPI_PTYPE2_UUID_PAIR:
316414ef032Schristos
317414ef032Schristos /* The package contains a variable list of UUID Buffer/Package pairs */
318414ef032Schristos
319414ef032Schristos /* The length of the package must be even */
320414ef032Schristos
321414ef032Schristos if (Count & 1)
322414ef032Schristos {
3237efa3256Schristos sprintf (AslGbl_MsgBuffer, "%4.4s: Package length, %d, must be even.",
324414ef032Schristos Predefined->Info.Name, Count);
325414ef032Schristos
326414ef032Schristos AslError (ASL_ERROR, ASL_MSG_RESERVED_PACKAGE_LENGTH,
3277efa3256Schristos ParentOp->Asl.Child, AslGbl_MsgBuffer);
328414ef032Schristos }
329414ef032Schristos
330414ef032Schristos /* Validate the alternating types */
331414ef032Schristos
332414ef032Schristos for (i = 0; i < Count; ++i)
333414ef032Schristos {
334414ef032Schristos if (i & 1)
335414ef032Schristos {
336414ef032Schristos ApCheckObjectType (Predefined->Info.Name, Op,
337414ef032Schristos Package->RetInfo.ObjectType2, i);
338414ef032Schristos }
339414ef032Schristos else
340414ef032Schristos {
341414ef032Schristos ApCheckObjectType (Predefined->Info.Name, Op,
342414ef032Schristos Package->RetInfo.ObjectType1, i);
343414ef032Schristos }
344414ef032Schristos
345414ef032Schristos Op = Op->Asl.Next;
346414ef032Schristos }
347414ef032Schristos
348414ef032Schristos break;
349414ef032Schristos
3509b9ee194Schristos case ACPI_PTYPE2_VAR_VAR:
3519b9ee194Schristos
3529b9ee194Schristos /* Check for minimum size (ints at beginning + 1 subpackage) */
3539b9ee194Schristos
3549b9ee194Schristos ExpectedCount = Package->RetInfo4.Count1 + 1;
3559b9ee194Schristos if (Count < ExpectedCount)
3569b9ee194Schristos {
3579b9ee194Schristos goto PackageTooSmall;
3589b9ee194Schristos }
3599b9ee194Schristos
3609b9ee194Schristos /* Check the non-package elements at beginning of main package */
3619b9ee194Schristos
3629b9ee194Schristos for (i = 0; i < Package->RetInfo4.Count1; ++i)
3639b9ee194Schristos {
3641c663068Schristos ApCheckObjectType (Predefined->Info.Name, Op,
3659b9ee194Schristos Package->RetInfo4.ObjectType1, i);
3669b9ee194Schristos Op = Op->Asl.Next;
3679b9ee194Schristos }
3689b9ee194Schristos
3699b9ee194Schristos /* Examine the variable-length list of subpackages */
3709b9ee194Schristos
3719b9ee194Schristos ApCheckPackageList (Predefined->Info.Name, Op,
3729b9ee194Schristos Package, Package->RetInfo4.Count1, Count);
3739b9ee194Schristos
3749b9ee194Schristos break;
3759b9ee194Schristos
376ff4a156dSchristos case ACPI_PTYPE2:
377ff4a156dSchristos case ACPI_PTYPE2_FIXED:
378ff4a156dSchristos case ACPI_PTYPE2_MIN:
379ff4a156dSchristos case ACPI_PTYPE2_COUNT:
380ff4a156dSchristos case ACPI_PTYPE2_FIX_VAR:
381ff4a156dSchristos /*
382ff4a156dSchristos * These types all return a single Package that consists of a
383414ef032Schristos * variable number of subpackages.
384ff4a156dSchristos */
385ff4a156dSchristos
386414ef032Schristos /* Examine the subpackages */
387ff4a156dSchristos
388ff4a156dSchristos ApCheckPackageList (Predefined->Info.Name, Op,
389ff4a156dSchristos Package, 0, Count);
390ff4a156dSchristos break;
391ff4a156dSchristos
392ff4a156dSchristos default:
393ff4a156dSchristos return;
394ff4a156dSchristos }
395ff4a156dSchristos
396ff4a156dSchristos return;
397ff4a156dSchristos
398ff4a156dSchristos PackageTooSmall:
399ff4a156dSchristos ApPackageTooSmall (Predefined->Info.Name, ParentOp,
400ff4a156dSchristos Count, ExpectedCount);
401ff4a156dSchristos }
402ff4a156dSchristos
403ff4a156dSchristos
404ff4a156dSchristos /*******************************************************************************
405ff4a156dSchristos *
40649c2f1f4Schristos * FUNCTION: ApCustomPackage
40749c2f1f4Schristos *
40849c2f1f4Schristos * PARAMETERS: ParentOp - Parse op for the package
40949c2f1f4Schristos * Predefined - Pointer to package-specific info for
41049c2f1f4Schristos * the method
41149c2f1f4Schristos *
41249c2f1f4Schristos * RETURN: None
41349c2f1f4Schristos *
41449c2f1f4Schristos * DESCRIPTION: Validate packages that don't fit into the standard model and
41549c2f1f4Schristos * require custom code.
41649c2f1f4Schristos *
41749c2f1f4Schristos * NOTE: Currently used for the _BIX method only. When needed for two or more
41849c2f1f4Schristos * methods, probably a detect/dispatch mechanism will be required.
41949c2f1f4Schristos *
42049c2f1f4Schristos ******************************************************************************/
42149c2f1f4Schristos
42249c2f1f4Schristos static void
ApCustomPackage(ACPI_PARSE_OBJECT * ParentOp,const ACPI_PREDEFINED_INFO * Predefined)42349c2f1f4Schristos ApCustomPackage (
42449c2f1f4Schristos ACPI_PARSE_OBJECT *ParentOp,
42549c2f1f4Schristos const ACPI_PREDEFINED_INFO *Predefined)
42649c2f1f4Schristos {
42749c2f1f4Schristos ACPI_PARSE_OBJECT *Op;
42849c2f1f4Schristos UINT32 Count;
42949c2f1f4Schristos UINT32 ExpectedCount;
43049c2f1f4Schristos UINT32 Version;
43149c2f1f4Schristos
43249c2f1f4Schristos
43349c2f1f4Schristos /* First child is the package length */
43449c2f1f4Schristos
43549c2f1f4Schristos Op = ParentOp->Asl.Child;
43649c2f1f4Schristos Count = (UINT32) Op->Asl.Value.Integer;
43749c2f1f4Schristos
43849c2f1f4Schristos /* Get the version number, must be Integer */
43949c2f1f4Schristos
44049c2f1f4Schristos Op = Op->Asl.Next;
44149c2f1f4Schristos Version = (UINT32) Op->Asl.Value.Integer;
44249c2f1f4Schristos if (Op->Asl.ParseOpcode != PARSEOP_INTEGER)
44349c2f1f4Schristos {
4447efa3256Schristos AslError (ASL_ERROR, ASL_MSG_RESERVED_OPERAND_TYPE, Op, AslGbl_MsgBuffer);
44549c2f1f4Schristos return;
44649c2f1f4Schristos }
44749c2f1f4Schristos
44849c2f1f4Schristos /* Validate count (# of elements) */
44949c2f1f4Schristos
45049c2f1f4Schristos ExpectedCount = 21; /* Version 1 */
45149c2f1f4Schristos if (Version == 0)
45249c2f1f4Schristos {
45349c2f1f4Schristos ExpectedCount = 20; /* Version 0 */
45449c2f1f4Schristos }
45549c2f1f4Schristos
45649c2f1f4Schristos if (Count < ExpectedCount)
45749c2f1f4Schristos {
45849c2f1f4Schristos ApPackageTooSmall (Predefined->Info.Name, ParentOp,
45949c2f1f4Schristos Count, ExpectedCount);
46049c2f1f4Schristos return;
46149c2f1f4Schristos }
46249c2f1f4Schristos else if (Count > ExpectedCount)
46349c2f1f4Schristos {
46449c2f1f4Schristos ApPackageTooLarge (Predefined->Info.Name, ParentOp,
46549c2f1f4Schristos Count, ExpectedCount);
46649c2f1f4Schristos }
46749c2f1f4Schristos
46849c2f1f4Schristos /* Validate all elements of the package */
46949c2f1f4Schristos
47049c2f1f4Schristos Op = ApCheckPackageElements (Predefined->Info.Name, Op,
47149c2f1f4Schristos ACPI_RTYPE_INTEGER, 16,
47249c2f1f4Schristos ACPI_RTYPE_STRING, 4);
47349c2f1f4Schristos
47449c2f1f4Schristos /* Version 1 has a single trailing integer */
47549c2f1f4Schristos
47649c2f1f4Schristos if (Version > 0)
47749c2f1f4Schristos {
47849c2f1f4Schristos ApCheckPackageElements (Predefined->Info.Name, Op,
47949c2f1f4Schristos ACPI_RTYPE_INTEGER, 1, 0, 0);
48049c2f1f4Schristos }
48149c2f1f4Schristos }
48249c2f1f4Schristos
48349c2f1f4Schristos
48449c2f1f4Schristos /*******************************************************************************
48549c2f1f4Schristos *
486ff4a156dSchristos * FUNCTION: ApCheckPackageElements
487ff4a156dSchristos *
488ff4a156dSchristos * PARAMETERS: PredefinedName - Name of the predefined object
489ff4a156dSchristos * Op - Parser op for the package
490ff4a156dSchristos * Type1 - Object type for first group
491ff4a156dSchristos * Count1 - Count for first group
492ff4a156dSchristos * Type2 - Object type for second group
493ff4a156dSchristos * Count2 - Count for second group
494ff4a156dSchristos *
49549c2f1f4Schristos * RETURN: Next Op peer in the parse tree, after all specified elements
49649c2f1f4Schristos * have been validated. Used for multiple validations (calls
49749c2f1f4Schristos * to this function).
498ff4a156dSchristos *
499ff4a156dSchristos * DESCRIPTION: Validate all elements of a package. Works with packages that
500ff4a156dSchristos * are defined to contain up to two groups of different object
501ff4a156dSchristos * types.
502ff4a156dSchristos *
503ff4a156dSchristos ******************************************************************************/
504ff4a156dSchristos
50549c2f1f4Schristos static ACPI_PARSE_OBJECT *
ApCheckPackageElements(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT8 Type1,UINT32 Count1,UINT8 Type2,UINT32 Count2)506ff4a156dSchristos ApCheckPackageElements (
507ff4a156dSchristos const char *PredefinedName,
508ff4a156dSchristos ACPI_PARSE_OBJECT *Op,
509ff4a156dSchristos UINT8 Type1,
510ff4a156dSchristos UINT32 Count1,
511ff4a156dSchristos UINT8 Type2,
512ff4a156dSchristos UINT32 Count2)
513ff4a156dSchristos {
514ff4a156dSchristos UINT32 i;
515ff4a156dSchristos
516ff4a156dSchristos
517ff4a156dSchristos /*
518ff4a156dSchristos * Up to two groups of package elements are supported by the data
519ff4a156dSchristos * structure. All elements in each group must be of the same type.
520ff4a156dSchristos * The second group can have a count of zero.
521ff4a156dSchristos *
522ff4a156dSchristos * Aborts check upon a NULL package element, as this means (at compile
523ff4a156dSchristos * time) that the remainder of the package elements are also NULL
524ff4a156dSchristos * (This is the only way to create NULL package elements.)
525ff4a156dSchristos */
526ff4a156dSchristos for (i = 0; (i < Count1) && Op; i++)
527ff4a156dSchristos {
528ff4a156dSchristos ApCheckObjectType (PredefinedName, Op, Type1, i);
529ff4a156dSchristos Op = Op->Asl.Next;
530ff4a156dSchristos }
531ff4a156dSchristos
532ff4a156dSchristos for (i = 0; (i < Count2) && Op; i++)
533ff4a156dSchristos {
534ff4a156dSchristos ApCheckObjectType (PredefinedName, Op, Type2, (i + Count1));
535ff4a156dSchristos Op = Op->Asl.Next;
536ff4a156dSchristos }
53749c2f1f4Schristos
53849c2f1f4Schristos return (Op);
539ff4a156dSchristos }
540ff4a156dSchristos
541ff4a156dSchristos
542ff4a156dSchristos /*******************************************************************************
543ff4a156dSchristos *
544ff4a156dSchristos * FUNCTION: ApCheckPackageList
545ff4a156dSchristos *
546ff4a156dSchristos * PARAMETERS: PredefinedName - Name of the predefined object
547ff4a156dSchristos * ParentOp - Parser op of the parent package
548ff4a156dSchristos * Package - Package info for this predefined name
549ff4a156dSchristos * StartIndex - Index in parent package where list begins
550ff4a156dSchristos * ParentCount - Element count of parent package
551ff4a156dSchristos *
552ff4a156dSchristos * RETURN: None
553ff4a156dSchristos *
554ff4a156dSchristos * DESCRIPTION: Validate the individual package elements for a predefined name.
555ff4a156dSchristos * Handles the cases where the predefined name is defined as a
556ff4a156dSchristos * Package of Packages (subpackages). These are the types:
557ff4a156dSchristos *
558ff4a156dSchristos * ACPI_PTYPE2
559ff4a156dSchristos * ACPI_PTYPE2_FIXED
560ff4a156dSchristos * ACPI_PTYPE2_MIN
561ff4a156dSchristos * ACPI_PTYPE2_COUNT
562ff4a156dSchristos * ACPI_PTYPE2_FIX_VAR
5639b9ee194Schristos * ACPI_PTYPE2_VAR_VAR
564ff4a156dSchristos *
565ff4a156dSchristos ******************************************************************************/
566ff4a156dSchristos
567ff4a156dSchristos static void
ApCheckPackageList(const char * PredefinedName,ACPI_PARSE_OBJECT * ParentOp,const ACPI_PREDEFINED_INFO * Package,UINT32 StartIndex,UINT32 ParentCount)568ff4a156dSchristos ApCheckPackageList (
569ff4a156dSchristos const char *PredefinedName,
570ff4a156dSchristos ACPI_PARSE_OBJECT *ParentOp,
571ff4a156dSchristos const ACPI_PREDEFINED_INFO *Package,
572ff4a156dSchristos UINT32 StartIndex,
573ff4a156dSchristos UINT32 ParentCount)
574ff4a156dSchristos {
575ff4a156dSchristos ACPI_PARSE_OBJECT *SubPackageOp = ParentOp;
576ff4a156dSchristos ACPI_PARSE_OBJECT *Op;
577ff4a156dSchristos ACPI_STATUS Status;
578ff4a156dSchristos UINT32 Count;
579ff4a156dSchristos UINT32 ExpectedCount;
580ff4a156dSchristos UINT32 i;
581ff4a156dSchristos UINT32 j;
582ff4a156dSchristos
583ff4a156dSchristos
584ff4a156dSchristos /*
585ff4a156dSchristos * Validate each subpackage in the parent Package
586ff4a156dSchristos *
587ff4a156dSchristos * Note: We ignore NULL package elements on the assumption that
588ff4a156dSchristos * they will be initialized by the BIOS or other ASL code.
589ff4a156dSchristos */
590ff4a156dSchristos for (i = 0; (i < ParentCount) && SubPackageOp; i++)
591ff4a156dSchristos {
592ff4a156dSchristos /* Each object in the list must be of type Package */
593ff4a156dSchristos
594ff4a156dSchristos Status = ApCheckObjectType (PredefinedName, SubPackageOp,
595ff4a156dSchristos ACPI_RTYPE_PACKAGE, i + StartIndex);
596ff4a156dSchristos if (ACPI_FAILURE (Status))
597ff4a156dSchristos {
598ff4a156dSchristos goto NextSubpackage;
599ff4a156dSchristos }
600ff4a156dSchristos
601ff4a156dSchristos /* Examine the different types of expected subpackages */
602ff4a156dSchristos
603ff4a156dSchristos Op = SubPackageOp->Asl.Child;
604ff4a156dSchristos
605ff4a156dSchristos /* First child is the package length */
606ff4a156dSchristos
607ff4a156dSchristos Count = (UINT32) Op->Asl.Value.Integer;
608ff4a156dSchristos Op = Op->Asl.Next;
609ff4a156dSchristos
6109b9ee194Schristos /*
6119b9ee194Schristos * Most subpackage must have at least one element, with
6129b9ee194Schristos * only rare exceptions. (_RDI)
6139b9ee194Schristos */
6149b9ee194Schristos if (!Count &&
6159b9ee194Schristos (Package->RetInfo.Type != ACPI_PTYPE2_VAR_VAR))
616ff4a156dSchristos {
617ff4a156dSchristos ApZeroLengthPackage (PredefinedName, SubPackageOp);
618ff4a156dSchristos goto NextSubpackage;
619ff4a156dSchristos }
620ff4a156dSchristos
621ff4a156dSchristos /*
622ff4a156dSchristos * Decode the package type.
623ff4a156dSchristos * PTYPE2 indicates that a "package of packages" is expected for
624ff4a156dSchristos * this name. The various flavors of PTYPE2 indicate the number
625ff4a156dSchristos * and format of the subpackages.
626ff4a156dSchristos */
627ff4a156dSchristos switch (Package->RetInfo.Type)
628ff4a156dSchristos {
629ff4a156dSchristos case ACPI_PTYPE2:
630ff4a156dSchristos case ACPI_PTYPE2_PKG_COUNT:
631ff4a156dSchristos case ACPI_PTYPE2_REV_FIXED:
632ff4a156dSchristos
633ff4a156dSchristos /* Each subpackage has a fixed number of elements */
634ff4a156dSchristos
635ff4a156dSchristos ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
636ff4a156dSchristos if (Count < ExpectedCount)
637ff4a156dSchristos {
638ff4a156dSchristos ApPackageTooSmall (PredefinedName, SubPackageOp,
639ff4a156dSchristos Count, ExpectedCount);
640ff4a156dSchristos break;
641ff4a156dSchristos }
642414ef032Schristos if (Count > ExpectedCount)
643414ef032Schristos {
644414ef032Schristos ApPackageTooLarge (PredefinedName, SubPackageOp,
645414ef032Schristos Count, ExpectedCount);
646414ef032Schristos break;
647414ef032Schristos }
648ff4a156dSchristos
649ff4a156dSchristos ApCheckPackageElements (PredefinedName, Op,
650ff4a156dSchristos Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
651ff4a156dSchristos Package->RetInfo.ObjectType2, Package->RetInfo.Count2);
652ff4a156dSchristos break;
653ff4a156dSchristos
654ff4a156dSchristos case ACPI_PTYPE2_FIX_VAR:
655ff4a156dSchristos /*
656ff4a156dSchristos * Each subpackage has a fixed number of elements and an
657ff4a156dSchristos * optional element
658ff4a156dSchristos */
659ff4a156dSchristos ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
660ff4a156dSchristos if (Count < ExpectedCount)
661ff4a156dSchristos {
662ff4a156dSchristos ApPackageTooSmall (PredefinedName, SubPackageOp,
663ff4a156dSchristos Count, ExpectedCount);
664ff4a156dSchristos break;
665ff4a156dSchristos }
666ff4a156dSchristos
667ff4a156dSchristos ApCheckPackageElements (PredefinedName, Op,
668ff4a156dSchristos Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
669ff4a156dSchristos Package->RetInfo.ObjectType2,
670ff4a156dSchristos Count - Package->RetInfo.Count1);
671ff4a156dSchristos break;
672ff4a156dSchristos
6739b9ee194Schristos case ACPI_PTYPE2_VAR_VAR:
6749b9ee194Schristos /*
6759b9ee194Schristos * Must have at least the minimum number elements.
6769b9ee194Schristos * A zero PkgCount means the number of elements is variable.
6779b9ee194Schristos */
6789b9ee194Schristos ExpectedCount = Package->RetInfo4.PkgCount;
6799b9ee194Schristos if (ExpectedCount && (Count < ExpectedCount))
6809b9ee194Schristos {
6819b9ee194Schristos ApPackageTooSmall (PredefinedName, SubPackageOp,
6829b9ee194Schristos Count, 1);
6839b9ee194Schristos break;
6849b9ee194Schristos }
6859b9ee194Schristos
6869b9ee194Schristos ApCheckPackageElements (PredefinedName, Op,
6879b9ee194Schristos Package->RetInfo4.SubObjectTypes,
6889b9ee194Schristos Package->RetInfo4.PkgCount,
6899b9ee194Schristos 0, 0);
6909b9ee194Schristos break;
6919b9ee194Schristos
692ff4a156dSchristos case ACPI_PTYPE2_FIXED:
693ff4a156dSchristos
694414ef032Schristos /* Each subpackage has a fixed length */
695ff4a156dSchristos
696ff4a156dSchristos ExpectedCount = Package->RetInfo2.Count;
697ff4a156dSchristos if (Count < ExpectedCount)
698ff4a156dSchristos {
699ff4a156dSchristos ApPackageTooSmall (PredefinedName, SubPackageOp,
700ff4a156dSchristos Count, ExpectedCount);
701ff4a156dSchristos break;
702ff4a156dSchristos }
703414ef032Schristos if (Count > ExpectedCount)
704414ef032Schristos {
705414ef032Schristos ApPackageTooLarge (PredefinedName, SubPackageOp,
706414ef032Schristos Count, ExpectedCount);
707414ef032Schristos break;
708414ef032Schristos }
709ff4a156dSchristos
710ff4a156dSchristos /* Check each object/type combination */
711ff4a156dSchristos
712ff4a156dSchristos for (j = 0; j < ExpectedCount; j++)
713ff4a156dSchristos {
714ff4a156dSchristos ApCheckObjectType (PredefinedName, Op,
715ff4a156dSchristos Package->RetInfo2.ObjectType[j], j);
716ff4a156dSchristos
717ff4a156dSchristos Op = Op->Asl.Next;
718ff4a156dSchristos }
719ff4a156dSchristos break;
720ff4a156dSchristos
721ff4a156dSchristos case ACPI_PTYPE2_MIN:
722ff4a156dSchristos
723414ef032Schristos /* Each subpackage has a variable but minimum length */
724ff4a156dSchristos
725ff4a156dSchristos ExpectedCount = Package->RetInfo.Count1;
726ff4a156dSchristos if (Count < ExpectedCount)
727ff4a156dSchristos {
728ff4a156dSchristos ApPackageTooSmall (PredefinedName, SubPackageOp,
729ff4a156dSchristos Count, ExpectedCount);
730ff4a156dSchristos break;
731ff4a156dSchristos }
732ff4a156dSchristos
733414ef032Schristos /* Check the type of each subpackage element */
734ff4a156dSchristos
735ff4a156dSchristos ApCheckPackageElements (PredefinedName, Op,
736ff4a156dSchristos Package->RetInfo.ObjectType1, Count, 0, 0);
737ff4a156dSchristos break;
738ff4a156dSchristos
739ff4a156dSchristos case ACPI_PTYPE2_COUNT:
740ff4a156dSchristos /*
741ff4a156dSchristos * First element is the (Integer) count of elements, including
742ff4a156dSchristos * the count field (the ACPI name is NumElements)
743ff4a156dSchristos */
744ff4a156dSchristos Status = ApCheckObjectType (PredefinedName, Op,
745ff4a156dSchristos ACPI_RTYPE_INTEGER, 0);
746ff4a156dSchristos
747ff4a156dSchristos /* We must have an integer count from above (otherwise, use Count) */
748ff4a156dSchristos
749ff4a156dSchristos if (ACPI_SUCCESS (Status))
750ff4a156dSchristos {
751ff4a156dSchristos /*
752ff4a156dSchristos * Make sure package is large enough for the Count and is
753ff4a156dSchristos * is as large as the minimum size
754ff4a156dSchristos */
755ff4a156dSchristos ExpectedCount = (UINT32) Op->Asl.Value.Integer;
756ff4a156dSchristos
757ff4a156dSchristos if (Count < ExpectedCount)
758ff4a156dSchristos {
759ff4a156dSchristos ApPackageTooSmall (PredefinedName, SubPackageOp,
760ff4a156dSchristos Count, ExpectedCount);
761ff4a156dSchristos break;
762ff4a156dSchristos }
763ff4a156dSchristos else if (Count > ExpectedCount)
764ff4a156dSchristos {
765ff4a156dSchristos ApPackageTooLarge (PredefinedName, SubPackageOp,
766ff4a156dSchristos Count, ExpectedCount);
767ff4a156dSchristos }
768ff4a156dSchristos
769ff4a156dSchristos /* Some names of this type have a minimum length */
770ff4a156dSchristos
771ff4a156dSchristos if (Count < Package->RetInfo.Count1)
772ff4a156dSchristos {
773ff4a156dSchristos ExpectedCount = Package->RetInfo.Count1;
774ff4a156dSchristos ApPackageTooSmall (PredefinedName, SubPackageOp,
775ff4a156dSchristos Count, ExpectedCount);
776ff4a156dSchristos break;
777ff4a156dSchristos }
778ff4a156dSchristos
779ff4a156dSchristos Count = ExpectedCount;
780ff4a156dSchristos }
781ff4a156dSchristos
782414ef032Schristos /* Check the type of each subpackage element */
783ff4a156dSchristos
784ff4a156dSchristos Op = Op->Asl.Next;
785ff4a156dSchristos ApCheckPackageElements (PredefinedName, Op,
786ff4a156dSchristos Package->RetInfo.ObjectType1, (Count - 1), 0, 0);
787ff4a156dSchristos break;
788ff4a156dSchristos
789ff4a156dSchristos default:
790ff4a156dSchristos break;
791ff4a156dSchristos }
792ff4a156dSchristos
793ff4a156dSchristos NextSubpackage:
794ff4a156dSchristos SubPackageOp = SubPackageOp->Asl.Next;
795ff4a156dSchristos }
796ff4a156dSchristos }
797ff4a156dSchristos
798ff4a156dSchristos
799ff4a156dSchristos /*******************************************************************************
800ff4a156dSchristos *
801ff4a156dSchristos * FUNCTION: ApPackageTooSmall
802ff4a156dSchristos *
803ff4a156dSchristos * PARAMETERS: PredefinedName - Name of the predefined object
804ff4a156dSchristos * Op - Current parser op
805ff4a156dSchristos * Count - Actual package element count
806ff4a156dSchristos * ExpectedCount - Expected package element count
807ff4a156dSchristos *
808ff4a156dSchristos * RETURN: None
809ff4a156dSchristos *
810ff4a156dSchristos * DESCRIPTION: Issue error message for a package that is smaller than
811ff4a156dSchristos * required.
812ff4a156dSchristos *
813ff4a156dSchristos ******************************************************************************/
814ff4a156dSchristos
815ff4a156dSchristos static void
ApPackageTooSmall(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT32 Count,UINT32 ExpectedCount)816ff4a156dSchristos ApPackageTooSmall (
817ff4a156dSchristos const char *PredefinedName,
818ff4a156dSchristos ACPI_PARSE_OBJECT *Op,
819ff4a156dSchristos UINT32 Count,
820ff4a156dSchristos UINT32 ExpectedCount)
821ff4a156dSchristos {
822ff4a156dSchristos
823b558e860Schristos snprintf (AslGbl_MsgBuffer, sizeof(AslGbl_MsgBuffer), "%4.4s: length %u, required minimum is %u",
824ff4a156dSchristos PredefinedName, Count, ExpectedCount);
825ff4a156dSchristos
8267efa3256Schristos AslError (ASL_ERROR, ASL_MSG_RESERVED_PACKAGE_LENGTH, Op, AslGbl_MsgBuffer);
827ff4a156dSchristos }
828ff4a156dSchristos
829ff4a156dSchristos
830ff4a156dSchristos /*******************************************************************************
831ff4a156dSchristos *
832ff4a156dSchristos * FUNCTION: ApZeroLengthPackage
833ff4a156dSchristos *
834ff4a156dSchristos * PARAMETERS: PredefinedName - Name of the predefined object
835ff4a156dSchristos * Op - Current parser op
836ff4a156dSchristos *
837ff4a156dSchristos * RETURN: None
838ff4a156dSchristos *
839ff4a156dSchristos * DESCRIPTION: Issue error message for a zero-length package (a package that
840ff4a156dSchristos * is required to have a non-zero length). Variable length
841ff4a156dSchristos * packages seem to be allowed to have zero length, however.
842ff4a156dSchristos * Even if not allowed, BIOS code does it.
843ff4a156dSchristos *
844ff4a156dSchristos ******************************************************************************/
845ff4a156dSchristos
846ff4a156dSchristos static void
ApZeroLengthPackage(const char * PredefinedName,ACPI_PARSE_OBJECT * Op)847ff4a156dSchristos ApZeroLengthPackage (
848ff4a156dSchristos const char *PredefinedName,
849ff4a156dSchristos ACPI_PARSE_OBJECT *Op)
850ff4a156dSchristos {
851ff4a156dSchristos
852b558e860Schristos snprintf (AslGbl_MsgBuffer, sizeof(AslGbl_MsgBuffer), "%4.4s: length is zero", PredefinedName);
853ff4a156dSchristos
8547efa3256Schristos AslError (ASL_ERROR, ASL_MSG_RESERVED_PACKAGE_LENGTH, Op, AslGbl_MsgBuffer);
855ff4a156dSchristos }
856ff4a156dSchristos
857ff4a156dSchristos
858ff4a156dSchristos /*******************************************************************************
859ff4a156dSchristos *
860ff4a156dSchristos * FUNCTION: ApPackageTooLarge
861ff4a156dSchristos *
862ff4a156dSchristos * PARAMETERS: PredefinedName - Name of the predefined object
863ff4a156dSchristos * Op - Current parser op
864ff4a156dSchristos * Count - Actual package element count
865ff4a156dSchristos * ExpectedCount - Expected package element count
866ff4a156dSchristos *
867ff4a156dSchristos * RETURN: None
868ff4a156dSchristos *
869ff4a156dSchristos * DESCRIPTION: Issue a remark for a package that is larger than expected.
870ff4a156dSchristos *
871ff4a156dSchristos ******************************************************************************/
872ff4a156dSchristos
873ff4a156dSchristos static void
ApPackageTooLarge(const char * PredefinedName,ACPI_PARSE_OBJECT * Op,UINT32 Count,UINT32 ExpectedCount)874ff4a156dSchristos ApPackageTooLarge (
875ff4a156dSchristos const char *PredefinedName,
876ff4a156dSchristos ACPI_PARSE_OBJECT *Op,
877ff4a156dSchristos UINT32 Count,
878ff4a156dSchristos UINT32 ExpectedCount)
879ff4a156dSchristos {
880ff4a156dSchristos
881b558e860Schristos snprintf (AslGbl_MsgBuffer, sizeof(AslGbl_MsgBuffer), "%4.4s: length is %u, only %u required",
882ff4a156dSchristos PredefinedName, Count, ExpectedCount);
883ff4a156dSchristos
8847efa3256Schristos AslError (ASL_REMARK, ASL_MSG_RESERVED_PACKAGE_LENGTH, Op, AslGbl_MsgBuffer);
885ff4a156dSchristos }
886