//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (C)Copyright 1985-2011, American Megatrends, Inc.            **
//**                                                                     **
//**                       All Rights Reserved.                          **
//**                                                                     **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093           **
//**                                                                     **
//**                       Phone: (770)-246-8600                         **
//**                                                                     **
//*************************************************************************
//*************************************************************************
// $Header: /Alaska/SOURCE/Modules/OpalSecurity/OPALSECURITY/AHCIOpalSec.c 5     12/21/11 8:32p Rajkumarkc $
//
// $Revision: 5 $
//
// $Date: 12/21/11 8:32p $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/OpalSecurity/OPALSECURITY/AHCIOpalSec.c $
// 
// 5     12/21/11 8:32p Rajkumarkc
// [TAG]            EIP77142
// [Category]     BUG FIX & IMPROVEMENT
// [Description] BUG FIX - Changed Little Endian format to Big Endian
// format while sending commands.
//                      IMPROVEMENT - Added support to Lock the Opal hdd
// if it's unlocked on Bios POST.
// [Files]            IdeOpalSec.c, AhciOpalSec.c, OpalSecurity.c,
// OpalSecurity.h, OpalSecurity.sdl
// 
// 4     8/22/11 4:09a Anandakrishnanl
// [TAG]  		EIP64040
// [Category]  	Improvement
// [Description]  	Opal Security - Changes requested for CodeReview by
// customer
// [Files]  		IdeOpalSec.c
// AhciOpalSec.c
// 
// 3     8/22/11 3:04a Anandakrishnanl
// [TAG]  		EIP62912
// [Category]  	Improvement
// [Description]  	Opal Security Definitions Should be Moved to PIDEBUS.h
// from StorageSecurityProtocol.h
// StorageSecurityProtocol.h included in OPAL security driver module will
// give build error when disabled without sdl token #if
// OpalSecurity_SUPPORT properly placed in Ahcibus and IdeBus drivers. But
// Bus driver should not depend on any tokens. For this reason need to
// move OPAL_SEC_INIT_PROTOCOL_GUID in Pidebus.h
// [Files]  		IdeBus.c
// Pidebus.h
// OpalSecurity.cif
// OpalSecurity.h
// IdeOpalSec.c
// AhciOpalSec.c
// 
// 2     5/19/11 5:58a Anandakrishnanl
// [TAG]  		EIP53565 
// [Category]  	New Feature
// [Description]  	UEFI2.3+ Specifications defines Storage Security
// protocol which needs to be implemented
// [Files]  		AhciBus.c,IdeBus.c,AHCIOpalSec.c,IDEOpalSec.c,OpalSecurity.c
// ,OpalSecurity.chm,OpalSecurity.cif,OpalSecurity.h,OpalSecurity.mak,Opal
// Security.sdl,PIDEBus.h,StorageSecurityProtocol.CIF,StorageSecurityProto
// col.h
// 
//
//<AMI_FHDR_START>
//---------------------------------------------------------------------------
//
// Name: AHCIOpalSec.c
//
// Description: Opal Support
//
//---------------------------------------------------------------------------
//<AMI_FHDR_END>

#include "OpalSecurity.h"

#define ZeroMemory(Buffer,Size) pBS->SetMem(Buffer,Size,0)


//**********************************************************************
//<AMI_PHDR_START>
//
// Procedure:    AhciSendData
//
// Description:    Send a security protocol command to a device.
//
// Input:
//    This - Indicates a pointer to the calling context. Type
//           EFI_STORAGE_SECURITY_COMMAND_PROTOCOL is defined in the
//           EFI_STORAGE_SECURITY_COMMAND_PROTOCOL description.
//    MediaId - ID of the medium to send data to.
//    Timeout - The timeout, in 100ns units, to use for the execution of the 
//              security protocol command. A Timeout value of 0 means that this function 
//              will wait indefinitely for the security protocol command to execute.
//              If Timeout is greater than zero, then this function will return 
//              EFI_TIMEOUT if the time required to execute the receive data command 
//              is greater than Timeout.
//    SecurityProtocolId - Security protocol ID of the security protocol 
//                         command to be sent.
//    SecurityProtocolSpecificData - Security protocol specific portion of 
//                                   the security protocol command.
//    PayloadBufferSize    - Size in bytes of the payload data buffer.
//    PayloadBuffer - A pointer to a buffer containing the security protocol 
//                    command specific payload data for the security protocol command.
//
// Output:
//    EFI_SUCCESS         - The security protocol command completed successfully.
//    EFI_UNSUPPORTED     - The given MediaId does not support security protocol 
//                           commands.
//    EFI_DEVICE_ERROR     - The security protocol command completed with an error.
//    EFI_INVALID_PARAMETER - The PayloadBuffer or PayloadTransferSize is 
//                            NULL and PayloadBufferSize is non-zero.
//
//<AMI_PHDR_END>
//**********************************************************************

