/** @file
This file implements ATA pass through transaction for ATA bus driver.
This file implements the low level execution of ATA pass through transaction.
through command and protocol.
NOTE: This file also implements the StorageSecurityCommandProtocol(SSP). For input
parameter SecurityProtocolSpecificData, ATA spec has no explicitly definition
for Security Protocol Specific layout. This implementation uses big endian for
Cylinder register.
Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "AtaBus.h"
//
// Look up table (UdmaValid, IsWrite) for EFI_ATA_PASS_THRU_CMD_PROTOCOL
//
{
},
{
}
};
//
// Look up table (UdmaValid, Lba48Bit, IsIsWrite) for ATA_CMD
//
{
{
ATA_CMD_READ_SECTORS, // 28-bit LBA; PIO read
ATA_CMD_WRITE_SECTORS // 28-bit LBA; PIO write
},
{
ATA_CMD_READ_SECTORS_EXT, // 48-bit LBA; PIO read
ATA_CMD_WRITE_SECTORS_EXT // 48-bit LBA; PIO write
}
},
{
{
ATA_CMD_READ_DMA, // 28-bit LBA; DMA read
ATA_CMD_WRITE_DMA // 28-bit LBA; DMA write
},
{
ATA_CMD_READ_DMA_EXT, // 48-bit LBA; DMA read
ATA_CMD_WRITE_DMA_EXT // 48-bit LBA; DMA write
}
}
};
//
// Look up table (UdmaValid, IsTrustSend) for ATA_CMD
//
{
ATA_CMD_TRUST_RECEIVE, // PIO read
ATA_CMD_TRUST_SEND // PIO write
},
{
ATA_CMD_TRUST_RECEIVE_DMA, // DMA read
ATA_CMD_TRUST_SEND_DMA // DMA write
}
};
//
// Look up table (Lba48Bit) for maximum transfer block number
//
};
/**
Wrapper for EFI_ATA_PASS_THRU_PROTOCOL.PassThru().
This function wraps the PassThru() invocation for ATA pass through function
for an ATA device. It assembles the ATA pass through command packet for ATA
transaction.
@param[in, out] AtaDevice The ATA child device involved for the operation.
@param[in, out] TaskPacket Pointer to a Pass Thru Command Packet. Optional,
if it is NULL, blocking mode, and use the packet
in AtaDevice. If it is not NULL, non blocking mode,
and pass down this Packet.
@param[in, out] Event If Event is NULL, then blocking I/O is performed.
If Event is not NULL and non-blocking I/O is
supported,then non-blocking I/O is performed,
and Event will be signaled when the write
request is completed.
@return The return status from EFI_ATA_PASS_THRU_PROTOCOL.PassThru().
**/
)
{
//
// Assemble packet. If it is non blocking mode, the Ata driver should keep each
// subtask and clean them when the event is signaled.
//
if (TaskPacket != NULL) {
Packet = TaskPacket;
} else {
}
);
//
// Ensure ATA pass through caller and callee have the same
// interpretation of ATA pass through protocol.
//
return Status;
}
/**
Wrapper for EFI_ATA_PASS_THRU_PROTOCOL.ResetDevice().
This function wraps the ResetDevice() invocation for ATA pass through function
for an ATA device.
@param AtaDevice The ATA child device involved for the operation.
@return The return status from EFI_ATA_PASS_THRU_PROTOCOL.PassThru().
**/
)
{
return AtaPassThru->ResetDevice (
);
}
/**
Prints ATA model name to ATA device structure.
This function converts ATA device model name from ATA identify data
to a string in ATA device structure. It needs to change the character
order in the original model name string.
@param AtaDevice The ATA child device involved for the operation.
**/
)
{
//
// Swap the byte order in the original module name.
//
}
}
/**
Gets ATA device Capacity according to ATA 6.
This function returns the capacity of the ATA device if it follows
ATA 6 to support 48 bit addressing.
@param AtaDevice The ATA child device involved for the operation.
@return The capacity of the ATA device or 0 if the device does not support
48-bit addressing defined in ATA 6.
**/
)
{
//
// The device doesn't support 48 bit addressing
//
return 0;
}
//
// 48 bit address feature set is supported, get maximum capacity
//
Capacity = 0;
//
// Lower byte goes first: word[100] is the lowest word, word[103] is highest
//
}
return Capacity;
}
/**
Identifies ATA device via the Identify data.
This function identifies the ATA device and initializes the Media information in
Block IO protocol interface.
@param AtaDevice The ATA child device involved for the operation.
@retval EFI_UNSUPPORTED The device is not a valid ATA device (hard disk).
@retval EFI_SUCCESS The device is successfully identified and Media information
is correctly initialized.
**/
)
{
//
// This is not an hard disk
//
return EFI_UNSUPPORTED;
}
DEBUG ((EFI_D_INFO, "AtaBus - Identify Device: Port %x PortMultiplierPort %x\n", AtaDevice->Port, AtaDevice->PortMultiplierPort));
//
// Check whether the WORD 88 (supported UltraDMA by drive) is valid
//
//
// If BIT0~BIT6 is selected, then UDMA is supported
//
}
}
if (Capacity > MAX_28BIT_ADDRESSING_CAPACITY) {
//
// Capacity exceeds 120GB. 48-bit addressing is really needed
//
} else {
//
// This is a hard disk <= 120GB capacity, treat it as normal hard disk
//
Capacity = ((UINT32)IdentifyData->user_addressable_sectors_hi << 16) | IdentifyData->user_addressable_sectors_lo;
}
//
// Block Media Information:
//
//
// Check whether Long Physical Sector Feature is supported
//
//
// Check whether one physical block contains multiple physical blocks
//
if ((PhyLogicSectorSupport & BIT13) != 0) {
//
// Check lowest alignment of logical blocks within physical block
//
BlockMedia->LowestAlignedLba = (EFI_LBA) ((BlockMedia->LogicalBlocksPerPhysicalBlock - ((UINT32)IdentifyData->alignment_logic_in_phy_blocks & 0x3fff)) %
}
}
//
// Check logical block size
//
if ((PhyLogicSectorSupport & BIT12) != 0) {
BlockMedia->BlockSize = (UINT32) (((IdentifyData->logic_sector_size_hi << 16) | IdentifyData->logic_sector_size_lo) * sizeof (UINT16));
}
}
//
// Get ATA model name from identify data structure.
//
return EFI_SUCCESS;
}
/**
Discovers whether it is a valid ATA device.
This function issues ATA_CMD_IDENTIFY_DRIVE command to the ATA device to identify it.
If the command is executed successfully, it then identifies it and initializes
the Media information in Block IO protocol interface.
@param AtaDevice The ATA child device involved for the operation.
@retval EFI_SUCCESS The device is successfully identified and Media information
is correctly initialized.
@return others Some error occurs when discovering the ATA device.
**/
)
{
//
// Prepare for ATA command block.
//
//
// Prepare for ATA pass through packet.
//
do {
//
// The command is issued successfully
//
return Status;
}
}
} while (Retry-- > 0);
return Status;
}
/**
Transfer data from ATA device.
ATA device. It chooses the appropriate ATA command and protocol to invoke PassThru
interface of ATA pass through.
@param[in, out] AtaDevice The ATA child device involved for the operation.
@param[in, out] TaskPacket Pointer to a Pass Thru Command Packet. Optional,
if it is NULL, blocking mode, and use the packet
in AtaDevice. If it is not NULL, non blocking mode,
and pass down this Packet.
@param[in, out] Buffer The pointer to the current transaction buffer.
@param[in] StartLba The starting logical block address to be accessed.
@param[in] TransferLength The block number or sector count of the transfer.
@param[in] IsWrite Indicates whether it is a write operation.
@param[in] Event If Event is NULL, then blocking I/O is performed.
If Event is not NULL and non-blocking I/O is
supported,then non-blocking I/O is performed,
and Event will be signaled when the write
request is completed.
@retval EFI_SUCCESS The data transfer is complete successfully.
@return others Some error occurs when transferring data.
**/
)
{
//
// Ensure AtaDevice->UdmaValid, AtaDevice->Lba48Bit and IsWrite are valid boolean values
//
//
// Prepare for ATA command block.
//
} else {
}
//
// Prepare for ATA pass through packet.
//
if (TaskPacket != NULL) {
} else {
}
if (IsWrite) {
} else {
}
}
/**
Free SubTask.
@param[in, out] Task Pointer to task to be freed.
**/
)
{
}
}
}
/**
Call back funtion when the event is signaled.
@param[in] Event The Event this notify function registered to.
@param[in] Context Pointer to the context data registered to the
Event.
**/
)
{
//
// Check the command status.
// If there is error during the sub task source allocation, the error status
// should be returned to the caller directly, so here the Task->Token may already
// be deleted by the caller and no need to update the status.
//
}
DEBUG ((
"NON-BLOCKING EVENT FINISHED!- STATUS = %r\n",
));
//
// Reduce the SubEventCount, till it comes to zero.
//
(*Task->UnsignalledEventCount) --;
//
// Remove the SubTask from the Task list.
//
if ((*Task->UnsignalledEventCount) == 0) {
//
// All Sub tasks are done, then signal the upper layer event.
// Except there is error during the sub task source allocation.
//
}
//
// Finish all subtasks and move to the next task in AtaTaskList.
//
DEBUG ((EFI_D_BLKIO, "AtaTask->NumberOfBlocks = %x; AtaTask->Token=%x\n", AtaTask->NumberOfBlocks, AtaTask->Token));
);
}
}
}
DEBUG ((
"PACKET INFO: Write=%s, Length=%x, LowCylinder=%x, HighCylinder=%x, SectionNumber=%x\n",
Task->Packet.OutDataBuffer != NULL ? Task->Packet.OutTransferLength : Task->Packet.InTransferLength,
));
//
// Free the buffer of SubTask.
//
}
/**
Read or write a number of blocks from ATA device.
transactions.
@param[in, out] AtaDevice The ATA child device involved for the operation.
@param[in, out] Buffer The pointer to the current transaction buffer.
@param[in] StartLba The starting logical block address to be accessed.
@param[in] NumberOfBlocks The block number or sector count of the transfer.
@param[in] IsWrite Indicates whether it is a write operation.
@param[in, out] Token A pointer to the token associated with the transaction.
@retval EFI_SUCCESS The data transfer is complete successfully.
@return others Some error occurs when transferring data.
**/
)
{
TempCount = 0;
EventCount = NULL;
Index = 0;
//
// Ensure AtaDevice->Lba48Bit is a valid boolean value
//
//
// Initial the return status and shared account for Non Blocking.
//
return EFI_OUT_OF_RESOURCES;
}
return EFI_SUCCESS;
}
if (EventCount == NULL) {
return EFI_OUT_OF_RESOURCES;
}
return EFI_OUT_OF_RESOURCES;
}
*EventCount = TempCount;
}else {
//
// Stall for 100us.
//
MicroSecondDelay (100);
}
}
do {
if (NumberOfBlocks > MaxTransferBlockNumber) {
} else {
NumberOfBlocks = 0;
}
//
// Create sub event for the sub ata task. Non-blocking mode.
//
goto EXIT;
}
);
//
// If resource allocation fail, the un-signalled event count should equal to
// the original one minus the unassigned subtasks number.
//
goto EXIT;
}
Status = TransferAtaDevice (AtaDevice, &SubTask->Packet, Buffer, StartLba, (UINT32) TransferBlockNumber, IsWrite, SubEvent);
} else {
//
// Blocking Mode.
//
DEBUG ((EFI_D_BLKIO, "Blocking AccessAtaDevice, TransferBlockNumber=%x; StartLba = %x\n", TransferBlockNumber, StartLba));
Status = TransferAtaDevice (AtaDevice, NULL, Buffer, StartLba, (UINT32) TransferBlockNumber, IsWrite, NULL);
}
goto EXIT;
}
Index++;
} while (NumberOfBlocks > 0);
EXIT:
//
// Release resource at non-blocking mode.
//
if (*EventCount == 0) {
}
}
}
}
}
return Status;
}
/**
ATA device. It chooses the appropriate ATA command and protocol to invoke PassThru
interface of ATA pass through.
@param AtaDevice The ATA child device involved for the operation.
@param Buffer The pointer to the current transaction buffer.
@param SecurityProtocolId The value of the "Security Protocol" parameter of
the security protocol command to be sent.
@param SecurityProtocolSpecificData The value of the "Security Protocol Specific" parameter
of the security protocol command to be sent.
@param TransferLength The block number or sector count of the transfer.
@param IsTrustSend Indicates whether it is a trust send operation or not.
@param 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.
@param TransferLengthOut A pointer to a buffer to store the size in bytes of the data
written to the buffer. Ignore it when IsTrustSend is TRUE.
@retval EFI_SUCCESS The data transfer is complete successfully.
@return others Some error occurs when transferring data.
**/
)
{
//
// Ensure AtaDevice->UdmaValid and IsTrustSend are valid boolean values
//
//
// Prepare for ATA command block.
//
if (TransferLength == 0) {
} else {
}
//
// NOTE: ATA Spec has no explicitly definition for Security Protocol Specific layout.
// Here use big endian for Cylinder register.
//
//
// Prepare for ATA pass through packet.
//
if (TransferLength == 0) {
Packet->InTransferLength = 0;
Packet->OutTransferLength = 0;
} else if (IsTrustSend) {
//
// Check the alignment of the incoming buffer prior to invoking underlying ATA PassThru
//
}
} else {
}
if (TransferLengthOut != NULL) {
if (! IsTrustSend) {
}
}
return Status;
}