1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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_validate_handle(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
,
209 "Invalid ACPI Object Type 0x%08X", type
));
212 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node
));
215 /* Now we can print out the pertinent information */
217 acpi_os_printf(" %-12s %p %2.2X ",
218 acpi_ut_get_type_name(type
), this_node
,
219 this_node
->owner_id
);
221 dbg_level
= acpi_dbg_level
;
223 obj_desc
= acpi_ns_get_attached_object(this_node
);
224 acpi_dbg_level
= dbg_level
;
226 /* Temp nodes are those nodes created by a control method */
228 if (this_node
->flags
& ANOBJ_TEMPORARY
) {
229 acpi_os_printf("(T) ");
232 switch (info
->display_type
& ACPI_DISPLAY_MASK
) {
233 case ACPI_DISPLAY_SUMMARY
:
237 /* No attached object. Some types should always have an object */
240 case ACPI_TYPE_INTEGER
:
241 case ACPI_TYPE_PACKAGE
:
242 case ACPI_TYPE_BUFFER
:
243 case ACPI_TYPE_STRING
:
244 case ACPI_TYPE_METHOD
:
245 acpi_os_printf("<No attached object>");
252 acpi_os_printf("\n");
257 case ACPI_TYPE_PROCESSOR
:
259 acpi_os_printf("ID %02X Len %02X Addr %p\n",
260 obj_desc
->processor
.proc_id
,
261 obj_desc
->processor
.length
,
267 case ACPI_TYPE_DEVICE
:
269 acpi_os_printf("Notify Object: %p\n", obj_desc
);
272 case ACPI_TYPE_METHOD
:
274 acpi_os_printf("Args %X Len %.4X Aml %p\n",
275 (u32
) obj_desc
->method
.param_count
,
276 obj_desc
->method
.aml_length
,
277 obj_desc
->method
.aml_start
);
280 case ACPI_TYPE_INTEGER
:
282 acpi_os_printf("= %8.8X%8.8X\n",
283 ACPI_FORMAT_UINT64(obj_desc
->integer
.
287 case ACPI_TYPE_PACKAGE
:
289 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
290 acpi_os_printf("Elements %.2X\n",
291 obj_desc
->package
.count
);
293 acpi_os_printf("[Length not yet evaluated]\n");
297 case ACPI_TYPE_BUFFER
:
299 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
300 acpi_os_printf("Len %.2X",
301 obj_desc
->buffer
.length
);
303 /* Dump some of the buffer */
305 if (obj_desc
->buffer
.length
> 0) {
306 acpi_os_printf(" =");
308 (i
< obj_desc
->buffer
.length
310 acpi_os_printf(" %.2hX",
315 acpi_os_printf("\n");
317 acpi_os_printf("[Length not yet evaluated]\n");
321 case ACPI_TYPE_STRING
:
323 acpi_os_printf("Len %.2X ", obj_desc
->string
.length
);
324 acpi_ut_print_string(obj_desc
->string
.pointer
, 32);
325 acpi_os_printf("\n");
328 case ACPI_TYPE_REGION
:
330 acpi_os_printf("[%s]",
331 acpi_ut_get_region_name(obj_desc
->region
.
333 if (obj_desc
->region
.flags
& AOPOBJ_DATA_VALID
) {
334 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
335 ACPI_FORMAT_NATIVE_UINT
336 (obj_desc
->region
.address
),
337 obj_desc
->region
.length
);
340 (" [Address/Length not yet evaluated]\n");
344 case ACPI_TYPE_LOCAL_REFERENCE
:
346 acpi_os_printf("[%s]\n",
347 acpi_ut_get_reference_name(obj_desc
));
350 case ACPI_TYPE_BUFFER_FIELD
:
352 if (obj_desc
->buffer_field
.buffer_obj
&&
353 obj_desc
->buffer_field
.buffer_obj
->buffer
.node
) {
354 acpi_os_printf("Buf [%4.4s]",
355 acpi_ut_get_node_name(obj_desc
->
363 case ACPI_TYPE_LOCAL_REGION_FIELD
:
365 acpi_os_printf("Rgn [%4.4s]",
366 acpi_ut_get_node_name(obj_desc
->
372 case ACPI_TYPE_LOCAL_BANK_FIELD
:
374 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
375 acpi_ut_get_node_name(obj_desc
->
379 acpi_ut_get_node_name(obj_desc
->
386 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
388 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
389 acpi_ut_get_node_name(obj_desc
->
393 acpi_ut_get_node_name(obj_desc
->
400 case ACPI_TYPE_LOCAL_ALIAS
:
401 case ACPI_TYPE_LOCAL_METHOD_ALIAS
:
403 acpi_os_printf("Target %4.4s (%p)\n",
404 acpi_ut_get_node_name(obj_desc
),
410 acpi_os_printf("Object %p\n", obj_desc
);
414 /* Common field handling */
417 case ACPI_TYPE_BUFFER_FIELD
:
418 case ACPI_TYPE_LOCAL_REGION_FIELD
:
419 case ACPI_TYPE_LOCAL_BANK_FIELD
:
420 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
422 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
423 (obj_desc
->common_field
.
424 base_byte_offset
* 8)
426 obj_desc
->common_field
.
427 start_field_bit_offset
,
428 obj_desc
->common_field
.bit_length
,
429 obj_desc
->common_field
.
438 case ACPI_DISPLAY_OBJECTS
:
440 acpi_os_printf("O:%p", obj_desc
);
443 /* No attached object, we are done */
445 acpi_os_printf("\n");
449 acpi_os_printf("(R%u)", obj_desc
->common
.reference_count
);
452 case ACPI_TYPE_METHOD
:
454 /* Name is a Method and its AML offset/length are set */
456 acpi_os_printf(" M:%p-%X\n", obj_desc
->method
.aml_start
,
457 obj_desc
->method
.aml_length
);
460 case ACPI_TYPE_INTEGER
:
462 acpi_os_printf(" I:%8.8X8.8%X\n",
463 ACPI_FORMAT_UINT64(obj_desc
->integer
.
467 case ACPI_TYPE_STRING
:
469 acpi_os_printf(" S:%p-%X\n", obj_desc
->string
.pointer
,
470 obj_desc
->string
.length
);
473 case ACPI_TYPE_BUFFER
:
475 acpi_os_printf(" B:%p-%X\n", obj_desc
->buffer
.pointer
,
476 obj_desc
->buffer
.length
);
481 acpi_os_printf("\n");
487 acpi_os_printf("\n");
491 /* If debug turned off, done */
493 if (!(acpi_dbg_level
& ACPI_LV_VALUES
)) {
497 /* If there is an attached object, display it */
499 dbg_level
= acpi_dbg_level
;
501 obj_desc
= acpi_ns_get_attached_object(this_node
);
502 acpi_dbg_level
= dbg_level
;
504 /* Dump attached objects */
507 obj_type
= ACPI_TYPE_INVALID
;
508 acpi_os_printf("Attached Object %p: ", obj_desc
);
510 /* Decode the type of attached object and dump the contents */
512 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
)) {
513 case ACPI_DESC_TYPE_NAMED
:
515 acpi_os_printf("(Ptr to Node)\n");
516 bytes_to_dump
= sizeof(struct acpi_namespace_node
);
517 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
520 case ACPI_DESC_TYPE_OPERAND
:
522 obj_type
= obj_desc
->common
.type
;
524 if (obj_type
> ACPI_TYPE_LOCAL_MAX
) {
526 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
531 ("(Pointer to ACPI Object type %.2X [%s])\n",
532 obj_type
, acpi_ut_get_type_name(obj_type
));
534 sizeof(union acpi_operand_object
);
537 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
545 /* If value is NOT an internal object, we are done */
547 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
) !=
548 ACPI_DESC_TYPE_OPERAND
) {
552 /* Valid object, get the pointer to next level, if any */
555 case ACPI_TYPE_BUFFER
:
556 case ACPI_TYPE_STRING
:
558 * NOTE: takes advantage of common fields between string/buffer
560 bytes_to_dump
= obj_desc
->string
.length
;
561 obj_desc
= (void *)obj_desc
->string
.pointer
;
562 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
563 obj_desc
, bytes_to_dump
);
564 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
567 case ACPI_TYPE_BUFFER_FIELD
:
569 (union acpi_operand_object
*)obj_desc
->buffer_field
.
573 case ACPI_TYPE_PACKAGE
:
574 obj_desc
= (void *)obj_desc
->package
.elements
;
577 case ACPI_TYPE_METHOD
:
578 obj_desc
= (void *)obj_desc
->method
.aml_start
;
581 case ACPI_TYPE_LOCAL_REGION_FIELD
:
582 obj_desc
= (void *)obj_desc
->field
.region_obj
;
585 case ACPI_TYPE_LOCAL_BANK_FIELD
:
586 obj_desc
= (void *)obj_desc
->bank_field
.region_obj
;
589 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
590 obj_desc
= (void *)obj_desc
->index_field
.index_obj
;
597 obj_type
= ACPI_TYPE_INVALID
; /* Terminate loop after next pass */
601 acpi_os_printf("\n");
605 #ifdef ACPI_FUTURE_USAGE
606 /*******************************************************************************
608 * FUNCTION: acpi_ns_dump_objects
610 * PARAMETERS: type - Object type to be dumped
611 * display_type - 0 or ACPI_DISPLAY_SUMMARY
612 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
613 * for an effectively unlimited depth.
614 * owner_id - Dump only objects owned by this ID. Use
615 * ACPI_UINT32_MAX to match all owners.
616 * start_handle - Where in namespace to start/end search
620 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses
621 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
623 ******************************************************************************/
626 acpi_ns_dump_objects(acpi_object_type type
,
629 acpi_owner_id owner_id
, acpi_handle start_handle
)
631 struct acpi_walk_info info
;
634 ACPI_FUNCTION_ENTRY();
637 * Just lock the entire namespace for the duration of the dump.
638 * We don't want any changes to the namespace during this time,
639 * especially the temporary nodes since we are going to display
642 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
643 if (ACPI_FAILURE(status
)) {
644 acpi_os_printf("Could not acquire namespace mutex\n");
648 info
.debug_level
= ACPI_LV_TABLES
;
649 info
.owner_id
= owner_id
;
650 info
.display_type
= display_type
;
652 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
653 ACPI_NS_WALK_NO_UNLOCK
|
654 ACPI_NS_WALK_TEMP_NODES
,
655 acpi_ns_dump_one_object
, NULL
,
656 (void *)&info
, NULL
);
658 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
660 #endif /* ACPI_FUTURE_USAGE */
662 /*******************************************************************************
664 * FUNCTION: acpi_ns_dump_entry
666 * PARAMETERS: handle - Node to be dumped
667 * debug_level - Output level
671 * DESCRIPTION: Dump a single Node
673 ******************************************************************************/
675 void acpi_ns_dump_entry(acpi_handle handle
, u32 debug_level
)
677 struct acpi_walk_info info
;
679 ACPI_FUNCTION_ENTRY();
681 info
.debug_level
= debug_level
;
682 info
.owner_id
= ACPI_OWNER_ID_MAX
;
683 info
.display_type
= ACPI_DISPLAY_SUMMARY
;
685 (void)acpi_ns_dump_one_object(handle
, 1, &info
, NULL
);
688 #ifdef ACPI_ASL_COMPILER
689 /*******************************************************************************
691 * FUNCTION: acpi_ns_dump_tables
693 * PARAMETERS: search_base - Root of subtree to be dumped, or
694 * NS_ALL to dump the entire namespace
695 * max_depth - Maximum depth of dump. Use INT_MAX
696 * for an effectively unlimited depth.
700 * DESCRIPTION: Dump the name space, or a portion of it.
702 ******************************************************************************/
704 void acpi_ns_dump_tables(acpi_handle search_base
, u32 max_depth
)
706 acpi_handle search_handle
= search_base
;
708 ACPI_FUNCTION_TRACE(ns_dump_tables
);
710 if (!acpi_gbl_root_node
) {
712 * If the name space has not been initialized,
713 * there is nothing to dump.
715 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
,
716 "namespace not initialized!\n"));
720 if (ACPI_NS_ALL
== search_base
) {
722 /* Entire namespace */
724 search_handle
= acpi_gbl_root_node
;
725 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
, "\\\n"));
728 acpi_ns_dump_objects(ACPI_TYPE_ANY
, ACPI_DISPLAY_OBJECTS
, max_depth
,
729 ACPI_OWNER_ID_MAX
, search_handle
);
732 #endif /* _ACPI_ASL_COMPILER */
733 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */