1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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_NAMESPACE
49 ACPI_MODULE_NAME("nsdump")
51 /* Local prototypes */
52 #ifdef ACPI_OBSOLETE_FUNCTIONS
53 void acpi_ns_dump_root_devices(void);
56 acpi_ns_dump_one_device(acpi_handle obj_handle,
57 u32 level, void *context, void **return_value);
60 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
61 /*******************************************************************************
63 * FUNCTION: acpi_ns_print_pathname
65 * PARAMETERS: num_segments - Number of ACPI name segments
66 * Pathname - The compressed (internal) path
70 * DESCRIPTION: Print an object's full namespace pathname
72 ******************************************************************************/
74 void acpi_ns_print_pathname(u32 num_segments, char *pathname)
78 ACPI_FUNCTION_NAME(ns_print_pathname);
80 if (!(acpi_dbg_level & ACPI_LV_NAMES)
81 || !(acpi_dbg_layer & ACPI_NAMESPACE)) {
85 /* Print the entire name */
87 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "["));
89 while (num_segments) {
90 for (i = 0; i < 4; i++) {
91 ACPI_IS_PRINT(pathname[i]) ?
92 acpi_os_printf("%c", pathname[i]) :
96 pathname += ACPI_NAME_SIZE;
103 acpi_os_printf("]\n");
106 /*******************************************************************************
108 * FUNCTION: acpi_ns_dump_pathname
110 * PARAMETERS: Handle - Object
111 * Msg - Prefix message
112 * Level - Desired debug level
113 * Component - Caller's component ID
117 * DESCRIPTION: Print an object's full namespace pathname
118 * Manages allocation/freeing of a pathname buffer
120 ******************************************************************************/
123 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component)
126 ACPI_FUNCTION_TRACE(ns_dump_pathname);
128 /* Do this only if the requested debug level and component are enabled */
130 if (!(acpi_dbg_level & level) || !(acpi_dbg_layer & component)) {
134 /* Convert handle to a full pathname and print it (with supplied message) */
136 acpi_ns_print_node_pathname(handle, msg);
137 acpi_os_printf("\n");
141 /*******************************************************************************
143 * FUNCTION: acpi_ns_dump_one_object
145 * PARAMETERS: obj_handle - Node to be dumped
146 * Level - Nesting level of the handle
147 * Context - Passed into walk_namespace
148 * return_value - Not used
152 * DESCRIPTION: Dump a single Node
153 * This procedure is a user_function called by acpi_ns_walk_namespace.
155 ******************************************************************************/
158 acpi_ns_dump_one_object(acpi_handle obj_handle,
159 u32 level, void *context, void **return_value)
161 struct acpi_walk_info *info = (struct acpi_walk_info *)context;
162 struct acpi_namespace_node *this_node;
163 union acpi_operand_object *obj_desc = NULL;
164 acpi_object_type obj_type;
165 acpi_object_type type;
170 ACPI_FUNCTION_NAME(ns_dump_one_object);
172 /* Is output enabled? */
174 if (!(acpi_dbg_level & info->debug_level)) {
179 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Null object handle\n"));
183 this_node = acpi_ns_map_handle_to_node(obj_handle);
185 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Invalid object handle %p\n",
190 type = this_node->type;
192 /* Check if the owner matches */
194 if ((info->owner_id != ACPI_OWNER_ID_MAX) &&
195 (info->owner_id != this_node->owner_id)) {
199 if (!(info->display_type & ACPI_DISPLAY_SHORT)) {
201 /* Indent the object according to the level */
203 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " ");
205 /* Check the node type and name */
207 if (type > ACPI_TYPE_LOCAL_MAX) {
208 ACPI_WARNING((AE_INFO, "Invalid ACPI Object Type %08X",
212 if (!acpi_ut_valid_acpi_name(this_node->name.integer)) {
213 this_node->name.integer =
214 acpi_ut_repair_name(this_node->name.ascii);
216 ACPI_WARNING((AE_INFO, "Invalid ACPI Name %08X",
217 this_node->name.integer));
220 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
224 * Now we can print out the pertinent information
226 acpi_os_printf(" %-12s %p %2.2X ",
227 acpi_ut_get_type_name(type), this_node,
228 this_node->owner_id);
230 dbg_level = acpi_dbg_level;
232 obj_desc = acpi_ns_get_attached_object(this_node);
233 acpi_dbg_level = dbg_level;
235 /* Temp nodes are those nodes created by a control method */
237 if (this_node->flags & ANOBJ_TEMPORARY) {
238 acpi_os_printf("(T) ");
241 switch (info->display_type & ACPI_DISPLAY_MASK) {
242 case ACPI_DISPLAY_SUMMARY:
246 /* No attached object, we are done */
248 acpi_os_printf("\n");
253 case ACPI_TYPE_PROCESSOR:
255 acpi_os_printf("ID %X Len %.4X Addr %p\n",
256 obj_desc->processor.proc_id,
257 obj_desc->processor.length,
263 case ACPI_TYPE_DEVICE:
265 acpi_os_printf("Notify Object: %p\n", obj_desc);
268 case ACPI_TYPE_METHOD:
270 acpi_os_printf("Args %X Len %.4X Aml %p\n",
271 (u32) obj_desc->method.param_count,
272 obj_desc->method.aml_length,
273 obj_desc->method.aml_start);
276 case ACPI_TYPE_INTEGER:
278 acpi_os_printf("= %8.8X%8.8X\n",
279 ACPI_FORMAT_UINT64(obj_desc->integer.
283 case ACPI_TYPE_PACKAGE:
285 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
286 acpi_os_printf("Elements %.2X\n",
287 obj_desc->package.count);
289 acpi_os_printf("[Length not yet evaluated]\n");
293 case ACPI_TYPE_BUFFER:
295 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
296 acpi_os_printf("Len %.2X",
297 obj_desc->buffer.length);
299 /* Dump some of the buffer */
301 if (obj_desc->buffer.length > 0) {
302 acpi_os_printf(" =");
304 (i < obj_desc->buffer.length
306 acpi_os_printf(" %.2hX",
311 acpi_os_printf("\n");
313 acpi_os_printf("[Length not yet evaluated]\n");
317 case ACPI_TYPE_STRING:
319 acpi_os_printf("Len %.2X ", obj_desc->string.length);
320 acpi_ut_print_string(obj_desc->string.pointer, 32);
321 acpi_os_printf("\n");
324 case ACPI_TYPE_REGION:
326 acpi_os_printf("[%s]",
327 acpi_ut_get_region_name(obj_desc->region.
329 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
330 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
331 ACPI_FORMAT_NATIVE_UINT
332 (obj_desc->region.address),
333 obj_desc->region.length);
336 (" [Address/Length not yet evaluated]\n");
340 case ACPI_TYPE_LOCAL_REFERENCE:
342 acpi_os_printf("[%s]\n",
343 acpi_ut_get_reference_name(obj_desc));
346 case ACPI_TYPE_BUFFER_FIELD:
348 if (obj_desc->buffer_field.buffer_obj &&
349 obj_desc->buffer_field.buffer_obj->buffer.node) {
350 acpi_os_printf("Buf [%4.4s]",
351 acpi_ut_get_node_name(obj_desc->
359 case ACPI_TYPE_LOCAL_REGION_FIELD:
361 acpi_os_printf("Rgn [%4.4s]",
362 acpi_ut_get_node_name(obj_desc->
368 case ACPI_TYPE_LOCAL_BANK_FIELD:
370 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
371 acpi_ut_get_node_name(obj_desc->
375 acpi_ut_get_node_name(obj_desc->
382 case ACPI_TYPE_LOCAL_INDEX_FIELD:
384 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
385 acpi_ut_get_node_name(obj_desc->
389 acpi_ut_get_node_name(obj_desc->
396 case ACPI_TYPE_LOCAL_ALIAS:
397 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
399 acpi_os_printf("Target %4.4s (%p)\n",
400 acpi_ut_get_node_name(obj_desc),
406 acpi_os_printf("Object %p\n", obj_desc);
410 /* Common field handling */
413 case ACPI_TYPE_BUFFER_FIELD:
414 case ACPI_TYPE_LOCAL_REGION_FIELD:
415 case ACPI_TYPE_LOCAL_BANK_FIELD:
416 case ACPI_TYPE_LOCAL_INDEX_FIELD:
418 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
419 (obj_desc->common_field.
420 base_byte_offset * 8)
422 obj_desc->common_field.
423 start_field_bit_offset,
424 obj_desc->common_field.bit_length,
425 obj_desc->common_field.
434 case ACPI_DISPLAY_OBJECTS:
436 acpi_os_printf("O:%p", obj_desc);
439 /* No attached object, we are done */
441 acpi_os_printf("\n");
445 acpi_os_printf("(R%d)", obj_desc->common.reference_count);
448 case ACPI_TYPE_METHOD:
450 /* Name is a Method and its AML offset/length are set */
452 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
453 obj_desc->method.aml_length);
456 case ACPI_TYPE_INTEGER:
458 acpi_os_printf(" I:%8.8X8.8%X\n",
459 ACPI_FORMAT_UINT64(obj_desc->integer.
463 case ACPI_TYPE_STRING:
465 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
466 obj_desc->string.length);
469 case ACPI_TYPE_BUFFER:
471 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
472 obj_desc->buffer.length);
477 acpi_os_printf("\n");
483 acpi_os_printf("\n");
487 /* If debug turned off, done */
489 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
493 /* If there is an attached object, display it */
495 dbg_level = acpi_dbg_level;
497 obj_desc = acpi_ns_get_attached_object(this_node);
498 acpi_dbg_level = dbg_level;
500 /* Dump attached objects */
503 obj_type = ACPI_TYPE_INVALID;
504 acpi_os_printf("Attached Object %p: ", obj_desc);
506 /* Decode the type of attached object and dump the contents */
508 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
509 case ACPI_DESC_TYPE_NAMED:
511 acpi_os_printf("(Ptr to Node)\n");
512 bytes_to_dump = sizeof(struct acpi_namespace_node);
513 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
516 case ACPI_DESC_TYPE_OPERAND:
518 obj_type = obj_desc->common.type;
520 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
522 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
527 ("(Pointer to ACPI Object type %.2X [%s])\n",
528 obj_type, acpi_ut_get_type_name(obj_type));
530 sizeof(union acpi_operand_object);
533 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
541 /* If value is NOT an internal object, we are done */
543 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
544 ACPI_DESC_TYPE_OPERAND) {
549 * Valid object, get the pointer to next level, if any
552 case ACPI_TYPE_BUFFER:
553 case ACPI_TYPE_STRING:
555 * NOTE: takes advantage of common fields between string/buffer
557 bytes_to_dump = obj_desc->string.length;
558 obj_desc = (void *)obj_desc->string.pointer;
559 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
560 obj_desc, bytes_to_dump);
561 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
564 case ACPI_TYPE_BUFFER_FIELD:
566 (union acpi_operand_object *)obj_desc->buffer_field.
570 case ACPI_TYPE_PACKAGE:
571 obj_desc = (void *)obj_desc->package.elements;
574 case ACPI_TYPE_METHOD:
575 obj_desc = (void *)obj_desc->method.aml_start;
578 case ACPI_TYPE_LOCAL_REGION_FIELD:
579 obj_desc = (void *)obj_desc->field.region_obj;
582 case ACPI_TYPE_LOCAL_BANK_FIELD:
583 obj_desc = (void *)obj_desc->bank_field.region_obj;
586 case ACPI_TYPE_LOCAL_INDEX_FIELD:
587 obj_desc = (void *)obj_desc->index_field.index_obj;
594 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
598 acpi_os_printf("\n");
602 #ifdef ACPI_FUTURE_USAGE
603 /*******************************************************************************
605 * FUNCTION: acpi_ns_dump_objects
607 * PARAMETERS: Type - Object type to be dumped
608 * display_type - 0 or ACPI_DISPLAY_SUMMARY
609 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
610 * for an effectively unlimited depth.
611 * owner_id - Dump only objects owned by this ID. Use
612 * ACPI_UINT32_MAX to match all owners.
613 * start_handle - Where in namespace to start/end search
617 * DESCRIPTION: Dump typed objects within the loaded namespace.
618 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
620 ******************************************************************************/
623 acpi_ns_dump_objects(acpi_object_type type,
626 acpi_owner_id owner_id, acpi_handle start_handle)
628 struct acpi_walk_info info;
630 ACPI_FUNCTION_ENTRY();
632 info.debug_level = ACPI_LV_TABLES;
633 info.owner_id = owner_id;
634 info.display_type = display_type;
636 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
637 ACPI_NS_WALK_NO_UNLOCK |
638 ACPI_NS_WALK_TEMP_NODES,
639 acpi_ns_dump_one_object, (void *)&info,
642 #endif /* ACPI_FUTURE_USAGE */
644 /*******************************************************************************
646 * FUNCTION: acpi_ns_dump_entry
648 * PARAMETERS: Handle - Node to be dumped
649 * debug_level - Output level
653 * DESCRIPTION: Dump a single Node
655 ******************************************************************************/
657 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
659 struct acpi_walk_info info;
661 ACPI_FUNCTION_ENTRY();
663 info.debug_level = debug_level;
664 info.owner_id = ACPI_OWNER_ID_MAX;
665 info.display_type = ACPI_DISPLAY_SUMMARY;
667 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
670 #ifdef ACPI_ASL_COMPILER
671 /*******************************************************************************
673 * FUNCTION: acpi_ns_dump_tables
675 * PARAMETERS: search_base - Root of subtree to be dumped, or
676 * NS_ALL to dump the entire namespace
677 * max_depth - Maximum depth of dump. Use INT_MAX
678 * for an effectively unlimited depth.
682 * DESCRIPTION: Dump the name space, or a portion of it.
684 ******************************************************************************/
686 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
688 acpi_handle search_handle = search_base;
690 ACPI_FUNCTION_TRACE(ns_dump_tables);
692 if (!acpi_gbl_root_node) {
694 * If the name space has not been initialized,
695 * there is nothing to dump.
697 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
698 "namespace not initialized!\n"));
702 if (ACPI_NS_ALL == search_base) {
704 /* Entire namespace */
706 search_handle = acpi_gbl_root_node;
707 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
710 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
711 ACPI_OWNER_ID_MAX, search_handle);
714 #endif /* _ACPI_ASL_COMPILER */
715 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */