1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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>
47 #include <acpi/acoutput.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsdump")
52 /* Local prototypes */
53 #ifdef ACPI_OBSOLETE_FUNCTIONS
54 void acpi_ns_dump_root_devices(void);
57 acpi_ns_dump_one_device(acpi_handle obj_handle
,
58 u32 level
, void *context
, void **return_value
);
61 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
63 #ifdef ACPI_FUTURE_USAGE
65 acpi_ns_dump_one_object_path(acpi_handle obj_handle
,
66 u32 level
, void *context
, void **return_value
);
69 acpi_ns_get_max_depth(acpi_handle obj_handle
,
70 u32 level
, void *context
, void **return_value
);
71 #endif /* ACPI_FUTURE_USAGE */
73 /*******************************************************************************
75 * FUNCTION: acpi_ns_print_pathname
77 * PARAMETERS: num_segments - Number of ACPI name segments
78 * pathname - The compressed (internal) path
82 * DESCRIPTION: Print an object's full namespace pathname
84 ******************************************************************************/
86 void acpi_ns_print_pathname(u32 num_segments
, char *pathname
)
90 ACPI_FUNCTION_NAME(ns_print_pathname
);
92 /* Check if debug output enabled */
94 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_NAMES
, ACPI_NAMESPACE
)) {
98 /* Print the entire name */
100 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
, "["));
102 while (num_segments
) {
103 for (i
= 0; i
< 4; i
++) {
104 ACPI_IS_PRINT(pathname
[i
]) ?
105 acpi_os_printf("%c", pathname
[i
]) :
109 pathname
+= ACPI_NAME_SIZE
;
116 acpi_os_printf("]\n");
119 /*******************************************************************************
121 * FUNCTION: acpi_ns_dump_pathname
123 * PARAMETERS: handle - Object
124 * msg - Prefix message
125 * level - Desired debug level
126 * component - Caller's component ID
130 * DESCRIPTION: Print an object's full namespace pathname
131 * Manages allocation/freeing of a pathname buffer
133 ******************************************************************************/
136 acpi_ns_dump_pathname(acpi_handle handle
, char *msg
, u32 level
, u32 component
)
139 ACPI_FUNCTION_TRACE(ns_dump_pathname
);
141 /* Do this only if the requested debug level and component are enabled */
143 if (!ACPI_IS_DEBUG_ENABLED(level
, component
)) {
147 /* Convert handle to a full pathname and print it (with supplied message) */
149 acpi_ns_print_node_pathname(handle
, msg
);
150 acpi_os_printf("\n");
154 /*******************************************************************************
156 * FUNCTION: acpi_ns_dump_one_object
158 * PARAMETERS: obj_handle - Node to be dumped
159 * level - Nesting level of the handle
160 * context - Passed into walk_namespace
161 * return_value - Not used
165 * DESCRIPTION: Dump a single Node
166 * This procedure is a user_function called by acpi_ns_walk_namespace.
168 ******************************************************************************/
171 acpi_ns_dump_one_object(acpi_handle obj_handle
,
172 u32 level
, void *context
, void **return_value
)
174 struct acpi_walk_info
*info
= (struct acpi_walk_info
*)context
;
175 struct acpi_namespace_node
*this_node
;
176 union acpi_operand_object
*obj_desc
= NULL
;
177 acpi_object_type obj_type
;
178 acpi_object_type type
;
183 ACPI_FUNCTION_NAME(ns_dump_one_object
);
185 /* Is output enabled? */
187 if (!(acpi_dbg_level
& info
->debug_level
)) {
192 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Null object handle\n"));
196 this_node
= acpi_ns_validate_handle(obj_handle
);
198 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Invalid object handle %p\n",
203 type
= this_node
->type
;
205 /* Check if the owner matches */
207 if ((info
->owner_id
!= ACPI_OWNER_ID_MAX
) &&
208 (info
->owner_id
!= this_node
->owner_id
)) {
212 if (!(info
->display_type
& ACPI_DISPLAY_SHORT
)) {
214 /* Indent the object according to the level */
216 acpi_os_printf("%2d%*s", (u32
) level
- 1, (int)level
* 2, " ");
218 /* Check the node type and name */
220 if (type
> ACPI_TYPE_LOCAL_MAX
) {
221 ACPI_WARNING((AE_INFO
,
222 "Invalid ACPI Object Type 0x%08X", type
));
225 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node
));
228 /* Now we can print out the pertinent information */
230 acpi_os_printf(" %-12s %p %2.2X ",
231 acpi_ut_get_type_name(type
), this_node
,
232 this_node
->owner_id
);
234 dbg_level
= acpi_dbg_level
;
236 obj_desc
= acpi_ns_get_attached_object(this_node
);
237 acpi_dbg_level
= dbg_level
;
239 /* Temp nodes are those nodes created by a control method */
241 if (this_node
->flags
& ANOBJ_TEMPORARY
) {
242 acpi_os_printf("(T) ");
245 switch (info
->display_type
& ACPI_DISPLAY_MASK
) {
246 case ACPI_DISPLAY_SUMMARY
:
250 /* No attached object. Some types should always have an object */
253 case ACPI_TYPE_INTEGER
:
254 case ACPI_TYPE_PACKAGE
:
255 case ACPI_TYPE_BUFFER
:
256 case ACPI_TYPE_STRING
:
257 case ACPI_TYPE_METHOD
:
259 acpi_os_printf("<No attached object>");
267 acpi_os_printf("\n");
272 case ACPI_TYPE_PROCESSOR
:
274 acpi_os_printf("ID %02X Len %02X Addr %p\n",
275 obj_desc
->processor
.proc_id
,
276 obj_desc
->processor
.length
,
282 case ACPI_TYPE_DEVICE
:
284 acpi_os_printf("Notify Object: %p\n", obj_desc
);
287 case ACPI_TYPE_METHOD
:
289 acpi_os_printf("Args %X Len %.4X Aml %p\n",
290 (u32
) obj_desc
->method
.param_count
,
291 obj_desc
->method
.aml_length
,
292 obj_desc
->method
.aml_start
);
295 case ACPI_TYPE_INTEGER
:
297 acpi_os_printf("= %8.8X%8.8X\n",
298 ACPI_FORMAT_UINT64(obj_desc
->integer
.
302 case ACPI_TYPE_PACKAGE
:
304 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
305 acpi_os_printf("Elements %.2X\n",
306 obj_desc
->package
.count
);
308 acpi_os_printf("[Length not yet evaluated]\n");
312 case ACPI_TYPE_BUFFER
:
314 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
315 acpi_os_printf("Len %.2X",
316 obj_desc
->buffer
.length
);
318 /* Dump some of the buffer */
320 if (obj_desc
->buffer
.length
> 0) {
321 acpi_os_printf(" =");
323 (i
< obj_desc
->buffer
.length
325 acpi_os_printf(" %.2hX",
330 acpi_os_printf("\n");
332 acpi_os_printf("[Length not yet evaluated]\n");
336 case ACPI_TYPE_STRING
:
338 acpi_os_printf("Len %.2X ", obj_desc
->string
.length
);
339 acpi_ut_print_string(obj_desc
->string
.pointer
, 32);
340 acpi_os_printf("\n");
343 case ACPI_TYPE_REGION
:
345 acpi_os_printf("[%s]",
346 acpi_ut_get_region_name(obj_desc
->region
.
348 if (obj_desc
->region
.flags
& AOPOBJ_DATA_VALID
) {
349 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
350 ACPI_FORMAT_NATIVE_UINT
351 (obj_desc
->region
.address
),
352 obj_desc
->region
.length
);
355 (" [Address/Length not yet evaluated]\n");
359 case ACPI_TYPE_LOCAL_REFERENCE
:
361 acpi_os_printf("[%s]\n",
362 acpi_ut_get_reference_name(obj_desc
));
365 case ACPI_TYPE_BUFFER_FIELD
:
367 if (obj_desc
->buffer_field
.buffer_obj
&&
368 obj_desc
->buffer_field
.buffer_obj
->buffer
.node
) {
369 acpi_os_printf("Buf [%4.4s]",
370 acpi_ut_get_node_name(obj_desc
->
378 case ACPI_TYPE_LOCAL_REGION_FIELD
:
380 acpi_os_printf("Rgn [%4.4s]",
381 acpi_ut_get_node_name(obj_desc
->
387 case ACPI_TYPE_LOCAL_BANK_FIELD
:
389 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
390 acpi_ut_get_node_name(obj_desc
->
394 acpi_ut_get_node_name(obj_desc
->
401 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
403 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
404 acpi_ut_get_node_name(obj_desc
->
408 acpi_ut_get_node_name(obj_desc
->
415 case ACPI_TYPE_LOCAL_ALIAS
:
416 case ACPI_TYPE_LOCAL_METHOD_ALIAS
:
418 acpi_os_printf("Target %4.4s (%p)\n",
419 acpi_ut_get_node_name(obj_desc
),
425 acpi_os_printf("Object %p\n", obj_desc
);
429 /* Common field handling */
432 case ACPI_TYPE_BUFFER_FIELD
:
433 case ACPI_TYPE_LOCAL_REGION_FIELD
:
434 case ACPI_TYPE_LOCAL_BANK_FIELD
:
435 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
437 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
438 (obj_desc
->common_field
.
439 base_byte_offset
* 8)
441 obj_desc
->common_field
.
442 start_field_bit_offset
,
443 obj_desc
->common_field
.bit_length
,
444 obj_desc
->common_field
.
454 case ACPI_DISPLAY_OBJECTS
:
456 acpi_os_printf("O:%p", obj_desc
);
459 /* No attached object, we are done */
461 acpi_os_printf("\n");
465 acpi_os_printf("(R%u)", obj_desc
->common
.reference_count
);
468 case ACPI_TYPE_METHOD
:
470 /* Name is a Method and its AML offset/length are set */
472 acpi_os_printf(" M:%p-%X\n", obj_desc
->method
.aml_start
,
473 obj_desc
->method
.aml_length
);
476 case ACPI_TYPE_INTEGER
:
478 acpi_os_printf(" I:%8.8X8.8%X\n",
479 ACPI_FORMAT_UINT64(obj_desc
->integer
.
483 case ACPI_TYPE_STRING
:
485 acpi_os_printf(" S:%p-%X\n", obj_desc
->string
.pointer
,
486 obj_desc
->string
.length
);
489 case ACPI_TYPE_BUFFER
:
491 acpi_os_printf(" B:%p-%X\n", obj_desc
->buffer
.pointer
,
492 obj_desc
->buffer
.length
);
497 acpi_os_printf("\n");
503 acpi_os_printf("\n");
507 /* If debug turned off, done */
509 if (!(acpi_dbg_level
& ACPI_LV_VALUES
)) {
513 /* If there is an attached object, display it */
515 dbg_level
= acpi_dbg_level
;
517 obj_desc
= acpi_ns_get_attached_object(this_node
);
518 acpi_dbg_level
= dbg_level
;
520 /* Dump attached objects */
523 obj_type
= ACPI_TYPE_INVALID
;
524 acpi_os_printf("Attached Object %p: ", obj_desc
);
526 /* Decode the type of attached object and dump the contents */
528 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
)) {
529 case ACPI_DESC_TYPE_NAMED
:
531 acpi_os_printf("(Ptr to Node)\n");
532 bytes_to_dump
= sizeof(struct acpi_namespace_node
);
533 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
536 case ACPI_DESC_TYPE_OPERAND
:
538 obj_type
= obj_desc
->common
.type
;
540 if (obj_type
> ACPI_TYPE_LOCAL_MAX
) {
542 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
547 ("(Pointer to ACPI Object type %.2X [%s])\n",
548 obj_type
, acpi_ut_get_type_name(obj_type
));
550 sizeof(union acpi_operand_object
);
553 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
561 /* If value is NOT an internal object, we are done */
563 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
) !=
564 ACPI_DESC_TYPE_OPERAND
) {
568 /* Valid object, get the pointer to next level, if any */
571 case ACPI_TYPE_BUFFER
:
572 case ACPI_TYPE_STRING
:
574 * NOTE: takes advantage of common fields between string/buffer
576 bytes_to_dump
= obj_desc
->string
.length
;
577 obj_desc
= (void *)obj_desc
->string
.pointer
;
578 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
579 obj_desc
, bytes_to_dump
);
580 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
583 case ACPI_TYPE_BUFFER_FIELD
:
586 (union acpi_operand_object
*)obj_desc
->buffer_field
.
590 case ACPI_TYPE_PACKAGE
:
592 obj_desc
= (void *)obj_desc
->package
.elements
;
595 case ACPI_TYPE_METHOD
:
597 obj_desc
= (void *)obj_desc
->method
.aml_start
;
600 case ACPI_TYPE_LOCAL_REGION_FIELD
:
602 obj_desc
= (void *)obj_desc
->field
.region_obj
;
605 case ACPI_TYPE_LOCAL_BANK_FIELD
:
607 obj_desc
= (void *)obj_desc
->bank_field
.region_obj
;
610 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
612 obj_desc
= (void *)obj_desc
->index_field
.index_obj
;
620 obj_type
= ACPI_TYPE_INVALID
; /* Terminate loop after next pass */
624 acpi_os_printf("\n");
628 #ifdef ACPI_FUTURE_USAGE
629 /*******************************************************************************
631 * FUNCTION: acpi_ns_dump_objects
633 * PARAMETERS: type - Object type to be dumped
634 * display_type - 0 or ACPI_DISPLAY_SUMMARY
635 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
636 * for an effectively unlimited depth.
637 * owner_id - Dump only objects owned by this ID. Use
638 * ACPI_UINT32_MAX to match all owners.
639 * start_handle - Where in namespace to start/end search
643 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses
644 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
646 ******************************************************************************/
649 acpi_ns_dump_objects(acpi_object_type type
,
652 acpi_owner_id owner_id
, acpi_handle start_handle
)
654 struct acpi_walk_info info
;
657 ACPI_FUNCTION_ENTRY();
660 * Just lock the entire namespace for the duration of the dump.
661 * We don't want any changes to the namespace during this time,
662 * especially the temporary nodes since we are going to display
665 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
666 if (ACPI_FAILURE(status
)) {
667 acpi_os_printf("Could not acquire namespace mutex\n");
671 info
.debug_level
= ACPI_LV_TABLES
;
672 info
.owner_id
= owner_id
;
673 info
.display_type
= display_type
;
675 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
676 ACPI_NS_WALK_NO_UNLOCK
|
677 ACPI_NS_WALK_TEMP_NODES
,
678 acpi_ns_dump_one_object
, NULL
,
679 (void *)&info
, NULL
);
681 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
683 #endif /* ACPI_FUTURE_USAGE */
685 #ifdef ACPI_FUTURE_USAGE
686 /*******************************************************************************
688 * FUNCTION: acpi_ns_dump_one_object_path, acpi_ns_get_max_depth
690 * PARAMETERS: obj_handle - Node to be dumped
691 * level - Nesting level of the handle
692 * context - Passed into walk_namespace
693 * return_value - Not used
697 * DESCRIPTION: Dump the full pathname to a namespace object. acp_ns_get_max_depth
698 * computes the maximum nesting depth in the namespace tree, in
699 * order to simplify formatting in acpi_ns_dump_one_object_path.
700 * These procedures are user_functions called by acpi_ns_walk_namespace.
702 ******************************************************************************/
705 acpi_ns_dump_one_object_path(acpi_handle obj_handle
,
706 u32 level
, void *context
, void **return_value
)
708 u32 max_level
= *((u32
*)context
);
710 struct acpi_namespace_node
*node
;
717 node
= acpi_ns_validate_handle(obj_handle
);
720 /* Ignore bad node during namespace walk */
725 pathname
= acpi_ns_get_external_pathname(node
);
728 if (level
<= max_level
) {
729 path_indent
= max_level
- level
+ 1;
732 acpi_os_printf("%2d%*s%-12s%*s",
733 level
, level
, " ", acpi_ut_get_type_name(node
->type
),
736 acpi_os_printf("%s\n", &pathname
[1]);
742 acpi_ns_get_max_depth(acpi_handle obj_handle
,
743 u32 level
, void *context
, void **return_value
)
745 u32
*max_level
= (u32
*)context
;
747 if (level
> *max_level
) {
753 /*******************************************************************************
755 * FUNCTION: acpi_ns_dump_object_paths
757 * PARAMETERS: type - Object type to be dumped
758 * display_type - 0 or ACPI_DISPLAY_SUMMARY
759 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
760 * for an effectively unlimited depth.
761 * owner_id - Dump only objects owned by this ID. Use
762 * ACPI_UINT32_MAX to match all owners.
763 * start_handle - Where in namespace to start/end search
767 * DESCRIPTION: Dump full object pathnames within the loaded namespace. Uses
768 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object_path.
770 ******************************************************************************/
773 acpi_ns_dump_object_paths(acpi_object_type type
,
776 acpi_owner_id owner_id
, acpi_handle start_handle
)
781 ACPI_FUNCTION_ENTRY();
784 * Just lock the entire namespace for the duration of the dump.
785 * We don't want any changes to the namespace during this time,
786 * especially the temporary nodes since we are going to display
789 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
790 if (ACPI_FAILURE(status
)) {
791 acpi_os_printf("Could not acquire namespace mutex\n");
795 /* Get the max depth of the namespace tree, for formatting later */
797 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
798 ACPI_NS_WALK_NO_UNLOCK
|
799 ACPI_NS_WALK_TEMP_NODES
,
800 acpi_ns_get_max_depth
, NULL
,
801 (void *)&max_level
, NULL
);
803 /* Now dump the entire namespace */
805 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
806 ACPI_NS_WALK_NO_UNLOCK
|
807 ACPI_NS_WALK_TEMP_NODES
,
808 acpi_ns_dump_one_object_path
, NULL
,
809 (void *)&max_level
, NULL
);
811 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
813 #endif /* ACPI_FUTURE_USAGE */
815 /*******************************************************************************
817 * FUNCTION: acpi_ns_dump_entry
819 * PARAMETERS: handle - Node to be dumped
820 * debug_level - Output level
824 * DESCRIPTION: Dump a single Node
826 ******************************************************************************/
828 void acpi_ns_dump_entry(acpi_handle handle
, u32 debug_level
)
830 struct acpi_walk_info info
;
832 ACPI_FUNCTION_ENTRY();
834 info
.debug_level
= debug_level
;
835 info
.owner_id
= ACPI_OWNER_ID_MAX
;
836 info
.display_type
= ACPI_DISPLAY_SUMMARY
;
838 (void)acpi_ns_dump_one_object(handle
, 1, &info
, NULL
);
841 #ifdef ACPI_ASL_COMPILER
842 /*******************************************************************************
844 * FUNCTION: acpi_ns_dump_tables
846 * PARAMETERS: search_base - Root of subtree to be dumped, or
847 * NS_ALL to dump the entire namespace
848 * max_depth - Maximum depth of dump. Use INT_MAX
849 * for an effectively unlimited depth.
853 * DESCRIPTION: Dump the name space, or a portion of it.
855 ******************************************************************************/
857 void acpi_ns_dump_tables(acpi_handle search_base
, u32 max_depth
)
859 acpi_handle search_handle
= search_base
;
861 ACPI_FUNCTION_TRACE(ns_dump_tables
);
863 if (!acpi_gbl_root_node
) {
865 * If the name space has not been initialized,
866 * there is nothing to dump.
868 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
,
869 "namespace not initialized!\n"));
873 if (ACPI_NS_ALL
== search_base
) {
875 /* Entire namespace */
877 search_handle
= acpi_gbl_root_node
;
878 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
, "\\\n"));
881 acpi_ns_dump_objects(ACPI_TYPE_ANY
, ACPI_DISPLAY_OBJECTS
, max_depth
,
882 ACPI_OWNER_ID_MAX
, search_handle
);