path: root/Core/EM/Recovery/SerialRecovery.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/Modules/Recovery/SerialRecovery.c 8     2/13/12 4:13a Rajeshms $
//
// $Revision: 8 $
//
// $Date: 2/13/12 4:13a $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Core/Modules/Recovery/SerialRecovery.c $
// 
// 8     2/13/12 4:13a Rajeshms
// [TAG]  		EIP80704
// [Category]  	New Feature
// [Description]  	Serial Recovery support through PCI Serial Port .
// [Files]  		PciSerialRecovery.mak, PciSerialRecovery.sdl,
// PciSerialRecovery.c, PciSerialRecovery.h, PciSerialRecovery.chm,
// PciSerialRecovery.dxs, SerialRecovery.c, SerialDevice.h
// 
// 7     5/13/11 5:08p Artems
// Added secure flash update support
// 
// 6     11/25/09 4:53p Felixp
// sAmiRomFile renamed to RecoveryFileName
// FlashSize renamed ro RecoveryImageSize
// 
// 5     7/10/09 10:42a Rameshr
// Recovery from Multiple Serial Device support Added
// EIP:21100
// 
// 4     7/01/09 4:19p Rameshr
// Coding Standard and File header updated.
//
// 3     5/20/06 2:58p Felixp
//
// 2     12/19/05 5:52p Robert
// The GetSerialChar function was not returning the character properly in
// the parameter list.  A pointer was being created and it was initialized
// to a value, but the pointer itself was never initialized.  A CHAR8
// variable was created and the pointer was initialized to that variable.
// It worked in debug mode because the compiler set aside a data space for
// the pointer and that the optimized version didn't.
//
// 1     12/01/05 9:45a Felixp
//
// 1     7/15/05 10:40a Eswark
//
//**********************************************************************
//<AMI_FHDR_START>
//----------------------------------------------------------------------
//
// Name: SerialRecovery.c - PEI driver
//
// Description:	Implements Serial Recovery Functions
//
//----------------------------------------------------------------------
//<AMI_FHDR_END>

#include "Recovery.h"
#include "RecoveryCsp.h"

#include <AmiPeiLib.h>
#include <Ppi\Stall.h>
#include <Ppi\DeviceRecoveryModule.h>
#include <Ppi\SerialDevice.h>


#define BAUD_DIVISOR_LSB        0x0001
#define BAUD_DIVISOR_MSB        0x0000
#define MAX_USER_DELAY          0x1E84EC    //wait for user response in 15 microseconds units
#define MAX_DATA_DELAY          0x1046A     //Wait for data byte in 50 microseconds units
#define MAX_DATA1_DELAY         0x28B0A
#define MAX_RESP_DELAY          0x1E        //Max Response time in 1 second units
#define XMODEM_SOH              0x01        // Start Header
#define XMODEM_EOT              0x04        // End of Transfer
#define XMODEM_ACK              0x06        // Acknowledge
#define XMODEM_NAK              0x15        // Negative Acknowledge
#define XMODEM_CAN              0x18        // Cancel Transfer

#define COM_BASE_ADDRESS        0x3f8

VOID SendSerialChar (
    CHAR8 c 
);
BOOLEAN GetSerialData1 (
    UINT8* ReadData 
);
BOOLEAN GetSerialData (
    UINT8* ReadData 
);
VOID SendSerialData (
    UINT8 d 
);
VOID SendSerialString (
    CHAR8* Str 
);
BOOLEAN GetSerialChar (
    CHAR8* ReadChar 
);
VOID PrintCopyRightMessage ( );
VOID InitSerialPort ( );

UINT8 ReadSerialDevice (
    IN  PEI_RECOVERY_SERIAL_MODE_PPI *This,
    IN  UINT8   Offset
);

VOID WriteSerialDevice (
    IN  PEI_RECOVERY_SERIAL_MODE_PPI *This,
	IN  UINT8   Offset,
    IN  UINT8   Data
);

EFI_PEI_SERVICES **mPeiServices;

PEI_RECOVERY_SERIAL_MODE_PPI    *SerialModePpi=NULL;

EFI_STATUS
EFIAPI GetNumberRecoveryCapsules (
    IN EFI_PEI_SERVICES                   **PeiServices,
    IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
    OUT UINTN                             *NumberRecoveryCapsules );

EFI_STATUS
EFIAPI GetRecoveryCapsuleInfo (
    IN EFI_PEI_SERVICES                   **PeiServices,
    IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
    IN UINTN                              CapsuleInstance,
    OUT UINTN                             *Size,
    OUT EFI_GUID                          *CapsuleType );

