1 /******************************************************************************
3 * Module Name: nsprepkg - Validation of package objects for predefined names
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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.
44 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsprepkg")
52 /* Local prototypes */
54 acpi_ns_check_package_list(struct acpi_predefined_data *data,
55 const union acpi_predefined_info *package,
56 union acpi_operand_object **elements, u32 count);
59 acpi_ns_check_package_elements(struct acpi_predefined_data *data,
60 union acpi_operand_object **elements,
63 u8 type2, u32 count2, u32 start_index);
65 /*******************************************************************************
67 * FUNCTION: acpi_ns_check_package
69 * PARAMETERS: data - Pointer to validation data structure
70 * return_object_ptr - Pointer to the object returned from the
71 * evaluation of a method or object
75 * DESCRIPTION: Check a returned package object for the correct count and
76 * correct type of all sub-objects.
78 ******************************************************************************/
81 acpi_ns_check_package(struct acpi_predefined_data *data,
82 union acpi_operand_object **return_object_ptr)
84 union acpi_operand_object *return_object = *return_object_ptr;
85 const union acpi_predefined_info *package;
86 union acpi_operand_object **elements;
87 acpi_status status = AE_OK;
92 ACPI_FUNCTION_NAME(ns_check_package);
94 /* The package info for this name is in the next table entry */
96 package = data->predefined + 1;
98 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
99 "%s Validating return Package of Type %X, Count %X\n",
100 data->pathname, package->ret_info.type,
101 return_object->package.count));
104 * For variable-length Packages, we can safely remove all embedded
105 * and trailing NULL package elements
107 acpi_ns_remove_null_elements(data, package->ret_info.type,
110 /* Extract package count and elements array */
112 elements = return_object->package.elements;
113 count = return_object->package.count;
115 /* The package must have at least one element, else invalid */
118 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
119 "Return Package has no elements (empty)"));
121 return (AE_AML_OPERAND_VALUE);
125 * Decode the type of the expected package contents
127 * PTYPE1 packages contain no subpackages
128 * PTYPE2 packages contain sub-packages
130 switch (package->ret_info.type) {
131 case ACPI_PTYPE1_FIXED:
134 * The package count is fixed and there are no sub-packages
136 * If package is too small, exit.
137 * If package is larger than expected, issue warning but continue
140 package->ret_info.count1 + package->ret_info.count2;
141 if (count < expected_count) {
142 goto package_too_small;
143 } else if (count > expected_count) {
144 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
145 "%s: Return Package is larger than needed - "
146 "found %u, expected %u\n",
147 data->pathname, count,
151 /* Validate all elements of the returned package */
153 status = acpi_ns_check_package_elements(data, elements,
164 case ACPI_PTYPE1_VAR:
167 * The package count is variable, there are no sub-packages, and all
168 * elements must be of the same type
170 for (i = 0; i < count; i++) {
171 status = acpi_ns_check_object_type(data, elements,
174 if (ACPI_FAILURE(status)) {
181 case ACPI_PTYPE1_OPTION:
184 * The package count is variable, there are no sub-packages. There are
185 * a fixed number of required elements, and a variable number of
188 * Check if package is at least as large as the minimum required
190 expected_count = package->ret_info3.count;
191 if (count < expected_count) {
192 goto package_too_small;
195 /* Variable number of sub-objects */
197 for (i = 0; i < count; i++) {
198 if (i < package->ret_info3.count) {
200 /* These are the required package elements (0, 1, or 2) */
203 acpi_ns_check_object_type(data, elements,
208 if (ACPI_FAILURE(status)) {
212 /* These are the optional package elements */
215 acpi_ns_check_object_type(data, elements,
220 if (ACPI_FAILURE(status)) {
228 case ACPI_PTYPE2_REV_FIXED:
230 /* First element is the (Integer) revision */
232 status = acpi_ns_check_object_type(data, elements,
233 ACPI_RTYPE_INTEGER, 0);
234 if (ACPI_FAILURE(status)) {
241 /* Examine the sub-packages */
244 acpi_ns_check_package_list(data, package, elements, count);
247 case ACPI_PTYPE2_PKG_COUNT:
249 /* First element is the (Integer) count of sub-packages to follow */
251 status = acpi_ns_check_object_type(data, elements,
252 ACPI_RTYPE_INTEGER, 0);
253 if (ACPI_FAILURE(status)) {
258 * Count cannot be larger than the parent package length, but allow it
259 * to be smaller. The >= accounts for the Integer above.
261 expected_count = (u32)(*elements)->integer.value;
262 if (expected_count >= count) {
263 goto package_too_small;
266 count = expected_count;
269 /* Examine the sub-packages */
272 acpi_ns_check_package_list(data, package, elements, count);
276 case ACPI_PTYPE2_FIXED:
277 case ACPI_PTYPE2_MIN:
278 case ACPI_PTYPE2_COUNT:
279 case ACPI_PTYPE2_FIX_VAR:
282 * These types all return a single Package that consists of a
283 * variable number of sub-Packages.
285 * First, ensure that the first element is a sub-Package. If not,
286 * the BIOS may have incorrectly returned the object as a single
287 * package instead of a Package of Packages (a common error if
288 * there is only one entry). We may be able to repair this by
289 * wrapping the returned Package with a new outer Package.
292 && ((*elements)->common.type != ACPI_TYPE_PACKAGE)) {
294 /* Create the new outer package and populate it */
297 acpi_ns_wrap_with_package(data, return_object,
299 if (ACPI_FAILURE(status)) {
303 /* Update locals to point to the new package (of 1 element) */
305 return_object = *return_object_ptr;
306 elements = return_object->package.elements;
310 /* Examine the sub-packages */
313 acpi_ns_check_package_list(data, package, elements, count);
318 /* Should not get here if predefined info table is correct */
320 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
321 "Invalid internal return type in table entry: %X",
322 package->ret_info.type));
324 return (AE_AML_INTERNAL);
331 /* Error exit for the case with an incorrect package count */
333 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
334 "Return Package is too small - found %u elements, expected %u",
335 count, expected_count));
337 return (AE_AML_OPERAND_VALUE);
340 /*******************************************************************************
342 * FUNCTION: acpi_ns_check_package_list
344 * PARAMETERS: data - Pointer to validation data structure
345 * package - Pointer to package-specific info for method
346 * elements - Element list of parent package. All elements
347 * of this list should be of type Package.
348 * count - Count of subpackages
352 * DESCRIPTION: Examine a list of subpackages
354 ******************************************************************************/
357 acpi_ns_check_package_list(struct acpi_predefined_data *data,
358 const union acpi_predefined_info *package,
359 union acpi_operand_object **elements, u32 count)
361 union acpi_operand_object *sub_package;
362 union acpi_operand_object **sub_elements;
369 * Validate each sub-Package in the parent Package
371 * NOTE: assumes list of sub-packages contains no NULL elements.
372 * Any NULL elements should have been removed by earlier call
373 * to acpi_ns_remove_null_elements.
375 for (i = 0; i < count; i++) {
376 sub_package = *elements;
377 sub_elements = sub_package->package.elements;
378 data->parent_package = sub_package;
380 /* Each sub-object must be of type Package */
382 status = acpi_ns_check_object_type(data, &sub_package,
383 ACPI_RTYPE_PACKAGE, i);
384 if (ACPI_FAILURE(status)) {
388 /* Examine the different types of expected sub-packages */
390 data->parent_package = sub_package;
391 switch (package->ret_info.type) {
393 case ACPI_PTYPE2_PKG_COUNT:
394 case ACPI_PTYPE2_REV_FIXED:
396 /* Each subpackage has a fixed number of elements */
399 package->ret_info.count1 + package->ret_info.count2;
400 if (sub_package->package.count < expected_count) {
401 goto package_too_small;
405 acpi_ns_check_package_elements(data, sub_elements,
414 if (ACPI_FAILURE(status)) {
419 case ACPI_PTYPE2_FIX_VAR:
421 * Each subpackage has a fixed number of elements and an
425 package->ret_info.count1 + package->ret_info.count2;
426 if (sub_package->package.count < expected_count) {
427 goto package_too_small;
431 acpi_ns_check_package_elements(data, sub_elements,
438 sub_package->package.
442 if (ACPI_FAILURE(status)) {
447 case ACPI_PTYPE2_FIXED:
449 /* Each sub-package has a fixed length */
451 expected_count = package->ret_info2.count;
452 if (sub_package->package.count < expected_count) {
453 goto package_too_small;
456 /* Check the type of each sub-package element */
458 for (j = 0; j < expected_count; j++) {
460 acpi_ns_check_object_type(data,
466 if (ACPI_FAILURE(status)) {
472 case ACPI_PTYPE2_MIN:
474 /* Each sub-package has a variable but minimum length */
476 expected_count = package->ret_info.count1;
477 if (sub_package->package.count < expected_count) {
478 goto package_too_small;
481 /* Check the type of each sub-package element */
484 acpi_ns_check_package_elements(data, sub_elements,
487 sub_package->package.
489 if (ACPI_FAILURE(status)) {
494 case ACPI_PTYPE2_COUNT:
497 * First element is the (Integer) count of elements, including
498 * the count field (the ACPI name is num_elements)
500 status = acpi_ns_check_object_type(data, sub_elements,
503 if (ACPI_FAILURE(status)) {
508 * Make sure package is large enough for the Count and is
509 * is as large as the minimum size
511 expected_count = (u32)(*sub_elements)->integer.value;
512 if (sub_package->package.count < expected_count) {
513 goto package_too_small;
515 if (sub_package->package.count <
516 package->ret_info.count1) {
517 expected_count = package->ret_info.count1;
518 goto package_too_small;
520 if (expected_count == 0) {
522 * Either the num_entries element was originally zero or it was
523 * a NULL element and repaired to an Integer of value zero.
524 * In either case, repair it by setting num_entries to be the
525 * actual size of the subpackage.
527 expected_count = sub_package->package.count;
528 (*sub_elements)->integer.value = expected_count;
531 /* Check the type of each sub-package element */
534 acpi_ns_check_package_elements(data,
538 (expected_count - 1),
540 if (ACPI_FAILURE(status)) {
545 default: /* Should not get here, type was validated by caller */
547 return (AE_AML_INTERNAL);
557 /* The sub-package count was smaller than required */
559 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
560 "Return Sub-Package[%u] is too small - found %u elements, expected %u",
561 i, sub_package->package.count, expected_count));
563 return (AE_AML_OPERAND_VALUE);
566 /*******************************************************************************
568 * FUNCTION: acpi_ns_check_package_elements
570 * PARAMETERS: data - Pointer to validation data structure
571 * elements - Pointer to the package elements array
572 * type1 - Object type for first group
573 * count1 - Count for first group
574 * type2 - Object type for second group
575 * count2 - Count for second group
576 * start_index - Start of the first group of elements
580 * DESCRIPTION: Check that all elements of a package are of the correct object
581 * type. Supports up to two groups of different object types.
583 ******************************************************************************/
586 acpi_ns_check_package_elements(struct acpi_predefined_data *data,
587 union acpi_operand_object **elements,
590 u8 type2, u32 count2, u32 start_index)
592 union acpi_operand_object **this_element = elements;
597 * Up to two groups of package elements are supported by the data
598 * structure. All elements in each group must be of the same type.
599 * The second group can have a count of zero.
601 for (i = 0; i < count1; i++) {
602 status = acpi_ns_check_object_type(data, this_element,
603 type1, i + start_index);
604 if (ACPI_FAILURE(status)) {
610 for (i = 0; i < count2; i++) {
611 status = acpi_ns_check_object_type(data, this_element,
613 (i + count1 + start_index));
614 if (ACPI_FAILURE(status)) {