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
);
184 type
= this_node
->type
;
186 /* Check if the owner matches */
188 if ((info
->owner_id
!= ACPI_OWNER_ID_MAX
) &&
189 (info
->owner_id
!= this_node
->owner_id
)) {
193 if (!(info
->display_type
& ACPI_DISPLAY_SHORT
)) {
195 /* Indent the object according to the level */
197 acpi_os_printf("%2d%*s", (u32
) level
- 1, (int)level
* 2, " ");
199 /* Check the node type and name */
201 if (type
> ACPI_TYPE_LOCAL_MAX
) {
202 ACPI_WARNING((AE_INFO
, "Invalid ACPI Object Type %08X",
206 if (!acpi_ut_valid_acpi_name(this_node
->name
.integer
)) {
207 this_node
->name
.integer
=
208 acpi_ut_repair_name(this_node
->name
.ascii
);
210 ACPI_WARNING((AE_INFO
, "Invalid ACPI Name %08X",
211 this_node
->name
.integer
));
214 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node
));
218 * Now we can print out the pertinent information
220 acpi_os_printf(" %-12s %p %2.2X ",
221 acpi_ut_get_type_name(type
), this_node
,
222 this_node
->owner_id
);
224 dbg_level
= acpi_dbg_level
;
226 obj_desc
= acpi_ns_get_attached_object(this_node
);
227 acpi_dbg_level
= dbg_level
;
229 /* Temp nodes are those nodes created by a control method */
231 if (this_node
->flags
& ANOBJ_TEMPORARY
) {
232 acpi_os_printf("(T) ");
235 switch (info
->display_type
& ACPI_DISPLAY_MASK
) {
236 case ACPI_DISPLAY_SUMMARY
:
240 /* No attached object, we are done */
242 acpi_os_printf("\n");
247 case ACPI_TYPE_PROCESSOR
:
249 acpi_os_printf("ID %X Len %.4X Addr %p\n",
250 obj_desc
->processor
.proc_id
,
251 obj_desc
->processor
.length
,
257 case ACPI_TYPE_DEVICE
:
259 acpi_os_printf("Notify Object: %p\n", obj_desc
);
262 case ACPI_TYPE_METHOD
:
264 acpi_os_printf("Args %X Len %.4X Aml %p\n",
265 (u32
) obj_desc
->method
.param_count
,
266 obj_desc
->method
.aml_length
,
267 obj_desc
->method
.aml_start
);
270 case ACPI_TYPE_INTEGER
:
272 acpi_os_printf("= %8.8X%8.8X\n",
273 ACPI_FORMAT_UINT64(obj_desc
->integer
.
277 case ACPI_TYPE_PACKAGE
:
279 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
280 acpi_os_printf("Elements %.2X\n",
281 obj_desc
->package
.count
);
283 acpi_os_printf("[Length not yet evaluated]\n");
287 case ACPI_TYPE_BUFFER
:
289 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
290 acpi_os_printf("Len %.2X",
291 obj_desc
->buffer
.length
);
293 /* Dump some of the buffer */
295 if (obj_desc
->buffer
.length
> 0) {
296 acpi_os_printf(" =");
298 (i
< obj_desc
->buffer
.length
300 acpi_os_printf(" %.2hX",
305 acpi_os_printf("\n");
307 acpi_os_printf("[Length not yet evaluated]\n");
311 case ACPI_TYPE_STRING
:
313 acpi_os_printf("Len %.2X ", obj_desc
->string
.length
);
314 acpi_ut_print_string(obj_desc
->string
.pointer
, 32);
315 acpi_os_printf("\n");
318 case ACPI_TYPE_REGION
:
320 acpi_os_printf("[%s]",
321 acpi_ut_get_region_name(obj_desc
->region
.
323 if (obj_desc
->region
.flags
& AOPOBJ_DATA_VALID
) {
324 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
325 ACPI_FORMAT_NATIVE_UINT
326 (obj_desc
->region
.address
),
327 obj_desc
->region
.length
);
330 (" [Address/Length not yet evaluated]\n");
334 case ACPI_TYPE_LOCAL_REFERENCE
:
336 acpi_os_printf("[%s]\n",
337 acpi_ut_get_reference_name(obj_desc
));
340 case ACPI_TYPE_BUFFER_FIELD
:
342 if (obj_desc
->buffer_field
.buffer_obj
&&
343 obj_desc
->buffer_field
.buffer_obj
->buffer
.node
) {
344 acpi_os_printf("Buf [%4.4s]",
345 acpi_ut_get_node_name(obj_desc
->
353 case ACPI_TYPE_LOCAL_REGION_FIELD
:
355 acpi_os_printf("Rgn [%4.4s]",
356 acpi_ut_get_node_name(obj_desc
->
362 case ACPI_TYPE_LOCAL_BANK_FIELD
:
364 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
365 acpi_ut_get_node_name(obj_desc
->
369 acpi_ut_get_node_name(obj_desc
->
376 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
378 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
379 acpi_ut_get_node_name(obj_desc
->
383 acpi_ut_get_node_name(obj_desc
->
390 case ACPI_TYPE_LOCAL_ALIAS
:
391 case ACPI_TYPE_LOCAL_METHOD_ALIAS
:
393 acpi_os_printf("Target %4.4s (%p)\n",
394 acpi_ut_get_node_name(obj_desc
),
400 acpi_os_printf("Object %p\n", obj_desc
);
404 /* Common field handling */
407 case ACPI_TYPE_BUFFER_FIELD
:
408 case ACPI_TYPE_LOCAL_REGION_FIELD
:
409 case ACPI_TYPE_LOCAL_BANK_FIELD
:
410 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
412 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
413 (obj_desc
->common_field
.
414 base_byte_offset
* 8)
416 obj_desc
->common_field
.
417 start_field_bit_offset
,
418 obj_desc
->common_field
.bit_length
,
419 obj_desc
->common_field
.
428 case ACPI_DISPLAY_OBJECTS
:
430 acpi_os_printf("O:%p", obj_desc
);
433 /* No attached object, we are done */
435 acpi_os_printf("\n");
439 acpi_os_printf("(R%d)", obj_desc
->common
.reference_count
);
442 case ACPI_TYPE_METHOD
:
444 /* Name is a Method and its AML offset/length are set */
446 acpi_os_printf(" M:%p-%X\n", obj_desc
->method
.aml_start
,
447 obj_desc
->method
.aml_length
);
450 case ACPI_TYPE_INTEGER
:
452 acpi_os_printf(" I:%8.8X8.8%X\n",
453 ACPI_FORMAT_UINT64(obj_desc
->integer
.
457 case ACPI_TYPE_STRING
:
459 acpi_os_printf(" S:%p-%X\n", obj_desc
->string
.pointer
,
460 obj_desc
->string
.length
);
463 case ACPI_TYPE_BUFFER
:
465 acpi_os_printf(" B:%p-%X\n", obj_desc
->buffer
.pointer
,
466 obj_desc
->buffer
.length
);
471 acpi_os_printf("\n");
477 acpi_os_printf("\n");
481 /* If debug turned off, done */
483 if (!(acpi_dbg_level
& ACPI_LV_VALUES
)) {
487 /* If there is an attached object, display it */
489 dbg_level
= acpi_dbg_level
;
491 obj_desc
= acpi_ns_get_attached_object(this_node
);
492 acpi_dbg_level
= dbg_level
;
494 /* Dump attached objects */
497 obj_type
= ACPI_TYPE_INVALID
;
498 acpi_os_printf("Attached Object %p: ", obj_desc
);
500 /* Decode the type of attached object and dump the contents */
502 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
)) {
503 case ACPI_DESC_TYPE_NAMED
:
505 acpi_os_printf("(Ptr to Node)\n");
506 bytes_to_dump
= sizeof(struct acpi_namespace_node
);
507 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
510 case ACPI_DESC_TYPE_OPERAND
:
512 obj_type
= ACPI_GET_OBJECT_TYPE(obj_desc
);
514 if (obj_type
> ACPI_TYPE_LOCAL_MAX
) {
516 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
521 ("(Pointer to ACPI Object type %.2X [%s])\n",
522 obj_type
, acpi_ut_get_type_name(obj_type
));
524 sizeof(union acpi_operand_object
);
527 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
535 /* If value is NOT an internal object, we are done */
537 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc
) !=
538 ACPI_DESC_TYPE_OPERAND
) {
543 * Valid object, get the pointer to next level, if any
546 case ACPI_TYPE_BUFFER
:
547 case ACPI_TYPE_STRING
:
549 * NOTE: takes advantage of common fields between string/buffer
551 bytes_to_dump
= obj_desc
->string
.length
;
552 obj_desc
= (void *)obj_desc
->string
.pointer
;
553 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
554 obj_desc
, bytes_to_dump
);
555 ACPI_DUMP_BUFFER(obj_desc
, bytes_to_dump
);
558 case ACPI_TYPE_BUFFER_FIELD
:
560 (union acpi_operand_object
*)obj_desc
->buffer_field
.
564 case ACPI_TYPE_PACKAGE
:
565 obj_desc
= (void *)obj_desc
->package
.elements
;
568 case ACPI_TYPE_METHOD
:
569 obj_desc
= (void *)obj_desc
->method
.aml_start
;
572 case ACPI_TYPE_LOCAL_REGION_FIELD
:
573 obj_desc
= (void *)obj_desc
->field
.region_obj
;
576 case ACPI_TYPE_LOCAL_BANK_FIELD
:
577 obj_desc
= (void *)obj_desc
->bank_field
.region_obj
;
580 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
581 obj_desc
= (void *)obj_desc
->index_field
.index_obj
;
588 obj_type
= ACPI_TYPE_INVALID
; /* Terminate loop after next pass */
592 acpi_os_printf("\n");
596 #ifdef ACPI_FUTURE_USAGE
597 /*******************************************************************************
599 * FUNCTION: acpi_ns_dump_objects
601 * PARAMETERS: Type - Object type to be dumped
602 * display_type - 0 or ACPI_DISPLAY_SUMMARY
603 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
604 * for an effectively unlimited depth.
605 * owner_id - Dump only objects owned by this ID. Use
606 * ACPI_UINT32_MAX to match all owners.
607 * start_handle - Where in namespace to start/end search
611 * DESCRIPTION: Dump typed objects within the loaded namespace.
612 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
614 ******************************************************************************/
617 acpi_ns_dump_objects(acpi_object_type type
,
620 acpi_owner_id owner_id
, acpi_handle start_handle
)
622 struct acpi_walk_info info
;
624 ACPI_FUNCTION_ENTRY();
626 info
.debug_level
= ACPI_LV_TABLES
;
627 info
.owner_id
= owner_id
;
628 info
.display_type
= display_type
;
630 (void)acpi_ns_walk_namespace(type
, start_handle
, max_depth
,
631 ACPI_NS_WALK_NO_UNLOCK
|
632 ACPI_NS_WALK_TEMP_NODES
,
633 acpi_ns_dump_one_object
, (void *)&info
,
636 #endif /* ACPI_FUTURE_USAGE */
638 /*******************************************************************************
640 * FUNCTION: acpi_ns_dump_entry
642 * PARAMETERS: Handle - Node to be dumped
643 * debug_level - Output level
647 * DESCRIPTION: Dump a single Node
649 ******************************************************************************/
651 void acpi_ns_dump_entry(acpi_handle handle
, u32 debug_level
)
653 struct acpi_walk_info info
;
655 ACPI_FUNCTION_ENTRY();
657 info
.debug_level
= debug_level
;
658 info
.owner_id
= ACPI_OWNER_ID_MAX
;
659 info
.display_type
= ACPI_DISPLAY_SUMMARY
;
661 (void)acpi_ns_dump_one_object(handle
, 1, &info
, NULL
);
664 #ifdef ACPI_ASL_COMPILER
665 /*******************************************************************************
667 * FUNCTION: acpi_ns_dump_tables
669 * PARAMETERS: search_base - Root of subtree to be dumped, or
670 * NS_ALL to dump the entire namespace
671 * max_depth - Maximum depth of dump. Use INT_MAX
672 * for an effectively unlimited depth.
676 * DESCRIPTION: Dump the name space, or a portion of it.
678 ******************************************************************************/
680 void acpi_ns_dump_tables(acpi_handle search_base
, u32 max_depth
)
682 acpi_handle search_handle
= search_base
;
684 ACPI_FUNCTION_TRACE(ns_dump_tables
);
686 if (!acpi_gbl_root_node
) {
688 * If the name space has not been initialized,
689 * there is nothing to dump.
691 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
,
692 "namespace not initialized!\n"));
696 if (ACPI_NS_ALL
== search_base
) {
698 /* Entire namespace */
700 search_handle
= acpi_gbl_root_node
;
701 ACPI_DEBUG_PRINT((ACPI_DB_TABLES
, "\\\n"));
704 acpi_ns_dump_objects(ACPI_TYPE_ANY
, ACPI_DISPLAY_OBJECTS
, max_depth
,
705 ACPI_OWNER_ID_MAX
, search_handle
);
708 #endif /* _ACPI_ASL_COMPILER */
709 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */