1 /******************************************************************************
3 * Module Name: nspredef - Validation of ACPI predefined methods and objects
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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 #define ACPI_CREATE_PREDEFINED_TABLE
46 #include <acpi/acpi.h>
51 #define _COMPONENT ACPI_NAMESPACE
52 ACPI_MODULE_NAME("nspredef")
54 /*******************************************************************************
56 * This module validates predefined ACPI objects that appear in the namespace,
57 * at the time they are evaluated (via acpi_evaluate_object). The purpose of this
58 * validation is to detect problems with BIOS-exposed predefined ACPI objects
59 * before the results are returned to the ACPI-related drivers.
61 * There are several areas that are validated:
63 * 1) The number of input arguments as defined by the method/object in the
64 * ASL is validated against the ACPI specification.
65 * 2) The type of the return object (if any) is validated against the ACPI
67 * 3) For returned package objects, the count of package elements is
68 * validated, as well as the type of each package element. Nested
69 * packages are supported.
71 * For any problems found, a warning message is issued.
73 ******************************************************************************/
74 /* Local prototypes */
76 acpi_ns_check_package(struct acpi_predefined_data *data,
77 union acpi_operand_object **return_object_ptr);
80 acpi_ns_check_package_list(struct acpi_predefined_data *data,
81 const union acpi_predefined_info *package,
82 union acpi_operand_object **elements, u32 count);
85 acpi_ns_check_package_elements(struct acpi_predefined_data *data,
86 union acpi_operand_object **elements,
89 u8 type2, u32 count2, u32 start_index);
92 acpi_ns_check_object_type(struct acpi_predefined_data *data,
93 union acpi_operand_object **return_object_ptr,
94 u32 expected_btypes, u32 package_index);
97 acpi_ns_check_reference(struct acpi_predefined_data *data,
98 union acpi_operand_object *return_object);
100 static void acpi_ns_get_expected_types(char *buffer, u32 expected_btypes);
103 * Names for the types that can be returned by the predefined objects.
104 * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
106 static const char *acpi_rtype_names[] = {
114 /*******************************************************************************
116 * FUNCTION: acpi_ns_check_predefined_names
118 * PARAMETERS: node - Namespace node for the method/object
119 * user_param_count - Number of parameters actually passed
120 * return_status - Status from the object evaluation
121 * return_object_ptr - Pointer to the object returned from the
122 * evaluation of a method or object
126 * DESCRIPTION: Check an ACPI name for a match in the predefined name list.
128 ******************************************************************************/
131 acpi_ns_check_predefined_names(struct acpi_namespace_node *node,
132 u32 user_param_count,
133 acpi_status return_status,
134 union acpi_operand_object **return_object_ptr)
136 union acpi_operand_object *return_object = *return_object_ptr;
137 acpi_status status = AE_OK;
138 const union acpi_predefined_info *predefined;
140 struct acpi_predefined_data *data;
142 /* Match the name for this method/object against the predefined list */
144 predefined = acpi_ns_check_for_predefined_name(node);
146 /* Get the full pathname to the object, for use in warning messages */
148 pathname = acpi_ns_get_external_pathname(node);
150 return (AE_OK); /* Could not get pathname, ignore */
154 * Check that the parameter count for this method matches the ASL
155 * definition. For predefined names, ensure that both the caller and
156 * the method itself are in accordance with the ACPI specification.
158 acpi_ns_check_parameter_count(pathname, node, user_param_count,
161 /* If not a predefined name, we cannot validate the return object */
168 * If the method failed or did not actually return an object, we cannot
169 * validate the return object
171 if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) {
176 * If there is no return value, check if we require a return value for
177 * this predefined name. Either one return value is expected, or none,
178 * for both methods and other objects.
180 * Exit now if there is no return object. Warning if one was expected.
182 if (!return_object) {
183 if ((predefined->info.expected_btypes) &&
184 (!(predefined->info.expected_btypes & ACPI_RTYPE_NONE))) {
185 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
187 "Missing expected return value"));
189 status = AE_AML_NO_RETURN_VALUE;
195 * Return value validation and possible repair.
197 * 1) Don't perform return value validation/repair if this feature
198 * has been disabled via a global option.
200 * 2) We have a return value, but if one wasn't expected, just exit,
201 * this is not a problem. For example, if the "Implicit Return"
202 * feature is enabled, methods will always return a value.
204 * 3) If the return value can be of any type, then we cannot perform
205 * any validation, just exit.
207 if (acpi_gbl_disable_auto_repair ||
208 (!predefined->info.expected_btypes) ||
209 (predefined->info.expected_btypes == ACPI_RTYPE_ALL)) {
213 /* Create the parameter data block for object validation */
215 data = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_predefined_data));
219 data->predefined = predefined;
221 data->node_flags = node->flags;
222 data->pathname = pathname;
225 * Check that the type of the main return object is what is expected
226 * for this predefined name
228 status = acpi_ns_check_object_type(data, return_object_ptr,
229 predefined->info.expected_btypes,
230 ACPI_NOT_PACKAGE_ELEMENT);
231 if (ACPI_FAILURE(status)) {
236 * For returned Package objects, check the type of all sub-objects.
237 * Note: Package may have been newly created by call above.
239 if ((*return_object_ptr)->common.type == ACPI_TYPE_PACKAGE) {
240 data->parent_package = *return_object_ptr;
241 status = acpi_ns_check_package(data, return_object_ptr);
242 if (ACPI_FAILURE(status)) {
248 * The return object was OK, or it was successfully repaired above.
249 * Now make some additional checks such as verifying that package
250 * objects are sorted correctly (if required) or buffer objects have
251 * the correct data width (bytes vs. dwords). These repairs are
252 * performed on a per-name basis, i.e., the code is specific to
253 * particular predefined names.
255 status = acpi_ns_complex_repairs(data, node, status, return_object_ptr);
259 * If the object validation failed or if we successfully repaired one
260 * or more objects, mark the parent node to suppress further warning
261 * messages during the next evaluation of the same method/object.
263 if (ACPI_FAILURE(status) || (data->flags & ACPI_OBJECT_REPAIRED)) {
264 node->flags |= ANOBJ_EVALUATED;
273 /*******************************************************************************
275 * FUNCTION: acpi_ns_check_parameter_count
277 * PARAMETERS: pathname - Full pathname to the node (for error msgs)
278 * node - Namespace node for the method/object
279 * user_param_count - Number of args passed in by the caller
280 * predefined - Pointer to entry in predefined name table
284 * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
285 * predefined name is what is expected (i.e., what is defined in
286 * the ACPI specification for this predefined name.)
288 ******************************************************************************/
291 acpi_ns_check_parameter_count(char *pathname,
292 struct acpi_namespace_node *node,
293 u32 user_param_count,
294 const union acpi_predefined_info *predefined)
297 u32 required_params_current;
298 u32 required_params_old;
300 /* Methods have 0-7 parameters. All other types have zero. */
303 if (node->type == ACPI_TYPE_METHOD) {
304 param_count = node->object->method.param_count;
309 * Check the parameter count for non-predefined methods/objects.
311 * Warning if too few or too many arguments have been passed by the
312 * caller. An incorrect number of arguments may not cause the method
313 * to fail. However, the method will fail if there are too few
314 * arguments and the method attempts to use one of the missing ones.
316 if (user_param_count < param_count) {
317 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
319 "Insufficient arguments - needs %u, found %u",
320 param_count, user_param_count));
321 } else if (user_param_count > param_count) {
322 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
324 "Excess arguments - needs %u, found %u",
325 param_count, user_param_count));
331 * Validate the user-supplied parameter count.
332 * Allow two different legal argument counts (_SCP, etc.)
334 required_params_current = predefined->info.param_count & 0x0F;
335 required_params_old = predefined->info.param_count >> 4;
337 if (user_param_count != ACPI_UINT32_MAX) {
338 if ((user_param_count != required_params_current) &&
339 (user_param_count != required_params_old)) {
340 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
342 "Parameter count mismatch - "
343 "caller passed %u, ACPI requires %u",
345 required_params_current));
350 * Check that the ASL-defined parameter count is what is expected for
351 * this predefined name (parameter count as defined by the ACPI
354 if ((param_count != required_params_current) &&
355 (param_count != required_params_old)) {
356 ACPI_WARN_PREDEFINED((AE_INFO, pathname, node->flags,
357 "Parameter count mismatch - ASL declared %u, ACPI requires %u",
358 param_count, required_params_current));
362 /*******************************************************************************
364 * FUNCTION: acpi_ns_check_for_predefined_name
366 * PARAMETERS: node - Namespace node for the method/object
368 * RETURN: Pointer to entry in predefined table. NULL indicates not found.
370 * DESCRIPTION: Check an object name against the predefined object list.
372 ******************************************************************************/
374 const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct
378 const union acpi_predefined_info *this_name;
380 /* Quick check for a predefined name, first character must be underscore */
382 if (node->name.ascii[0] != '_') {
386 /* Search info table for a predefined method/object name */
388 this_name = predefined_names;
389 while (this_name->info.name[0]) {
390 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->info.name)) {
395 * Skip next entry in the table if this name returns a Package
396 * (next entry contains the package info)
398 if (this_name->info.expected_btypes & ACPI_RTYPE_PACKAGE) {
405 return (NULL); /* Not found */
408 /*******************************************************************************
410 * FUNCTION: acpi_ns_check_package
412 * PARAMETERS: data - Pointer to validation data structure
413 * return_object_ptr - Pointer to the object returned from the
414 * evaluation of a method or object
418 * DESCRIPTION: Check a returned package object for the correct count and
419 * correct type of all sub-objects.
421 ******************************************************************************/
424 acpi_ns_check_package(struct acpi_predefined_data *data,
425 union acpi_operand_object **return_object_ptr)
427 union acpi_operand_object *return_object = *return_object_ptr;
428 const union acpi_predefined_info *package;
429 union acpi_operand_object **elements;
430 acpi_status status = AE_OK;
435 ACPI_FUNCTION_NAME(ns_check_package);
437 /* The package info for this name is in the next table entry */
439 package = data->predefined + 1;
441 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
442 "%s Validating return Package of Type %X, Count %X\n",
443 data->pathname, package->ret_info.type,
444 return_object->package.count));
447 * For variable-length Packages, we can safely remove all embedded
448 * and trailing NULL package elements
450 acpi_ns_remove_null_elements(data, package->ret_info.type,
453 /* Extract package count and elements array */
455 elements = return_object->package.elements;
456 count = return_object->package.count;
458 /* The package must have at least one element, else invalid */
461 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
462 "Return Package has no elements (empty)"));
464 return (AE_AML_OPERAND_VALUE);
468 * Decode the type of the expected package contents
470 * PTYPE1 packages contain no subpackages
471 * PTYPE2 packages contain sub-packages
473 switch (package->ret_info.type) {
474 case ACPI_PTYPE1_FIXED:
477 * The package count is fixed and there are no sub-packages
479 * If package is too small, exit.
480 * If package is larger than expected, issue warning but continue
483 package->ret_info.count1 + package->ret_info.count2;
484 if (count < expected_count) {
485 goto package_too_small;
486 } else if (count > expected_count) {
487 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
488 "%s: Return Package is larger than needed - "
489 "found %u, expected %u\n",
490 data->pathname, count,
494 /* Validate all elements of the returned package */
496 status = acpi_ns_check_package_elements(data, elements,
507 case ACPI_PTYPE1_VAR:
510 * The package count is variable, there are no sub-packages, and all
511 * elements must be of the same type
513 for (i = 0; i < count; i++) {
514 status = acpi_ns_check_object_type(data, elements,
517 if (ACPI_FAILURE(status)) {
524 case ACPI_PTYPE1_OPTION:
527 * The package count is variable, there are no sub-packages. There are
528 * a fixed number of required elements, and a variable number of
531 * Check if package is at least as large as the minimum required
533 expected_count = package->ret_info3.count;
534 if (count < expected_count) {
535 goto package_too_small;
538 /* Variable number of sub-objects */
540 for (i = 0; i < count; i++) {
541 if (i < package->ret_info3.count) {
543 /* These are the required package elements (0, 1, or 2) */
546 acpi_ns_check_object_type(data, elements,
551 if (ACPI_FAILURE(status)) {
555 /* These are the optional package elements */
558 acpi_ns_check_object_type(data, elements,
563 if (ACPI_FAILURE(status)) {
571 case ACPI_PTYPE2_REV_FIXED:
573 /* First element is the (Integer) revision */
575 status = acpi_ns_check_object_type(data, elements,
576 ACPI_RTYPE_INTEGER, 0);
577 if (ACPI_FAILURE(status)) {
584 /* Examine the sub-packages */
587 acpi_ns_check_package_list(data, package, elements, count);
590 case ACPI_PTYPE2_PKG_COUNT:
592 /* First element is the (Integer) count of sub-packages to follow */
594 status = acpi_ns_check_object_type(data, elements,
595 ACPI_RTYPE_INTEGER, 0);
596 if (ACPI_FAILURE(status)) {
601 * Count cannot be larger than the parent package length, but allow it
602 * to be smaller. The >= accounts for the Integer above.
604 expected_count = (u32) (*elements)->integer.value;
605 if (expected_count >= count) {
606 goto package_too_small;
609 count = expected_count;
612 /* Examine the sub-packages */
615 acpi_ns_check_package_list(data, package, elements, count);
619 case ACPI_PTYPE2_FIXED:
620 case ACPI_PTYPE2_MIN:
621 case ACPI_PTYPE2_COUNT:
622 case ACPI_PTYPE2_FIX_VAR:
625 * These types all return a single Package that consists of a
626 * variable number of sub-Packages.
628 * First, ensure that the first element is a sub-Package. If not,
629 * the BIOS may have incorrectly returned the object as a single
630 * package instead of a Package of Packages (a common error if
631 * there is only one entry). We may be able to repair this by
632 * wrapping the returned Package with a new outer Package.
635 && ((*elements)->common.type != ACPI_TYPE_PACKAGE)) {
637 /* Create the new outer package and populate it */
640 acpi_ns_wrap_with_package(data, return_object,
642 if (ACPI_FAILURE(status)) {
646 /* Update locals to point to the new package (of 1 element) */
648 return_object = *return_object_ptr;
649 elements = return_object->package.elements;
653 /* Examine the sub-packages */
656 acpi_ns_check_package_list(data, package, elements, count);
661 /* Should not get here if predefined info table is correct */
663 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
664 "Invalid internal return type in table entry: %X",
665 package->ret_info.type));
667 return (AE_AML_INTERNAL);
674 /* Error exit for the case with an incorrect package count */
676 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
677 "Return Package is too small - found %u elements, expected %u",
678 count, expected_count));
680 return (AE_AML_OPERAND_VALUE);
683 /*******************************************************************************
685 * FUNCTION: acpi_ns_check_package_list
687 * PARAMETERS: data - Pointer to validation data structure
688 * package - Pointer to package-specific info for method
689 * elements - Element list of parent package. All elements
690 * of this list should be of type Package.
691 * count - Count of subpackages
695 * DESCRIPTION: Examine a list of subpackages
697 ******************************************************************************/
700 acpi_ns_check_package_list(struct acpi_predefined_data *data,
701 const union acpi_predefined_info *package,
702 union acpi_operand_object **elements, u32 count)
704 union acpi_operand_object *sub_package;
705 union acpi_operand_object **sub_elements;
712 * Validate each sub-Package in the parent Package
714 * NOTE: assumes list of sub-packages contains no NULL elements.
715 * Any NULL elements should have been removed by earlier call
716 * to acpi_ns_remove_null_elements.
718 for (i = 0; i < count; i++) {
719 sub_package = *elements;
720 sub_elements = sub_package->package.elements;
721 data->parent_package = sub_package;
723 /* Each sub-object must be of type Package */
725 status = acpi_ns_check_object_type(data, &sub_package,
726 ACPI_RTYPE_PACKAGE, i);
727 if (ACPI_FAILURE(status)) {
731 /* Examine the different types of expected sub-packages */
733 data->parent_package = sub_package;
734 switch (package->ret_info.type) {
736 case ACPI_PTYPE2_PKG_COUNT:
737 case ACPI_PTYPE2_REV_FIXED:
739 /* Each subpackage has a fixed number of elements */
742 package->ret_info.count1 + package->ret_info.count2;
743 if (sub_package->package.count < expected_count) {
744 goto package_too_small;
748 acpi_ns_check_package_elements(data, sub_elements,
757 if (ACPI_FAILURE(status)) {
762 case ACPI_PTYPE2_FIX_VAR:
764 * Each subpackage has a fixed number of elements and an
768 package->ret_info.count1 + package->ret_info.count2;
769 if (sub_package->package.count < expected_count) {
770 goto package_too_small;
774 acpi_ns_check_package_elements(data, sub_elements,
781 sub_package->package.
785 if (ACPI_FAILURE(status)) {
790 case ACPI_PTYPE2_FIXED:
792 /* Each sub-package has a fixed length */
794 expected_count = package->ret_info2.count;
795 if (sub_package->package.count < expected_count) {
796 goto package_too_small;
799 /* Check the type of each sub-package element */
801 for (j = 0; j < expected_count; j++) {
803 acpi_ns_check_object_type(data,
809 if (ACPI_FAILURE(status)) {
815 case ACPI_PTYPE2_MIN:
817 /* Each sub-package has a variable but minimum length */
819 expected_count = package->ret_info.count1;
820 if (sub_package->package.count < expected_count) {
821 goto package_too_small;
824 /* Check the type of each sub-package element */
827 acpi_ns_check_package_elements(data, sub_elements,
830 sub_package->package.
832 if (ACPI_FAILURE(status)) {
837 case ACPI_PTYPE2_COUNT:
840 * First element is the (Integer) count of elements, including
841 * the count field (the ACPI name is num_elements)
843 status = acpi_ns_check_object_type(data, sub_elements,
846 if (ACPI_FAILURE(status)) {
851 * Make sure package is large enough for the Count and is
852 * is as large as the minimum size
854 expected_count = (u32)(*sub_elements)->integer.value;
855 if (sub_package->package.count < expected_count) {
856 goto package_too_small;
858 if (sub_package->package.count <
859 package->ret_info.count1) {
860 expected_count = package->ret_info.count1;
861 goto package_too_small;
863 if (expected_count == 0) {
865 * Either the num_entries element was originally zero or it was
866 * a NULL element and repaired to an Integer of value zero.
867 * In either case, repair it by setting num_entries to be the
868 * actual size of the subpackage.
870 expected_count = sub_package->package.count;
871 (*sub_elements)->integer.value = expected_count;
874 /* Check the type of each sub-package element */
877 acpi_ns_check_package_elements(data,
881 (expected_count - 1),
883 if (ACPI_FAILURE(status)) {
888 default: /* Should not get here, type was validated by caller */
890 return (AE_AML_INTERNAL);
900 /* The sub-package count was smaller than required */
902 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
903 "Return Sub-Package[%u] is too small - found %u elements, expected %u",
904 i, sub_package->package.count, expected_count));
906 return (AE_AML_OPERAND_VALUE);
909 /*******************************************************************************
911 * FUNCTION: acpi_ns_check_package_elements
913 * PARAMETERS: data - Pointer to validation data structure
914 * elements - Pointer to the package elements array
915 * type1 - Object type for first group
916 * count1 - Count for first group
917 * type2 - Object type for second group
918 * count2 - Count for second group
919 * start_index - Start of the first group of elements
923 * DESCRIPTION: Check that all elements of a package are of the correct object
924 * type. Supports up to two groups of different object types.
926 ******************************************************************************/
929 acpi_ns_check_package_elements(struct acpi_predefined_data *data,
930 union acpi_operand_object **elements,
933 u8 type2, u32 count2, u32 start_index)
935 union acpi_operand_object **this_element = elements;
940 * Up to two groups of package elements are supported by the data
941 * structure. All elements in each group must be of the same type.
942 * The second group can have a count of zero.
944 for (i = 0; i < count1; i++) {
945 status = acpi_ns_check_object_type(data, this_element,
946 type1, i + start_index);
947 if (ACPI_FAILURE(status)) {
953 for (i = 0; i < count2; i++) {
954 status = acpi_ns_check_object_type(data, this_element,
956 (i + count1 + start_index));
957 if (ACPI_FAILURE(status)) {
966 /*******************************************************************************
968 * FUNCTION: acpi_ns_check_object_type
970 * PARAMETERS: data - Pointer to validation data structure
971 * return_object_ptr - Pointer to the object returned from the
972 * evaluation of a method or object
973 * expected_btypes - Bitmap of expected return type(s)
974 * package_index - Index of object within parent package (if
975 * applicable - ACPI_NOT_PACKAGE_ELEMENT
980 * DESCRIPTION: Check the type of the return object against the expected object
981 * type(s). Use of Btype allows multiple expected object types.
983 ******************************************************************************/
986 acpi_ns_check_object_type(struct acpi_predefined_data *data,
987 union acpi_operand_object **return_object_ptr,
988 u32 expected_btypes, u32 package_index)
990 union acpi_operand_object *return_object = *return_object_ptr;
991 acpi_status status = AE_OK;
993 char type_buffer[48]; /* Room for 5 types */
996 * If we get a NULL return_object here, it is a NULL package element.
997 * Since all extraneous NULL package elements were removed earlier by a
998 * call to acpi_ns_remove_null_elements, this is an unexpected NULL element.
999 * We will attempt to repair it.
1001 if (!return_object) {
1002 status = acpi_ns_repair_null_element(data, expected_btypes,
1005 if (ACPI_SUCCESS(status)) {
1006 return (AE_OK); /* Repair was successful */
1008 goto type_error_exit;
1011 /* A Namespace node should not get here, but make sure */
1013 if (ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) {
1014 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1015 "Invalid return type - Found a Namespace node [%4.4s] type %s",
1016 return_object->node.name.ascii,
1017 acpi_ut_get_type_name(return_object->node.
1019 return (AE_AML_OPERAND_TYPE);
1023 * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
1024 * The bitmapped type allows multiple possible return types.
1026 * Note, the cases below must handle all of the possible types returned
1027 * from all of the predefined names (including elements of returned
1030 switch (return_object->common.type) {
1031 case ACPI_TYPE_INTEGER:
1032 return_btype = ACPI_RTYPE_INTEGER;
1035 case ACPI_TYPE_BUFFER:
1036 return_btype = ACPI_RTYPE_BUFFER;
1039 case ACPI_TYPE_STRING:
1040 return_btype = ACPI_RTYPE_STRING;
1043 case ACPI_TYPE_PACKAGE:
1044 return_btype = ACPI_RTYPE_PACKAGE;
1047 case ACPI_TYPE_LOCAL_REFERENCE:
1048 return_btype = ACPI_RTYPE_REFERENCE;
1052 /* Not one of the supported objects, must be incorrect */
1054 goto type_error_exit;
1057 /* Is the object one of the expected types? */
1059 if (return_btype & expected_btypes) {
1061 /* For reference objects, check that the reference type is correct */
1063 if (return_object->common.type == ACPI_TYPE_LOCAL_REFERENCE) {
1064 status = acpi_ns_check_reference(data, return_object);
1070 /* Type mismatch -- attempt repair of the returned object */
1072 status = acpi_ns_repair_object(data, expected_btypes,
1073 package_index, return_object_ptr);
1074 if (ACPI_SUCCESS(status)) {
1075 return (AE_OK); /* Repair was successful */
1080 /* Create a string with all expected types for this predefined object */
1082 acpi_ns_get_expected_types(type_buffer, expected_btypes);
1084 if (package_index == ACPI_NOT_PACKAGE_ELEMENT) {
1085 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1086 "Return type mismatch - found %s, expected %s",
1087 acpi_ut_get_object_type_name
1088 (return_object), type_buffer));
1090 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1091 "Return Package type mismatch at index %u - "
1092 "found %s, expected %s", package_index,
1093 acpi_ut_get_object_type_name
1094 (return_object), type_buffer));
1097 return (AE_AML_OPERAND_TYPE);
1100 /*******************************************************************************
1102 * FUNCTION: acpi_ns_check_reference
1104 * PARAMETERS: data - Pointer to validation data structure
1105 * return_object - Object returned from the evaluation of a
1110 * DESCRIPTION: Check a returned reference object for the correct reference
1111 * type. The only reference type that can be returned from a
1112 * predefined method is a named reference. All others are invalid.
1114 ******************************************************************************/
1117 acpi_ns_check_reference(struct acpi_predefined_data *data,
1118 union acpi_operand_object *return_object)
1122 * Check the reference object for the correct reference type (opcode).
1123 * The only type of reference that can be converted to an union acpi_object is
1124 * a reference to a named object (reference class: NAME)
1126 if (return_object->reference.class == ACPI_REFCLASS_NAME) {
1130 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
1131 "Return type mismatch - unexpected reference object type [%s] %2.2X",
1132 acpi_ut_get_reference_name(return_object),
1133 return_object->reference.class));
1135 return (AE_AML_OPERAND_TYPE);
1138 /*******************************************************************************
1140 * FUNCTION: acpi_ns_get_expected_types
1142 * PARAMETERS: buffer - Pointer to where the string is returned
1143 * expected_btypes - Bitmap of expected return type(s)
1145 * RETURN: Buffer is populated with type names.
1147 * DESCRIPTION: Translate the expected types bitmap into a string of ascii
1148 * names of expected types, for use in warning messages.
1150 ******************************************************************************/
1152 static void acpi_ns_get_expected_types(char *buffer, u32 expected_btypes)
1160 this_rtype = ACPI_RTYPE_INTEGER;
1162 for (i = 0; i < ACPI_NUM_RTYPES; i++) {
1164 /* If one of the expected types, concatenate the name of this type */
1166 if (expected_btypes & this_rtype) {
1167 ACPI_STRCAT(buffer, &acpi_rtype_names[i][j]);
1168 j = 0; /* Use name separator from now on */
1170 this_rtype <<= 1; /* Next Rtype */