EFI_STATUS
EFIAPI LoadRecoveryCapsule (
    IN OUT EFI_PEI_SERVICES               **PeiServices,
    IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
    IN UINTN                              CapsuleInstance,
    OUT VOID                              *Buffer );

BOOLEAN ReadFileFromSerial (
    CHAR8 * Buffer,
    UINT32* Size,
    UINT8 *result );

BOOLEAN ReadSerialBlock (
    UINT8* Buffer );

BOOLEAN SendNakAck (
    UINT8 * Data,
    UINT8 XCommand );

EFI_GUID                           gEfiPeiStallPpiGuid  = EFI_PEI_STALL_PPI_GUID;
static EFI_GUID                    gPeiDevRecModuleGuid = EFI_PEI_DEVICE_RECOVERY_MODULE_PPI_GUID;
EFI_PEI_STALL_PPI                  *mStallPpi;

EFI_PEI_DEVICE_RECOVERY_MODULE_PPI SerialRecoveryModule = {
    GetNumberRecoveryCapsules, GetRecoveryCapsuleInfo, LoadRecoveryCapsule
};

// PPI to be installed
EFI_PEI_PPI_DESCRIPTOR  SerialRecoveryPpiList[] = {
    {
        EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
        &guidRecoveryDevice, &SerialRecoveryModule
    }
};

EFI_GUID guidSerialRecoveryDevice=PEI_RECOVERY_SERIAL_MODE_PPI_GUID;

PEI_RECOVERY_SERIAL_MODE_PPI ComSerialDevice =
{
    COM_BASE_ADDRESS,
    ReadSerialDevice,
    WriteSerialDevice
};

// PPI to be installed
EFI_PEI_PPI_DESCRIPTOR SerialDevicePpiList[] =
{ 
	{
		EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
		&guidSerialRecoveryDevice, &ComSerialDevice
	}
};
//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	SerialRecoveryPeimEntry
//
// Description:	Serial Recovery PEI entry Function
//
//  Input:       IN EFI_FFS_FILE_HEADER *FfsHeader- FFSHeader
//               IN  EFI_PEI_SERVICES **PeiServices - pointer to PEI services
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
EFIAPI SerialRecoveryPeimEntry(
    IN EFI_FFS_FILE_HEADER *FfsHeader,
    IN EFI_PEI_SERVICES    **PeiServices )
{
    EFI_STATUS Status;

    mPeiServices = PeiServices;

    Status = (*PeiServices)->LocatePpi(
        PeiServices,
        &gEfiPeiStallPpiGuid,
        0,
        NULL,
        &mStallPpi
        );
    ASSERT_PEI_ERROR( PeiServices, Status );

    Status = (*PeiServices)->InstallPpi( PeiServices, SerialRecoveryPpiList );

    //
    //Install the Serial Device for Com port 0x3f8
    //
	Status = (*PeiServices)->InstallPpi (PeiServices,SerialDevicePpiList);
    ASSERT_PEI_ERROR( PeiServices, Status );

    return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	GetNumberRecoveryCapsules
//
// Description:	Get the Number of Recovery Capsules
//
//  Input:      IN  EFI_PEI_SERVICES **PeiServices - pointer to PEI services
//              IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This
//              OUT UINTN  *NumberRecoveryCapsules- Number of Recovery Capsule
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
static EFI_STATUS
EFIAPI GetNumberRecoveryCapsules(
    IN EFI_PEI_SERVICES                   **PeiServices,
    IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
    OUT UINTN                             *NumberRecoveryCapsules )
{
    *NumberRecoveryCapsules = 1;
    return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	GetRecoveryCapsuleInfo
//
// Description:	Get the Recovery Capsule Information
//
//  Input:      IN  EFI_PEI_SERVICES **PeiServices - pointer to PEI services
//              IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This
//              IN UINTN                              CapsuleInstance,
//              OUT UINTN                             *Size,
//              OUT EFI_GUID                          *CapsuleType
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
static EFI_STATUS
EFIAPI GetRecoveryCapsuleInfo(
    IN EFI_PEI_SERVICES                   **PeiServices,
    IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
    IN UINTN                              CapsuleInstance,
    OUT UINTN                             *Size,
    OUT EFI_GUID                          *CapsuleType )
{
    EFI_STATUS Status;

    *CapsuleType = guidSerialCapsule;

    Status = GetRecoveryFileInfo(PeiServices, NULL, Size, NULL);
    
    return Status;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	PrintBaseAddress
//
// Description:	Print the Serial Port base address
//
// Input:       IN UINT16 BaseAddress
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
VOID PrintBaseAddress(
    IN UINT64 BaseAddress
)
{

    CHAR8   TempBuffer[5]={0,0,0,0,0};
    UINTN   ValueCharNum=0;
    UINTN   Remainder;
    CHAR8   TempPrintBuffer[5]={0,0,0,0,0};
    UINTN   Index=0;

    do {
        BaseAddress = (UINT64)Div64 ((UINT64)BaseAddress, 0x10, &Remainder);

        if(Remainder < 0xa) {
            TempBuffer[ValueCharNum] = (CHAR8)(Remainder + '0');
        } else {
            TempBuffer[ValueCharNum] = (CHAR8)(Remainder + 'A' - 0xa);
        }
        ValueCharNum++;
    } while (BaseAddress != 0);

    //
    // Reverse temp string into Buffer.
    //
    while (ValueCharNum) {
        TempPrintBuffer[Index] = TempBuffer[ValueCharNum-1];
        ValueCharNum--;
        Index++;
    }
    SendSerialString(&TempPrintBuffer[0]);
    return;
}       
//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	LoadRecoveryCapsule
//
// Description:	Download the Capsule file from the Serial device and returns the buffer
//
//  Input:      IN  EFI_PEI_SERVICES **PeiServices - pointer to PEI services
//              IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This
//              IN UINTN                              CapsuleInstance,
//              OUT VOID                              *Buffer- Recovery Capsule Data
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
static EFI_STATUS
EFIAPI LoadRecoveryCapsule(
    IN OUT EFI_PEI_SERVICES               **PeiServices,
    IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This,
    IN UINTN                              CapsuleInstance,
    OUT VOID                              *Buffer )
{
    CHAR8   *pBuff;
    UINT32  FileSize;
    UINT8   Result   = 0xFF;
    CHAR8   *message;
    UINTN   Number;
    CHAR8   Char      = 0;
    CHAR8   *ReadChar = &Char;
    UINT32  waitCount;
	BOOLEAN			Recovery = FALSE;
    UINT8   Index=0;
    EFI_STATUS  Status;
    UINTN   RecoveryCapsuleSize;
    BOOLEAN ExtendedVerification;

    Status = GetRecoveryFileInfo(PeiServices, NULL, &RecoveryCapsuleSize, &ExtendedVerification);
    if(EFI_ERROR(Status))
        return Status;

	mPeiServices	= PeiServices;
    Index=0;

    do {

        //
        //Locate the Serial Device PPI
        //
	    Status = (**PeiServices).LocatePpi (PeiServices, &guidSerialRecoveryDevice, Index, NULL, &SerialModePpi);
            
        //
        //If Found Proceed with Reading recovery file. If not break the loop and return the status
        //
	    if ((EFI_ERROR (Status))) {
            break;   
	    }
        
        FileSize = (UINT32)RecoveryCapsuleSize;

	    GetNumberRecoveryCapsules(PeiServices, This, &Number);
	    if(Number == 0) {
            return EFI_UNSUPPORTED;
        }

        InitSerialPort( );

        *ReadChar = '\n';
        SendSerialChar( *ReadChar );
	    PrintCopyRightMessage();

	    message="Press space to start recovery from Serial Address 0x";
        //
        //Display the Serial Port Base address
        //
	    SendSerialString(message);
        PrintBaseAddress((UINT64)SerialModePpi->SerialDeviceBaseAddress);
	    message="\n\r or 'N' to try Next Serial Device or 'Q' to quit\n\r";
	    SendSerialString(message);
	    do {
		    waitCount=0xF;		// EKCheck
            while ( waitCount-- ) {
                if ( GetSerialChar( ReadChar ) == TRUE ) {
                    Recovery = TRUE;
                    break;
                }
		    }

		    if(*ReadChar ==' ') {
			    break;
            }

		    if (*ReadChar=='N' || *ReadChar=='n') {
                //
                // Try the Next Serial Device
                //
			    message="Trying next serial device if avilable.\n\r";
			    SendSerialString(message);
		        Recovery=FALSE;
			    break;
		    }
            if ( *ReadChar == 'Q' || *ReadChar == 'q' ) {
                //
                //Exit from Serial Recovery
                //
                message = "Serial Recovery is aborted by user.\n\r";
                SendSerialString( message );
                return EFI_ABORTED;
            }
	    } while(Recovery==TRUE);

        if(Recovery == FALSE) {
            //
            // Try Next Device
            //  
            Index++;
            continue;
        }
	    message="Send BIOS image using XMODEM protocol\n\r";
        SendSerialString( message );

        //
        //Wait for 3-5 Seconds before User Sends a file
        //
        mStallPpi->Stall( mPeiServices, mStallPpi, 20000000 );

        pBuff = Buffer;

        if ( !ReadFileFromSerial( pBuff, &FileSize, &Result )) {
            PEI_TRACE((-1, PeiServices, "\nRead File Failed Capsule Size= %d, FileRead Result=%d\n", FileSize, Result));

            if ( Result == 1 ) {
                PEI_TRACE((-1, PeiServices, "\nNo Responce from Terminal\n"));
            }

            if ( Result == 3 ) {
                PEI_TRACE((-1, PeiServices, "\nFile Size over Run\n"));
            }

            //
            // Error getting Recovery file from current serial device. So try another
            // Serial Device
            //
            Index++;
		    continue;
	    } else {
            //
            //File got successfully. So Return
            //
            if(ExtendedVerification || FileSize == (UINT32)RecoveryCapsuleSize)
                return EFI_SUCCESS;
        }
    }while(TRUE);

	return EFI_NOT_FOUND;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	InitSerialPort
//
// Description:	Initilize the Serial port Registers 
//
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
VOID InitSerialPort( )
{
    //
    // Disable all interrupts
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, InteruptEnableReg, 0x00);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Enable Baud Rate Programming
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, LineControlReg, 0x80);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Program Baud Rate LSB
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, SerialDataReg, BAUD_DIVISOR_LSB);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Program Baud Rate MSB
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, InteruptEnableReg, BAUD_DIVISOR_MSB);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Set to 8 bits, 1 Stop, No Parity
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, LineControlReg, 0x03);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Clear and enable FIFOs
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, FifoControlReg, 0x01);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Disable all interrupts
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, InteruptEnableReg, 0x00);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Clear and enable FIFOs
    //
    SerialModePpi->WriteSerialDevice(SerialModePpi, FifoControlReg, 0xC7);
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );
    //
    // Activate DTR and RTS
    //    
    SerialModePpi->WriteSerialDevice(SerialModePpi, ModemControlReg, 0x03); 
    mStallPpi->Stall( mPeiServices, mStallPpi, 1000 );

    //
    // Discard any garbage that may be in the receive FIFO
    //
    while ( (SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg)) & 01 ) {
           SerialModePpi->ReadSerialDevice(SerialModePpi,SerialDataReg);  // else, read data and discard
    }
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	ReadFileFromSerial
//
// Description:	Read the Recovery file through Serial Device
//
// Input:       CHAR8 * Buffer- Data buffer
//              UINT32* Size- Size
//              UINT8 * result- Result Status
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN ReadFileFromSerial(
    CHAR8 * Buffer,
    UINT32* Size,
    UINT8 * result )
{
    // Read recovery file through serial port, check checksum, signature etc.,
    // and copy it to the buffer ImageStart.

    UINT32  NumBlocks = *Size / 128;
    UINT32  count     = 10;
    UINT32  BlockID   = 1;
    UINT32  TimeOut   = 10;                 //1 second (in .1 sec units) timeout
    UINT8   BlockNum  = 1;
    UINT8   Command   = XMODEM_NAK;
    UINT8   Data      = 0;
    CHAR8*  InChar  = '\0';
    BOOLEAN Status;

    NumBlocks++;
    while ( NumBlocks )
    {
        if ( !SendNakAck( &Data, Command ))     //send NAK
        {
            *result = 1;
            return FALSE;
        }

        if ( Data == XMODEM_EOT )            //if end of transfer, exit with success
        {
            Command = XMODEM_ACK;
            SendSerialData( Command );
            BlockID--;
            *Size   = BlockID * 128;
            *result = 0;
            return TRUE;
        }

        if ( Data == XMODEM_SOH ) {
            //
            //Start header received, get rest of the packet
            //
            Status = GetSerialData( &Data );        
            //
            //read block#
            //    
            if ( Status && (Data == BlockNum)) {                                       
                Status = GetSerialData( &Data );        

                if ( Status ) {                                   
                    //if FF-block number doesn't match, retry
                    if ( ReadSerialBlock( Buffer )) {     
                        // Read 128 byte packet
                        BlockNum++;
                        BlockID++;
                        NumBlocks--;
                        Command = XMODEM_ACK;
                        continue;
                    }
                }
            }
            while ( GetSerialData( &Data ))
            {
                ;
            }
        }
    }

    //
    //No more block to read, No EOT byte received, terminate xfer and exit with error
    //
    *result = 3;
    while ( GetSerialData( &Data )) {
        ;    //If abort, read and discard
    }
    Command = XMODEM_CAN;
    while ( count-- ) {
        SendSerialData( Command );    // Send CANCEL Command
    }
    return FALSE;
}

