1 /******************************************************************************
3 * Module Name: exdebug - Support for stores to the AML Debug Object
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 <acpi/acpi.h>
48 #define _COMPONENT ACPI_EXECUTER
49 ACPI_MODULE_NAME("exdebug")
51 #ifndef ACPI_NO_ERROR_MESSAGES
52 /*******************************************************************************
54 * FUNCTION: acpi_ex_do_debug_object
56 * PARAMETERS: source_desc - Object to be output to "Debug Object"
57 * level - Indentation level (used for packages)
58 * index - Current package element, zero if not pkg
62 * DESCRIPTION: Handles stores to the AML Debug Object. For example:
65 * This function is not compiled if ACPI_NO_ERROR_MESSAGES is set.
67 * This function is only enabled if acpi_gbl_enable_aml_debug_object is set, or
68 * if ACPI_LV_DEBUG_OBJECT is set in the acpi_dbg_level. Thus, in the normal
69 * operational case, stores to the debug object are ignored but can be easily
70 * enabled if necessary.
72 ******************************************************************************/
74 acpi_ex_do_debug_object(union acpi_operand_object *source_desc,
79 union acpi_operand_object *object_desc;
82 ACPI_FUNCTION_TRACE_PTR(ex_do_debug_object, source_desc);
84 /* Output must be enabled via the debug_object global or the dbg_level */
86 if (!acpi_gbl_enable_aml_debug_object &&
87 !(acpi_dbg_level & ACPI_LV_DEBUG_OBJECT)) {
91 /* Null string or newline -- don't emit the line header */
94 (ACPI_GET_DESCRIPTOR_TYPE(source_desc) == ACPI_DESC_TYPE_OPERAND) &&
95 (source_desc->common.type == ACPI_TYPE_STRING)) {
96 if ((source_desc->string.length == 0) ||
97 ((source_desc->string.length == 1) &&
98 (*source_desc->string.pointer == '\n'))) {
105 * Print line header as long as we are not in the middle of an
108 if (!((level > 0) && index == 0)) {
109 if (acpi_gbl_display_debug_timer) {
111 * We will emit the current timer value (in microseconds) with each
112 * debug output. Only need the lower 26 bits. This allows for 67
113 * million microseconds or 67 seconds before rollover.
115 * Convert 100 nanosecond units to microseconds
117 timer = ((u32)acpi_os_get_timer() / 10);
120 acpi_os_printf("[ACPI Debug T=0x%8.8X] %*s", timer,
123 acpi_os_printf("[ACPI Debug] %*s", level, " ");
127 /* Display the index for package output only */
130 acpi_os_printf("(%.2u) ", index - 1);
134 acpi_os_printf("[Null Object]\n");
138 if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) == ACPI_DESC_TYPE_OPERAND) {
140 /* No object type prefix needed for integers and strings */
142 if ((source_desc->common.type != ACPI_TYPE_INTEGER) &&
143 (source_desc->common.type != ACPI_TYPE_STRING)) {
144 acpi_os_printf("%s ",
145 acpi_ut_get_object_type_name
149 if (!acpi_ut_valid_internal_object(source_desc)) {
150 acpi_os_printf("%p, Invalid Internal Object!\n",
154 } else if (ACPI_GET_DESCRIPTOR_TYPE(source_desc) ==
155 ACPI_DESC_TYPE_NAMED) {
156 acpi_os_printf("%s (Node %p)\n",
157 acpi_ut_get_type_name(((struct
158 acpi_namespace_node *)
166 /* source_desc is of type ACPI_DESC_TYPE_OPERAND */
168 switch (source_desc->common.type) {
169 case ACPI_TYPE_INTEGER:
171 /* Output correct integer width */
173 if (acpi_gbl_integer_byte_width == 4) {
174 acpi_os_printf("0x%8.8X\n",
175 (u32)source_desc->integer.value);
177 acpi_os_printf("0x%8.8X%8.8X\n",
178 ACPI_FORMAT_UINT64(source_desc->integer.
183 case ACPI_TYPE_BUFFER:
185 acpi_os_printf("[0x%.2X]\n", (u32)source_desc->buffer.length);
186 acpi_ut_dump_buffer(source_desc->buffer.pointer,
187 (source_desc->buffer.length < 256) ?
188 source_desc->buffer.length : 256,
192 case ACPI_TYPE_STRING:
194 acpi_os_printf("\"%s\"\n", source_desc->string.pointer);
197 case ACPI_TYPE_PACKAGE:
199 acpi_os_printf("(Contains 0x%.2X Elements):\n",
200 source_desc->package.count);
202 /* Output the entire contents of the package */
204 for (i = 0; i < source_desc->package.count; i++) {
205 acpi_ex_do_debug_object(source_desc->package.
206 elements[i], level + 4, i + 1);
210 case ACPI_TYPE_LOCAL_REFERENCE:
212 acpi_os_printf("[%s] ",
213 acpi_ut_get_reference_name(source_desc));
215 /* Decode the reference */
217 switch (source_desc->reference.class) {
218 case ACPI_REFCLASS_INDEX:
220 acpi_os_printf("0x%X\n", source_desc->reference.value);
223 case ACPI_REFCLASS_TABLE:
225 /* Case for ddb_handle */
227 acpi_os_printf("Table Index 0x%X\n",
228 source_desc->reference.value);
238 /* Check for valid node first, then valid object */
240 if (source_desc->reference.node) {
241 if (ACPI_GET_DESCRIPTOR_TYPE
242 (source_desc->reference.node) !=
243 ACPI_DESC_TYPE_NAMED) {
245 (" %p - Not a valid namespace node\n",
246 source_desc->reference.node);
248 acpi_os_printf("Node %p [%4.4s] ",
249 source_desc->reference.node,
250 (source_desc->reference.node)->
253 switch ((source_desc->reference.node)->type) {
255 /* These types have no attached object */
257 case ACPI_TYPE_DEVICE:
258 acpi_os_printf("Device\n");
261 case ACPI_TYPE_THERMAL:
262 acpi_os_printf("Thermal Zone\n");
267 acpi_ex_do_debug_object((source_desc->
274 } else if (source_desc->reference.object) {
275 if (ACPI_GET_DESCRIPTOR_TYPE
276 (source_desc->reference.object) ==
277 ACPI_DESC_TYPE_NAMED) {
279 /* Reference object is a namespace node */
281 acpi_ex_do_debug_object(ACPI_CAST_PTR
284 source_desc->reference.
285 object), level + 4, 0);
287 object_desc = source_desc->reference.object;
288 value = source_desc->reference.value;
290 switch (object_desc->common.type) {
291 case ACPI_TYPE_BUFFER:
293 acpi_os_printf("Buffer[%u] = 0x%2.2X\n",
295 *source_desc->reference.
299 case ACPI_TYPE_STRING:
302 ("String[%u] = \"%c\" (0x%2.2X)\n",
304 *source_desc->reference.
306 *source_desc->reference.
310 case ACPI_TYPE_PACKAGE:
312 acpi_os_printf("Package[%u] = ", value);
313 if (!(*source_desc->reference.where)) {
315 ("[Uninitialized Package Element]\n");
317 acpi_ex_do_debug_object
318 (*source_desc->reference.
319 where, level + 4, 0);
326 ("Unknown Reference object type %X\n",
327 object_desc->common.type);
336 acpi_os_printf("(Descriptor %p)\n", source_desc);
340 ACPI_DEBUG_PRINT_RAW((ACPI_DB_EXEC, "\n"));