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.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acnamesp.h>
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 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_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))
121 /*******************************************************************************
123 * FUNCTION: AcpiUtDwordByteSwap
125 * PARAMETERS: Value - Value to be converted
127 * RETURN: UINT32 integer with bytes swapped
129 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
131 ******************************************************************************/
134 AcpiUtDwordByteSwap (
149 ACPI_FUNCTION_ENTRY ();
154 Out.Bytes[0] = In.Bytes[3];
155 Out.Bytes[1] = In.Bytes[2];
156 Out.Bytes[2] = In.Bytes[1];
157 Out.Bytes[3] = In.Bytes[0];
163 /*******************************************************************************
165 * FUNCTION: AcpiUtSetIntegerWidth
167 * PARAMETERS: Revision From DSDT header
171 * DESCRIPTION: Set the global integer bit width based upon the revision
172 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
173 * For Revision 2 and above, Integers are 64 bits. Yes, this
174 * makes a difference.
176 ******************************************************************************/
179 AcpiUtSetIntegerWidth (
187 AcpiGbl_IntegerBitWidth = 32;
188 AcpiGbl_IntegerNybbleWidth = 8;
189 AcpiGbl_IntegerByteWidth = 4;
193 /* 64-bit case (ACPI 2.0+) */
195 AcpiGbl_IntegerBitWidth = 64;
196 AcpiGbl_IntegerNybbleWidth = 16;
197 AcpiGbl_IntegerByteWidth = 8;
202 /*******************************************************************************
204 * FUNCTION: AcpiUtCreateUpdateStateAndPush
206 * PARAMETERS: Object - Object to be added to the new state
207 * Action - Increment/Decrement
208 * StateList - List the state will be added to
212 * DESCRIPTION: Create a new state and push it
214 ******************************************************************************/
217 AcpiUtCreateUpdateStateAndPush (
218 ACPI_OPERAND_OBJECT *Object,
220 ACPI_GENERIC_STATE **StateList)
222 ACPI_GENERIC_STATE *State;
225 ACPI_FUNCTION_ENTRY ();
228 /* Ignore null objects; these are expected */
235 State = AcpiUtCreateUpdateState (Object, Action);
238 return (AE_NO_MEMORY);
241 AcpiUtPushGenericState (StateList, State);
246 /*******************************************************************************
248 * FUNCTION: AcpiUtWalkPackageTree
250 * PARAMETERS: SourceObject - The package to walk
251 * TargetObject - Target object (if package is being copied)
252 * WalkCallback - Called once for each package element
253 * Context - Passed to the callback function
257 * DESCRIPTION: Walk through a package
259 ******************************************************************************/
262 AcpiUtWalkPackageTree (
263 ACPI_OPERAND_OBJECT *SourceObject,
265 ACPI_PKG_CALLBACK WalkCallback,
268 ACPI_STATUS Status = AE_OK;
269 ACPI_GENERIC_STATE *StateList = NULL;
270 ACPI_GENERIC_STATE *State;
272 ACPI_OPERAND_OBJECT *ThisSourceObj;
275 ACPI_FUNCTION_TRACE (UtWalkPackageTree);
278 State = AcpiUtCreatePkgState (SourceObject, TargetObject, 0);
281 return_ACPI_STATUS (AE_NO_MEMORY);
286 /* Get one element of the package */
288 ThisIndex = State->Pkg.Index;
289 ThisSourceObj = (ACPI_OPERAND_OBJECT *)
290 State->Pkg.SourceObject->Package.Elements[ThisIndex];
294 * 1) An uninitialized package element. It is completely
295 * legal to declare a package and leave it uninitialized
296 * 2) Not an internal object - can be a namespace node instead
297 * 3) Any type other than a package. Packages are handled in else
300 if ((!ThisSourceObj) ||
301 (ACPI_GET_DESCRIPTOR_TYPE (ThisSourceObj) != ACPI_DESC_TYPE_OPERAND) ||
302 (ThisSourceObj->Common.Type != ACPI_TYPE_PACKAGE))
304 Status = WalkCallback (ACPI_COPY_TYPE_SIMPLE, ThisSourceObj,
306 if (ACPI_FAILURE (Status))
308 return_ACPI_STATUS (Status);
312 while (State->Pkg.Index >= State->Pkg.SourceObject->Package.Count)
315 * We've handled all of the objects at this level, This means
316 * that we have just completed a package. That package may
317 * have contained one or more packages itself.
319 * Delete this state and pop the previous state (package).
321 AcpiUtDeleteGenericState (State);
322 State = AcpiUtPopGenericState (&StateList);
324 /* Finished when there are no more states */
329 * We have handled all of the objects in the top level
330 * package just add the length of the package objects
333 return_ACPI_STATUS (AE_OK);
337 * Go back up a level and move the index past the just
338 * completed package object.
345 /* This is a subobject of type package */
347 Status = WalkCallback (ACPI_COPY_TYPE_PACKAGE, ThisSourceObj,
349 if (ACPI_FAILURE (Status))
351 return_ACPI_STATUS (Status);
355 * Push the current state and create a new one
356 * The callback above returned a new target package object.
358 AcpiUtPushGenericState (&StateList, State);
359 State = AcpiUtCreatePkgState (ThisSourceObj,
360 State->Pkg.ThisTargetObj, 0);
363 /* Free any stacked Update State objects */
367 State = AcpiUtPopGenericState (&StateList);
368 AcpiUtDeleteGenericState (State);
370 return_ACPI_STATUS (AE_NO_MEMORY);
375 /* We should never get here */
377 return_ACPI_STATUS (AE_AML_INTERNAL);
381 #ifdef ACPI_DEBUG_OUTPUT
382 /*******************************************************************************
384 * FUNCTION: AcpiUtDisplayInitPathname
386 * PARAMETERS: Type - Object type of the node
387 * ObjHandle - Handle whose pathname will be displayed
388 * Path - Additional path string to be appended.
389 * (NULL if no extra path)
391 * RETURN: ACPI_STATUS
393 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
395 ******************************************************************************/
398 AcpiUtDisplayInitPathname (
400 ACPI_NAMESPACE_NODE *ObjHandle,
407 ACPI_FUNCTION_ENTRY ();
410 /* Only print the path if the appropriate debug level is enabled */
412 if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES))
417 /* Get the full pathname to the node */
419 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
420 Status = AcpiNsHandleToPathname (ObjHandle, &Buffer);
421 if (ACPI_FAILURE (Status))
426 /* Print what we're doing */
430 case ACPI_TYPE_METHOD:
432 AcpiOsPrintf ("Executing ");
437 AcpiOsPrintf ("Initializing ");
441 /* Print the object type and pathname */
443 AcpiOsPrintf ("%-12s %s",
444 AcpiUtGetTypeName (Type), (char *) Buffer.Pointer);
446 /* Extra path is used to append names like _STA, _INI, etc. */
450 AcpiOsPrintf (".%s", Path);
454 ACPI_FREE (Buffer.Pointer);