summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/ScsiIo.h
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-09 19:17:35 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-09 19:17:35 +0000
commit1f08a159034549216eccfd533b50b712d944d844 (patch)
treec4a4b16daa6f02b29896c96007b94112ae51d54c /MdePkg/Include/Protocol/ScsiIo.h
parentcce6f7aa66125df1bddf24c122f02093d47ef204 (diff)
downloadedk2-platforms-1f08a159034549216eccfd533b50b712d944d844.tar.xz
Fix doxygen comment for structure and macro
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6097 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/ScsiIo.h')
-rw-r--r--MdePkg/Include/Protocol/ScsiIo.h31
1 files changed, 7 insertions, 24 deletions
diff --git a/MdePkg/Include/Protocol/ScsiIo.h b/MdePkg/Include/Protocol/ScsiIo.h
index 93bbea6ba8..51840a17a8 100644
--- a/MdePkg/Include/Protocol/ScsiIo.h
+++ b/MdePkg/Include/Protocol/ScsiIo.h
@@ -218,30 +218,6 @@ EFI_STATUS
/**
@par Protocol Description:
Provides services to manage and communicate with SCSI devices.
-
- @param GetDeviceType
- Retrieves the information of the device type which the SCSI device belongs to.
-
- @param GetDeviceLocation
- Retrieves the device location information in the SCSI bus.
-
- @param ResetBus
- Resets the entire SCSI bus the SCSI device attaches to.
-
- @param ResetDevice
- Resets the SCSI Device that is specified by the device handle the SCSI I/O
- protocol attaches.
-
- @param ExecuteScsiCommand
- Sends a SCSI command to the SCSI device and waits for the execution completion
- until an exit condition is met, or a timeout occurs.
-
- @param IoAlign
- Supplies the alignment requirement for any buffer used in a data transfer.
- IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory.
- Otherwise, IoAlign must be a power of 2, and the requirement is that the
- start address of a buffer must be evenly divisible by IoAlign with no remainder.
-
**/
struct _EFI_SCSI_IO_PROTOCOL {
EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE GetDeviceType;
@@ -249,6 +225,13 @@ struct _EFI_SCSI_IO_PROTOCOL {
EFI_SCSI_IO_PROTOCOL_RESET_BUS ResetBus;
EFI_SCSI_IO_PROTOCOL_RESET_DEVICE ResetDevice;
EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand;
+
+ ///
+ /// Supplies the alignment requirement for any buffer used in a data transfer.
+ /// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory.
+ /// Otherwise, IoAlign must be a power of 2, and the requirement is that the
+ /// start address of a buffer must be evenly divisible by IoAlign with no remainder.
+ ///
UINT32 IoAlign;
};