1 /******************************************************************************
3 * Module Name: utbuffer - Buffer dump routines
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
153 #include "accommon.h"
155 #define _COMPONENT ACPI_UTILITIES
156 ACPI_MODULE_NAME ("utbuffer")
159 /*******************************************************************************
161 * FUNCTION: AcpiUtDumpBuffer
163 * PARAMETERS: Buffer - Buffer to dump
164 * Count - Amount to dump, in bytes
165 * Display - BYTE, WORD, DWORD, or QWORD display:
170 * BaseOffset - Beginning buffer offset (display only)
174 * DESCRIPTION: Generic dump buffer in both hex and ascii.
176 ******************************************************************************/
193 AcpiOsPrintf ("Null Buffer Pointer in DumpBuffer!\n");
197 if ((Count < 4) || (Count & 0x01))
199 Display = DB_BYTE_DISPLAY;
202 /* Nasty little dump buffer routine! */
206 /* Print current offset */
208 AcpiOsPrintf ("%8.4X: ", (BaseOffset + i));
210 /* Print 16 hex chars */
216 /* Dump fill spaces */
218 AcpiOsPrintf ("%*s", ((Display * 2) + 1), " ");
225 case DB_BYTE_DISPLAY:
226 default: /* Default is BYTE display */
228 AcpiOsPrintf ("%02X ", Buffer[(ACPI_SIZE) i + j]);
231 case DB_WORD_DISPLAY:
233 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
234 AcpiOsPrintf ("%04X ", Temp32);
237 case DB_DWORD_DISPLAY:
239 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
240 AcpiOsPrintf ("%08X ", Temp32);
243 case DB_QWORD_DISPLAY:
245 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
246 AcpiOsPrintf ("%08X", Temp32);
248 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]);
249 AcpiOsPrintf ("%08X ", Temp32);
257 * Print the ASCII equivalent characters but watch out for the bad
258 * unprintable ones (printable chars are 0x20 through 0x7E)
261 for (j = 0; j < 16; j++)
270 * Add comment characters so rest of line is ignored when
275 AcpiOsPrintf ("// ");
278 BufChar = Buffer[(ACPI_SIZE) i + j];
279 if (isprint (BufChar))
281 AcpiOsPrintf ("%c", BufChar);
289 /* Done with that line. */
299 /*******************************************************************************
301 * FUNCTION: AcpiUtDebugDumpBuffer
303 * PARAMETERS: Buffer - Buffer to dump
304 * Count - Amount to dump, in bytes
305 * Display - BYTE, WORD, DWORD, or QWORD display:
310 * ComponentID - Caller's component ID
314 * DESCRIPTION: Generic dump buffer in both hex and ascii.
316 ******************************************************************************/
319 AcpiUtDebugDumpBuffer (
326 /* Only dump the buffer if tracing is enabled */
328 if (!((ACPI_LV_TABLES & AcpiDbgLevel) &&
329 (ComponentId & AcpiDbgLayer)))
334 AcpiUtDumpBuffer (Buffer, Count, Display, 0);
338 #ifdef ACPI_APPLICATION
339 /*******************************************************************************
341 * FUNCTION: AcpiUtDumpBufferToFile
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:
351 * BaseOffset - Beginning buffer offset (display only)
355 * DESCRIPTION: Generic dump buffer in both hex and ascii to a file.
357 ******************************************************************************/
360 AcpiUtDumpBufferToFile (
375 fprintf (File, "Null Buffer Pointer in DumpBuffer!\n");
379 if ((Count < 4) || (Count & 0x01))
381 Display = DB_BYTE_DISPLAY;
384 /* Nasty little dump buffer routine! */
388 /* Print current offset */
390 fprintf (File, "%8.4X: ", (BaseOffset + i));
392 /* Print 16 hex chars */
398 /* Dump fill spaces */
400 fprintf (File, "%*s", ((Display * 2) + 1), " ");
407 case DB_BYTE_DISPLAY:
408 default: /* Default is BYTE display */
410 fprintf (File, "%02X ", Buffer[(ACPI_SIZE) i + j]);
413 case DB_WORD_DISPLAY:
415 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
416 fprintf (File, "%04X ", Temp32);
419 case DB_DWORD_DISPLAY:
421 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
422 fprintf (File, "%08X ", Temp32);
425 case DB_QWORD_DISPLAY:
427 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
428 fprintf (File, "%08X", Temp32);
430 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]);
431 fprintf (File, "%08X ", Temp32);
439 * Print the ASCII equivalent characters but watch out for the bad
440 * unprintable ones (printable chars are 0x20 through 0x7E)
443 for (j = 0; j < 16; j++)
447 fprintf (File, "\n");
451 BufChar = Buffer[(ACPI_SIZE) i + j];
452 if (isprint (BufChar))
454 fprintf (File, "%c", BufChar);
462 /* Done with that line. */
464 fprintf (File, "\n");