1 /*******************************************************************************
3 * Module Name: utmisc - common utility procedures
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2017, 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.
49 #define _COMPONENT ACPI_UTILITIES
50 ACPI_MODULE_NAME ("utmisc")
53 /*******************************************************************************
55 * FUNCTION: AcpiUtIsPciRootBridge
57 * PARAMETERS: Id - The HID/CID in string format
59 * RETURN: TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
61 * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
63 ******************************************************************************/
66 AcpiUtIsPciRootBridge (
71 * Check if this is a PCI root bridge.
72 * ACPI 3.0+: check for a PCI Express root also.
75 PCI_ROOT_HID_STRING
)) ||
78 PCI_EXPRESS_ROOT_HID_STRING
)))
87 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
88 /*******************************************************************************
90 * FUNCTION: AcpiUtIsAmlTable
92 * PARAMETERS: Table - An ACPI table
94 * RETURN: TRUE if table contains executable AML; FALSE otherwise
96 * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
97 * Currently, these are DSDT,SSDT,PSDT. All other table types are
98 * data tables that do not contain AML code.
100 ******************************************************************************/
104 ACPI_TABLE_HEADER
*Table
)
107 /* These are the only tables that contain executable AML */
109 if (ACPI_COMPARE_NAME (Table
->Signature
, ACPI_SIG_DSDT
) ||
110 ACPI_COMPARE_NAME (Table
->Signature
, ACPI_SIG_PSDT
) ||
111 ACPI_COMPARE_NAME (Table
->Signature
, ACPI_SIG_SSDT
) ||
112 ACPI_COMPARE_NAME (Table
->Signature
, ACPI_SIG_OSDT
))
122 /*******************************************************************************
124 * FUNCTION: AcpiUtDwordByteSwap
126 * PARAMETERS: Value - Value to be converted
128 * RETURN: UINT32 integer with bytes swapped
130 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
132 ******************************************************************************/
135 AcpiUtDwordByteSwap (
150 ACPI_FUNCTION_ENTRY ();
155 Out
.Bytes
[0] = In
.Bytes
[3];
156 Out
.Bytes
[1] = In
.Bytes
[2];
157 Out
.Bytes
[2] = In
.Bytes
[1];
158 Out
.Bytes
[3] = In
.Bytes
[0];
164 /*******************************************************************************
166 * FUNCTION: AcpiUtSetIntegerWidth
168 * PARAMETERS: Revision From DSDT header
172 * DESCRIPTION: Set the global integer bit width based upon the revision
173 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
174 * For Revision 2 and above, Integers are 64 bits. Yes, this
175 * makes a difference.
177 ******************************************************************************/
180 AcpiUtSetIntegerWidth (
188 AcpiGbl_IntegerBitWidth
= 32;
189 AcpiGbl_IntegerNybbleWidth
= 8;
190 AcpiGbl_IntegerByteWidth
= 4;
194 /* 64-bit case (ACPI 2.0+) */
196 AcpiGbl_IntegerBitWidth
= 64;
197 AcpiGbl_IntegerNybbleWidth
= 16;
198 AcpiGbl_IntegerByteWidth
= 8;
203 /*******************************************************************************
205 * FUNCTION: AcpiUtCreateUpdateStateAndPush
207 * PARAMETERS: Object - Object to be added to the new state
208 * Action - Increment/Decrement
209 * StateList - List the state will be added to
213 * DESCRIPTION: Create a new state and push it
215 ******************************************************************************/
218 AcpiUtCreateUpdateStateAndPush (
219 ACPI_OPERAND_OBJECT
*Object
,
221 ACPI_GENERIC_STATE
**StateList
)
223 ACPI_GENERIC_STATE
*State
;
226 ACPI_FUNCTION_ENTRY ();
229 /* Ignore null objects; these are expected */
236 State
= AcpiUtCreateUpdateState (Object
, Action
);
239 return (AE_NO_MEMORY
);
242 AcpiUtPushGenericState (StateList
, State
);
247 /*******************************************************************************
249 * FUNCTION: AcpiUtWalkPackageTree
251 * PARAMETERS: SourceObject - The package to walk
252 * TargetObject - Target object (if package is being copied)
253 * WalkCallback - Called once for each package element
254 * Context - Passed to the callback function
258 * DESCRIPTION: Walk through a package, including subpackages
260 ******************************************************************************/
263 AcpiUtWalkPackageTree (
264 ACPI_OPERAND_OBJECT
*SourceObject
,
266 ACPI_PKG_CALLBACK WalkCallback
,
269 ACPI_STATUS Status
= AE_OK
;
270 ACPI_GENERIC_STATE
*StateList
= NULL
;
271 ACPI_GENERIC_STATE
*State
;
272 ACPI_OPERAND_OBJECT
*ThisSourceObj
;
276 ACPI_FUNCTION_TRACE (UtWalkPackageTree
);
279 State
= AcpiUtCreatePkgState (SourceObject
, TargetObject
, 0);
282 return_ACPI_STATUS (AE_NO_MEMORY
);
287 /* Get one element of the package */
289 ThisIndex
= State
->Pkg
.Index
;
291 State
->Pkg
.SourceObject
->Package
.Elements
[ThisIndex
];
292 State
->Pkg
.ThisTargetObj
=
293 &State
->Pkg
.SourceObject
->Package
.Elements
[ThisIndex
];
297 * 1) An uninitialized package element. It is completely
298 * legal to declare a package and leave it uninitialized
299 * 2) Not an internal object - can be a namespace node instead
300 * 3) Any type other than a package. Packages are handled in else
303 if ((!ThisSourceObj
) ||
304 (ACPI_GET_DESCRIPTOR_TYPE (ThisSourceObj
) !=
305 ACPI_DESC_TYPE_OPERAND
) ||
306 (ThisSourceObj
->Common
.Type
!= ACPI_TYPE_PACKAGE
))
308 Status
= WalkCallback (ACPI_COPY_TYPE_SIMPLE
, ThisSourceObj
,
310 if (ACPI_FAILURE (Status
))
312 return_ACPI_STATUS (Status
);
316 while (State
->Pkg
.Index
>=
317 State
->Pkg
.SourceObject
->Package
.Count
)
320 * We've handled all of the objects at this level, This means
321 * that we have just completed a package. That package may
322 * have contained one or more packages itself.
324 * Delete this state and pop the previous state (package).
326 AcpiUtDeleteGenericState (State
);
327 State
= AcpiUtPopGenericState (&StateList
);
329 /* Finished when there are no more states */
334 * We have handled all of the objects in the top level
335 * package just add the length of the package objects
338 return_ACPI_STATUS (AE_OK
);
342 * Go back up a level and move the index past the just
343 * completed package object.
350 /* This is a subobject of type package */
352 Status
= WalkCallback (
353 ACPI_COPY_TYPE_PACKAGE
, ThisSourceObj
, State
, Context
);
354 if (ACPI_FAILURE (Status
))
356 return_ACPI_STATUS (Status
);
360 * Push the current state and create a new one
361 * The callback above returned a new target package object.
363 AcpiUtPushGenericState (&StateList
, State
);
364 State
= AcpiUtCreatePkgState (
365 ThisSourceObj
, State
->Pkg
.ThisTargetObj
, 0);
368 /* Free any stacked Update State objects */
372 State
= AcpiUtPopGenericState (&StateList
);
373 AcpiUtDeleteGenericState (State
);
375 return_ACPI_STATUS (AE_NO_MEMORY
);
380 /* We should never get here */
382 ACPI_ERROR ((AE_INFO
,
383 "State list did not terminate correctly"));
385 return_ACPI_STATUS (AE_AML_INTERNAL
);
389 #ifdef ACPI_DEBUG_OUTPUT
390 /*******************************************************************************
392 * FUNCTION: AcpiUtDisplayInitPathname
394 * PARAMETERS: Type - Object type of the node
395 * ObjHandle - Handle whose pathname will be displayed
396 * Path - Additional path string to be appended.
397 * (NULL if no extra path)
399 * RETURN: ACPI_STATUS
401 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
403 ******************************************************************************/
406 AcpiUtDisplayInitPathname (
408 ACPI_NAMESPACE_NODE
*ObjHandle
,
415 ACPI_FUNCTION_ENTRY ();
418 /* Only print the path if the appropriate debug level is enabled */
420 if (!(AcpiDbgLevel
& ACPI_LV_INIT_NAMES
))
425 /* Get the full pathname to the node */
427 Buffer
.Length
= ACPI_ALLOCATE_LOCAL_BUFFER
;
428 Status
= AcpiNsHandleToPathname (ObjHandle
, &Buffer
, TRUE
);
429 if (ACPI_FAILURE (Status
))
434 /* Print what we're doing */
438 case ACPI_TYPE_METHOD
:
440 AcpiOsPrintf ("Executing ");
445 AcpiOsPrintf ("Initializing ");
449 /* Print the object type and pathname */
451 AcpiOsPrintf ("%-12s %s",
452 AcpiUtGetTypeName (Type
), (char *) Buffer
.Pointer
);
454 /* Extra path is used to append names like _STA, _INI, etc. */
458 AcpiOsPrintf (".%s", Path
);
462 ACPI_FREE (Buffer
.Pointer
);