aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/acpi/acpica/nspredef.c
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/acpi/acpica/nspredef.c')
-rw-r--r--drivers/acpi/acpica/nspredef.c1065
1 files changed, 1065 insertions, 0 deletions
diff --git a/drivers/acpi/acpica/nspredef.c b/drivers/acpi/acpica/nspredef.c
new file mode 100644
index 000000000000..1e682d03f620
--- /dev/null
+++ b/drivers/acpi/acpica/nspredef.c
@@ -0,0 +1,1065 @@
1/******************************************************************************
2 *
3 * Module Name: nspredef - Validation of ACPI predefined methods and objects
4 * $Revision: 1.1 $
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
30 *
31 * NO WARRANTY
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
43 */
44
45#include <acpi/acpi.h>
46#include <acpi/accommon.h>
47#include <acpi/acnamesp.h>
48#include <acpi/acpredef.h>
49
50#define _COMPONENT ACPI_NAMESPACE
51ACPI_MODULE_NAME("nspredef")
52
53/*******************************************************************************
54 *
55 * This module validates predefined ACPI objects that appear in the namespace,
56 * at the time they are evaluated (via acpi_evaluate_object). The purpose of this
57 * validation is to detect problems with BIOS-exposed predefined ACPI objects
58 * before the results are returned to the ACPI-related drivers.
59 *
60 * There are several areas that are validated:
61 *
62 * 1) The number of input arguments as defined by the method/object in the
63 * ASL is validated against the ACPI specification.
64 * 2) The type of the return object (if any) is validated against the ACPI
65 * specification.
66 * 3) For returned package objects, the count of package elements is
67 * validated, as well as the type of each package element. Nested
68 * packages are supported.
69 *
70 * For any problems found, a warning message is issued.
71 *
72 ******************************************************************************/
73/* Local prototypes */
74static acpi_status
75acpi_ns_check_package(char *pathname,
76 union acpi_operand_object **return_object_ptr,
77 const union acpi_predefined_info *predefined);
78
79static acpi_status
80acpi_ns_check_package_elements(char *pathname,
81 union acpi_operand_object **elements,
82 u8 type1, u32 count1, u8 type2, u32 count2);
83
84static acpi_status
85acpi_ns_check_object_type(char *pathname,
86 union acpi_operand_object **return_object_ptr,
87 u32 expected_btypes, u32 package_index);
88
89static acpi_status
90acpi_ns_check_reference(char *pathname,
91 union acpi_operand_object *return_object);
92
93static acpi_status
94acpi_ns_repair_object(u32 expected_btypes,
95 u32 package_index,
96 union acpi_operand_object **return_object_ptr);
97
98/*
99 * Names for the types that can be returned by the predefined objects.
100 * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
101 */
102static const char *acpi_rtype_names[] = {
103 "/Integer",
104 "/String",
105 "/Buffer",
106 "/Package",
107 "/Reference",
108};
109
110#define ACPI_NOT_PACKAGE ACPI_UINT32_MAX
111
112/*******************************************************************************
113 *
114 * FUNCTION: acpi_ns_check_predefined_names
115 *
116 * PARAMETERS: Node - Namespace node for the method/object
117 * return_object_ptr - Pointer to the object returned from the
118 * evaluation of a method or object
119 *
120 * RETURN: Status
121 *
122 * DESCRIPTION: Check an ACPI name for a match in the predefined name list.
123 *
124 ******************************************************************************/
125
126acpi_status
127acpi_ns_check_predefined_names(struct acpi_namespace_node *node,
128 u32 user_param_count,
129 acpi_status return_status,
130 union acpi_operand_object **return_object_ptr)
131{
132 union acpi_operand_object *return_object = *return_object_ptr;
133 acpi_status status = AE_OK;
134 const union acpi_predefined_info *predefined;
135 char *pathname;
136
137 /* Match the name for this method/object against the predefined list */
138
139 predefined = acpi_ns_check_for_predefined_name(node);
140
141 /* Get the full pathname to the object, for use in error messages */
142
143 pathname = acpi_ns_get_external_pathname(node);
144 if (!pathname) {
145 pathname = ACPI_CAST_PTR(char, predefined->info.name);
146 }
147
148 /*
149 * Check that the parameter count for this method matches the ASL
150 * definition. For predefined names, ensure that both the caller and
151 * the method itself are in accordance with the ACPI specification.
152 */
153 acpi_ns_check_parameter_count(pathname, node, user_param_count,
154 predefined);
155
156 /* If not a predefined name, we cannot validate the return object */
157
158 if (!predefined) {
159 goto exit;
160 }
161
162 /* If the method failed, we cannot validate the return object */
163
164 if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) {
165 goto exit;
166 }
167
168 /*
169 * Only validate the return value on the first successful evaluation of
170 * the method. This ensures that any warnings will only be emitted during
171 * the very first evaluation of the method/object.
172 */
173 if (node->flags & ANOBJ_EVALUATED) {
174 goto exit;
175 }
176
177 /* Mark the node as having been successfully evaluated */
178
179 node->flags |= ANOBJ_EVALUATED;
180
181 /*
182 * If there is no return value, check if we require a return value for
183 * this predefined name. Either one return value is expected, or none,
184 * for both methods and other objects.
185 *
186 * Exit now if there is no return object. Warning if one was expected.
187 */
188 if (!return_object) {
189 if ((predefined->info.expected_btypes) &&
190 (!(predefined->info.expected_btypes & ACPI_RTYPE_NONE))) {
191 ACPI_ERROR((AE_INFO,
192 "%s: Missing expected return value",
193 pathname));
194
195 status = AE_AML_NO_RETURN_VALUE;
196 }
197 goto exit;
198 }
199
200 /*
201 * We have a return value, but if one wasn't expected, just exit, this is
202 * not a problem
203 *
204 * For example, if the "Implicit Return" feature is enabled, methods will
205 * always return a value
206 */
207 if (!predefined->info.expected_btypes) {
208 goto exit;
209 }
210
211 /*
212 * Check that the type of the return object is what is expected for
213 * this predefined name
214 */
215 status = acpi_ns_check_object_type(pathname, return_object_ptr,
216 predefined->info.expected_btypes,
217 ACPI_NOT_PACKAGE);
218 if (ACPI_FAILURE(status)) {
219 goto exit;
220 }
221
222 /* For returned Package objects, check the type of all sub-objects */
223
224 if (ACPI_GET_OBJECT_TYPE(return_object) == ACPI_TYPE_PACKAGE) {
225 status =
226 acpi_ns_check_package(pathname, return_object_ptr,
227 predefined);
228 }
229
230 exit:
231 if (pathname != predefined->info.name) {
232 ACPI_FREE(pathname);
233 }
234
235 return (status);
236}
237
238/*******************************************************************************
239 *
240 * FUNCTION: acpi_ns_check_parameter_count
241 *
242 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
243 * Node - Namespace node for the method/object
244 * user_param_count - Number of args passed in by the caller
245 * Predefined - Pointer to entry in predefined name table
246 *
247 * RETURN: None
248 *
249 * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
250 * predefined name is what is expected (i.e., what is defined in
251 * the ACPI specification for this predefined name.)
252 *
253 ******************************************************************************/
254
255void
256acpi_ns_check_parameter_count(char *pathname,
257 struct acpi_namespace_node *node,
258 u32 user_param_count,
259 const union acpi_predefined_info *predefined)
260{
261 u32 param_count;
262 u32 required_params_current;
263 u32 required_params_old;
264
265 /* Methods have 0-7 parameters. All other types have zero. */
266
267 param_count = 0;
268 if (node->type == ACPI_TYPE_METHOD) {
269 param_count = node->object->method.param_count;
270 }
271
272 /* Argument count check for non-predefined methods/objects */
273
274 if (!predefined) {
275 /*
276 * Warning if too few or too many arguments have been passed by the
277 * caller. An incorrect number of arguments may not cause the method
278 * to fail. However, the method will fail if there are too few
279 * arguments and the method attempts to use one of the missing ones.
280 */
281 if (user_param_count < param_count) {
282 ACPI_WARNING((AE_INFO,
283 "%s: Insufficient arguments - needs %d, found %d",
284 pathname, param_count, user_param_count));
285 } else if (user_param_count > param_count) {
286 ACPI_WARNING((AE_INFO,
287 "%s: Excess arguments - needs %d, found %d",
288 pathname, param_count, user_param_count));
289 }
290 return;
291 }
292
293 /* Allow two different legal argument counts (_SCP, etc.) */
294
295 required_params_current = predefined->info.param_count & 0x0F;
296 required_params_old = predefined->info.param_count >> 4;
297
298 if (user_param_count != ACPI_UINT32_MAX) {
299
300 /* Validate the user-supplied parameter count */
301
302 if ((user_param_count != required_params_current) &&
303 (user_param_count != required_params_old)) {
304 ACPI_WARNING((AE_INFO,
305 "%s: Parameter count mismatch - caller passed %d, ACPI requires %d",
306 pathname, user_param_count,
307 required_params_current));
308 }
309 }
310
311 /*
312 * Only validate the argument count on the first successful evaluation of
313 * the method. This ensures that any warnings will only be emitted during
314 * the very first evaluation of the method/object.
315 */
316 if (node->flags & ANOBJ_EVALUATED) {
317 return;
318 }
319
320 /*
321 * Check that the ASL-defined parameter count is what is expected for
322 * this predefined name.
323 */
324 if ((param_count != required_params_current) &&
325 (param_count != required_params_old)) {
326 ACPI_WARNING((AE_INFO,
327 "%s: Parameter count mismatch - ASL declared %d, ACPI requires %d",
328 pathname, param_count, required_params_current));
329 }
330}
331
332/*******************************************************************************
333 *
334 * FUNCTION: acpi_ns_check_for_predefined_name
335 *
336 * PARAMETERS: Node - Namespace node for the method/object
337 *
338 * RETURN: Pointer to entry in predefined table. NULL indicates not found.
339 *
340 * DESCRIPTION: Check an object name against the predefined object list.
341 *
342 ******************************************************************************/
343
344const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct
345 acpi_namespace_node
346 *node)
347{
348 const union acpi_predefined_info *this_name;
349
350 /* Quick check for a predefined name, first character must be underscore */
351
352 if (node->name.ascii[0] != '_') {
353 return (NULL);
354 }
355
356 /* Search info table for a predefined method/object name */
357
358 this_name = predefined_names;
359 while (this_name->info.name[0]) {
360 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->info.name)) {
361
362 /* Return pointer to this table entry */
363
364 return (this_name);
365 }
366
367 /*
368 * Skip next entry in the table if this name returns a Package
369 * (next entry contains the package info)
370 */
371 if (this_name->info.expected_btypes & ACPI_RTYPE_PACKAGE) {
372 this_name++;
373 }
374
375 this_name++;
376 }
377
378 return (NULL);
379}
380
381/*******************************************************************************
382 *
383 * FUNCTION: acpi_ns_check_package
384 *
385 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
386 * return_object_ptr - Pointer to the object returned from the
387 * evaluation of a method or object
388 * Predefined - Pointer to entry in predefined name table
389 *
390 * RETURN: Status
391 *
392 * DESCRIPTION: Check a returned package object for the correct count and
393 * correct type of all sub-objects.
394 *
395 ******************************************************************************/
396
397static acpi_status
398acpi_ns_check_package(char *pathname,
399 union acpi_operand_object **return_object_ptr,
400 const union acpi_predefined_info *predefined)
401{
402 union acpi_operand_object *return_object = *return_object_ptr;
403 const union acpi_predefined_info *package;
404 union acpi_operand_object *sub_package;
405 union acpi_operand_object **elements;
406 union acpi_operand_object **sub_elements;
407 acpi_status status;
408 u32 expected_count;
409 u32 count;
410 u32 i;
411 u32 j;
412
413 ACPI_FUNCTION_NAME(ns_check_package);
414
415 /* The package info for this name is in the next table entry */
416
417 package = predefined + 1;
418
419 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
420 "%s Validating return Package of Type %X, Count %X\n",
421 pathname, package->ret_info.type,
422 return_object->package.count));
423
424 /* Extract package count and elements array */
425
426 elements = return_object->package.elements;
427 count = return_object->package.count;
428
429 /* The package must have at least one element, else invalid */
430
431 if (!count) {
432 ACPI_WARNING((AE_INFO,
433 "%s: Return Package has no elements (empty)",
434 pathname));
435
436 return (AE_AML_OPERAND_VALUE);
437 }
438
439 /*
440 * Decode the type of the expected package contents
441 *
442 * PTYPE1 packages contain no subpackages
443 * PTYPE2 packages contain sub-packages
444 */
445 switch (package->ret_info.type) {
446 case ACPI_PTYPE1_FIXED:
447
448 /*
449 * The package count is fixed and there are no sub-packages
450 *
451 * If package is too small, exit.
452 * If package is larger than expected, issue warning but continue
453 */
454 expected_count =
455 package->ret_info.count1 + package->ret_info.count2;
456 if (count < expected_count) {
457 goto package_too_small;
458 } else if (count > expected_count) {
459 ACPI_WARNING((AE_INFO,
460 "%s: Return Package is larger than needed - "
461 "found %u, expected %u", pathname, count,
462 expected_count));
463 }
464
465 /* Validate all elements of the returned package */
466
467 status = acpi_ns_check_package_elements(pathname, elements,
468 package->ret_info.
469 object_type1,
470 package->ret_info.
471 count1,
472 package->ret_info.
473 object_type2,
474 package->ret_info.
475 count2);
476 if (ACPI_FAILURE(status)) {
477 return (status);
478 }
479 break;
480
481 case ACPI_PTYPE1_VAR:
482
483 /*
484 * The package count is variable, there are no sub-packages, and all
485 * elements must be of the same type
486 */
487 for (i = 0; i < count; i++) {
488 status = acpi_ns_check_object_type(pathname, elements,
489 package->ret_info.
490 object_type1, i);
491 if (ACPI_FAILURE(status)) {
492 return (status);
493 }
494 elements++;
495 }
496 break;
497
498 case ACPI_PTYPE1_OPTION:
499
500 /*
501 * The package count is variable, there are no sub-packages. There are
502 * a fixed number of required elements, and a variable number of
503 * optional elements.
504 *
505 * Check if package is at least as large as the minimum required
506 */
507 expected_count = package->ret_info3.count;
508 if (count < expected_count) {
509 goto package_too_small;
510 }
511
512 /* Variable number of sub-objects */
513
514 for (i = 0; i < count; i++) {
515 if (i < package->ret_info3.count) {
516
517 /* These are the required package elements (0, 1, or 2) */
518
519 status =
520 acpi_ns_check_object_type(pathname,
521 elements,
522 package->
523 ret_info3.
524 object_type[i],
525 i);
526 if (ACPI_FAILURE(status)) {
527 return (status);
528 }
529 } else {
530 /* These are the optional package elements */
531
532 status =
533 acpi_ns_check_object_type(pathname,
534 elements,
535 package->
536 ret_info3.
537 tail_object_type,
538 i);
539 if (ACPI_FAILURE(status)) {
540 return (status);
541 }
542 }
543 elements++;
544 }
545 break;
546
547 case ACPI_PTYPE2_PKG_COUNT:
548
549 /* First element is the (Integer) count of sub-packages to follow */
550
551 status = acpi_ns_check_object_type(pathname, elements,
552 ACPI_RTYPE_INTEGER, 0);
553 if (ACPI_FAILURE(status)) {
554 return (status);
555 }
556
557 /*
558 * Count cannot be larger than the parent package length, but allow it
559 * to be smaller. The >= accounts for the Integer above.
560 */
561 expected_count = (u32) (*elements)->integer.value;
562 if (expected_count >= count) {
563 goto package_too_small;
564 }
565
566 count = expected_count;
567 elements++;
568
569 /* Now we can walk the sub-packages */
570
571 /*lint -fallthrough */
572
573 case ACPI_PTYPE2:
574 case ACPI_PTYPE2_FIXED:
575 case ACPI_PTYPE2_MIN:
576 case ACPI_PTYPE2_COUNT:
577
578 /*
579 * These types all return a single package that consists of a variable
580 * number of sub-packages
581 */
582 for (i = 0; i < count; i++) {
583 sub_package = *elements;
584 sub_elements = sub_package->package.elements;
585
586 /* Each sub-object must be of type Package */
587
588 status =
589 acpi_ns_check_object_type(pathname, &sub_package,
590 ACPI_RTYPE_PACKAGE, i);
591 if (ACPI_FAILURE(status)) {
592 return (status);
593 }
594
595 /* Examine the different types of sub-packages */
596
597 switch (package->ret_info.type) {
598 case ACPI_PTYPE2:
599 case ACPI_PTYPE2_PKG_COUNT:
600
601 /* Each subpackage has a fixed number of elements */
602
603 expected_count =
604 package->ret_info.count1 +
605 package->ret_info.count2;
606 if (sub_package->package.count !=
607 expected_count) {
608 count = sub_package->package.count;
609 goto package_too_small;
610 }
611
612 status =
613 acpi_ns_check_package_elements(pathname,
614 sub_elements,
615 package->
616 ret_info.
617 object_type1,
618 package->
619 ret_info.
620 count1,
621 package->
622 ret_info.
623 object_type2,
624 package->
625 ret_info.
626 count2);
627 if (ACPI_FAILURE(status)) {
628 return (status);
629 }
630 break;
631
632 case ACPI_PTYPE2_FIXED:
633
634 /* Each sub-package has a fixed length */
635
636 expected_count = package->ret_info2.count;
637 if (sub_package->package.count < expected_count) {
638 count = sub_package->package.count;
639 goto package_too_small;
640 }
641
642 /* Check the type of each sub-package element */
643
644 for (j = 0; j < expected_count; j++) {
645 status =
646 acpi_ns_check_object_type(pathname,
647 &sub_elements[j],
648 package->ret_info2.object_type[j], j);
649 if (ACPI_FAILURE(status)) {
650 return (status);
651 }
652 }
653 break;
654
655 case ACPI_PTYPE2_MIN:
656
657 /* Each sub-package has a variable but minimum length */
658
659 expected_count = package->ret_info.count1;
660 if (sub_package->package.count < expected_count) {
661 count = sub_package->package.count;
662 goto package_too_small;
663 }
664
665 /* Check the type of each sub-package element */
666
667 status =
668 acpi_ns_check_package_elements(pathname,
669 sub_elements,
670 package->
671 ret_info.
672 object_type1,
673 sub_package->
674 package.
675 count, 0, 0);
676 if (ACPI_FAILURE(status)) {
677 return (status);
678 }
679 break;
680
681 case ACPI_PTYPE2_COUNT:
682
683 /* First element is the (Integer) count of elements to follow */
684
685 status =
686 acpi_ns_check_object_type(pathname,
687 sub_elements,
688 ACPI_RTYPE_INTEGER,
689 0);
690 if (ACPI_FAILURE(status)) {
691 return (status);
692 }
693
694 /* Make sure package is large enough for the Count */
695
696 expected_count =
697 (u32) (*sub_elements)->integer.value;
698 if (sub_package->package.count < expected_count) {
699 count = sub_package->package.count;
700 goto package_too_small;
701 }
702
703 /* Check the type of each sub-package element */
704
705 status =
706 acpi_ns_check_package_elements(pathname,
707 (sub_elements
708 + 1),
709 package->
710 ret_info.
711 object_type1,
712 (expected_count
713 - 1), 0, 0);
714 if (ACPI_FAILURE(status)) {
715 return (status);
716 }
717 break;
718
719 default:
720 break;
721 }
722
723 elements++;
724 }
725 break;
726
727 default:
728
729 /* Should not get here if predefined info table is correct */
730
731 ACPI_WARNING((AE_INFO,
732 "%s: Invalid internal return type in table entry: %X",
733 pathname, package->ret_info.type));
734
735 return (AE_AML_INTERNAL);
736 }
737
738 return (AE_OK);
739
740 package_too_small:
741
742 /* Error exit for the case with an incorrect package count */
743
744 ACPI_WARNING((AE_INFO, "%s: Return Package is too small - "
745 "found %u, expected %u", pathname, count,
746 expected_count));
747
748 return (AE_AML_OPERAND_VALUE);
749}
750
751/*******************************************************************************
752 *
753 * FUNCTION: acpi_ns_check_package_elements
754 *
755 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
756 * Elements - Pointer to the package elements array
757 * Type1 - Object type for first group
758 * Count1 - Count for first group
759 * Type2 - Object type for second group
760 * Count2 - Count for second group
761 *
762 * RETURN: Status
763 *
764 * DESCRIPTION: Check that all elements of a package are of the correct object
765 * type. Supports up to two groups of different object types.
766 *
767 ******************************************************************************/
768
769static acpi_status
770acpi_ns_check_package_elements(char *pathname,
771 union acpi_operand_object **elements,
772 u8 type1, u32 count1, u8 type2, u32 count2)
773{
774 union acpi_operand_object **this_element = elements;
775 acpi_status status;
776 u32 i;
777
778 /*
779 * Up to two groups of package elements are supported by the data
780 * structure. All elements in each group must be of the same type.
781 * The second group can have a count of zero.
782 */
783 for (i = 0; i < count1; i++) {
784 status = acpi_ns_check_object_type(pathname, this_element,
785 type1, i);
786 if (ACPI_FAILURE(status)) {
787 return (status);
788 }
789 this_element++;
790 }
791
792 for (i = 0; i < count2; i++) {
793 status = acpi_ns_check_object_type(pathname, this_element,
794 type2, (i + count1));
795 if (ACPI_FAILURE(status)) {
796 return (status);
797 }
798 this_element++;
799 }
800
801 return (AE_OK);
802}
803
804/*******************************************************************************
805 *
806 * FUNCTION: acpi_ns_check_object_type
807 *
808 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
809 * return_object_ptr - Pointer to the object returned from the
810 * evaluation of a method or object
811 * expected_btypes - Bitmap of expected return type(s)
812 * package_index - Index of object within parent package (if
813 * applicable - ACPI_NOT_PACKAGE otherwise)
814 *
815 * RETURN: Status
816 *
817 * DESCRIPTION: Check the type of the return object against the expected object
818 * type(s). Use of Btype allows multiple expected object types.
819 *
820 ******************************************************************************/
821
822static acpi_status
823acpi_ns_check_object_type(char *pathname,
824 union acpi_operand_object **return_object_ptr,
825 u32 expected_btypes, u32 package_index)
826{
827 union acpi_operand_object *return_object = *return_object_ptr;
828 acpi_status status = AE_OK;
829 u32 return_btype;
830 char type_buffer[48]; /* Room for 5 types */
831 u32 this_rtype;
832 u32 i;
833 u32 j;
834
835 /*
836 * If we get a NULL return_object here, it is a NULL package element,
837 * and this is always an error.
838 */
839 if (!return_object) {
840 goto type_error_exit;
841 }
842
843 /* A Namespace node should not get here, but make sure */
844
845 if (ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) {
846 ACPI_WARNING((AE_INFO,
847 "%s: Invalid return type - Found a Namespace node [%4.4s] type %s",
848 pathname, return_object->node.name.ascii,
849 acpi_ut_get_type_name(return_object->node.type)));
850 return (AE_AML_OPERAND_TYPE);
851 }
852
853 /*
854 * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
855 * The bitmapped type allows multiple possible return types.
856 *
857 * Note, the cases below must handle all of the possible types returned
858 * from all of the predefined names (including elements of returned
859 * packages)
860 */
861 switch (ACPI_GET_OBJECT_TYPE(return_object)) {
862 case ACPI_TYPE_INTEGER:
863 return_btype = ACPI_RTYPE_INTEGER;
864 break;
865
866 case ACPI_TYPE_BUFFER:
867 return_btype = ACPI_RTYPE_BUFFER;
868 break;
869
870 case ACPI_TYPE_STRING:
871 return_btype = ACPI_RTYPE_STRING;
872 break;
873
874 case ACPI_TYPE_PACKAGE:
875 return_btype = ACPI_RTYPE_PACKAGE;
876 break;
877
878 case ACPI_TYPE_LOCAL_REFERENCE:
879 return_btype = ACPI_RTYPE_REFERENCE;
880 break;
881
882 default:
883 /* Not one of the supported objects, must be incorrect */
884
885 goto type_error_exit;
886 }
887
888 /* Is the object one of the expected types? */
889
890 if (!(return_btype & expected_btypes)) {
891
892 /* Type mismatch -- attempt repair of the returned object */
893
894 status = acpi_ns_repair_object(expected_btypes, package_index,
895 return_object_ptr);
896 if (ACPI_SUCCESS(status)) {
897 return (status);
898 }
899 goto type_error_exit;
900 }
901
902 /* For reference objects, check that the reference type is correct */
903
904 if (ACPI_GET_OBJECT_TYPE(return_object) == ACPI_TYPE_LOCAL_REFERENCE) {
905 status = acpi_ns_check_reference(pathname, return_object);
906 }
907
908 return (status);
909
910 type_error_exit:
911
912 /* Create a string with all expected types for this predefined object */
913
914 j = 1;
915 type_buffer[0] = 0;
916 this_rtype = ACPI_RTYPE_INTEGER;
917
918 for (i = 0; i < ACPI_NUM_RTYPES; i++) {
919
920 /* If one of the expected types, concatenate the name of this type */
921
922 if (expected_btypes & this_rtype) {
923 ACPI_STRCAT(type_buffer, &acpi_rtype_names[i][j]);
924 j = 0; /* Use name separator from now on */
925 }
926 this_rtype <<= 1; /* Next Rtype */
927 }
928
929 if (package_index == ACPI_NOT_PACKAGE) {
930 ACPI_WARNING((AE_INFO,
931 "%s: Return type mismatch - found %s, expected %s",
932 pathname,
933 acpi_ut_get_object_type_name(return_object),
934 type_buffer));
935 } else {
936 ACPI_WARNING((AE_INFO,
937 "%s: Return Package type mismatch at index %u - "
938 "found %s, expected %s", pathname, package_index,
939 acpi_ut_get_object_type_name(return_object),
940 type_buffer));
941 }
942
943 return (AE_AML_OPERAND_TYPE);
944}
945
946/*******************************************************************************
947 *
948 * FUNCTION: acpi_ns_check_reference
949 *
950 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
951 * return_object - Object returned from the evaluation of a
952 * method or object
953 *
954 * RETURN: Status
955 *
956 * DESCRIPTION: Check a returned reference object for the correct reference
957 * type. The only reference type that can be returned from a
958 * predefined method is a named reference. All others are invalid.
959 *
960 ******************************************************************************/
961
962static acpi_status
963acpi_ns_check_reference(char *pathname,
964 union acpi_operand_object *return_object)
965{
966
967 /*
968 * Check the reference object for the correct reference type (opcode).
969 * The only type of reference that can be converted to an union acpi_object is
970 * a reference to a named object (reference class: NAME)
971 */
972 if (return_object->reference.class == ACPI_REFCLASS_NAME) {
973 return (AE_OK);
974 }
975
976 ACPI_WARNING((AE_INFO,
977 "%s: Return type mismatch - unexpected reference object type [%s] %2.2X",
978 pathname, acpi_ut_get_reference_name(return_object),
979 return_object->reference.class));
980
981 return (AE_AML_OPERAND_TYPE);
982}
983
984/*******************************************************************************
985 *
986 * FUNCTION: acpi_ns_repair_object
987 *
988 * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
989 * package_index - Used to determine if target is in a package
990 * return_object_ptr - Pointer to the object returned from the
991 * evaluation of a method or object
992 *
993 * RETURN: Status. AE_OK if repair was successful.
994 *
995 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
996 * not expected.
997 *
998 ******************************************************************************/
999
1000static acpi_status
1001acpi_ns_repair_object(u32 expected_btypes,
1002 u32 package_index,
1003 union acpi_operand_object **return_object_ptr)
1004{
1005 union acpi_operand_object *return_object = *return_object_ptr;
1006 union acpi_operand_object *new_object;
1007 acpi_size length;
1008
1009 switch (ACPI_GET_OBJECT_TYPE(return_object)) {
1010 case ACPI_TYPE_BUFFER:
1011
1012 if (!(expected_btypes & ACPI_RTYPE_STRING)) {
1013 return (AE_AML_OPERAND_TYPE);
1014 }
1015
1016 /*
1017 * Have a Buffer, expected a String, convert. Use a to_string
1018 * conversion, no transform performed on the buffer data. The best
1019 * example of this is the _BIF method, where the string data from
1020 * the battery is often (incorrectly) returned as buffer object(s).
1021 */
1022 length = 0;
1023 while ((length < return_object->buffer.length) &&
1024 (return_object->buffer.pointer[length])) {
1025 length++;
1026 }
1027
1028 /* Allocate a new string object */
1029
1030 new_object = acpi_ut_create_string_object(length);
1031 if (!new_object) {
1032 return (AE_NO_MEMORY);
1033 }
1034
1035 /*
1036 * Copy the raw buffer data with no transform. String is already NULL
1037 * terminated at Length+1.
1038 */
1039 ACPI_MEMCPY(new_object->string.pointer,
1040 return_object->buffer.pointer, length);
1041
1042 /* Install the new return object */
1043
1044 acpi_ut_remove_reference(return_object);
1045 *return_object_ptr = new_object;
1046
1047 /*
1048 * If the object is a package element, we need to:
1049 * 1. Decrement the reference count of the orignal object, it was
1050 * incremented when building the package
1051 * 2. Increment the reference count of the new object, it will be
1052 * decremented when releasing the package
1053 */
1054 if (package_index != ACPI_NOT_PACKAGE) {
1055 acpi_ut_remove_reference(return_object);
1056 acpi_ut_add_reference(new_object);
1057 }
1058 return (AE_OK);
1059
1060 default:
1061 break;
1062 }
1063
1064 return (AE_AML_OPERAND_TYPE);
1065}
generated by cgit v1.2.2 (git 2.25.0) at 2024-12-29 20:46:00 -0500