path: root/Library/Debug.c

//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (C)Copyright 1985-2009, American Megatrends, Inc.            **
//**                                                                     **
//**                       All Rights Reserved.                          **
//**                                                                     **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093           **
//**                                                                     **
//**                       Phone: (770)-246-8600                         **
//**                                                                     **
//*************************************************************************
//*************************************************************************

//*************************************************************************
// $Header: /Alaska/SOURCE/Core/Library/Debug.c 10    7/30/09 4:39p Vyacheslava $
//
// $Revision: 10 $
//
// $Date: 7/30/09 4:39p $
//*************************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Core/Library/Debug.c $
// 
// 10    7/30/09 4:39p Vyacheslava
// Minor bug fix. EIP#24453: Synopsis: CPU exception when printing long
// debug messages.
// 
// 9     7/28/09 4:54p Vyacheslava
//  Bug fix. EIP#24453: Synopsis: CPU exception when printing long
// debug messages.
// 
// 8     7/10/09 3:49p Felixp
// Function headers added
// 
// 7     8/24/06 9:26a Felixp
// Preliminary x64 support (work in progress):
// 1. Processor architecture specific functions moved to a processor
// library
// 2. Makefile removed (AmiLib files are build by the AmiPeiLib and
// AmeDxeLib makefile)
// 3. Tokens.c added
// 
// 6     3/13/06 1:49a Felixp
// 
// 5     3/04/05 10:50a Mandal
// 
// 4     1/19/05 5:03p Felixp
// 
// 2     1/18/05 3:22p Felixp
// PrintDebugMessage renamed to Trace
// 
// 1     12/23/04 9:41a Felixp
// 
// 5     11/24/04 9:36a Felixp
// GetCpuTimer added
// 
// 4     10/22/04 8:01p Felixp
// 
// 3     10/22/04 7:42p Felixp
// 
// 2     7/13/04 10:42a Felixp
// 
// 1     7/12/04 6:31p Felixp
// 
//*************************************************************************
//<AMI_FHDR_START>
//
// Name: Debug.c
//
// Description:
//  Contains generic debug library functions.
//
//<AMI_FHDR_END>
//*************************************************************************
#include <AmiLib.h>
#include <StatusCodes.h>

//*************************************************************************
//<AMI_GHDR_START>
//
// Name: Debug_Functions
//
// Description:
//  Debug related functions defined in the AMI library.
//
// Fields: Header Function Description
// ------------------------------------------------------------------
// AmiPeiLib PEI_TRACE         Macro which creates a serial debug message in PEI.
// AmiDxeLib TRACE             Macro which creates a serial debug message in DXE.
// AmiDxeLib PROGRESS_CODE     Macro to report boot progress information in DXE.
// AmiPeiLib PEI_PROGRESS_CODE Macro report boot progress information in PEI.
// AmiDxeLib ERROR_CODE        Macro to report error condition in DXE.
// AmiPeiLib PEI_ERROR_CODE    Macro to report error condition in PEI.
// AmiLib    checkpoint        Send a checkpoint to port 0x80.  Use PROGRESS_CODE or PEI_PROGRESS_CODE if possible.
//
// Notes:
//  Header details which header file contains the function prototype for
// the above functions.  Append .h to the given name.
//   
//<AMI_GHDR_END>
//*************************************************************************

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: PROGRESS_CODE
//
// Description:	
//  PROGRESS_CODE(Code) is a macro which reports progress code
//    using UEFI ReportStatusCode API.
//
// Input:
//  Code - progress code value. 
//    Standard values are defined in AmiStatusCodes.h
//
// Output:
//  VOID.
//
//<AMI_PHDR_END>
//*************************************************************************

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: PEI_PROGRESS_CODE
//
// Description:	
//  PEI_PROGRESS_CODE(PeiServices, Code) is a macro which reports progress code
//    using (*PeiServices)->ReportStatusCode
//
// Input:
//  PeiServices - Double pointer to PEI Services Table.    
//  Code - progress code value. 
//    Standard values are defined in AmiStatusCodes.h
// 
// Output:
//  VOID.
//
//<AMI_PHDR_END>
//*************************************************************************

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: PEI_TRACE
//
// Description:	
//  PEI_TRACE(Arguments) is a macro which creates a serial debug message in
// PEI if the DEBUG_MODE SDL token is enabled by invoking the PeiTrace
// function with the provided arguments.  If DEBUG_MODE is off, nothing is
// generated.  See notes for an example usage.
//
// Input:
//  Arguments
// A bracket enclosed list including the following input parameters for
// PeiTrace (in order from left to right).
//
//  IN UINTN Level
// The error level of the debug message.
//
//  IN EFI_PEI_SERVICES **ppPS
// Double pointer to PEI Services Table.
//
//  IN CHAR8 *sFormat
// Format string for the debug message to print.
//
//  IN ...
// Additional parameters utilized by the format string.
//
// Output:
//  VOID.
//
// Modified:
//
// Referrals:
//  PeiTrace
//  Sprintf
// 
// Notes:
//  See Sprintf for a detailed description of the format string parameters.
// Example usage:
//
// PEI_TRACE((TRACE_ALWAYS, PeiServices, "This is a test message.  Status
// is %r.\n", Status));
//          
//<AMI_PHDR_END>
//*************************************************************************