EFI_STATUS 
AhciSendData(
    IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This,
    IN UINT32                MediaId,
    IN UINT64                Timeout,
    IN UINT8                 SecurityProtocolId,
    IN UINT16                SecurityProtocolSpecificData,
    IN UINTN                 PayloadBufferSize,
    IN VOID                  *PayloadBuffer 
)
{
    EFI_STATUS              Status;
    UINT8                   SectorCountL = 0;
    UINT8                   SectorCountH = 0;
    COMMAND_STRUCTURE       CommandStructure;
    STORAGE_SECURITY_COMMAND_PROTOCOL *StorageSecurityProtocol = (STORAGE_SECURITY_COMMAND_PROTOCOL*)This;
    SATA_DEVICE_INTERFACE   *SataDevInterface = (SATA_DEVICE_INTERFACE *)StorageSecurityProtocol->BusInterface;
    SATA_BLOCK_IO           *SataBlkIo = SataDevInterface->SataBlkIo;

    // Check for BlkIo presence
    if(SataBlkIo == NULL) {
        return EFI_UNSUPPORTED;
    }

    // Check for Media change
    if(SataBlkIo->BlkIo.Media->MediaId != MediaId) {
        return EFI_MEDIA_CHANGED;
    }
    
    SectorCountL = (UINT8)(PayloadBufferSize / SataBlkIo->BlkIo.Media->BlockSize);
    SectorCountH = (UINT8)((PayloadBufferSize / SataBlkIo->BlkIo.Media->BlockSize)/0x100);

    ZeroMemory (&CommandStructure, sizeof(COMMAND_STRUCTURE));

    if(PayloadBufferSize != 0){
         Status = SataDevInterface->AhciBusInterface->SataPioDataOut(
                        SataDevInterface,
                        PayloadBuffer,
                        (UINT32)PayloadBufferSize,
                        SecurityProtocolId,
                        SectorCountH,//TransferLength
                        0,
                        (UINT8)(SecurityProtocolSpecificData >> 8) , //Com ID
                        0,
                        (UINT8)SecurityProtocolSpecificData,
                        0,
                        TRUSTED_SEND,
                        TRUE);

    }else{
        // For PayloadBufferSize zero, Trusted Non Data command should be used
        // BIT 24 indicates Trusted Receive/Send
        CommandStructure.LBAMid = (UINT8)(SecurityProtocolSpecificData >> 8);
        CommandStructure.LBAHigh = (UINT8)SecurityProtocolSpecificData;
        CommandStructure.Command = TRUSTED_NON_DATA;
        CommandStructure.Features = SecurityProtocolId;
        CommandStructure.Buffer = PayloadBuffer;
        CommandStructure.ByteCount = (UINT32)PayloadBufferSize;
        Status = SataDevInterface->AhciBusInterface->ExecuteNonDataCommand (SataDevInterface, CommandStructure);
    }

    return Status;
}

