1 /****************************************************************************** 2 * 3 * Module Name: utbuffer - Buffer dump routines 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2021, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include "acpi.h" 153 #include "accommon.h" 154 155 #define _COMPONENT ACPI_UTILITIES 156 ACPI_MODULE_NAME ("utbuffer") 157 158 159 /******************************************************************************* 160 * 161 * FUNCTION: AcpiUtDumpBuffer 162 * 163 * PARAMETERS: Buffer - Buffer to dump 164 * Count - Amount to dump, in bytes 165 * Display - BYTE, WORD, DWORD, or QWORD display: 166 * DB_BYTE_DISPLAY 167 * DB_WORD_DISPLAY 168 * DB_DWORD_DISPLAY 169 * DB_QWORD_DISPLAY 170 * BaseOffset - Beginning buffer offset (display only) 171 * 172 * RETURN: None 173 * 174 * DESCRIPTION: Generic dump buffer in both hex and ascii. 175 * 176 ******************************************************************************/ 177 178 void 179 AcpiUtDumpBuffer ( 180 UINT8 *Buffer, 181 UINT32 Count, 182 UINT32 Display, 183 UINT32 BaseOffset) 184 { 185 UINT32 i = 0; 186 UINT32 j; 187 UINT32 Temp32; 188 UINT8 BufChar; 189 UINT32 DisplayDataOnly = Display & DB_DISPLAY_DATA_ONLY; 190 191 192 Display &= ~DB_DISPLAY_DATA_ONLY; 193 if (!Buffer) 194 { 195 AcpiOsPrintf ("Null Buffer Pointer in DumpBuffer!\n"); 196 return; 197 } 198 199 if ((Count < 4) || (Count & 0x01)) 200 { 201 Display = DB_BYTE_DISPLAY; 202 } 203 204 /* Nasty little dump buffer routine! */ 205 206 while (i < Count) 207 { 208 /* Print current offset */ 209 210 if (!DisplayDataOnly) 211 { 212 AcpiOsPrintf ("%8.4X: ", (BaseOffset + i)); 213 } 214 215 /* Print 16 hex chars */ 216 217 for (j = 0; j < 16;) 218 { 219 if (i + j >= Count) 220 { 221 /* Dump fill spaces */ 222 223 AcpiOsPrintf ("%*s", ((Display * 2) + 1), " "); 224 j += Display; 225 continue; 226 } 227 228 switch (Display) 229 { 230 case DB_BYTE_DISPLAY: 231 default: /* Default is BYTE display */ 232 233 AcpiOsPrintf ("%02X ", Buffer[(ACPI_SIZE) i + j]); 234 break; 235 236 case DB_WORD_DISPLAY: 237 238 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 239 AcpiOsPrintf ("%04X ", Temp32); 240 break; 241 242 case DB_DWORD_DISPLAY: 243 244 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 245 AcpiOsPrintf ("%08X ", Temp32); 246 break; 247 248 case DB_QWORD_DISPLAY: 249 250 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 251 AcpiOsPrintf ("%08X", Temp32); 252 253 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]); 254 AcpiOsPrintf ("%08X ", Temp32); 255 break; 256 } 257 258 j += Display; 259 } 260 261 /* 262 * Print the ASCII equivalent characters but watch out for the bad 263 * unprintable ones (printable chars are 0x20 through 0x7E) 264 */ 265 if (!DisplayDataOnly) 266 { 267 AcpiOsPrintf (" "); 268 for (j = 0; j < 16; j++) 269 { 270 if (i + j >= Count) 271 { 272 AcpiOsPrintf ("\n"); 273 return; 274 } 275 276 /* 277 * Add comment characters so rest of line is ignored when 278 * compiled 279 */ 280 if (j == 0) 281 { 282 AcpiOsPrintf ("// "); 283 } 284 285 BufChar = Buffer[(ACPI_SIZE) i + j]; 286 if (isprint (BufChar)) 287 { 288 AcpiOsPrintf ("%c", BufChar); 289 } 290 else 291 { 292 AcpiOsPrintf ("."); 293 } 294 } 295 296 /* Done with that line. */ 297 298 AcpiOsPrintf ("\n"); 299 } 300 i += 16; 301 } 302 303 return; 304 } 305 306 307 /******************************************************************************* 308 * 309 * FUNCTION: AcpiUtDebugDumpBuffer 310 * 311 * PARAMETERS: Buffer - Buffer to dump 312 * Count - Amount to dump, in bytes 313 * Display - BYTE, WORD, DWORD, or QWORD display: 314 * DB_BYTE_DISPLAY 315 * DB_WORD_DISPLAY 316 * DB_DWORD_DISPLAY 317 * DB_QWORD_DISPLAY 318 * ComponentID - Caller's component ID 319 * 320 * RETURN: None 321 * 322 * DESCRIPTION: Generic dump buffer in both hex and ascii. 323 * 324 ******************************************************************************/ 325 326 void 327 AcpiUtDebugDumpBuffer ( 328 UINT8 *Buffer, 329 UINT32 Count, 330 UINT32 Display, 331 UINT32 ComponentId) 332 { 333 334 /* Only dump the buffer if tracing is enabled */ 335 336 if (!((ACPI_LV_TABLES & AcpiDbgLevel) && 337 (ComponentId & AcpiDbgLayer))) 338 { 339 return; 340 } 341 342 AcpiUtDumpBuffer (Buffer, Count, Display, 0); 343 } 344 345 346 #ifdef ACPI_APPLICATION 347 /******************************************************************************* 348 * 349 * FUNCTION: AcpiUtDumpBufferToFile 350 * 351 * PARAMETERS: File - File descriptor 352 * Buffer - Buffer to dump 353 * Count - Amount to dump, in bytes 354 * Display - BYTE, WORD, DWORD, or QWORD display: 355 * DB_BYTE_DISPLAY 356 * DB_WORD_DISPLAY 357 * DB_DWORD_DISPLAY 358 * DB_QWORD_DISPLAY 359 * BaseOffset - Beginning buffer offset (display only) 360 * 361 * RETURN: None 362 * 363 * DESCRIPTION: Generic dump buffer in both hex and ascii to a file. 364 * 365 ******************************************************************************/ 366 367 void 368 AcpiUtDumpBufferToFile ( 369 ACPI_FILE File, 370 UINT8 *Buffer, 371 UINT32 Count, 372 UINT32 Display, 373 UINT32 BaseOffset) 374 { 375 UINT32 i = 0; 376 UINT32 j; 377 UINT32 Temp32; 378 UINT8 BufChar; 379 380 381 if (!Buffer) 382 { 383 fprintf (File, "Null Buffer Pointer in DumpBuffer!\n"); 384 return; 385 } 386 387 if ((Count < 4) || (Count & 0x01)) 388 { 389 Display = DB_BYTE_DISPLAY; 390 } 391 392 /* Nasty little dump buffer routine! */ 393 394 while (i < Count) 395 { 396 /* Print current offset */ 397 398 fprintf (File, "%8.4X: ", (BaseOffset + i)); 399 400 /* Print 16 hex chars */ 401 402 for (j = 0; j < 16;) 403 { 404 if (i + j >= Count) 405 { 406 /* Dump fill spaces */ 407 408 fprintf (File, "%*s", ((Display * 2) + 1), " "); 409 j += Display; 410 continue; 411 } 412 413 switch (Display) 414 { 415 case DB_BYTE_DISPLAY: 416 default: /* Default is BYTE display */ 417 418 fprintf (File, "%02X ", Buffer[(ACPI_SIZE) i + j]); 419 break; 420 421 case DB_WORD_DISPLAY: 422 423 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 424 fprintf (File, "%04X ", Temp32); 425 break; 426 427 case DB_DWORD_DISPLAY: 428 429 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 430 fprintf (File, "%08X ", Temp32); 431 break; 432 433 case DB_QWORD_DISPLAY: 434 435 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 436 fprintf (File, "%08X", Temp32); 437 438 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]); 439 fprintf (File, "%08X ", Temp32); 440 break; 441 } 442 443 j += Display; 444 } 445 446 /* 447 * Print the ASCII equivalent characters but watch out for the bad 448 * unprintable ones (printable chars are 0x20 through 0x7E) 449 */ 450 fprintf (File, " "); 451 for (j = 0; j < 16; j++) 452 { 453 if (i + j >= Count) 454 { 455 fprintf (File, "\n"); 456 return; 457 } 458 459 BufChar = Buffer[(ACPI_SIZE) i + j]; 460 if (isprint (BufChar)) 461 { 462 fprintf (File, "%c", BufChar); 463 } 464 else 465 { 466 fprintf (File, "."); 467 } 468 } 469 470 /* Done with that line. */ 471 472 fprintf (File, "\n"); 473 i += 16; 474 } 475 476 return; 477 } 478 #endif 479