1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acparser.h>
50 #define _COMPONENT ACPI_NAMESPACE
51 ACPI_MODULE_NAME ("nsdump")
53 /* Local prototypes */
55 #ifdef ACPI_OBSOLETE_FUNCTIONS
57 acpi_ns_dump_root_devices (
61 acpi_ns_dump_one_device (
62 acpi_handle obj_handle
,
69 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
70 /*******************************************************************************
72 * FUNCTION: acpi_ns_print_pathname
74 * PARAMETERS: num_segments - Number of ACPI name segments
75 * Pathname - The compressed (internal) path
79 * DESCRIPTION: Print an object's full namespace pathname
81 ******************************************************************************/
84 acpi_ns_print_pathname (
88 ACPI_FUNCTION_NAME ("ns_print_pathname");
91 if (!(acpi_dbg_level
& ACPI_LV_NAMES
) || !(acpi_dbg_layer
& ACPI_NAMESPACE
)) {
95 /* Print the entire name */
97 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES
, "["));
99 while (num_segments
) {
100 acpi_os_printf ("%4.4s", pathname
);
101 pathname
+= ACPI_NAME_SIZE
;
105 acpi_os_printf (".");
109 acpi_os_printf ("]\n");
113 /*******************************************************************************
115 * FUNCTION: acpi_ns_dump_pathname
117 * PARAMETERS: Handle - Object
118 * Msg - Prefix message
119 * Level - Desired debug level
120 * Component - Caller's component ID
124 * DESCRIPTION: Print an object's full namespace pathname
125 * Manages allocation/freeing of a pathname buffer
127 ******************************************************************************/
130 acpi_ns_dump_pathname (
137 ACPI_FUNCTION_TRACE ("ns_dump_pathname");
140 /* Do this only if the requested debug level and component are enabled */
142 if (!(acpi_dbg_level
& level
) || !(acpi_dbg_layer
& component
)) {
146 /* Convert handle to a full pathname and print it (with supplied message) */
148 acpi_ns_print_node_pathname (handle
, msg
);
149 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 (
172 acpi_handle obj_handle
,
177 struct acpi_walk_info
*info
= (struct acpi_walk_info
*) context
;
178 struct acpi_namespace_node
*this_node
;
179 union acpi_operand_object
*obj_desc
= NULL
;
180 acpi_object_type obj_type
;
181 acpi_object_type type
;
187 ACPI_FUNCTION_NAME ("ns_dump_one_object");
190 /* Is output enabled? */
192 if (!(acpi_dbg_level
& info
->debug_level
)) {
197 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
, "Null object handle\n"));
201 this_node
= acpi_ns_map_handle_to_node (obj_handle
);
202 type
= this_node
->type
;
204 /* Check if the owner matches */
206 if ((info
->owner_id
!= ACPI_UINT32_MAX
) &&
207 (info
->owner_id
!= this_node
->owner_id
)) {
211 /* Indent the object according to the level */
213 acpi_os_printf ("%2d%*s", (u32
) level
- 1, (int) level
* 2, " ");
215 /* Check the node type and name */
217 if (type
> ACPI_TYPE_LOCAL_MAX
) {
218 ACPI_REPORT_WARNING (("Invalid ACPI Type %08X\n", type
));
221 if (!acpi_ut_valid_acpi_name (this_node
->name
.integer
)) {
222 ACPI_REPORT_WARNING (("Invalid ACPI Name %08X\n",
223 this_node
->name
.integer
));
227 * Now we can print out the pertinent information
229 acpi_os_printf ("%4.4s %-12s %p ",
230 acpi_ut_get_node_name (this_node
), acpi_ut_get_type_name (type
), this_node
);
232 dbg_level
= acpi_dbg_level
;
234 obj_desc
= acpi_ns_get_attached_object (this_node
);
235 acpi_dbg_level
= dbg_level
;
237 switch (info
->display_type
) {
238 case ACPI_DISPLAY_SUMMARY
:
241 /* No attached object, we are done */
243 acpi_os_printf ("\n");
248 case ACPI_TYPE_PROCESSOR
:
250 acpi_os_printf ("ID %X Len %.4X Addr %p\n",
251 obj_desc
->processor
.proc_id
, obj_desc
->processor
.length
,
252 (char *) obj_desc
->processor
.address
);
256 case ACPI_TYPE_DEVICE
:
258 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
, 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
.value
));
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
);
284 acpi_os_printf ("[Length not yet evaluated]\n");
289 case ACPI_TYPE_BUFFER
:
291 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
292 acpi_os_printf ("Len %.2X",
293 obj_desc
->buffer
.length
);
295 /* Dump some of the buffer */
297 if (obj_desc
->buffer
.length
> 0) {
298 acpi_os_printf (" =");
299 for (i
= 0; (i
< obj_desc
->buffer
.length
&& i
< 12); i
++) {
300 acpi_os_printf (" %.2hX", obj_desc
->buffer
.pointer
[i
]);
303 acpi_os_printf ("\n");
306 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");
319 case ACPI_TYPE_REGION
:
321 acpi_os_printf ("[%s]",
322 acpi_ut_get_region_name (obj_desc
->region
.space_id
));
323 if (obj_desc
->region
.flags
& AOPOBJ_DATA_VALID
) {
324 acpi_os_printf (" Addr %8.8X%8.8X Len %.4X\n",
325 ACPI_FORMAT_UINT64 (obj_desc
->region
.address
),
326 obj_desc
->region
.length
);
329 acpi_os_printf (" [Address/Length not yet evaluated]\n");
334 case ACPI_TYPE_LOCAL_REFERENCE
:
336 acpi_os_printf ("[%s]\n",
337 acpi_ps_get_opcode_name (obj_desc
->reference
.opcode
));
341 case ACPI_TYPE_BUFFER_FIELD
:
343 if (obj_desc
->buffer_field
.buffer_obj
&&
344 obj_desc
->buffer_field
.buffer_obj
->buffer
.node
) {
345 acpi_os_printf ("Buf [%4.4s]",
346 acpi_ut_get_node_name (obj_desc
->buffer_field
.buffer_obj
->buffer
.node
));
351 case ACPI_TYPE_LOCAL_REGION_FIELD
:
353 acpi_os_printf ("Rgn [%4.4s]",
354 acpi_ut_get_node_name (obj_desc
->common_field
.region_obj
->region
.node
));
358 case ACPI_TYPE_LOCAL_BANK_FIELD
:
360 acpi_os_printf ("Rgn [%4.4s] Bnk [%4.4s]",
361 acpi_ut_get_node_name (obj_desc
->common_field
.region_obj
->region
.node
),
362 acpi_ut_get_node_name (obj_desc
->bank_field
.bank_obj
->common_field
.node
));
366 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
368 acpi_os_printf ("Idx [%4.4s] Dat [%4.4s]",
369 acpi_ut_get_node_name (obj_desc
->index_field
.index_obj
->common_field
.node
),
370 acpi_ut_get_node_name (obj_desc
->index_field
.data_obj
->common_field
.node
));
374 case ACPI_TYPE_LOCAL_ALIAS
:
375 case ACPI_TYPE_LOCAL_METHOD_ALIAS
:
377 acpi_os_printf ("Target %4.4s (%p)\n",
378 acpi_ut_get_node_name (obj_desc
), obj_desc
);
383 acpi_os_printf ("Object %p\n", obj_desc
);
387 /* Common field handling */
390 case ACPI_TYPE_BUFFER_FIELD
:
391 case ACPI_TYPE_LOCAL_REGION_FIELD
:
392 case ACPI_TYPE_LOCAL_BANK_FIELD
:
393 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
395 acpi_os_printf (" Off %.3X Len %.2X Acc %.2hd\n",
396 (obj_desc
->common_field
.base_byte_offset
* 8)
397 + obj_desc
->common_field
.start_field_bit_offset
,
398 obj_desc
->common_field
.bit_length
,
399 obj_desc
->common_field
.access_byte_width
);
408 case ACPI_DISPLAY_OBJECTS
:
410 acpi_os_printf ("O:%p", obj_desc
);
412 /* No attached object, we are done */
414 acpi_os_printf ("\n");
418 acpi_os_printf ("(R%d)", obj_desc
->common
.reference_count
);
421 case ACPI_TYPE_METHOD
:
423 /* Name is a Method and its AML offset/length are set */
425 acpi_os_printf (" M:%p-%X\n", obj_desc
->method
.aml_start
,
426 obj_desc
->method
.aml_length
);
429 case ACPI_TYPE_INTEGER
:
431 acpi_os_printf (" I:%8.8X8.8%X\n",
432 ACPI_FORMAT_UINT64 (obj_desc
->integer
.value
));
435 case ACPI_TYPE_STRING
:
437 acpi_os_printf (" S:%p-%X\n", obj_desc
->string
.pointer
,
438 obj_desc
->string
.length
);
441 case ACPI_TYPE_BUFFER
:
443 acpi_os_printf (" B:%p-%X\n", obj_desc
->buffer
.pointer
,
444 obj_desc
->buffer
.length
);
449 acpi_os_printf ("\n");
456 acpi_os_printf ("\n");
460 /* If debug turned off, done */
462 if (!(acpi_dbg_level
& ACPI_LV_VALUES
)) {
467 /* If there is an attached object, display it */
469 dbg_level
= acpi_dbg_level
;
471 obj_desc
= acpi_ns_get_attached_object (this_node
);
472 acpi_dbg_level
= dbg_level
;
474 /* Dump attached objects */
477 obj_type
= ACPI_TYPE_INVALID
;
478 acpi_os_printf (" Attached Object %p: ", obj_desc
);
480 /* Decode the type of attached object and dump the contents */
482 switch (ACPI_GET_DESCRIPTOR_TYPE (obj_desc
)) {
483 case ACPI_DESC_TYPE_NAMED
:
485 acpi_os_printf ("(Ptr to Node)\n");
486 bytes_to_dump
= sizeof (struct acpi_namespace_node
);
490 case ACPI_DESC_TYPE_OPERAND
:
492 obj_type
= ACPI_GET_OBJECT_TYPE (obj_desc
);
494 if (obj_type
> ACPI_TYPE_LOCAL_MAX
) {
495 acpi_os_printf ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
500 acpi_os_printf ("(Ptr to ACPI Object type %s, %X)\n",
501 acpi_ut_get_type_name (obj_type
), obj_type
);
502 bytes_to_dump
= sizeof (union acpi_operand_object
);
510 "(String or Buffer ptr - not an object descriptor) [%s]\n",
511 acpi_ut_get_descriptor_name (obj_desc
));
516 ACPI_DUMP_BUFFER (obj_desc
, bytes_to_dump
);
518 /* If value is NOT an internal object, we are done */
520 if (ACPI_GET_DESCRIPTOR_TYPE (obj_desc
) != ACPI_DESC_TYPE_OPERAND
) {
525 * Valid object, get the pointer to next level, if any
528 case ACPI_TYPE_STRING
:
529 obj_desc
= (void *) obj_desc
->string
.pointer
;
532 case ACPI_TYPE_BUFFER
:
533 obj_desc
= (void *) obj_desc
->buffer
.pointer
;
536 case ACPI_TYPE_BUFFER_FIELD
:
537 obj_desc
= (union acpi_operand_object
*) obj_desc
->buffer_field
.buffer_obj
;
540 case ACPI_TYPE_PACKAGE
:
541 obj_desc
= (void *) obj_desc
->package
.elements
;
544 case ACPI_TYPE_METHOD
:
545 obj_desc
= (void *) obj_desc
->method
.aml_start
;
548 case ACPI_TYPE_LOCAL_REGION_FIELD
:
549 obj_desc
= (void *) obj_desc
->field
.region_obj
;
552 case ACPI_TYPE_LOCAL_BANK_FIELD
:
553 obj_desc
= (void *) obj_desc
->bank_field
.region_obj
;
556 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
557 obj_desc
= (void *) obj_desc
->index_field
.index_obj
;
564 obj_type
= ACPI_TYPE_INVALID
; /* Terminate loop after next pass */
568 acpi_os_printf ("\n");
573 #ifdef ACPI_FUTURE_USAGE
574 /*******************************************************************************
576 * FUNCTION: acpi_ns_dump_objects
578 * PARAMETERS: Type - Object type to be dumped
579 * display_type - 0 or ACPI_DISPLAY_SUMMARY
580 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
581 * for an effectively unlimited depth.
582 * owner_id - Dump only objects owned by this ID. Use
583 * ACPI_UINT32_MAX to match all owners.
584 * start_handle - Where in namespace to start/end search
588 * DESCRIPTION: Dump typed objects within the loaded namespace.
589 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
591 ******************************************************************************/
594 acpi_ns_dump_objects (
595 acpi_object_type type
,
599 acpi_handle start_handle
)
601 struct acpi_walk_info info
;
604 ACPI_FUNCTION_ENTRY ();
607 info
.debug_level
= ACPI_LV_TABLES
;
608 info
.owner_id
= owner_id
;
609 info
.display_type
= display_type
;
611 (void) acpi_ns_walk_namespace (type
, start_handle
, max_depth
,
612 ACPI_NS_WALK_NO_UNLOCK
, acpi_ns_dump_one_object
,
613 (void *) &info
, NULL
);
615 #endif /* ACPI_FUTURE_USAGE */
618 /*******************************************************************************
620 * FUNCTION: acpi_ns_dump_entry
622 * PARAMETERS: Handle - Node to be dumped
623 * debug_level - Output level
627 * DESCRIPTION: Dump a single Node
629 ******************************************************************************/
636 struct acpi_walk_info info
;
639 ACPI_FUNCTION_ENTRY ();
642 info
.debug_level
= debug_level
;
643 info
.owner_id
= ACPI_UINT32_MAX
;
644 info
.display_type
= ACPI_DISPLAY_SUMMARY
;
646 (void) acpi_ns_dump_one_object (handle
, 1, &info
, NULL
);
650 #ifdef _ACPI_ASL_COMPILER
651 /*******************************************************************************
653 * FUNCTION: acpi_ns_dump_tables
655 * PARAMETERS: search_base - Root of subtree to be dumped, or
656 * NS_ALL to dump the entire namespace
657 * max_depth - Maximum depth of dump. Use INT_MAX
658 * for an effectively unlimited depth.
662 * DESCRIPTION: Dump the name space, or a portion of it.
664 ******************************************************************************/
667 acpi_ns_dump_tables (
668 acpi_handle search_base
,
671 acpi_handle search_handle
= search_base
;
674 ACPI_FUNCTION_TRACE ("ns_dump_tables");
677 if (!acpi_gbl_root_node
) {
679 * If the name space has not been initialized,
680 * there is nothing to dump.
682 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES
, "namespace not initialized!\n"));
686 if (ACPI_NS_ALL
== search_base
) {
687 /* Entire namespace */
689 search_handle
= acpi_gbl_root_node
;
690 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES
, "\\\n"));
693 acpi_ns_dump_objects (ACPI_TYPE_ANY
, ACPI_DISPLAY_OBJECTS
, max_depth
,
694 ACPI_UINT32_MAX
, search_handle
);
697 #endif /* _ACPI_ASL_COMPILER */
698 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */