1 /******************************************************************************
3 * Module Name: nsrepair - Repair for objects returned by predefined methods
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************/
116 #define __NSREPAIR_C__
119 #include "accommon.h"
120 #include "acnamesp.h"
121 #include "acinterp.h"
122 #include "acpredef.h"
123 #include "amlresrc.h"
125 #define _COMPONENT ACPI_NAMESPACE
126 ACPI_MODULE_NAME ("nsrepair")
129 /*******************************************************************************
131 * This module attempts to repair or convert objects returned by the
132 * predefined methods to an object type that is expected, as per the ACPI
133 * specification. The need for this code is dictated by the many machines that
134 * return incorrect types for the standard predefined methods. Performing these
135 * conversions here, in one place, eliminates the need for individual ACPI
136 * device drivers to do the same. Note: Most of these conversions are different
137 * than the internal object conversion routines used for implicit object
140 * The following conversions can be performed as necessary:
148 * Buffer -> Package of Integers
149 * Package -> Package of one Package
151 * Additional conversions that are available:
152 * Convert a null return or zero return value to an EndTag descriptor
153 * Convert an ASCII string to a Unicode buffer
155 * An incorrect standalone object is wrapped with required outer package
157 * Additional possible repairs:
158 * Required package elements that are NULL replaced by Integer/String/Buffer
160 ******************************************************************************/
163 /* Local prototypes */
165 static const ACPI_SIMPLE_REPAIR_INFO
*
166 AcpiNsMatchSimpleRepair (
167 ACPI_NAMESPACE_NODE
*Node
,
169 UINT32 PackageIndex
);
173 * Special but simple repairs for some names.
175 * 2nd argument: Unexpected types that can be repaired
177 static const ACPI_SIMPLE_REPAIR_INFO AcpiObjectRepairInfo
[] =
179 /* Resource descriptor conversions */
181 { "_CRS", ACPI_RTYPE_INTEGER
| ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
| ACPI_RTYPE_NONE
,
182 ACPI_NOT_PACKAGE_ELEMENT
,
183 AcpiNsConvertToResource
},
184 { "_DMA", ACPI_RTYPE_INTEGER
| ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
| ACPI_RTYPE_NONE
,
185 ACPI_NOT_PACKAGE_ELEMENT
,
186 AcpiNsConvertToResource
},
187 { "_PRS", ACPI_RTYPE_INTEGER
| ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
| ACPI_RTYPE_NONE
,
188 ACPI_NOT_PACKAGE_ELEMENT
,
189 AcpiNsConvertToResource
},
191 /* Unicode conversions */
193 { "_MLS", ACPI_RTYPE_STRING
, 1,
194 AcpiNsConvertToUnicode
},
195 { "_STR", ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
,
196 ACPI_NOT_PACKAGE_ELEMENT
,
197 AcpiNsConvertToUnicode
},
198 { {0,0,0,0}, 0, 0, NULL
} /* Table terminator */
202 /*******************************************************************************
204 * FUNCTION: AcpiNsSimpleRepair
206 * PARAMETERS: Info - Method execution information block
207 * ExpectedBtypes - Object types expected
208 * PackageIndex - Index of object within parent package (if
209 * applicable - ACPI_NOT_PACKAGE_ELEMENT
211 * ReturnObjectPtr - Pointer to the object returned from the
212 * evaluation of a method or object
214 * RETURN: Status. AE_OK if repair was successful.
216 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
219 ******************************************************************************/
223 ACPI_EVALUATE_INFO
*Info
,
224 UINT32 ExpectedBtypes
,
226 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
228 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
229 ACPI_OPERAND_OBJECT
*NewObject
= NULL
;
231 const ACPI_SIMPLE_REPAIR_INFO
*Predefined
;
234 ACPI_FUNCTION_NAME (NsSimpleRepair
);
238 * Special repairs for certain names that are in the repair table.
239 * Check if this name is in the list of repairable names.
241 Predefined
= AcpiNsMatchSimpleRepair (Info
->Node
,
242 Info
->ReturnBtype
, PackageIndex
);
247 ACPI_WARN_PREDEFINED ((AE_INFO
, Info
->FullPathname
,
248 ACPI_WARN_ALWAYS
, "Missing expected return value"));
251 Status
= Predefined
->ObjectConverter (ReturnObject
, &NewObject
);
252 if (ACPI_FAILURE (Status
))
254 /* A fatal error occurred during a conversion */
256 ACPI_EXCEPTION ((AE_INFO
, Status
,
257 "During return object analysis"));
267 * Do not perform simple object repair unless the return type is not
270 if (Info
->ReturnBtype
& ExpectedBtypes
)
276 * At this point, we know that the type of the returned object was not
277 * one of the expected types for this predefined name. Attempt to
278 * repair the object by converting it to one of the expected object
279 * types for this predefined name.
283 * If there is no return value, check if we require a return value for
284 * this predefined name. Either one return value is expected, or none,
285 * for both methods and other objects.
287 * Try to fix if there was no return object. Warning if failed to fix.
291 if (ExpectedBtypes
&& (!(ExpectedBtypes
& ACPI_RTYPE_NONE
)))
293 if (PackageIndex
!= ACPI_NOT_PACKAGE_ELEMENT
)
295 ACPI_WARN_PREDEFINED ((AE_INFO
, Info
->FullPathname
,
296 ACPI_WARN_ALWAYS
, "Found unexpected NULL package element"));
298 Status
= AcpiNsRepairNullElement (Info
, ExpectedBtypes
,
299 PackageIndex
, ReturnObjectPtr
);
300 if (ACPI_SUCCESS (Status
))
302 return (AE_OK
); /* Repair was successful */
307 ACPI_WARN_PREDEFINED ((AE_INFO
, Info
->FullPathname
,
308 ACPI_WARN_ALWAYS
, "Missing expected return value"));
311 return (AE_AML_NO_RETURN_VALUE
);
315 if (ExpectedBtypes
& ACPI_RTYPE_INTEGER
)
317 Status
= AcpiNsConvertToInteger (ReturnObject
, &NewObject
);
318 if (ACPI_SUCCESS (Status
))
323 if (ExpectedBtypes
& ACPI_RTYPE_STRING
)
325 Status
= AcpiNsConvertToString (ReturnObject
, &NewObject
);
326 if (ACPI_SUCCESS (Status
))
331 if (ExpectedBtypes
& ACPI_RTYPE_BUFFER
)
333 Status
= AcpiNsConvertToBuffer (ReturnObject
, &NewObject
);
334 if (ACPI_SUCCESS (Status
))
339 if (ExpectedBtypes
& ACPI_RTYPE_PACKAGE
)
342 * A package is expected. We will wrap the existing object with a
343 * new package object. It is often the case that if a variable-length
344 * package is required, but there is only a single object needed, the
345 * BIOS will return that object instead of wrapping it with a Package
346 * object. Note: after the wrapping, the package will be validated
347 * for correct contents (expected object type or types).
349 Status
= AcpiNsWrapWithPackage (Info
, ReturnObject
, &NewObject
);
350 if (ACPI_SUCCESS (Status
))
353 * The original object just had its reference count
354 * incremented for being inserted into the new package.
356 *ReturnObjectPtr
= NewObject
; /* New Package object */
357 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
;
362 /* We cannot repair this object */
364 return (AE_AML_OPERAND_TYPE
);
369 /* Object was successfully repaired */
371 if (PackageIndex
!= ACPI_NOT_PACKAGE_ELEMENT
)
374 * The original object is a package element. We need to
375 * decrement the reference count of the original object,
376 * for removing it from the package.
378 * However, if the original object was just wrapped with a
379 * package object as part of the repair, we don't need to
380 * change the reference count.
382 if (!(Info
->ReturnFlags
& ACPI_OBJECT_WRAPPED
))
384 NewObject
->Common
.ReferenceCount
=
385 ReturnObject
->Common
.ReferenceCount
;
387 if (ReturnObject
->Common
.ReferenceCount
> 1)
389 ReturnObject
->Common
.ReferenceCount
--;
393 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
394 "%s: Converted %s to expected %s at Package index %u\n",
395 Info
->FullPathname
, AcpiUtGetObjectTypeName (ReturnObject
),
396 AcpiUtGetObjectTypeName (NewObject
), PackageIndex
));
400 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
401 "%s: Converted %s to expected %s\n",
402 Info
->FullPathname
, AcpiUtGetObjectTypeName (ReturnObject
),
403 AcpiUtGetObjectTypeName (NewObject
)));
406 /* Delete old object, install the new return object */
408 AcpiUtRemoveReference (ReturnObject
);
409 *ReturnObjectPtr
= NewObject
;
410 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
;
415 /******************************************************************************
417 * FUNCTION: AcpiNsMatchSimpleRepair
419 * PARAMETERS: Node - Namespace node for the method/object
420 * ReturnBtype - Object type that was returned
421 * PackageIndex - Index of object within parent package (if
422 * applicable - ACPI_NOT_PACKAGE_ELEMENT
425 * RETURN: Pointer to entry in repair table. NULL indicates not found.
427 * DESCRIPTION: Check an object name against the repairable object list.
429 *****************************************************************************/
431 static const ACPI_SIMPLE_REPAIR_INFO
*
432 AcpiNsMatchSimpleRepair (
433 ACPI_NAMESPACE_NODE
*Node
,
437 const ACPI_SIMPLE_REPAIR_INFO
*ThisName
;
440 /* Search info table for a repairable predefined method/object name */
442 ThisName
= AcpiObjectRepairInfo
;
443 while (ThisName
->ObjectConverter
)
445 if (ACPI_COMPARE_NAME (Node
->Name
.Ascii
, ThisName
->Name
))
447 /* Check if we can actually repair this name/type combination */
449 if ((ReturnBtype
& ThisName
->UnexpectedBtypes
) &&
450 (PackageIndex
== ThisName
->PackageIndex
))
460 return (NULL
); /* Name was not found in the repair table */
464 /*******************************************************************************
466 * FUNCTION: AcpiNsRepairNullElement
468 * PARAMETERS: Info - Method execution information block
469 * ExpectedBtypes - Object types expected
470 * PackageIndex - Index of object within parent package (if
471 * applicable - ACPI_NOT_PACKAGE_ELEMENT
473 * ReturnObjectPtr - Pointer to the object returned from the
474 * evaluation of a method or object
476 * RETURN: Status. AE_OK if repair was successful.
478 * DESCRIPTION: Attempt to repair a NULL element of a returned Package object.
480 ******************************************************************************/
483 AcpiNsRepairNullElement (
484 ACPI_EVALUATE_INFO
*Info
,
485 UINT32 ExpectedBtypes
,
487 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
489 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
490 ACPI_OPERAND_OBJECT
*NewObject
;
493 ACPI_FUNCTION_NAME (NsRepairNullElement
);
496 /* No repair needed if return object is non-NULL */
504 * Attempt to repair a NULL element of a Package object. This applies to
505 * predefined names that return a fixed-length package and each element
506 * is required. It does not apply to variable-length packages where NULL
507 * elements are allowed, especially at the end of the package.
509 if (ExpectedBtypes
& ACPI_RTYPE_INTEGER
)
511 /* Need an Integer - create a zero-value integer */
513 NewObject
= AcpiUtCreateIntegerObject ((UINT64
) 0);
515 else if (ExpectedBtypes
& ACPI_RTYPE_STRING
)
517 /* Need a String - create a NULL string */
519 NewObject
= AcpiUtCreateStringObject (0);
521 else if (ExpectedBtypes
& ACPI_RTYPE_BUFFER
)
523 /* Need a Buffer - create a zero-length buffer */
525 NewObject
= AcpiUtCreateBufferObject (0);
529 /* Error for all other expected types */
531 return (AE_AML_OPERAND_TYPE
);
536 return (AE_NO_MEMORY
);
539 /* Set the reference count according to the parent Package object */
541 NewObject
->Common
.ReferenceCount
= Info
->ParentPackage
->Common
.ReferenceCount
;
543 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
544 "%s: Converted NULL package element to expected %s at index %u\n",
545 Info
->FullPathname
, AcpiUtGetObjectTypeName (NewObject
), PackageIndex
));
547 *ReturnObjectPtr
= NewObject
;
548 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
;
553 /******************************************************************************
555 * FUNCTION: AcpiNsRemoveNullElements
557 * PARAMETERS: Info - Method execution information block
558 * PackageType - An AcpiReturnPackageTypes value
559 * ObjDesc - A Package object
563 * DESCRIPTION: Remove all NULL package elements from packages that contain
564 * a variable number of subpackages. For these types of
565 * packages, NULL elements can be safely removed.
567 *****************************************************************************/
570 AcpiNsRemoveNullElements (
571 ACPI_EVALUATE_INFO
*Info
,
573 ACPI_OPERAND_OBJECT
*ObjDesc
)
575 ACPI_OPERAND_OBJECT
**Source
;
576 ACPI_OPERAND_OBJECT
**Dest
;
582 ACPI_FUNCTION_NAME (NsRemoveNullElements
);
586 * We can safely remove all NULL elements from these package types:
587 * PTYPE1_VAR packages contain a variable number of simple data types.
588 * PTYPE2 packages contain a variable number of subpackages.
592 case ACPI_PTYPE1_VAR
:
594 case ACPI_PTYPE2_COUNT
:
595 case ACPI_PTYPE2_PKG_COUNT
:
596 case ACPI_PTYPE2_FIXED
:
597 case ACPI_PTYPE2_MIN
:
598 case ACPI_PTYPE2_REV_FIXED
:
599 case ACPI_PTYPE2_FIX_VAR
:
604 case ACPI_PTYPE1_FIXED
:
605 case ACPI_PTYPE1_OPTION
:
609 Count
= ObjDesc
->Package
.Count
;
612 Source
= ObjDesc
->Package
.Elements
;
615 /* Examine all elements of the package object, remove nulls */
617 for (i
= 0; i
< Count
; i
++)
631 /* Update parent package if any null elements were removed */
633 if (NewCount
< Count
)
635 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
636 "%s: Found and removed %u NULL elements\n",
637 Info
->FullPathname
, (Count
- NewCount
)));
639 /* NULL terminate list and update the package count */
642 ObjDesc
->Package
.Count
= NewCount
;
647 /*******************************************************************************
649 * FUNCTION: AcpiNsWrapWithPackage
651 * PARAMETERS: Info - Method execution information block
652 * OriginalObject - Pointer to the object to repair.
653 * ObjDescPtr - The new package object is returned here
655 * RETURN: Status, new object in *ObjDescPtr
657 * DESCRIPTION: Repair a common problem with objects that are defined to
658 * return a variable-length Package of sub-objects. If there is
659 * only one sub-object, some BIOS code mistakenly simply declares
660 * the single object instead of a Package with one sub-object.
661 * This function attempts to repair this error by wrapping a
662 * Package object around the original object, creating the
663 * correct and expected Package with one sub-object.
665 * Names that can be repaired in this manner include:
666 * _ALR, _CSD, _HPX, _MLS, _PLD, _PRT, _PSS, _TRT, _TSS,
667 * _BCL, _DOD, _FIX, _Sx
669 ******************************************************************************/
672 AcpiNsWrapWithPackage (
673 ACPI_EVALUATE_INFO
*Info
,
674 ACPI_OPERAND_OBJECT
*OriginalObject
,
675 ACPI_OPERAND_OBJECT
**ObjDescPtr
)
677 ACPI_OPERAND_OBJECT
*PkgObjDesc
;
680 ACPI_FUNCTION_NAME (NsWrapWithPackage
);
684 * Create the new outer package and populate it. The new package will
685 * have a single element, the lone sub-object.
687 PkgObjDesc
= AcpiUtCreatePackageObject (1);
690 return (AE_NO_MEMORY
);
693 PkgObjDesc
->Package
.Elements
[0] = OriginalObject
;
695 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
696 "%s: Wrapped %s with expected Package object\n",
697 Info
->FullPathname
, AcpiUtGetObjectTypeName (OriginalObject
)));
699 /* Return the new object in the object pointer */
701 *ObjDescPtr
= PkgObjDesc
;
702 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
| ACPI_OBJECT_WRAPPED
;