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