1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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>
47 #include <acpi/acoutput.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsdump")
52 /* Local prototypes */
53 #ifdef ACPI_OBSOLETE_FUNCTIONS
54 void acpi_ns_dump_root_devices(void);
57 acpi_ns_dump_one_device(acpi_handle obj_handle,
58 u32 level, void *context, void **return_value);
61 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
62 /*******************************************************************************
64 * FUNCTION: acpi_ns_print_pathname
66 * PARAMETERS: num_segments - Number of ACPI name segments
67 * pathname - The compressed (internal) path
71 * DESCRIPTION: Print an object's full namespace pathname
73 ******************************************************************************/
75 void acpi_ns_print_pathname(u32 num_segments, char *pathname)
79 ACPI_FUNCTION_NAME(ns_print_pathname);
81 /* Check if debug output enabled */
83 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_NAMES, ACPI_NAMESPACE)) {
87 /* Print the entire name */
89 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "["));
91 while (num_segments) {
92 for (i = 0; i < 4; i++) {
93 ACPI_IS_PRINT(pathname[i]) ?
94 acpi_os_printf("%c", pathname[i]) :
98 pathname += ACPI_NAME_SIZE;
105 acpi_os_printf("]\n");
108 /*******************************************************************************
110 * FUNCTION: acpi_ns_dump_pathname
112 * PARAMETERS: handle - Object
113 * msg - Prefix message
114 * level - Desired debug level
115 * component - Caller's component ID
119 * DESCRIPTION: Print an object's full namespace pathname
120 * Manages allocation/freeing of a pathname buffer
122 ******************************************************************************/
125 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component)
128 ACPI_FUNCTION_TRACE(ns_dump_pathname);
130 /* Do this only if the requested debug level and component are enabled */
132 if (!ACPI_IS_DEBUG_ENABLED(level, component)) {
136 /* Convert handle to a full pathname and print it (with supplied message) */
138 acpi_ns_print_node_pathname(handle, msg);
139 acpi_os_printf("\n");
143 /*******************************************************************************
145 * FUNCTION: acpi_ns_dump_one_object
147 * PARAMETERS: obj_handle - Node to be dumped
148 * level - Nesting level of the handle
149 * context - Passed into walk_namespace
150 * return_value - Not used
154 * DESCRIPTION: Dump a single Node
155 * This procedure is a user_function called by acpi_ns_walk_namespace.
157 ******************************************************************************/
160 acpi_ns_dump_one_object(acpi_handle obj_handle,
161 u32 level, void *context, void **return_value)
163 struct acpi_walk_info *info = (struct acpi_walk_info *)context;
164 struct acpi_namespace_node *this_node;
165 union acpi_operand_object *obj_desc = NULL;
166 acpi_object_type obj_type;
167 acpi_object_type type;
172 ACPI_FUNCTION_NAME(ns_dump_one_object);
174 /* Is output enabled? */
176 if (!(acpi_dbg_level & info->debug_level)) {
181 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Null object handle\n"));
185 this_node = acpi_ns_validate_handle(obj_handle);
187 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Invalid object handle %p\n",
192 type = this_node->type;
194 /* Check if the owner matches */
196 if ((info->owner_id != ACPI_OWNER_ID_MAX) &&
197 (info->owner_id != this_node->owner_id)) {
201 if (!(info->display_type & ACPI_DISPLAY_SHORT)) {
203 /* Indent the object according to the level */
205 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " ");
207 /* Check the node type and name */
209 if (type > ACPI_TYPE_LOCAL_MAX) {
210 ACPI_WARNING((AE_INFO,
211 "Invalid ACPI Object Type 0x%08X", type));
214 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
217 /* Now we can print out the pertinent information */
219 acpi_os_printf(" %-12s %p %2.2X ",
220 acpi_ut_get_type_name(type), this_node,
221 this_node->owner_id);
223 dbg_level = acpi_dbg_level;
225 obj_desc = acpi_ns_get_attached_object(this_node);
226 acpi_dbg_level = dbg_level;
228 /* Temp nodes are those nodes created by a control method */
230 if (this_node->flags & ANOBJ_TEMPORARY) {
231 acpi_os_printf("(T) ");
234 switch (info->display_type & ACPI_DISPLAY_MASK) {
235 case ACPI_DISPLAY_SUMMARY:
239 /* No attached object. Some types should always have an object */
242 case ACPI_TYPE_INTEGER:
243 case ACPI_TYPE_PACKAGE:
244 case ACPI_TYPE_BUFFER:
245 case ACPI_TYPE_STRING:
246 case ACPI_TYPE_METHOD:
247 acpi_os_printf("<No attached object>");
254 acpi_os_printf("\n");
259 case ACPI_TYPE_PROCESSOR:
261 acpi_os_printf("ID %02X Len %02X Addr %p\n",
262 obj_desc->processor.proc_id,
263 obj_desc->processor.length,
269 case ACPI_TYPE_DEVICE:
271 acpi_os_printf("Notify Object: %p\n", obj_desc);
274 case ACPI_TYPE_METHOD:
276 acpi_os_printf("Args %X Len %.4X Aml %p\n",
277 (u32) obj_desc->method.param_count,
278 obj_desc->method.aml_length,
279 obj_desc->method.aml_start);
282 case ACPI_TYPE_INTEGER:
284 acpi_os_printf("= %8.8X%8.8X\n",
285 ACPI_FORMAT_UINT64(obj_desc->integer.
289 case ACPI_TYPE_PACKAGE:
291 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
292 acpi_os_printf("Elements %.2X\n",
293 obj_desc->package.count);
295 acpi_os_printf("[Length not yet evaluated]\n");
299 case ACPI_TYPE_BUFFER:
301 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
302 acpi_os_printf("Len %.2X",
303 obj_desc->buffer.length);
305 /* Dump some of the buffer */
307 if (obj_desc->buffer.length > 0) {
308 acpi_os_printf(" =");
310 (i < obj_desc->buffer.length
312 acpi_os_printf(" %.2hX",
317 acpi_os_printf("\n");
319 acpi_os_printf("[Length not yet evaluated]\n");
323 case ACPI_TYPE_STRING:
325 acpi_os_printf("Len %.2X ", obj_desc->string.length);
326 acpi_ut_print_string(obj_desc->string.pointer, 32);
327 acpi_os_printf("\n");
330 case ACPI_TYPE_REGION:
332 acpi_os_printf("[%s]",
333 acpi_ut_get_region_name(obj_desc->region.
335 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
336 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
337 ACPI_FORMAT_NATIVE_UINT
338 (obj_desc->region.address),
339 obj_desc->region.length);
342 (" [Address/Length not yet evaluated]\n");
346 case ACPI_TYPE_LOCAL_REFERENCE:
348 acpi_os_printf("[%s]\n",
349 acpi_ut_get_reference_name(obj_desc));
352 case ACPI_TYPE_BUFFER_FIELD:
354 if (obj_desc->buffer_field.buffer_obj &&
355 obj_desc->buffer_field.buffer_obj->buffer.node) {
356 acpi_os_printf("Buf [%4.4s]",
357 acpi_ut_get_node_name(obj_desc->
365 case ACPI_TYPE_LOCAL_REGION_FIELD:
367 acpi_os_printf("Rgn [%4.4s]",
368 acpi_ut_get_node_name(obj_desc->
374 case ACPI_TYPE_LOCAL_BANK_FIELD:
376 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
377 acpi_ut_get_node_name(obj_desc->
381 acpi_ut_get_node_name(obj_desc->
388 case ACPI_TYPE_LOCAL_INDEX_FIELD:
390 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
391 acpi_ut_get_node_name(obj_desc->
395 acpi_ut_get_node_name(obj_desc->
402 case ACPI_TYPE_LOCAL_ALIAS:
403 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
405 acpi_os_printf("Target %4.4s (%p)\n",
406 acpi_ut_get_node_name(obj_desc),
412 acpi_os_printf("Object %p\n", obj_desc);
416 /* Common field handling */
419 case ACPI_TYPE_BUFFER_FIELD:
420 case ACPI_TYPE_LOCAL_REGION_FIELD:
421 case ACPI_TYPE_LOCAL_BANK_FIELD:
422 case ACPI_TYPE_LOCAL_INDEX_FIELD:
424 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
425 (obj_desc->common_field.
426 base_byte_offset * 8)
428 obj_desc->common_field.
429 start_field_bit_offset,
430 obj_desc->common_field.bit_length,
431 obj_desc->common_field.
440 case ACPI_DISPLAY_OBJECTS:
442 acpi_os_printf("O:%p", obj_desc);
445 /* No attached object, we are done */
447 acpi_os_printf("\n");
451 acpi_os_printf("(R%u)", obj_desc->common.reference_count);
454 case ACPI_TYPE_METHOD:
456 /* Name is a Method and its AML offset/length are set */
458 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
459 obj_desc->method.aml_length);
462 case ACPI_TYPE_INTEGER:
464 acpi_os_printf(" I:%8.8X8.8%X\n",
465 ACPI_FORMAT_UINT64(obj_desc->integer.
469 case ACPI_TYPE_STRING:
471 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
472 obj_desc->string.length);
475 case ACPI_TYPE_BUFFER:
477 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
478 obj_desc->buffer.length);
483 acpi_os_printf("\n");
489 acpi_os_printf("\n");
493 /* If debug turned off, done */
495 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
499 /* If there is an attached object, display it */
501 dbg_level = acpi_dbg_level;
503 obj_desc = acpi_ns_get_attached_object(this_node);
504 acpi_dbg_level = dbg_level;
506 /* Dump attached objects */
509 obj_type = ACPI_TYPE_INVALID;
510 acpi_os_printf("Attached Object %p: ", obj_desc);
512 /* Decode the type of attached object and dump the contents */
514 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
515 case ACPI_DESC_TYPE_NAMED:
517 acpi_os_printf("(Ptr to Node)\n");
518 bytes_to_dump = sizeof(struct acpi_namespace_node);
519 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
522 case ACPI_DESC_TYPE_OPERAND:
524 obj_type = obj_desc->common.type;
526 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
528 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
533 ("(Pointer to ACPI Object type %.2X [%s])\n",
534 obj_type, acpi_ut_get_type_name(obj_type));
536 sizeof(union acpi_operand_object);
539 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
547 /* If value is NOT an internal object, we are done */
549 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
550 ACPI_DESC_TYPE_OPERAND) {
554 /* Valid object, get the pointer to next level, if any */
557 case ACPI_TYPE_BUFFER:
558 case ACPI_TYPE_STRING:
560 * NOTE: takes advantage of common fields between string/buffer
562 bytes_to_dump = obj_desc->string.length;
563 obj_desc = (void *)obj_desc->string.pointer;
564 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
565 obj_desc, bytes_to_dump);
566 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
569 case ACPI_TYPE_BUFFER_FIELD:
571 (union acpi_operand_object *)obj_desc->buffer_field.
575 case ACPI_TYPE_PACKAGE:
576 obj_desc = (void *)obj_desc->package.elements;
579 case ACPI_TYPE_METHOD:
580 obj_desc = (void *)obj_desc->method.aml_start;
583 case ACPI_TYPE_LOCAL_REGION_FIELD:
584 obj_desc = (void *)obj_desc->field.region_obj;
587 case ACPI_TYPE_LOCAL_BANK_FIELD:
588 obj_desc = (void *)obj_desc->bank_field.region_obj;
591 case ACPI_TYPE_LOCAL_INDEX_FIELD:
592 obj_desc = (void *)obj_desc->index_field.index_obj;
599 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
603 acpi_os_printf("\n");
607 #ifdef ACPI_FUTURE_USAGE
608 /*******************************************************************************
610 * FUNCTION: acpi_ns_dump_objects
612 * PARAMETERS: type - Object type to be dumped
613 * display_type - 0 or ACPI_DISPLAY_SUMMARY
614 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
615 * for an effectively unlimited depth.
616 * owner_id - Dump only objects owned by this ID. Use
617 * ACPI_UINT32_MAX to match all owners.
618 * start_handle - Where in namespace to start/end search
622 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses
623 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
625 ******************************************************************************/
628 acpi_ns_dump_objects(acpi_object_type type,
631 acpi_owner_id owner_id, acpi_handle start_handle)
633 struct acpi_walk_info info;
636 ACPI_FUNCTION_ENTRY();
639 * Just lock the entire namespace for the duration of the dump.
640 * We don't want any changes to the namespace during this time,
641 * especially the temporary nodes since we are going to display
644 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
645 if (ACPI_FAILURE(status)) {
646 acpi_os_printf("Could not acquire namespace mutex\n");
650 info.debug_level = ACPI_LV_TABLES;
651 info.owner_id = owner_id;
652 info.display_type = display_type;
654 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
655 ACPI_NS_WALK_NO_UNLOCK |
656 ACPI_NS_WALK_TEMP_NODES,
657 acpi_ns_dump_one_object, NULL,
658 (void *)&info, NULL);
660 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
662 #endif /* ACPI_FUTURE_USAGE */
664 /*******************************************************************************
666 * FUNCTION: acpi_ns_dump_entry
668 * PARAMETERS: handle - Node to be dumped
669 * debug_level - Output level
673 * DESCRIPTION: Dump a single Node
675 ******************************************************************************/
677 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
679 struct acpi_walk_info info;
681 ACPI_FUNCTION_ENTRY();
683 info.debug_level = debug_level;
684 info.owner_id = ACPI_OWNER_ID_MAX;
685 info.display_type = ACPI_DISPLAY_SUMMARY;
687 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
690 #ifdef ACPI_ASL_COMPILER
691 /*******************************************************************************
693 * FUNCTION: acpi_ns_dump_tables
695 * PARAMETERS: search_base - Root of subtree to be dumped, or
696 * NS_ALL to dump the entire namespace
697 * max_depth - Maximum depth of dump. Use INT_MAX
698 * for an effectively unlimited depth.
702 * DESCRIPTION: Dump the name space, or a portion of it.
704 ******************************************************************************/
706 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
708 acpi_handle search_handle = search_base;
710 ACPI_FUNCTION_TRACE(ns_dump_tables);
712 if (!acpi_gbl_root_node) {
714 * If the name space has not been initialized,
715 * there is nothing to dump.
717 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
718 "namespace not initialized!\n"));
722 if (ACPI_NS_ALL == search_base) {
724 /* Entire namespace */
726 search_handle = acpi_gbl_root_node;
727 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
730 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
731 ACPI_OWNER_ID_MAX, search_handle);