drivers/acpi/components/utilities/utbuffer.c

   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 - 2015, 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
 119 #define _COMPONENT          ACPI_UTILITIES
 120         ACPI_MODULE_NAME    ("utbuffer")
 121
 122
 123 /*******************************************************************************
 124  *
 125  * FUNCTION:    AcpiUtDumpBuffer
 126  *
 127  * PARAMETERS:  Buffer              - Buffer to dump
 128  *              Count               - Amount to dump, in bytes
 129  *              Display             - BYTE, WORD, DWORD, or QWORD display:
 130  *                                      DB_BYTE_DISPLAY
 131  *                                      DB_WORD_DISPLAY
 132  *                                      DB_DWORD_DISPLAY
 133  *                                      DB_QWORD_DISPLAY
 134  *              BaseOffset          - Beginning buffer offset (display only)
 135  *
 136  * RETURN:      None
 137  *
 138  * DESCRIPTION: Generic dump buffer in both hex and ascii.
 139  *
 140  ******************************************************************************/
 141
 142 void
 143 AcpiUtDumpBuffer (
 144     UINT8                   *Buffer,
 145     UINT32                  Count,
 146     UINT32                  Display,
 147     UINT32                  BaseOffset)
 148 {
 149     UINT32                  i = 0;
 150     UINT32                  j;
 151     UINT32                  Temp32;
 152     UINT8                   BufChar;
 153
 154
 155     if (!Buffer)
 156     {
 157         AcpiOsPrintf ("Null Buffer Pointer in DumpBuffer!\n");
 158         return;
 159     }
 160
 161     if ((Count < 4) || (Count & 0x01))
 162     {
 163         Display = DB_BYTE_DISPLAY;
 164     }
 165
 166     /* Nasty little dump buffer routine! */
 167
 168     while (i < Count)
 169     {
 170         /* Print current offset */
 171
 172         AcpiOsPrintf ("%6.4X: ", (BaseOffset + i));
 173
 174         /* Print 16 hex chars */
 175
 176         for (j = 0; j < 16;)
 177         {
 178             if (i + j >= Count)
 179             {
 180                 /* Dump fill spaces */
 181
 182                 AcpiOsPrintf ("%*s", ((Display * 2) + 1), " ");
 183                 j += Display;
 184                 continue;
 185             }
 186
 187             switch (Display)
 188             {
 189             case DB_BYTE_DISPLAY:
 190             default:    /* Default is BYTE display */
 191
 192                 AcpiOsPrintf ("%02X ", Buffer[(ACPI_SIZE) i + j]);
 193                 break;
 194
 195             case DB_WORD_DISPLAY:
 196
 197                 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
 198                 AcpiOsPrintf ("%04X ", Temp32);
 199                 break;
 200
 201             case DB_DWORD_DISPLAY:
 202
 203                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
 204                 AcpiOsPrintf ("%08X ", Temp32);
 205                 break;
 206
 207             case DB_QWORD_DISPLAY:
 208
 209                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
 210                 AcpiOsPrintf ("%08X", Temp32);
 211
 212                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]);
 213                 AcpiOsPrintf ("%08X ", Temp32);
 214                 break;
 215             }
 216
 217             j += Display;
 218         }
 219
 220         /*
 221          * Print the ASCII equivalent characters but watch out for the bad
 222          * unprintable ones (printable chars are 0x20 through 0x7E)
 223          */
 224         AcpiOsPrintf (" ");
 225         for (j = 0; j < 16; j++)
 226         {
 227             if (i + j >= Count)
 228             {
 229                 AcpiOsPrintf ("\n");
 230                 return;
 231             }
 232
 233             /*
 234              * Add comment characters so rest of line is ignored when
 235              * compiled
 236              */
 237             if (j == 0)
 238             {
 239                 AcpiOsPrintf ("// ");
 240             }
 241
 242             BufChar = Buffer[(ACPI_SIZE) i + j];
 243             if (ACPI_IS_PRINT (BufChar))
 244             {
 245                 AcpiOsPrintf ("%c", BufChar);
 246             }
 247             else
 248             {
 249                 AcpiOsPrintf (".");
 250             }
 251         }
 252
 253         /* Done with that line. */
 254
 255         AcpiOsPrintf ("\n");
 256         i += 16;
 257     }
 258
 259     return;
 260 }
 261
 262
 263 /*******************************************************************************
 264  *
 265  * FUNCTION:    AcpiUtDebugDumpBuffer
 266  *
 267  * PARAMETERS:  Buffer              - Buffer to dump
 268  *              Count               - Amount to dump, in bytes
 269  *              Display             - BYTE, WORD, DWORD, or QWORD display:
 270  *                                      DB_BYTE_DISPLAY
 271  *                                      DB_WORD_DISPLAY
 272  *                                      DB_DWORD_DISPLAY
 273  *                                      DB_QWORD_DISPLAY
 274  *              ComponentID         - Caller's component ID
 275  *
 276  * RETURN:      None
 277  *
 278  * DESCRIPTION: Generic dump buffer in both hex and ascii.
 279  *
 280  ******************************************************************************/
 281
 282 void
 283 AcpiUtDebugDumpBuffer (
 284     UINT8                   *Buffer,
 285     UINT32                  Count,
 286     UINT32                  Display,
 287     UINT32                  ComponentId)
 288 {
 289
 290     /* Only dump the buffer if tracing is enabled */
 291
 292     if (!((ACPI_LV_TABLES & AcpiDbgLevel) &&
 293         (ComponentId & AcpiDbgLayer)))
 294     {
 295         return;
 296     }
 297
 298     AcpiUtDumpBuffer (Buffer, Count, Display, 0);
 299 }
 300
 301
 302 #ifdef ACPI_APPLICATION
 303 /*******************************************************************************
 304  *
 305  * FUNCTION:    AcpiUtDumpBufferToFile
 306  *
 307  * PARAMETERS:  File                - File descriptor
 308  *              Buffer              - Buffer to dump
 309  *              Count               - Amount to dump, in bytes
 310  *              Display             - BYTE, WORD, DWORD, or QWORD display:
 311  *                                      DB_BYTE_DISPLAY
 312  *                                      DB_WORD_DISPLAY
 313  *                                      DB_DWORD_DISPLAY
 314  *                                      DB_QWORD_DISPLAY
 315  *              BaseOffset          - Beginning buffer offset (display only)
 316  *
 317  * RETURN:      None
 318  *
 319  * DESCRIPTION: Generic dump buffer in both hex and ascii to a file.
 320  *
 321  ******************************************************************************/
 322
 323 void
 324 AcpiUtDumpBufferToFile (
 325     ACPI_FILE               File,
 326     UINT8                   *Buffer,
 327     UINT32                  Count,
 328     UINT32                  Display,
 329     UINT32                  BaseOffset)
 330 {
 331     UINT32                  i = 0;
 332     UINT32                  j;
 333     UINT32                  Temp32;
 334     UINT8                   BufChar;
 335
 336
 337     if (!Buffer)
 338     {
 339         AcpiUtFilePrintf (File, "Null Buffer Pointer in DumpBuffer!\n");
 340         return;
 341     }
 342
 343     if ((Count < 4) || (Count & 0x01))
 344     {
 345         Display = DB_BYTE_DISPLAY;
 346     }
 347
 348     /* Nasty little dump buffer routine! */
 349
 350     while (i < Count)
 351     {
 352         /* Print current offset */
 353
 354         AcpiUtFilePrintf (File, "%6.4X: ", (BaseOffset + i));
 355
 356         /* Print 16 hex chars */
 357
 358         for (j = 0; j < 16;)
 359         {
 360             if (i + j >= Count)
 361             {
 362                 /* Dump fill spaces */
 363
 364                 AcpiUtFilePrintf (File, "%*s", ((Display * 2) + 1), " ");
 365                 j += Display;
 366                 continue;
 367             }
 368
 369             switch (Display)
 370             {
 371             case DB_BYTE_DISPLAY:
 372             default:    /* Default is BYTE display */
 373
 374                 AcpiUtFilePrintf (File, "%02X ", Buffer[(ACPI_SIZE) i + j]);
 375                 break;
 376
 377             case DB_WORD_DISPLAY:
 378
 379                 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
 380                 AcpiUtFilePrintf (File, "%04X ", Temp32);
 381                 break;
 382
 383             case DB_DWORD_DISPLAY:
 384
 385                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
 386                 AcpiUtFilePrintf (File, "%08X ", Temp32);
 387                 break;
 388
 389             case DB_QWORD_DISPLAY:
 390
 391                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
 392                 AcpiUtFilePrintf (File, "%08X", Temp32);
 393
 394                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]);
 395                 AcpiUtFilePrintf (File, "%08X ", Temp32);
 396                 break;
 397             }
 398
 399             j += Display;
 400         }
 401
 402         /*
 403          * Print the ASCII equivalent characters but watch out for the bad
 404          * unprintable ones (printable chars are 0x20 through 0x7E)
 405          */
 406         AcpiUtFilePrintf (File, " ");
 407         for (j = 0; j < 16; j++)
 408         {
 409             if (i + j >= Count)
 410             {
 411                 AcpiUtFilePrintf (File, "\n");
 412                 return;
 413             }
 414
 415             BufChar = Buffer[(ACPI_SIZE) i + j];
 416             if (ACPI_IS_PRINT (BufChar))
 417             {
 418                 AcpiUtFilePrintf (File, "%c", BufChar);
 419             }
 420             else
 421             {
 422                 AcpiUtFilePrintf (File, ".");
 423             }
 424         }
 425
 426         /* Done with that line. */
 427
 428         AcpiUtFilePrintf (File, "\n");
 429         i += 16;
 430     }
 431
 432     return;
 433 }
 434 #endif