Home | History | Annotate | Line # | Download | only in utilities
utdebug.c revision 1.2
      1  1.1  jruoho /******************************************************************************
      2  1.1  jruoho  *
      3  1.1  jruoho  * Module Name: utdebug - Debug print routines
      4  1.1  jruoho  *
      5  1.1  jruoho  *****************************************************************************/
      6  1.1  jruoho 
      7  1.1  jruoho /******************************************************************************
      8  1.1  jruoho  *
      9  1.1  jruoho  * 1. Copyright Notice
     10  1.1  jruoho  *
     11  1.1  jruoho  * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
     12  1.1  jruoho  * All rights reserved.
     13  1.1  jruoho  *
     14  1.1  jruoho  * 2. License
     15  1.1  jruoho  *
     16  1.1  jruoho  * 2.1. This is your license from Intel Corp. under its intellectual property
     17  1.1  jruoho  * rights.  You may have additional license terms from the party that provided
     18  1.1  jruoho  * you this software, covering your right to use that party's intellectual
     19  1.1  jruoho  * property rights.
     20  1.1  jruoho  *
     21  1.1  jruoho  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     22  1.1  jruoho  * copy of the source code appearing in this file ("Covered Code") an
     23  1.1  jruoho  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     24  1.1  jruoho  * base code distributed originally by Intel ("Original Intel Code") to copy,
     25  1.1  jruoho  * make derivatives, distribute, use and display any portion of the Covered
     26  1.1  jruoho  * Code in any form, with the right to sublicense such rights; and
     27  1.1  jruoho  *
     28  1.1  jruoho  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     29  1.1  jruoho  * license (with the right to sublicense), under only those claims of Intel
     30  1.1  jruoho  * patents that are infringed by the Original Intel Code, to make, use, sell,
     31  1.1  jruoho  * offer to sell, and import the Covered Code and derivative works thereof
     32  1.1  jruoho  * solely to the minimum extent necessary to exercise the above copyright
     33  1.1  jruoho  * license, and in no event shall the patent license extend to any additions
     34  1.1  jruoho  * to or modifications of the Original Intel Code.  No other license or right
     35  1.1  jruoho  * is granted directly or by implication, estoppel or otherwise;
     36  1.1  jruoho  *
     37  1.1  jruoho  * The above copyright and patent license is granted only if the following
     38  1.1  jruoho  * conditions are met:
     39  1.1  jruoho  *
     40  1.1  jruoho  * 3. Conditions
     41  1.1  jruoho  *
     42  1.1  jruoho  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     43  1.1  jruoho  * Redistribution of source code of any substantial portion of the Covered
     44  1.1  jruoho  * Code or modification with rights to further distribute source must include
     45  1.1  jruoho  * the above Copyright Notice, the above License, this list of Conditions,
     46  1.1  jruoho  * and the following Disclaimer and Export Compliance provision.  In addition,
     47  1.1  jruoho  * Licensee must cause all Covered Code to which Licensee contributes to
     48  1.1  jruoho  * contain a file documenting the changes Licensee made to create that Covered
     49  1.1  jruoho  * Code and the date of any change.  Licensee must include in that file the
     50  1.1  jruoho  * documentation of any changes made by any predecessor Licensee.  Licensee
     51  1.1  jruoho  * must include a prominent statement that the modification is derived,
     52  1.1  jruoho  * directly or indirectly, from Original Intel Code.
     53  1.1  jruoho  *
     54  1.1  jruoho  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     55  1.1  jruoho  * Redistribution of source code of any substantial portion of the Covered
     56  1.1  jruoho  * Code or modification without rights to further distribute source must
     57  1.1  jruoho  * include the following Disclaimer and Export Compliance provision in the
     58  1.1  jruoho  * documentation and/or other materials provided with distribution.  In
     59  1.1  jruoho  * addition, Licensee may not authorize further sublicense of source of any
     60  1.1  jruoho  * portion of the Covered Code, and must include terms to the effect that the
     61  1.1  jruoho  * license from Licensee to its licensee is limited to the intellectual
     62  1.1  jruoho  * property embodied in the software Licensee provides to its licensee, and
     63  1.1  jruoho  * not to intellectual property embodied in modifications its licensee may
     64  1.1  jruoho  * make.
     65  1.1  jruoho  *
     66  1.1  jruoho  * 3.3. Redistribution of Executable. Redistribution in executable form of any
     67  1.1  jruoho  * substantial portion of the Covered Code or modification must reproduce the
     68  1.1  jruoho  * above Copyright Notice, and the following Disclaimer and Export Compliance
     69  1.1  jruoho  * provision in the documentation and/or other materials provided with the
     70  1.1  jruoho  * distribution.
     71  1.1  jruoho  *
     72  1.1  jruoho  * 3.4. Intel retains all right, title, and interest in and to the Original
     73  1.1  jruoho  * Intel Code.
     74  1.1  jruoho  *
     75  1.1  jruoho  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     76  1.1  jruoho  * Intel shall be used in advertising or otherwise to promote the sale, use or
     77  1.1  jruoho  * other dealings in products derived from or relating to the Covered Code
     78  1.1  jruoho  * without prior written authorization from Intel.
     79  1.1  jruoho  *
     80  1.1  jruoho  * 4. Disclaimer and Export Compliance
     81  1.1  jruoho  *
     82  1.1  jruoho  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     83  1.1  jruoho  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     84  1.1  jruoho  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
     85  1.1  jruoho  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
     86  1.1  jruoho  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
     87  1.1  jruoho  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     88  1.1  jruoho  * PARTICULAR PURPOSE.
     89  1.1  jruoho  *
     90  1.1  jruoho  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     91  1.1  jruoho  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     92  1.1  jruoho  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     93  1.1  jruoho  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     94  1.1  jruoho  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     95  1.1  jruoho  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
     96  1.1  jruoho  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     97  1.1  jruoho  * LIMITED REMEDY.
     98  1.1  jruoho  *
     99  1.1  jruoho  * 4.3. Licensee shall not export, either directly or indirectly, any of this
    100  1.1  jruoho  * software or system incorporating such software without first obtaining any
    101  1.1  jruoho  * required license or other approval from the U. S. Department of Commerce or
    102  1.1  jruoho  * any other agency or department of the United States Government.  In the
    103  1.1  jruoho  * event Licensee exports any such software from the United States or
    104  1.1  jruoho  * re-exports any such software from a foreign destination, Licensee shall
    105  1.1  jruoho  * ensure that the distribution and export/re-export of the software is in
    106  1.1  jruoho  * compliance with all laws, regulations, orders, or other restrictions of the
    107  1.1  jruoho  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    108  1.1  jruoho  * any of its subsidiaries will export/re-export any technical data, process,
    109  1.1  jruoho  * software, or service, directly or indirectly, to any country for which the
    110  1.1  jruoho  * United States government or any agency thereof requires an export license,
    111  1.1  jruoho  * other governmental approval, or letter of assurance, without first obtaining
    112  1.1  jruoho  * such license, approval or letter.
    113  1.1  jruoho  *
    114  1.1  jruoho  *****************************************************************************/
    115  1.1  jruoho 
    116  1.1  jruoho #define __UTDEBUG_C__
    117  1.1  jruoho 
    118  1.1  jruoho #include "acpi.h"
    119  1.1  jruoho #include "accommon.h"
    120  1.1  jruoho 
    121  1.1  jruoho #define _COMPONENT          ACPI_UTILITIES
    122  1.1  jruoho         ACPI_MODULE_NAME    ("utdebug")
    123  1.1  jruoho 
    124  1.1  jruoho 
    125  1.1  jruoho #ifdef ACPI_DEBUG_OUTPUT
    126  1.1  jruoho 
    127  1.1  jruoho static ACPI_THREAD_ID       AcpiGbl_PrevThreadId = (ACPI_THREAD_ID) 0xFFFFFFFF;
    128  1.2  jruoho static const char           *AcpiGbl_FnEntryStr = "----Entry";
    129  1.2  jruoho static const char           *AcpiGbl_FnExitStr  = "----Exit-";
    130  1.1  jruoho 
    131  1.1  jruoho /* Local prototypes */
    132  1.1  jruoho 
    133  1.1  jruoho static const char *
    134  1.1  jruoho AcpiUtTrimFunctionName (
    135  1.1  jruoho     const char              *FunctionName);
    136  1.1  jruoho 
    137  1.1  jruoho 
    138  1.1  jruoho /*******************************************************************************
    139  1.1  jruoho  *
    140  1.1  jruoho  * FUNCTION:    AcpiUtInitStackPtrTrace
    141  1.1  jruoho  *
    142  1.1  jruoho  * PARAMETERS:  None
    143  1.1  jruoho  *
    144  1.1  jruoho  * RETURN:      None
    145  1.1  jruoho  *
    146  1.1  jruoho  * DESCRIPTION: Save the current CPU stack pointer at subsystem startup
    147  1.1  jruoho  *
    148  1.1  jruoho  ******************************************************************************/
    149  1.1  jruoho 
    150  1.1  jruoho void
    151  1.1  jruoho AcpiUtInitStackPtrTrace (
    152  1.1  jruoho     void)
    153  1.1  jruoho {
    154  1.1  jruoho     ACPI_SIZE               CurrentSp;
    155  1.1  jruoho 
    156  1.1  jruoho 
    157  1.1  jruoho     AcpiGbl_EntryStackPointer = &CurrentSp;
    158  1.1  jruoho }
    159  1.1  jruoho 
    160  1.1  jruoho 
    161  1.1  jruoho /*******************************************************************************
    162  1.1  jruoho  *
    163  1.1  jruoho  * FUNCTION:    AcpiUtTrackStackPtr
    164  1.1  jruoho  *
    165  1.1  jruoho  * PARAMETERS:  None
    166  1.1  jruoho  *
    167  1.1  jruoho  * RETURN:      None
    168  1.1  jruoho  *
    169  1.1  jruoho  * DESCRIPTION: Save the current CPU stack pointer
    170  1.1  jruoho  *
    171  1.1  jruoho  ******************************************************************************/
    172  1.1  jruoho 
    173  1.1  jruoho void
    174  1.1  jruoho AcpiUtTrackStackPtr (
    175  1.1  jruoho     void)
    176  1.1  jruoho {
    177  1.1  jruoho     ACPI_SIZE               CurrentSp;
    178  1.1  jruoho 
    179  1.1  jruoho 
    180  1.1  jruoho     if (&CurrentSp < AcpiGbl_LowestStackPointer)
    181  1.1  jruoho     {
    182  1.1  jruoho         AcpiGbl_LowestStackPointer = &CurrentSp;
    183  1.1  jruoho     }
    184  1.1  jruoho 
    185  1.1  jruoho     if (AcpiGbl_NestingLevel > AcpiGbl_DeepestNesting)
    186  1.1  jruoho     {
    187  1.1  jruoho         AcpiGbl_DeepestNesting = AcpiGbl_NestingLevel;
    188  1.1  jruoho     }
    189  1.1  jruoho }
    190  1.1  jruoho 
    191  1.1  jruoho 
    192  1.1  jruoho /*******************************************************************************
    193  1.1  jruoho  *
    194  1.1  jruoho  * FUNCTION:    AcpiUtTrimFunctionName
    195  1.1  jruoho  *
    196  1.1  jruoho  * PARAMETERS:  FunctionName        - Ascii string containing a procedure name
    197  1.1  jruoho  *
    198  1.1  jruoho  * RETURN:      Updated pointer to the function name
    199  1.1  jruoho  *
    200  1.1  jruoho  * DESCRIPTION: Remove the "Acpi" prefix from the function name, if present.
    201  1.1  jruoho  *              This allows compiler macros such as __FUNCTION__ to be used
    202  1.1  jruoho  *              with no change to the debug output.
    203  1.1  jruoho  *
    204  1.1  jruoho  ******************************************************************************/
    205  1.1  jruoho 
    206  1.1  jruoho static const char *
    207  1.1  jruoho AcpiUtTrimFunctionName (
    208  1.1  jruoho     const char              *FunctionName)
    209  1.1  jruoho {
    210  1.1  jruoho 
    211  1.1  jruoho     /* All Function names are longer than 4 chars, check is safe */
    212  1.1  jruoho 
    213  1.1  jruoho     if (*(ACPI_CAST_PTR (UINT32, FunctionName)) == ACPI_PREFIX_MIXED)
    214  1.1  jruoho     {
    215  1.1  jruoho         /* This is the case where the original source has not been modified */
    216  1.1  jruoho 
    217  1.1  jruoho         return (FunctionName + 4);
    218  1.1  jruoho     }
    219  1.1  jruoho 
    220  1.1  jruoho     if (*(ACPI_CAST_PTR (UINT32, FunctionName)) == ACPI_PREFIX_LOWER)
    221  1.1  jruoho     {
    222  1.1  jruoho         /* This is the case where the source has been 'linuxized' */
    223  1.1  jruoho 
    224  1.1  jruoho         return (FunctionName + 5);
    225  1.1  jruoho     }
    226  1.1  jruoho 
    227  1.1  jruoho     return (FunctionName);
    228  1.1  jruoho }
    229  1.1  jruoho 
    230  1.1  jruoho 
    231  1.1  jruoho /*******************************************************************************
    232  1.1  jruoho  *
    233  1.1  jruoho  * FUNCTION:    AcpiDebugPrint
    234  1.1  jruoho  *
    235  1.1  jruoho  * PARAMETERS:  RequestedDebugLevel - Requested debug print level
    236  1.1  jruoho  *              LineNumber          - Caller's line number (for error output)
    237  1.1  jruoho  *              FunctionName        - Caller's procedure name
    238  1.1  jruoho  *              ModuleName          - Caller's module name
    239  1.1  jruoho  *              ComponentId         - Caller's component ID
    240  1.1  jruoho  *              Format              - Printf format field
    241  1.1  jruoho  *              ...                 - Optional printf arguments
    242  1.1  jruoho  *
    243  1.1  jruoho  * RETURN:      None
    244  1.1  jruoho  *
    245  1.1  jruoho  * DESCRIPTION: Print error message with prefix consisting of the module name,
    246  1.1  jruoho  *              line number, and component ID.
    247  1.1  jruoho  *
    248  1.1  jruoho  ******************************************************************************/
    249  1.1  jruoho 
    250  1.1  jruoho void  ACPI_INTERNAL_VAR_XFACE
    251  1.1  jruoho AcpiDebugPrint (
    252  1.1  jruoho     UINT32                  RequestedDebugLevel,
    253  1.1  jruoho     UINT32                  LineNumber,
    254  1.1  jruoho     const char              *FunctionName,
    255  1.1  jruoho     const char              *ModuleName,
    256  1.1  jruoho     UINT32                  ComponentId,
    257  1.1  jruoho     const char              *Format,
    258  1.1  jruoho     ...)
    259  1.1  jruoho {
    260  1.1  jruoho     ACPI_THREAD_ID          ThreadId;
    261  1.1  jruoho     va_list                 args;
    262  1.1  jruoho 
    263  1.1  jruoho 
    264  1.1  jruoho     /*
    265  1.1  jruoho      * Stay silent if the debug level or component ID is disabled
    266  1.1  jruoho      */
    267  1.1  jruoho     if (!(RequestedDebugLevel & AcpiDbgLevel) ||
    268  1.1  jruoho         !(ComponentId & AcpiDbgLayer))
    269  1.1  jruoho     {
    270  1.1  jruoho         return;
    271  1.1  jruoho     }
    272  1.1  jruoho 
    273  1.1  jruoho     /*
    274  1.1  jruoho      * Thread tracking and context switch notification
    275  1.1  jruoho      */
    276  1.1  jruoho     ThreadId = AcpiOsGetThreadId ();
    277  1.1  jruoho     if (ThreadId != AcpiGbl_PrevThreadId)
    278  1.1  jruoho     {
    279  1.1  jruoho         if (ACPI_LV_THREADS & AcpiDbgLevel)
    280  1.1  jruoho         {
    281  1.1  jruoho             AcpiOsPrintf (
    282  1.1  jruoho                 "\n**** Context Switch from TID %p to TID %p ****\n\n",
    283  1.1  jruoho                 ACPI_CAST_PTR (void, AcpiGbl_PrevThreadId),
    284  1.1  jruoho                 ACPI_CAST_PTR (void, ThreadId));
    285  1.1  jruoho         }
    286  1.1  jruoho 
    287  1.1  jruoho         AcpiGbl_PrevThreadId = ThreadId;
    288  1.1  jruoho     }
    289  1.1  jruoho 
    290  1.1  jruoho     /*
    291  1.1  jruoho      * Display the module name, current line number, thread ID (if requested),
    292  1.1  jruoho      * current procedure nesting level, and the current procedure name
    293  1.1  jruoho      */
    294  1.1  jruoho     AcpiOsPrintf ("%8s-%04ld ", ModuleName, LineNumber);
    295  1.1  jruoho 
    296  1.1  jruoho     if (ACPI_LV_THREADS & AcpiDbgLevel)
    297  1.1  jruoho     {
    298  1.1  jruoho         AcpiOsPrintf ("[%p] ", ACPI_CAST_PTR (void, ThreadId));
    299  1.1  jruoho     }
    300  1.1  jruoho 
    301  1.1  jruoho     AcpiOsPrintf ("[%02ld] %-22.22s: ",
    302  1.1  jruoho         AcpiGbl_NestingLevel, AcpiUtTrimFunctionName (FunctionName));
    303  1.1  jruoho 
    304  1.1  jruoho     va_start (args, Format);
    305  1.1  jruoho     AcpiOsVprintf (Format, args);
    306  1.1  jruoho     va_end (args);
    307  1.1  jruoho }
    308  1.1  jruoho 
    309  1.1  jruoho ACPI_EXPORT_SYMBOL (AcpiDebugPrint)
    310  1.1  jruoho 
    311  1.1  jruoho 
    312  1.1  jruoho /*******************************************************************************
    313  1.1  jruoho  *
    314  1.1  jruoho  * FUNCTION:    AcpiDebugPrintRaw
    315  1.1  jruoho  *
    316  1.1  jruoho  * PARAMETERS:  RequestedDebugLevel - Requested debug print level
    317  1.1  jruoho  *              LineNumber          - Caller's line number
    318  1.1  jruoho  *              FunctionName        - Caller's procedure name
    319  1.1  jruoho  *              ModuleName          - Caller's module name
    320  1.1  jruoho  *              ComponentId         - Caller's component ID
    321  1.1  jruoho  *              Format              - Printf format field
    322  1.1  jruoho  *              ...                 - Optional printf arguments
    323  1.1  jruoho  *
    324  1.1  jruoho  * RETURN:      None
    325  1.1  jruoho  *
    326  1.1  jruoho  * DESCRIPTION: Print message with no headers.  Has same interface as
    327  1.1  jruoho  *              DebugPrint so that the same macros can be used.
    328  1.1  jruoho  *
    329  1.1  jruoho  ******************************************************************************/
    330  1.1  jruoho 
    331  1.1  jruoho void  ACPI_INTERNAL_VAR_XFACE
    332  1.1  jruoho AcpiDebugPrintRaw (
    333  1.1  jruoho     UINT32                  RequestedDebugLevel,
    334  1.1  jruoho     UINT32                  LineNumber,
    335  1.1  jruoho     const char              *FunctionName,
    336  1.1  jruoho     const char              *ModuleName,
    337  1.1  jruoho     UINT32                  ComponentId,
    338  1.1  jruoho     const char              *Format,
    339  1.1  jruoho     ...)
    340  1.1  jruoho {
    341  1.1  jruoho     va_list                 args;
    342  1.1  jruoho 
    343  1.1  jruoho 
    344  1.1  jruoho     if (!(RequestedDebugLevel & AcpiDbgLevel) ||
    345  1.1  jruoho         !(ComponentId & AcpiDbgLayer))
    346  1.1  jruoho     {
    347  1.1  jruoho         return;
    348  1.1  jruoho     }
    349  1.1  jruoho 
    350  1.1  jruoho     va_start (args, Format);
    351  1.1  jruoho     AcpiOsVprintf (Format, args);
    352  1.1  jruoho     va_end (args);
    353  1.1  jruoho }
    354  1.1  jruoho 
    355  1.1  jruoho ACPI_EXPORT_SYMBOL (AcpiDebugPrintRaw)
    356  1.1  jruoho 
    357  1.1  jruoho 
    358  1.1  jruoho /*******************************************************************************
    359  1.1  jruoho  *
    360  1.1  jruoho  * FUNCTION:    AcpiUtTrace
    361  1.1  jruoho  *
    362  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    363  1.1  jruoho  *              FunctionName        - Caller's procedure name
    364  1.1  jruoho  *              ModuleName          - Caller's module name
    365  1.1  jruoho  *              ComponentId         - Caller's component ID
    366  1.1  jruoho  *
    367  1.1  jruoho  * RETURN:      None
    368  1.1  jruoho  *
    369  1.1  jruoho  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
    370  1.1  jruoho  *              set in DebugLevel
    371  1.1  jruoho  *
    372  1.1  jruoho  ******************************************************************************/
    373  1.1  jruoho 
    374  1.1  jruoho void
    375  1.1  jruoho AcpiUtTrace (
    376  1.1  jruoho     UINT32                  LineNumber,
    377  1.1  jruoho     const char              *FunctionName,
    378  1.1  jruoho     const char              *ModuleName,
    379  1.1  jruoho     UINT32                  ComponentId)
    380  1.1  jruoho {
    381  1.1  jruoho 
    382  1.1  jruoho     AcpiGbl_NestingLevel++;
    383  1.1  jruoho     AcpiUtTrackStackPtr ();
    384  1.1  jruoho 
    385  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    386  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    387  1.1  jruoho         "%s\n", AcpiGbl_FnEntryStr);
    388  1.1  jruoho }
    389  1.1  jruoho 
    390  1.1  jruoho ACPI_EXPORT_SYMBOL (AcpiUtTrace)
    391  1.1  jruoho 
    392  1.1  jruoho 
    393  1.1  jruoho /*******************************************************************************
    394  1.1  jruoho  *
    395  1.1  jruoho  * FUNCTION:    AcpiUtTracePtr
    396  1.1  jruoho  *
    397  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    398  1.1  jruoho  *              FunctionName        - Caller's procedure name
    399  1.1  jruoho  *              ModuleName          - Caller's module name
    400  1.1  jruoho  *              ComponentId         - Caller's component ID
    401  1.1  jruoho  *              Pointer             - Pointer to display
    402  1.1  jruoho  *
    403  1.1  jruoho  * RETURN:      None
    404  1.1  jruoho  *
    405  1.1  jruoho  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
    406  1.1  jruoho  *              set in DebugLevel
    407  1.1  jruoho  *
    408  1.1  jruoho  ******************************************************************************/
    409  1.1  jruoho 
    410  1.1  jruoho void
    411  1.1  jruoho AcpiUtTracePtr (
    412  1.1  jruoho     UINT32                  LineNumber,
    413  1.1  jruoho     const char              *FunctionName,
    414  1.1  jruoho     const char              *ModuleName,
    415  1.1  jruoho     UINT32                  ComponentId,
    416  1.1  jruoho     void                    *Pointer)
    417  1.1  jruoho {
    418  1.1  jruoho     AcpiGbl_NestingLevel++;
    419  1.1  jruoho     AcpiUtTrackStackPtr ();
    420  1.1  jruoho 
    421  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    422  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    423  1.1  jruoho         "%s %p\n", AcpiGbl_FnEntryStr, Pointer);
    424  1.1  jruoho }
    425  1.1  jruoho 
    426  1.1  jruoho 
    427  1.1  jruoho /*******************************************************************************
    428  1.1  jruoho  *
    429  1.1  jruoho  * FUNCTION:    AcpiUtTraceStr
    430  1.1  jruoho  *
    431  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    432  1.1  jruoho  *              FunctionName        - Caller's procedure name
    433  1.1  jruoho  *              ModuleName          - Caller's module name
    434  1.1  jruoho  *              ComponentId         - Caller's component ID
    435  1.1  jruoho  *              String              - Additional string to display
    436  1.1  jruoho  *
    437  1.1  jruoho  * RETURN:      None
    438  1.1  jruoho  *
    439  1.1  jruoho  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
    440  1.1  jruoho  *              set in DebugLevel
    441  1.1  jruoho  *
    442  1.1  jruoho  ******************************************************************************/
    443  1.1  jruoho 
    444  1.1  jruoho void
    445  1.1  jruoho AcpiUtTraceStr (
    446  1.1  jruoho     UINT32                  LineNumber,
    447  1.1  jruoho     const char              *FunctionName,
    448  1.1  jruoho     const char              *ModuleName,
    449  1.1  jruoho     UINT32                  ComponentId,
    450  1.1  jruoho     char                    *String)
    451  1.1  jruoho {
    452  1.1  jruoho 
    453  1.1  jruoho     AcpiGbl_NestingLevel++;
    454  1.1  jruoho     AcpiUtTrackStackPtr ();
    455  1.1  jruoho 
    456  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    457  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    458  1.1  jruoho         "%s %s\n", AcpiGbl_FnEntryStr, String);
    459  1.1  jruoho }
    460  1.1  jruoho 
    461  1.1  jruoho 
    462  1.1  jruoho /*******************************************************************************
    463  1.1  jruoho  *
    464  1.1  jruoho  * FUNCTION:    AcpiUtTraceU32
    465  1.1  jruoho  *
    466  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    467  1.1  jruoho  *              FunctionName        - Caller's procedure name
    468  1.1  jruoho  *              ModuleName          - Caller's module name
    469  1.1  jruoho  *              ComponentId         - Caller's component ID
    470  1.1  jruoho  *              Integer             - Integer to display
    471  1.1  jruoho  *
    472  1.1  jruoho  * RETURN:      None
    473  1.1  jruoho  *
    474  1.1  jruoho  * DESCRIPTION: Function entry trace.  Prints only if TRACE_FUNCTIONS bit is
    475  1.1  jruoho  *              set in DebugLevel
    476  1.1  jruoho  *
    477  1.1  jruoho  ******************************************************************************/
    478  1.1  jruoho 
    479  1.1  jruoho void
    480  1.1  jruoho AcpiUtTraceU32 (
    481  1.1  jruoho     UINT32                  LineNumber,
    482  1.1  jruoho     const char              *FunctionName,
    483  1.1  jruoho     const char              *ModuleName,
    484  1.1  jruoho     UINT32                  ComponentId,
    485  1.1  jruoho     UINT32                  Integer)
    486  1.1  jruoho {
    487  1.1  jruoho 
    488  1.1  jruoho     AcpiGbl_NestingLevel++;
    489  1.1  jruoho     AcpiUtTrackStackPtr ();
    490  1.1  jruoho 
    491  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    492  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    493  1.1  jruoho         "%s %08X\n", AcpiGbl_FnEntryStr, Integer);
    494  1.1  jruoho }
    495  1.1  jruoho 
    496  1.1  jruoho 
    497  1.1  jruoho /*******************************************************************************
    498  1.1  jruoho  *
    499  1.1  jruoho  * FUNCTION:    AcpiUtExit
    500  1.1  jruoho  *
    501  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    502  1.1  jruoho  *              FunctionName        - Caller's procedure name
    503  1.1  jruoho  *              ModuleName          - Caller's module name
    504  1.1  jruoho  *              ComponentId         - Caller's component ID
    505  1.1  jruoho  *
    506  1.1  jruoho  * RETURN:      None
    507  1.1  jruoho  *
    508  1.1  jruoho  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
    509  1.1  jruoho  *              set in DebugLevel
    510  1.1  jruoho  *
    511  1.1  jruoho  ******************************************************************************/
    512  1.1  jruoho 
    513  1.1  jruoho void
    514  1.1  jruoho AcpiUtExit (
    515  1.1  jruoho     UINT32                  LineNumber,
    516  1.1  jruoho     const char              *FunctionName,
    517  1.1  jruoho     const char              *ModuleName,
    518  1.1  jruoho     UINT32                  ComponentId)
    519  1.1  jruoho {
    520  1.1  jruoho 
    521  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    522  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    523  1.1  jruoho         "%s\n", AcpiGbl_FnExitStr);
    524  1.1  jruoho 
    525  1.1  jruoho     AcpiGbl_NestingLevel--;
    526  1.1  jruoho }
    527  1.1  jruoho 
    528  1.1  jruoho ACPI_EXPORT_SYMBOL (AcpiUtExit)
    529  1.1  jruoho 
    530  1.1  jruoho 
    531  1.1  jruoho /*******************************************************************************
    532  1.1  jruoho  *
    533  1.1  jruoho  * FUNCTION:    AcpiUtStatusExit
    534  1.1  jruoho  *
    535  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    536  1.1  jruoho  *              FunctionName        - Caller's procedure name
    537  1.1  jruoho  *              ModuleName          - Caller's module name
    538  1.1  jruoho  *              ComponentId         - Caller's component ID
    539  1.1  jruoho  *              Status              - Exit status code
    540  1.1  jruoho  *
    541  1.1  jruoho  * RETURN:      None
    542  1.1  jruoho  *
    543  1.1  jruoho  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
    544  1.1  jruoho  *              set in DebugLevel.  Prints exit status also.
    545  1.1  jruoho  *
    546  1.1  jruoho  ******************************************************************************/
    547  1.1  jruoho 
    548  1.1  jruoho void
    549  1.1  jruoho AcpiUtStatusExit (
    550  1.1  jruoho     UINT32                  LineNumber,
    551  1.1  jruoho     const char              *FunctionName,
    552  1.1  jruoho     const char              *ModuleName,
    553  1.1  jruoho     UINT32                  ComponentId,
    554  1.1  jruoho     ACPI_STATUS             Status)
    555  1.1  jruoho {
    556  1.1  jruoho 
    557  1.1  jruoho     if (ACPI_SUCCESS (Status))
    558  1.1  jruoho     {
    559  1.1  jruoho         AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    560  1.1  jruoho             LineNumber, FunctionName, ModuleName, ComponentId,
    561  1.1  jruoho             "%s %s\n", AcpiGbl_FnExitStr,
    562  1.1  jruoho             AcpiFormatException (Status));
    563  1.1  jruoho     }
    564  1.1  jruoho     else
    565  1.1  jruoho     {
    566  1.1  jruoho         AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    567  1.1  jruoho             LineNumber, FunctionName, ModuleName, ComponentId,
    568  1.1  jruoho             "%s ****Exception****: %s\n", AcpiGbl_FnExitStr,
    569  1.1  jruoho             AcpiFormatException (Status));
    570  1.1  jruoho     }
    571  1.1  jruoho 
    572  1.1  jruoho     AcpiGbl_NestingLevel--;
    573  1.1  jruoho }
    574  1.1  jruoho 
    575  1.1  jruoho ACPI_EXPORT_SYMBOL (AcpiUtStatusExit)
    576  1.1  jruoho 
    577  1.1  jruoho 
    578  1.1  jruoho /*******************************************************************************
    579  1.1  jruoho  *
    580  1.1  jruoho  * FUNCTION:    AcpiUtValueExit
    581  1.1  jruoho  *
    582  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    583  1.1  jruoho  *              FunctionName        - Caller's procedure name
    584  1.1  jruoho  *              ModuleName          - Caller's module name
    585  1.1  jruoho  *              ComponentId         - Caller's component ID
    586  1.1  jruoho  *              Value               - Value to be printed with exit msg
    587  1.1  jruoho  *
    588  1.1  jruoho  * RETURN:      None
    589  1.1  jruoho  *
    590  1.1  jruoho  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
    591  1.1  jruoho  *              set in DebugLevel.  Prints exit value also.
    592  1.1  jruoho  *
    593  1.1  jruoho  ******************************************************************************/
    594  1.1  jruoho 
    595  1.1  jruoho void
    596  1.1  jruoho AcpiUtValueExit (
    597  1.1  jruoho     UINT32                  LineNumber,
    598  1.1  jruoho     const char              *FunctionName,
    599  1.1  jruoho     const char              *ModuleName,
    600  1.1  jruoho     UINT32                  ComponentId,
    601  1.1  jruoho     UINT64                  Value)
    602  1.1  jruoho {
    603  1.1  jruoho 
    604  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    605  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    606  1.1  jruoho         "%s %8.8X%8.8X\n", AcpiGbl_FnExitStr,
    607  1.1  jruoho         ACPI_FORMAT_UINT64 (Value));
    608  1.1  jruoho 
    609  1.1  jruoho     AcpiGbl_NestingLevel--;
    610  1.1  jruoho }
    611  1.1  jruoho 
    612  1.1  jruoho ACPI_EXPORT_SYMBOL (AcpiUtValueExit)
    613  1.1  jruoho 
    614  1.1  jruoho 
    615  1.1  jruoho /*******************************************************************************
    616  1.1  jruoho  *
    617  1.1  jruoho  * FUNCTION:    AcpiUtPtrExit
    618  1.1  jruoho  *
    619  1.1  jruoho  * PARAMETERS:  LineNumber          - Caller's line number
    620  1.1  jruoho  *              FunctionName        - Caller's procedure name
    621  1.1  jruoho  *              ModuleName          - Caller's module name
    622  1.1  jruoho  *              ComponentId         - Caller's component ID
    623  1.1  jruoho  *              Ptr                 - Pointer to display
    624  1.1  jruoho  *
    625  1.1  jruoho  * RETURN:      None
    626  1.1  jruoho  *
    627  1.1  jruoho  * DESCRIPTION: Function exit trace.  Prints only if TRACE_FUNCTIONS bit is
    628  1.1  jruoho  *              set in DebugLevel.  Prints exit value also.
    629  1.1  jruoho  *
    630  1.1  jruoho  ******************************************************************************/
    631  1.1  jruoho 
    632  1.1  jruoho void
    633  1.1  jruoho AcpiUtPtrExit (
    634  1.1  jruoho     UINT32                  LineNumber,
    635  1.1  jruoho     const char              *FunctionName,
    636  1.1  jruoho     const char              *ModuleName,
    637  1.1  jruoho     UINT32                  ComponentId,
    638  1.1  jruoho     UINT8                   *Ptr)
    639  1.1  jruoho {
    640  1.1  jruoho 
    641  1.1  jruoho     AcpiDebugPrint (ACPI_LV_FUNCTIONS,
    642  1.1  jruoho         LineNumber, FunctionName, ModuleName, ComponentId,
    643  1.1  jruoho         "%s %p\n", AcpiGbl_FnExitStr, Ptr);
    644  1.1  jruoho 
    645  1.1  jruoho     AcpiGbl_NestingLevel--;
    646  1.1  jruoho }
    647  1.1  jruoho 
    648  1.1  jruoho #endif
    649  1.1  jruoho 
    650  1.1  jruoho 
    651  1.1  jruoho /*******************************************************************************
    652  1.1  jruoho  *
    653  1.1  jruoho  * FUNCTION:    AcpiUtDumpBuffer
    654  1.1  jruoho  *
    655  1.1  jruoho  * PARAMETERS:  Buffer              - Buffer to dump
    656  1.1  jruoho  *              Count               - Amount to dump, in bytes
    657  1.1  jruoho  *              Display             - BYTE, WORD, DWORD, or QWORD display
    658  1.1  jruoho  *              ComponentID         - Caller's component ID
    659  1.1  jruoho  *
    660  1.1  jruoho  * RETURN:      None
    661  1.1  jruoho  *
    662  1.1  jruoho  * DESCRIPTION: Generic dump buffer in both hex and ascii.
    663  1.1  jruoho  *
    664  1.1  jruoho  ******************************************************************************/
    665  1.1  jruoho 
    666  1.1  jruoho void
    667  1.1  jruoho AcpiUtDumpBuffer2 (
    668  1.1  jruoho     UINT8                   *Buffer,
    669  1.1  jruoho     UINT32                  Count,
    670  1.1  jruoho     UINT32                  Display)
    671  1.1  jruoho {
    672  1.1  jruoho     UINT32                  i = 0;
    673  1.1  jruoho     UINT32                  j;
    674  1.1  jruoho     UINT32                  Temp32;
    675  1.1  jruoho     UINT8                   BufChar;
    676  1.1  jruoho 
    677  1.1  jruoho 
    678  1.1  jruoho     if (!Buffer)
    679  1.1  jruoho     {
    680  1.1  jruoho         AcpiOsPrintf ("Null Buffer Pointer in DumpBuffer!\n");
    681  1.1  jruoho         return;
    682  1.1  jruoho     }
    683  1.1  jruoho 
    684  1.1  jruoho     if ((Count < 4) || (Count & 0x01))
    685  1.1  jruoho     {
    686  1.1  jruoho         Display = DB_BYTE_DISPLAY;
    687  1.1  jruoho     }
    688  1.1  jruoho 
    689  1.1  jruoho     /* Nasty little dump buffer routine! */
    690  1.1  jruoho 
    691  1.1  jruoho     while (i < Count)
    692  1.1  jruoho     {
    693  1.1  jruoho         /* Print current offset */
    694  1.1  jruoho 
    695  1.1  jruoho         AcpiOsPrintf ("%6.4X: ", i);
    696  1.1  jruoho 
    697  1.1  jruoho         /* Print 16 hex chars */
    698  1.1  jruoho 
    699  1.1  jruoho         for (j = 0; j < 16;)
    700  1.1  jruoho         {
    701  1.1  jruoho             if (i + j >= Count)
    702  1.1  jruoho             {
    703  1.1  jruoho                 /* Dump fill spaces */
    704  1.1  jruoho 
    705  1.1  jruoho                 AcpiOsPrintf ("%*s", ((Display * 2) + 1), " ");
    706  1.1  jruoho                 j += Display;
    707  1.1  jruoho                 continue;
    708  1.1  jruoho             }
    709  1.1  jruoho 
    710  1.1  jruoho             switch (Display)
    711  1.1  jruoho             {
    712  1.1  jruoho             case DB_BYTE_DISPLAY:
    713  1.1  jruoho             default:    /* Default is BYTE display */
    714  1.1  jruoho 
    715  1.1  jruoho                 AcpiOsPrintf ("%02X ", Buffer[(ACPI_SIZE) i + j]);
    716  1.1  jruoho                 break;
    717  1.1  jruoho 
    718  1.1  jruoho 
    719  1.1  jruoho             case DB_WORD_DISPLAY:
    720  1.1  jruoho 
    721  1.1  jruoho                 ACPI_MOVE_16_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
    722  1.1  jruoho                 AcpiOsPrintf ("%04X ", Temp32);
    723  1.1  jruoho                 break;
    724  1.1  jruoho 
    725  1.1  jruoho 
    726  1.1  jruoho             case DB_DWORD_DISPLAY:
    727  1.1  jruoho 
    728  1.1  jruoho                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
    729  1.1  jruoho                 AcpiOsPrintf ("%08X ", Temp32);
    730  1.1  jruoho                 break;
    731  1.1  jruoho 
    732  1.1  jruoho 
    733  1.1  jruoho             case DB_QWORD_DISPLAY:
    734  1.1  jruoho 
    735  1.1  jruoho                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j]);
    736  1.1  jruoho                 AcpiOsPrintf ("%08X", Temp32);
    737  1.1  jruoho 
    738  1.1  jruoho                 ACPI_MOVE_32_TO_32 (&Temp32, &Buffer[(ACPI_SIZE) i + j + 4]);
    739  1.1  jruoho                 AcpiOsPrintf ("%08X ", Temp32);
    740  1.1  jruoho                 break;
    741  1.1  jruoho             }
    742  1.1  jruoho 
    743  1.1  jruoho             j += Display;
    744  1.1  jruoho         }
    745  1.1  jruoho 
    746  1.1  jruoho         /*
    747  1.1  jruoho          * Print the ASCII equivalent characters but watch out for the bad
    748  1.1  jruoho          * unprintable ones (printable chars are 0x20 through 0x7E)
    749  1.1  jruoho          */
    750  1.1  jruoho         AcpiOsPrintf (" ");
    751  1.1  jruoho         for (j = 0; j < 16; j++)
    752  1.1  jruoho         {
    753  1.1  jruoho             if (i + j >= Count)
    754  1.1  jruoho             {
    755  1.1  jruoho                 AcpiOsPrintf ("\n");
    756  1.1  jruoho                 return;
    757  1.1  jruoho             }
    758  1.1  jruoho 
    759  1.1  jruoho             BufChar = Buffer[(ACPI_SIZE) i + j];
    760  1.1  jruoho             if (ACPI_IS_PRINT (BufChar))
    761  1.1  jruoho             {
    762  1.1  jruoho                 AcpiOsPrintf ("%c", BufChar);
    763  1.1  jruoho             }
    764  1.1  jruoho             else
    765  1.1  jruoho             {
    766  1.1  jruoho                 AcpiOsPrintf (".");
    767  1.1  jruoho             }
    768  1.1  jruoho         }
    769  1.1  jruoho 
    770  1.1  jruoho         /* Done with that line. */
    771  1.1  jruoho 
    772  1.1  jruoho         AcpiOsPrintf ("\n");
    773  1.1  jruoho         i += 16;
    774  1.1  jruoho     }
    775  1.1  jruoho 
    776  1.1  jruoho     return;
    777  1.1  jruoho }
    778  1.1  jruoho 
    779  1.1  jruoho 
    780  1.1  jruoho /*******************************************************************************
    781  1.1  jruoho  *
    782  1.1  jruoho  * FUNCTION:    AcpiUtDumpBuffer
    783  1.1  jruoho  *
    784  1.1  jruoho  * PARAMETERS:  Buffer              - Buffer to dump
    785  1.1  jruoho  *              Count               - Amount to dump, in bytes
    786  1.1  jruoho  *              Display             - BYTE, WORD, DWORD, or QWORD display
    787  1.1  jruoho  *              ComponentID         - Caller's component ID
    788  1.1  jruoho  *
    789  1.1  jruoho  * RETURN:      None
    790  1.1  jruoho  *
    791  1.1  jruoho  * DESCRIPTION: Generic dump buffer in both hex and ascii.
    792  1.1  jruoho  *
    793  1.1  jruoho  ******************************************************************************/
    794  1.1  jruoho 
    795  1.1  jruoho void
    796  1.1  jruoho AcpiUtDumpBuffer (
    797  1.1  jruoho     UINT8                   *Buffer,
    798  1.1  jruoho     UINT32                  Count,
    799  1.1  jruoho     UINT32                  Display,
    800  1.1  jruoho     UINT32                  ComponentId)
    801  1.1  jruoho {
    802  1.1  jruoho 
    803  1.1  jruoho     /* Only dump the buffer if tracing is enabled */
    804  1.1  jruoho 
    805  1.1  jruoho     if (!((ACPI_LV_TABLES & AcpiDbgLevel) &&
    806  1.1  jruoho         (ComponentId & AcpiDbgLayer)))
    807  1.1  jruoho     {
    808  1.1  jruoho         return;
    809  1.1  jruoho     }
    810  1.1  jruoho 
    811  1.1  jruoho     AcpiUtDumpBuffer2 (Buffer, Count, Display);
    812  1.1  jruoho }
    813  1.1  jruoho 
    814  1.1  jruoho 
    815