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 - 2019, 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 <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/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 190 191 if (!Buffer) 192 { 193 AcpiOsPrintf ("Null Buffer Pointer in DumpBuffer!\n"); 194 return; 195 } 196 197 if ((Count < 4) || (Count & 0x01)) 198 { 199 Display = DB_BYTE_DISPLAY; 200 } 201 202 /* Nasty little dump buffer routine! */ 203 204 while (i < Count) 205 { 206 /* Print current offset */ 207 208 AcpiOsPrintf ("%8.4X: ", (BaseOffset + i)); 209 210 /* Print 16 hex chars */ 211 212 for (j = 0; j < 16;) 213 { 214 if (i + j >= Count) 215 { 216 /* Dump fill spaces */ 217 218 AcpiOsPrintf ("%*s", ((Display * 2) + 1), " "); 219 j += Display; 220 continue; 221 } 222 223 switch (Display) 224 { 225 case DB_BYTE_DISPLAY: 226 default: /* Default is BYTE display */ 227 228 AcpiOsPrintf ("%02X ", Buffer[(ACPI_SIZE) i + j]); 229 break; 230 231 case DB_WORD_DISPLAY: 232 233 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 234 AcpiOsPrintf ("%04X ", Temp32); 235 break; 236 237 case DB_DWORD_DISPLAY: 238 239 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 240 AcpiOsPrintf ("%08X ", Temp32); 241 break; 242 243 case DB_QWORD_DISPLAY: 244 245 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 246 AcpiOsPrintf ("%08X", Temp32); 247 248 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]); 249 AcpiOsPrintf ("%08X ", Temp32); 250 break; 251 } 252 253 j += Display; 254 } 255 256 /* 257 * Print the ASCII equivalent characters but watch out for the bad 258 * unprintable ones (printable chars are 0x20 through 0x7E) 259 */ 260 AcpiOsPrintf (" "); 261 for (j = 0; j < 16; j++) 262 { 263 if (i + j >= Count) 264 { 265 AcpiOsPrintf ("\n"); 266 return; 267 } 268 269 /* 270 * Add comment characters so rest of line is ignored when 271 * compiled 272 */ 273 if (j == 0) 274 { 275 AcpiOsPrintf ("// "); 276 } 277 278 BufChar = Buffer[(ACPI_SIZE) i + j]; 279 if (isprint (BufChar)) 280 { 281 AcpiOsPrintf ("%c", BufChar); 282 } 283 else 284 { 285 AcpiOsPrintf ("."); 286 } 287 } 288 289 /* Done with that line. */ 290 291 AcpiOsPrintf ("\n"); 292 i += 16; 293 } 294 295 return; 296 } 297 298 299 /******************************************************************************* 300 * 301 * FUNCTION: AcpiUtDebugDumpBuffer 302 * 303 * PARAMETERS: Buffer - Buffer to dump 304 * Count - Amount to dump, in bytes 305 * Display - BYTE, WORD, DWORD, or QWORD display: 306 * DB_BYTE_DISPLAY 307 * DB_WORD_DISPLAY 308 * DB_DWORD_DISPLAY 309 * DB_QWORD_DISPLAY 310 * ComponentID - Caller's component ID 311 * 312 * RETURN: None 313 * 314 * DESCRIPTION: Generic dump buffer in both hex and ascii. 315 * 316 ******************************************************************************/ 317 318 void 319 AcpiUtDebugDumpBuffer ( 320 UINT8 *Buffer, 321 UINT32 Count, 322 UINT32 Display, 323 UINT32 ComponentId) 324 { 325 326 /* Only dump the buffer if tracing is enabled */ 327 328 if (!((ACPI_LV_TABLES & AcpiDbgLevel) && 329 (ComponentId & AcpiDbgLayer))) 330 { 331 return; 332 } 333 334 AcpiUtDumpBuffer (Buffer, Count, Display, 0); 335 } 336 337 338 #ifdef ACPI_APPLICATION 339 /******************************************************************************* 340 * 341 * FUNCTION: AcpiUtDumpBufferToFile 342 * 343 * PARAMETERS: File - File descriptor 344 * Buffer - Buffer to dump 345 * Count - Amount to dump, in bytes 346 * Display - BYTE, WORD, DWORD, or QWORD display: 347 * DB_BYTE_DISPLAY 348 * DB_WORD_DISPLAY 349 * DB_DWORD_DISPLAY 350 * DB_QWORD_DISPLAY 351 * BaseOffset - Beginning buffer offset (display only) 352 * 353 * RETURN: None 354 * 355 * DESCRIPTION: Generic dump buffer in both hex and ascii to a file. 356 * 357 ******************************************************************************/ 358 359 void 360 AcpiUtDumpBufferToFile ( 361 ACPI_FILE File, 362 UINT8 *Buffer, 363 UINT32 Count, 364 UINT32 Display, 365 UINT32 BaseOffset) 366 { 367 UINT32 i = 0; 368 UINT32 j; 369 UINT32 Temp32; 370 UINT8 BufChar; 371 372 373 if (!Buffer) 374 { 375 fprintf (File, "Null Buffer Pointer in DumpBuffer!\n"); 376 return; 377 } 378 379 if ((Count < 4) || (Count & 0x01)) 380 { 381 Display = DB_BYTE_DISPLAY; 382 } 383 384 /* Nasty little dump buffer routine! */ 385 386 while (i < Count) 387 { 388 /* Print current offset */ 389 390 fprintf (File, "%8.4X: ", (BaseOffset + i)); 391 392 /* Print 16 hex chars */ 393 394 for (j = 0; j < 16;) 395 { 396 if (i + j >= Count) 397 { 398 /* Dump fill spaces */ 399 400 fprintf (File, "%*s", ((Display * 2) + 1), " "); 401 j += Display; 402 continue; 403 } 404 405 switch (Display) 406 { 407 case DB_BYTE_DISPLAY: 408 default: /* Default is BYTE display */ 409 410 fprintf (File, "%02X ", Buffer[(ACPI_SIZE) i + j]); 411 break; 412 413 case DB_WORD_DISPLAY: 414 415 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 416 fprintf (File, "%04X ", Temp32); 417 break; 418 419 case DB_DWORD_DISPLAY: 420 421 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 422 fprintf (File, "%08X ", Temp32); 423 break; 424 425 case DB_QWORD_DISPLAY: 426 427 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]); 428 fprintf (File, "%08X", Temp32); 429 430 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]); 431 fprintf (File, "%08X ", Temp32); 432 break; 433 } 434 435 j += Display; 436 } 437 438 /* 439 * Print the ASCII equivalent characters but watch out for the bad 440 * unprintable ones (printable chars are 0x20 through 0x7E) 441 */ 442 fprintf (File, " "); 443 for (j = 0; j < 16; j++) 444 { 445 if (i + j >= Count) 446 { 447 fprintf (File, "\n"); 448 return; 449 } 450 451 BufChar = Buffer[(ACPI_SIZE) i + j]; 452 if (isprint (BufChar)) 453 { 454 fprintf (File, "%c", BufChar); 455 } 456 else 457 { 458 fprintf (File, "."); 459 } 460 } 461 462 /* Done with that line. */ 463 464 fprintf (File, "\n"); 465 i += 16; 466 } 467 468 return; 469 } 470 #endif 471