//*************************************************************************
//<AMI_PHDR_START>
//
// Name: TRACE
//
// Description:
//  TRACE(Arguments) is a macro which creates a serial debug message in DXE
// if the DEBUG_MODE SDL token is enabled by invoking the Trace function with
// the provided arguments.  If DEBUG_MODE is off, nothing is generated.  See
// notes for an example usage.
//
// Input:
//  Arguments
// A bracket enclosed list including the following input parameters for
// Trace (in order from left to right).
//
//  IN UINTN Level
// The error level of the debug message. 
//
//  IN CHAR8 *sFormat
// Format string for the debug message to print.
//
//  IN ...
// Argument list for the format string.
//
// Output:
//  VOID.
//
// Modified:
//
// Referrals:
//  Trace
//  Sprintf
// 
// Notes:
//  See Sprintf for a detailed description of the format string parameters.
// Example usage:
//
// TRACE((TRACE_ALWAYS, "This is a test message.  Status is %r.\n", Status));
//          
//<AMI_PHDR_END>
//*************************************************************************

//*************************************************************************
//
// Name: PrepareStatusCodeString
//
// Description: Produces a Status Code ASCII string in the output
// buffer.  The ASCII string is produced by parsing the format string 
// specified by format.  Arguments are pulled from the variable argument
// list specified by ArgList based on the contents of the format string.
// This is internal function used by TRACE and PEI_TRACE
//
// Input:
//  pBuffer - Pointer to a EFI_STATUS_CODE_STRING_DATA buffer. User is 
//  responsible for allocating the necessary memory resources!
//  
//  Size - Size of the buffer in bytes.
//
//  sFormat - Pointer to a null-terminated format ASCII string.
//
//  ArgList - Marker for the variable argument list.
//
// Output: VOID
//
// Referrals: Sprintf_va_list
//
//          
//*************************************************************************
VOID PrepareStatusCodeString( VOID* pBuffer, UINTN Size, CHAR8 *sFormat, va_list ArgList )
{
    static CHAR8 OverflowMessageStr[] = "... DEBUG BUFFER OVERFLOW!!!\n";
    UINTN n;

    static EFI_STATUS_CODE_STRING_DATA Header = 
    {
        {
            sizeof(EFI_STATUS_CODE_DATA),
            sizeof(EFI_STATUS_CODE_STRING_DATA) - sizeof(EFI_STATUS_CODE_DATA),
            EFI_STATUS_CODE_DATA_TYPE_STRING_GUID
        }, EfiStringAscii, NULL
    };
    EFI_STATUS_CODE_STRING_DATA *pData = pBuffer;

    //Prepare the data strucutre
    *pData = Header;
    pData->String.Ascii = (CHAR8*)pData + sizeof(EFI_STATUS_CODE_STRING_DATA);

    //Prepare the string
    n = Sprintf_s_va_list( 
        (CHAR8*)(pData + 1), 
        Size - sizeof(EFI_STATUS_CODE_STRING_DATA), 
        sFormat, 
        ArgList 
    );
    if ( n < (Size - sizeof(EFI_STATUS_CODE_STRING_DATA) - 1) || 
         Size < (sizeof(OverflowMessageStr) + sizeof(EFI_STATUS_CODE_STRING_DATA)) )
        return;

    // Buffer Overflow!
    // Cut of the previous debug message plus error message
    MemCpy(
        (CHAR8*)pBuffer + Size - sizeof(OverflowMessageStr),
        OverflowMessageStr, 
        sizeof(OverflowMessageStr)
    );
}

//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (C)Copyright 1985-2009, American Megatrends, Inc.            **
//**                                                                     **
//**                       All Rights Reserved.                          **
//**                                                                     **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093           **
//**                                                                     **
//**                       Phone: (770)-246-8600                         **
//**                                                                     **
//*************************************************************************
//*************************************************************************