1 /*******************************************************************************
3 * Module Name: utmisc - common utility procedures
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2015, 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.
74 if (!(ACPI_STRCMP (Id,
75 PCI_ROOT_HID_STRING)) ||
78 PCI_EXPRESS_ROOT_HID_STRING)))
87 /*******************************************************************************
89 * FUNCTION: AcpiUtIsAmlTable
91 * PARAMETERS: Table - An ACPI table
93 * RETURN: TRUE if table contains executable AML; FALSE otherwise
95 * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
96 * Currently, these are DSDT,SSDT,PSDT. All other table types are
97 * data tables that do not contain AML code.
99 ******************************************************************************/
103 ACPI_TABLE_HEADER *Table)
106 /* These are the only tables that contain executable AML */
108 if (ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_DSDT) ||
109 ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_PSDT) ||
110 ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_SSDT))
119 /*******************************************************************************
121 * FUNCTION: AcpiUtDwordByteSwap
123 * PARAMETERS: Value - Value to be converted
125 * RETURN: UINT32 integer with bytes swapped
127 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
129 ******************************************************************************/
132 AcpiUtDwordByteSwap (
147 ACPI_FUNCTION_ENTRY ();
152 Out.Bytes[0] = In.Bytes[3];
153 Out.Bytes[1] = In.Bytes[2];
154 Out.Bytes[2] = In.Bytes[1];
155 Out.Bytes[3] = In.Bytes[0];
161 /*******************************************************************************
163 * FUNCTION: AcpiUtSetIntegerWidth
165 * PARAMETERS: Revision From DSDT header
169 * DESCRIPTION: Set the global integer bit width based upon the revision
170 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
171 * For Revision 2 and above, Integers are 64 bits. Yes, this
172 * makes a difference.
174 ******************************************************************************/
177 AcpiUtSetIntegerWidth (
185 AcpiGbl_IntegerBitWidth = 32;
186 AcpiGbl_IntegerNybbleWidth = 8;
187 AcpiGbl_IntegerByteWidth = 4;
191 /* 64-bit case (ACPI 2.0+) */
193 AcpiGbl_IntegerBitWidth = 64;
194 AcpiGbl_IntegerNybbleWidth = 16;
195 AcpiGbl_IntegerByteWidth = 8;
200 /*******************************************************************************
202 * FUNCTION: AcpiUtCreateUpdateStateAndPush
204 * PARAMETERS: Object - Object to be added to the new state
205 * Action - Increment/Decrement
206 * StateList - List the state will be added to
210 * DESCRIPTION: Create a new state and push it
212 ******************************************************************************/
215 AcpiUtCreateUpdateStateAndPush (
216 ACPI_OPERAND_OBJECT *Object,
218 ACPI_GENERIC_STATE **StateList)
220 ACPI_GENERIC_STATE *State;
223 ACPI_FUNCTION_ENTRY ();
226 /* Ignore null objects; these are expected */
233 State = AcpiUtCreateUpdateState (Object, Action);
236 return (AE_NO_MEMORY);
239 AcpiUtPushGenericState (StateList, State);
244 /*******************************************************************************
246 * FUNCTION: AcpiUtWalkPackageTree
248 * PARAMETERS: SourceObject - The package to walk
249 * TargetObject - Target object (if package is being copied)
250 * WalkCallback - Called once for each package element
251 * Context - Passed to the callback function
255 * DESCRIPTION: Walk through a package
257 ******************************************************************************/
260 AcpiUtWalkPackageTree (
261 ACPI_OPERAND_OBJECT *SourceObject,
263 ACPI_PKG_CALLBACK WalkCallback,
266 ACPI_STATUS Status = AE_OK;
267 ACPI_GENERIC_STATE *StateList = NULL;
268 ACPI_GENERIC_STATE *State;
270 ACPI_OPERAND_OBJECT *ThisSourceObj;
273 ACPI_FUNCTION_TRACE (UtWalkPackageTree);
276 State = AcpiUtCreatePkgState (SourceObject, TargetObject, 0);
279 return_ACPI_STATUS (AE_NO_MEMORY);
284 /* Get one element of the package */
286 ThisIndex = State->Pkg.Index;
287 ThisSourceObj = (ACPI_OPERAND_OBJECT *)
288 State->Pkg.SourceObject->Package.Elements[ThisIndex];
292 * 1) An uninitialized package element. It is completely
293 * legal to declare a package and leave it uninitialized
294 * 2) Not an internal object - can be a namespace node instead
295 * 3) Any type other than a package. Packages are handled in else
298 if ((!ThisSourceObj) ||
299 (ACPI_GET_DESCRIPTOR_TYPE (ThisSourceObj) != ACPI_DESC_TYPE_OPERAND) ||
300 (ThisSourceObj->Common.Type != ACPI_TYPE_PACKAGE))
302 Status = WalkCallback (ACPI_COPY_TYPE_SIMPLE, ThisSourceObj,
304 if (ACPI_FAILURE (Status))
306 return_ACPI_STATUS (Status);
310 while (State->Pkg.Index >= State->Pkg.SourceObject->Package.Count)
313 * We've handled all of the objects at this level, This means
314 * that we have just completed a package. That package may
315 * have contained one or more packages itself.
317 * Delete this state and pop the previous state (package).
319 AcpiUtDeleteGenericState (State);
320 State = AcpiUtPopGenericState (&StateList);
322 /* Finished when there are no more states */
327 * We have handled all of the objects in the top level
328 * package just add the length of the package objects
331 return_ACPI_STATUS (AE_OK);
335 * Go back up a level and move the index past the just
336 * completed package object.
343 /* This is a subobject of type package */
345 Status = WalkCallback (ACPI_COPY_TYPE_PACKAGE, ThisSourceObj,
347 if (ACPI_FAILURE (Status))
349 return_ACPI_STATUS (Status);
353 * Push the current state and create a new one
354 * The callback above returned a new target package object.
356 AcpiUtPushGenericState (&StateList, State);
357 State = AcpiUtCreatePkgState (ThisSourceObj,
358 State->Pkg.ThisTargetObj, 0);
361 /* Free any stacked Update State objects */
365 State = AcpiUtPopGenericState (&StateList);
366 AcpiUtDeleteGenericState (State);
368 return_ACPI_STATUS (AE_NO_MEMORY);
373 /* We should never get here */
375 return_ACPI_STATUS (AE_AML_INTERNAL);
379 #ifdef ACPI_DEBUG_OUTPUT
380 /*******************************************************************************
382 * FUNCTION: AcpiUtDisplayInitPathname
384 * PARAMETERS: Type - Object type of the node
385 * ObjHandle - Handle whose pathname will be displayed
386 * Path - Additional path string to be appended.
387 * (NULL if no extra path)
389 * RETURN: ACPI_STATUS
391 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
393 ******************************************************************************/
396 AcpiUtDisplayInitPathname (
398 ACPI_NAMESPACE_NODE *ObjHandle,
405 ACPI_FUNCTION_ENTRY ();
408 /* Only print the path if the appropriate debug level is enabled */
410 if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
415 /* Get the full pathname to the node */
417 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
418 Status = AcpiNsHandleToPathname (ObjHandle, &Buffer);
419 if (ACPI_FAILURE (Status))
424 /* Print what we're doing */
428 case ACPI_TYPE_METHOD:
430 AcpiOsPrintf ("Executing ");
435 AcpiOsPrintf ("Initializing ");
439 /* Print the object type and pathname */
441 AcpiOsPrintf ("%-12s %s",
442 AcpiUtGetTypeName (Type), (char *) Buffer.Pointer);
444 /* Extra path is used to append names like _STA, _INI, etc. */
448 AcpiOsPrintf (".%s", Path);
452 ACPI_FREE (Buffer.Pointer);