UINT32 CurrentIndex = 0;  //global variable to hold current buffer index

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	ReadSerialBlock
//
// Description:	Read the Serial Block
//
// Input:       CHAR8 * Buffer- Data buffer
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN ReadSerialBlock(
    UINT8* Buffer )
{
    UINT8  CheckSum     = 0;
    UINT8  DataByte     = 0;
    UINT8  * DataBuffer = Buffer;
    UINT32 TempIndex    = CurrentIndex;
    UINT8  bytecount;

    //
    //read 128 byte packet
    //
    for ( bytecount = 1; bytecount <= 128; bytecount++ ) {
        //
        //if error  reading serial port, retry packet
        //
        if ( !(GetSerialData( DataBuffer + CurrentIndex ))) {
            CurrentIndex = TempIndex;
            return FALSE;
        }
        CheckSum += *(DataBuffer + CurrentIndex++);
    }

    //
    //Get Checksum byte
    //
    if ( !(GetSerialData( &DataByte ))) {
        CurrentIndex = TempIndex;
        return FALSE;
    }

    //
    //if byte checksum doesn't match, retry
    //
    if ( DataByte != CheckSum ) {
        CurrentIndex = TempIndex;
        return FALSE;
    }
    return TRUE;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	SendNakAck
//
// Description:	Send the Ack
//
// Input:           UINT8 * Data,
//                  UINT8 XCommand
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN SendNakAck(
    UINT8 * Data,
    UINT8 XCommand )
{
    UINT8 AbortCount = 12, count = 24;       //Number of NAKs or ACKs to send before abort
    CHAR8 * SerialMsg;

    while ( count-- ){
        SendSerialData( XCommand );

        if ( GetSerialData1( Data )) {
            return TRUE;
        }
    }
    //if timeout, cancel the transfer and
    // return false, with abort message
    while ( GetSerialData( Data ))      //If abort, read and discard
    {
        ;
    }
    XCommand = XMODEM_CAN;
    while ( AbortCount-- ) {
        SendSerialData( XCommand );   // Send CANCEL Command
    }
    SerialMsg = "\n\rAborting Serial Recovery";
    SendSerialString( SerialMsg );
    return FALSE;
}


//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	SendSerialChar
//
// Description:	Send a character to Serial Port
//
// Input:       CHAR8 c- Data to send
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
VOID SendSerialChar(
    CHAR8 c )
{
    while ( !(SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg) & 0x20) ) {
        ;
    }
    SerialModePpi->WriteSerialDevice(SerialModePpi, SerialDataReg, (UINT8)c);    
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	GetSerialData1
//
// Description:	Get the Data from Serial Port
//
// Input:       UINT8* ReadData - Data Got from Serial Device
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN GetSerialData1(
    UINT8* ReadData )
{
    long MaxDelay = MAX_DATA1_DELAY;

    //
    //	wait for upto 1 second for the data byte to be ready
    //
    while ( MaxDelay-- )                       
    {
        if ( SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg) & 0x0A ) {
            //
            //exit if overrun/framing error
            //
            return FALSE;                 
        }

        if ( SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg)  & 0x01 ) {
            //
            //exit loop if character ready in Reveive buffer
            //
            break;                          
        }
    }

    if ( MaxDelay <= 0 ) {
        return FALSE;
    }

    //
    //read data byte from receive biffer
    //
    *ReadData = SerialModePpi->ReadSerialDevice(SerialModePpi,SerialDataReg);

    return TRUE;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	GetSerialData