//**********************************************************************
//<AMI_PHDR_START>
//
// Procedure:    ReceiveData
//
// Description:    Send a security protocol command to a device that receives 
//        data and/or the result of one or more commands sent by 
//        SendData.
//
// Input:
//    This -Indicates a pointer to the calling context. Type 
//            EFI_STORAGE_SECURITY_COMMAND_PROTOCOL is defined in the
//            EFI_STORAGE_SECURITY_COMMAND_PROTOCOL description.
//    MediaId - ID of the medium to receive data from. 
//    Timeout - The timeout, in 100ns units, to use for the execution of the
//            security protocol command. A Timeout value of 0 means that this 
//            function will wait indefinitely for the security protocol command
//            to execute. If Timeout is greater than zero, then this function 
//            will return.
//    SecurityProtocolId - Security protocol ID of the security protocol 
//            command to be sent.
//    SecurityProtocolSpecificData - Security protocol specific portion of 
//                the security protocol command.
//    PayloadBufferSize - Size in bytes of the payload data buffer.
//    PayloadBuffer - A pointer to a destination buffer to store the 
//            security protocol command specific payload data for the 
//            security protocol command. The caller is responsible 
//            for either having implicit or explicit ownership of 
//            the buffer.
//    PayloadTransferSize - A pointer to a buffer to store the size in bytes
//            of the data written to the payload data buffer.
//
// Output:
//    EFI_SUCCESS - The security protocol command completed successfully.
//    EFI_UNSUPPORTED - The given MediaId does not support security 
//            protocol commands.
//    EFI_DEVICE_ERROR - The security protocol command completed with an error.
//    EFI_INVALID_PARAMETER - The PayloadBuffer or PayloadTransferSize is 
//                  NULL and PayloadBufferSize is non-zero.
//<AMI_PHDR_END>
//**********************************************************************
EFI_STATUS
AhciReceiveData(
    IN EFI_STORAGE_SECURITY_COMMAND_PROTOCOL *This,
    IN UINT32                MediaId,
    IN UINT64                Timeout,
    IN UINT8                 SecurityProtocolId,
    IN UINT16                SecurityProtocolSpecificData,
    IN UINTN                 PayloadBufferSize,
    OUT VOID                 *PayloadBuffer,
    OUT UINTN                *PayloadTransferSize
)
{
    EFI_STATUS              Status;
    UINT8                   SectorCountL = 0;
    UINT8                   SectorCountH = 0;
    COMMAND_STRUCTURE       CommandStructure;
    STORAGE_SECURITY_COMMAND_PROTOCOL *StorageSecurityProtocol = (STORAGE_SECURITY_COMMAND_PROTOCOL*)This;
    SATA_DEVICE_INTERFACE   *SataDevInterface = (SATA_DEVICE_INTERFACE *)StorageSecurityProtocol->BusInterface;
    SATA_BLOCK_IO           *SataBlkIo = SataDevInterface->SataBlkIo;

    // Check for BlkIo presence
    if(SataBlkIo==NULL) {
        return EFI_UNSUPPORTED;
    }

    // Check for Media change
    if(SataBlkIo->BlkIo.Media->MediaId != MediaId) {
        return EFI_MEDIA_CHANGED;
    }

    SectorCountL = (UINT8)(PayloadBufferSize / SataBlkIo->BlkIo.Media->BlockSize);
    SectorCountH = (UINT8)((PayloadBufferSize / SataBlkIo->BlkIo.Media->BlockSize)/0x100);

    ZeroMemory (&CommandStructure, sizeof(COMMAND_STRUCTURE));

    if(PayloadBufferSize != 0){
        // For PayloadBufferSize non zero, Trusted Receive command should be used

        if(PayloadTransferSize == NULL || PayloadBuffer == NULL) {
            return EFI_INVALID_PARAMETER;
        }

        CommandStructure.SectorCount = (UINT16)SectorCountL;
        CommandStructure.LBALow = (UINT8)SectorCountH;
        CommandStructure.LBAMid = (UINT8)(SecurityProtocolSpecificData >> 8);
        CommandStructure.LBAHigh = (UINT8)SecurityProtocolSpecificData;
        CommandStructure.Command = TRUSTED_RECEIVE;
        CommandStructure.Features = SecurityProtocolId;
        CommandStructure.Buffer = PayloadBuffer;
        CommandStructure.ByteCount = (UINT32)PayloadBufferSize ;
        Status = SataDevInterface->AhciBusInterface->ExecutePioDataCommand (SataDevInterface, &CommandStructure, FALSE);
    }else{
        // For PayloadBufferSize zero, Trusted Non Data command should be used
        // BIT 24 indicates Trusted Receive/Send
        CommandStructure.LBAMid = (UINT8)(SecurityProtocolSpecificData >> 8);
        CommandStructure.LBAHigh = (UINT8)SecurityProtocolSpecificData;
        CommandStructure.LBALowExp = 0x01; // Trusted Receive
        CommandStructure.Command = TRUSTED_NON_DATA;
        CommandStructure.Features = SecurityProtocolId;
        CommandStructure.Buffer = PayloadBuffer;
        CommandStructure.ByteCount = (UINT32)PayloadBufferSize;
        Status = SataDevInterface->AhciBusInterface->ExecuteNonDataCommand (SataDevInterface, CommandStructure);
    }

    if (!EFI_ERROR( Status) ) {
        *PayloadTransferSize = CommandStructure.ByteCount;
    } else {
        *PayloadTransferSize = 0;
    }

    return Status;
}

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