1 /******************************************************************************
3 * Module Name: nsdump - table dumping routines for debug
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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>
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_validate_handle(obj_handle);
185 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Invalid object handle %p\n",
190 type = this_node->type;
192 /* Check if the owner matches */
194 if ((info->owner_id != ACPI_OWNER_ID_MAX) &&
195 (info->owner_id != this_node->owner_id)) {
199 if (!(info->display_type & ACPI_DISPLAY_SHORT)) {
201 /* Indent the object according to the level */
203 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " ");
205 /* Check the node type and name */
207 if (type > ACPI_TYPE_LOCAL_MAX) {
208 ACPI_WARNING((AE_INFO,
209 "Invalid ACPI Object Type 0x%08X", type));
212 if (!acpi_ut_valid_acpi_name(this_node->name.integer)) {
213 this_node->name.integer =
214 acpi_ut_repair_name(this_node->name.ascii);
216 ACPI_WARNING((AE_INFO, "Invalid ACPI Name %08X",
217 this_node->name.integer));
220 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
223 /* Now we can print out the pertinent information */
225 acpi_os_printf(" %-12s %p %2.2X ",
226 acpi_ut_get_type_name(type), this_node,
227 this_node->owner_id);
229 dbg_level = acpi_dbg_level;
231 obj_desc = acpi_ns_get_attached_object(this_node);
232 acpi_dbg_level = dbg_level;
234 /* Temp nodes are those nodes created by a control method */
236 if (this_node->flags & ANOBJ_TEMPORARY) {
237 acpi_os_printf("(T) ");
240 switch (info->display_type & ACPI_DISPLAY_MASK) {
241 case ACPI_DISPLAY_SUMMARY:
245 /* No attached object. Some types should always have an object */
248 case ACPI_TYPE_INTEGER:
249 case ACPI_TYPE_PACKAGE:
250 case ACPI_TYPE_BUFFER:
251 case ACPI_TYPE_STRING:
252 case ACPI_TYPE_METHOD:
253 acpi_os_printf("<No attached object>");
260 acpi_os_printf("\n");
265 case ACPI_TYPE_PROCESSOR:
267 acpi_os_printf("ID %X Len %.4X Addr %p\n",
268 obj_desc->processor.proc_id,
269 obj_desc->processor.length,
275 case ACPI_TYPE_DEVICE:
277 acpi_os_printf("Notify Object: %p\n", obj_desc);
280 case ACPI_TYPE_METHOD:
282 acpi_os_printf("Args %X Len %.4X Aml %p\n",
283 (u32) obj_desc->method.param_count,
284 obj_desc->method.aml_length,
285 obj_desc->method.aml_start);
288 case ACPI_TYPE_INTEGER:
290 acpi_os_printf("= %8.8X%8.8X\n",
291 ACPI_FORMAT_UINT64(obj_desc->integer.
295 case ACPI_TYPE_PACKAGE:
297 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
298 acpi_os_printf("Elements %.2X\n",
299 obj_desc->package.count);
301 acpi_os_printf("[Length not yet evaluated]\n");
305 case ACPI_TYPE_BUFFER:
307 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
308 acpi_os_printf("Len %.2X",
309 obj_desc->buffer.length);
311 /* Dump some of the buffer */
313 if (obj_desc->buffer.length > 0) {
314 acpi_os_printf(" =");
316 (i < obj_desc->buffer.length
318 acpi_os_printf(" %.2hX",
323 acpi_os_printf("\n");
325 acpi_os_printf("[Length not yet evaluated]\n");
329 case ACPI_TYPE_STRING:
331 acpi_os_printf("Len %.2X ", obj_desc->string.length);
332 acpi_ut_print_string(obj_desc->string.pointer, 32);
333 acpi_os_printf("\n");
336 case ACPI_TYPE_REGION:
338 acpi_os_printf("[%s]",
339 acpi_ut_get_region_name(obj_desc->region.
341 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
342 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
343 ACPI_FORMAT_NATIVE_UINT
344 (obj_desc->region.address),
345 obj_desc->region.length);
348 (" [Address/Length not yet evaluated]\n");
352 case ACPI_TYPE_LOCAL_REFERENCE:
354 acpi_os_printf("[%s]\n",
355 acpi_ut_get_reference_name(obj_desc));
358 case ACPI_TYPE_BUFFER_FIELD:
360 if (obj_desc->buffer_field.buffer_obj &&
361 obj_desc->buffer_field.buffer_obj->buffer.node) {
362 acpi_os_printf("Buf [%4.4s]",
363 acpi_ut_get_node_name(obj_desc->
371 case ACPI_TYPE_LOCAL_REGION_FIELD:
373 acpi_os_printf("Rgn [%4.4s]",
374 acpi_ut_get_node_name(obj_desc->
380 case ACPI_TYPE_LOCAL_BANK_FIELD:
382 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
383 acpi_ut_get_node_name(obj_desc->
387 acpi_ut_get_node_name(obj_desc->
394 case ACPI_TYPE_LOCAL_INDEX_FIELD:
396 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
397 acpi_ut_get_node_name(obj_desc->
401 acpi_ut_get_node_name(obj_desc->
408 case ACPI_TYPE_LOCAL_ALIAS:
409 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
411 acpi_os_printf("Target %4.4s (%p)\n",
412 acpi_ut_get_node_name(obj_desc),
418 acpi_os_printf("Object %p\n", obj_desc);
422 /* Common field handling */
425 case ACPI_TYPE_BUFFER_FIELD:
426 case ACPI_TYPE_LOCAL_REGION_FIELD:
427 case ACPI_TYPE_LOCAL_BANK_FIELD:
428 case ACPI_TYPE_LOCAL_INDEX_FIELD:
430 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
431 (obj_desc->common_field.
432 base_byte_offset * 8)
434 obj_desc->common_field.
435 start_field_bit_offset,
436 obj_desc->common_field.bit_length,
437 obj_desc->common_field.
446 case ACPI_DISPLAY_OBJECTS:
448 acpi_os_printf("O:%p", obj_desc);
451 /* No attached object, we are done */
453 acpi_os_printf("\n");
457 acpi_os_printf("(R%u)", obj_desc->common.reference_count);
460 case ACPI_TYPE_METHOD:
462 /* Name is a Method and its AML offset/length are set */
464 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
465 obj_desc->method.aml_length);
468 case ACPI_TYPE_INTEGER:
470 acpi_os_printf(" I:%8.8X8.8%X\n",
471 ACPI_FORMAT_UINT64(obj_desc->integer.
475 case ACPI_TYPE_STRING:
477 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
478 obj_desc->string.length);
481 case ACPI_TYPE_BUFFER:
483 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
484 obj_desc->buffer.length);
489 acpi_os_printf("\n");
495 acpi_os_printf("\n");
499 /* If debug turned off, done */
501 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
505 /* If there is an attached object, display it */
507 dbg_level = acpi_dbg_level;
509 obj_desc = acpi_ns_get_attached_object(this_node);
510 acpi_dbg_level = dbg_level;
512 /* Dump attached objects */
515 obj_type = ACPI_TYPE_INVALID;
516 acpi_os_printf("Attached Object %p: ", obj_desc);
518 /* Decode the type of attached object and dump the contents */
520 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
521 case ACPI_DESC_TYPE_NAMED:
523 acpi_os_printf("(Ptr to Node)\n");
524 bytes_to_dump = sizeof(struct acpi_namespace_node);
525 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
528 case ACPI_DESC_TYPE_OPERAND:
530 obj_type = obj_desc->common.type;
532 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
534 ("(Pointer to ACPI Object type %.2X [UNKNOWN])\n",
539 ("(Pointer to ACPI Object type %.2X [%s])\n",
540 obj_type, acpi_ut_get_type_name(obj_type));
542 sizeof(union acpi_operand_object);
545 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
553 /* If value is NOT an internal object, we are done */
555 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
556 ACPI_DESC_TYPE_OPERAND) {
560 /* Valid object, get the pointer to next level, if any */
563 case ACPI_TYPE_BUFFER:
564 case ACPI_TYPE_STRING:
566 * NOTE: takes advantage of common fields between string/buffer
568 bytes_to_dump = obj_desc->string.length;
569 obj_desc = (void *)obj_desc->string.pointer;
570 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
571 obj_desc, bytes_to_dump);
572 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
575 case ACPI_TYPE_BUFFER_FIELD:
577 (union acpi_operand_object *)obj_desc->buffer_field.
581 case ACPI_TYPE_PACKAGE:
582 obj_desc = (void *)obj_desc->package.elements;
585 case ACPI_TYPE_METHOD:
586 obj_desc = (void *)obj_desc->method.aml_start;
589 case ACPI_TYPE_LOCAL_REGION_FIELD:
590 obj_desc = (void *)obj_desc->field.region_obj;
593 case ACPI_TYPE_LOCAL_BANK_FIELD:
594 obj_desc = (void *)obj_desc->bank_field.region_obj;
597 case ACPI_TYPE_LOCAL_INDEX_FIELD:
598 obj_desc = (void *)obj_desc->index_field.index_obj;
605 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
609 acpi_os_printf("\n");
613 #ifdef ACPI_FUTURE_USAGE
614 /*******************************************************************************
616 * FUNCTION: acpi_ns_dump_objects
618 * PARAMETERS: Type - Object type to be dumped
619 * display_type - 0 or ACPI_DISPLAY_SUMMARY
620 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
621 * for an effectively unlimited depth.
622 * owner_id - Dump only objects owned by this ID. Use
623 * ACPI_UINT32_MAX to match all owners.
624 * start_handle - Where in namespace to start/end search
628 * DESCRIPTION: Dump typed objects within the loaded namespace. Uses
629 * acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
631 ******************************************************************************/
634 acpi_ns_dump_objects(acpi_object_type type,
637 acpi_owner_id owner_id, acpi_handle start_handle)
639 struct acpi_walk_info info;
642 ACPI_FUNCTION_ENTRY();
645 * Just lock the entire namespace for the duration of the dump.
646 * We don't want any changes to the namespace during this time,
647 * especially the temporary nodes since we are going to display
650 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
651 if (ACPI_FAILURE(status)) {
652 acpi_os_printf("Could not acquire namespace mutex\n");
656 info.debug_level = ACPI_LV_TABLES;
657 info.owner_id = owner_id;
658 info.display_type = display_type;
660 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
661 ACPI_NS_WALK_NO_UNLOCK |
662 ACPI_NS_WALK_TEMP_NODES,
663 acpi_ns_dump_one_object, NULL,
664 (void *)&info, NULL);
666 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
668 #endif /* ACPI_FUTURE_USAGE */
670 /*******************************************************************************
672 * FUNCTION: acpi_ns_dump_entry
674 * PARAMETERS: Handle - Node to be dumped
675 * debug_level - Output level
679 * DESCRIPTION: Dump a single Node
681 ******************************************************************************/
683 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
685 struct acpi_walk_info info;
687 ACPI_FUNCTION_ENTRY();
689 info.debug_level = debug_level;
690 info.owner_id = ACPI_OWNER_ID_MAX;
691 info.display_type = ACPI_DISPLAY_SUMMARY;
693 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
696 #ifdef ACPI_ASL_COMPILER
697 /*******************************************************************************
699 * FUNCTION: acpi_ns_dump_tables
701 * PARAMETERS: search_base - Root of subtree to be dumped, or
702 * NS_ALL to dump the entire namespace
703 * max_depth - Maximum depth of dump. Use INT_MAX
704 * for an effectively unlimited depth.
708 * DESCRIPTION: Dump the name space, or a portion of it.
710 ******************************************************************************/
712 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
714 acpi_handle search_handle = search_base;
716 ACPI_FUNCTION_TRACE(ns_dump_tables);
718 if (!acpi_gbl_root_node) {
720 * If the name space has not been initialized,
721 * there is nothing to dump.
723 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
724 "namespace not initialized!\n"));
728 if (ACPI_NS_ALL == search_base) {
730 /* Entire namespace */
732 search_handle = acpi_gbl_root_node;
733 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
736 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
737 ACPI_OWNER_ID_MAX, search_handle);
740 #endif /* _ACPI_ASL_COMPILER */
741 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */