1 /******************************************************************************
3 * Module Name: nsrepair - Repair for objects returned by predefined methods
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2019, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
51 #define _COMPONENT ACPI_NAMESPACE
52 ACPI_MODULE_NAME ("nsrepair")
55 /*******************************************************************************
57 * This module attempts to repair or convert objects returned by the
58 * predefined methods to an object type that is expected, as per the ACPI
59 * specification. The need for this code is dictated by the many machines that
60 * return incorrect types for the standard predefined methods. Performing these
61 * conversions here, in one place, eliminates the need for individual ACPI
62 * device drivers to do the same. Note: Most of these conversions are different
63 * than the internal object conversion routines used for implicit object
66 * The following conversions can be performed as necessary:
74 * Buffer -> Package of Integers
75 * Package -> Package of one Package
77 * Additional conversions that are available:
78 * Convert a null return or zero return value to an EndTag descriptor
79 * Convert an ASCII string to a Unicode buffer
81 * An incorrect standalone object is wrapped with required outer package
83 * Additional possible repairs:
84 * Required package elements that are NULL replaced by Integer/String/Buffer
86 ******************************************************************************/
89 /* Local prototypes */
91 static const ACPI_SIMPLE_REPAIR_INFO
*
92 AcpiNsMatchSimpleRepair (
93 ACPI_NAMESPACE_NODE
*Node
,
99 * Special but simple repairs for some names.
101 * 2nd argument: Unexpected types that can be repaired
103 static const ACPI_SIMPLE_REPAIR_INFO AcpiObjectRepairInfo
[] =
105 /* Resource descriptor conversions */
107 { "_CRS", ACPI_RTYPE_INTEGER
| ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
| ACPI_RTYPE_NONE
,
108 ACPI_NOT_PACKAGE_ELEMENT
,
109 AcpiNsConvertToResource
},
110 { "_DMA", ACPI_RTYPE_INTEGER
| ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
| ACPI_RTYPE_NONE
,
111 ACPI_NOT_PACKAGE_ELEMENT
,
112 AcpiNsConvertToResource
},
113 { "_PRS", ACPI_RTYPE_INTEGER
| ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
| ACPI_RTYPE_NONE
,
114 ACPI_NOT_PACKAGE_ELEMENT
,
115 AcpiNsConvertToResource
},
117 /* Object reference conversions */
119 { "_DEP", ACPI_RTYPE_STRING
, ACPI_ALL_PACKAGE_ELEMENTS
,
120 AcpiNsConvertToReference
},
122 /* Unicode conversions */
124 { "_MLS", ACPI_RTYPE_STRING
, 1,
125 AcpiNsConvertToUnicode
},
126 { "_STR", ACPI_RTYPE_STRING
| ACPI_RTYPE_BUFFER
,
127 ACPI_NOT_PACKAGE_ELEMENT
,
128 AcpiNsConvertToUnicode
},
129 { {0,0,0,0}, 0, 0, NULL
} /* Table terminator */
133 /*******************************************************************************
135 * FUNCTION: AcpiNsSimpleRepair
137 * PARAMETERS: Info - Method execution information block
138 * ExpectedBtypes - Object types expected
139 * PackageIndex - Index of object within parent package (if
140 * applicable - ACPI_NOT_PACKAGE_ELEMENT
142 * ReturnObjectPtr - Pointer to the object returned from the
143 * evaluation of a method or object
145 * RETURN: Status. AE_OK if repair was successful.
147 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
150 ******************************************************************************/
154 ACPI_EVALUATE_INFO
*Info
,
155 UINT32 ExpectedBtypes
,
157 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
159 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
160 ACPI_OPERAND_OBJECT
*NewObject
= NULL
;
162 const ACPI_SIMPLE_REPAIR_INFO
*Predefined
;
165 ACPI_FUNCTION_NAME (NsSimpleRepair
);
169 * Special repairs for certain names that are in the repair table.
170 * Check if this name is in the list of repairable names.
172 Predefined
= AcpiNsMatchSimpleRepair (Info
->Node
,
173 Info
->ReturnBtype
, PackageIndex
);
178 ACPI_WARN_PREDEFINED ((AE_INFO
, Info
->FullPathname
,
179 ACPI_WARN_ALWAYS
, "Missing expected return value"));
182 Status
= Predefined
->ObjectConverter (Info
->Node
, ReturnObject
,
184 if (ACPI_FAILURE (Status
))
186 /* A fatal error occurred during a conversion */
188 ACPI_EXCEPTION ((AE_INFO
, Status
,
189 "During return object analysis"));
199 * Do not perform simple object repair unless the return type is not
202 if (Info
->ReturnBtype
& ExpectedBtypes
)
208 * At this point, we know that the type of the returned object was not
209 * one of the expected types for this predefined name. Attempt to
210 * repair the object by converting it to one of the expected object
211 * types for this predefined name.
215 * If there is no return value, check if we require a return value for
216 * this predefined name. Either one return value is expected, or none,
217 * for both methods and other objects.
219 * Try to fix if there was no return object. Warning if failed to fix.
223 if (ExpectedBtypes
&& (!(ExpectedBtypes
& ACPI_RTYPE_NONE
)))
225 if (PackageIndex
!= ACPI_NOT_PACKAGE_ELEMENT
)
227 ACPI_WARN_PREDEFINED ((AE_INFO
, Info
->FullPathname
,
228 ACPI_WARN_ALWAYS
, "Found unexpected NULL package element"));
230 Status
= AcpiNsRepairNullElement (Info
, ExpectedBtypes
,
231 PackageIndex
, ReturnObjectPtr
);
232 if (ACPI_SUCCESS (Status
))
234 return (AE_OK
); /* Repair was successful */
239 ACPI_WARN_PREDEFINED ((AE_INFO
, Info
->FullPathname
,
240 ACPI_WARN_ALWAYS
, "Missing expected return value"));
243 return (AE_AML_NO_RETURN_VALUE
);
247 if (ExpectedBtypes
& ACPI_RTYPE_INTEGER
)
249 Status
= AcpiNsConvertToInteger (ReturnObject
, &NewObject
);
250 if (ACPI_SUCCESS (Status
))
255 if (ExpectedBtypes
& ACPI_RTYPE_STRING
)
257 Status
= AcpiNsConvertToString (ReturnObject
, &NewObject
);
258 if (ACPI_SUCCESS (Status
))
263 if (ExpectedBtypes
& ACPI_RTYPE_BUFFER
)
265 Status
= AcpiNsConvertToBuffer (ReturnObject
, &NewObject
);
266 if (ACPI_SUCCESS (Status
))
271 if (ExpectedBtypes
& ACPI_RTYPE_PACKAGE
)
274 * A package is expected. We will wrap the existing object with a
275 * new package object. It is often the case that if a variable-length
276 * package is required, but there is only a single object needed, the
277 * BIOS will return that object instead of wrapping it with a Package
278 * object. Note: after the wrapping, the package will be validated
279 * for correct contents (expected object type or types).
281 Status
= AcpiNsWrapWithPackage (Info
, ReturnObject
, &NewObject
);
282 if (ACPI_SUCCESS (Status
))
285 * The original object just had its reference count
286 * incremented for being inserted into the new package.
288 *ReturnObjectPtr
= NewObject
; /* New Package object */
289 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
;
294 /* We cannot repair this object */
296 return (AE_AML_OPERAND_TYPE
);
301 /* Object was successfully repaired */
303 if (PackageIndex
!= ACPI_NOT_PACKAGE_ELEMENT
)
305 /* Update reference count of new object */
307 if (!(Info
->ReturnFlags
& ACPI_OBJECT_WRAPPED
))
309 NewObject
->Common
.ReferenceCount
=
310 ReturnObject
->Common
.ReferenceCount
;
313 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
314 "%s: Converted %s to expected %s at Package index %u\n",
315 Info
->FullPathname
, AcpiUtGetObjectTypeName (ReturnObject
),
316 AcpiUtGetObjectTypeName (NewObject
), PackageIndex
));
320 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
321 "%s: Converted %s to expected %s\n",
322 Info
->FullPathname
, AcpiUtGetObjectTypeName (ReturnObject
),
323 AcpiUtGetObjectTypeName (NewObject
)));
326 /* Delete old object, install the new return object */
328 AcpiUtRemoveReference (ReturnObject
);
329 *ReturnObjectPtr
= NewObject
;
330 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
;
335 /******************************************************************************
337 * FUNCTION: AcpiNsMatchSimpleRepair
339 * PARAMETERS: Node - Namespace node for the method/object
340 * ReturnBtype - Object type that was returned
341 * PackageIndex - Index of object within parent package (if
342 * applicable - ACPI_NOT_PACKAGE_ELEMENT
345 * RETURN: Pointer to entry in repair table. NULL indicates not found.
347 * DESCRIPTION: Check an object name against the repairable object list.
349 *****************************************************************************/
351 static const ACPI_SIMPLE_REPAIR_INFO
*
352 AcpiNsMatchSimpleRepair (
353 ACPI_NAMESPACE_NODE
*Node
,
357 const ACPI_SIMPLE_REPAIR_INFO
*ThisName
;
360 /* Search info table for a repairable predefined method/object name */
362 ThisName
= AcpiObjectRepairInfo
;
363 while (ThisName
->ObjectConverter
)
365 if (ACPI_COMPARE_NAME (Node
->Name
.Ascii
, ThisName
->Name
))
367 /* Check if we can actually repair this name/type combination */
369 if ((ReturnBtype
& ThisName
->UnexpectedBtypes
) &&
370 (ThisName
->PackageIndex
== ACPI_ALL_PACKAGE_ELEMENTS
||
371 PackageIndex
== ThisName
->PackageIndex
))
382 return (NULL
); /* Name was not found in the repair table */
386 /*******************************************************************************
388 * FUNCTION: AcpiNsRepairNullElement
390 * PARAMETERS: Info - Method execution information block
391 * ExpectedBtypes - Object types expected
392 * PackageIndex - Index of object within parent package (if
393 * applicable - ACPI_NOT_PACKAGE_ELEMENT
395 * ReturnObjectPtr - Pointer to the object returned from the
396 * evaluation of a method or object
398 * RETURN: Status. AE_OK if repair was successful.
400 * DESCRIPTION: Attempt to repair a NULL element of a returned Package object.
402 ******************************************************************************/
405 AcpiNsRepairNullElement (
406 ACPI_EVALUATE_INFO
*Info
,
407 UINT32 ExpectedBtypes
,
409 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
411 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
412 ACPI_OPERAND_OBJECT
*NewObject
;
415 ACPI_FUNCTION_NAME (NsRepairNullElement
);
418 /* No repair needed if return object is non-NULL */
426 * Attempt to repair a NULL element of a Package object. This applies to
427 * predefined names that return a fixed-length package and each element
428 * is required. It does not apply to variable-length packages where NULL
429 * elements are allowed, especially at the end of the package.
431 if (ExpectedBtypes
& ACPI_RTYPE_INTEGER
)
433 /* Need an Integer - create a zero-value integer */
435 NewObject
= AcpiUtCreateIntegerObject ((UINT64
) 0);
437 else if (ExpectedBtypes
& ACPI_RTYPE_STRING
)
439 /* Need a String - create a NULL string */
441 NewObject
= AcpiUtCreateStringObject (0);
443 else if (ExpectedBtypes
& ACPI_RTYPE_BUFFER
)
445 /* Need a Buffer - create a zero-length buffer */
447 NewObject
= AcpiUtCreateBufferObject (0);
451 /* Error for all other expected types */
453 return (AE_AML_OPERAND_TYPE
);
458 return (AE_NO_MEMORY
);
461 /* Set the reference count according to the parent Package object */
463 NewObject
->Common
.ReferenceCount
=
464 Info
->ParentPackage
->Common
.ReferenceCount
;
466 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
467 "%s: Converted NULL package element to expected %s at index %u\n",
468 Info
->FullPathname
, AcpiUtGetObjectTypeName (NewObject
),
471 *ReturnObjectPtr
= NewObject
;
472 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
;
477 /******************************************************************************
479 * FUNCTION: AcpiNsRemoveNullElements
481 * PARAMETERS: Info - Method execution information block
482 * PackageType - An AcpiReturnPackageTypes value
483 * ObjDesc - A Package object
487 * DESCRIPTION: Remove all NULL package elements from packages that contain
488 * a variable number of subpackages. For these types of
489 * packages, NULL elements can be safely removed.
491 *****************************************************************************/
494 AcpiNsRemoveNullElements (
495 ACPI_EVALUATE_INFO
*Info
,
497 ACPI_OPERAND_OBJECT
*ObjDesc
)
499 ACPI_OPERAND_OBJECT
**Source
;
500 ACPI_OPERAND_OBJECT
**Dest
;
506 ACPI_FUNCTION_NAME (NsRemoveNullElements
);
510 * We can safely remove all NULL elements from these package types:
511 * PTYPE1_VAR packages contain a variable number of simple data types.
512 * PTYPE2 packages contain a variable number of subpackages.
516 case ACPI_PTYPE1_VAR
:
518 case ACPI_PTYPE2_COUNT
:
519 case ACPI_PTYPE2_PKG_COUNT
:
520 case ACPI_PTYPE2_FIXED
:
521 case ACPI_PTYPE2_MIN
:
522 case ACPI_PTYPE2_REV_FIXED
:
523 case ACPI_PTYPE2_FIX_VAR
:
527 case ACPI_PTYPE2_VAR_VAR
:
528 case ACPI_PTYPE1_FIXED
:
529 case ACPI_PTYPE1_OPTION
:
533 Count
= ObjDesc
->Package
.Count
;
536 Source
= ObjDesc
->Package
.Elements
;
539 /* Examine all elements of the package object, remove nulls */
541 for (i
= 0; i
< Count
; i
++)
556 /* Update parent package if any null elements were removed */
558 if (NewCount
< Count
)
560 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
561 "%s: Found and removed %u NULL elements\n",
562 Info
->FullPathname
, (Count
- NewCount
)));
564 /* NULL terminate list and update the package count */
567 ObjDesc
->Package
.Count
= NewCount
;
572 /*******************************************************************************
574 * FUNCTION: AcpiNsWrapWithPackage
576 * PARAMETERS: Info - Method execution information block
577 * OriginalObject - Pointer to the object to repair.
578 * ObjDescPtr - The new package object is returned here
580 * RETURN: Status, new object in *ObjDescPtr
582 * DESCRIPTION: Repair a common problem with objects that are defined to
583 * return a variable-length Package of sub-objects. If there is
584 * only one sub-object, some BIOS code mistakenly simply declares
585 * the single object instead of a Package with one sub-object.
586 * This function attempts to repair this error by wrapping a
587 * Package object around the original object, creating the
588 * correct and expected Package with one sub-object.
590 * Names that can be repaired in this manner include:
591 * _ALR, _CSD, _HPX, _MLS, _PLD, _PRT, _PSS, _TRT, _TSS,
592 * _BCL, _DOD, _FIX, _Sx
594 ******************************************************************************/
597 AcpiNsWrapWithPackage (
598 ACPI_EVALUATE_INFO
*Info
,
599 ACPI_OPERAND_OBJECT
*OriginalObject
,
600 ACPI_OPERAND_OBJECT
**ObjDescPtr
)
602 ACPI_OPERAND_OBJECT
*PkgObjDesc
;
605 ACPI_FUNCTION_NAME (NsWrapWithPackage
);
609 * Create the new outer package and populate it. The new
610 * package will have a single element, the lone sub-object.
612 PkgObjDesc
= AcpiUtCreatePackageObject (1);
615 return (AE_NO_MEMORY
);
618 PkgObjDesc
->Package
.Elements
[0] = OriginalObject
;
620 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
621 "%s: Wrapped %s with expected Package object\n",
622 Info
->FullPathname
, AcpiUtGetObjectTypeName (OriginalObject
)));
624 /* Return the new object in the object pointer */
626 *ObjDescPtr
= PkgObjDesc
;
627 Info
->ReturnFlags
|= ACPI_OBJECT_REPAIRED
| ACPI_OBJECT_WRAPPED
;