[ACPI] ACPICA 20060210
[pandora-kernel.git] / drivers / acpi / namespace / nsdump.c
1 /******************************************************************************
2  *
3  * Module Name: nsdump - table dumping routines for debug
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, 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                         ACPI_WARNING((AE_INFO, "Invalid ACPI Name %08X",
208                                       this_node->name.integer));
209                 }
210
211                 acpi_os_printf("%4.4s", acpi_ut_get_node_name(this_node));
212         }
213
214         /*
215          * Now we can print out the pertinent information
216          */
217         acpi_os_printf(" %-12s %p %2.2X ",
218                        acpi_ut_get_type_name(type), this_node,
219                        this_node->owner_id);
220
221         dbg_level = acpi_dbg_level;
222         acpi_dbg_level = 0;
223         obj_desc = acpi_ns_get_attached_object(this_node);
224         acpi_dbg_level = dbg_level;
225
226         switch (info->display_type & ACPI_DISPLAY_MASK) {
227         case ACPI_DISPLAY_SUMMARY:
228
229                 if (!obj_desc) {
230
231                         /* No attached object, we are done */
232
233                         acpi_os_printf("\n");
234                         return (AE_OK);
235                 }
236
237                 switch (type) {
238                 case ACPI_TYPE_PROCESSOR:
239
240                         acpi_os_printf("ID %X Len %.4X Addr %p\n",
241                                        obj_desc->processor.proc_id,
242                                        obj_desc->processor.length,
243                                        (char *)obj_desc->processor.address);
244                         break;
245
246                 case ACPI_TYPE_DEVICE:
247
248                         acpi_os_printf("Notify Object: %p\n", obj_desc);
249                         break;
250
251                 case ACPI_TYPE_METHOD:
252
253                         acpi_os_printf("Args %X Len %.4X Aml %p\n",
254                                        (u32) obj_desc->method.param_count,
255                                        obj_desc->method.aml_length,
256                                        obj_desc->method.aml_start);
257                         break;
258
259                 case ACPI_TYPE_INTEGER:
260
261                         acpi_os_printf("= %8.8X%8.8X\n",
262                                        ACPI_FORMAT_UINT64(obj_desc->integer.
263                                                           value));
264                         break;
265
266                 case ACPI_TYPE_PACKAGE:
267
268                         if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
269                                 acpi_os_printf("Elements %.2X\n",
270                                                obj_desc->package.count);
271                         } else {
272                                 acpi_os_printf("[Length not yet evaluated]\n");
273                         }
274                         break;
275
276                 case ACPI_TYPE_BUFFER:
277
278                         if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
279                                 acpi_os_printf("Len %.2X",
280                                                obj_desc->buffer.length);
281
282                                 /* Dump some of the buffer */
283
284                                 if (obj_desc->buffer.length > 0) {
285                                         acpi_os_printf(" =");
286                                         for (i = 0;
287                                              (i < obj_desc->buffer.length
288                                               && i < 12); i++) {
289                                                 acpi_os_printf(" %.2hX",
290                                                                obj_desc->buffer.
291                                                                pointer[i]);
292                                         }
293                                 }
294                                 acpi_os_printf("\n");
295                         } else {
296                                 acpi_os_printf("[Length not yet evaluated]\n");
297                         }
298                         break;
299
300                 case ACPI_TYPE_STRING:
301
302                         acpi_os_printf("Len %.2X ", obj_desc->string.length);
303                         acpi_ut_print_string(obj_desc->string.pointer, 32);
304                         acpi_os_printf("\n");
305                         break;
306
307                 case ACPI_TYPE_REGION:
308
309                         acpi_os_printf("[%s]",
310                                        acpi_ut_get_region_name(obj_desc->region.
311                                                                space_id));
312                         if (obj_desc->region.flags & AOPOBJ_DATA_VALID) {
313                                 acpi_os_printf(" Addr %8.8X%8.8X Len %.4X\n",
314                                                ACPI_FORMAT_UINT64(obj_desc->
315                                                                   region.
316                                                                   address),
317                                                obj_desc->region.length);
318                         } else {
319                                 acpi_os_printf
320                                     (" [Address/Length not yet evaluated]\n");
321                         }
322                         break;
323
324                 case ACPI_TYPE_LOCAL_REFERENCE:
325
326                         acpi_os_printf("[%s]\n",
327                                        acpi_ps_get_opcode_name(obj_desc->
328                                                                reference.
329                                                                opcode));
330                         break;
331
332                 case ACPI_TYPE_BUFFER_FIELD:
333
334                         if (obj_desc->buffer_field.buffer_obj &&
335                             obj_desc->buffer_field.buffer_obj->buffer.node) {
336                                 acpi_os_printf("Buf [%4.4s]",
337                                                acpi_ut_get_node_name(obj_desc->
338                                                                      buffer_field.
339                                                                      buffer_obj->
340                                                                      buffer.
341                                                                      node));
342                         }
343                         break;
344
345                 case ACPI_TYPE_LOCAL_REGION_FIELD:
346
347                         acpi_os_printf("Rgn [%4.4s]",
348                                        acpi_ut_get_node_name(obj_desc->
349                                                              common_field.
350                                                              region_obj->region.
351                                                              node));
352                         break;
353
354                 case ACPI_TYPE_LOCAL_BANK_FIELD:
355
356                         acpi_os_printf("Rgn [%4.4s] Bnk [%4.4s]",
357                                        acpi_ut_get_node_name(obj_desc->
358                                                              common_field.
359                                                              region_obj->region.
360                                                              node),
361                                        acpi_ut_get_node_name(obj_desc->
362                                                              bank_field.
363                                                              bank_obj->
364                                                              common_field.
365                                                              node));
366                         break;
367
368                 case ACPI_TYPE_LOCAL_INDEX_FIELD:
369
370                         acpi_os_printf("Idx [%4.4s] Dat [%4.4s]",
371                                        acpi_ut_get_node_name(obj_desc->
372                                                              index_field.
373                                                              index_obj->
374                                                              common_field.node),
375                                        acpi_ut_get_node_name(obj_desc->
376                                                              index_field.
377                                                              data_obj->
378                                                              common_field.
379                                                              node));
380                         break;
381
382                 case ACPI_TYPE_LOCAL_ALIAS:
383                 case ACPI_TYPE_LOCAL_METHOD_ALIAS:
384
385                         acpi_os_printf("Target %4.4s (%p)\n",
386                                        acpi_ut_get_node_name(obj_desc),
387                                        obj_desc);
388                         break;
389
390                 default:
391
392                         acpi_os_printf("Object %p\n", obj_desc);
393                         break;
394                 }
395
396                 /* Common field handling */
397
398                 switch (type) {
399                 case ACPI_TYPE_BUFFER_FIELD:
400                 case ACPI_TYPE_LOCAL_REGION_FIELD:
401                 case ACPI_TYPE_LOCAL_BANK_FIELD:
402                 case ACPI_TYPE_LOCAL_INDEX_FIELD:
403
404                         acpi_os_printf(" Off %.3X Len %.2X Acc %.2hd\n",
405                                        (obj_desc->common_field.
406                                         base_byte_offset * 8)
407                                        +
408                                        obj_desc->common_field.
409                                        start_field_bit_offset,
410                                        obj_desc->common_field.bit_length,
411                                        obj_desc->common_field.
412                                        access_byte_width);
413                         break;
414
415                 default:
416                         break;
417                 }
418                 break;
419
420         case ACPI_DISPLAY_OBJECTS:
421
422                 acpi_os_printf("O:%p", obj_desc);
423                 if (!obj_desc) {
424
425                         /* No attached object, we are done */
426
427                         acpi_os_printf("\n");
428                         return (AE_OK);
429                 }
430
431                 acpi_os_printf("(R%d)", obj_desc->common.reference_count);
432
433                 switch (type) {
434                 case ACPI_TYPE_METHOD:
435
436                         /* Name is a Method and its AML offset/length are set */
437
438                         acpi_os_printf(" M:%p-%X\n", obj_desc->method.aml_start,
439                                        obj_desc->method.aml_length);
440                         break;
441
442                 case ACPI_TYPE_INTEGER:
443
444                         acpi_os_printf(" I:%8.8X8.8%X\n",
445                                        ACPI_FORMAT_UINT64(obj_desc->integer.
446                                                           value));
447                         break;
448
449                 case ACPI_TYPE_STRING:
450
451                         acpi_os_printf(" S:%p-%X\n", obj_desc->string.pointer,
452                                        obj_desc->string.length);
453                         break;
454
455                 case ACPI_TYPE_BUFFER:
456
457                         acpi_os_printf(" B:%p-%X\n", obj_desc->buffer.pointer,
458                                        obj_desc->buffer.length);
459                         break;
460
461                 default:
462
463                         acpi_os_printf("\n");
464                         break;
465                 }
466                 break;
467
468         default:
469                 acpi_os_printf("\n");
470                 break;
471         }
472
473         /* If debug turned off, done */
474
475         if (!(acpi_dbg_level & ACPI_LV_VALUES)) {
476                 return (AE_OK);
477         }
478
479         /* If there is an attached object, display it */
480
481         dbg_level = acpi_dbg_level;
482         acpi_dbg_level = 0;
483         obj_desc = acpi_ns_get_attached_object(this_node);
484         acpi_dbg_level = dbg_level;
485
486         /* Dump attached objects */
487
488         while (obj_desc) {
489                 obj_type = ACPI_TYPE_INVALID;
490                 acpi_os_printf("Attached Object %p: ", obj_desc);
491
492                 /* Decode the type of attached object and dump the contents */
493
494                 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
495                 case ACPI_DESC_TYPE_NAMED:
496
497                         acpi_os_printf("(Ptr to Node)\n");
498                         bytes_to_dump = sizeof(struct acpi_namespace_node);
499                         ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
500                         break;
501
502                 case ACPI_DESC_TYPE_OPERAND:
503
504                         obj_type = ACPI_GET_OBJECT_TYPE(obj_desc);
505
506                         if (obj_type > ACPI_TYPE_LOCAL_MAX) {
507                                 acpi_os_printf
508                                     ("(Ptr to ACPI Object type %X [UNKNOWN])\n",
509                                      obj_type);
510                                 bytes_to_dump = 32;
511                         } else {
512                                 acpi_os_printf
513                                     ("(Ptr to ACPI Object type %X [%s])\n",
514                                      obj_type, acpi_ut_get_type_name(obj_type));
515                                 bytes_to_dump =
516                                     sizeof(union acpi_operand_object);
517                         }
518
519                         ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
520                         break;
521
522                 default:
523
524                         break;
525                 }
526
527                 /* If value is NOT an internal object, we are done */
528
529                 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) !=
530                     ACPI_DESC_TYPE_OPERAND) {
531                         goto cleanup;
532                 }
533
534                 /*
535                  * Valid object, get the pointer to next level, if any
536                  */
537                 switch (obj_type) {
538                 case ACPI_TYPE_BUFFER:
539                 case ACPI_TYPE_STRING:
540                         /*
541                          * NOTE: takes advantage of common fields between string/buffer
542                          */
543                         bytes_to_dump = obj_desc->string.length;
544                         obj_desc = (void *)obj_desc->string.pointer;
545                         acpi_os_printf("(Buffer/String pointer %p length %X)\n",
546                                        obj_desc, bytes_to_dump);
547                         ACPI_DUMP_BUFFER(obj_desc, bytes_to_dump);
548                         goto cleanup;
549
550                 case ACPI_TYPE_BUFFER_FIELD:
551                         obj_desc =
552                             (union acpi_operand_object *)obj_desc->buffer_field.
553                             buffer_obj;
554                         break;
555
556                 case ACPI_TYPE_PACKAGE:
557                         obj_desc = (void *)obj_desc->package.elements;
558                         break;
559
560                 case ACPI_TYPE_METHOD:
561                         obj_desc = (void *)obj_desc->method.aml_start;
562                         break;
563
564                 case ACPI_TYPE_LOCAL_REGION_FIELD:
565                         obj_desc = (void *)obj_desc->field.region_obj;
566                         break;
567
568                 case ACPI_TYPE_LOCAL_BANK_FIELD:
569                         obj_desc = (void *)obj_desc->bank_field.region_obj;
570                         break;
571
572                 case ACPI_TYPE_LOCAL_INDEX_FIELD:
573                         obj_desc = (void *)obj_desc->index_field.index_obj;
574                         break;
575
576                 default:
577                         goto cleanup;
578                 }
579
580                 obj_type = ACPI_TYPE_INVALID;   /* Terminate loop after next pass */
581         }
582
583       cleanup:
584         acpi_os_printf("\n");
585         return (AE_OK);
586 }
587
588 #ifdef ACPI_FUTURE_USAGE
589 /*******************************************************************************
590  *
591  * FUNCTION:    acpi_ns_dump_objects
592  *
593  * PARAMETERS:  Type                - Object type to be dumped
594  *              display_type        - 0 or ACPI_DISPLAY_SUMMARY
595  *              max_depth           - Maximum depth of dump. Use ACPI_UINT32_MAX
596  *                                    for an effectively unlimited depth.
597  *              owner_id            - Dump only objects owned by this ID.  Use
598  *                                    ACPI_UINT32_MAX to match all owners.
599  *              start_handle        - Where in namespace to start/end search
600  *
601  * RETURN:      None
602  *
603  * DESCRIPTION: Dump typed objects within the loaded namespace.
604  *              Uses acpi_ns_walk_namespace in conjunction with acpi_ns_dump_one_object.
605  *
606  ******************************************************************************/
607
608 void
609 acpi_ns_dump_objects(acpi_object_type type,
610                      u8 display_type,
611                      u32 max_depth,
612                      acpi_owner_id owner_id, acpi_handle start_handle)
613 {
614         struct acpi_walk_info info;
615
616         ACPI_FUNCTION_ENTRY();
617
618         info.debug_level = ACPI_LV_TABLES;
619         info.owner_id = owner_id;
620         info.display_type = display_type;
621
622         (void)acpi_ns_walk_namespace(type, start_handle, max_depth,
623                                      ACPI_NS_WALK_NO_UNLOCK,
624                                      acpi_ns_dump_one_object, (void *)&info,
625                                      NULL);
626 }
627 #endif                          /* ACPI_FUTURE_USAGE */
628
629 /*******************************************************************************
630  *
631  * FUNCTION:    acpi_ns_dump_entry
632  *
633  * PARAMETERS:  Handle              - Node to be dumped
634  *              debug_level         - Output level
635  *
636  * RETURN:      None
637  *
638  * DESCRIPTION: Dump a single Node
639  *
640  ******************************************************************************/
641
642 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level)
643 {
644         struct acpi_walk_info info;
645
646         ACPI_FUNCTION_ENTRY();
647
648         info.debug_level = debug_level;
649         info.owner_id = ACPI_OWNER_ID_MAX;
650         info.display_type = ACPI_DISPLAY_SUMMARY;
651
652         (void)acpi_ns_dump_one_object(handle, 1, &info, NULL);
653 }
654
655 #ifdef ACPI_ASL_COMPILER
656 /*******************************************************************************
657  *
658  * FUNCTION:    acpi_ns_dump_tables
659  *
660  * PARAMETERS:  search_base         - Root of subtree to be dumped, or
661  *                                    NS_ALL to dump the entire namespace
662  *              max_depth           - Maximum depth of dump.  Use INT_MAX
663  *                                    for an effectively unlimited depth.
664  *
665  * RETURN:      None
666  *
667  * DESCRIPTION: Dump the name space, or a portion of it.
668  *
669  ******************************************************************************/
670
671 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth)
672 {
673         acpi_handle search_handle = search_base;
674
675         ACPI_FUNCTION_TRACE("ns_dump_tables");
676
677         if (!acpi_gbl_root_node) {
678                 /*
679                  * If the name space has not been initialized,
680                  * there is nothing to dump.
681                  */
682                 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
683                                   "namespace not initialized!\n"));
684                 return_VOID;
685         }
686
687         if (ACPI_NS_ALL == search_base) {
688
689                 /* Entire namespace */
690
691                 search_handle = acpi_gbl_root_node;
692                 ACPI_DEBUG_PRINT((ACPI_DB_TABLES, "\\\n"));
693         }
694
695         acpi_ns_dump_objects(ACPI_TYPE_ANY, ACPI_DISPLAY_OBJECTS, max_depth,
696                              ACPI_OWNER_ID_MAX, search_handle);
697         return_VOID;
698 }
699 #endif                          /* _ACPI_ASL_COMPILER */
700 #endif                          /* defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) */