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