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.
44 #include <acpi/acpi.h>
45 #include <acpi/acnamesp.h>
46 #include <acpi/acparser.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)) {
194 /* Indent the object according to the level */
196 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " ");
198 /* Check the node type and name */
200 if (type > ACPI_TYPE_LOCAL_MAX) {
201 ACPI_REPORT_WARNING(("Invalid ACPI Type %08X\n", type));
204 if (!acpi_ut_valid_acpi_name(this_node->name.integer)) {
205 ACPI_REPORT_WARNING(("Invalid ACPI Name %08X\n",
206 this_node->name.integer));
209 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
213 * Now we can print out the pertinent information
215 acpi_os_printf(" %-12s %p %2.2X ",
216 acpi_ut_get_type_name(type), this_node,
217 this_node->owner_id);
219 dbg_level = acpi_dbg_level;
221 obj_desc = acpi_ns_get_attached_object(this_node);
222 acpi_dbg_level = dbg_level;
224 switch (info->display_type & ACPI_DISPLAY_MASK) {
225 case ACPI_DISPLAY_SUMMARY:
228 /* No attached object, we are done */
230 acpi_os_printf("\n");
235 case ACPI_TYPE_PROCESSOR:
237 acpi_os_printf("ID %X Len %.4X Addr %p\n",
238 obj_desc->processor.proc_id,
239 obj_desc->processor.length,
240 (char *)obj_desc->processor.address);
243 case ACPI_TYPE_DEVICE:
245 acpi_os_printf("Notify Object: %p\n", obj_desc);
248 case ACPI_TYPE_METHOD:
250 acpi_os_printf("Args %X Len %.4X Aml %p\n",
251 (u32) obj_desc->method.param_count,
252 obj_desc->method.aml_length,
253 obj_desc->method.aml_start);
256 case ACPI_TYPE_INTEGER:
258 acpi_os_printf("= %8.8X%8.8X\n",
259 ACPI_FORMAT_UINT64(obj_desc->integer.
263 case ACPI_TYPE_PACKAGE:
265 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
266 acpi_os_printf("Elements %.2X\n",
267 obj_desc->package.count);
269 acpi_os_printf("[Length not yet evaluated]\n");
273 case ACPI_TYPE_BUFFER:
275 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
276 acpi_os_printf("Len %.2X",
277 obj_desc->buffer.length);
279 /* Dump some of the buffer */
281 if (obj_desc->buffer.length > 0) {
282 acpi_os_printf(" =");
284 (i < obj_desc->buffer.length
286 acpi_os_printf(" %.2hX",
291 acpi_os_printf("\n");
293 acpi_os_printf("[Length not yet evaluated]\n");
297 case ACPI_TYPE_STRING:
299 acpi_os_printf("Len %.2X ", obj_desc->string.length);
300 acpi_ut_print_string(obj_desc->string.pointer, 32);
301 acpi_os_printf("\n");
304 case ACPI_TYPE_REGION:
306 acpi_os_printf("[%s]",
307 acpi_ut_get_region_name(obj_desc->region.
309 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
310 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
311 ACPI_FORMAT_UINT64(obj_desc->
314 obj_desc->region.length);
317 (" [Address/Length not yet evaluated]\n");
321 case ACPI_TYPE_LOCAL_REFERENCE:
323 acpi_os_printf("[%s]\n",
324 acpi_ps_get_opcode_name(obj_desc->
329 case ACPI_TYPE_BUFFER_FIELD:
331 if (obj_desc->buffer_field.buffer_obj &&
332 obj_desc->buffer_field.buffer_obj->buffer.node) {
333 acpi_os_printf("Buf [%4.4s]",
334 acpi_ut_get_node_name(obj_desc->
342 case ACPI_TYPE_LOCAL_REGION_FIELD:
344 acpi_os_printf("Rgn [%4.4s]",
345 acpi_ut_get_node_name(obj_desc->
351 case ACPI_TYPE_LOCAL_BANK_FIELD:
353 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
354 acpi_ut_get_node_name(obj_desc->
358 acpi_ut_get_node_name(obj_desc->
365 case ACPI_TYPE_LOCAL_INDEX_FIELD:
367 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
368 acpi_ut_get_node_name(obj_desc->
372 acpi_ut_get_node_name(obj_desc->
379 case ACPI_TYPE_LOCAL_ALIAS:
380 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
382 acpi_os_printf("Target %4.4s (%p)\n",
383 acpi_ut_get_node_name(obj_desc),
389 acpi_os_printf("Object %p\n", obj_desc);
393 /* Common field handling */
396 case ACPI_TYPE_BUFFER_FIELD:
397 case ACPI_TYPE_LOCAL_REGION_FIELD:
398 case ACPI_TYPE_LOCAL_BANK_FIELD:
399 case ACPI_TYPE_LOCAL_INDEX_FIELD:
401 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
402 (obj_desc->common_field.
403 base_byte_offset * 8)
405 obj_desc->common_field.
406 start_field_bit_offset,
407 obj_desc->common_field.bit_length,
408 obj_desc->common_field.
417 case ACPI_DISPLAY_OBJECTS:
419 acpi_os_printf("O:%p", obj_desc);
421 /* No attached object, we are done */
423 acpi_os_printf("\n");
427 acpi_os_printf("(R%d)", obj_desc->common.reference_count);
430 case ACPI_TYPE_METHOD:
432 /* Name is a Method and its AML offset/length are set */
434 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
435 obj_desc->method.aml_length);
438 case ACPI_TYPE_INTEGER:
440 acpi_os_printf(" I:%8.8X8.8%X\n",
441 ACPI_FORMAT_UINT64(obj_desc->integer.
445 case ACPI_TYPE_STRING:
447 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
448 obj_desc->string.length);
451 case ACPI_TYPE_BUFFER:
453 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
454 obj_desc->buffer.length);
459 acpi_os_printf("\n");
465 acpi_os_printf("\n");
469 /* If debug turned off, done */
471 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
475 /* If there is an attached object, display it */
477 dbg_level = acpi_dbg_level;
479 obj_desc = acpi_ns_get_attached_object(this_node);
480 acpi_dbg_level = dbg_level;
482 /* Dump attached objects */
485 obj_type = ACPI_TYPE_INVALID;
486 acpi_os_printf("Attached Object %p: ", obj_desc);
488 /* Decode the type of attached object and dump the contents */
490 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
491 case ACPI_DESC_TYPE_NAMED:
493 acpi_os_printf("(Ptr to Node)\n");
494 bytes_to_dump = sizeof(struct acpi_namespace_node);
495 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
498 case ACPI_DESC_TYPE_OPERAND:
500 obj_type = ACPI_GET_OBJECT_TYPE(obj_desc);
502 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
504 ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
509 ("(Ptr to ACPI Object type %X [%s])\n",
510 obj_type, acpi_ut_get_type_name(obj_type));
512 sizeof(union acpi_operand_object);
515 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
523 /* If value is NOT an internal object, we are done */
525 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
526 ACPI_DESC_TYPE_OPERAND) {
531 * Valid object, get the pointer to next level, if any
534 case ACPI_TYPE_BUFFER:
535 case ACPI_TYPE_STRING:
537 * NOTE: takes advantage of common fields between string/buffer
539 bytes_to_dump = obj_desc->string.length;
540 obj_desc = (void *)obj_desc->string.pointer;
541 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
542 obj_desc, bytes_to_dump);
543 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
546 case ACPI_TYPE_BUFFER_FIELD:
548 (union acpi_operand_object *)obj_desc->buffer_field.
552 case ACPI_TYPE_PACKAGE:
553 obj_desc = (void *)obj_desc->package.elements;
556 case ACPI_TYPE_METHOD:
557 obj_desc = (void *)obj_desc->method.aml_start;
560 case ACPI_TYPE_LOCAL_REGION_FIELD:
561 obj_desc = (void *)obj_desc->field.region_obj;
564 case ACPI_TYPE_LOCAL_BANK_FIELD:
565 obj_desc = (void *)obj_desc->bank_field.region_obj;
568 case ACPI_TYPE_LOCAL_INDEX_FIELD:
569 obj_desc = (void *)obj_desc->index_field.index_obj;
576 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
580 acpi_os_printf("\n");
584 #ifdef ACPI_FUTURE_USAGE
585 /*******************************************************************************
587 * FUNCTION: acpi_ns_dump_objects
589 * PARAMETERS: Type - Object type to be dumped
590 * display_type - 0 or ACPI_DISPLAY_SUMMARY
591 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
592 * for an effectively unlimited depth.
593 * owner_id - Dump only objects owned by this ID. Use
594 * ACPI_UINT32_MAX to match all owners.
595 * start_handle - Where in namespace to start/end search
599 * DESCRIPTION: Dump typed objects within the loaded namespace.
600 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
602 ******************************************************************************/
605 acpi_ns_dump_objects(acpi_object_type type,
608 acpi_owner_id owner_id, acpi_handle start_handle)
610 struct acpi_walk_info info;
612 ACPI_FUNCTION_ENTRY();
614 info.debug_level = ACPI_LV_TABLES;
615 info.owner_id = owner_id;
616 info.display_type = display_type;
618 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
619 ACPI_NS_WALK_NO_UNLOCK,
620 acpi_ns_dump_one_object, (void *)&info,
623 #endif /* ACPI_FUTURE_USAGE */
625 /*******************************************************************************
627 * FUNCTION: acpi_ns_dump_entry
629 * PARAMETERS: Handle - Node to be dumped
630 * debug_level - Output level
634 * DESCRIPTION: Dump a single Node
636 ******************************************************************************/
638 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
640 struct acpi_walk_info info;
642 ACPI_FUNCTION_ENTRY();
644 info.debug_level = debug_level;
645 info.owner_id = ACPI_OWNER_ID_MAX;
646 info.display_type = ACPI_DISPLAY_SUMMARY;
648 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
651 #ifdef ACPI_ASL_COMPILER
652 /*******************************************************************************
654 * FUNCTION: acpi_ns_dump_tables
656 * PARAMETERS: search_base - Root of subtree to be dumped, or
657 * NS_ALL to dump the entire namespace
658 * max_depth - Maximum depth of dump. Use INT_MAX
659 * for an effectively unlimited depth.
663 * DESCRIPTION: Dump the name space, or a portion of it.
665 ******************************************************************************/
667 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
669 acpi_handle search_handle = search_base;
671 ACPI_FUNCTION_TRACE("ns_dump_tables");
673 if (!acpi_gbl_root_node) {
675 * If the name space has not been initialized,
676 * there is nothing to dump.
678 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
679 "namespace not initialized!\n"));
683 if (ACPI_NS_ALL == search_base) {
684 /* Entire namespace */
686 search_handle = acpi_gbl_root_node;
687 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
690 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
691 ACPI_OWNER_ID_MAX, search_handle);
694 #endif /* _ACPI_ASL_COMPILER */
695 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */