1 /******************************************************************************
3 * Module Name: utdebug - Debug print routines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, 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__
119 #include <contrib/dev/acpica/acpi.h>
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-";
131 /* Local prototypes */
134 AcpiUtTrimFunctionName (
135 const char *FunctionName);
138 /*******************************************************************************
140 * FUNCTION: AcpiUtInitStackPtrTrace
146 * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
148 ******************************************************************************/
151 AcpiUtInitStackPtrTrace (
157 AcpiGbl_EntryStackPointer = ACPI_PTR_DIFF (&CurrentSp, NULL);
161 /*******************************************************************************
163 * FUNCTION: AcpiUtTrackStackPtr
169 * DESCRIPTION: Save the current CPU stack pointer
171 ******************************************************************************/
174 AcpiUtTrackStackPtr (
180 CurrentSp = ACPI_PTR_DIFF (&CurrentSp, NULL);
182 if (CurrentSp < AcpiGbl_LowestStackPointer)
184 AcpiGbl_LowestStackPointer = CurrentSp;
187 if (AcpiGbl_NestingLevel > AcpiGbl_DeepestNesting)
189 AcpiGbl_DeepestNesting = AcpiGbl_NestingLevel;
194 /*******************************************************************************
196 * FUNCTION: AcpiUtTrimFunctionName
198 * PARAMETERS: FunctionName - Ascii string containing a procedure name
200 * RETURN: Updated pointer to the function name
202 * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
203 * This allows compiler macros such as __FUNCTION__ to be used
204 * with no change to the debug output.
206 ******************************************************************************/
209 AcpiUtTrimFunctionName (
210 const char *FunctionName)
213 /* All Function names are longer than 4 chars, check is safe */
215 if (*(ACPI_CAST_PTR (UINT32, FunctionName)) == ACPI_PREFIX_MIXED)
217 /* This is the case where the original source has not been modified */
219 return (FunctionName + 4);
222 if (*(ACPI_CAST_PTR (UINT32, FunctionName)) == ACPI_PREFIX_LOWER)
224 /* This is the case where the source has been 'linuxized' */
226 return (FunctionName + 5);
229 return (FunctionName);
233 /*******************************************************************************
235 * FUNCTION: AcpiUtDebugPrint
237 * PARAMETERS: RequestedDebugLevel - Requested debug print level
238 * LineNumber - Caller's line number (for error output)
239 * FunctionName - Caller's procedure name
240 * ModuleName - Caller's module name
241 * ComponentId - Caller's component ID
242 * Format - Printf format field
243 * ... - Optional printf arguments
247 * DESCRIPTION: Print error message with prefix consisting of the module name,
248 * line number, and component ID.
250 ******************************************************************************/
252 void ACPI_INTERNAL_VAR_XFACE
254 UINT32 RequestedDebugLevel,
256 const char *FunctionName,
262 ACPI_THREAD_ID ThreadId;
267 * Stay silent if the debug level or component ID is disabled
269 if (!(RequestedDebugLevel & AcpiDbgLevel) ||
270 !(ComponentId & AcpiDbgLayer))
276 * Thread tracking and context switch notification
278 ThreadId = AcpiOsGetThreadId ();
279 if (ThreadId != AcpiGbl_PrevThreadId)
281 if (ACPI_LV_THREADS & AcpiDbgLevel)
284 "\n**** Context Switch from TID %X to TID %X ****\n\n",
285 AcpiGbl_PrevThreadId, ThreadId);
288 AcpiGbl_PrevThreadId = ThreadId;
292 * Display the module name, current line number, thread ID (if requested),
293 * current procedure nesting level, and the current procedure name
295 AcpiOsPrintf ("%8s-%04ld ", ModuleName, LineNumber);
297 if (ACPI_LV_THREADS & AcpiDbgLevel)
299 AcpiOsPrintf ("[%04lX] ", ThreadId);
302 AcpiOsPrintf ("[%02ld] %-22.22s: ",
303 AcpiGbl_NestingLevel, AcpiUtTrimFunctionName (FunctionName));
305 va_start (args, Format);
306 AcpiOsVprintf (Format, args);
309 ACPI_EXPORT_SYMBOL (AcpiUtDebugPrint)
312 /*******************************************************************************
314 * FUNCTION: AcpiUtDebugPrintRaw
316 * PARAMETERS: RequestedDebugLevel - Requested debug print level
317 * LineNumber - Caller's line number
318 * FunctionName - Caller's procedure name
319 * ModuleName - Caller's module name
320 * ComponentId - Caller's component ID
321 * Format - Printf format field
322 * ... - Optional printf arguments
326 * DESCRIPTION: Print message with no headers. Has same interface as
327 * DebugPrint so that the same macros can be used.
329 ******************************************************************************/
331 void ACPI_INTERNAL_VAR_XFACE
332 AcpiUtDebugPrintRaw (
333 UINT32 RequestedDebugLevel,
335 const char *FunctionName,
344 if (!(RequestedDebugLevel & AcpiDbgLevel) ||
345 !(ComponentId & AcpiDbgLayer))
350 va_start (args, Format);
351 AcpiOsVprintf (Format, args);
354 ACPI_EXPORT_SYMBOL (AcpiUtDebugPrintRaw)
357 /*******************************************************************************
359 * FUNCTION: AcpiUtTrace
361 * PARAMETERS: LineNumber - Caller's line number
362 * FunctionName - Caller's procedure name
363 * ModuleName - Caller's module name
364 * ComponentId - Caller's component ID
368 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
371 ******************************************************************************/
376 const char *FunctionName,
381 AcpiGbl_NestingLevel++;
382 AcpiUtTrackStackPtr ();
384 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
385 LineNumber, FunctionName, ModuleName, ComponentId,
386 "%s\n", AcpiGbl_FnEntryStr);
389 ACPI_EXPORT_SYMBOL (AcpiUtTrace)
392 /*******************************************************************************
394 * FUNCTION: AcpiUtTracePtr
396 * PARAMETERS: LineNumber - Caller's line number
397 * FunctionName - Caller's procedure name
398 * ModuleName - Caller's module name
399 * ComponentId - Caller's component ID
400 * Pointer - Pointer to display
404 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
407 ******************************************************************************/
412 const char *FunctionName,
417 AcpiGbl_NestingLevel++;
418 AcpiUtTrackStackPtr ();
420 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
421 LineNumber, FunctionName, ModuleName, ComponentId,
422 "%s %p\n", AcpiGbl_FnEntryStr, Pointer);
426 /*******************************************************************************
428 * FUNCTION: AcpiUtTraceStr
430 * PARAMETERS: LineNumber - Caller's line number
431 * FunctionName - Caller's procedure name
432 * ModuleName - Caller's module name
433 * ComponentId - Caller's component ID
434 * String - Additional string to display
438 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
441 ******************************************************************************/
446 const char *FunctionName,
452 AcpiGbl_NestingLevel++;
453 AcpiUtTrackStackPtr ();
455 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
456 LineNumber, FunctionName, ModuleName, ComponentId,
457 "%s %s\n", AcpiGbl_FnEntryStr, String);
461 /*******************************************************************************
463 * FUNCTION: AcpiUtTraceU32
465 * PARAMETERS: LineNumber - Caller's line number
466 * FunctionName - Caller's procedure name
467 * ModuleName - Caller's module name
468 * ComponentId - Caller's component ID
469 * Integer - Integer to display
473 * DESCRIPTION: Function entry trace. Prints only if TRACE_FUNCTIONS bit is
476 ******************************************************************************/
481 const char *FunctionName,
487 AcpiGbl_NestingLevel++;
488 AcpiUtTrackStackPtr ();
490 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
491 LineNumber, FunctionName, ModuleName, ComponentId,
492 "%s %08X\n", AcpiGbl_FnEntryStr, Integer);
496 /*******************************************************************************
498 * FUNCTION: AcpiUtExit
500 * PARAMETERS: LineNumber - Caller's line number
501 * FunctionName - Caller's procedure name
502 * ModuleName - Caller's module name
503 * ComponentId - Caller's component ID
507 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
510 ******************************************************************************/
515 const char *FunctionName,
520 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
521 LineNumber, FunctionName, ModuleName, ComponentId,
522 "%s\n", AcpiGbl_FnExitStr);
524 AcpiGbl_NestingLevel--;
527 ACPI_EXPORT_SYMBOL (AcpiUtExit)
530 /*******************************************************************************
532 * FUNCTION: AcpiUtStatusExit
534 * PARAMETERS: LineNumber - Caller's line number
535 * FunctionName - Caller's procedure name
536 * ModuleName - Caller's module name
537 * ComponentId - Caller's component ID
538 * Status - Exit status code
542 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
543 * set in DebugLevel. Prints exit status also.
545 ******************************************************************************/
550 const char *FunctionName,
556 if (ACPI_SUCCESS (Status))
558 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
559 LineNumber, FunctionName, ModuleName, ComponentId,
560 "%s %s\n", AcpiGbl_FnExitStr,
561 AcpiFormatException (Status));
565 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
566 LineNumber, FunctionName, ModuleName, ComponentId,
567 "%s ****Exception****: %s\n", AcpiGbl_FnExitStr,
568 AcpiFormatException (Status));
571 AcpiGbl_NestingLevel--;
574 ACPI_EXPORT_SYMBOL (AcpiUtStatusExit)
577 /*******************************************************************************
579 * FUNCTION: AcpiUtValueExit
581 * PARAMETERS: LineNumber - Caller's line number
582 * FunctionName - Caller's procedure name
583 * ModuleName - Caller's module name
584 * ComponentId - Caller's component ID
585 * Value - Value to be printed with exit msg
589 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
590 * set in DebugLevel. Prints exit value also.
592 ******************************************************************************/
597 const char *FunctionName,
603 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
604 LineNumber, FunctionName, ModuleName, ComponentId,
605 "%s %8.8X%8.8X\n", AcpiGbl_FnExitStr,
606 ACPI_FORMAT_UINT64 (Value));
608 AcpiGbl_NestingLevel--;
611 ACPI_EXPORT_SYMBOL (AcpiUtValueExit)
614 /*******************************************************************************
616 * FUNCTION: AcpiUtPtrExit
618 * PARAMETERS: LineNumber - Caller's line number
619 * FunctionName - Caller's procedure name
620 * ModuleName - Caller's module name
621 * ComponentId - Caller's component ID
622 * Ptr - Pointer to display
626 * DESCRIPTION: Function exit trace. Prints only if TRACE_FUNCTIONS bit is
627 * set in DebugLevel. Prints exit value also.
629 ******************************************************************************/
634 const char *FunctionName,
640 AcpiUtDebugPrint (ACPI_LV_FUNCTIONS,
641 LineNumber, FunctionName, ModuleName, ComponentId,
642 "%s %p\n", AcpiGbl_FnExitStr, Ptr);
644 AcpiGbl_NestingLevel--;
650 /*******************************************************************************
652 * FUNCTION: AcpiUtDumpBuffer
654 * PARAMETERS: Buffer - Buffer to dump
655 * Count - Amount to dump, in bytes
656 * Display - BYTE, WORD, DWORD, or QWORD display
657 * ComponentID - Caller's component ID
661 * DESCRIPTION: Generic dump buffer in both hex and ascii.
663 ******************************************************************************/
671 ACPI_NATIVE_UINT i = 0;
677 if ((Count < 4) || (Count & 0x01))
679 Display = DB_BYTE_DISPLAY;
682 /* Nasty little dump buffer routine! */
686 /* Print current offset */
688 AcpiOsPrintf ("%6.4X: ", (UINT32) i);
690 /* Print 16 hex chars */
696 /* Dump fill spaces */
698 AcpiOsPrintf ("%*s", ((Display * 2) + 1), " ");
699 j += (ACPI_NATIVE_UINT) Display;
705 case DB_BYTE_DISPLAY:
706 default: /* Default is BYTE display */
708 AcpiOsPrintf ("%02X ", Buffer[i + j]);
712 case DB_WORD_DISPLAY:
714 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[i + j]);
715 AcpiOsPrintf ("%04X ", Temp32);
719 case DB_DWORD_DISPLAY:
721 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[i + j]);
722 AcpiOsPrintf ("%08X ", Temp32);
726 case DB_QWORD_DISPLAY:
728 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[i + j]);
729 AcpiOsPrintf ("%08X", Temp32);
731 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[i + j + 4]);
732 AcpiOsPrintf ("%08X ", Temp32);
736 j += (ACPI_NATIVE_UINT) Display;
740 * Print the ASCII equivalent characters but watch out for the bad
741 * unprintable ones (printable chars are 0x20 through 0x7E)
744 for (j = 0; j < 16; j++)
752 BufChar = Buffer[i + j];
753 if (ACPI_IS_PRINT (BufChar))
755 AcpiOsPrintf ("%c", BufChar);
763 /* Done with that line. */
773 /*******************************************************************************
775 * FUNCTION: AcpiUtDumpBuffer
777 * PARAMETERS: Buffer - Buffer to dump
778 * Count - Amount to dump, in bytes
779 * Display - BYTE, WORD, DWORD, or QWORD display
780 * ComponentID - Caller's component ID
784 * DESCRIPTION: Generic dump buffer in both hex and ascii.
786 ******************************************************************************/
796 /* Only dump the buffer if tracing is enabled */
798 if (!((ACPI_LV_TABLES & AcpiDbgLevel) &&
799 (ComponentId & AcpiDbgLayer)))
804 AcpiUtDumpBuffer2 (Buffer, Count, Display);