Update the function's descriptions (which is in AtaBus, AtaAtapiPassThru, Partition drivers) to make them be consistent with the code.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11678 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qianouyang 2011-05-19 06:12:58 +00:00
parent b40f99a8c1
commit 86d8e19942
7 changed files with 18 additions and 15 deletions

View File

@ -201,11 +201,11 @@ AhciWaitMemSet (
EFI_STATUS
EFIAPI
AhciCheckMemSet (
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN UINT32 Offset,
IN UINT32 MaskValue,
IN UINT32 TestValue,
IN UINTN *RetryTimes
IN EFI_PCI_IO_PROTOCOL *PciIo,
IN UINT32 Offset,
IN UINT32 MaskValue,
IN UINT32 TestValue,
IN OUT UINTN *RetryTimes
)
{
UINT32 Value;

View File

@ -1269,7 +1269,7 @@ AtaUdmaInOut (
to host;Read equals 0, means data transferred
from host to device.
@param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure.
@param[in] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.
@param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.
@param[in] Timeout The time to complete the command.
@param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK
used by non-blocking mode.

View File

@ -1128,12 +1128,12 @@ AtaIssueCommand (
@param[in] IdeRegisters A pointer to EFI_IDE_REGISTERS data structure.
@param[in, out] Buffer A pointer to the source buffer for the data.
@param[in] ByteCount The length of the data.
@param[in] Read Flag used to determine the data transfer direction.
@param[in] Read Flag used to determine the data transfer direction.
Read equals 1, means data transferred from device
to host;Read equals 0, means data transferred
from host to device.
@param[in] AtaCommandBlock A pointer to EFI_ATA_COMMAND_BLOCK data structure.
@param[in] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.
@param[in, out] AtaStatusBlock A pointer to EFI_ATA_STATUS_BLOCK data structure.
@param[in] Timeout The time to complete the command.
@param[in] Task Optional. Pointer to the ATA_NONBLOCK_TASK
used by non-blocking mode.

View File

@ -199,7 +199,7 @@ FreeAlignedBuffer (
VOID
EFIAPI
FreeAtaSubTask (
IN ATA_BUS_ASYN_TASK *Task
IN OUT ATA_BUS_ASYN_TASK *Task
);
/**
@ -287,6 +287,8 @@ AccessAtaDevice(
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.
@ -947,7 +949,7 @@ AtaStorageSecurityReceiveData (
IN UINTN PayloadBufferSize,
OUT VOID *PayloadBuffer,
OUT UINTN *PayloadTransferSize
);
);
/**
Send a security protocol command to a device.
@ -1020,6 +1022,6 @@ AtaStorageSecuritySendData (
IN UINT16 SecurityProtocolSpecificData,
IN UINTN PayloadBufferSize,
IN VOID *PayloadBuffer
);
);
#endif

View File

@ -106,7 +106,7 @@ UINTN mMaxTransferBlockNumber[] = {
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] Event If Event is NULL, then blocking I/O is performed.
@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
@ -527,7 +527,7 @@ TransferAtaDevice (
VOID
EFIAPI
FreeAtaSubTask (
IN ATA_BUS_ASYN_TASK *Task
IN OUT ATA_BUS_ASYN_TASK *Task
)
{
if (Task->Packet.Asb != NULL) {
@ -805,6 +805,8 @@ EXIT:
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.

View File

@ -481,7 +481,6 @@ PartitionValidGptTable (
for Partition entry array.
@param[in] BlockIo Parent BlockIo interface
@param[in] BlockIo2 Parent BlockIo2 interface.
@param[in] DiskIo Disk Io Protocol.
@param[in] PartHeader Partition table header structure

View File

@ -912,7 +912,7 @@ PartitionWriteBlocksEx (
this request will not be signaled.
@param[in] This Indicates a pointer to the calling context.
@param[in,out] Token A pointer to the token associated with the transaction
@param[in, out] Token A pointer to the token associated with the transaction
@retval EFI_SUCCESS The flush request was queued if Event is not NULL.
All outstanding data was written correctly to the