1 /******************************************************************************
3 * Module Name: exdebug - Support for stores to the AML Debug Object
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2019, 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_EXECUTER
50 ACPI_MODULE_NAME ("exdebug")
53 #ifndef ACPI_NO_ERROR_MESSAGES
54 /*******************************************************************************
56 * FUNCTION: AcpiExDoDebugObject
58 * PARAMETERS: SourceDesc - Object to be output to "Debug Object"
59 * Level - Indentation level (used for packages)
60 * Index - Current package element, zero if not pkg
64 * DESCRIPTION: Handles stores to the AML Debug Object. For example:
67 * This function is not compiled if ACPI_NO_ERROR_MESSAGES is set.
69 * This function is only enabled if AcpiGbl_EnableAmlDebugObject is set, or
70 * if ACPI_LV_DEBUG_OBJECT is set in the AcpiDbgLevel. Thus, in the normal
71 * operational case, stores to the debug object are ignored but can be easily
72 * enabled if necessary.
74 ******************************************************************************/
78 ACPI_OPERAND_OBJECT
*SourceDesc
,
84 ACPI_OPERAND_OBJECT
*ObjectDesc
;
88 ACPI_FUNCTION_TRACE_PTR (ExDoDebugObject
, SourceDesc
);
91 /* Output must be enabled via the DebugObject global or the DbgLevel */
93 if (!AcpiGbl_EnableAmlDebugObject
&&
94 !(AcpiDbgLevel
& ACPI_LV_DEBUG_OBJECT
))
99 /* Newline -- don't emit the line header */
102 (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc
) == ACPI_DESC_TYPE_OPERAND
) &&
103 (SourceDesc
->Common
.Type
== ACPI_TYPE_STRING
))
105 if ((SourceDesc
->String
.Length
== 1) &&
106 (*SourceDesc
->String
.Pointer
== '\n'))
114 * Print line header as long as we are not in the middle of an
117 if (!((Level
> 0) && Index
== 0))
119 if (AcpiGbl_DisplayDebugTimer
)
122 * We will emit the current timer value (in microseconds) with each
123 * debug output. Only need the lower 26 bits. This allows for 67
124 * million microseconds or 67 seconds before rollover.
126 * Convert 100 nanosecond units to microseconds
128 Timer
= ((UINT32
) AcpiOsGetTimer () / 10);
131 AcpiOsPrintf ("ACPI Debug: T=0x%8.8X %*s", Timer
, Level
, " ");
135 AcpiOsPrintf ("ACPI Debug: %*s", Level
, " ");
139 /* Display the index for package output only */
143 AcpiOsPrintf ("(%.2u) ", Index
- 1);
148 AcpiOsPrintf ("[Null Object]\n");
152 if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc
) == ACPI_DESC_TYPE_OPERAND
)
154 /* No object type prefix needed for integers and strings */
156 if ((SourceDesc
->Common
.Type
!= ACPI_TYPE_INTEGER
) &&
157 (SourceDesc
->Common
.Type
!= ACPI_TYPE_STRING
))
159 AcpiOsPrintf ("%s ", AcpiUtGetObjectTypeName (SourceDesc
));
162 if (!AcpiUtValidInternalObject (SourceDesc
))
164 AcpiOsPrintf ("%p, Invalid Internal Object!\n", SourceDesc
);
168 else if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc
) == ACPI_DESC_TYPE_NAMED
)
170 AcpiOsPrintf ("%s (Node %p)\n",
171 AcpiUtGetTypeName (((ACPI_NAMESPACE_NODE
*) SourceDesc
)->Type
),
180 /* SourceDesc is of type ACPI_DESC_TYPE_OPERAND */
182 switch (SourceDesc
->Common
.Type
)
184 case ACPI_TYPE_INTEGER
:
186 /* Output correct integer width */
188 if (AcpiGbl_IntegerByteWidth
== 4)
190 AcpiOsPrintf ("0x%8.8X\n",
191 (UINT32
) SourceDesc
->Integer
.Value
);
195 AcpiOsPrintf ("0x%8.8X%8.8X\n",
196 ACPI_FORMAT_UINT64 (SourceDesc
->Integer
.Value
));
200 case ACPI_TYPE_BUFFER
:
202 AcpiOsPrintf ("[0x%.2X]\n", (UINT32
) SourceDesc
->Buffer
.Length
);
203 AcpiUtDumpBuffer (SourceDesc
->Buffer
.Pointer
,
204 (SourceDesc
->Buffer
.Length
< 256) ?
205 SourceDesc
->Buffer
.Length
: 256, DB_BYTE_DISPLAY
, 0);
208 case ACPI_TYPE_STRING
:
210 AcpiOsPrintf ("\"%s\"\n", SourceDesc
->String
.Pointer
);
213 case ACPI_TYPE_PACKAGE
:
215 AcpiOsPrintf ("(Contains 0x%.2X Elements):\n",
216 SourceDesc
->Package
.Count
);
218 /* Output the entire contents of the package */
220 for (i
= 0; i
< SourceDesc
->Package
.Count
; i
++)
222 AcpiExDoDebugObject (SourceDesc
->Package
.Elements
[i
],
227 case ACPI_TYPE_LOCAL_REFERENCE
:
229 AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (SourceDesc
));
231 /* Decode the reference */
233 switch (SourceDesc
->Reference
.Class
)
235 case ACPI_REFCLASS_INDEX
:
237 AcpiOsPrintf ("0x%X\n", SourceDesc
->Reference
.Value
);
240 case ACPI_REFCLASS_TABLE
:
242 /* Case for DdbHandle */
244 AcpiOsPrintf ("Table Index 0x%X\n", SourceDesc
->Reference
.Value
);
254 /* Check for valid node first, then valid object */
256 if (SourceDesc
->Reference
.Node
)
258 if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc
->Reference
.Node
) !=
259 ACPI_DESC_TYPE_NAMED
)
261 AcpiOsPrintf (" %p - Not a valid namespace node\n",
262 SourceDesc
->Reference
.Node
);
266 AcpiOsPrintf ("Node %p [%4.4s] ", SourceDesc
->Reference
.Node
,
267 (SourceDesc
->Reference
.Node
)->Name
.Ascii
);
269 switch ((SourceDesc
->Reference
.Node
)->Type
)
271 /* These types have no attached object */
273 case ACPI_TYPE_DEVICE
:
274 AcpiOsPrintf ("Device\n");
277 case ACPI_TYPE_THERMAL
:
278 AcpiOsPrintf ("Thermal Zone\n");
283 AcpiExDoDebugObject ((SourceDesc
->Reference
.Node
)->Object
,
289 else if (SourceDesc
->Reference
.Object
)
291 if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc
->Reference
.Object
) ==
292 ACPI_DESC_TYPE_NAMED
)
294 /* Reference object is a namespace node */
296 AcpiExDoDebugObject (ACPI_CAST_PTR (ACPI_OPERAND_OBJECT
,
297 SourceDesc
->Reference
.Object
),
302 ObjectDesc
= SourceDesc
->Reference
.Object
;
303 Value
= SourceDesc
->Reference
.Value
;
305 switch (ObjectDesc
->Common
.Type
)
307 case ACPI_TYPE_BUFFER
:
309 AcpiOsPrintf ("Buffer[%u] = 0x%2.2X\n",
310 Value
, *SourceDesc
->Reference
.IndexPointer
);
313 case ACPI_TYPE_STRING
:
315 AcpiOsPrintf ("String[%u] = \"%c\" (0x%2.2X)\n",
316 Value
, *SourceDesc
->Reference
.IndexPointer
,
317 *SourceDesc
->Reference
.IndexPointer
);
320 case ACPI_TYPE_PACKAGE
:
322 AcpiOsPrintf ("Package[%u] = ", Value
);
323 if (!(*SourceDesc
->Reference
.Where
))
325 AcpiOsPrintf ("[Uninitialized Package Element]\n");
329 AcpiExDoDebugObject (*SourceDesc
->Reference
.Where
,
336 AcpiOsPrintf ("Unknown Reference object type %X\n",
337 ObjectDesc
->Common
.Type
);
346 AcpiOsPrintf ("(Descriptor %p)\n", SourceDesc
);
350 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC
, "\n"));