1 /******************************************************************************
3 * Module Name: utdebug - Debug print routines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #define __UTDEBUG_C__
121 #define _COMPONENT ACPI_UTILITIES
122 ACPI_MODULE_NAME ("utdebug")
125 #ifdef ACPI_DEBUG_OUTPUT
127 static UINT32 AcpiGbl_PrevThreadId = 0xFFFFFFFF;
128 static char *AcpiGbl_FnEntryStr = "----Entry";
129 static char *AcpiGbl_FnExitStr = "----Exit-";
132 /*****************************************************************************
134 * FUNCTION: AcpiUtInitStackPtrTrace
140 * DESCRIPTION: Save the current stack pointer
142 ****************************************************************************/
145 AcpiUtInitStackPtrTrace (
151 AcpiGbl_EntryStackPointer = ACPI_PTR_DIFF (&CurrentSp, NULL);
155 /*****************************************************************************
157 * FUNCTION: AcpiUtTrackStackPtr
163 * DESCRIPTION: Save the current stack pointer
165 ****************************************************************************/
168 AcpiUtTrackStackPtr (
174 CurrentSp = ACPI_PTR_DIFF (&CurrentSp, NULL);
176 if (CurrentSp < AcpiGbl_LowestStackPointer)
178 AcpiGbl_LowestStackPointer = CurrentSp;
181 if (AcpiGbl_NestingLevel > AcpiGbl_DeepestNesting)
183 AcpiGbl_DeepestNesting = AcpiGbl_NestingLevel;
188 /*****************************************************************************
190 * FUNCTION: AcpiUtDebugPrint
192 * PARAMETERS: DebugLevel - Requested debug print level
193 * ProcName - Caller's procedure name
194 * ModuleName - Caller's module name (for error output)
195 * LineNumber - Caller's line number (for error output)
196 * ComponentId - Caller's component ID (for error output)
198 * Format - Printf format field
199 * ... - Optional printf arguments
203 * DESCRIPTION: Print error message with prefix consisting of the module name,
204 * line number, and component ID.
206 ****************************************************************************/
208 void ACPI_INTERNAL_VAR_XFACE
210 UINT32 RequestedDebugLevel,
212 ACPI_DEBUG_PRINT_INFO *DbgInfo,
221 * Stay silent if the debug level or component ID is disabled
223 if (!(RequestedDebugLevel & AcpiDbgLevel) ||
224 !(DbgInfo->ComponentId & AcpiDbgLayer))
230 * Thread tracking and context switch notification
232 ThreadId = AcpiOsGetThreadId ();
234 if (ThreadId != AcpiGbl_PrevThreadId)
236 if (ACPI_LV_THREADS & AcpiDbgLevel)
238 AcpiOsPrintf ("\n**** Context Switch from TID %X to TID %X ****\n\n",
239 AcpiGbl_PrevThreadId, ThreadId);
242 AcpiGbl_PrevThreadId = ThreadId;
246 * Display the module name, current line number, thread ID (if requested),
247 * current procedure nesting level, and the current procedure name
249 AcpiOsPrintf ("%8s-%04ld ", DbgInfo->ModuleName, LineNumber);
251 if (ACPI_LV_THREADS & AcpiDbgLevel)
253 AcpiOsPrintf ("[%04lX] ", ThreadId);
256 AcpiOsPrintf ("[%02ld] %-22.22s: ", AcpiGbl_NestingLevel, DbgInfo->ProcName);
258 va_start (args, Format);
259 AcpiOsVprintf (Format, args);
263 /*****************************************************************************
265 * FUNCTION: AcpiUtDebugPrintRaw
267 * PARAMETERS: RequestedDebugLevel - Requested debug print level
268 * LineNumber - Caller's line number
269 * DbgInfo - Contains:
270 * ProcName - Caller's procedure name
271 * ModuleName - Caller's module name
272 * ComponentId - Caller's component ID
273 * Format - Printf format field
274 * ... - Optional printf arguments
278 * DESCRIPTION: Print message with no headers. Has same interface as
279 * DebugPrint so that the same macros can be used.
281 ****************************************************************************/
283 void ACPI_INTERNAL_VAR_XFACE
284 AcpiUtDebugPrintRaw (
285 UINT32 RequestedDebugLevel,
287 ACPI_DEBUG_PRINT_INFO *DbgInfo,
294 if (!(RequestedDebugLevel & AcpiDbgLevel) ||
295 !(DbgInfo->ComponentId & AcpiDbgLayer))
300 va_start (args, Format);
301 AcpiOsVprintf (Format, args);
305 /*****************************************************************************
307 * FUNCTION: AcpiUtTrace
309 * PARAMETERS: LineNumber - Caller's line number
310 * DbgInfo - Contains:
311 * ProcName - Caller's procedure name
312 * ModuleName - Caller's module name
313 * ComponentId - Caller's component ID
317 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
320 ****************************************************************************/
325 ACPI_DEBUG_PRINT_INFO *DbgInfo)
328 AcpiGbl_NestingLevel++;
329 AcpiUtTrackStackPtr ();
331 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
332 "%s\n", AcpiGbl_FnEntryStr);
336 /*****************************************************************************
338 * FUNCTION: AcpiUtTracePtr
340 * PARAMETERS: LineNumber - Caller's line number
341 * DbgInfo - Contains:
342 * ProcName - Caller's procedure name
343 * ModuleName - Caller's module name
344 * ComponentId - Caller's component ID
345 * Pointer - Pointer to display
349 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
352 ****************************************************************************/
357 ACPI_DEBUG_PRINT_INFO *DbgInfo,
360 AcpiGbl_NestingLevel++;
361 AcpiUtTrackStackPtr ();
363 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
364 "%s %p\n", AcpiGbl_FnEntryStr, Pointer);
368 /*****************************************************************************
370 * FUNCTION: AcpiUtTraceStr
372 * PARAMETERS: LineNumber - Caller's line number
373 * DbgInfo - Contains:
374 * ProcName - Caller's procedure name
375 * ModuleName - Caller's module name
376 * ComponentId - Caller's component ID
377 * String - Additional string to display
381 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
384 ****************************************************************************/
389 ACPI_DEBUG_PRINT_INFO *DbgInfo,
393 AcpiGbl_NestingLevel++;
394 AcpiUtTrackStackPtr ();
396 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
397 "%s %s\n", AcpiGbl_FnEntryStr, String);
401 /*****************************************************************************
403 * FUNCTION: AcpiUtTraceU32
405 * PARAMETERS: LineNumber - Caller's line number
406 * DbgInfo - Contains:
407 * ProcName - Caller's procedure name
408 * ModuleName - Caller's module name
409 * ComponentId - Caller's component ID
410 * Integer - Integer to display
414 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
417 ****************************************************************************/
422 ACPI_DEBUG_PRINT_INFO *DbgInfo,
426 AcpiGbl_NestingLevel++;
427 AcpiUtTrackStackPtr ();
429 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
430 "%s %08X\n", AcpiGbl_FnEntryStr, Integer);
434 /*****************************************************************************
436 * FUNCTION: AcpiUtExit
438 * PARAMETERS: LineNumber - Caller's line number
439 * DbgInfo - Contains:
440 * ProcName - Caller's procedure name
441 * ModuleName - Caller's module name
442 * ComponentId - Caller's component ID
446 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
449 ****************************************************************************/
454 ACPI_DEBUG_PRINT_INFO *DbgInfo)
457 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
458 "%s\n", AcpiGbl_FnExitStr);
460 AcpiGbl_NestingLevel--;
464 /*****************************************************************************
466 * FUNCTION: AcpiUtStatusExit
468 * PARAMETERS: LineNumber - Caller's line number
469 * DbgInfo - Contains:
470 * ProcName - Caller's procedure name
471 * ModuleName - Caller's module name
472 * ComponentId - Caller's component ID
473 * Status - Exit status code
477 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
478 * set in DebugLevel. Prints exit status also.
480 ****************************************************************************/
485 ACPI_DEBUG_PRINT_INFO *DbgInfo,
489 if (ACPI_SUCCESS (Status))
491 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
492 "%s %s\n", AcpiGbl_FnExitStr,
493 AcpiFormatException (Status));
497 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
498 "%s ****Exception****: %s\n", AcpiGbl_FnExitStr,
499 AcpiFormatException (Status));
502 AcpiGbl_NestingLevel--;
506 /*****************************************************************************
508 * FUNCTION: AcpiUtValueExit
510 * PARAMETERS: LineNumber - Caller's line number
511 * DbgInfo - Contains:
512 * ProcName - Caller's procedure name
513 * ModuleName - Caller's module name
514 * ComponentId - Caller's component ID
515 * Value - Value to be printed with exit msg
519 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
520 * set in DebugLevel. Prints exit value also.
522 ****************************************************************************/
527 ACPI_DEBUG_PRINT_INFO *DbgInfo,
531 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
532 "%s %8.8X%8.8X\n", AcpiGbl_FnExitStr,
533 ACPI_FORMAT_UINT64 (Value));
535 AcpiGbl_NestingLevel--;
539 /*****************************************************************************
541 * FUNCTION: AcpiUtPtrExit
543 * PARAMETERS: LineNumber - Caller's line number
544 * DbgInfo - Contains:
545 * ProcName - Caller's procedure name
546 * ModuleName - Caller's module name
547 * ComponentId - Caller's component ID
548 * Value - Value to be printed with exit msg
552 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
553 * set in DebugLevel. Prints exit value also.
555 ****************************************************************************/
560 ACPI_DEBUG_PRINT_INFO *DbgInfo,
564 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS, LineNumber, DbgInfo,
565 "%s %p\n", AcpiGbl_FnExitStr, Ptr);
567 AcpiGbl_NestingLevel--;
573 /*****************************************************************************
575 * FUNCTION: AcpiUtDumpBuffer
577 * PARAMETERS: Buffer - Buffer to dump
578 * Count - Amount to dump, in bytes
579 * Display - BYTE, WORD, DWORD, or QWORD display
580 * ComponentID - Caller's component ID
584 * DESCRIPTION: Generic dump buffer in both hex and ascii.
586 ****************************************************************************/
595 ACPI_NATIVE_UINT i = 0;
601 /* Only dump the buffer if tracing is enabled */
603 if (!((ACPI_LV_TABLES & AcpiDbgLevel) &&
604 (ComponentId & AcpiDbgLayer)))
609 if ((Count < 4) || (Count & 0x01))
611 Display = DB_BYTE_DISPLAY;
614 AcpiOsPrintf ("\nOffset Value\n");
617 * Nasty little dump buffer routine!
621 /* Print current offset */
623 AcpiOsPrintf ("%05X ", (UINT32) i);
625 /* Print 16 hex chars */
635 /* Make sure that the INT8 doesn't get sign-extended! */
639 /* Default is BYTE display */
643 AcpiOsPrintf ("%02X ",
644 *((UINT8 *) &Buffer[i + j]));
649 case DB_WORD_DISPLAY:
651 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[i + j]);
652 AcpiOsPrintf ("%04X ", Temp32);
657 case DB_DWORD_DISPLAY:
659 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[i + j]);
660 AcpiOsPrintf ("%08X ", Temp32);
665 case DB_QWORD_DISPLAY:
667 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[i + j]);
668 AcpiOsPrintf ("%08X", Temp32);
670 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[i + j + 4]);
671 AcpiOsPrintf ("%08X ", Temp32);
678 * Print the ASCII equivalent characters
679 * But watch out for the bad unprintable ones...
681 for (j = 0; j < 16; j++)
689 BufChar = Buffer[i + j];
690 if ((BufChar > 0x1F && BufChar < 0x2E) ||
691 (BufChar > 0x2F && BufChar < 0x61) ||
692 (BufChar > 0x60 && BufChar < 0x7F))
694 AcpiOsPrintf ("%c", BufChar);
702 /* Done with that line. */