1 /******************************************************************************
2 *
3 * Module Name: nsrepair - Repair for objects returned by predefined methods
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acnamesp.h"
155 #include "acinterp.h"
156 #include "acpredef.h"
157 #include "amlresrc.h"
158
159 #define _COMPONENT ACPI_NAMESPACE
160 ACPI_MODULE_NAME ("nsrepair")
161
162
163 /*******************************************************************************
164 *
165 * This module attempts to repair or convert objects returned by the
166 * predefined methods to an object type that is expected, as per the ACPI
167 * specification. The need for this code is dictated by the many machines that
168 * return incorrect types for the standard predefined methods. Performing these
169 * conversions here, in one place, eliminates the need for individual ACPI
170 * device drivers to do the same. Note: Most of these conversions are different
171 * than the internal object conversion routines used for implicit object
172 * conversion.
173 *
174 * The following conversions can be performed as necessary:
175 *
176 * Integer -> String
177 * Integer -> Buffer
178 * String -> Integer
179 * String -> Buffer
180 * Buffer -> Integer
181 * Buffer -> String
182 * Buffer -> Package of Integers
183 * Package -> Package of one Package
184 *
185 * Additional conversions that are available:
186 * Convert a null return or zero return value to an EndTag descriptor
187 * Convert an ASCII string to a Unicode buffer
188 *
189 * An incorrect standalone object is wrapped with required outer package
190 *
191 * Additional possible repairs:
192 * Required package elements that are NULL replaced by Integer/String/Buffer
193 *
194 ******************************************************************************/
195
196
197 /* Local prototypes */
198
199 static const ACPI_SIMPLE_REPAIR_INFO *
200 AcpiNsMatchSimpleRepair (
201 ACPI_NAMESPACE_NODE *Node,
202 UINT32 ReturnBtype,
203 UINT32 PackageIndex);
204
205
206 /*
207 * Special but simple repairs for some names.
208 *
209 * 2nd argument: Unexpected types that can be repaired
210 */
211 static const ACPI_SIMPLE_REPAIR_INFO AcpiObjectRepairInfo[] =
212 {
213 /* Resource descriptor conversions */
214
215 { "_CRS", ACPI_RTYPE_INTEGER | ACPI_RTYPE_STRING | ACPI_RTYPE_BUFFER | ACPI_RTYPE_NONE,
216 ACPI_NOT_PACKAGE_ELEMENT,
217 AcpiNsConvertToResource },
218 { "_DMA", ACPI_RTYPE_INTEGER | ACPI_RTYPE_STRING | ACPI_RTYPE_BUFFER | ACPI_RTYPE_NONE,
219 ACPI_NOT_PACKAGE_ELEMENT,
220 AcpiNsConvertToResource },
221 { "_PRS", ACPI_RTYPE_INTEGER | ACPI_RTYPE_STRING | ACPI_RTYPE_BUFFER | ACPI_RTYPE_NONE,
222 ACPI_NOT_PACKAGE_ELEMENT,
223 AcpiNsConvertToResource },
224
225 /* Object reference conversions */
226
227 { "_DEP", ACPI_RTYPE_STRING, ACPI_ALL_PACKAGE_ELEMENTS,
228 AcpiNsConvertToReference },
229
230 /* Unicode conversions */
231
232 { "_MLS", ACPI_RTYPE_STRING, 1,
233 AcpiNsConvertToUnicode },
234 { "_STR", ACPI_RTYPE_STRING | ACPI_RTYPE_BUFFER,
235 ACPI_NOT_PACKAGE_ELEMENT,
236 AcpiNsConvertToUnicode },
237 { {0,0,0,0}, 0, 0, NULL } /* Table terminator */
238 };
239
240
241 /*******************************************************************************
242 *
243 * FUNCTION: AcpiNsSimpleRepair
244 *
245 * PARAMETERS: Info - Method execution information block
246 * ExpectedBtypes - Object types expected
247 * PackageIndex - Index of object within parent package (if
248 * applicable - ACPI_NOT_PACKAGE_ELEMENT
249 * otherwise)
250 * ReturnObjectPtr - Pointer to the object returned from the
251 * evaluation of a method or object
252 *
253 * RETURN: Status. AE_OK if repair was successful.
254 *
255 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
256 * not expected.
257 *
258 ******************************************************************************/
259
260 ACPI_STATUS
AcpiNsSimpleRepair(ACPI_EVALUATE_INFO * Info,UINT32 ExpectedBtypes,UINT32 PackageIndex,ACPI_OPERAND_OBJECT ** ReturnObjectPtr)261 AcpiNsSimpleRepair (
262 ACPI_EVALUATE_INFO *Info,
263 UINT32 ExpectedBtypes,
264 UINT32 PackageIndex,
265 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
266 {
267 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
268 ACPI_OPERAND_OBJECT *NewObject = NULL;
269 ACPI_STATUS Status;
270 const ACPI_SIMPLE_REPAIR_INFO *Predefined;
271
272
273 ACPI_FUNCTION_NAME (NsSimpleRepair);
274
275
276 /*
277 * Special repairs for certain names that are in the repair table.
278 * Check if this name is in the list of repairable names.
279 */
280 Predefined = AcpiNsMatchSimpleRepair (Info->Node,
281 Info->ReturnBtype, PackageIndex);
282 if (Predefined)
283 {
284 if (!ReturnObject)
285 {
286 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname,
287 ACPI_WARN_ALWAYS, "Missing expected return value"));
288 }
289
290 Status = Predefined->ObjectConverter (Info->Node, ReturnObject,
291 &NewObject);
292 if (ACPI_FAILURE (Status))
293 {
294 /* A fatal error occurred during a conversion */
295
296 ACPI_EXCEPTION ((AE_INFO, Status,
297 "During return object analysis"));
298 return (Status);
299 }
300 if (NewObject)
301 {
302 goto ObjectRepaired;
303 }
304 }
305
306 /*
307 * Do not perform simple object repair unless the return type is not
308 * expected.
309 */
310 if (Info->ReturnBtype & ExpectedBtypes)
311 {
312 return (AE_OK);
313 }
314
315 /*
316 * At this point, we know that the type of the returned object was not
317 * one of the expected types for this predefined name. Attempt to
318 * repair the object by converting it to one of the expected object
319 * types for this predefined name.
320 */
321
322 /*
323 * If there is no return value, check if we require a return value for
324 * this predefined name. Either one return value is expected, or none,
325 * for both methods and other objects.
326 *
327 * Try to fix if there was no return object. Warning if failed to fix.
328 */
329 if (!ReturnObject)
330 {
331 if (ExpectedBtypes)
332 {
333 if (!(ExpectedBtypes & ACPI_RTYPE_NONE) &&
334 PackageIndex != ACPI_NOT_PACKAGE_ELEMENT)
335 {
336 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname,
337 ACPI_WARN_ALWAYS, "Found unexpected NULL package element"));
338
339 Status = AcpiNsRepairNullElement (Info, ExpectedBtypes,
340 PackageIndex, ReturnObjectPtr);
341 if (ACPI_SUCCESS (Status))
342 {
343 return (AE_OK); /* Repair was successful */
344 }
345 }
346
347 if (ExpectedBtypes != ACPI_RTYPE_NONE)
348 {
349 ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname,
350 ACPI_WARN_ALWAYS,
351 "Missing expected return value"));
352 return (AE_AML_NO_RETURN_VALUE);
353 }
354 }
355 }
356
357 if (ExpectedBtypes & ACPI_RTYPE_INTEGER)
358 {
359 Status = AcpiNsConvertToInteger (ReturnObject, &NewObject);
360 if (ACPI_SUCCESS (Status))
361 {
362 goto ObjectRepaired;
363 }
364 }
365 if (ExpectedBtypes & ACPI_RTYPE_STRING)
366 {
367 Status = AcpiNsConvertToString (ReturnObject, &NewObject);
368 if (ACPI_SUCCESS (Status))
369 {
370 goto ObjectRepaired;
371 }
372 }
373 if (ExpectedBtypes & ACPI_RTYPE_BUFFER)
374 {
375 Status = AcpiNsConvertToBuffer (ReturnObject, &NewObject);
376 if (ACPI_SUCCESS (Status))
377 {
378 goto ObjectRepaired;
379 }
380 }
381 if (ExpectedBtypes & ACPI_RTYPE_PACKAGE)
382 {
383 /*
384 * A package is expected. We will wrap the existing object with a
385 * new package object. It is often the case that if a variable-length
386 * package is required, but there is only a single object needed, the
387 * BIOS will return that object instead of wrapping it with a Package
388 * object. Note: after the wrapping, the package will be validated
389 * for correct contents (expected object type or types).
390 */
391 Status = AcpiNsWrapWithPackage (Info, ReturnObject, &NewObject);
392 if (ACPI_SUCCESS (Status))
393 {
394 /*
395 * The original object just had its reference count
396 * incremented for being inserted into the new package.
397 */
398 *ReturnObjectPtr = NewObject; /* New Package object */
399 Info->ReturnFlags |= ACPI_OBJECT_REPAIRED;
400 return (AE_OK);
401 }
402 }
403
404 /* We cannot repair this object */
405
406 return (AE_AML_OPERAND_TYPE);
407
408
409 ObjectRepaired:
410
411 /* Object was successfully repaired */
412
413 if (PackageIndex != ACPI_NOT_PACKAGE_ELEMENT)
414 {
415 /* Update reference count of new object */
416
417 if (!(Info->ReturnFlags & ACPI_OBJECT_WRAPPED))
418 {
419 NewObject->Common.ReferenceCount =
420 ReturnObject->Common.ReferenceCount;
421 }
422
423 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
424 "%s: Converted %s to expected %s at Package index %u\n",
425 Info->FullPathname, AcpiUtGetObjectTypeName (ReturnObject),
426 AcpiUtGetObjectTypeName (NewObject), PackageIndex));
427 }
428 else
429 {
430 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
431 "%s: Converted %s to expected %s\n",
432 Info->FullPathname, AcpiUtGetObjectTypeName (ReturnObject),
433 AcpiUtGetObjectTypeName (NewObject)));
434 }
435
436 /* Delete old object, install the new return object */
437
438 AcpiUtRemoveReference (ReturnObject);
439 *ReturnObjectPtr = NewObject;
440 Info->ReturnFlags |= ACPI_OBJECT_REPAIRED;
441 return (AE_OK);
442 }
443
444
445 /******************************************************************************
446 *
447 * FUNCTION: AcpiNsMatchSimpleRepair
448 *
449 * PARAMETERS: Node - Namespace node for the method/object
450 * ReturnBtype - Object type that was returned
451 * PackageIndex - Index of object within parent package (if
452 * applicable - ACPI_NOT_PACKAGE_ELEMENT
453 * otherwise)
454 *
455 * RETURN: Pointer to entry in repair table. NULL indicates not found.
456 *
457 * DESCRIPTION: Check an object name against the repairable object list.
458 *
459 *****************************************************************************/
460
461 static const ACPI_SIMPLE_REPAIR_INFO *
AcpiNsMatchSimpleRepair(ACPI_NAMESPACE_NODE * Node,UINT32 ReturnBtype,UINT32 PackageIndex)462 AcpiNsMatchSimpleRepair (
463 ACPI_NAMESPACE_NODE *Node,
464 UINT32 ReturnBtype,
465 UINT32 PackageIndex)
466 {
467 const ACPI_SIMPLE_REPAIR_INFO *ThisName;
468
469
470 /* Search info table for a repairable predefined method/object name */
471
472 ThisName = AcpiObjectRepairInfo;
473 while (ThisName->ObjectConverter)
474 {
475 if (ACPI_COMPARE_NAMESEG (Node->Name.Ascii, ThisName->Name))
476 {
477 /* Check if we can actually repair this name/type combination */
478
479 if ((ReturnBtype & ThisName->UnexpectedBtypes) &&
480 (ThisName->PackageIndex == ACPI_ALL_PACKAGE_ELEMENTS ||
481 PackageIndex == ThisName->PackageIndex))
482 {
483 return (ThisName);
484 }
485
486 return (NULL);
487 }
488
489 ThisName++;
490 }
491
492 return (NULL); /* Name was not found in the repair table */
493 }
494
495
496 /*******************************************************************************
497 *
498 * FUNCTION: AcpiNsRepairNullElement
499 *
500 * PARAMETERS: Info - Method execution information block
501 * ExpectedBtypes - Object types expected
502 * PackageIndex - Index of object within parent package (if
503 * applicable - ACPI_NOT_PACKAGE_ELEMENT
504 * otherwise)
505 * ReturnObjectPtr - Pointer to the object returned from the
506 * evaluation of a method or object
507 *
508 * RETURN: Status. AE_OK if repair was successful.
509 *
510 * DESCRIPTION: Attempt to repair a NULL element of a returned Package object.
511 *
512 ******************************************************************************/
513
514 ACPI_STATUS
AcpiNsRepairNullElement(ACPI_EVALUATE_INFO * Info,UINT32 ExpectedBtypes,UINT32 PackageIndex,ACPI_OPERAND_OBJECT ** ReturnObjectPtr)515 AcpiNsRepairNullElement (
516 ACPI_EVALUATE_INFO *Info,
517 UINT32 ExpectedBtypes,
518 UINT32 PackageIndex,
519 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
520 {
521 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
522 ACPI_OPERAND_OBJECT *NewObject;
523
524
525 ACPI_FUNCTION_NAME (NsRepairNullElement);
526
527
528 /* No repair needed if return object is non-NULL */
529
530 if (ReturnObject)
531 {
532 return (AE_OK);
533 }
534
535 /*
536 * Attempt to repair a NULL element of a Package object. This applies to
537 * predefined names that return a fixed-length package and each element
538 * is required. It does not apply to variable-length packages where NULL
539 * elements are allowed, especially at the end of the package.
540 */
541 if (ExpectedBtypes & ACPI_RTYPE_INTEGER)
542 {
543 /* Need an Integer - create a zero-value integer */
544
545 NewObject = AcpiUtCreateIntegerObject ((UINT64) 0);
546 }
547 else if (ExpectedBtypes & ACPI_RTYPE_STRING)
548 {
549 /* Need a String - create a NULL string */
550
551 NewObject = AcpiUtCreateStringObject (0);
552 }
553 else if (ExpectedBtypes & ACPI_RTYPE_BUFFER)
554 {
555 /* Need a Buffer - create a zero-length buffer */
556
557 NewObject = AcpiUtCreateBufferObject (0);
558 }
559 else
560 {
561 /* Error for all other expected types */
562
563 return (AE_AML_OPERAND_TYPE);
564 }
565
566 if (!NewObject)
567 {
568 return (AE_NO_MEMORY);
569 }
570
571 /* Set the reference count according to the parent Package object */
572
573 NewObject->Common.ReferenceCount =
574 Info->ParentPackage->Common.ReferenceCount;
575
576 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
577 "%s: Converted NULL package element to expected %s at index %u\n",
578 Info->FullPathname, AcpiUtGetObjectTypeName (NewObject),
579 PackageIndex));
580
581 *ReturnObjectPtr = NewObject;
582 Info->ReturnFlags |= ACPI_OBJECT_REPAIRED;
583 return (AE_OK);
584 }
585
586
587 /******************************************************************************
588 *
589 * FUNCTION: AcpiNsRemoveNullElements
590 *
591 * PARAMETERS: Info - Method execution information block
592 * PackageType - An AcpiReturnPackageTypes value
593 * ObjDesc - A Package object
594 *
595 * RETURN: None.
596 *
597 * DESCRIPTION: Remove all NULL package elements from packages that contain
598 * a variable number of subpackages. For these types of
599 * packages, NULL elements can be safely removed.
600 *
601 *****************************************************************************/
602
603 void
AcpiNsRemoveNullElements(ACPI_EVALUATE_INFO * Info,UINT8 PackageType,ACPI_OPERAND_OBJECT * ObjDesc)604 AcpiNsRemoveNullElements (
605 ACPI_EVALUATE_INFO *Info,
606 UINT8 PackageType,
607 ACPI_OPERAND_OBJECT *ObjDesc)
608 {
609 ACPI_OPERAND_OBJECT **Source;
610 ACPI_OPERAND_OBJECT **Dest;
611 UINT32 Count;
612 UINT32 NewCount;
613 UINT32 i;
614
615
616 ACPI_FUNCTION_NAME (NsRemoveNullElements);
617
618
619 /*
620 * We can safely remove all NULL elements from these package types:
621 * PTYPE1_VAR packages contain a variable number of simple data types.
622 * PTYPE2 packages contain a variable number of subpackages.
623 */
624 switch (PackageType)
625 {
626 case ACPI_PTYPE1_VAR:
627 case ACPI_PTYPE2:
628 case ACPI_PTYPE2_COUNT:
629 case ACPI_PTYPE2_PKG_COUNT:
630 case ACPI_PTYPE2_FIXED:
631 case ACPI_PTYPE2_MIN:
632 case ACPI_PTYPE2_REV_FIXED:
633 case ACPI_PTYPE2_FIX_VAR:
634 break;
635
636 default:
637 case ACPI_PTYPE2_VAR_VAR:
638 case ACPI_PTYPE1_FIXED:
639 case ACPI_PTYPE1_OPTION:
640 return;
641 }
642
643 Count = ObjDesc->Package.Count;
644 NewCount = Count;
645
646 Source = ObjDesc->Package.Elements;
647 Dest = Source;
648
649 /* Examine all elements of the package object, remove nulls */
650
651 for (i = 0; i < Count; i++)
652 {
653 if (!*Source)
654 {
655 NewCount--;
656 }
657 else
658 {
659 *Dest = *Source;
660 Dest++;
661 }
662
663 Source++;
664 }
665
666 /* Update parent package if any null elements were removed */
667
668 if (NewCount < Count)
669 {
670 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
671 "%s: Found and removed %u NULL elements\n",
672 Info->FullPathname, (Count - NewCount)));
673
674 /* NULL terminate list and update the package count */
675
676 *Dest = NULL;
677 ObjDesc->Package.Count = NewCount;
678 }
679 }
680
681
682 /*******************************************************************************
683 *
684 * FUNCTION: AcpiNsWrapWithPackage
685 *
686 * PARAMETERS: Info - Method execution information block
687 * OriginalObject - Pointer to the object to repair.
688 * ObjDescPtr - The new package object is returned here
689 *
690 * RETURN: Status, new object in *ObjDescPtr
691 *
692 * DESCRIPTION: Repair a common problem with objects that are defined to
693 * return a variable-length Package of sub-objects. If there is
694 * only one sub-object, some BIOS code mistakenly simply declares
695 * the single object instead of a Package with one sub-object.
696 * This function attempts to repair this error by wrapping a
697 * Package object around the original object, creating the
698 * correct and expected Package with one sub-object.
699 *
700 * Names that can be repaired in this manner include:
701 * _ALR, _CSD, _HPX, _MLS, _PLD, _PRT, _PSS, _TRT, _TSS,
702 * _BCL, _DOD, _FIX, _Sx
703 *
704 ******************************************************************************/
705
706 ACPI_STATUS
AcpiNsWrapWithPackage(ACPI_EVALUATE_INFO * Info,ACPI_OPERAND_OBJECT * OriginalObject,ACPI_OPERAND_OBJECT ** ObjDescPtr)707 AcpiNsWrapWithPackage (
708 ACPI_EVALUATE_INFO *Info,
709 ACPI_OPERAND_OBJECT *OriginalObject,
710 ACPI_OPERAND_OBJECT **ObjDescPtr)
711 {
712 ACPI_OPERAND_OBJECT *PkgObjDesc;
713
714
715 ACPI_FUNCTION_NAME (NsWrapWithPackage);
716
717
718 /*
719 * Create the new outer package and populate it. The new
720 * package will have a single element, the lone sub-object.
721 */
722 PkgObjDesc = AcpiUtCreatePackageObject (1);
723 if (!PkgObjDesc)
724 {
725 return (AE_NO_MEMORY);
726 }
727
728 PkgObjDesc->Package.Elements[0] = OriginalObject;
729
730 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
731 "%s: Wrapped %s with expected Package object\n",
732 Info->FullPathname, AcpiUtGetObjectTypeName (OriginalObject)));
733
734 /* Return the new object in the object pointer */
735
736 *ObjDescPtr = PkgObjDesc;
737 Info->ReturnFlags |= ACPI_OBJECT_REPAIRED | ACPI_OBJECT_WRAPPED;
738 return (AE_OK);
739 }
740
