1 /******************************************************************************
3 * Module Name: nspredef - Validation of ACPI predefined methods and objects
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #define ACPI_CREATE_PREDEFINED_TABLE
119 #include "accommon.h"
120 #include "acnamesp.h"
121 #include "acpredef.h"
124 #define _COMPONENT ACPI_NAMESPACE
125 ACPI_MODULE_NAME ("nspredef")
128 /*******************************************************************************
130 * This module validates predefined ACPI objects that appear in the namespace,
131 * at the time they are evaluated (via AcpiEvaluateObject). The purpose of this
132 * validation is to detect problems with BIOS-exposed predefined ACPI objects
133 * before the results are returned to the ACPI-related drivers.
135 * There are several areas that are validated:
137 * 1) The number of input arguments as defined by the method/object in the
138 * ASL is validated against the ACPI specification.
139 * 2) The type of the return object (if any) is validated against the ACPI
141 * 3) For returned package objects, the count of package elements is
142 * validated, as well as the type of each package element. Nested
143 * packages are supported.
145 * For any problems found, a warning message is issued.
147 ******************************************************************************/
150 /* Local prototypes */
154 ACPI_PREDEFINED_DATA
*Data
,
155 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
);
158 AcpiNsCheckPackageList (
159 ACPI_PREDEFINED_DATA
*Data
,
160 const ACPI_PREDEFINED_INFO
*Package
,
161 ACPI_OPERAND_OBJECT
**Elements
,
165 AcpiNsCheckPackageElements (
166 ACPI_PREDEFINED_DATA
*Data
,
167 ACPI_OPERAND_OBJECT
**Elements
,
175 AcpiNsCheckObjectType (
176 ACPI_PREDEFINED_DATA
*Data
,
177 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
,
178 UINT32 ExpectedBtypes
,
179 UINT32 PackageIndex
);
182 AcpiNsCheckReference (
183 ACPI_PREDEFINED_DATA
*Data
,
184 ACPI_OPERAND_OBJECT
*ReturnObject
);
187 AcpiNsGetExpectedTypes (
189 UINT32 ExpectedBtypes
);
192 * Names for the types that can be returned by the predefined objects.
193 * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
195 static const char *AcpiRtypeNames
[] =
205 /*******************************************************************************
207 * FUNCTION: AcpiNsCheckPredefinedNames
209 * PARAMETERS: Node - Namespace node for the method/object
210 * UserParamCount - Number of parameters actually passed
211 * ReturnStatus - Status from the object evaluation
212 * ReturnObjectPtr - Pointer to the object returned from the
213 * evaluation of a method or object
217 * DESCRIPTION: Check an ACPI name for a match in the predefined name list.
219 ******************************************************************************/
222 AcpiNsCheckPredefinedNames (
223 ACPI_NAMESPACE_NODE
*Node
,
224 UINT32 UserParamCount
,
225 ACPI_STATUS ReturnStatus
,
226 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
228 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
229 ACPI_STATUS Status
= AE_OK
;
230 const ACPI_PREDEFINED_INFO
*Predefined
;
232 ACPI_PREDEFINED_DATA
*Data
;
235 /* Match the name for this method/object against the predefined list */
237 Predefined
= AcpiNsCheckForPredefinedName (Node
);
239 /* Get the full pathname to the object, for use in warning messages */
241 Pathname
= AcpiNsGetExternalPathname (Node
);
244 return (AE_OK
); /* Could not get pathname, ignore */
248 * Check that the parameter count for this method matches the ASL
249 * definition. For predefined names, ensure that both the caller and
250 * the method itself are in accordance with the ACPI specification.
252 AcpiNsCheckParameterCount (Pathname
, Node
, UserParamCount
, Predefined
);
254 /* If not a predefined name, we cannot validate the return object */
262 * If the method failed or did not actually return an object, we cannot
263 * validate the return object
265 if ((ReturnStatus
!= AE_OK
) && (ReturnStatus
!= AE_CTRL_RETURN_VALUE
))
271 * If there is no return value, check if we require a return value for
272 * this predefined name. Either one return value is expected, or none,
273 * for both methods and other objects.
275 * Exit now if there is no return object. Warning if one was expected.
279 if ((Predefined
->Info
.ExpectedBtypes
) &&
280 (!(Predefined
->Info
.ExpectedBtypes
& ACPI_RTYPE_NONE
)))
282 ACPI_WARN_PREDEFINED ((AE_INFO
, Pathname
, ACPI_WARN_ALWAYS
,
283 "Missing expected return value"));
285 Status
= AE_AML_NO_RETURN_VALUE
;
291 * 1) We have a return value, but if one wasn't expected, just exit, this is
292 * not a problem. For example, if the "Implicit Return" feature is
293 * enabled, methods will always return a value.
295 * 2) If the return value can be of any type, then we cannot perform any
298 if ((!Predefined
->Info
.ExpectedBtypes
) ||
299 (Predefined
->Info
.ExpectedBtypes
== ACPI_RTYPE_ALL
))
304 /* Create the parameter data block for object validation */
306 Data
= ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PREDEFINED_DATA
));
311 Data
->Predefined
= Predefined
;
312 Data
->NodeFlags
= Node
->Flags
;
313 Data
->Pathname
= Pathname
;
316 * Check that the type of the main return object is what is expected
317 * for this predefined name
319 Status
= AcpiNsCheckObjectType (Data
, ReturnObjectPtr
,
320 Predefined
->Info
.ExpectedBtypes
, ACPI_NOT_PACKAGE_ELEMENT
);
321 if (ACPI_FAILURE (Status
))
327 * For returned Package objects, check the type of all sub-objects.
328 * Note: Package may have been newly created by call above.
330 if ((*ReturnObjectPtr
)->Common
.Type
== ACPI_TYPE_PACKAGE
)
332 Status
= AcpiNsCheckPackage (Data
, ReturnObjectPtr
);
333 if (ACPI_FAILURE (Status
))
340 * The return object was OK, or it was successfully repaired above.
341 * Now make some additional checks such as verifying that package
342 * objects are sorted correctly (if required) or buffer objects have
343 * the correct data width (bytes vs. dwords). These repairs are
344 * performed on a per-name basis, i.e., the code is specific to
345 * particular predefined names.
347 Status
= AcpiNsComplexRepairs (Data
, Node
, Status
, ReturnObjectPtr
);
351 * If the object validation failed or if we successfully repaired one
352 * or more objects, mark the parent node to suppress further warning
353 * messages during the next evaluation of the same method/object.
355 if (ACPI_FAILURE (Status
) || (Data
->Flags
& ACPI_OBJECT_REPAIRED
))
357 Node
->Flags
|= ANOBJ_EVALUATED
;
362 ACPI_FREE (Pathname
);
367 /*******************************************************************************
369 * FUNCTION: AcpiNsCheckParameterCount
371 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
372 * Node - Namespace node for the method/object
373 * UserParamCount - Number of args passed in by the caller
374 * Predefined - Pointer to entry in predefined name table
378 * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
379 * predefined name is what is expected (i.e., what is defined in
380 * the ACPI specification for this predefined name.)
382 ******************************************************************************/
385 AcpiNsCheckParameterCount (
387 ACPI_NAMESPACE_NODE
*Node
,
388 UINT32 UserParamCount
,
389 const ACPI_PREDEFINED_INFO
*Predefined
)
392 UINT32 RequiredParamsCurrent
;
393 UINT32 RequiredParamsOld
;
396 /* Methods have 0-7 parameters. All other types have zero. */
399 if (Node
->Type
== ACPI_TYPE_METHOD
)
401 ParamCount
= Node
->Object
->Method
.ParamCount
;
407 * Check the parameter count for non-predefined methods/objects.
409 * Warning if too few or too many arguments have been passed by the
410 * caller. An incorrect number of arguments may not cause the method
411 * to fail. However, the method will fail if there are too few
412 * arguments and the method attempts to use one of the missing ones.
414 if (UserParamCount
< ParamCount
)
416 ACPI_WARN_PREDEFINED ((AE_INFO
, Pathname
, ACPI_WARN_ALWAYS
,
417 "Insufficient arguments - needs %u, found %u",
418 ParamCount
, UserParamCount
));
420 else if (UserParamCount
> ParamCount
)
422 ACPI_WARN_PREDEFINED ((AE_INFO
, Pathname
, ACPI_WARN_ALWAYS
,
423 "Excess arguments - needs %u, found %u",
424 ParamCount
, UserParamCount
));
430 * Validate the user-supplied parameter count.
431 * Allow two different legal argument counts (_SCP, etc.)
433 RequiredParamsCurrent
= Predefined
->Info
.ParamCount
& 0x0F;
434 RequiredParamsOld
= Predefined
->Info
.ParamCount
>> 4;
436 if (UserParamCount
!= ACPI_UINT32_MAX
)
438 if ((UserParamCount
!= RequiredParamsCurrent
) &&
439 (UserParamCount
!= RequiredParamsOld
))
441 ACPI_WARN_PREDEFINED ((AE_INFO
, Pathname
, ACPI_WARN_ALWAYS
,
442 "Parameter count mismatch - "
443 "caller passed %u, ACPI requires %u",
444 UserParamCount
, RequiredParamsCurrent
));
449 * Check that the ASL-defined parameter count is what is expected for
450 * this predefined name (parameter count as defined by the ACPI
453 if ((ParamCount
!= RequiredParamsCurrent
) &&
454 (ParamCount
!= RequiredParamsOld
))
456 ACPI_WARN_PREDEFINED ((AE_INFO
, Pathname
, Node
->Flags
,
457 "Parameter count mismatch - ASL declared %u, ACPI requires %u",
458 ParamCount
, RequiredParamsCurrent
));
463 /*******************************************************************************
465 * FUNCTION: AcpiNsCheckForPredefinedName
467 * PARAMETERS: Node - Namespace node for the method/object
469 * RETURN: Pointer to entry in predefined table. NULL indicates not found.
471 * DESCRIPTION: Check an object name against the predefined object list.
473 ******************************************************************************/
475 const ACPI_PREDEFINED_INFO
*
476 AcpiNsCheckForPredefinedName (
477 ACPI_NAMESPACE_NODE
*Node
)
479 const ACPI_PREDEFINED_INFO
*ThisName
;
482 /* Quick check for a predefined name, first character must be underscore */
484 if (Node
->Name
.Ascii
[0] != '_')
489 /* Search info table for a predefined method/object name */
491 ThisName
= PredefinedNames
;
492 while (ThisName
->Info
.Name
[0])
494 if (ACPI_COMPARE_NAME (Node
->Name
.Ascii
, ThisName
->Info
.Name
))
500 * Skip next entry in the table if this name returns a Package
501 * (next entry contains the package info)
503 if (ThisName
->Info
.ExpectedBtypes
& ACPI_RTYPE_PACKAGE
)
511 return (NULL
); /* Not found */
515 /*******************************************************************************
517 * FUNCTION: AcpiNsCheckPackage
519 * PARAMETERS: Data - Pointer to validation data structure
520 * ReturnObjectPtr - Pointer to the object returned from the
521 * evaluation of a method or object
525 * DESCRIPTION: Check a returned package object for the correct count and
526 * correct type of all sub-objects.
528 ******************************************************************************/
532 ACPI_PREDEFINED_DATA
*Data
,
533 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
535 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
536 const ACPI_PREDEFINED_INFO
*Package
;
537 ACPI_OPERAND_OBJECT
**Elements
;
538 ACPI_STATUS Status
= AE_OK
;
539 UINT32 ExpectedCount
;
544 ACPI_FUNCTION_NAME (NsCheckPackage
);
547 /* The package info for this name is in the next table entry */
549 Package
= Data
->Predefined
+ 1;
551 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
,
552 "%s Validating return Package of Type %X, Count %X\n",
553 Data
->Pathname
, Package
->RetInfo
.Type
, ReturnObject
->Package
.Count
));
556 * For variable-length Packages, we can safely remove all embedded
557 * and trailing NULL package elements
559 AcpiNsRemoveNullElements (Data
, Package
->RetInfo
.Type
, ReturnObject
);
561 /* Extract package count and elements array */
563 Elements
= ReturnObject
->Package
.Elements
;
564 Count
= ReturnObject
->Package
.Count
;
566 /* The package must have at least one element, else invalid */
570 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
571 "Return Package has no elements (empty)"));
573 return (AE_AML_OPERAND_VALUE
);
577 * Decode the type of the expected package contents
579 * PTYPE1 packages contain no subpackages
580 * PTYPE2 packages contain sub-packages
582 switch (Package
->RetInfo
.Type
)
584 case ACPI_PTYPE1_FIXED
:
587 * The package count is fixed and there are no sub-packages
589 * If package is too small, exit.
590 * If package is larger than expected, issue warning but continue
592 ExpectedCount
= Package
->RetInfo
.Count1
+ Package
->RetInfo
.Count2
;
593 if (Count
< ExpectedCount
)
595 goto PackageTooSmall
;
597 else if (Count
> ExpectedCount
)
599 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
600 "%s: Return Package is larger than needed - "
601 "found %u, expected %u\n",
602 Data
->Pathname
, Count
, ExpectedCount
));
605 /* Validate all elements of the returned package */
607 Status
= AcpiNsCheckPackageElements (Data
, Elements
,
608 Package
->RetInfo
.ObjectType1
, Package
->RetInfo
.Count1
,
609 Package
->RetInfo
.ObjectType2
, Package
->RetInfo
.Count2
, 0);
613 case ACPI_PTYPE1_VAR
:
616 * The package count is variable, there are no sub-packages, and all
617 * elements must be of the same type
619 for (i
= 0; i
< Count
; i
++)
621 Status
= AcpiNsCheckObjectType (Data
, Elements
,
622 Package
->RetInfo
.ObjectType1
, i
);
623 if (ACPI_FAILURE (Status
))
632 case ACPI_PTYPE1_OPTION
:
635 * The package count is variable, there are no sub-packages. There are
636 * a fixed number of required elements, and a variable number of
639 * Check if package is at least as large as the minimum required
641 ExpectedCount
= Package
->RetInfo3
.Count
;
642 if (Count
< ExpectedCount
)
644 goto PackageTooSmall
;
647 /* Variable number of sub-objects */
649 for (i
= 0; i
< Count
; i
++)
651 if (i
< Package
->RetInfo3
.Count
)
653 /* These are the required package elements (0, 1, or 2) */
655 Status
= AcpiNsCheckObjectType (Data
, Elements
,
656 Package
->RetInfo3
.ObjectType
[i
], i
);
657 if (ACPI_FAILURE (Status
))
664 /* These are the optional package elements */
666 Status
= AcpiNsCheckObjectType (Data
, Elements
,
667 Package
->RetInfo3
.TailObjectType
, i
);
668 if (ACPI_FAILURE (Status
))
678 case ACPI_PTYPE2_REV_FIXED
:
680 /* First element is the (Integer) revision */
682 Status
= AcpiNsCheckObjectType (Data
, Elements
,
683 ACPI_RTYPE_INTEGER
, 0);
684 if (ACPI_FAILURE (Status
))
692 /* Examine the sub-packages */
694 Status
= AcpiNsCheckPackageList (Data
, Package
, Elements
, Count
);
698 case ACPI_PTYPE2_PKG_COUNT
:
700 /* First element is the (Integer) count of sub-packages to follow */
702 Status
= AcpiNsCheckObjectType (Data
, Elements
,
703 ACPI_RTYPE_INTEGER
, 0);
704 if (ACPI_FAILURE (Status
))
710 * Count cannot be larger than the parent package length, but allow it
711 * to be smaller. The >= accounts for the Integer above.
713 ExpectedCount
= (UINT32
) (*Elements
)->Integer
.Value
;
714 if (ExpectedCount
>= Count
)
716 goto PackageTooSmall
;
719 Count
= ExpectedCount
;
722 /* Examine the sub-packages */
724 Status
= AcpiNsCheckPackageList (Data
, Package
, Elements
, Count
);
729 case ACPI_PTYPE2_FIXED
:
730 case ACPI_PTYPE2_MIN
:
731 case ACPI_PTYPE2_COUNT
:
734 * These types all return a single Package that consists of a
735 * variable number of sub-Packages.
737 * First, ensure that the first element is a sub-Package. If not,
738 * the BIOS may have incorrectly returned the object as a single
739 * package instead of a Package of Packages (a common error if
740 * there is only one entry). We may be able to repair this by
741 * wrapping the returned Package with a new outer Package.
743 if (*Elements
&& ((*Elements
)->Common
.Type
!= ACPI_TYPE_PACKAGE
))
745 /* Create the new outer package and populate it */
747 Status
= AcpiNsRepairPackageList (Data
, ReturnObjectPtr
);
748 if (ACPI_FAILURE (Status
))
753 /* Update locals to point to the new package (of 1 element) */
755 ReturnObject
= *ReturnObjectPtr
;
756 Elements
= ReturnObject
->Package
.Elements
;
760 /* Examine the sub-packages */
762 Status
= AcpiNsCheckPackageList (Data
, Package
, Elements
, Count
);
768 /* Should not get here if predefined info table is correct */
770 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
771 "Invalid internal return type in table entry: %X",
772 Package
->RetInfo
.Type
));
774 return (AE_AML_INTERNAL
);
782 /* Error exit for the case with an incorrect package count */
784 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
785 "Return Package is too small - found %u elements, expected %u",
786 Count
, ExpectedCount
));
788 return (AE_AML_OPERAND_VALUE
);
792 /*******************************************************************************
794 * FUNCTION: AcpiNsCheckPackageList
796 * PARAMETERS: Data - Pointer to validation data structure
797 * Package - Pointer to package-specific info for method
798 * Elements - Element list of parent package. All elements
799 * of this list should be of type Package.
800 * Count - Count of subpackages
804 * DESCRIPTION: Examine a list of subpackages
806 ******************************************************************************/
809 AcpiNsCheckPackageList (
810 ACPI_PREDEFINED_DATA
*Data
,
811 const ACPI_PREDEFINED_INFO
*Package
,
812 ACPI_OPERAND_OBJECT
**Elements
,
815 ACPI_OPERAND_OBJECT
*SubPackage
;
816 ACPI_OPERAND_OBJECT
**SubElements
;
818 UINT32 ExpectedCount
;
824 * Validate each sub-Package in the parent Package
826 * NOTE: assumes list of sub-packages contains no NULL elements.
827 * Any NULL elements should have been removed by earlier call
828 * to AcpiNsRemoveNullElements.
830 for (i
= 0; i
< Count
; i
++)
832 SubPackage
= *Elements
;
833 SubElements
= SubPackage
->Package
.Elements
;
835 /* Each sub-object must be of type Package */
837 Status
= AcpiNsCheckObjectType (Data
, &SubPackage
,
838 ACPI_RTYPE_PACKAGE
, i
);
839 if (ACPI_FAILURE (Status
))
844 /* Examine the different types of expected sub-packages */
846 switch (Package
->RetInfo
.Type
)
849 case ACPI_PTYPE2_PKG_COUNT
:
850 case ACPI_PTYPE2_REV_FIXED
:
852 /* Each subpackage has a fixed number of elements */
854 ExpectedCount
= Package
->RetInfo
.Count1
+ Package
->RetInfo
.Count2
;
855 if (SubPackage
->Package
.Count
< ExpectedCount
)
857 goto PackageTooSmall
;
860 Status
= AcpiNsCheckPackageElements (Data
, SubElements
,
861 Package
->RetInfo
.ObjectType1
,
862 Package
->RetInfo
.Count1
,
863 Package
->RetInfo
.ObjectType2
,
864 Package
->RetInfo
.Count2
, 0);
865 if (ACPI_FAILURE (Status
))
872 case ACPI_PTYPE2_FIXED
:
874 /* Each sub-package has a fixed length */
876 ExpectedCount
= Package
->RetInfo2
.Count
;
877 if (SubPackage
->Package
.Count
< ExpectedCount
)
879 goto PackageTooSmall
;
882 /* Check the type of each sub-package element */
884 for (j
= 0; j
< ExpectedCount
; j
++)
886 Status
= AcpiNsCheckObjectType (Data
, &SubElements
[j
],
887 Package
->RetInfo2
.ObjectType
[j
], j
);
888 if (ACPI_FAILURE (Status
))
896 case ACPI_PTYPE2_MIN
:
898 /* Each sub-package has a variable but minimum length */
900 ExpectedCount
= Package
->RetInfo
.Count1
;
901 if (SubPackage
->Package
.Count
< ExpectedCount
)
903 goto PackageTooSmall
;
906 /* Check the type of each sub-package element */
908 Status
= AcpiNsCheckPackageElements (Data
, SubElements
,
909 Package
->RetInfo
.ObjectType1
,
910 SubPackage
->Package
.Count
, 0, 0, 0);
911 if (ACPI_FAILURE (Status
))
918 case ACPI_PTYPE2_COUNT
:
921 * First element is the (Integer) count of elements, including
924 Status
= AcpiNsCheckObjectType (Data
, SubElements
,
925 ACPI_RTYPE_INTEGER
, 0);
926 if (ACPI_FAILURE (Status
))
932 * Make sure package is large enough for the Count and is
933 * is as large as the minimum size
935 ExpectedCount
= (UINT32
) (*SubElements
)->Integer
.Value
;
936 if (SubPackage
->Package
.Count
< ExpectedCount
)
938 goto PackageTooSmall
;
940 if (SubPackage
->Package
.Count
< Package
->RetInfo
.Count1
)
942 ExpectedCount
= Package
->RetInfo
.Count1
;
943 goto PackageTooSmall
;
946 /* Check the type of each sub-package element */
948 Status
= AcpiNsCheckPackageElements (Data
, (SubElements
+ 1),
949 Package
->RetInfo
.ObjectType1
,
950 (ExpectedCount
- 1), 0, 0, 1);
951 if (ACPI_FAILURE (Status
))
958 default: /* Should not get here, type was validated by caller */
960 return (AE_AML_INTERNAL
);
971 /* The sub-package count was smaller than required */
973 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
974 "Return Sub-Package[%u] is too small - found %u elements, expected %u",
975 i
, SubPackage
->Package
.Count
, ExpectedCount
));
977 return (AE_AML_OPERAND_VALUE
);
981 /*******************************************************************************
983 * FUNCTION: AcpiNsCheckPackageElements
985 * PARAMETERS: Data - Pointer to validation data structure
986 * Elements - Pointer to the package elements array
987 * Type1 - Object type for first group
988 * Count1 - Count for first group
989 * Type2 - Object type for second group
990 * Count2 - Count for second group
991 * StartIndex - Start of the first group of elements
995 * DESCRIPTION: Check that all elements of a package are of the correct object
996 * type. Supports up to two groups of different object types.
998 ******************************************************************************/
1001 AcpiNsCheckPackageElements (
1002 ACPI_PREDEFINED_DATA
*Data
,
1003 ACPI_OPERAND_OBJECT
**Elements
,
1010 ACPI_OPERAND_OBJECT
**ThisElement
= Elements
;
1016 * Up to two groups of package elements are supported by the data
1017 * structure. All elements in each group must be of the same type.
1018 * The second group can have a count of zero.
1020 for (i
= 0; i
< Count1
; i
++)
1022 Status
= AcpiNsCheckObjectType (Data
, ThisElement
,
1023 Type1
, i
+ StartIndex
);
1024 if (ACPI_FAILURE (Status
))
1031 for (i
= 0; i
< Count2
; i
++)
1033 Status
= AcpiNsCheckObjectType (Data
, ThisElement
,
1034 Type2
, (i
+ Count1
+ StartIndex
));
1035 if (ACPI_FAILURE (Status
))
1046 /*******************************************************************************
1048 * FUNCTION: AcpiNsCheckObjectType
1050 * PARAMETERS: Data - Pointer to validation data structure
1051 * ReturnObjectPtr - Pointer to the object returned from the
1052 * evaluation of a method or object
1053 * ExpectedBtypes - Bitmap of expected return type(s)
1054 * PackageIndex - Index of object within parent package (if
1055 * applicable - ACPI_NOT_PACKAGE_ELEMENT
1060 * DESCRIPTION: Check the type of the return object against the expected object
1061 * type(s). Use of Btype allows multiple expected object types.
1063 ******************************************************************************/
1066 AcpiNsCheckObjectType (
1067 ACPI_PREDEFINED_DATA
*Data
,
1068 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
,
1069 UINT32 ExpectedBtypes
,
1070 UINT32 PackageIndex
)
1072 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
1073 ACPI_STATUS Status
= AE_OK
;
1075 char TypeBuffer
[48]; /* Room for 5 types */
1079 * If we get a NULL ReturnObject here, it is a NULL package element,
1080 * and this is always an error.
1087 /* A Namespace node should not get here, but make sure */
1089 if (ACPI_GET_DESCRIPTOR_TYPE (ReturnObject
) == ACPI_DESC_TYPE_NAMED
)
1091 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
1092 "Invalid return type - Found a Namespace node [%4.4s] type %s",
1093 ReturnObject
->Node
.Name
.Ascii
,
1094 AcpiUtGetTypeName (ReturnObject
->Node
.Type
)));
1095 return (AE_AML_OPERAND_TYPE
);
1099 * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
1100 * The bitmapped type allows multiple possible return types.
1102 * Note, the cases below must handle all of the possible types returned
1103 * from all of the predefined names (including elements of returned
1106 switch (ReturnObject
->Common
.Type
)
1108 case ACPI_TYPE_INTEGER
:
1109 ReturnBtype
= ACPI_RTYPE_INTEGER
;
1112 case ACPI_TYPE_BUFFER
:
1113 ReturnBtype
= ACPI_RTYPE_BUFFER
;
1116 case ACPI_TYPE_STRING
:
1117 ReturnBtype
= ACPI_RTYPE_STRING
;
1120 case ACPI_TYPE_PACKAGE
:
1121 ReturnBtype
= ACPI_RTYPE_PACKAGE
;
1124 case ACPI_TYPE_LOCAL_REFERENCE
:
1125 ReturnBtype
= ACPI_RTYPE_REFERENCE
;
1129 /* Not one of the supported objects, must be incorrect */
1134 /* Is the object one of the expected types? */
1136 if (!(ReturnBtype
& ExpectedBtypes
))
1138 /* Type mismatch -- attempt repair of the returned object */
1140 Status
= AcpiNsRepairObject (Data
, ExpectedBtypes
,
1141 PackageIndex
, ReturnObjectPtr
);
1142 if (ACPI_SUCCESS (Status
))
1144 return (AE_OK
); /* Repair was successful */
1149 /* For reference objects, check that the reference type is correct */
1151 if (ReturnObject
->Common
.Type
== ACPI_TYPE_LOCAL_REFERENCE
)
1153 Status
= AcpiNsCheckReference (Data
, ReturnObject
);
1161 /* Create a string with all expected types for this predefined object */
1163 AcpiNsGetExpectedTypes (TypeBuffer
, ExpectedBtypes
);
1165 if (PackageIndex
== ACPI_NOT_PACKAGE_ELEMENT
)
1167 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
1168 "Return type mismatch - found %s, expected %s",
1169 AcpiUtGetObjectTypeName (ReturnObject
), TypeBuffer
));
1173 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
1174 "Return Package type mismatch at index %u - "
1175 "found %s, expected %s", PackageIndex
,
1176 AcpiUtGetObjectTypeName (ReturnObject
), TypeBuffer
));
1179 return (AE_AML_OPERAND_TYPE
);
1183 /*******************************************************************************
1185 * FUNCTION: AcpiNsCheckReference
1187 * PARAMETERS: Data - Pointer to validation data structure
1188 * ReturnObject - Object returned from the evaluation of a
1193 * DESCRIPTION: Check a returned reference object for the correct reference
1194 * type. The only reference type that can be returned from a
1195 * predefined method is a named reference. All others are invalid.
1197 ******************************************************************************/
1200 AcpiNsCheckReference (
1201 ACPI_PREDEFINED_DATA
*Data
,
1202 ACPI_OPERAND_OBJECT
*ReturnObject
)
1206 * Check the reference object for the correct reference type (opcode).
1207 * The only type of reference that can be converted to an ACPI_OBJECT is
1208 * a reference to a named object (reference class: NAME)
1210 if (ReturnObject
->Reference
.Class
== ACPI_REFCLASS_NAME
)
1215 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
1216 "Return type mismatch - unexpected reference object type [%s] %2.2X",
1217 AcpiUtGetReferenceName (ReturnObject
),
1218 ReturnObject
->Reference
.Class
));
1220 return (AE_AML_OPERAND_TYPE
);
1224 /*******************************************************************************
1226 * FUNCTION: AcpiNsGetExpectedTypes
1228 * PARAMETERS: Buffer - Pointer to where the string is returned
1229 * ExpectedBtypes - Bitmap of expected return type(s)
1231 * RETURN: Buffer is populated with type names.
1233 * DESCRIPTION: Translate the expected types bitmap into a string of ascii
1234 * names of expected types, for use in warning messages.
1236 ******************************************************************************/
1239 AcpiNsGetExpectedTypes (
1241 UINT32 ExpectedBtypes
)
1250 ThisRtype
= ACPI_RTYPE_INTEGER
;
1252 for (i
= 0; i
< ACPI_NUM_RTYPES
; i
++)
1254 /* If one of the expected types, concatenate the name of this type */
1256 if (ExpectedBtypes
& ThisRtype
)
1258 ACPI_STRCAT (Buffer
, &AcpiRtypeNames
[i
][j
]);
1259 j
= 0; /* Use name separator from now on */
1261 ThisRtype
<<= 1; /* Next Rtype */