treewide: fix a few typos in comments
[zen-stable.git] / drivers / acpi / acpica / exdump.c
blob61b8c0e8b74d1b5bc115addeb1d04da535401b03
1 /******************************************************************************
3 * Module Name: exdump - Interpreter debug output routines
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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>
45 #include "accommon.h"
46 #include "acinterp.h"
47 #include "amlcode.h"
48 #include "acnamesp.h"
50 #define _COMPONENT ACPI_EXECUTER
51 ACPI_MODULE_NAME("exdump")
54 * The following routines are used for debug output only
56 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
57 /* Local prototypes */
58 static void acpi_ex_out_string(char *title, char *value);
60 static void acpi_ex_out_pointer(char *title, void *value);
62 static void
63 acpi_ex_dump_object(union acpi_operand_object *obj_desc,
64 struct acpi_exdump_info *info);
66 static void acpi_ex_dump_reference_obj(union acpi_operand_object *obj_desc);
68 static void
69 acpi_ex_dump_package_obj(union acpi_operand_object *obj_desc,
70 u32 level, u32 index);
72 /*******************************************************************************
74 * Object Descriptor info tables
76 * Note: The first table entry must be an INIT opcode and must contain
77 * the table length (number of table entries)
79 ******************************************************************************/
81 static struct acpi_exdump_info acpi_ex_dump_integer[2] = {
82 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_integer), NULL},
83 {ACPI_EXD_UINT64, ACPI_EXD_OFFSET(integer.value), "Value"}
86 static struct acpi_exdump_info acpi_ex_dump_string[4] = {
87 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_string), NULL},
88 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(string.length), "Length"},
89 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(string.pointer), "Pointer"},
90 {ACPI_EXD_STRING, 0, NULL}
93 static struct acpi_exdump_info acpi_ex_dump_buffer[5] = {
94 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_buffer), NULL},
95 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(buffer.length), "Length"},
96 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(buffer.pointer), "Pointer"},
97 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(buffer.node), "Parent Node"},
98 {ACPI_EXD_BUFFER, 0, NULL}
101 static struct acpi_exdump_info acpi_ex_dump_package[5] = {
102 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_package), NULL},
103 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(package.flags), "Flags"},
104 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(package.count), "Elements"},
105 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(package.elements), "Element List"},
106 {ACPI_EXD_PACKAGE, 0, NULL}
109 static struct acpi_exdump_info acpi_ex_dump_device[4] = {
110 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_device), NULL},
111 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(device.handler), "Handler"},
112 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(device.system_notify),
113 "System Notify"},
114 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(device.device_notify),
115 "Device Notify"}
118 static struct acpi_exdump_info acpi_ex_dump_event[2] = {
119 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_event), NULL},
120 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(event.os_semaphore), "OsSemaphore"}
123 static struct acpi_exdump_info acpi_ex_dump_method[9] = {
124 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_method), NULL},
125 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.info_flags), "Info Flags"},
126 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.param_count),
127 "Parameter Count"},
128 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.sync_level), "Sync Level"},
129 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(method.mutex), "Mutex"},
130 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.owner_id), "Owner Id"},
131 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.thread_count), "Thread Count"},
132 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(method.aml_length), "Aml Length"},
133 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(method.aml_start), "Aml Start"}
136 static struct acpi_exdump_info acpi_ex_dump_mutex[5] = {
137 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_mutex), NULL},
138 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(mutex.sync_level), "Sync Level"},
139 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(mutex.owner_thread), "Owner Thread"},
140 {ACPI_EXD_UINT16, ACPI_EXD_OFFSET(mutex.acquisition_depth),
141 "Acquire Depth"},
142 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(mutex.os_mutex), "OsMutex"}
145 static struct acpi_exdump_info acpi_ex_dump_region[7] = {
146 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_region), NULL},
147 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(region.space_id), "Space Id"},
148 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(region.flags), "Flags"},
149 {ACPI_EXD_ADDRESS, ACPI_EXD_OFFSET(region.address), "Address"},
150 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(region.length), "Length"},
151 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(region.handler), "Handler"},
152 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(region.next), "Next"}
155 static struct acpi_exdump_info acpi_ex_dump_power[5] = {
156 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_power), NULL},
157 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(power_resource.system_level),
158 "System Level"},
159 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(power_resource.resource_order),
160 "Resource Order"},
161 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(power_resource.system_notify),
162 "System Notify"},
163 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(power_resource.device_notify),
164 "Device Notify"}
167 static struct acpi_exdump_info acpi_ex_dump_processor[7] = {
168 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_processor), NULL},
169 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(processor.proc_id), "Processor ID"},
170 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(processor.length), "Length"},
171 {ACPI_EXD_ADDRESS, ACPI_EXD_OFFSET(processor.address), "Address"},
172 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(processor.system_notify),
173 "System Notify"},
174 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(processor.device_notify),
175 "Device Notify"},
176 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(processor.handler), "Handler"}
179 static struct acpi_exdump_info acpi_ex_dump_thermal[4] = {
180 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_thermal), NULL},
181 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(thermal_zone.system_notify),
182 "System Notify"},
183 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(thermal_zone.device_notify),
184 "Device Notify"},
185 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(thermal_zone.handler), "Handler"}
188 static struct acpi_exdump_info acpi_ex_dump_buffer_field[3] = {
189 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_buffer_field), NULL},
190 {ACPI_EXD_FIELD, 0, NULL},
191 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(buffer_field.buffer_obj),
192 "Buffer Object"}
195 static struct acpi_exdump_info acpi_ex_dump_region_field[3] = {
196 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_region_field), NULL},
197 {ACPI_EXD_FIELD, 0, NULL},
198 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(field.region_obj), "Region Object"}
201 static struct acpi_exdump_info acpi_ex_dump_bank_field[5] = {
202 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_bank_field), NULL},
203 {ACPI_EXD_FIELD, 0, NULL},
204 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(bank_field.value), "Value"},
205 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(bank_field.region_obj),
206 "Region Object"},
207 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(bank_field.bank_obj), "Bank Object"}
210 static struct acpi_exdump_info acpi_ex_dump_index_field[5] = {
211 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_bank_field), NULL},
212 {ACPI_EXD_FIELD, 0, NULL},
213 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(index_field.value), "Value"},
214 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(index_field.index_obj),
215 "Index Object"},
216 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(index_field.data_obj), "Data Object"}
219 static struct acpi_exdump_info acpi_ex_dump_reference[8] = {
220 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_reference), NULL},
221 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(reference.class), "Class"},
222 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(reference.target_type), "Target Type"},
223 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(reference.value), "Value"},
224 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(reference.object), "Object Desc"},
225 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(reference.node), "Node"},
226 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(reference.where), "Where"},
227 {ACPI_EXD_REFERENCE, 0, NULL}
230 static struct acpi_exdump_info acpi_ex_dump_address_handler[6] = {
231 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_address_handler),
232 NULL},
233 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(address_space.space_id), "Space Id"},
234 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.next), "Next"},
235 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.region_list),
236 "Region List"},
237 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.node), "Node"},
238 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.context), "Context"}
241 static struct acpi_exdump_info acpi_ex_dump_notify[3] = {
242 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_notify), NULL},
243 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.node), "Node"},
244 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.context), "Context"}
247 /* Miscellaneous tables */
249 static struct acpi_exdump_info acpi_ex_dump_common[4] = {
250 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_common), NULL},
251 {ACPI_EXD_TYPE, 0, NULL},
252 {ACPI_EXD_UINT16, ACPI_EXD_OFFSET(common.reference_count),
253 "Reference Count"},
254 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common.flags), "Flags"}
257 static struct acpi_exdump_info acpi_ex_dump_field_common[7] = {
258 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_field_common), NULL},
259 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common_field.field_flags),
260 "Field Flags"},
261 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common_field.access_byte_width),
262 "Access Byte Width"},
263 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(common_field.bit_length),
264 "Bit Length"},
265 {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common_field.start_field_bit_offset),
266 "Field Bit Offset"},
267 {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(common_field.base_byte_offset),
268 "Base Byte Offset"},
269 {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(common_field.node), "Parent Node"}
272 static struct acpi_exdump_info acpi_ex_dump_node[5] = {
273 {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_node), NULL},
274 {ACPI_EXD_UINT8, ACPI_EXD_NSOFFSET(flags), "Flags"},
275 {ACPI_EXD_UINT8, ACPI_EXD_NSOFFSET(owner_id), "Owner Id"},
276 {ACPI_EXD_POINTER, ACPI_EXD_NSOFFSET(child), "Child List"},
277 {ACPI_EXD_POINTER, ACPI_EXD_NSOFFSET(peer), "Next Peer"}
280 /* Dispatch table, indexed by object type */
282 static struct acpi_exdump_info *acpi_ex_dump_info[] = {
283 NULL,
284 acpi_ex_dump_integer,
285 acpi_ex_dump_string,
286 acpi_ex_dump_buffer,
287 acpi_ex_dump_package,
288 NULL,
289 acpi_ex_dump_device,
290 acpi_ex_dump_event,
291 acpi_ex_dump_method,
292 acpi_ex_dump_mutex,
293 acpi_ex_dump_region,
294 acpi_ex_dump_power,
295 acpi_ex_dump_processor,
296 acpi_ex_dump_thermal,
297 acpi_ex_dump_buffer_field,
298 NULL,
299 NULL,
300 acpi_ex_dump_region_field,
301 acpi_ex_dump_bank_field,
302 acpi_ex_dump_index_field,
303 acpi_ex_dump_reference,
304 NULL,
305 NULL,
306 acpi_ex_dump_notify,
307 acpi_ex_dump_address_handler,
308 NULL,
309 NULL,
310 NULL
313 /*******************************************************************************
315 * FUNCTION: acpi_ex_dump_object
317 * PARAMETERS: obj_desc - Descriptor to dump
318 * Info - Info table corresponding to this object
319 * type
321 * RETURN: None
323 * DESCRIPTION: Walk the info table for this object
325 ******************************************************************************/
327 static void
328 acpi_ex_dump_object(union acpi_operand_object *obj_desc,
329 struct acpi_exdump_info *info)
331 u8 *target;
332 char *name;
333 u8 count;
335 if (!info) {
336 acpi_os_printf
337 ("ExDumpObject: Display not implemented for object type %s\n",
338 acpi_ut_get_object_type_name(obj_desc));
339 return;
342 /* First table entry must contain the table length (# of table entries) */
344 count = info->offset;
346 while (count) {
347 target = ACPI_ADD_PTR(u8, obj_desc, info->offset);
348 name = info->name;
350 switch (info->opcode) {
351 case ACPI_EXD_INIT:
352 break;
354 case ACPI_EXD_TYPE:
356 acpi_ex_out_string("Type",
357 acpi_ut_get_object_type_name
358 (obj_desc));
359 break;
361 case ACPI_EXD_UINT8:
363 acpi_os_printf("%20s : %2.2X\n", name, *target);
364 break;
366 case ACPI_EXD_UINT16:
368 acpi_os_printf("%20s : %4.4X\n", name,
369 ACPI_GET16(target));
370 break;
372 case ACPI_EXD_UINT32:
374 acpi_os_printf("%20s : %8.8X\n", name,
375 ACPI_GET32(target));
376 break;
378 case ACPI_EXD_UINT64:
380 acpi_os_printf("%20s : %8.8X%8.8X\n", "Value",
381 ACPI_FORMAT_UINT64(ACPI_GET64(target)));
382 break;
384 case ACPI_EXD_POINTER:
385 case ACPI_EXD_ADDRESS:
387 acpi_ex_out_pointer(name,
388 *ACPI_CAST_PTR(void *, target));
389 break;
391 case ACPI_EXD_STRING:
393 acpi_ut_print_string(obj_desc->string.pointer,
394 ACPI_UINT8_MAX);
395 acpi_os_printf("\n");
396 break;
398 case ACPI_EXD_BUFFER:
400 ACPI_DUMP_BUFFER(obj_desc->buffer.pointer,
401 obj_desc->buffer.length);
402 break;
404 case ACPI_EXD_PACKAGE:
406 /* Dump the package contents */
408 acpi_os_printf("\nPackage Contents:\n");
409 acpi_ex_dump_package_obj(obj_desc, 0, 0);
410 break;
412 case ACPI_EXD_FIELD:
414 acpi_ex_dump_object(obj_desc,
415 acpi_ex_dump_field_common);
416 break;
418 case ACPI_EXD_REFERENCE:
420 acpi_ex_out_string("Class Name",
421 ACPI_CAST_PTR(char,
422 acpi_ut_get_reference_name
423 (obj_desc)));
424 acpi_ex_dump_reference_obj(obj_desc);
425 break;
427 default:
429 acpi_os_printf("**** Invalid table opcode [%X] ****\n",
430 info->opcode);
431 return;
434 info++;
435 count--;
439 /*******************************************************************************
441 * FUNCTION: acpi_ex_dump_operand
443 * PARAMETERS: *obj_desc - Pointer to entry to be dumped
444 * Depth - Current nesting depth
446 * RETURN: None
448 * DESCRIPTION: Dump an operand object
450 ******************************************************************************/
452 void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth)
454 u32 length;
455 u32 index;
457 ACPI_FUNCTION_NAME(ex_dump_operand)
459 if (!((ACPI_LV_EXEC & acpi_dbg_level)
460 && (_COMPONENT & acpi_dbg_layer))) {
461 return;
464 if (!obj_desc) {
466 /* This could be a null element of a package */
468 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Null Object Descriptor\n"));
469 return;
472 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_NAMED) {
473 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%p Namespace Node: ",
474 obj_desc));
475 ACPI_DUMP_ENTRY(obj_desc, ACPI_LV_EXEC);
476 return;
479 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) {
480 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
481 "%p is not a node or operand object: [%s]\n",
482 obj_desc,
483 acpi_ut_get_descriptor_name(obj_desc)));
484 ACPI_DUMP_BUFFER(obj_desc, sizeof(union acpi_operand_object));
485 return;
488 /* obj_desc is a valid object */
490 if (depth > 0) {
491 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%*s[%u] %p ",
492 depth, " ", depth, obj_desc));
493 } else {
494 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%p ", obj_desc));
497 /* Decode object type */
499 switch (obj_desc->common.type) {
500 case ACPI_TYPE_LOCAL_REFERENCE:
502 acpi_os_printf("Reference: [%s] ",
503 acpi_ut_get_reference_name(obj_desc));
505 switch (obj_desc->reference.class) {
506 case ACPI_REFCLASS_DEBUG:
508 acpi_os_printf("\n");
509 break;
511 case ACPI_REFCLASS_INDEX:
513 acpi_os_printf("%p\n", obj_desc->reference.object);
514 break;
516 case ACPI_REFCLASS_TABLE:
518 acpi_os_printf("Table Index %X\n",
519 obj_desc->reference.value);
520 break;
522 case ACPI_REFCLASS_REFOF:
524 acpi_os_printf("%p [%s]\n", obj_desc->reference.object,
525 acpi_ut_get_type_name(((union
526 acpi_operand_object
528 obj_desc->
529 reference.
530 object)->common.
531 type));
532 break;
534 case ACPI_REFCLASS_NAME:
536 acpi_os_printf("- [%4.4s]\n",
537 obj_desc->reference.node->name.ascii);
538 break;
540 case ACPI_REFCLASS_ARG:
541 case ACPI_REFCLASS_LOCAL:
543 acpi_os_printf("%X\n", obj_desc->reference.value);
544 break;
546 default: /* Unknown reference class */
548 acpi_os_printf("%2.2X\n", obj_desc->reference.class);
549 break;
551 break;
553 case ACPI_TYPE_BUFFER:
555 acpi_os_printf("Buffer length %.2X @ %p\n",
556 obj_desc->buffer.length,
557 obj_desc->buffer.pointer);
559 /* Debug only -- dump the buffer contents */
561 if (obj_desc->buffer.pointer) {
562 length = obj_desc->buffer.length;
563 if (length > 128) {
564 length = 128;
567 acpi_os_printf
568 ("Buffer Contents: (displaying length 0x%.2X)\n",
569 length);
570 ACPI_DUMP_BUFFER(obj_desc->buffer.pointer, length);
572 break;
574 case ACPI_TYPE_INTEGER:
576 acpi_os_printf("Integer %8.8X%8.8X\n",
577 ACPI_FORMAT_UINT64(obj_desc->integer.value));
578 break;
580 case ACPI_TYPE_PACKAGE:
582 acpi_os_printf("Package [Len %X] ElementArray %p\n",
583 obj_desc->package.count,
584 obj_desc->package.elements);
587 * If elements exist, package element pointer is valid,
588 * and debug_level exceeds 1, dump package's elements.
590 if (obj_desc->package.count &&
591 obj_desc->package.elements && acpi_dbg_level > 1) {
592 for (index = 0; index < obj_desc->package.count;
593 index++) {
594 acpi_ex_dump_operand(obj_desc->package.
595 elements[index],
596 depth + 1);
599 break;
601 case ACPI_TYPE_REGION:
603 acpi_os_printf("Region %s (%X)",
604 acpi_ut_get_region_name(obj_desc->region.
605 space_id),
606 obj_desc->region.space_id);
609 * If the address and length have not been evaluated,
610 * don't print them.
612 if (!(obj_desc->region.flags & AOPOBJ_DATA_VALID)) {
613 acpi_os_printf("\n");
614 } else {
615 acpi_os_printf(" base %8.8X%8.8X Length %X\n",
616 ACPI_FORMAT_NATIVE_UINT(obj_desc->region.
617 address),
618 obj_desc->region.length);
620 break;
622 case ACPI_TYPE_STRING:
624 acpi_os_printf("String length %X @ %p ",
625 obj_desc->string.length,
626 obj_desc->string.pointer);
628 acpi_ut_print_string(obj_desc->string.pointer, ACPI_UINT8_MAX);
629 acpi_os_printf("\n");
630 break;
632 case ACPI_TYPE_LOCAL_BANK_FIELD:
634 acpi_os_printf("BankField\n");
635 break;
637 case ACPI_TYPE_LOCAL_REGION_FIELD:
639 acpi_os_printf
640 ("RegionField: Bits=%X AccWidth=%X Lock=%X Update=%X at "
641 "byte=%X bit=%X of below:\n", obj_desc->field.bit_length,
642 obj_desc->field.access_byte_width,
643 obj_desc->field.field_flags & AML_FIELD_LOCK_RULE_MASK,
644 obj_desc->field.field_flags & AML_FIELD_UPDATE_RULE_MASK,
645 obj_desc->field.base_byte_offset,
646 obj_desc->field.start_field_bit_offset);
648 acpi_ex_dump_operand(obj_desc->field.region_obj, depth + 1);
649 break;
651 case ACPI_TYPE_LOCAL_INDEX_FIELD:
653 acpi_os_printf("IndexField\n");
654 break;
656 case ACPI_TYPE_BUFFER_FIELD:
658 acpi_os_printf("BufferField: %X bits at byte %X bit %X of\n",
659 obj_desc->buffer_field.bit_length,
660 obj_desc->buffer_field.base_byte_offset,
661 obj_desc->buffer_field.start_field_bit_offset);
663 if (!obj_desc->buffer_field.buffer_obj) {
664 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "*NULL*\n"));
665 } else if ((obj_desc->buffer_field.buffer_obj)->common.type !=
666 ACPI_TYPE_BUFFER) {
667 acpi_os_printf("*not a Buffer*\n");
668 } else {
669 acpi_ex_dump_operand(obj_desc->buffer_field.buffer_obj,
670 depth + 1);
672 break;
674 case ACPI_TYPE_EVENT:
676 acpi_os_printf("Event\n");
677 break;
679 case ACPI_TYPE_METHOD:
681 acpi_os_printf("Method(%X) @ %p:%X\n",
682 obj_desc->method.param_count,
683 obj_desc->method.aml_start,
684 obj_desc->method.aml_length);
685 break;
687 case ACPI_TYPE_MUTEX:
689 acpi_os_printf("Mutex\n");
690 break;
692 case ACPI_TYPE_DEVICE:
694 acpi_os_printf("Device\n");
695 break;
697 case ACPI_TYPE_POWER:
699 acpi_os_printf("Power\n");
700 break;
702 case ACPI_TYPE_PROCESSOR:
704 acpi_os_printf("Processor\n");
705 break;
707 case ACPI_TYPE_THERMAL:
709 acpi_os_printf("Thermal\n");
710 break;
712 default:
713 /* Unknown Type */
715 acpi_os_printf("Unknown Type %X\n", obj_desc->common.type);
716 break;
719 return;
722 /*******************************************************************************
724 * FUNCTION: acpi_ex_dump_operands
726 * PARAMETERS: Operands - A list of Operand objects
727 * opcode_name - AML opcode name
728 * num_operands - Operand count for this opcode
730 * DESCRIPTION: Dump the operands associated with the opcode
732 ******************************************************************************/
734 void
735 acpi_ex_dump_operands(union acpi_operand_object **operands,
736 const char *opcode_name, u32 num_operands)
738 ACPI_FUNCTION_NAME(ex_dump_operands);
740 if (!opcode_name) {
741 opcode_name = "UNKNOWN";
744 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
745 "**** Start operand dump for opcode [%s], %u operands\n",
746 opcode_name, num_operands));
748 if (num_operands == 0) {
749 num_operands = 1;
752 /* Dump the individual operands */
754 while (num_operands) {
755 acpi_ex_dump_operand(*operands, 0);
756 operands++;
757 num_operands--;
760 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
761 "**** End operand dump for [%s]\n", opcode_name));
762 return;
765 /*******************************************************************************
767 * FUNCTION: acpi_ex_out* functions
769 * PARAMETERS: Title - Descriptive text
770 * Value - Value to be displayed
772 * DESCRIPTION: Object dump output formatting functions. These functions
773 * reduce the number of format strings required and keeps them
774 * all in one place for easy modification.
776 ******************************************************************************/
778 static void acpi_ex_out_string(char *title, char *value)
780 acpi_os_printf("%20s : %s\n", title, value);
783 static void acpi_ex_out_pointer(char *title, void *value)
785 acpi_os_printf("%20s : %p\n", title, value);
788 /*******************************************************************************
790 * FUNCTION: acpi_ex_dump_namespace_node
792 * PARAMETERS: Node - Descriptor to dump
793 * Flags - Force display if TRUE
795 * DESCRIPTION: Dumps the members of the given.Node
797 ******************************************************************************/
799 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags)
802 ACPI_FUNCTION_ENTRY();
804 if (!flags) {
805 if (!((ACPI_LV_OBJECTS & acpi_dbg_level)
806 && (_COMPONENT & acpi_dbg_layer))) {
807 return;
811 acpi_os_printf("%20s : %4.4s\n", "Name", acpi_ut_get_node_name(node));
812 acpi_ex_out_string("Type", acpi_ut_get_type_name(node->type));
813 acpi_ex_out_pointer("Attached Object",
814 acpi_ns_get_attached_object(node));
815 acpi_ex_out_pointer("Parent", node->parent);
817 acpi_ex_dump_object(ACPI_CAST_PTR(union acpi_operand_object, node),
818 acpi_ex_dump_node);
821 /*******************************************************************************
823 * FUNCTION: acpi_ex_dump_reference_obj
825 * PARAMETERS: Object - Descriptor to dump
827 * DESCRIPTION: Dumps a reference object
829 ******************************************************************************/
831 static void acpi_ex_dump_reference_obj(union acpi_operand_object *obj_desc)
833 struct acpi_buffer ret_buf;
834 acpi_status status;
836 ret_buf.length = ACPI_ALLOCATE_LOCAL_BUFFER;
838 if (obj_desc->reference.class == ACPI_REFCLASS_NAME) {
839 acpi_os_printf(" %p ", obj_desc->reference.node);
841 status =
842 acpi_ns_handle_to_pathname(obj_desc->reference.node,
843 &ret_buf);
844 if (ACPI_FAILURE(status)) {
845 acpi_os_printf(" Could not convert name to pathname\n");
846 } else {
847 acpi_os_printf("%s\n", (char *)ret_buf.pointer);
848 ACPI_FREE(ret_buf.pointer);
850 } else if (obj_desc->reference.object) {
851 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) ==
852 ACPI_DESC_TYPE_OPERAND) {
853 acpi_os_printf(" Target: %p",
854 obj_desc->reference.object);
855 if (obj_desc->reference.class == ACPI_REFCLASS_TABLE) {
856 acpi_os_printf(" Table Index: %X\n",
857 obj_desc->reference.value);
858 } else {
859 acpi_os_printf(" Target: %p [%s]\n",
860 obj_desc->reference.object,
861 acpi_ut_get_type_name(((union
862 acpi_operand_object
864 obj_desc->
865 reference.
866 object)->
867 common.
868 type));
870 } else {
871 acpi_os_printf(" Target: %p\n",
872 obj_desc->reference.object);
877 /*******************************************************************************
879 * FUNCTION: acpi_ex_dump_package_obj
881 * PARAMETERS: obj_desc - Descriptor to dump
882 * Level - Indentation Level
883 * Index - Package index for this object
885 * DESCRIPTION: Dumps the elements of the package
887 ******************************************************************************/
889 static void
890 acpi_ex_dump_package_obj(union acpi_operand_object *obj_desc,
891 u32 level, u32 index)
893 u32 i;
895 /* Indentation and index output */
897 if (level > 0) {
898 for (i = 0; i < level; i++) {
899 acpi_os_printf(" ");
902 acpi_os_printf("[%.2d] ", index);
905 acpi_os_printf("%p ", obj_desc);
907 /* Null package elements are allowed */
909 if (!obj_desc) {
910 acpi_os_printf("[Null Object]\n");
911 return;
914 /* Packages may only contain a few object types */
916 switch (obj_desc->common.type) {
917 case ACPI_TYPE_INTEGER:
919 acpi_os_printf("[Integer] = %8.8X%8.8X\n",
920 ACPI_FORMAT_UINT64(obj_desc->integer.value));
921 break;
923 case ACPI_TYPE_STRING:
925 acpi_os_printf("[String] Value: ");
926 for (i = 0; i < obj_desc->string.length; i++) {
927 acpi_os_printf("%c", obj_desc->string.pointer[i]);
929 acpi_os_printf("\n");
930 break;
932 case ACPI_TYPE_BUFFER:
934 acpi_os_printf("[Buffer] Length %.2X = ",
935 obj_desc->buffer.length);
936 if (obj_desc->buffer.length) {
937 acpi_ut_dump_buffer(ACPI_CAST_PTR
938 (u8, obj_desc->buffer.pointer),
939 obj_desc->buffer.length,
940 DB_DWORD_DISPLAY, _COMPONENT);
941 } else {
942 acpi_os_printf("\n");
944 break;
946 case ACPI_TYPE_PACKAGE:
948 acpi_os_printf("[Package] Contains %u Elements:\n",
949 obj_desc->package.count);
951 for (i = 0; i < obj_desc->package.count; i++) {
952 acpi_ex_dump_package_obj(obj_desc->package.elements[i],
953 level + 1, i);
955 break;
957 case ACPI_TYPE_LOCAL_REFERENCE:
959 acpi_os_printf("[Object Reference] Type [%s] %2.2X",
960 acpi_ut_get_reference_name(obj_desc),
961 obj_desc->reference.class);
962 acpi_ex_dump_reference_obj(obj_desc);
963 break;
965 default:
967 acpi_os_printf("[Unknown Type] %X\n", obj_desc->common.type);
968 break;
972 /*******************************************************************************
974 * FUNCTION: acpi_ex_dump_object_descriptor
976 * PARAMETERS: obj_desc - Descriptor to dump
977 * Flags - Force display if TRUE
979 * DESCRIPTION: Dumps the members of the object descriptor given.
981 ******************************************************************************/
983 void
984 acpi_ex_dump_object_descriptor(union acpi_operand_object *obj_desc, u32 flags)
986 ACPI_FUNCTION_TRACE(ex_dump_object_descriptor);
988 if (!obj_desc) {
989 return_VOID;
992 if (!flags) {
993 if (!((ACPI_LV_OBJECTS & acpi_dbg_level)
994 && (_COMPONENT & acpi_dbg_layer))) {
995 return_VOID;
999 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_NAMED) {
1000 acpi_ex_dump_namespace_node((struct acpi_namespace_node *)
1001 obj_desc, flags);
1003 acpi_os_printf("\nAttached Object (%p):\n",
1004 ((struct acpi_namespace_node *)obj_desc)->
1005 object);
1007 acpi_ex_dump_object_descriptor(((struct acpi_namespace_node *)
1008 obj_desc)->object, flags);
1009 return_VOID;
1012 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) {
1013 acpi_os_printf
1014 ("ExDumpObjectDescriptor: %p is not an ACPI operand object: [%s]\n",
1015 obj_desc, acpi_ut_get_descriptor_name(obj_desc));
1016 return_VOID;
1019 if (obj_desc->common.type > ACPI_TYPE_NS_NODE_MAX) {
1020 return_VOID;
1023 /* Common Fields */
1025 acpi_ex_dump_object(obj_desc, acpi_ex_dump_common);
1027 /* Object-specific fields */
1029 acpi_ex_dump_object(obj_desc, acpi_ex_dump_info[obj_desc->common.type]);
1030 return_VOID;
1033 #endif