?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / drivers / acpi / namespace / nsdump.c
blob1fc4f86676e1969b5981ef6ffae26a853ad74606
1 /******************************************************************************
2 *
3 * Module Name: nsdump - table dumping routines for debug
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2007, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44 #include <acpi/acpi.h>
45 #include <acpi/acnamesp.h>
46 #include <acpi/acparser.h>
47
48 #define _COMPONENT ACPI_NAMESPACE
49 ACPI_MODULE_NAME("nsdump")
50
51 /* Local prototypes */
52 #ifdef ACPI_OBSOLETE_FUNCTIONS
53 void acpi_ns_dump_root_devices(void);
54
55 static acpi_status
56 acpi_ns_dump_one_device(acpi_handle obj_handle,
57 u32 level, void *context, void **return_value);
58 #endif
59
60 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
61 /*******************************************************************************
62 *
63 * FUNCTION: acpi_ns_print_pathname
64 *
65 * PARAMETERS: num_segments - Number of ACPI name segments
66 * Pathname - The compressed (internal) path
67 *
68 * RETURN: None
69 *
70 * DESCRIPTION: Print an object's full namespace pathname
71 *
72 ******************************************************************************/
73
74 void acpi_ns_print_pathname(u32 num_segments, char *pathname)
75 {
76 acpi_native_uint i;
77
78 ACPI_FUNCTION_NAME(ns_print_pathname);
79
80 if (!(acpi_dbg_level & ACPI_LV_NAMES)
81 || !(acpi_dbg_layer & ACPI_NAMESPACE)) {
82 return;
83 }
84
85 /* Print the entire name */
86
87 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "["));
88
89 while (num_segments) {
90 for (i = 0; i < 4; i++) {
91 ACPI_IS_PRINT(pathname[i]) ?
92 acpi_os_printf("%c", pathname[i]) :
93 acpi_os_printf("?");
94 }
95
96 pathname += ACPI_NAME_SIZE;
97 num_segments--;
98 if (num_segments) {
99 acpi_os_printf(".");
100 }
101 }
102
103 acpi_os_printf("]\n");
104 }
105
106 /*******************************************************************************
107 *
108 * FUNCTION: acpi_ns_dump_pathname
109 *
110 * PARAMETERS: Handle - Object
111 * Msg - Prefix message
112 * Level - Desired debug level
113 * Component - Caller's component ID
114 *
115 * RETURN: None
116 *
117 * DESCRIPTION: Print an object's full namespace pathname
118 * Manages allocation/freeing of a pathname buffer
119 *
120 ******************************************************************************/
121
122 void
123 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component)
124 {
125
126 ACPI_FUNCTION_TRACE(ns_dump_pathname);
127
128 /* Do this only if the requested debug level and component are enabled */
129
130 if (!(acpi_dbg_level & level) || !(acpi_dbg_layer & component)) {
131 return_VOID;
132 }
133
134 /* Convert handle to a full pathname and print it (with supplied message) */
135
136 acpi_ns_print_node_pathname(handle, msg);
137 acpi_os_printf("\n");
138 return_VOID;
139 }
140
141 /*******************************************************************************
142 *
143 * FUNCTION: acpi_ns_dump_one_object
144 *
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
149 *
150 * RETURN: Status
151 *
152 * DESCRIPTION: Dump a single Node
153 * This procedure is a user_function called by acpi_ns_walk_namespace.
154 *
155 ******************************************************************************/
156
157 acpi_status
158 acpi_ns_dump_one_object(acpi_handle obj_handle,
159 u32 level, void *context, void **return_value)
160 {
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;
166 u32 bytes_to_dump;
167 u32 dbg_level;
168 u32 i;
169
170 ACPI_FUNCTION_NAME(ns_dump_one_object);
171
172 /* Is output enabled? */
173
174 if (!(acpi_dbg_level & info->debug_level)) {
175 return (AE_OK);
176 }
177
178 if (!obj_handle) {
179 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Null object handle\n"));
180 return (AE_OK);
181 }
182
183 this_node = acpi_ns_map_handle_to_node(obj_handle);
184 type = this_node->type;
185
186 /* Check if the owner matches */
187
188 if ((info->owner_id != ACPI_OWNER_ID_MAX) &&
189 (info->owner_id != this_node->owner_id)) {
190 return (AE_OK);
191 }
192
193 if (!(info->display_type & ACPI_DISPLAY_SHORT)) {
194
195 /* Indent the object according to the level */
196
197 acpi_os_printf("%2d%*s", (u32) level - 1, (int)level * 2, " ");
198
199 /* Check the node type and name */
200
201 if (type > ACPI_TYPE_LOCAL_MAX) {
202 ACPI_WARNING((AE_INFO, "Invalid ACPI Object Type %08X",
203 type));
204 }
205
206 if (!acpi_ut_valid_acpi_name(this_node->name.integer)) {
207 this_node->name.integer =
208 acpi_ut_repair_name(this_node->name.ascii);
209
210 ACPI_WARNING((AE_INFO, "Invalid ACPI Name %08X",
211 this_node->name.integer));
212 }
213
214 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
215 }
216
217 /*
218 * Now we can print out the pertinent information
219 */
220 acpi_os_printf(" %-12s %p %2.2X ",
221 acpi_ut_get_type_name(type), this_node,
222 this_node->owner_id);
223
224 dbg_level = acpi_dbg_level;
225 acpi_dbg_level = 0;
226 obj_desc = acpi_ns_get_attached_object(this_node);
227 acpi_dbg_level = dbg_level;
228
229 /* Temp nodes are those nodes created by a control method */
230
231 if (this_node->flags & ANOBJ_TEMPORARY) {
232 acpi_os_printf("(T) ");
233 }
234
235 switch (info->display_type & ACPI_DISPLAY_MASK) {
236 case ACPI_DISPLAY_SUMMARY:
237
238 if (!obj_desc) {
239
240 /* No attached object, we are done */
241
242 acpi_os_printf("\n");
243 return (AE_OK);
244 }
245
246 switch (type) {
247 case ACPI_TYPE_PROCESSOR:
248
249 acpi_os_printf("ID %X Len %.4X Addr %p\n",
250 obj_desc->processor.proc_id,
251 obj_desc->processor.length,
252 (char *)obj_desc->processor.address);
253 break;
254
255 case ACPI_TYPE_DEVICE:
256
257 acpi_os_printf("Notify Object: %p\n", obj_desc);
258 break;
259
260 case ACPI_TYPE_METHOD:
261
262 acpi_os_printf("Args %X Len %.4X Aml %p\n",
263 (u32) obj_desc->method.param_count,
264 obj_desc->method.aml_length,
265 obj_desc->method.aml_start);
266 break;
267
268 case ACPI_TYPE_INTEGER:
269
270 acpi_os_printf("= %8.8X%8.8X\n",
271 ACPI_FORMAT_UINT64(obj_desc->integer.
272 value));
273 break;
274
275 case ACPI_TYPE_PACKAGE:
276
277 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
278 acpi_os_printf("Elements %.2X\n",
279 obj_desc->package.count);
280 } else {
281 acpi_os_printf("[Length not yet evaluated]\n");
282 }
283 break;
284
285 case ACPI_TYPE_BUFFER:
286
287 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
288 acpi_os_printf("Len %.2X",
289 obj_desc->buffer.length);
290
291 /* Dump some of the buffer */
292
293 if (obj_desc->buffer.length > 0) {
294 acpi_os_printf(" =");
295 for (i = 0;
296 (i < obj_desc->buffer.length
297 && i < 12); i++) {
298 acpi_os_printf(" %.2hX",
299 obj_desc->buffer.
300 pointer[i]);
301 }
302 }
303 acpi_os_printf("\n");
304 } else {
305 acpi_os_printf("[Length not yet evaluated]\n");
306 }
307 break;
308
309 case ACPI_TYPE_STRING:
310
311 acpi_os_printf("Len %.2X ", obj_desc->string.length);
312 acpi_ut_print_string(obj_desc->string.pointer, 32);
313 acpi_os_printf("\n");
314 break;
315
316 case ACPI_TYPE_REGION:
317
318 acpi_os_printf("[%s]",
319 acpi_ut_get_region_name(obj_desc->region.
320 space_id));
321 if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
322 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
323 ACPI_FORMAT_UINT64(obj_desc->
324 region.
325 address),
326 obj_desc->region.length);
327 } else {
328 acpi_os_printf
329 (" [Address/Length not yet evaluated]\n");
330 }
331 break;
332
333 case ACPI_TYPE_LOCAL_REFERENCE:
334
335 acpi_os_printf("[%s]\n",
336 acpi_ps_get_opcode_name(obj_desc->
337 reference.
338 opcode));
339 break;
340
341 case ACPI_TYPE_BUFFER_FIELD:
342
343 if (obj_desc->buffer_field.buffer_obj &&
344 obj_desc->buffer_field.buffer_obj->buffer.node) {
345 acpi_os_printf("Buf [%4.4s]",
346 acpi_ut_get_node_name(obj_desc->
347 buffer_field.
348 buffer_obj->
349 buffer.
350 node));
351 }
352 break;
353
354 case ACPI_TYPE_LOCAL_REGION_FIELD:
355
356 acpi_os_printf("Rgn [%4.4s]",
357 acpi_ut_get_node_name(obj_desc->
358 common_field.
359 region_obj->region.
360 node));
361 break;
362
363 case ACPI_TYPE_LOCAL_BANK_FIELD:
364
365 acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
366 acpi_ut_get_node_name(obj_desc->
367 common_field.
368 region_obj->region.
369 node),
370 acpi_ut_get_node_name(obj_desc->
371 bank_field.
372 bank_obj->
373 common_field.
374 node));
375 break;
376
377 case ACPI_TYPE_LOCAL_INDEX_FIELD:
378
379 acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
380 acpi_ut_get_node_name(obj_desc->
381 index_field.
382 index_obj->
383 common_field.node),
384 acpi_ut_get_node_name(obj_desc->
385 index_field.
386 data_obj->
387 common_field.
388 node));
389 break;
390
391 case ACPI_TYPE_LOCAL_ALIAS:
392 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
393
394 acpi_os_printf("Target %4.4s (%p)\n",
395 acpi_ut_get_node_name(obj_desc),
396 obj_desc);
397 break;
398
399 default:
400
401 acpi_os_printf("Object %p\n", obj_desc);
402 break;
403 }
404
405 /* Common field handling */
406
407 switch (type) {
408 case ACPI_TYPE_BUFFER_FIELD:
409 case ACPI_TYPE_LOCAL_REGION_FIELD:
410 case ACPI_TYPE_LOCAL_BANK_FIELD:
411 case ACPI_TYPE_LOCAL_INDEX_FIELD:
412
413 acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
414 (obj_desc->common_field.
415 base_byte_offset * 8)
416 +
417 obj_desc->common_field.
418 start_field_bit_offset,
419 obj_desc->common_field.bit_length,
420 obj_desc->common_field.
421 access_byte_width);
422 break;
423
424 default:
425 break;
426 }
427 break;
428
429 case ACPI_DISPLAY_OBJECTS:
430
431 acpi_os_printf("O:%p", obj_desc);
432 if (!obj_desc) {
433
434 /* No attached object, we are done */
435
436 acpi_os_printf("\n");
437 return (AE_OK);
438 }
439
440 acpi_os_printf("(R%d)", obj_desc->common.reference_count);
441
442 switch (type) {
443 case ACPI_TYPE_METHOD:
444
445 /* Name is a Method and its AML offset/length are set */
446
447 acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
448 obj_desc->method.aml_length);
449 break;
450
451 case ACPI_TYPE_INTEGER:
452
453 acpi_os_printf(" I:%8.8X8.8%X\n",
454 ACPI_FORMAT_UINT64(obj_desc->integer.
455 value));
456 break;
457
458 case ACPI_TYPE_STRING:
459
460 acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
461 obj_desc->string.length);
462 break;
463
464 case ACPI_TYPE_BUFFER:
465
466 acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
467 obj_desc->buffer.length);
468 break;
469
470 default:
471
472 acpi_os_printf("\n");
473 break;
474 }
475 break;
476
477 default:
478 acpi_os_printf("\n");
479 break;
480 }
481
482 /* If debug turned off, done */
483
484 if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
485 return (AE_OK);
486 }
487
488 /* If there is an attached object, display it */
489
490 dbg_level = acpi_dbg_level;
491 acpi_dbg_level = 0;
492 obj_desc = acpi_ns_get_attached_object(this_node);
493 acpi_dbg_level = dbg_level;
494
495 /* Dump attached objects */
496
497 while (obj_desc) {
498 obj_type = ACPI_TYPE_INVALID;
499 acpi_os_printf("Attached Object %p: ", obj_desc);
500
501 /* Decode the type of attached object and dump the contents */
502
503 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
504 case ACPI_DESC_TYPE_NAMED:
505
506 acpi_os_printf("(Ptr to Node)\n");
507 bytes_to_dump = sizeof(struct acpi_namespace_node);
508 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
509 break;
510
511 case ACPI_DESC_TYPE_OPERAND:
512
513 obj_type = ACPI_GET_OBJECT_TYPE(obj_desc);
514
515 if (obj_type > ACPI_TYPE_LOCAL_MAX) {
516 acpi_os_printf
517 ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
518 obj_type);
519 bytes_to_dump = 32;
520 } else {
521 acpi_os_printf
522 ("(Ptr to ACPI Object type %X [%s])\n",
523 obj_type, acpi_ut_get_type_name(obj_type));
524 bytes_to_dump =
525 sizeof(union acpi_operand_object);
526 }
527
528 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
529 break;
530
531 default:
532
533 break;
534 }
535
536 /* If value is NOT an internal object, we are done */
537
538 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
539 ACPI_DESC_TYPE_OPERAND) {
540 goto cleanup;
541 }
542
543 /*
544 * Valid object, get the pointer to next level, if any
545 */
546 switch (obj_type) {
547 case ACPI_TYPE_BUFFER:
548 case ACPI_TYPE_STRING:
549 /*
550 * NOTE: takes advantage of common fields between string/buffer
551 */
552 bytes_to_dump = obj_desc->string.length;
553 obj_desc = (void *)obj_desc->string.pointer;
554 acpi_os_printf("(Buffer/String pointer %p length %X)\n",
555 obj_desc, bytes_to_dump);
556 ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
557 goto cleanup;
558
559 case ACPI_TYPE_BUFFER_FIELD:
560 obj_desc =
561 (union acpi_operand_object *)obj_desc->buffer_field.
562 buffer_obj;
563 break;
564
565 case ACPI_TYPE_PACKAGE:
566 obj_desc = (void *)obj_desc->package.elements;
567 break;
568
569 case ACPI_TYPE_METHOD:
570 obj_desc = (void *)obj_desc->method.aml_start;
571 break;
572
573 case ACPI_TYPE_LOCAL_REGION_FIELD:
574 obj_desc = (void *)obj_desc->field.region_obj;
575 break;
576
577 case ACPI_TYPE_LOCAL_BANK_FIELD:
578 obj_desc = (void *)obj_desc->bank_field.region_obj;
579 break;
580
581 case ACPI_TYPE_LOCAL_INDEX_FIELD:
582 obj_desc = (void *)obj_desc->index_field.index_obj;
583 break;
584
585 default:
586 goto cleanup;
587 }
588
589 obj_type = ACPI_TYPE_INVALID; /* Terminate loop after next pass */
590 }
591
592 cleanup:
593 acpi_os_printf("\n");
594 return (AE_OK);
595 }
596
597 #ifdef ACPI_FUTURE_USAGE
598 /*******************************************************************************
599 *
600 * FUNCTION: acpi_ns_dump_objects
601 *
602 * PARAMETERS: Type - Object type to be dumped
603 * display_type - 0 or ACPI_DISPLAY_SUMMARY
604 * max_depth - Maximum depth of dump. Use ACPI_UINT32_MAX
605 * for an effectively unlimited depth.
606 * owner_id - Dump only objects owned by this ID. Use
607 * ACPI_UINT32_MAX to match all owners.
608 * start_handle - Where in namespace to start/end search
609 *
610 * RETURN: None
611 *
612 * DESCRIPTION: Dump typed objects within the loaded namespace.
613 * Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
614 *
615 ******************************************************************************/
616
617 void
618 acpi_ns_dump_objects(acpi_object_type type,
619 u8 display_type,
620 u32 max_depth,
621 acpi_owner_id owner_id, acpi_handle start_handle)
622 {
623 struct acpi_walk_info info;
624
625 ACPI_FUNCTION_ENTRY();
626
627 info.debug_level = ACPI_LV_TABLES;
628 info.owner_id = owner_id;
629 info.display_type = display_type;
630
631 (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
632 ACPI_NS_WALK_NO_UNLOCK |
633 ACPI_NS_WALK_TEMP_NODES,
634 acpi_ns_dump_one_object, (void *)&info,
635 NULL);
636 }
637 #endif /* ACPI_FUTURE_USAGE */
638
639 /*******************************************************************************
640 *
641 * FUNCTION: acpi_ns_dump_entry
642 *
643 * PARAMETERS: Handle - Node to be dumped
644 * debug_level - Output level
645 *
646 * RETURN: None
647 *
648 * DESCRIPTION: Dump a single Node
649 *
650 ******************************************************************************/
651
652 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
653 {
654 struct acpi_walk_info info;
655
656 ACPI_FUNCTION_ENTRY();
657
658 info.debug_level = debug_level;
659 info.owner_id = ACPI_OWNER_ID_MAX;
660 info.display_type = ACPI_DISPLAY_SUMMARY;
661
662 (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
663 }
664
665 #ifdef ACPI_ASL_COMPILER
666 /*******************************************************************************
667 *
668 * FUNCTION: acpi_ns_dump_tables
669 *
670 * PARAMETERS: search_base - Root of subtree to be dumped, or
671 * NS_ALL to dump the entire namespace
672 * max_depth - Maximum depth of dump. Use INT_MAX
673 * for an effectively unlimited depth.
674 *
675 * RETURN: None
676 *
677 * DESCRIPTION: Dump the name space, or a portion of it.
678 *
679 ******************************************************************************/
680
681 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
682 {
683 acpi_handle search_handle = search_base;
684
685 ACPI_FUNCTION_TRACE(ns_dump_tables);
686
687 if (!acpi_gbl_root_node) {
688 /*
689 * If the name space has not been initialized,
690 * there is nothing to dump.
691 */
692 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
693 "namespace not initialized!\n"));
694 return_VOID;
695 }
696
697 if (ACPI_NS_ALL == search_base) {
698
699 /* Entire namespace */
700
701 search_handle = acpi_gbl_root_node;
702 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
703 }
704
705 acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
706 ACPI_OWNER_ID_MAX, search_handle);
707 return_VOID;
708 }
709 #endif /* _ACPI_ASL_COMPILER */
710 #endif /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */
mah project overlay