1 /******************************************************************************
3 * Module Name: nsprepkg - Validation of package objects for predefined names
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
50 #define _COMPONENT ACPI_NAMESPACE
51 ACPI_MODULE_NAME ("nsprepkg")
54 /* Local prototypes */
57 AcpiNsCheckPackageList (
58 ACPI_EVALUATE_INFO *Info,
59 const ACPI_PREDEFINED_INFO *Package,
60 ACPI_OPERAND_OBJECT **Elements,
64 AcpiNsCheckPackageElements (
65 ACPI_EVALUATE_INFO *Info,
66 ACPI_OPERAND_OBJECT **Elements,
74 /*******************************************************************************
76 * FUNCTION: AcpiNsCheckPackage
78 * PARAMETERS: Info - Method execution information block
79 * ReturnObjectPtr - Pointer to the object returned from the
80 * evaluation of a method or object
84 * DESCRIPTION: Check a returned package object for the correct count and
85 * correct type of all sub-objects.
87 ******************************************************************************/
91 ACPI_EVALUATE_INFO *Info,
92 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
94 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
95 const ACPI_PREDEFINED_INFO *Package;
96 ACPI_OPERAND_OBJECT **Elements;
97 ACPI_STATUS Status = AE_OK;
103 ACPI_FUNCTION_NAME (NsCheckPackage);
106 /* The package info for this name is in the next table entry */
108 Package = Info->Predefined + 1;
110 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
111 "%s Validating return Package of Type %X, Count %X\n",
112 Info->FullPathname, Package->RetInfo.Type,
113 ReturnObject->Package.Count));
116 * For variable-length Packages, we can safely remove all embedded
117 * and trailing NULL package elements
119 AcpiNsRemoveNullElements (Info, Package->RetInfo.Type, ReturnObject);
121 /* Extract package count and elements array */
123 Elements = ReturnObject->Package.Elements;
124 Count = ReturnObject->Package.Count;
127 * Most packages must have at least one element. The only exception
128 * is the variable-length package (ACPI_PTYPE1_VAR).
132 if (Package->RetInfo.Type == ACPI_PTYPE1_VAR)
137 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
138 "Return Package has no elements (empty)"));
140 return (AE_AML_OPERAND_VALUE);
144 * Decode the type of the expected package contents
146 * PTYPE1 packages contain no subpackages
147 * PTYPE2 packages contain subpackages
149 switch (Package->RetInfo.Type)
151 case ACPI_PTYPE1_FIXED:
153 * The package count is fixed and there are no subpackages
155 * If package is too small, exit.
156 * If package is larger than expected, issue warning but continue
158 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
159 if (Count < ExpectedCount)
161 goto PackageTooSmall;
163 else if (Count > ExpectedCount)
165 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
166 "%s: Return Package is larger than needed - "
167 "found %u, expected %u\n",
168 Info->FullPathname, Count, ExpectedCount));
171 /* Validate all elements of the returned package */
173 Status = AcpiNsCheckPackageElements (Info, Elements,
174 Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
175 Package->RetInfo.ObjectType2, Package->RetInfo.Count2, 0);
178 case ACPI_PTYPE1_VAR:
180 * The package count is variable, there are no subpackages, and all
181 * elements must be of the same type
183 for (i = 0; i < Count; i++)
185 Status = AcpiNsCheckObjectType (Info, Elements,
186 Package->RetInfo.ObjectType1, i);
187 if (ACPI_FAILURE (Status))
195 case ACPI_PTYPE1_OPTION:
197 * The package count is variable, there are no subpackages. There are
198 * a fixed number of required elements, and a variable number of
201 * Check if package is at least as large as the minimum required
203 ExpectedCount = Package->RetInfo3.Count;
204 if (Count < ExpectedCount)
206 goto PackageTooSmall;
209 /* Variable number of sub-objects */
211 for (i = 0; i < Count; i++)
213 if (i < Package->RetInfo3.Count)
215 /* These are the required package elements (0, 1, or 2) */
217 Status = AcpiNsCheckObjectType (Info, Elements,
218 Package->RetInfo3.ObjectType[i], i);
219 if (ACPI_FAILURE (Status))
226 /* These are the optional package elements */
228 Status = AcpiNsCheckObjectType (Info, Elements,
229 Package->RetInfo3.TailObjectType, i);
230 if (ACPI_FAILURE (Status))
239 case ACPI_PTYPE2_REV_FIXED:
241 /* First element is the (Integer) revision */
243 Status = AcpiNsCheckObjectType (Info, Elements,
244 ACPI_RTYPE_INTEGER, 0);
245 if (ACPI_FAILURE (Status))
253 /* Examine the subpackages */
255 Status = AcpiNsCheckPackageList (Info, Package, Elements, Count);
258 case ACPI_PTYPE2_PKG_COUNT:
260 /* First element is the (Integer) count of subpackages to follow */
262 Status = AcpiNsCheckObjectType (Info, Elements,
263 ACPI_RTYPE_INTEGER, 0);
264 if (ACPI_FAILURE (Status))
270 * Count cannot be larger than the parent package length, but allow it
271 * to be smaller. The >= accounts for the Integer above.
273 ExpectedCount = (UINT32) (*Elements)->Integer.Value;
274 if (ExpectedCount >= Count)
276 goto PackageTooSmall;
279 Count = ExpectedCount;
282 /* Examine the subpackages */
284 Status = AcpiNsCheckPackageList (Info, Package, Elements, Count);
288 case ACPI_PTYPE2_FIXED:
289 case ACPI_PTYPE2_MIN:
290 case ACPI_PTYPE2_COUNT:
291 case ACPI_PTYPE2_FIX_VAR:
293 * These types all return a single Package that consists of a
294 * variable number of subpackages.
296 * First, ensure that the first element is a subpackage. If not,
297 * the BIOS may have incorrectly returned the object as a single
298 * package instead of a Package of Packages (a common error if
299 * there is only one entry). We may be able to repair this by
300 * wrapping the returned Package with a new outer Package.
302 if (*Elements && ((*Elements)->Common.Type != ACPI_TYPE_PACKAGE))
304 /* Create the new outer package and populate it */
306 Status = AcpiNsWrapWithPackage (Info, ReturnObject, ReturnObjectPtr);
307 if (ACPI_FAILURE (Status))
312 /* Update locals to point to the new package (of 1 element) */
314 ReturnObject = *ReturnObjectPtr;
315 Elements = ReturnObject->Package.Elements;
319 /* Examine the subpackages */
321 Status = AcpiNsCheckPackageList (Info, Package, Elements, Count);
324 case ACPI_PTYPE2_UUID_PAIR:
326 /* The package must contain pairs of (UUID + type) */
330 ExpectedCount = Count + 1;
331 goto PackageTooSmall;
336 Status = AcpiNsCheckObjectType(Info, Elements,
337 Package->RetInfo.ObjectType1, 0);
338 if (ACPI_FAILURE(Status))
343 /* Validate length of the UUID buffer */
345 if ((*Elements)->Buffer.Length != 16)
347 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname,
348 Info->NodeFlags, "Invalid length for UUID Buffer"));
349 return (AE_AML_OPERAND_VALUE);
352 Status = AcpiNsCheckObjectType(Info, Elements + 1,
353 Package->RetInfo.ObjectType2, 0);
354 if (ACPI_FAILURE(Status))
366 /* Should not get here if predefined info table is correct */
368 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
369 "Invalid internal return type in table entry: %X",
370 Package->RetInfo.Type));
372 return (AE_AML_INTERNAL);
380 /* Error exit for the case with an incorrect package count */
382 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
383 "Return Package is too small - found %u elements, expected %u",
384 Count, ExpectedCount));
386 return (AE_AML_OPERAND_VALUE);
390 /*******************************************************************************
392 * FUNCTION: AcpiNsCheckPackageList
394 * PARAMETERS: Info - Method execution information block
395 * Package - Pointer to package-specific info for method
396 * Elements - Element list of parent package. All elements
397 * of this list should be of type Package.
398 * Count - Count of subpackages
402 * DESCRIPTION: Examine a list of subpackages
404 ******************************************************************************/
407 AcpiNsCheckPackageList (
408 ACPI_EVALUATE_INFO *Info,
409 const ACPI_PREDEFINED_INFO *Package,
410 ACPI_OPERAND_OBJECT **Elements,
413 ACPI_OPERAND_OBJECT *SubPackage;
414 ACPI_OPERAND_OBJECT **SubElements;
416 UINT32 ExpectedCount;
422 * Validate each subpackage in the parent Package
424 * NOTE: assumes list of subpackages contains no NULL elements.
425 * Any NULL elements should have been removed by earlier call
426 * to AcpiNsRemoveNullElements.
428 for (i = 0; i < Count; i++)
430 SubPackage = *Elements;
431 SubElements = SubPackage->Package.Elements;
432 Info->ParentPackage = SubPackage;
434 /* Each sub-object must be of type Package */
436 Status = AcpiNsCheckObjectType (Info, &SubPackage,
437 ACPI_RTYPE_PACKAGE, i);
438 if (ACPI_FAILURE (Status))
443 /* Examine the different types of expected subpackages */
445 Info->ParentPackage = SubPackage;
446 switch (Package->RetInfo.Type)
449 case ACPI_PTYPE2_PKG_COUNT:
450 case ACPI_PTYPE2_REV_FIXED:
452 /* Each subpackage has a fixed number of elements */
454 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
455 if (SubPackage->Package.Count < ExpectedCount)
457 goto PackageTooSmall;
460 Status = AcpiNsCheckPackageElements (Info, SubElements,
461 Package->RetInfo.ObjectType1,
462 Package->RetInfo.Count1,
463 Package->RetInfo.ObjectType2,
464 Package->RetInfo.Count2, 0);
465 if (ACPI_FAILURE (Status))
471 case ACPI_PTYPE2_FIX_VAR:
473 * Each subpackage has a fixed number of elements and an
476 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
477 if (SubPackage->Package.Count < ExpectedCount)
479 goto PackageTooSmall;
482 Status = AcpiNsCheckPackageElements (Info, SubElements,
483 Package->RetInfo.ObjectType1,
484 Package->RetInfo.Count1,
485 Package->RetInfo.ObjectType2,
486 SubPackage->Package.Count - Package->RetInfo.Count1, 0);
487 if (ACPI_FAILURE (Status))
493 case ACPI_PTYPE2_FIXED:
495 /* Each subpackage has a fixed length */
497 ExpectedCount = Package->RetInfo2.Count;
498 if (SubPackage->Package.Count < ExpectedCount)
500 goto PackageTooSmall;
503 /* Check the type of each subpackage element */
505 for (j = 0; j < ExpectedCount; j++)
507 Status = AcpiNsCheckObjectType (Info, &SubElements[j],
508 Package->RetInfo2.ObjectType[j], j);
509 if (ACPI_FAILURE (Status))
516 case ACPI_PTYPE2_MIN:
518 /* Each subpackage has a variable but minimum length */
520 ExpectedCount = Package->RetInfo.Count1;
521 if (SubPackage->Package.Count < ExpectedCount)
523 goto PackageTooSmall;
526 /* Check the type of each subpackage element */
528 Status = AcpiNsCheckPackageElements (Info, SubElements,
529 Package->RetInfo.ObjectType1,
530 SubPackage->Package.Count, 0, 0, 0);
531 if (ACPI_FAILURE (Status))
537 case ACPI_PTYPE2_COUNT:
539 * First element is the (Integer) count of elements, including
540 * the count field (the ACPI name is NumElements)
542 Status = AcpiNsCheckObjectType (Info, SubElements,
543 ACPI_RTYPE_INTEGER, 0);
544 if (ACPI_FAILURE (Status))
550 * Make sure package is large enough for the Count and is
551 * is as large as the minimum size
553 ExpectedCount = (UINT32) (*SubElements)->Integer.Value;
554 if (SubPackage->Package.Count < ExpectedCount)
556 goto PackageTooSmall;
558 if (SubPackage->Package.Count < Package->RetInfo.Count1)
560 ExpectedCount = Package->RetInfo.Count1;
561 goto PackageTooSmall;
563 if (ExpectedCount == 0)
566 * Either the NumEntries element was originally zero or it was
567 * a NULL element and repaired to an Integer of value zero.
568 * In either case, repair it by setting NumEntries to be the
569 * actual size of the subpackage.
571 ExpectedCount = SubPackage->Package.Count;
572 (*SubElements)->Integer.Value = ExpectedCount;
575 /* Check the type of each subpackage element */
577 Status = AcpiNsCheckPackageElements (Info, (SubElements + 1),
578 Package->RetInfo.ObjectType1,
579 (ExpectedCount - 1), 0, 0, 1);
580 if (ACPI_FAILURE (Status))
586 default: /* Should not get here, type was validated by caller */
588 return (AE_AML_INTERNAL);
599 /* The subpackage count was smaller than required */
601 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
602 "Return SubPackage[%u] is too small - found %u elements, expected %u",
603 i, SubPackage->Package.Count, ExpectedCount));
605 return (AE_AML_OPERAND_VALUE);
609 /*******************************************************************************
611 * FUNCTION: AcpiNsCheckPackageElements
613 * PARAMETERS: Info - Method execution information block
614 * Elements - Pointer to the package elements array
615 * Type1 - Object type for first group
616 * Count1 - Count for first group
617 * Type2 - Object type for second group
618 * Count2 - Count for second group
619 * StartIndex - Start of the first group of elements
623 * DESCRIPTION: Check that all elements of a package are of the correct object
624 * type. Supports up to two groups of different object types.
626 ******************************************************************************/
629 AcpiNsCheckPackageElements (
630 ACPI_EVALUATE_INFO *Info,
631 ACPI_OPERAND_OBJECT **Elements,
638 ACPI_OPERAND_OBJECT **ThisElement = Elements;
644 * Up to two groups of package elements are supported by the data
645 * structure. All elements in each group must be of the same type.
646 * The second group can have a count of zero.
648 for (i = 0; i < Count1; i++)
650 Status = AcpiNsCheckObjectType (Info, ThisElement,
651 Type1, i + StartIndex);
652 if (ACPI_FAILURE (Status))
659 for (i = 0; i < Count2; i++)
661 Status = AcpiNsCheckObjectType (Info, ThisElement,
662 Type2, (i + Count1 + StartIndex));
663 if (ACPI_FAILURE (Status))