1 /****************************************************************************** 2 * 3 * Module Name: exdebug - Support for stores to the AML Debug Object 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #include "acpi.h" 117 #include "accommon.h" 118 #include "acinterp.h" 119 120 121 #define _COMPONENT ACPI_EXECUTER 122 ACPI_MODULE_NAME ("exdebug") 123 124 125 #ifndef ACPI_NO_ERROR_MESSAGES 126 /******************************************************************************* 127 * 128 * FUNCTION: AcpiExDoDebugObject 129 * 130 * PARAMETERS: SourceDesc - Object to be output to "Debug Object" 131 * Level - Indentation level (used for packages) 132 * Index - Current package element, zero if not pkg 133 * 134 * RETURN: None 135 * 136 * DESCRIPTION: Handles stores to the AML Debug Object. For example: 137 * Store(INT1, Debug) 138 * 139 * This function is not compiled if ACPI_NO_ERROR_MESSAGES is set. 140 * 141 * This function is only enabled if AcpiGbl_EnableAmlDebugObject is set, or 142 * if ACPI_LV_DEBUG_OBJECT is set in the AcpiDbgLevel. Thus, in the normal 143 * operational case, stores to the debug object are ignored but can be easily 144 * enabled if necessary. 145 * 146 ******************************************************************************/ 147 148 void 149 AcpiExDoDebugObject ( 150 ACPI_OPERAND_OBJECT *SourceDesc, 151 UINT32 Level, 152 UINT32 Index) 153 { 154 UINT32 i; 155 UINT32 Timer; 156 ACPI_OPERAND_OBJECT *ObjectDesc; 157 UINT32 Value; 158 159 160 ACPI_FUNCTION_TRACE_PTR (ExDoDebugObject, SourceDesc); 161 162 163 /* Output must be enabled via the DebugObject global or the DbgLevel */ 164 165 if (!AcpiGbl_EnableAmlDebugObject && 166 !(AcpiDbgLevel & ACPI_LV_DEBUG_OBJECT)) 167 { 168 return_VOID; 169 } 170 171 /* Null string or newline -- don't emit the line header */ 172 173 if (SourceDesc && 174 (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND) && 175 (SourceDesc->Common.Type == ACPI_TYPE_STRING)) 176 { 177 if ((SourceDesc->String.Length == 0) || 178 ((SourceDesc->String.Length == 1) && 179 (*SourceDesc->String.Pointer == '\n'))) 180 { 181 AcpiOsPrintf ("\n"); 182 return_VOID; 183 } 184 } 185 186 /* 187 * Print line header as long as we are not in the middle of an 188 * object display 189 */ 190 if (!((Level > 0) && Index == 0)) 191 { 192 if (AcpiGbl_DisplayDebugTimer) 193 { 194 /* 195 * We will emit the current timer value (in microseconds) with each 196 * debug output. Only need the lower 26 bits. This allows for 67 197 * million microseconds or 67 seconds before rollover. 198 * 199 * Convert 100 nanosecond units to microseconds 200 */ 201 Timer = ((UINT32) AcpiOsGetTimer () / 10); 202 Timer &= 0x03FFFFFF; 203 204 AcpiOsPrintf ("[ACPI Debug T=0x%8.8X] %*s", Timer, Level, " "); 205 } 206 else 207 { 208 AcpiOsPrintf ("[ACPI Debug] %*s", Level, " "); 209 } 210 } 211 212 /* Display the index for package output only */ 213 214 if (Index > 0) 215 { 216 AcpiOsPrintf ("(%.2u) ", Index - 1); 217 } 218 219 if (!SourceDesc) 220 { 221 AcpiOsPrintf ("[Null Object]\n"); 222 return_VOID; 223 } 224 225 if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_OPERAND) 226 { 227 /* No object type prefix needed for integers and strings */ 228 229 if ((SourceDesc->Common.Type != ACPI_TYPE_INTEGER) && 230 (SourceDesc->Common.Type != ACPI_TYPE_STRING)) 231 { 232 AcpiOsPrintf ("%s ", AcpiUtGetObjectTypeName (SourceDesc)); 233 } 234 235 if (!AcpiUtValidInternalObject (SourceDesc)) 236 { 237 AcpiOsPrintf ("%p, Invalid Internal Object!\n", SourceDesc); 238 return_VOID; 239 } 240 } 241 else if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc) == ACPI_DESC_TYPE_NAMED) 242 { 243 AcpiOsPrintf ("%s (Node %p)\n", 244 AcpiUtGetTypeName (((ACPI_NAMESPACE_NODE *) SourceDesc)->Type), 245 SourceDesc); 246 return_VOID; 247 } 248 else 249 { 250 return_VOID; 251 } 252 253 /* SourceDesc is of type ACPI_DESC_TYPE_OPERAND */ 254 255 switch (SourceDesc->Common.Type) 256 { 257 case ACPI_TYPE_INTEGER: 258 259 /* Output correct integer width */ 260 261 if (AcpiGbl_IntegerByteWidth == 4) 262 { 263 AcpiOsPrintf ("0x%8.8X\n", 264 (UINT32) SourceDesc->Integer.Value); 265 } 266 else 267 { 268 AcpiOsPrintf ("0x%8.8X%8.8X\n", 269 ACPI_FORMAT_UINT64 (SourceDesc->Integer.Value)); 270 } 271 break; 272 273 case ACPI_TYPE_BUFFER: 274 275 AcpiOsPrintf ("[0x%.2X]\n", (UINT32) SourceDesc->Buffer.Length); 276 AcpiUtDumpBuffer (SourceDesc->Buffer.Pointer, 277 (SourceDesc->Buffer.Length < 256) ? 278 SourceDesc->Buffer.Length : 256, DB_BYTE_DISPLAY, 0); 279 break; 280 281 case ACPI_TYPE_STRING: 282 283 AcpiOsPrintf ("\"%s\"\n", SourceDesc->String.Pointer); 284 break; 285 286 case ACPI_TYPE_PACKAGE: 287 288 AcpiOsPrintf ("(Contains 0x%.2X Elements):\n", 289 SourceDesc->Package.Count); 290 291 /* Output the entire contents of the package */ 292 293 for (i = 0; i < SourceDesc->Package.Count; i++) 294 { 295 AcpiExDoDebugObject (SourceDesc->Package.Elements[i], 296 Level + 4, i + 1); 297 } 298 break; 299 300 case ACPI_TYPE_LOCAL_REFERENCE: 301 302 AcpiOsPrintf ("[%s] ", AcpiUtGetReferenceName (SourceDesc)); 303 304 /* Decode the reference */ 305 306 switch (SourceDesc->Reference.Class) 307 { 308 case ACPI_REFCLASS_INDEX: 309 310 AcpiOsPrintf ("0x%X\n", SourceDesc->Reference.Value); 311 break; 312 313 case ACPI_REFCLASS_TABLE: 314 315 /* Case for DdbHandle */ 316 317 AcpiOsPrintf ("Table Index 0x%X\n", SourceDesc->Reference.Value); 318 return_VOID; 319 320 default: 321 322 break; 323 } 324 325 AcpiOsPrintf (" "); 326 327 /* Check for valid node first, then valid object */ 328 329 if (SourceDesc->Reference.Node) 330 { 331 if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Node) != 332 ACPI_DESC_TYPE_NAMED) 333 { 334 AcpiOsPrintf (" %p - Not a valid namespace node\n", 335 SourceDesc->Reference.Node); 336 } 337 else 338 { 339 AcpiOsPrintf ("Node %p [%4.4s] ", SourceDesc->Reference.Node, 340 (SourceDesc->Reference.Node)->Name.Ascii); 341 342 switch ((SourceDesc->Reference.Node)->Type) 343 { 344 /* These types have no attached object */ 345 346 case ACPI_TYPE_DEVICE: 347 AcpiOsPrintf ("Device\n"); 348 break; 349 350 case ACPI_TYPE_THERMAL: 351 AcpiOsPrintf ("Thermal Zone\n"); 352 break; 353 354 default: 355 356 AcpiExDoDebugObject ((SourceDesc->Reference.Node)->Object, 357 Level + 4, 0); 358 break; 359 } 360 } 361 } 362 else if (SourceDesc->Reference.Object) 363 { 364 if (ACPI_GET_DESCRIPTOR_TYPE (SourceDesc->Reference.Object) == 365 ACPI_DESC_TYPE_NAMED) 366 { 367 /* Reference object is a namespace node */ 368 369 AcpiExDoDebugObject (ACPI_CAST_PTR (ACPI_OPERAND_OBJECT, 370 SourceDesc->Reference.Object), 371 Level + 4, 0); 372 } 373 else 374 { 375 ObjectDesc = SourceDesc->Reference.Object; 376 Value = SourceDesc->Reference.Value; 377 378 switch (ObjectDesc->Common.Type) 379 { 380 case ACPI_TYPE_BUFFER: 381 382 AcpiOsPrintf ("Buffer[%u] = 0x%2.2X\n", 383 Value, *SourceDesc->Reference.IndexPointer); 384 break; 385 386 case ACPI_TYPE_STRING: 387 388 AcpiOsPrintf ("String[%u] = \"%c\" (0x%2.2X)\n", 389 Value, *SourceDesc->Reference.IndexPointer, 390 *SourceDesc->Reference.IndexPointer); 391 break; 392 393 case ACPI_TYPE_PACKAGE: 394 395 AcpiOsPrintf ("Package[%u] = ", Value); 396 if (!(*SourceDesc->Reference.Where)) 397 { 398 AcpiOsPrintf ("[Uninitialized Package Element]\n"); 399 } 400 else 401 { 402 AcpiExDoDebugObject (*SourceDesc->Reference.Where, 403 Level+4, 0); 404 } 405 break; 406 407 default: 408 409 AcpiOsPrintf ("Unknown Reference object type %X\n", 410 ObjectDesc->Common.Type); 411 break; 412 } 413 } 414 } 415 break; 416 417 default: 418 419 AcpiOsPrintf ("(Descriptor %p)\n", SourceDesc); 420 break; 421 } 422 423 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, "\n")); 424 return_VOID; 425 } 426 #endif 427