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_OWNER_ID_MAX) &&
207 (info->owner_id != this_node->owner_id)) {
211 if (!(info->display_type & ACPI_DISPLAY_SHORT)) {
212 /* Indent the object according to the level */
214 acpi_os_printf ("%2d%*s", (u32) level - 1, (int) level * 2, " ");
216 /* Check the node type and name */
218 if (type > ACPI_TYPE_LOCAL_MAX) {
219 ACPI_REPORT_WARNING (("Invalid ACPI Type %08X\n", type));
222 if (!acpi_ut_valid_acpi_name (this_node->name.integer)) {
223 ACPI_REPORT_WARNING (("Invalid ACPI Name %08X\n",
224 this_node->name.integer));
227 acpi_os_printf ("%4.4s", acpi_ut_get_node_name (this_node));
231 * Now we can print out the pertinent information
233 acpi_os_printf (" %-12s %p ",
234 acpi_ut_get_type_name (type), this_node);
236 dbg_level = acpi_dbg_level;
238 obj_desc = acpi_ns_get_attached_object (this_node);
239 acpi_dbg_level = dbg_level;
241 switch (info->display_type & ACPI_DISPLAY_MASK) {
242 case ACPI_DISPLAY_SUMMARY:
245 /* No attached object, we are done */
247 acpi_os_printf ("\n");
252 case ACPI_TYPE_PROCESSOR:
254 acpi_os_printf ("ID %X Len %.4X Addr %p\n",
255 obj_desc->processor.proc_id, obj_desc->processor.length,
256 (char *) obj_desc->processor.address);
260 case ACPI_TYPE_DEVICE:
262 acpi_os_printf ("Notify Object: %p\n", obj_desc);
266 case ACPI_TYPE_METHOD:
268 acpi_os_printf ("Args %X Len %.4X Aml %p\n",
269 (u32) obj_desc->method.param_count,
270 obj_desc->method.aml_length, obj_desc->method.aml_start);
274 case ACPI_TYPE_INTEGER:
276 acpi_os_printf ("= %8.8X%8.8X\n",
277 ACPI_FORMAT_UINT64 (obj_desc->integer.value));
281 case ACPI_TYPE_PACKAGE:
283 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
284 acpi_os_printf ("Elements %.2X\n",
285 obj_desc->package.count);
288 acpi_os_printf ("[Length not yet evaluated]\n");
293 case ACPI_TYPE_BUFFER:
295 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
296 acpi_os_printf ("Len %.2X",
297 obj_desc->buffer.length);
299 /* Dump some of the buffer */
301 if (obj_desc->buffer.length > 0) {
302 acpi_os_printf (" =");
303 for (i = 0; (i < obj_desc->buffer.length && i < 12); i++) {
304 acpi_os_printf (" %.2hX", obj_desc->buffer.pointer[i]);
307 acpi_os_printf ("\n");
310 acpi_os_printf ("[Length not yet evaluated]\n");
315 case ACPI_TYPE_STRING:
317 acpi_os_printf ("Len %.2X ", obj_desc->string.length);
318 acpi_ut_print_string (obj_desc->string.pointer, 32);
319 acpi_os_printf ("\n");
323 case ACPI_TYPE_REGION:
325 acpi_os_printf ("[%s]",
326 acpi_ut_get_region_name (obj_desc->region.space_id));
327 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
328 acpi_os_printf (" Addr %8.8X%8.8X Len %.4X\n",
329 ACPI_FORMAT_UINT64 (obj_desc->region.address),
330 obj_desc->region.length);
333 acpi_os_printf (" [Address/Length not yet evaluated]\n");
338 case ACPI_TYPE_LOCAL_REFERENCE:
340 acpi_os_printf ("[%s]\n",
341 acpi_ps_get_opcode_name (obj_desc->reference.opcode));
345 case ACPI_TYPE_BUFFER_FIELD:
347 if (obj_desc->buffer_field.buffer_obj &&
348 obj_desc->buffer_field.buffer_obj->buffer.node) {
349 acpi_os_printf ("Buf [%4.4s]",
350 acpi_ut_get_node_name (obj_desc->buffer_field.buffer_obj->buffer.node));
355 case ACPI_TYPE_LOCAL_REGION_FIELD:
357 acpi_os_printf ("Rgn [%4.4s]",
358 acpi_ut_get_node_name (obj_desc->common_field.region_obj->region.node));
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->common_field.region_obj->region.node),
366 acpi_ut_get_node_name (obj_desc->bank_field.bank_obj->common_field.node));
370 case ACPI_TYPE_LOCAL_INDEX_FIELD:
372 acpi_os_printf ("Idx [%4.4s] Dat [%4.4s]",
373 acpi_ut_get_node_name (obj_desc->index_field.index_obj->common_field.node),
374 acpi_ut_get_node_name (obj_desc->index_field.data_obj->common_field.node));
378 case ACPI_TYPE_LOCAL_ALIAS:
379 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
381 acpi_os_printf ("Target %4.4s (%p)\n",
382 acpi_ut_get_node_name (obj_desc), obj_desc);
387 acpi_os_printf ("Object %p\n", obj_desc);
391 /* Common field handling */
394 case ACPI_TYPE_BUFFER_FIELD:
395 case ACPI_TYPE_LOCAL_REGION_FIELD:
396 case ACPI_TYPE_LOCAL_BANK_FIELD:
397 case ACPI_TYPE_LOCAL_INDEX_FIELD:
399 acpi_os_printf (" Off %.3X Len %.2X Acc %.2hd\n",
400 (obj_desc->common_field.base_byte_offset * 8)
401 + obj_desc->common_field.start_field_bit_offset,
402 obj_desc->common_field.bit_length,
403 obj_desc->common_field.access_byte_width);
412 case ACPI_DISPLAY_OBJECTS:
414 acpi_os_printf ("O:%p", obj_desc);
416 /* No attached object, we are done */
418 acpi_os_printf ("\n");
422 acpi_os_printf ("(R%d)", obj_desc->common.reference_count);
425 case ACPI_TYPE_METHOD:
427 /* Name is a Method and its AML offset/length are set */
429 acpi_os_printf (" M:%p-%X\n", obj_desc->method.aml_start,
430 obj_desc->method.aml_length);
433 case ACPI_TYPE_INTEGER:
435 acpi_os_printf (" I:%8.8X8.8%X\n",
436 ACPI_FORMAT_UINT64 (obj_desc->integer.value));
439 case ACPI_TYPE_STRING:
441 acpi_os_printf (" S:%p-%X\n", obj_desc->string.pointer,
442 obj_desc->string.length);
445 case ACPI_TYPE_BUFFER:
447 acpi_os_printf (" B:%p-%X\n", obj_desc->buffer.pointer,
448 obj_desc->buffer.length);
453 acpi_os_printf ("\n");
460 acpi_os_printf ("\n");
464 /* If debug turned off, done */
466 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
471 /* If there is an attached object, display it */
473 dbg_level = acpi_dbg_level;
475 obj_desc = acpi_ns_get_attached_object (this_node);
476 acpi_dbg_level = dbg_level;
478 /* Dump attached objects */
481 obj_type = ACPI_TYPE_INVALID;
482 acpi_os_printf ("Attached Object %p: ", obj_desc);
484 /* Decode the type of attached object and dump the contents */
486 switch (ACPI_GET_DESCRIPTOR_TYPE (obj_desc)) {
487 case ACPI_DESC_TYPE_NAMED:
489 acpi_os_printf ("(Ptr to Node)\n");
490 bytes_to_dump = sizeof (struct acpi_namespace_node);
491 ACPI_DUMP_BUFFER (obj_desc, bytes_to_dump);
494 case ACPI_DESC_TYPE_OPERAND:
496 obj_type = ACPI_GET_OBJECT_TYPE (obj_desc);
498 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
499 acpi_os_printf ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
504 acpi_os_printf ("(Ptr to ACPI Object type %X [%s])\n",
505 obj_type, acpi_ut_get_type_name (obj_type));
506 bytes_to_dump = sizeof (union acpi_operand_object);
509 ACPI_DUMP_BUFFER (obj_desc, bytes_to_dump);
517 /* If value is NOT an internal object, we are done */
519 if (ACPI_GET_DESCRIPTOR_TYPE (obj_desc) != ACPI_DESC_TYPE_OPERAND) {
524 * Valid object, get the pointer to next level, if any
527 case ACPI_TYPE_BUFFER:
528 case ACPI_TYPE_STRING:
530 * NOTE: takes advantage of common fields between string/buffer
532 bytes_to_dump = obj_desc->string.length;
533 obj_desc = (void *) obj_desc->string.pointer;
534 acpi_os_printf ( "(Buffer/String pointer %p length %X)\n",
535 obj_desc, bytes_to_dump);
536 ACPI_DUMP_BUFFER (obj_desc, bytes_to_dump);
539 case ACPI_TYPE_BUFFER_FIELD:
540 obj_desc = (union acpi_operand_object *) obj_desc->buffer_field.buffer_obj;
543 case ACPI_TYPE_PACKAGE:
544 obj_desc = (void *) obj_desc->package.elements;
547 case ACPI_TYPE_METHOD:
548 obj_desc = (void *) obj_desc->method.aml_start;
551 case ACPI_TYPE_LOCAL_REGION_FIELD:
552 obj_desc = (void *) obj_desc->field.region_obj;
555 case ACPI_TYPE_LOCAL_BANK_FIELD:
556 obj_desc = (void *) obj_desc->bank_field.region_obj;
559 case ACPI_TYPE_LOCAL_INDEX_FIELD:
560 obj_desc = (void *) obj_desc->index_field.index_obj;
567 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
571 acpi_os_printf ("\n");
576 #ifdef ACPI_FUTURE_USAGE
577 /*******************************************************************************
579 * FUNCTION: acpi_ns_dump_objects
581 * PARAMETERS: Type - Object type to be dumped
582 * display_type - 0 or ACPI_DISPLAY_SUMMARY
583 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
584 * for an effectively unlimited depth.
585 * owner_id - Dump only objects owned by this ID. Use
586 * ACPI_UINT32_MAX to match all owners.
587 * start_handle - Where in namespace to start/end search
591 * DESCRIPTION: Dump typed objects within the loaded namespace.
592 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
594 ******************************************************************************/
597 acpi_ns_dump_objects (
598 acpi_object_type type,
601 acpi_owner_id owner_id,
602 acpi_handle start_handle)
604 struct acpi_walk_info info;
607 ACPI_FUNCTION_ENTRY ();
610 info.debug_level = ACPI_LV_TABLES;
611 info.owner_id = owner_id;
612 info.display_type = display_type;
614 (void) acpi_ns_walk_namespace (type, start_handle, max_depth,
615 ACPI_NS_WALK_NO_UNLOCK, acpi_ns_dump_one_object,
616 (void *) &info, NULL);
618 #endif /* ACPI_FUTURE_USAGE */
621 /*******************************************************************************
623 * FUNCTION: acpi_ns_dump_entry
625 * PARAMETERS: Handle - Node to be dumped
626 * debug_level - Output level
630 * DESCRIPTION: Dump a single Node
632 ******************************************************************************/
639 struct acpi_walk_info info;
642 ACPI_FUNCTION_ENTRY ();
645 info.debug_level = debug_level;
646 info.owner_id = ACPI_OWNER_ID_MAX;
647 info.display_type = ACPI_DISPLAY_SUMMARY;
649 (void) acpi_ns_dump_one_object (handle, 1, &info, NULL);
653 #ifdef ACPI_ASL_COMPILER
654 /*******************************************************************************
656 * FUNCTION: acpi_ns_dump_tables
658 * PARAMETERS: search_base - Root of subtree to be dumped, or
659 * NS_ALL to dump the entire namespace
660 * max_depth - Maximum depth of dump. Use INT_MAX
661 * for an effectively unlimited depth.
665 * DESCRIPTION: Dump the name space, or a portion of it.
667 ******************************************************************************/
670 acpi_ns_dump_tables (
671 acpi_handle search_base,
674 acpi_handle search_handle = search_base;
677 ACPI_FUNCTION_TRACE ("ns_dump_tables");
680 if (!acpi_gbl_root_node) {
682 * If the name space has not been initialized,
683 * there is nothing to dump.
685 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "namespace not initialized!\n"));
689 if (ACPI_NS_ALL == search_base) {
690 /* Entire namespace */
692 search_handle = acpi_gbl_root_node;
693 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "\\\n"));
696 acpi_ns_dump_objects (ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
697 ACPI_OWNER_ID_MAX, search_handle);
700 #endif /* _ACPI_ASL_COMPILER */
701 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */