No empty .Rs/.Re
[netbsd-mini2440.git] / sys / external / intel-public / acpica / dist / namespace / nsrepair.c
blobae534264ab0c46bf216ab22cbf158d14b3d55a54
1 /******************************************************************************
3 * Module Name: nsrepair - Repair for objects returned by predefined methods
5 *****************************************************************************/
7 /******************************************************************************
9 * 1. Copyright Notice
11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12 * All rights reserved.
14 * 2. License
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.
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
38 * conditions are met:
40 * 3. Conditions
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
64 * make.
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.
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
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
88 * PARTICULAR PURPOSE.
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.
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__
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acnamesp.h"
121 #include "acpredef.h"
123 #define _COMPONENT ACPI_NAMESPACE
124 ACPI_MODULE_NAME ("nsrepair")
127 /*******************************************************************************
129 * FUNCTION: AcpiNsRepairObject
131 * PARAMETERS: Data - Pointer to validation data structure
132 * ExpectedBtypes - Object types expected
133 * PackageIndex - Index of object within parent package (if
134 * applicable - ACPI_NOT_PACKAGE_ELEMENT
135 * otherwise)
136 * ReturnObjectPtr - Pointer to the object returned from the
137 * evaluation of a method or object
139 * RETURN: Status. AE_OK if repair was successful.
141 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
142 * not expected.
144 ******************************************************************************/
146 ACPI_STATUS
147 AcpiNsRepairObject (
148 ACPI_PREDEFINED_DATA *Data,
149 UINT32 ExpectedBtypes,
150 UINT32 PackageIndex,
151 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
153 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
154 ACPI_OPERAND_OBJECT *NewObject;
155 ACPI_SIZE Length;
158 switch (ReturnObject->Common.Type)
160 case ACPI_TYPE_BUFFER:
162 /* Does the method/object legally return a string? */
164 if (!(ExpectedBtypes & ACPI_RTYPE_STRING))
166 return (AE_AML_OPERAND_TYPE);
170 * Have a Buffer, expected a String, convert. Use a ToString
171 * conversion, no transform performed on the buffer data. The best
172 * example of this is the _BIF method, where the string data from
173 * the battery is often (incorrectly) returned as buffer object(s).
175 Length = 0;
176 while ((Length < ReturnObject->Buffer.Length) &&
177 (ReturnObject->Buffer.Pointer[Length]))
179 Length++;
182 /* Allocate a new string object */
184 NewObject = AcpiUtCreateStringObject (Length);
185 if (!NewObject)
187 return (AE_NO_MEMORY);
191 * Copy the raw buffer data with no transform. String is already NULL
192 * terminated at Length+1.
194 ACPI_MEMCPY (NewObject->String.Pointer,
195 ReturnObject->Buffer.Pointer, Length);
198 * If the original object is a package element, we need to:
199 * 1. Set the reference count of the new object to match the
200 * reference count of the old object.
201 * 2. Decrement the reference count of the original object.
203 if (PackageIndex != ACPI_NOT_PACKAGE_ELEMENT)
205 NewObject->Common.ReferenceCount =
206 ReturnObject->Common.ReferenceCount;
208 if (ReturnObject->Common.ReferenceCount > 1)
210 ReturnObject->Common.ReferenceCount--;
213 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
214 "Converted Buffer to expected String at index %u",
215 PackageIndex));
217 else
219 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
220 "Converted Buffer to expected String"));
223 /* Delete old object, install the new return object */
225 AcpiUtRemoveReference (ReturnObject);
226 *ReturnObjectPtr = NewObject;
227 Data->Flags |= ACPI_OBJECT_REPAIRED;
228 return (AE_OK);
230 default:
231 break;
234 return (AE_AML_OPERAND_TYPE);
238 /*******************************************************************************
240 * FUNCTION: AcpiNsRepairPackageList
242 * PARAMETERS: Data - Pointer to validation data structure
243 * ObjDescPtr - Pointer to the object to repair. The new
244 * package object is returned here,
245 * overwriting the old object.
247 * RETURN: Status, new object in *ObjDescPtr
249 * DESCRIPTION: Repair a common problem with objects that are defined to return
250 * a variable-length Package of Packages. If the variable-length
251 * is one, some BIOS code mistakenly simply declares a single
252 * Package instead of a Package with one sub-Package. This
253 * function attempts to repair this error by wrapping a Package
254 * object around the original Package, creating the correct
255 * Package with one sub-Package.
257 * Names that can be repaired in this manner include:
258 * _ALR, _CSD, _HPX, _MLS, _PRT, _PSS, _TRT, TSS
260 ******************************************************************************/
262 ACPI_STATUS
263 AcpiNsRepairPackageList (
264 ACPI_PREDEFINED_DATA *Data,
265 ACPI_OPERAND_OBJECT **ObjDescPtr)
267 ACPI_OPERAND_OBJECT *PkgObjDesc;
271 * Create the new outer package and populate it. The new package will
272 * have a single element, the lone subpackage.
274 PkgObjDesc = AcpiUtCreatePackageObject (1);
275 if (!PkgObjDesc)
277 return (AE_NO_MEMORY);
280 PkgObjDesc->Package.Elements[0] = *ObjDescPtr;
282 /* Return the new object in the object pointer */
284 *ObjDescPtr = PkgObjDesc;
285 Data->Flags |= ACPI_OBJECT_REPAIRED;
287 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
288 "Incorrectly formed Package, attempting repair"));
290 return (AE_OK);