//
// Description:	Get the Data from Serial Port
//
// Input:       UINT8* ReadData - Data Got from Serial Device
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN GetSerialData(
    UINT8* ReadData )
{
    long     MaxDelay = MAX_DATA_DELAY;
    volatile infinite = 1;
    //
    //wait for upto 1 second for the data byte to be ready
    //
    while ( MaxDelay-- )
    {
        if ( SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg) & 0x0A ) {
            //
            //exit if overrun/framing error
            //
            return FALSE;                 
        }

        if ( SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg)  & 0x01 ) {
            //
            //exit loop if character ready in Reveive buffer
            //
            break;                          
        }        
    }

    if ( MaxDelay <= 0 ) {
        return FALSE;
    }
    //
    //read data byte from receive biffer
    //
    *ReadData = SerialModePpi->ReadSerialDevice(SerialModePpi,SerialDataReg);

    return TRUE;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	SendSerialData
//
// Description:	Send the Data to serial Device
//
// Input:       UINT8 d - Data to be send it to Serial Device
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
VOID SendSerialData(
    UINT8 d )                   
{
    while ( !(SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg) & 0x20) )
    {
        ;
    }
    SerialModePpi->WriteSerialDevice(SerialModePpi, SerialDataReg, d);
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	SendSerialString
//
// Description:	Send the String to serial Device
//
// Input:       CHAR8* Str - String to be send it to Serial Device
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
VOID SendSerialString(
    CHAR8* Str )
{
    while ( *Str )
    {
        SendSerialChar( *Str++ );
    }
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	GetSerialChar
//
// Description:	Get the Char from the Serial Device
//
// Input:       CHAR8* ReadChar - Data from Serial Device
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN GetSerialChar(
    CHAR8* ReadChar )  // ReadChar is the output character
{
    long MaxDelay = MAX_USER_DELAY;

    //
    //Wait for upto 30s for the user to enter Response
    //
    while ( MaxDelay-- ) {
        if ( SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg) & 0x0A ) {
            //
            //exit if overrun/framing error
            //
            return FALSE;
        }

        if ( SerialModePpi->ReadSerialDevice(SerialModePpi,LineStatusReg)  & 0x01 ) {
            //
            //exit loop if character ready in Reveive buffer
            //
            break;
        }
    }

    if ( MaxDelay <= 0 ) {
        return FALSE;
    }
    //
    //read character from receive biffer
    //
    *ReadChar = (CHAR8) SerialModePpi->ReadSerialDevice(SerialModePpi,SerialDataReg);
    return TRUE;
}

