Sync with trunk r62754.
[reactos.git] / drivers / bus / acpi / acpica / namespace / nsprepkg.c
1 /******************************************************************************
2 *
3 * Module Name: nsprepkg - Validation of package objects for predefined names
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
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
19 * property rights.
20 *
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
27 *
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;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
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.
53 *
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
64 * make.
65 *
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
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
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.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
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
88 * PARTICULAR PURPOSE.
89 *
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
97 * LIMITED REMEDY.
98 *
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.
113 *
114 *****************************************************************************/
115
116 #include "acpi.h"
117 #include "accommon.h"
118 #include "acnamesp.h"
119 #include "acpredef.h"
120
121
122 #define _COMPONENT ACPI_NAMESPACE
123 ACPI_MODULE_NAME ("nsprepkg")
124
125
126 /* Local prototypes */
127
128 static ACPI_STATUS
129 AcpiNsCheckPackageList (
130 ACPI_EVALUATE_INFO *Info,
131 const ACPI_PREDEFINED_INFO *Package,
132 ACPI_OPERAND_OBJECT **Elements,
133 UINT32 Count);
134
135 static ACPI_STATUS
136 AcpiNsCheckPackageElements (
137 ACPI_EVALUATE_INFO *Info,
138 ACPI_OPERAND_OBJECT **Elements,
139 UINT8 Type1,
140 UINT32 Count1,
141 UINT8 Type2,
142 UINT32 Count2,
143 UINT32 StartIndex);
144
145
146 /*******************************************************************************
147 *
148 * FUNCTION: AcpiNsCheckPackage
149 *
150 * PARAMETERS: Info - Method execution information block
151 * ReturnObjectPtr - Pointer to the object returned from the
152 * evaluation of a method or object
153 *
154 * RETURN: Status
155 *
156 * DESCRIPTION: Check a returned package object for the correct count and
157 * correct type of all sub-objects.
158 *
159 ******************************************************************************/
160
161 ACPI_STATUS
162 AcpiNsCheckPackage (
163 ACPI_EVALUATE_INFO *Info,
164 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
165 {
166 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
167 const ACPI_PREDEFINED_INFO *Package;
168 ACPI_OPERAND_OBJECT **Elements;
169 ACPI_STATUS Status = AE_OK;
170 UINT32 ExpectedCount;
171 UINT32 Count;
172 UINT32 i;
173
174
175 ACPI_FUNCTION_NAME (NsCheckPackage);
176
177
178 /* The package info for this name is in the next table entry */
179
180 Package = Info->Predefined + 1;
181
182 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
183 "%s Validating return Package of Type %X, Count %X\n",
184 Info->FullPathname, Package->RetInfo.Type,
185 ReturnObject->Package.Count));
186
187 /*
188 * For variable-length Packages, we can safely remove all embedded
189 * and trailing NULL package elements
190 */
191 AcpiNsRemoveNullElements (Info, Package->RetInfo.Type, ReturnObject);
192
193 /* Extract package count and elements array */
194
195 Elements = ReturnObject->Package.Elements;
196 Count = ReturnObject->Package.Count;
197
198 /*
199 * Most packages must have at least one element. The only exception
200 * is the variable-length package (ACPI_PTYPE1_VAR).
201 */
202 if (!Count)
203 {
204 if (Package->RetInfo.Type == ACPI_PTYPE1_VAR)
205 {
206 return (AE_OK);
207 }
208
209 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
210 "Return Package has no elements (empty)"));
211
212 return (AE_AML_OPERAND_VALUE);
213 }
214
215 /*
216 * Decode the type of the expected package contents
217 *
218 * PTYPE1 packages contain no subpackages
219 * PTYPE2 packages contain subpackages
220 */
221 switch (Package->RetInfo.Type)
222 {
223 case ACPI_PTYPE1_FIXED:
224 /*
225 * The package count is fixed and there are no subpackages
226 *
227 * If package is too small, exit.
228 * If package is larger than expected, issue warning but continue
229 */
230 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
231 if (Count < ExpectedCount)
232 {
233 goto PackageTooSmall;
234 }
235 else if (Count > ExpectedCount)
236 {
237 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
238 "%s: Return Package is larger than needed - "
239 "found %u, expected %u\n",
240 Info->FullPathname, Count, ExpectedCount));
241 }
242
243 /* Validate all elements of the returned package */
244
245 Status = AcpiNsCheckPackageElements (Info, Elements,
246 Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
247 Package->RetInfo.ObjectType2, Package->RetInfo.Count2, 0);
248 break;
249
250 case ACPI_PTYPE1_VAR:
251 /*
252 * The package count is variable, there are no subpackages, and all
253 * elements must be of the same type
254 */
255 for (i = 0; i < Count; i++)
256 {
257 Status = AcpiNsCheckObjectType (Info, Elements,
258 Package->RetInfo.ObjectType1, i);
259 if (ACPI_FAILURE (Status))
260 {
261 return (Status);
262 }
263 Elements++;
264 }
265 break;
266
267 case ACPI_PTYPE1_OPTION:
268 /*
269 * The package count is variable, there are no subpackages. There are
270 * a fixed number of required elements, and a variable number of
271 * optional elements.
272 *
273 * Check if package is at least as large as the minimum required
274 */
275 ExpectedCount = Package->RetInfo3.Count;
276 if (Count < ExpectedCount)
277 {
278 goto PackageTooSmall;
279 }
280
281 /* Variable number of sub-objects */
282
283 for (i = 0; i < Count; i++)
284 {
285 if (i < Package->RetInfo3.Count)
286 {
287 /* These are the required package elements (0, 1, or 2) */
288
289 Status = AcpiNsCheckObjectType (Info, Elements,
290 Package->RetInfo3.ObjectType[i], i);
291 if (ACPI_FAILURE (Status))
292 {
293 return (Status);
294 }
295 }
296 else
297 {
298 /* These are the optional package elements */
299
300 Status = AcpiNsCheckObjectType (Info, Elements,
301 Package->RetInfo3.TailObjectType, i);
302 if (ACPI_FAILURE (Status))
303 {
304 return (Status);
305 }
306 }
307 Elements++;
308 }
309 break;
310
311 case ACPI_PTYPE2_REV_FIXED:
312
313 /* First element is the (Integer) revision */
314
315 Status = AcpiNsCheckObjectType (Info, Elements,
316 ACPI_RTYPE_INTEGER, 0);
317 if (ACPI_FAILURE (Status))
318 {
319 return (Status);
320 }
321
322 Elements++;
323 Count--;
324
325 /* Examine the subpackages */
326
327 Status = AcpiNsCheckPackageList (Info, Package, Elements, Count);
328 break;
329
330 case ACPI_PTYPE2_PKG_COUNT:
331
332 /* First element is the (Integer) count of subpackages to follow */
333
334 Status = AcpiNsCheckObjectType (Info, Elements,
335 ACPI_RTYPE_INTEGER, 0);
336 if (ACPI_FAILURE (Status))
337 {
338 return (Status);
339 }
340
341 /*
342 * Count cannot be larger than the parent package length, but allow it
343 * to be smaller. The >= accounts for the Integer above.
344 */
345 ExpectedCount = (UINT32) (*Elements)->Integer.Value;
346 if (ExpectedCount >= Count)
347 {
348 goto PackageTooSmall;
349 }
350
351 Count = ExpectedCount;
352 Elements++;
353
354 /* Examine the subpackages */
355
356 Status = AcpiNsCheckPackageList (Info, Package, Elements, Count);
357 break;
358
359 case ACPI_PTYPE2:
360 case ACPI_PTYPE2_FIXED:
361 case ACPI_PTYPE2_MIN:
362 case ACPI_PTYPE2_COUNT:
363 case ACPI_PTYPE2_FIX_VAR:
364 /*
365 * These types all return a single Package that consists of a
366 * variable number of subpackages.
367 *
368 * First, ensure that the first element is a subpackage. If not,
369 * the BIOS may have incorrectly returned the object as a single
370 * package instead of a Package of Packages (a common error if
371 * there is only one entry). We may be able to repair this by
372 * wrapping the returned Package with a new outer Package.
373 */
374 if (*Elements && ((*Elements)->Common.Type != ACPI_TYPE_PACKAGE))
375 {
376 /* Create the new outer package and populate it */
377
378 Status = AcpiNsWrapWithPackage (Info, ReturnObject, ReturnObjectPtr);
379 if (ACPI_FAILURE (Status))
380 {
381 return (Status);
382 }
383
384 /* Update locals to point to the new package (of 1 element) */
385
386 ReturnObject = *ReturnObjectPtr;
387 Elements = ReturnObject->Package.Elements;
388 Count = 1;
389 }
390
391 /* Examine the subpackages */
392
393 Status = AcpiNsCheckPackageList (Info, Package, Elements, Count);
394 break;
395
396 default:
397
398 /* Should not get here if predefined info table is correct */
399
400 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
401 "Invalid internal return type in table entry: %X",
402 Package->RetInfo.Type));
403
404 return (AE_AML_INTERNAL);
405 }
406
407 return (Status);
408
409
410 PackageTooSmall:
411
412 /* Error exit for the case with an incorrect package count */
413
414 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
415 "Return Package is too small - found %u elements, expected %u",
416 Count, ExpectedCount));
417
418 return (AE_AML_OPERAND_VALUE);
419 }
420
421
422 /*******************************************************************************
423 *
424 * FUNCTION: AcpiNsCheckPackageList
425 *
426 * PARAMETERS: Info - Method execution information block
427 * Package - Pointer to package-specific info for method
428 * Elements - Element list of parent package. All elements
429 * of this list should be of type Package.
430 * Count - Count of subpackages
431 *
432 * RETURN: Status
433 *
434 * DESCRIPTION: Examine a list of subpackages
435 *
436 ******************************************************************************/
437
438 static ACPI_STATUS
439 AcpiNsCheckPackageList (
440 ACPI_EVALUATE_INFO *Info,
441 const ACPI_PREDEFINED_INFO *Package,
442 ACPI_OPERAND_OBJECT **Elements,
443 UINT32 Count)
444 {
445 ACPI_OPERAND_OBJECT *SubPackage;
446 ACPI_OPERAND_OBJECT **SubElements;
447 ACPI_STATUS Status;
448 UINT32 ExpectedCount;
449 UINT32 i;
450 UINT32 j;
451
452
453 /*
454 * Validate each subpackage in the parent Package
455 *
456 * NOTE: assumes list of subpackages contains no NULL elements.
457 * Any NULL elements should have been removed by earlier call
458 * to AcpiNsRemoveNullElements.
459 */
460 for (i = 0; i < Count; i++)
461 {
462 SubPackage = *Elements;
463 SubElements = SubPackage->Package.Elements;
464 Info->ParentPackage = SubPackage;
465
466 /* Each sub-object must be of type Package */
467
468 Status = AcpiNsCheckObjectType (Info, &SubPackage,
469 ACPI_RTYPE_PACKAGE, i);
470 if (ACPI_FAILURE (Status))
471 {
472 return (Status);
473 }
474
475 /* Examine the different types of expected subpackages */
476
477 Info->ParentPackage = SubPackage;
478 switch (Package->RetInfo.Type)
479 {
480 case ACPI_PTYPE2:
481 case ACPI_PTYPE2_PKG_COUNT:
482 case ACPI_PTYPE2_REV_FIXED:
483
484 /* Each subpackage has a fixed number of elements */
485
486 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
487 if (SubPackage->Package.Count < ExpectedCount)
488 {
489 goto PackageTooSmall;
490 }
491
492 Status = AcpiNsCheckPackageElements (Info, SubElements,
493 Package->RetInfo.ObjectType1,
494 Package->RetInfo.Count1,
495 Package->RetInfo.ObjectType2,
496 Package->RetInfo.Count2, 0);
497 if (ACPI_FAILURE (Status))
498 {
499 return (Status);
500 }
501 break;
502
503 case ACPI_PTYPE2_FIX_VAR:
504 /*
505 * Each subpackage has a fixed number of elements and an
506 * optional element
507 */
508 ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
509 if (SubPackage->Package.Count < ExpectedCount)
510 {
511 goto PackageTooSmall;
512 }
513
514 Status = AcpiNsCheckPackageElements (Info, SubElements,
515 Package->RetInfo.ObjectType1,
516 Package->RetInfo.Count1,
517 Package->RetInfo.ObjectType2,
518 SubPackage->Package.Count - Package->RetInfo.Count1, 0);
519 if (ACPI_FAILURE (Status))
520 {
521 return (Status);
522 }
523 break;
524
525 case ACPI_PTYPE2_FIXED:
526
527 /* Each subpackage has a fixed length */
528
529 ExpectedCount = Package->RetInfo2.Count;
530 if (SubPackage->Package.Count < ExpectedCount)
531 {
532 goto PackageTooSmall;
533 }
534
535 /* Check the type of each subpackage element */
536
537 for (j = 0; j < ExpectedCount; j++)
538 {
539 Status = AcpiNsCheckObjectType (Info, &SubElements[j],
540 Package->RetInfo2.ObjectType[j], j);
541 if (ACPI_FAILURE (Status))
542 {
543 return (Status);
544 }
545 }
546 break;
547
548 case ACPI_PTYPE2_MIN:
549
550 /* Each subpackage has a variable but minimum length */
551
552 ExpectedCount = Package->RetInfo.Count1;
553 if (SubPackage->Package.Count < ExpectedCount)
554 {
555 goto PackageTooSmall;
556 }
557
558 /* Check the type of each subpackage element */
559
560 Status = AcpiNsCheckPackageElements (Info, SubElements,
561 Package->RetInfo.ObjectType1,
562 SubPackage->Package.Count, 0, 0, 0);
563 if (ACPI_FAILURE (Status))
564 {
565 return (Status);
566 }
567 break;
568
569 case ACPI_PTYPE2_COUNT:
570 /*
571 * First element is the (Integer) count of elements, including
572 * the count field (the ACPI name is NumElements)
573 */
574 Status = AcpiNsCheckObjectType (Info, SubElements,
575 ACPI_RTYPE_INTEGER, 0);
576 if (ACPI_FAILURE (Status))
577 {
578 return (Status);
579 }
580
581 /*
582 * Make sure package is large enough for the Count and is
583 * is as large as the minimum size
584 */
585 ExpectedCount = (UINT32) (*SubElements)->Integer.Value;
586 if (SubPackage->Package.Count < ExpectedCount)
587 {
588 goto PackageTooSmall;
589 }
590 if (SubPackage->Package.Count < Package->RetInfo.Count1)
591 {
592 ExpectedCount = Package->RetInfo.Count1;
593 goto PackageTooSmall;
594 }
595 if (ExpectedCount == 0)
596 {
597 /*
598 * Either the NumEntries element was originally zero or it was
599 * a NULL element and repaired to an Integer of value zero.
600 * In either case, repair it by setting NumEntries to be the
601 * actual size of the subpackage.
602 */
603 ExpectedCount = SubPackage->Package.Count;
604 (*SubElements)->Integer.Value = ExpectedCount;
605 }
606
607 /* Check the type of each subpackage element */
608
609 Status = AcpiNsCheckPackageElements (Info, (SubElements + 1),
610 Package->RetInfo.ObjectType1,
611 (ExpectedCount - 1), 0, 0, 1);
612 if (ACPI_FAILURE (Status))
613 {
614 return (Status);
615 }
616 break;
617
618 default: /* Should not get here, type was validated by caller */
619
620 return (AE_AML_INTERNAL);
621 }
622
623 Elements++;
624 }
625
626 return (AE_OK);
627
628
629 PackageTooSmall:
630
631 /* The subpackage count was smaller than required */
632
633 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, Info->NodeFlags,
634 "Return SubPackage[%u] is too small - found %u elements, expected %u",
635 i, SubPackage->Package.Count, ExpectedCount));
636
637 return (AE_AML_OPERAND_VALUE);
638 }
639
640
641 /*******************************************************************************
642 *
643 * FUNCTION: AcpiNsCheckPackageElements
644 *
645 * PARAMETERS: Info - Method execution information block
646 * Elements - Pointer to the package elements array
647 * Type1 - Object type for first group
648 * Count1 - Count for first group
649 * Type2 - Object type for second group
650 * Count2 - Count for second group
651 * StartIndex - Start of the first group of elements
652 *
653 * RETURN: Status
654 *
655 * DESCRIPTION: Check that all elements of a package are of the correct object
656 * type. Supports up to two groups of different object types.
657 *
658 ******************************************************************************/
659
660 static ACPI_STATUS
661 AcpiNsCheckPackageElements (
662 ACPI_EVALUATE_INFO *Info,
663 ACPI_OPERAND_OBJECT **Elements,
664 UINT8 Type1,
665 UINT32 Count1,
666 UINT8 Type2,
667 UINT32 Count2,
668 UINT32 StartIndex)
669 {
670 ACPI_OPERAND_OBJECT **ThisElement = Elements;
671 ACPI_STATUS Status;
672 UINT32 i;
673
674
675 /*
676 * Up to two groups of package elements are supported by the data
677 * structure. All elements in each group must be of the same type.
678 * The second group can have a count of zero.
679 */
680 for (i = 0; i < Count1; i++)
681 {
682 Status = AcpiNsCheckObjectType (Info, ThisElement,
683 Type1, i + StartIndex);
684 if (ACPI_FAILURE (Status))
685 {
686 return (Status);
687 }
688 ThisElement++;
689 }
690
691 for (i = 0; i < Count2; i++)
692 {
693 Status = AcpiNsCheckObjectType (Info, ThisElement,
694 Type2, (i + Count1 + StartIndex));
695 if (ACPI_FAILURE (Status))
696 {
697 return (Status);
698 }
699 ThisElement++;
700 }
701
702 return (AE_OK);
703 }