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")
54 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
56 /*******************************************************************************
58 * FUNCTION: acpi_ns_print_pathname
60 * PARAMETERS: num_segment - Number of ACPI name segments
61 * Pathname - The compressed (internal) path
63 * DESCRIPTION: Print an object's full namespace pathname
65 ******************************************************************************/
68 acpi_ns_print_pathname (
72 ACPI_FUNCTION_NAME ("ns_print_pathname");
75 if (!(acpi_dbg_level & ACPI_LV_NAMES) || !(acpi_dbg_layer & ACPI_NAMESPACE)) {
79 /* Print the entire name */
81 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "["));
83 while (num_segments) {
84 acpi_os_printf ("%4.4s", pathname);
85 pathname += ACPI_NAME_SIZE;
93 acpi_os_printf ("]\n");
97 /*******************************************************************************
99 * FUNCTION: acpi_ns_dump_pathname
101 * PARAMETERS: Handle - Object
102 * Msg - Prefix message
103 * Level - Desired debug level
104 * Component - Caller's component ID
106 * DESCRIPTION: Print an object's full namespace pathname
107 * Manages allocation/freeing of a pathname buffer
109 ******************************************************************************/
112 acpi_ns_dump_pathname (
119 ACPI_FUNCTION_TRACE ("ns_dump_pathname");
122 /* Do this only if the requested debug level and component are enabled */
124 if (!(acpi_dbg_level & level) || !(acpi_dbg_layer & component)) {
128 /* Convert handle to a full pathname and print it (with supplied message) */
130 acpi_ns_print_node_pathname (handle, msg);
131 acpi_os_printf ("\n");
136 /*******************************************************************************
138 * FUNCTION: acpi_ns_dump_one_object
140 * PARAMETERS: Handle - Node to be dumped
141 * Level - Nesting level of the handle
142 * Context - Passed into walk_namespace
144 * DESCRIPTION: Dump a single Node
145 * This procedure is a user_function called by acpi_ns_walk_namespace.
147 ******************************************************************************/
150 acpi_ns_dump_one_object (
151 acpi_handle obj_handle,
156 struct acpi_walk_info *info = (struct acpi_walk_info *) context;
157 struct acpi_namespace_node *this_node;
158 union acpi_operand_object *obj_desc = NULL;
159 acpi_object_type obj_type;
160 acpi_object_type type;
166 ACPI_FUNCTION_NAME ("ns_dump_one_object");
169 /* Is output enabled? */
171 if (!(acpi_dbg_level & info->debug_level)) {
176 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Null object handle\n"));
180 this_node = acpi_ns_map_handle_to_node (obj_handle);
181 type = this_node->type;
183 /* Check if the owner matches */
185 if ((info->owner_id != ACPI_UINT32_MAX) &&
186 (info->owner_id != this_node->owner_id)) {
190 /* Indent the object according to the level */
192 acpi_os_printf ("%2d%*s", (u32) level - 1, (int) level * 2, " ");
194 /* Check the node type and name */
196 if (type > ACPI_TYPE_LOCAL_MAX) {
197 ACPI_REPORT_WARNING (("Invalid ACPI Type %08X\n", type));
200 if (!acpi_ut_valid_acpi_name (this_node->name.integer)) {
201 ACPI_REPORT_WARNING (("Invalid ACPI Name %08X\n",
202 this_node->name.integer));
206 * Now we can print out the pertinent information
208 acpi_os_printf ("%4.4s %-12s %p ",
209 acpi_ut_get_node_name (this_node), acpi_ut_get_type_name (type), this_node);
211 dbg_level = acpi_dbg_level;
213 obj_desc = acpi_ns_get_attached_object (this_node);
214 acpi_dbg_level = dbg_level;
216 switch (info->display_type) {
217 case ACPI_DISPLAY_SUMMARY:
220 /* No attached object, we are done */
222 acpi_os_printf ("\n");
227 case ACPI_TYPE_PROCESSOR:
229 acpi_os_printf ("ID %X Len %.4X Addr %p\n",
230 obj_desc->processor.proc_id, obj_desc->processor.length,
231 (char *) obj_desc->processor.address);
235 case ACPI_TYPE_DEVICE:
237 acpi_os_printf ("Notify Object: %p\n", obj_desc);
241 case ACPI_TYPE_METHOD:
243 acpi_os_printf ("Args %X Len %.4X Aml %p\n",
244 (u32) obj_desc->method.param_count,
245 obj_desc->method.aml_length, obj_desc->method.aml_start);
249 case ACPI_TYPE_INTEGER:
251 acpi_os_printf ("= %8.8X%8.8X\n",
252 ACPI_FORMAT_UINT64 (obj_desc->integer.value));
256 case ACPI_TYPE_PACKAGE:
258 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
259 acpi_os_printf ("Elements %.2X\n",
260 obj_desc->package.count);
263 acpi_os_printf ("[Length not yet evaluated]\n");
268 case ACPI_TYPE_BUFFER:
270 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
271 acpi_os_printf ("Len %.2X",
272 obj_desc->buffer.length);
274 /* Dump some of the buffer */
276 if (obj_desc->buffer.length > 0) {
277 acpi_os_printf (" =");
278 for (i = 0; (i < obj_desc->buffer.length && i < 12); i++) {
279 acpi_os_printf (" %.2hX", obj_desc->buffer.pointer[i]);
282 acpi_os_printf ("\n");
285 acpi_os_printf ("[Length not yet evaluated]\n");
290 case ACPI_TYPE_STRING:
292 acpi_os_printf ("Len %.2X ", obj_desc->string.length);
293 acpi_ut_print_string (obj_desc->string.pointer, 32);
294 acpi_os_printf ("\n");
298 case ACPI_TYPE_REGION:
300 acpi_os_printf ("[%s]",
301 acpi_ut_get_region_name (obj_desc->region.space_id));
302 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
303 acpi_os_printf (" Addr %8.8X%8.8X Len %.4X\n",
304 ACPI_FORMAT_UINT64 (obj_desc->region.address),
305 obj_desc->region.length);
308 acpi_os_printf (" [Address/Length not yet evaluated]\n");
313 case ACPI_TYPE_LOCAL_REFERENCE:
315 acpi_os_printf ("[%s]\n",
316 acpi_ps_get_opcode_name (obj_desc->reference.opcode));
320 case ACPI_TYPE_BUFFER_FIELD:
322 if (obj_desc->buffer_field.buffer_obj &&
323 obj_desc->buffer_field.buffer_obj->buffer.node) {
324 acpi_os_printf ("Buf [%4.4s]",
325 acpi_ut_get_node_name (obj_desc->buffer_field.buffer_obj->buffer.node));
330 case ACPI_TYPE_LOCAL_REGION_FIELD:
332 acpi_os_printf ("Rgn [%4.4s]",
333 acpi_ut_get_node_name (obj_desc->common_field.region_obj->region.node));
337 case ACPI_TYPE_LOCAL_BANK_FIELD:
339 acpi_os_printf ("Rgn [%4.4s] Bnk [%4.4s]",
340 acpi_ut_get_node_name (obj_desc->common_field.region_obj->region.node),
341 acpi_ut_get_node_name (obj_desc->bank_field.bank_obj->common_field.node));
345 case ACPI_TYPE_LOCAL_INDEX_FIELD:
347 acpi_os_printf ("Idx [%4.4s] Dat [%4.4s]",
348 acpi_ut_get_node_name (obj_desc->index_field.index_obj->common_field.node),
349 acpi_ut_get_node_name (obj_desc->index_field.data_obj->common_field.node));
353 case ACPI_TYPE_LOCAL_ALIAS:
354 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
356 acpi_os_printf ("Target %4.4s (%p)\n",
357 acpi_ut_get_node_name (obj_desc), obj_desc);
362 acpi_os_printf ("Object %p\n", obj_desc);
366 /* Common field handling */
369 case ACPI_TYPE_BUFFER_FIELD:
370 case ACPI_TYPE_LOCAL_REGION_FIELD:
371 case ACPI_TYPE_LOCAL_BANK_FIELD:
372 case ACPI_TYPE_LOCAL_INDEX_FIELD:
374 acpi_os_printf (" Off %.3X Len %.2X Acc %.2hd\n",
375 (obj_desc->common_field.base_byte_offset * 8)
376 + obj_desc->common_field.start_field_bit_offset,
377 obj_desc->common_field.bit_length,
378 obj_desc->common_field.access_byte_width);
387 case ACPI_DISPLAY_OBJECTS:
389 acpi_os_printf ("O:%p", obj_desc);
391 /* No attached object, we are done */
393 acpi_os_printf ("\n");
397 acpi_os_printf ("(R%d)",
398 obj_desc->common.reference_count);
401 case ACPI_TYPE_METHOD:
403 /* Name is a Method and its AML offset/length are set */
405 acpi_os_printf (" M:%p-%X\n", obj_desc->method.aml_start,
406 obj_desc->method.aml_length);
409 case ACPI_TYPE_INTEGER:
411 acpi_os_printf (" I:%8.8X8.8%X\n",
412 ACPI_FORMAT_UINT64 (obj_desc->integer.value));
415 case ACPI_TYPE_STRING:
417 acpi_os_printf (" S:%p-%X\n", obj_desc->string.pointer,
418 obj_desc->string.length);
421 case ACPI_TYPE_BUFFER:
423 acpi_os_printf (" B:%p-%X\n", obj_desc->buffer.pointer,
424 obj_desc->buffer.length);
429 acpi_os_printf ("\n");
436 acpi_os_printf ("\n");
440 /* If debug turned off, done */
442 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
447 /* If there is an attached object, display it */
449 dbg_level = acpi_dbg_level;
451 obj_desc = acpi_ns_get_attached_object (this_node);
452 acpi_dbg_level = dbg_level;
454 /* Dump attached objects */
457 obj_type = ACPI_TYPE_INVALID;
458 acpi_os_printf (" Attached Object %p: ", obj_desc);
460 /* Decode the type of attached object and dump the contents */
462 switch (ACPI_GET_DESCRIPTOR_TYPE (obj_desc)) {
463 case ACPI_DESC_TYPE_NAMED:
465 acpi_os_printf ("(Ptr to Node)\n");
466 bytes_to_dump = sizeof (struct acpi_namespace_node);
470 case ACPI_DESC_TYPE_OPERAND:
472 obj_type = ACPI_GET_OBJECT_TYPE (obj_desc);
474 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
475 acpi_os_printf ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
480 acpi_os_printf ("(Ptr to ACPI Object type %s, %X)\n",
481 acpi_ut_get_type_name (obj_type), obj_type);
482 bytes_to_dump = sizeof (union acpi_operand_object);
490 "(String or Buffer ptr - not an object descriptor) [%s]\n",
491 acpi_ut_get_descriptor_name (obj_desc));
496 ACPI_DUMP_BUFFER (obj_desc, bytes_to_dump);
498 /* If value is NOT an internal object, we are done */
500 if (ACPI_GET_DESCRIPTOR_TYPE (obj_desc) != ACPI_DESC_TYPE_OPERAND) {
505 * Valid object, get the pointer to next level, if any
508 case ACPI_TYPE_STRING:
509 obj_desc = (void *) obj_desc->string.pointer;
512 case ACPI_TYPE_BUFFER:
513 obj_desc = (void *) obj_desc->buffer.pointer;
516 case ACPI_TYPE_BUFFER_FIELD:
517 obj_desc = (union acpi_operand_object *) obj_desc->buffer_field.buffer_obj;
520 case ACPI_TYPE_PACKAGE:
521 obj_desc = (void *) obj_desc->package.elements;
524 case ACPI_TYPE_METHOD:
525 obj_desc = (void *) obj_desc->method.aml_start;
528 case ACPI_TYPE_LOCAL_REGION_FIELD:
529 obj_desc = (void *) obj_desc->field.region_obj;
532 case ACPI_TYPE_LOCAL_BANK_FIELD:
533 obj_desc = (void *) obj_desc->bank_field.region_obj;
536 case ACPI_TYPE_LOCAL_INDEX_FIELD:
537 obj_desc = (void *) obj_desc->index_field.index_obj;
544 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
548 acpi_os_printf ("\n");
553 #ifdef ACPI_FUTURE_USAGE
555 /*******************************************************************************
557 * FUNCTION: acpi_ns_dump_objects
559 * PARAMETERS: Type - Object type to be dumped
560 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
561 * for an effectively unlimited depth.
562 * owner_id - Dump only objects owned by this ID. Use
563 * ACPI_UINT32_MAX to match all owners.
564 * start_handle - Where in namespace to start/end search
566 * DESCRIPTION: Dump typed objects within the loaded namespace.
567 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
569 ******************************************************************************/
572 acpi_ns_dump_objects (
573 acpi_object_type type,
577 acpi_handle start_handle)
579 struct acpi_walk_info info;
582 ACPI_FUNCTION_ENTRY ();
585 info.debug_level = ACPI_LV_TABLES;
586 info.owner_id = owner_id;
587 info.display_type = display_type;
589 (void) acpi_ns_walk_namespace (type, start_handle, max_depth,
590 ACPI_NS_WALK_NO_UNLOCK, acpi_ns_dump_one_object,
591 (void *) &info, NULL);
595 /*******************************************************************************
597 * FUNCTION: acpi_ns_dump_tables
599 * PARAMETERS: search_base - Root of subtree to be dumped, or
600 * NS_ALL to dump the entire namespace
601 * max_depth - Maximum depth of dump. Use INT_MAX
602 * for an effectively unlimited depth.
604 * DESCRIPTION: Dump the name space, or a portion of it.
606 ******************************************************************************/
609 acpi_ns_dump_tables (
610 acpi_handle search_base,
613 acpi_handle search_handle = search_base;
616 ACPI_FUNCTION_TRACE ("ns_dump_tables");
619 if (!acpi_gbl_root_node) {
621 * If the name space has not been initialized,
622 * there is nothing to dump.
624 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "namespace not initialized!\n"));
628 if (ACPI_NS_ALL == search_base) {
629 /* entire namespace */
631 search_handle = acpi_gbl_root_node;
632 ACPI_DEBUG_PRINT ((ACPI_DB_TABLES, "\\\n"));
635 acpi_ns_dump_objects (ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
636 ACPI_UINT32_MAX, search_handle);
640 #endif /* ACPI_FUTURE_USAGE */
643 /*******************************************************************************
645 * FUNCTION: acpi_ns_dump_entry
647 * PARAMETERS: Handle - Node to be dumped
648 * debug_level - Output level
650 * DESCRIPTION: Dump a single Node
652 ******************************************************************************/
659 struct acpi_walk_info info;
662 ACPI_FUNCTION_ENTRY ();
665 info.debug_level = debug_level;
666 info.owner_id = ACPI_UINT32_MAX;
667 info.display_type = ACPI_DISPLAY_SUMMARY;
669 (void) acpi_ns_dump_one_object (handle, 1, &info, NULL);