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