1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/acnamesp.h>
122 #include <contrib/dev/acpica/acparser.h>
125 #define _COMPONENT ACPI_NAMESPACE
126 ACPI_MODULE_NAME ("nsdump")
128 /* Local prototypes */
130 #ifdef ACPI_OBSOLETE_FUNCTIONS
132 AcpiNsDumpRootDevices (
136 AcpiNsDumpOneDevice (
137 ACPI_HANDLE ObjHandle,
144 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
145 /*******************************************************************************
147 * FUNCTION: AcpiNsPrintPathname
149 * PARAMETERS: NumSegments - Number of ACPI name segments
150 * Pathname - The compressed (internal) path
154 * DESCRIPTION: Print an object's full namespace pathname
156 ******************************************************************************/
159 AcpiNsPrintPathname (
166 ACPI_FUNCTION_NAME ("NsPrintPathname");
169 if (!(AcpiDbgLevel & ACPI_LV_NAMES) || !(AcpiDbgLayer & ACPI_NAMESPACE))
174 /* Print the entire name */
176 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "["));
180 for (i = 0; i < 4; i++)
182 ACPI_IS_PRINT (Pathname[i]) ?
183 AcpiOsPrintf ("%c", Pathname[i]) :
187 Pathname += ACPI_NAME_SIZE;
195 AcpiOsPrintf ("]\n");
199 /*******************************************************************************
201 * FUNCTION: AcpiNsDumpPathname
203 * PARAMETERS: Handle - Object
204 * Msg - Prefix message
205 * Level - Desired debug level
206 * Component - Caller's component ID
210 * DESCRIPTION: Print an object's full namespace pathname
211 * Manages allocation/freeing of a pathname buffer
213 ******************************************************************************/
223 ACPI_FUNCTION_TRACE ("NsDumpPathname");
226 /* Do this only if the requested debug level and component are enabled */
228 if (!(AcpiDbgLevel & Level) || !(AcpiDbgLayer & Component))
233 /* Convert handle to a full pathname and print it (with supplied message) */
235 AcpiNsPrintNodePathname (Handle, Msg);
241 /*******************************************************************************
243 * FUNCTION: AcpiNsDumpOneObject
245 * PARAMETERS: ObjHandle - Node to be dumped
246 * Level - Nesting level of the handle
247 * Context - Passed into WalkNamespace
248 * ReturnValue - Not used
252 * DESCRIPTION: Dump a single Node
253 * This procedure is a UserFunction called by AcpiNsWalkNamespace.
255 ******************************************************************************/
258 AcpiNsDumpOneObject (
259 ACPI_HANDLE ObjHandle,
264 ACPI_WALK_INFO *Info = (ACPI_WALK_INFO *) Context;
265 ACPI_NAMESPACE_NODE *ThisNode;
266 ACPI_OPERAND_OBJECT *ObjDesc = NULL;
267 ACPI_OBJECT_TYPE ObjType;
268 ACPI_OBJECT_TYPE Type;
274 ACPI_FUNCTION_NAME ("NsDumpOneObject");
277 /* Is output enabled? */
279 if (!(AcpiDbgLevel & Info->DebugLevel))
286 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Null object handle\n"));
290 ThisNode = AcpiNsMapHandleToNode (ObjHandle);
291 Type = ThisNode->Type;
293 /* Check if the owner matches */
295 if ((Info->OwnerId != ACPI_OWNER_ID_MAX) &&
296 (Info->OwnerId != ThisNode->OwnerId))
301 if (!(Info->DisplayType & ACPI_DISPLAY_SHORT))
303 /* Indent the object according to the level */
305 AcpiOsPrintf ("%2d%*s", (UINT32) Level - 1, (int) Level * 2, " ");
307 /* Check the node type and name */
309 if (Type > ACPI_TYPE_LOCAL_MAX)
311 ACPI_REPORT_WARNING (("Invalid ACPI Type %08X\n", Type));
314 if (!AcpiUtValidAcpiName (ThisNode->Name.Integer))
316 ACPI_REPORT_WARNING (("Invalid ACPI Name %08X\n",
317 ThisNode->Name.Integer));
320 AcpiOsPrintf ("%4.4s", AcpiUtGetNodeName (ThisNode));
324 * Now we can print out the pertinent information
326 AcpiOsPrintf (" %-12s %p ",
327 AcpiUtGetTypeName (Type), ThisNode);
329 DbgLevel = AcpiDbgLevel;
331 ObjDesc = AcpiNsGetAttachedObject (ThisNode);
332 AcpiDbgLevel = DbgLevel;
334 switch (Info->DisplayType & ACPI_DISPLAY_MASK)
336 case ACPI_DISPLAY_SUMMARY:
340 /* No attached object, we are done */
348 case ACPI_TYPE_PROCESSOR:
350 AcpiOsPrintf ("ID %X Len %.4X Addr %p\n",
351 ObjDesc->Processor.ProcId, ObjDesc->Processor.Length,
352 (char *) ObjDesc->Processor.Address);
356 case ACPI_TYPE_DEVICE:
358 AcpiOsPrintf ("Notify Object: %p\n", ObjDesc);
362 case ACPI_TYPE_METHOD:
364 AcpiOsPrintf ("Args %X Len %.4X Aml %p\n",
365 (UINT32) ObjDesc->Method.ParamCount,
366 ObjDesc->Method.AmlLength, ObjDesc->Method.AmlStart);
370 case ACPI_TYPE_INTEGER:
372 AcpiOsPrintf ("= %8.8X%8.8X\n",
373 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
377 case ACPI_TYPE_PACKAGE:
379 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
381 AcpiOsPrintf ("Elements %.2X\n",
382 ObjDesc->Package.Count);
386 AcpiOsPrintf ("[Length not yet evaluated]\n");
391 case ACPI_TYPE_BUFFER:
393 if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
395 AcpiOsPrintf ("Len %.2X",
396 ObjDesc->Buffer.Length);
398 /* Dump some of the buffer */
400 if (ObjDesc->Buffer.Length > 0)
403 for (i = 0; (i < ObjDesc->Buffer.Length && i < 12); i++)
405 AcpiOsPrintf (" %.2hX", ObjDesc->Buffer.Pointer[i]);
412 AcpiOsPrintf ("[Length not yet evaluated]\n");
417 case ACPI_TYPE_STRING:
419 AcpiOsPrintf ("Len %.2X ", ObjDesc->String.Length);
420 AcpiUtPrintString (ObjDesc->String.Pointer, 32);
425 case ACPI_TYPE_REGION:
427 AcpiOsPrintf ("[%s]",
428 AcpiUtGetRegionName (ObjDesc->Region.SpaceId));
429 if (ObjDesc->Region.Flags & AOPOBJ_DATA_VALID)
431 AcpiOsPrintf (" Addr %8.8X%8.8X Len %.4X\n",
432 ACPI_FORMAT_UINT64 (ObjDesc->Region.Address),
433 ObjDesc->Region.Length);
437 AcpiOsPrintf (" [Address/Length not yet evaluated]\n");
442 case ACPI_TYPE_LOCAL_REFERENCE:
444 AcpiOsPrintf ("[%s]\n",
445 AcpiPsGetOpcodeName (ObjDesc->Reference.Opcode));
449 case ACPI_TYPE_BUFFER_FIELD:
451 if (ObjDesc->BufferField.BufferObj &&
452 ObjDesc->BufferField.BufferObj->Buffer.Node)
454 AcpiOsPrintf ("Buf [%4.4s]",
455 AcpiUtGetNodeName (ObjDesc->BufferField.BufferObj->Buffer.Node));
460 case ACPI_TYPE_LOCAL_REGION_FIELD:
462 AcpiOsPrintf ("Rgn [%4.4s]",
463 AcpiUtGetNodeName (ObjDesc->CommonField.RegionObj->Region.Node));
467 case ACPI_TYPE_LOCAL_BANK_FIELD:
469 AcpiOsPrintf ("Rgn [%4.4s] Bnk [%4.4s]",
470 AcpiUtGetNodeName (ObjDesc->CommonField.RegionObj->Region.Node),
471 AcpiUtGetNodeName (ObjDesc->BankField.BankObj->CommonField.Node));
475 case ACPI_TYPE_LOCAL_INDEX_FIELD:
477 AcpiOsPrintf ("Idx [%4.4s] Dat [%4.4s]",
478 AcpiUtGetNodeName (ObjDesc->IndexField.IndexObj->CommonField.Node),
479 AcpiUtGetNodeName (ObjDesc->IndexField.DataObj->CommonField.Node));
483 case ACPI_TYPE_LOCAL_ALIAS:
484 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
486 AcpiOsPrintf ("Target %4.4s (%p)\n",
487 AcpiUtGetNodeName (ObjDesc), ObjDesc);
492 AcpiOsPrintf ("Object %p\n", ObjDesc);
496 /* Common field handling */
500 case ACPI_TYPE_BUFFER_FIELD:
501 case ACPI_TYPE_LOCAL_REGION_FIELD:
502 case ACPI_TYPE_LOCAL_BANK_FIELD:
503 case ACPI_TYPE_LOCAL_INDEX_FIELD:
505 AcpiOsPrintf (" Off %.3X Len %.2X Acc %.2hd\n",
506 (ObjDesc->CommonField.BaseByteOffset * 8)
507 + ObjDesc->CommonField.StartFieldBitOffset,
508 ObjDesc->CommonField.BitLength,
509 ObjDesc->CommonField.AccessByteWidth);
518 case ACPI_DISPLAY_OBJECTS:
520 AcpiOsPrintf ("O:%p", ObjDesc);
523 /* No attached object, we are done */
529 AcpiOsPrintf ("(R%d)", ObjDesc->Common.ReferenceCount);
533 case ACPI_TYPE_METHOD:
535 /* Name is a Method and its AML offset/length are set */
537 AcpiOsPrintf (" M:%p-%X\n", ObjDesc->Method.AmlStart,
538 ObjDesc->Method.AmlLength);
541 case ACPI_TYPE_INTEGER:
543 AcpiOsPrintf (" I:%8.8X8.8%X\n",
544 ACPI_FORMAT_UINT64 (ObjDesc->Integer.Value));
547 case ACPI_TYPE_STRING:
549 AcpiOsPrintf (" S:%p-%X\n", ObjDesc->String.Pointer,
550 ObjDesc->String.Length);
553 case ACPI_TYPE_BUFFER:
555 AcpiOsPrintf (" B:%p-%X\n", ObjDesc->Buffer.Pointer,
556 ObjDesc->Buffer.Length);
572 /* If debug turned off, done */
574 if (!(AcpiDbgLevel & ACPI_LV_VALUES))
580 /* If there is an attached object, display it */
582 DbgLevel = AcpiDbgLevel;
584 ObjDesc = AcpiNsGetAttachedObject (ThisNode);
585 AcpiDbgLevel = DbgLevel;
587 /* Dump attached objects */
591 ObjType = ACPI_TYPE_INVALID;
592 AcpiOsPrintf ("Attached Object %p: ", ObjDesc);
594 /* Decode the type of attached object and dump the contents */
596 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
598 case ACPI_DESC_TYPE_NAMED:
600 AcpiOsPrintf ("(Ptr to Node)\n");
601 BytesToDump = sizeof (ACPI_NAMESPACE_NODE);
602 ACPI_DUMP_BUFFER (ObjDesc, BytesToDump);
605 case ACPI_DESC_TYPE_OPERAND:
607 ObjType = ACPI_GET_OBJECT_TYPE (ObjDesc);
609 if (ObjType > ACPI_TYPE_LOCAL_MAX)
611 AcpiOsPrintf ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
617 AcpiOsPrintf ("(Ptr to ACPI Object type %X [%s])\n",
618 ObjType, AcpiUtGetTypeName (ObjType));
619 BytesToDump = sizeof (ACPI_OPERAND_OBJECT);
622 ACPI_DUMP_BUFFER (ObjDesc, BytesToDump);
630 /* If value is NOT an internal object, we are done */
632 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND)
638 * Valid object, get the pointer to next level, if any
642 case ACPI_TYPE_BUFFER:
643 case ACPI_TYPE_STRING:
645 * NOTE: takes advantage of common fields between string/buffer
647 BytesToDump = ObjDesc->String.Length;
648 ObjDesc = (void *) ObjDesc->String.Pointer;
649 AcpiOsPrintf ( "(Buffer/String pointer %p length %X)\n",
650 ObjDesc, BytesToDump);
651 ACPI_DUMP_BUFFER (ObjDesc, BytesToDump);
654 case ACPI_TYPE_BUFFER_FIELD:
655 ObjDesc = (ACPI_OPERAND_OBJECT *) ObjDesc->BufferField.BufferObj;
658 case ACPI_TYPE_PACKAGE:
659 ObjDesc = (void *) ObjDesc->Package.Elements;
662 case ACPI_TYPE_METHOD:
663 ObjDesc = (void *) ObjDesc->Method.AmlStart;
666 case ACPI_TYPE_LOCAL_REGION_FIELD:
667 ObjDesc = (void *) ObjDesc->Field.RegionObj;
670 case ACPI_TYPE_LOCAL_BANK_FIELD:
671 ObjDesc = (void *) ObjDesc->BankField.RegionObj;
674 case ACPI_TYPE_LOCAL_INDEX_FIELD:
675 ObjDesc = (void *) ObjDesc->IndexField.IndexObj;
682 ObjType = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
691 /*******************************************************************************
693 * FUNCTION: AcpiNsDumpObjects
695 * PARAMETERS: Type - Object type to be dumped
696 * DisplayType - 0 or ACPI_DISPLAY_SUMMARY
697 * MaxDepth - Maximum depth of dump. Use ACPI_UINT32_MAX
698 * for an effectively unlimited depth.
699 * OwnerId - Dump only objects owned by this ID. Use
700 * ACPI_UINT32_MAX to match all owners.
701 * StartHandle - Where in namespace to start/end search
705 * DESCRIPTION: Dump typed objects within the loaded namespace.
706 * Uses AcpiNsWalkNamespace in conjunction with AcpiNsDumpOneObject.
708 ******************************************************************************/
712 ACPI_OBJECT_TYPE Type,
715 ACPI_OWNER_ID OwnerId,
716 ACPI_HANDLE StartHandle)
721 ACPI_FUNCTION_ENTRY ();
724 Info.DebugLevel = ACPI_LV_TABLES;
725 Info.OwnerId = OwnerId;
726 Info.DisplayType = DisplayType;
728 (void) AcpiNsWalkNamespace (Type, StartHandle, MaxDepth,
729 ACPI_NS_WALK_NO_UNLOCK, AcpiNsDumpOneObject,
730 (void *) &Info, NULL);
734 /*******************************************************************************
736 * FUNCTION: AcpiNsDumpEntry
738 * PARAMETERS: Handle - Node to be dumped
739 * DebugLevel - Output level
743 * DESCRIPTION: Dump a single Node
745 ******************************************************************************/
755 ACPI_FUNCTION_ENTRY ();
758 Info.DebugLevel = DebugLevel;
759 Info.OwnerId = ACPI_OWNER_ID_MAX;
760 Info.DisplayType = ACPI_DISPLAY_SUMMARY;
762 (void) AcpiNsDumpOneObject (Handle, 1, &Info, NULL);
766 #ifdef ACPI_ASL_COMPILER
767 /*******************************************************************************
769 * FUNCTION: AcpiNsDumpTables
771 * PARAMETERS: SearchBase - Root of subtree to be dumped, or
772 * NS_ALL to dump the entire namespace
773 * MaxDepth - Maximum depth of dump. Use INT_MAX
774 * for an effectively unlimited depth.
778 * DESCRIPTION: Dump the name space, or a portion of it.
780 ******************************************************************************/
784 ACPI_HANDLE SearchBase,
787 ACPI_HANDLE SearchHandle = SearchBase;
790 ACPI_FUNCTION_TRACE ("NsDumpTables");
793 if (!AcpiGbl_RootNode)
796 * If the name space has not been initialized,
797 * there is nothing to dump.
799 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "namespace not initialized!\n"));
803 if (ACPI_NS_ALL == SearchBase)
805 /* Entire namespace */
807 SearchHandle = AcpiGbl_RootNode;
808 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "\\\n"));
811 AcpiNsDumpObjects (ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, MaxDepth,
812 ACPI_OWNER_ID_MAX, SearchHandle);