linux/drivers/acpi/acpica/utdecode.c
<<
>>
Prefs
   1/******************************************************************************
   2 *
   3 * Module Name: utdecode - Utility decoding routines (value-to-string)
   4 *
   5 *****************************************************************************/
   6
   7/*
   8 * Copyright (C) 2000 - 2012, 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 <linux/export.h>
  45#include <acpi/acpi.h>
  46#include "accommon.h"
  47#include "acnamesp.h"
  48
  49#define _COMPONENT          ACPI_UTILITIES
  50ACPI_MODULE_NAME("utdecode")
  51
  52/*
  53 * Properties of the ACPI Object Types, both internal and external.
  54 * The table is indexed by values of acpi_object_type
  55 */
  56const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES] = {
  57        ACPI_NS_NORMAL,         /* 00 Any              */
  58        ACPI_NS_NORMAL,         /* 01 Number           */
  59        ACPI_NS_NORMAL,         /* 02 String           */
  60        ACPI_NS_NORMAL,         /* 03 Buffer           */
  61        ACPI_NS_NORMAL,         /* 04 Package          */
  62        ACPI_NS_NORMAL,         /* 05 field_unit       */
  63        ACPI_NS_NEWSCOPE,       /* 06 Device           */
  64        ACPI_NS_NORMAL,         /* 07 Event            */
  65        ACPI_NS_NEWSCOPE,       /* 08 Method           */
  66        ACPI_NS_NORMAL,         /* 09 Mutex            */
  67        ACPI_NS_NORMAL,         /* 10 Region           */
  68        ACPI_NS_NEWSCOPE,       /* 11 Power            */
  69        ACPI_NS_NEWSCOPE,       /* 12 Processor        */
  70        ACPI_NS_NEWSCOPE,       /* 13 Thermal          */
  71        ACPI_NS_NORMAL,         /* 14 buffer_field     */
  72        ACPI_NS_NORMAL,         /* 15 ddb_handle       */
  73        ACPI_NS_NORMAL,         /* 16 Debug Object     */
  74        ACPI_NS_NORMAL,         /* 17 def_field        */
  75        ACPI_NS_NORMAL,         /* 18 bank_field       */
  76        ACPI_NS_NORMAL,         /* 19 index_field      */
  77        ACPI_NS_NORMAL,         /* 20 Reference        */
  78        ACPI_NS_NORMAL,         /* 21 Alias            */
  79        ACPI_NS_NORMAL,         /* 22 method_alias     */
  80        ACPI_NS_NORMAL,         /* 23 Notify           */
  81        ACPI_NS_NORMAL,         /* 24 Address Handler  */
  82        ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,       /* 25 Resource Desc    */
  83        ACPI_NS_NEWSCOPE | ACPI_NS_LOCAL,       /* 26 Resource Field   */
  84        ACPI_NS_NEWSCOPE,       /* 27 Scope            */
  85        ACPI_NS_NORMAL,         /* 28 Extra            */
  86        ACPI_NS_NORMAL,         /* 29 Data             */
  87        ACPI_NS_NORMAL          /* 30 Invalid          */
  88};
  89
  90/*******************************************************************************
  91 *
  92 * FUNCTION:    acpi_ut_hex_to_ascii_char
  93 *
  94 * PARAMETERS:  integer             - Contains the hex digit
  95 *              position            - bit position of the digit within the
  96 *                                    integer (multiple of 4)
  97 *
  98 * RETURN:      The converted Ascii character
  99 *
 100 * DESCRIPTION: Convert a hex digit to an Ascii character
 101 *
 102 ******************************************************************************/
 103
 104/* Hex to ASCII conversion table */
 105
 106static const char acpi_gbl_hex_to_ascii[] = {
 107        '0', '1', '2', '3', '4', '5', '6', '7',
 108        '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
 109};
 110
 111char acpi_ut_hex_to_ascii_char(u64 integer, u32 position)
 112{
 113
 114        return (acpi_gbl_hex_to_ascii[(integer >> position) & 0xF]);
 115}
 116
 117/*******************************************************************************
 118 *
 119 * FUNCTION:    acpi_ut_get_region_name
 120 *
 121 * PARAMETERS:  Space ID            - ID for the region
 122 *
 123 * RETURN:      Decoded region space_id name
 124 *
 125 * DESCRIPTION: Translate a Space ID into a name string (Debug only)
 126 *
 127 ******************************************************************************/
 128
 129/* Region type decoding */
 130
 131const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS] = {
 132        "SystemMemory",         /* 0x00 */
 133        "SystemIO",             /* 0x01 */
 134        "PCI_Config",           /* 0x02 */
 135        "EmbeddedControl",      /* 0x03 */
 136        "SMBus",                /* 0x04 */
 137        "SystemCMOS",           /* 0x05 */
 138        "PCIBARTarget",         /* 0x06 */
 139        "IPMI",                 /* 0x07 */
 140        "GeneralPurposeIo",     /* 0x08 */
 141        "GenericSerialBus",     /* 0x09 */
 142        "PCC"                   /* 0x0A */
 143};
 144
 145char *acpi_ut_get_region_name(u8 space_id)
 146{
 147
 148        if (space_id >= ACPI_USER_REGION_BEGIN) {
 149                return ("UserDefinedRegion");
 150        } else if (space_id == ACPI_ADR_SPACE_DATA_TABLE) {
 151                return ("DataTable");
 152        } else if (space_id == ACPI_ADR_SPACE_FIXED_HARDWARE) {
 153                return ("FunctionalFixedHW");
 154        } else if (space_id >= ACPI_NUM_PREDEFINED_REGIONS) {
 155                return ("InvalidSpaceId");
 156        }
 157
 158        return (ACPI_CAST_PTR(char, acpi_gbl_region_types[space_id]));
 159}
 160
 161/*******************************************************************************
 162 *
 163 * FUNCTION:    acpi_ut_get_event_name
 164 *
 165 * PARAMETERS:  event_id            - Fixed event ID
 166 *
 167 * RETURN:      Decoded event ID name
 168 *
 169 * DESCRIPTION: Translate a Event ID into a name string (Debug only)
 170 *
 171 ******************************************************************************/
 172
 173/* Event type decoding */
 174
 175static const char *acpi_gbl_event_types[ACPI_NUM_FIXED_EVENTS] = {
 176        "PM_Timer",
 177        "GlobalLock",
 178        "PowerButton",
 179        "SleepButton",
 180        "RealTimeClock",
 181};
 182
 183char *acpi_ut_get_event_name(u32 event_id)
 184{
 185
 186        if (event_id > ACPI_EVENT_MAX) {
 187                return ("InvalidEventID");
 188        }
 189
 190        return (ACPI_CAST_PTR(char, acpi_gbl_event_types[event_id]));
 191}
 192
 193/*******************************************************************************
 194 *
 195 * FUNCTION:    acpi_ut_get_type_name
 196 *
 197 * PARAMETERS:  type                - An ACPI object type
 198 *
 199 * RETURN:      Decoded ACPI object type name
 200 *
 201 * DESCRIPTION: Translate a Type ID into a name string (Debug only)
 202 *
 203 ******************************************************************************/
 204
 205/*
 206 * Elements of acpi_gbl_ns_type_names below must match
 207 * one-to-one with values of acpi_object_type
 208 *
 209 * The type ACPI_TYPE_ANY (Untyped) is used as a "don't care" when searching;
 210 * when stored in a table it really means that we have thus far seen no
 211 * evidence to indicate what type is actually going to be stored for this entry.
 212 */
 213static const char acpi_gbl_bad_type[] = "UNDEFINED";
 214
 215/* Printable names of the ACPI object types */
 216
 217static const char *acpi_gbl_ns_type_names[] = {
 218        /* 00 */ "Untyped",
 219        /* 01 */ "Integer",
 220        /* 02 */ "String",
 221        /* 03 */ "Buffer",
 222        /* 04 */ "Package",
 223        /* 05 */ "FieldUnit",
 224        /* 06 */ "Device",
 225        /* 07 */ "Event",
 226        /* 08 */ "Method",
 227        /* 09 */ "Mutex",
 228        /* 10 */ "Region",
 229        /* 11 */ "Power",
 230        /* 12 */ "Processor",
 231        /* 13 */ "Thermal",
 232        /* 14 */ "BufferField",
 233        /* 15 */ "DdbHandle",
 234        /* 16 */ "DebugObject",
 235        /* 17 */ "RegionField",
 236        /* 18 */ "BankField",
 237        /* 19 */ "IndexField",
 238        /* 20 */ "Reference",
 239        /* 21 */ "Alias",
 240        /* 22 */ "MethodAlias",
 241        /* 23 */ "Notify",
 242        /* 24 */ "AddrHandler",
 243        /* 25 */ "ResourceDesc",
 244        /* 26 */ "ResourceFld",
 245        /* 27 */ "Scope",
 246        /* 28 */ "Extra",
 247        /* 29 */ "Data",
 248        /* 30 */ "Invalid"
 249};
 250
 251char *acpi_ut_get_type_name(acpi_object_type type)
 252{
 253
 254        if (type > ACPI_TYPE_INVALID) {
 255                return (ACPI_CAST_PTR(char, acpi_gbl_bad_type));
 256        }
 257
 258        return (ACPI_CAST_PTR(char, acpi_gbl_ns_type_names[type]));
 259}
 260
 261char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc)
 262{
 263
 264        if (!obj_desc) {
 265                return ("[NULL Object Descriptor]");
 266        }
 267
 268        return (acpi_ut_get_type_name(obj_desc->common.type));
 269}
 270
 271/*******************************************************************************
 272 *
 273 * FUNCTION:    acpi_ut_get_node_name
 274 *
 275 * PARAMETERS:  object               - A namespace node
 276 *
 277 * RETURN:      ASCII name of the node
 278 *
 279 * DESCRIPTION: Validate the node and return the node's ACPI name.
 280 *
 281 ******************************************************************************/
 282
 283char *acpi_ut_get_node_name(void *object)
 284{
 285        struct acpi_namespace_node *node = (struct acpi_namespace_node *)object;
 286
 287        /* Must return a string of exactly 4 characters == ACPI_NAME_SIZE */
 288
 289        if (!object) {
 290                return ("NULL");
 291        }
 292
 293        /* Check for Root node */
 294
 295        if ((object == ACPI_ROOT_OBJECT) || (object == acpi_gbl_root_node)) {
 296                return ("\"\\\" ");
 297        }
 298
 299        /* Descriptor must be a namespace node */
 300
 301        if (ACPI_GET_DESCRIPTOR_TYPE(node) != ACPI_DESC_TYPE_NAMED) {
 302                return ("####");
 303        }
 304
 305        /*
 306         * Ensure name is valid. The name was validated/repaired when the node
 307         * was created, but make sure it has not been corrupted.
 308         */
 309        acpi_ut_repair_name(node->name.ascii);
 310
 311        /* Return the name */
 312
 313        return (node->name.ascii);
 314}
 315
 316/*******************************************************************************
 317 *
 318 * FUNCTION:    acpi_ut_get_descriptor_name
 319 *
 320 * PARAMETERS:  object               - An ACPI object
 321 *
 322 * RETURN:      Decoded name of the descriptor type
 323 *
 324 * DESCRIPTION: Validate object and return the descriptor type
 325 *
 326 ******************************************************************************/
 327
 328/* Printable names of object descriptor types */
 329
 330static const char *acpi_gbl_desc_type_names[] = {
 331        /* 00 */ "Not a Descriptor",
 332        /* 01 */ "Cached",
 333        /* 02 */ "State-Generic",
 334        /* 03 */ "State-Update",
 335        /* 04 */ "State-Package",
 336        /* 05 */ "State-Control",
 337        /* 06 */ "State-RootParseScope",
 338        /* 07 */ "State-ParseScope",
 339        /* 08 */ "State-WalkScope",
 340        /* 09 */ "State-Result",
 341        /* 10 */ "State-Notify",
 342        /* 11 */ "State-Thread",
 343        /* 12 */ "Walk",
 344        /* 13 */ "Parser",
 345        /* 14 */ "Operand",
 346        /* 15 */ "Node"
 347};
 348
 349char *acpi_ut_get_descriptor_name(void *object)
 350{
 351
 352        if (!object) {
 353                return ("NULL OBJECT");
 354        }
 355
 356        if (ACPI_GET_DESCRIPTOR_TYPE(object) > ACPI_DESC_TYPE_MAX) {
 357                return ("Not a Descriptor");
 358        }
 359
 360        return (ACPI_CAST_PTR(char,
 361                              acpi_gbl_desc_type_names[ACPI_GET_DESCRIPTOR_TYPE
 362                                                       (object)]));
 363
 364}
 365
 366/*******************************************************************************
 367 *
 368 * FUNCTION:    acpi_ut_get_reference_name
 369 *
 370 * PARAMETERS:  object               - An ACPI reference object
 371 *
 372 * RETURN:      Decoded name of the type of reference
 373 *
 374 * DESCRIPTION: Decode a reference object sub-type to a string.
 375 *
 376 ******************************************************************************/
 377
 378/* Printable names of reference object sub-types */
 379
 380static const char *acpi_gbl_ref_class_names[] = {
 381        /* 00 */ "Local",
 382        /* 01 */ "Argument",
 383        /* 02 */ "RefOf",
 384        /* 03 */ "Index",
 385        /* 04 */ "DdbHandle",
 386        /* 05 */ "Named Object",
 387        /* 06 */ "Debug"
 388};
 389
 390const char *acpi_ut_get_reference_name(union acpi_operand_object *object)
 391{
 392
 393        if (!object) {
 394                return ("NULL Object");
 395        }
 396
 397        if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
 398                return ("Not an Operand object");
 399        }
 400
 401        if (object->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
 402                return ("Not a Reference object");
 403        }
 404
 405        if (object->reference.class > ACPI_REFCLASS_MAX) {
 406                return ("Unknown Reference class");
 407        }
 408
 409        return (acpi_gbl_ref_class_names[object->reference.class]);
 410}
 411
 412#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
 413/*
 414 * Strings and procedures used for debug only
 415 */
 416
 417/*******************************************************************************
 418 *
 419 * FUNCTION:    acpi_ut_get_mutex_name
 420 *
 421 * PARAMETERS:  mutex_id        - The predefined ID for this mutex.
 422 *
 423 * RETURN:      Decoded name of the internal mutex
 424 *
 425 * DESCRIPTION: Translate a mutex ID into a name string (Debug only)
 426 *
 427 ******************************************************************************/
 428
 429/* Names for internal mutex objects, used for debug output */
 430
 431static char *acpi_gbl_mutex_names[ACPI_NUM_MUTEX] = {
 432        "ACPI_MTX_Interpreter",
 433        "ACPI_MTX_Namespace",
 434        "ACPI_MTX_Tables",
 435        "ACPI_MTX_Events",
 436        "ACPI_MTX_Caches",
 437        "ACPI_MTX_Memory",
 438        "ACPI_MTX_CommandComplete",
 439        "ACPI_MTX_CommandReady"
 440};
 441
 442char *acpi_ut_get_mutex_name(u32 mutex_id)
 443{
 444
 445        if (mutex_id > ACPI_MAX_MUTEX) {
 446                return ("Invalid Mutex ID");
 447        }
 448
 449        return (acpi_gbl_mutex_names[mutex_id]);
 450}
 451
 452/*******************************************************************************
 453 *
 454 * FUNCTION:    acpi_ut_get_notify_name
 455 *
 456 * PARAMETERS:  notify_value    - Value from the Notify() request
 457 *
 458 * RETURN:      Decoded name for the notify value
 459 *
 460 * DESCRIPTION: Translate a Notify Value to a notify namestring.
 461 *
 462 ******************************************************************************/
 463
 464/* Names for Notify() values, used for debug output */
 465
 466static const char *acpi_gbl_notify_value_names[ACPI_NOTIFY_MAX + 1] = {
 467        /* 00 */ "Bus Check",
 468        /* 01 */ "Device Check",
 469        /* 02 */ "Device Wake",
 470        /* 03 */ "Eject Request",
 471        /* 04 */ "Device Check Light",
 472        /* 05 */ "Frequency Mismatch",
 473        /* 06 */ "Bus Mode Mismatch",
 474        /* 07 */ "Power Fault",
 475        /* 08 */ "Capabilities Check",
 476        /* 09 */ "Device PLD Check",
 477        /* 10 */ "Reserved",
 478        /* 11 */ "System Locality Update",
 479        /* 12 */ "Shutdown Request"
 480};
 481
 482const char *acpi_ut_get_notify_name(u32 notify_value)
 483{
 484
 485        if (notify_value <= ACPI_NOTIFY_MAX) {
 486                return (acpi_gbl_notify_value_names[notify_value]);
 487        } else if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
 488                return ("Reserved");
 489        } else if (notify_value <= ACPI_MAX_DEVICE_SPECIFIC_NOTIFY) {
 490                return ("Device Specific");
 491        } else {
 492                return ("Hardware Specific");
 493        }
 494}
 495#endif
 496
 497/*******************************************************************************
 498 *
 499 * FUNCTION:    acpi_ut_valid_object_type
 500 *
 501 * PARAMETERS:  type            - Object type to be validated
 502 *
 503 * RETURN:      TRUE if valid object type, FALSE otherwise
 504 *
 505 * DESCRIPTION: Validate an object type
 506 *
 507 ******************************************************************************/
 508
 509u8 acpi_ut_valid_object_type(acpi_object_type type)
 510{
 511
 512        if (type > ACPI_TYPE_LOCAL_MAX) {
 513
 514                /* Note: Assumes all TYPEs are contiguous (external/local) */
 515
 516                return (FALSE);
 517        }
 518
 519        return (TRUE);
 520}
 521