//<AMI_PHDR_START>
//----------------------------------------------------------------------
//
// Procedure:	PrintCopyRightMessage
//
// Description:	Display the CopyRight Message in Serial Device
//
//
//----------------------------------------------------------------------
//<AMI_PHDR_END>
VOID PrintCopyRightMessage( )
{
    static CHAR8
    *Message =  "\n\r*********************************************************\n\r"
               "(C)Copyright 1985-2012, American Megatrends, Inc.\n\r"
               "               All Rights Reserved.\n\r"
               "               AMI  Serial Recovery.\n\r"
               "*********************************************************\n\r";

    SendSerialString( Message );
}

// <AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Name: ReadSerialDevice
//
// Description:
//  Reads from address(COM_BASE_ADDRESS+offset) that is mapped toSerial
//  Device.
// 
// Input:
//  IN  PEI_RECOVERY_SERIAL_MODE_PPI *This - Pointer to 
//                                           PEI_RECOVERY_SERIAL_MODE_PPI
//  IN  UINT8   Offset - Offset to read the data from the Baseaddress
//
// Output:
//  UINT8 - Data Read from the Device
//
// Modified:
//
// Referrals:
//
// Notes:
//--------------------------------------------------------------------------- 
// <AMI_PHDR_END>
UINT8 ReadSerialDevice (
    IN  PEI_RECOVERY_SERIAL_MODE_PPI *This,
    IN  UINT8   Offset
)
{
    return IoRead8( COM_BASE_ADDRESS + Offset );
}

// <AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Name: WriteSerialDevice
//
// Description:
//  Writes into address(COM_BASE_ADDRESS+offset) that is mapped to Serial
//  Device.
// 
// Input:
//  IN  PEI_RECOVERY_SERIAL_MODE_PPI *This - Pointer to 
//                                           PEI_RECOVERY_SERIAL_MODE_PPI
//  IN  UINT8   Offset - Offset to write the data from the Baseaddress
//  IN  UINT8   Data   - Data to be written
//
// Output:
//  VOID
//
// Modified:
//
// Referrals:
//
// Notes:
//--------------------------------------------------------------------------- 
// <AMI_PHDR_END>
VOID WriteSerialDevice (
    IN  PEI_RECOVERY_SERIAL_MODE_PPI *This,
    IN  UINT8   Offset,
    IN  UINT8   Data
)
{
    IoWrite8( COM_BASE_ADDRESS + Offset , Data );
} 

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