drivers/acpi/acpica/exdump.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exdump - Interpreter debug output routines
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2013, Intel Corp.
   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 "accommon.h"
  46 #include "acinterp.h"
  47 #include "amlcode.h"
  48 #include "acnamesp.h"
  49
  50 #define _COMPONENT          ACPI_EXECUTER
  51 ACPI_MODULE_NAME("exdump")
  52
  53 /*
  54  * The following routines are used for debug output only
  55  */
  56 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
  57 /* Local prototypes */
  58 static void acpi_ex_out_string(char *title, char *value);
  59
  60 static void acpi_ex_out_pointer(char *title, void *value);
  61
  62 static void
  63 acpi_ex_dump_object(union acpi_operand_object *obj_desc,
  64                     struct acpi_exdump_info *info);
  65
  66 static void acpi_ex_dump_reference_obj(union acpi_operand_object *obj_desc);
  67
  68 static void
  69 acpi_ex_dump_package_obj(union acpi_operand_object *obj_desc,
  70                          u32 level, u32 index);
  71
  72 /*******************************************************************************
  73  *
  74  * Object Descriptor info tables
  75  *
  76  * Note: The first table entry must be an INIT opcode and must contain
  77  * the table length (number of table entries)
  78  *
  79  ******************************************************************************/
  80
  81 static struct acpi_exdump_info acpi_ex_dump_integer[2] = {
  82         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_integer), NULL},
  83         {ACPI_EXD_UINT64, ACPI_EXD_OFFSET(integer.value), "Value"}
  84 };
  85
  86 static struct acpi_exdump_info acpi_ex_dump_string[4] = {
  87         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_string), NULL},
  88         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(string.length), "Length"},
  89         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(string.pointer), "Pointer"},
  90         {ACPI_EXD_STRING, 0, NULL}
  91 };
  92
  93 static struct acpi_exdump_info acpi_ex_dump_buffer[5] = {
  94         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_buffer), NULL},
  95         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(buffer.length), "Length"},
  96         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(buffer.pointer), "Pointer"},
  97         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(buffer.node), "Parent Node"},
  98         {ACPI_EXD_BUFFER, 0, NULL}
  99 };
 100
 101 static struct acpi_exdump_info acpi_ex_dump_package[5] = {
 102         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_package), NULL},
 103         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(package.flags), "Flags"},
 104         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(package.count), "Elements"},
 105         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(package.elements), "Element List"},
 106         {ACPI_EXD_PACKAGE, 0, NULL}
 107 };
 108
 109 static struct acpi_exdump_info acpi_ex_dump_device[4] = {
 110         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_device), NULL},
 111         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(device.handler), "Handler"},
 112         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(device.notify_list[0]),
 113          "System Notify"},
 114         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(device.notify_list[1]),
 115          "Device Notify"}
 116 };
 117
 118 static struct acpi_exdump_info acpi_ex_dump_event[2] = {
 119         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_event), NULL},
 120         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(event.os_semaphore), "OsSemaphore"}
 121 };
 122
 123 static struct acpi_exdump_info acpi_ex_dump_method[9] = {
 124         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_method), NULL},
 125         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.info_flags), "Info Flags"},
 126         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.param_count),
 127          "Parameter Count"},
 128         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.sync_level), "Sync Level"},
 129         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(method.mutex), "Mutex"},
 130         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.owner_id), "Owner Id"},
 131         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(method.thread_count), "Thread Count"},
 132         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(method.aml_length), "Aml Length"},
 133         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(method.aml_start), "Aml Start"}
 134 };
 135
 136 static struct acpi_exdump_info acpi_ex_dump_mutex[5] = {
 137         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_mutex), NULL},
 138         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(mutex.sync_level), "Sync Level"},
 139         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(mutex.owner_thread), "Owner Thread"},
 140         {ACPI_EXD_UINT16, ACPI_EXD_OFFSET(mutex.acquisition_depth),
 141          "Acquire Depth"},
 142         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(mutex.os_mutex), "OsMutex"}
 143 };
 144
 145 static struct acpi_exdump_info acpi_ex_dump_region[7] = {
 146         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_region), NULL},
 147         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(region.space_id), "Space Id"},
 148         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(region.flags), "Flags"},
 149         {ACPI_EXD_ADDRESS, ACPI_EXD_OFFSET(region.address), "Address"},
 150         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(region.length), "Length"},
 151         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(region.handler), "Handler"},
 152         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(region.next), "Next"}
 153 };
 154
 155 static struct acpi_exdump_info acpi_ex_dump_power[5] = {
 156         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_power), NULL},
 157         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(power_resource.system_level),
 158          "System Level"},
 159         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(power_resource.resource_order),
 160          "Resource Order"},
 161         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(power_resource.notify_list[0]),
 162          "System Notify"},
 163         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(power_resource.notify_list[1]),
 164          "Device Notify"}
 165 };
 166
 167 static struct acpi_exdump_info acpi_ex_dump_processor[7] = {
 168         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_processor), NULL},
 169         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(processor.proc_id), "Processor ID"},
 170         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(processor.length), "Length"},
 171         {ACPI_EXD_ADDRESS, ACPI_EXD_OFFSET(processor.address), "Address"},
 172         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(processor.notify_list[0]),
 173          "System Notify"},
 174         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(processor.notify_list[1]),
 175          "Device Notify"},
 176         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(processor.handler), "Handler"}
 177 };
 178
 179 static struct acpi_exdump_info acpi_ex_dump_thermal[4] = {
 180         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_thermal), NULL},
 181         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(thermal_zone.notify_list[0]),
 182          "System Notify"},
 183         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(thermal_zone.notify_list[1]),
 184          "Device Notify"},
 185         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(thermal_zone.handler), "Handler"}
 186 };
 187
 188 static struct acpi_exdump_info acpi_ex_dump_buffer_field[3] = {
 189         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_buffer_field), NULL},
 190         {ACPI_EXD_FIELD, 0, NULL},
 191         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(buffer_field.buffer_obj),
 192          "Buffer Object"}
 193 };
 194
 195 static struct acpi_exdump_info acpi_ex_dump_region_field[5] = {
 196         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_region_field), NULL},
 197         {ACPI_EXD_FIELD, 0, NULL},
 198         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(field.access_length), "AccessLength"},
 199         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(field.region_obj), "Region Object"},
 200         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(field.resource_buffer),
 201          "ResourceBuffer"}
 202 };
 203
 204 static struct acpi_exdump_info acpi_ex_dump_bank_field[5] = {
 205         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_bank_field), NULL},
 206         {ACPI_EXD_FIELD, 0, NULL},
 207         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(bank_field.value), "Value"},
 208         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(bank_field.region_obj),
 209          "Region Object"},
 210         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(bank_field.bank_obj), "Bank Object"}
 211 };
 212
 213 static struct acpi_exdump_info acpi_ex_dump_index_field[5] = {
 214         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_bank_field), NULL},
 215         {ACPI_EXD_FIELD, 0, NULL},
 216         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(index_field.value), "Value"},
 217         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(index_field.index_obj),
 218          "Index Object"},
 219         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(index_field.data_obj), "Data Object"}
 220 };
 221
 222 static struct acpi_exdump_info acpi_ex_dump_reference[8] = {
 223         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_reference), NULL},
 224         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(reference.class), "Class"},
 225         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(reference.target_type), "Target Type"},
 226         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(reference.value), "Value"},
 227         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(reference.object), "Object Desc"},
 228         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(reference.node), "Node"},
 229         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(reference.where), "Where"},
 230         {ACPI_EXD_REFERENCE, 0, NULL}
 231 };
 232
 233 static struct acpi_exdump_info acpi_ex_dump_address_handler[6] = {
 234         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_address_handler),
 235          NULL},
 236         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(address_space.space_id), "Space Id"},
 237         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.next), "Next"},
 238         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.region_list),
 239          "Region List"},
 240         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.node), "Node"},
 241         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(address_space.context), "Context"}
 242 };
 243
 244 static struct acpi_exdump_info acpi_ex_dump_notify[7] = {
 245         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_notify), NULL},
 246         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.node), "Node"},
 247         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(notify.handler_type), "Handler Type"},
 248         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.handler), "Handler"},
 249         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.context), "Context"},
 250         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.next[0]),
 251          "Next System Notify"},
 252         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(notify.next[1]), "Next Device Notify"}
 253 };
 254
 255 /* Miscellaneous tables */
 256
 257 static struct acpi_exdump_info acpi_ex_dump_common[4] = {
 258         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_common), NULL},
 259         {ACPI_EXD_TYPE, 0, NULL},
 260         {ACPI_EXD_UINT16, ACPI_EXD_OFFSET(common.reference_count),
 261          "Reference Count"},
 262         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common.flags), "Flags"}
 263 };
 264
 265 static struct acpi_exdump_info acpi_ex_dump_field_common[7] = {
 266         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_field_common), NULL},
 267         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common_field.field_flags),
 268          "Field Flags"},
 269         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common_field.access_byte_width),
 270          "Access Byte Width"},
 271         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(common_field.bit_length),
 272          "Bit Length"},
 273         {ACPI_EXD_UINT8, ACPI_EXD_OFFSET(common_field.start_field_bit_offset),
 274          "Field Bit Offset"},
 275         {ACPI_EXD_UINT32, ACPI_EXD_OFFSET(common_field.base_byte_offset),
 276          "Base Byte Offset"},
 277         {ACPI_EXD_POINTER, ACPI_EXD_OFFSET(common_field.node), "Parent Node"}
 278 };
 279
 280 static struct acpi_exdump_info acpi_ex_dump_node[5] = {
 281         {ACPI_EXD_INIT, ACPI_EXD_TABLE_SIZE(acpi_ex_dump_node), NULL},
 282         {ACPI_EXD_UINT8, ACPI_EXD_NSOFFSET(flags), "Flags"},
 283         {ACPI_EXD_UINT8, ACPI_EXD_NSOFFSET(owner_id), "Owner Id"},
 284         {ACPI_EXD_POINTER, ACPI_EXD_NSOFFSET(child), "Child List"},
 285         {ACPI_EXD_POINTER, ACPI_EXD_NSOFFSET(peer), "Next Peer"}
 286 };
 287
 288 /* Dispatch table, indexed by object type */
 289
 290 static struct acpi_exdump_info *acpi_ex_dump_info[] = {
 291         NULL,
 292         acpi_ex_dump_integer,
 293         acpi_ex_dump_string,
 294         acpi_ex_dump_buffer,
 295         acpi_ex_dump_package,
 296         NULL,
 297         acpi_ex_dump_device,
 298         acpi_ex_dump_event,
 299         acpi_ex_dump_method,
 300         acpi_ex_dump_mutex,
 301         acpi_ex_dump_region,
 302         acpi_ex_dump_power,
 303         acpi_ex_dump_processor,
 304         acpi_ex_dump_thermal,
 305         acpi_ex_dump_buffer_field,
 306         NULL,
 307         NULL,
 308         acpi_ex_dump_region_field,
 309         acpi_ex_dump_bank_field,
 310         acpi_ex_dump_index_field,
 311         acpi_ex_dump_reference,
 312         NULL,
 313         NULL,
 314         acpi_ex_dump_notify,
 315         acpi_ex_dump_address_handler,
 316         NULL,
 317         NULL,
 318         NULL
 319 };
 320
 321 /*******************************************************************************
 322  *
 323  * FUNCTION:    acpi_ex_dump_object
 324  *
 325  * PARAMETERS:  obj_desc            - Descriptor to dump
 326  *              info                - Info table corresponding to this object
 327  *                                    type
 328  *
 329  * RETURN:      None
 330  *
 331  * DESCRIPTION: Walk the info table for this object
 332  *
 333  ******************************************************************************/
 334
 335 static void
 336 acpi_ex_dump_object(union acpi_operand_object *obj_desc,
 337                     struct acpi_exdump_info *info)
 338 {
 339         u8 *target;
 340         char *name;
 341         u8 count;
 342
 343         if (!info) {
 344                 acpi_os_printf
 345                     ("ExDumpObject: Display not implemented for object type %s\n",
 346                      acpi_ut_get_object_type_name(obj_desc));
 347                 return;
 348         }
 349
 350         /* First table entry must contain the table length (# of table entries) */
 351
 352         count = info->offset;
 353
 354         while (count) {
 355                 target = ACPI_ADD_PTR(u8, obj_desc, info->offset);
 356                 name = info->name;
 357
 358                 switch (info->opcode) {
 359                 case ACPI_EXD_INIT:
 360                         break;
 361
 362                 case ACPI_EXD_TYPE:
 363
 364                         acpi_ex_out_string("Type",
 365                                            acpi_ut_get_object_type_name
 366                                            (obj_desc));
 367                         break;
 368
 369                 case ACPI_EXD_UINT8:
 370
 371                         acpi_os_printf("%20s : %2.2X\n", name, *target);
 372                         break;
 373
 374                 case ACPI_EXD_UINT16:
 375
 376                         acpi_os_printf("%20s : %4.4X\n", name,
 377                                        ACPI_GET16(target));
 378                         break;
 379
 380                 case ACPI_EXD_UINT32:
 381
 382                         acpi_os_printf("%20s : %8.8X\n", name,
 383                                        ACPI_GET32(target));
 384                         break;
 385
 386                 case ACPI_EXD_UINT64:
 387
 388                         acpi_os_printf("%20s : %8.8X%8.8X\n", "Value",
 389                                        ACPI_FORMAT_UINT64(ACPI_GET64(target)));
 390                         break;
 391
 392                 case ACPI_EXD_POINTER:
 393                 case ACPI_EXD_ADDRESS:
 394
 395                         acpi_ex_out_pointer(name,
 396                                             *ACPI_CAST_PTR(void *, target));
 397                         break;
 398
 399                 case ACPI_EXD_STRING:
 400
 401                         acpi_ut_print_string(obj_desc->string.pointer,
 402                                              ACPI_UINT8_MAX);
 403                         acpi_os_printf("\n");
 404                         break;
 405
 406                 case ACPI_EXD_BUFFER:
 407
 408                         ACPI_DUMP_BUFFER(obj_desc->buffer.pointer,
 409                                          obj_desc->buffer.length);
 410                         break;
 411
 412                 case ACPI_EXD_PACKAGE:
 413
 414                         /* Dump the package contents */
 415
 416                         acpi_os_printf("\nPackage Contents:\n");
 417                         acpi_ex_dump_package_obj(obj_desc, 0, 0);
 418                         break;
 419
 420                 case ACPI_EXD_FIELD:
 421
 422                         acpi_ex_dump_object(obj_desc,
 423                                             acpi_ex_dump_field_common);
 424                         break;
 425
 426                 case ACPI_EXD_REFERENCE:
 427
 428                         acpi_ex_out_string("Class Name",
 429                                            ACPI_CAST_PTR(char,
 430                                                          acpi_ut_get_reference_name
 431                                                          (obj_desc)));
 432                         acpi_ex_dump_reference_obj(obj_desc);
 433                         break;
 434
 435                 default:
 436
 437                         acpi_os_printf("**** Invalid table opcode [%X] ****\n",
 438                                        info->opcode);
 439                         return;
 440                 }
 441
 442                 info++;
 443                 count--;
 444         }
 445 }
 446
 447 /*******************************************************************************
 448  *
 449  * FUNCTION:    acpi_ex_dump_operand
 450  *
 451  * PARAMETERS:  *obj_desc       - Pointer to entry to be dumped
 452  *              depth           - Current nesting depth
 453  *
 454  * RETURN:      None
 455  *
 456  * DESCRIPTION: Dump an operand object
 457  *
 458  ******************************************************************************/
 459
 460 void acpi_ex_dump_operand(union acpi_operand_object *obj_desc, u32 depth)
 461 {
 462         u32 length;
 463         u32 index;
 464
 465         ACPI_FUNCTION_NAME(ex_dump_operand)
 466
 467             /* Check if debug output enabled */
 468             if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_EXEC, _COMPONENT)) {
 469                 return;
 470         }
 471
 472         if (!obj_desc) {
 473
 474                 /* This could be a null element of a package */
 475
 476                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Null Object Descriptor\n"));
 477                 return;
 478         }
 479
 480         if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_NAMED) {
 481                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%p Namespace Node: ",
 482                                   obj_desc));
 483                 ACPI_DUMP_ENTRY(obj_desc, ACPI_LV_EXEC);
 484                 return;
 485         }
 486
 487         if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) {
 488                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 489                                   "%p is not a node or operand object: [%s]\n",
 490                                   obj_desc,
 491                                   acpi_ut_get_descriptor_name(obj_desc)));
 492                 ACPI_DUMP_BUFFER(obj_desc, sizeof(union acpi_operand_object));
 493                 return;
 494         }
 495
 496         /* obj_desc is a valid object */
 497
 498         if (depth > 0) {
 499                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%*s[%u] %p ",
 500                                   depth, " ", depth, obj_desc));
 501         } else {
 502                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%p ", obj_desc));
 503         }
 504
 505         /* Decode object type */
 506
 507         switch (obj_desc->common.type) {
 508         case ACPI_TYPE_LOCAL_REFERENCE:
 509
 510                 acpi_os_printf("Reference: [%s] ",
 511                                acpi_ut_get_reference_name(obj_desc));
 512
 513                 switch (obj_desc->reference.class) {
 514                 case ACPI_REFCLASS_DEBUG:
 515
 516                         acpi_os_printf("\n");
 517                         break;
 518
 519                 case ACPI_REFCLASS_INDEX:
 520
 521                         acpi_os_printf("%p\n", obj_desc->reference.object);
 522                         break;
 523
 524                 case ACPI_REFCLASS_TABLE:
 525
 526                         acpi_os_printf("Table Index %X\n",
 527                                        obj_desc->reference.value);
 528                         break;
 529
 530                 case ACPI_REFCLASS_REFOF:
 531
 532                         acpi_os_printf("%p [%s]\n", obj_desc->reference.object,
 533                                        acpi_ut_get_type_name(((union
 534                                                                acpi_operand_object
 535                                                                *)
 536                                                               obj_desc->
 537                                                               reference.
 538                                                               object)->common.
 539                                                              type));
 540                         break;
 541
 542                 case ACPI_REFCLASS_NAME:
 543
 544                         acpi_os_printf("- [%4.4s]\n",
 545                                        obj_desc->reference.node->name.ascii);
 546                         break;
 547
 548                 case ACPI_REFCLASS_ARG:
 549                 case ACPI_REFCLASS_LOCAL:
 550
 551                         acpi_os_printf("%X\n", obj_desc->reference.value);
 552                         break;
 553
 554                 default:        /* Unknown reference class */
 555
 556                         acpi_os_printf("%2.2X\n", obj_desc->reference.class);
 557                         break;
 558                 }
 559                 break;
 560
 561         case ACPI_TYPE_BUFFER:
 562
 563                 acpi_os_printf("Buffer length %.2X @ %p\n",
 564                                obj_desc->buffer.length,
 565                                obj_desc->buffer.pointer);
 566
 567                 /* Debug only -- dump the buffer contents */
 568
 569                 if (obj_desc->buffer.pointer) {
 570                         length = obj_desc->buffer.length;
 571                         if (length > 128) {
 572                                 length = 128;
 573                         }
 574
 575                         acpi_os_printf
 576                             ("Buffer Contents: (displaying length 0x%.2X)\n",
 577                              length);
 578                         ACPI_DUMP_BUFFER(obj_desc->buffer.pointer, length);
 579                 }
 580                 break;
 581
 582         case ACPI_TYPE_INTEGER:
 583
 584                 acpi_os_printf("Integer %8.8X%8.8X\n",
 585                                ACPI_FORMAT_UINT64(obj_desc->integer.value));
 586                 break;
 587
 588         case ACPI_TYPE_PACKAGE:
 589
 590                 acpi_os_printf("Package [Len %X] ElementArray %p\n",
 591                                obj_desc->package.count,
 592                                obj_desc->package.elements);
 593
 594                 /*
 595                  * If elements exist, package element pointer is valid,
 596                  * and debug_level exceeds 1, dump package's elements.
 597                  */
 598                 if (obj_desc->package.count &&
 599                     obj_desc->package.elements && acpi_dbg_level > 1) {
 600                         for (index = 0; index < obj_desc->package.count;
 601                              index++) {
 602                                 acpi_ex_dump_operand(obj_desc->package.
 603                                                      elements[index],
 604                                                      depth + 1);
 605                         }
 606                 }
 607                 break;
 608
 609         case ACPI_TYPE_REGION:
 610
 611                 acpi_os_printf("Region %s (%X)",
 612                                acpi_ut_get_region_name(obj_desc->region.
 613                                                        space_id),
 614                                obj_desc->region.space_id);
 615
 616                 /*
 617                  * If the address and length have not been evaluated,
 618                  * don't print them.
 619                  */
 620                 if (!(obj_desc->region.flags & AOPOBJ_DATA_VALID)) {
 621                         acpi_os_printf("\n");
 622                 } else {
 623                         acpi_os_printf(" base %8.8X%8.8X Length %X\n",
 624                                        ACPI_FORMAT_NATIVE_UINT(obj_desc->region.
 625                                                                address),
 626                                        obj_desc->region.length);
 627                 }
 628                 break;
 629
 630         case ACPI_TYPE_STRING:
 631
 632                 acpi_os_printf("String length %X @ %p ",
 633                                obj_desc->string.length,
 634                                obj_desc->string.pointer);
 635
 636                 acpi_ut_print_string(obj_desc->string.pointer, ACPI_UINT8_MAX);
 637                 acpi_os_printf("\n");
 638                 break;
 639
 640         case ACPI_TYPE_LOCAL_BANK_FIELD:
 641
 642                 acpi_os_printf("BankField\n");
 643                 break;
 644
 645         case ACPI_TYPE_LOCAL_REGION_FIELD:
 646
 647                 acpi_os_printf
 648                     ("RegionField: Bits=%X AccWidth=%X Lock=%X Update=%X at "
 649                      "byte=%X bit=%X of below:\n", obj_desc->field.bit_length,
 650                      obj_desc->field.access_byte_width,
 651                      obj_desc->field.field_flags & AML_FIELD_LOCK_RULE_MASK,
 652                      obj_desc->field.field_flags & AML_FIELD_UPDATE_RULE_MASK,
 653                      obj_desc->field.base_byte_offset,
 654                      obj_desc->field.start_field_bit_offset);
 655
 656                 acpi_ex_dump_operand(obj_desc->field.region_obj, depth + 1);
 657                 break;
 658
 659         case ACPI_TYPE_LOCAL_INDEX_FIELD:
 660
 661                 acpi_os_printf("IndexField\n");
 662                 break;
 663
 664         case ACPI_TYPE_BUFFER_FIELD:
 665
 666                 acpi_os_printf("BufferField: %X bits at byte %X bit %X of\n",
 667                                obj_desc->buffer_field.bit_length,
 668                                obj_desc->buffer_field.base_byte_offset,
 669                                obj_desc->buffer_field.start_field_bit_offset);
 670
 671                 if (!obj_desc->buffer_field.buffer_obj) {
 672                         ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "*NULL*\n"));
 673                 } else if ((obj_desc->buffer_field.buffer_obj)->common.type !=
 674                            ACPI_TYPE_BUFFER) {
 675                         acpi_os_printf("*not a Buffer*\n");
 676                 } else {
 677                         acpi_ex_dump_operand(obj_desc->buffer_field.buffer_obj,
 678                                              depth + 1);
 679                 }
 680                 break;
 681
 682         case ACPI_TYPE_EVENT:
 683
 684                 acpi_os_printf("Event\n");
 685                 break;
 686
 687         case ACPI_TYPE_METHOD:
 688
 689                 acpi_os_printf("Method(%X) @ %p:%X\n",
 690                                obj_desc->method.param_count,
 691                                obj_desc->method.aml_start,
 692                                obj_desc->method.aml_length);
 693                 break;
 694
 695         case ACPI_TYPE_MUTEX:
 696
 697                 acpi_os_printf("Mutex\n");
 698                 break;
 699
 700         case ACPI_TYPE_DEVICE:
 701
 702                 acpi_os_printf("Device\n");
 703                 break;
 704
 705         case ACPI_TYPE_POWER:
 706
 707                 acpi_os_printf("Power\n");
 708                 break;
 709
 710         case ACPI_TYPE_PROCESSOR:
 711
 712                 acpi_os_printf("Processor\n");
 713                 break;
 714
 715         case ACPI_TYPE_THERMAL:
 716
 717                 acpi_os_printf("Thermal\n");
 718                 break;
 719
 720         default:
 721                 /* Unknown Type */
 722
 723                 acpi_os_printf("Unknown Type %X\n", obj_desc->common.type);
 724                 break;
 725         }
 726
 727         return;
 728 }
 729
 730 /*******************************************************************************
 731  *
 732  * FUNCTION:    acpi_ex_dump_operands
 733  *
 734  * PARAMETERS:  operands            - A list of Operand objects
 735  *              opcode_name         - AML opcode name
 736  *              num_operands        - Operand count for this opcode
 737  *
 738  * DESCRIPTION: Dump the operands associated with the opcode
 739  *
 740  ******************************************************************************/
 741
 742 void
 743 acpi_ex_dump_operands(union acpi_operand_object **operands,
 744                       const char *opcode_name, u32 num_operands)
 745 {
 746         ACPI_FUNCTION_NAME(ex_dump_operands);
 747
 748         if (!opcode_name) {
 749                 opcode_name = "UNKNOWN";
 750         }
 751
 752         ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 753                           "**** Start operand dump for opcode [%s], %u operands\n",
 754                           opcode_name, num_operands));
 755
 756         if (num_operands == 0) {
 757                 num_operands = 1;
 758         }
 759
 760         /* Dump the individual operands */
 761
 762         while (num_operands) {
 763                 acpi_ex_dump_operand(*operands, 0);
 764                 operands++;
 765                 num_operands--;
 766         }
 767
 768         ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 769                           "**** End operand dump for [%s]\n", opcode_name));
 770         return;
 771 }
 772
 773 /*******************************************************************************
 774  *
 775  * FUNCTION:    acpi_ex_out* functions
 776  *
 777  * PARAMETERS:  title               - Descriptive text
 778  *              value               - Value to be displayed
 779  *
 780  * DESCRIPTION: Object dump output formatting functions. These functions
 781  *              reduce the number of format strings required and keeps them
 782  *              all in one place for easy modification.
 783  *
 784  ******************************************************************************/
 785
 786 static void acpi_ex_out_string(char *title, char *value)
 787 {
 788         acpi_os_printf("%20s : %s\n", title, value);
 789 }
 790
 791 static void acpi_ex_out_pointer(char *title, void *value)
 792 {
 793         acpi_os_printf("%20s : %p\n", title, value);
 794 }
 795
 796 /*******************************************************************************
 797  *
 798  * FUNCTION:    acpi_ex_dump_namespace_node
 799  *
 800  * PARAMETERS:  node                - Descriptor to dump
 801  *              flags               - Force display if TRUE
 802  *
 803  * DESCRIPTION: Dumps the members of the given.Node
 804  *
 805  ******************************************************************************/
 806
 807 void acpi_ex_dump_namespace_node(struct acpi_namespace_node *node, u32 flags)
 808 {
 809
 810         ACPI_FUNCTION_ENTRY();
 811
 812         if (!flags) {
 813
 814                 /* Check if debug output enabled */
 815
 816                 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_OBJECTS, _COMPONENT)) {
 817                         return;
 818                 }
 819         }
 820
 821         acpi_os_printf("%20s : %4.4s\n", "Name", acpi_ut_get_node_name(node));
 822         acpi_ex_out_string("Type", acpi_ut_get_type_name(node->type));
 823         acpi_ex_out_pointer("Attached Object",
 824                             acpi_ns_get_attached_object(node));
 825         acpi_ex_out_pointer("Parent", node->parent);
 826
 827         acpi_ex_dump_object(ACPI_CAST_PTR(union acpi_operand_object, node),
 828                             acpi_ex_dump_node);
 829 }
 830
 831 /*******************************************************************************
 832  *
 833  * FUNCTION:    acpi_ex_dump_reference_obj
 834  *
 835  * PARAMETERS:  object              - Descriptor to dump
 836  *
 837  * DESCRIPTION: Dumps a reference object
 838  *
 839  ******************************************************************************/
 840
 841 static void acpi_ex_dump_reference_obj(union acpi_operand_object *obj_desc)
 842 {
 843         struct acpi_buffer ret_buf;
 844         acpi_status status;
 845
 846         ret_buf.length = ACPI_ALLOCATE_LOCAL_BUFFER;
 847
 848         if (obj_desc->reference.class == ACPI_REFCLASS_NAME) {
 849                 acpi_os_printf(" %p ", obj_desc->reference.node);
 850
 851                 status =
 852                     acpi_ns_handle_to_pathname(obj_desc->reference.node,
 853                                                &ret_buf);
 854                 if (ACPI_FAILURE(status)) {
 855                         acpi_os_printf(" Could not convert name to pathname\n");
 856                 } else {
 857                         acpi_os_printf("%s\n", (char *)ret_buf.pointer);
 858                         ACPI_FREE(ret_buf.pointer);
 859                 }
 860         } else if (obj_desc->reference.object) {
 861                 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) ==
 862                     ACPI_DESC_TYPE_OPERAND) {
 863                         acpi_os_printf(" Target: %p",
 864                                        obj_desc->reference.object);
 865                         if (obj_desc->reference.class == ACPI_REFCLASS_TABLE) {
 866                                 acpi_os_printf(" Table Index: %X\n",
 867                                                obj_desc->reference.value);
 868                         } else {
 869                                 acpi_os_printf(" Target: %p [%s]\n",
 870                                                obj_desc->reference.object,
 871                                                acpi_ut_get_type_name(((union
 872                                                                        acpi_operand_object
 873                                                                        *)
 874                                                                       obj_desc->
 875                                                                       reference.
 876                                                                       object)->
 877                                                                      common.
 878                                                                      type));
 879                         }
 880                 } else {
 881                         acpi_os_printf(" Target: %p\n",
 882                                        obj_desc->reference.object);
 883                 }
 884         }
 885 }
 886
 887 /*******************************************************************************
 888  *
 889  * FUNCTION:    acpi_ex_dump_package_obj
 890  *
 891  * PARAMETERS:  obj_desc            - Descriptor to dump
 892  *              level               - Indentation Level
 893  *              index               - Package index for this object
 894  *
 895  * DESCRIPTION: Dumps the elements of the package
 896  *
 897  ******************************************************************************/
 898
 899 static void
 900 acpi_ex_dump_package_obj(union acpi_operand_object *obj_desc,
 901                          u32 level, u32 index)
 902 {
 903         u32 i;
 904
 905         /* Indentation and index output */
 906
 907         if (level > 0) {
 908                 for (i = 0; i < level; i++) {
 909                         acpi_os_printf(" ");
 910                 }
 911
 912                 acpi_os_printf("[%.2d] ", index);
 913         }
 914
 915         acpi_os_printf("%p ", obj_desc);
 916
 917         /* Null package elements are allowed */
 918
 919         if (!obj_desc) {
 920                 acpi_os_printf("[Null Object]\n");
 921                 return;
 922         }
 923
 924         /* Packages may only contain a few object types */
 925
 926         switch (obj_desc->common.type) {
 927         case ACPI_TYPE_INTEGER:
 928
 929                 acpi_os_printf("[Integer] = %8.8X%8.8X\n",
 930                                ACPI_FORMAT_UINT64(obj_desc->integer.value));
 931                 break;
 932
 933         case ACPI_TYPE_STRING:
 934
 935                 acpi_os_printf("[String] Value: ");
 936                 acpi_ut_print_string(obj_desc->string.pointer, ACPI_UINT8_MAX);
 937                 acpi_os_printf("\n");
 938                 break;
 939
 940         case ACPI_TYPE_BUFFER:
 941
 942                 acpi_os_printf("[Buffer] Length %.2X = ",
 943                                obj_desc->buffer.length);
 944                 if (obj_desc->buffer.length) {
 945                         acpi_ut_debug_dump_buffer(ACPI_CAST_PTR
 946                                                   (u8,
 947                                                    obj_desc->buffer.pointer),
 948                                                   obj_desc->buffer.length,
 949                                                   DB_DWORD_DISPLAY, _COMPONENT);
 950                 } else {
 951                         acpi_os_printf("\n");
 952                 }
 953                 break;
 954
 955         case ACPI_TYPE_PACKAGE:
 956
 957                 acpi_os_printf("[Package] Contains %u Elements:\n",
 958                                obj_desc->package.count);
 959
 960                 for (i = 0; i < obj_desc->package.count; i++) {
 961                         acpi_ex_dump_package_obj(obj_desc->package.elements[i],
 962                                                  level + 1, i);
 963                 }
 964                 break;
 965
 966         case ACPI_TYPE_LOCAL_REFERENCE:
 967
 968                 acpi_os_printf("[Object Reference] Type [%s] %2.2X",
 969                                acpi_ut_get_reference_name(obj_desc),
 970                                obj_desc->reference.class);
 971                 acpi_ex_dump_reference_obj(obj_desc);
 972                 break;
 973
 974         default:
 975
 976                 acpi_os_printf("[Unknown Type] %X\n", obj_desc->common.type);
 977                 break;
 978         }
 979 }
 980
 981 /*******************************************************************************
 982  *
 983  * FUNCTION:    acpi_ex_dump_object_descriptor
 984  *
 985  * PARAMETERS:  obj_desc            - Descriptor to dump
 986  *              flags               - Force display if TRUE
 987  *
 988  * DESCRIPTION: Dumps the members of the object descriptor given.
 989  *
 990  ******************************************************************************/
 991
 992 void
 993 acpi_ex_dump_object_descriptor(union acpi_operand_object *obj_desc, u32 flags)
 994 {
 995         ACPI_FUNCTION_TRACE(ex_dump_object_descriptor);
 996
 997         if (!obj_desc) {
 998                 return_VOID;
 999         }
1000
1001         if (!flags) {
1002
1003                 /* Check if debug output enabled */
1004
1005                 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_OBJECTS, _COMPONENT)) {
1006                         return_VOID;
1007                 }
1008         }
1009
1010         if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == ACPI_DESC_TYPE_NAMED) {
1011                 acpi_ex_dump_namespace_node((struct acpi_namespace_node *)
1012                                             obj_desc, flags);
1013
1014                 acpi_os_printf("\nAttached Object (%p):\n",
1015                                ((struct acpi_namespace_node *)obj_desc)->
1016                                object);
1017
1018                 acpi_ex_dump_object_descriptor(((struct acpi_namespace_node *)
1019                                                 obj_desc)->object, flags);
1020                 return_VOID;
1021         }
1022
1023         if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) != ACPI_DESC_TYPE_OPERAND) {
1024                 acpi_os_printf
1025                     ("ExDumpObjectDescriptor: %p is not an ACPI operand object: [%s]\n",
1026                      obj_desc, acpi_ut_get_descriptor_name(obj_desc));
1027                 return_VOID;
1028         }
1029
1030         if (obj_desc->common.type > ACPI_TYPE_NS_NODE_MAX) {
1031                 return_VOID;
1032         }
1033
1034         /* Common Fields */
1035
1036         acpi_ex_dump_object(obj_desc, acpi_ex_dump_common);
1037
1038         /* Object-specific fields */
1039
1040         acpi_ex_dump_object(obj_desc, acpi_ex_dump_info[obj_desc->common.type]);
1041         return_VOID;
1042 }
1043
1044 #endif