Update comments for Protocol definitions to match UEFI spec.

[mirror_edk2.git] / MdePkg / Include / Protocol / ScsiIo.h

diff --git a/MdePkg/Include/Protocol/ScsiIo.h b/MdePkg/Include/Protocol/ScsiIo.h
index 030a06229d3677e6ad547dba7d5009b8e719a808..cf37eba5e95c048bec5d3fcd17526c9fa7bcbd5c 100644 (file)
--- a/MdePkg/Include/Protocol/ScsiIo.h
+++ b/MdePkg/Include/Protocol/ScsiIo.h
@@ -20,12 +20,12 @@
 \r
 #define EFI_SCSI_IO_PROTOCOL_GUID \\r
   { \\r
-    0x932f4736, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \\r
+    0x932f47e6, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \\r
   }\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;\r
 \r
 //\r
@@ -96,8 +96,7 @@ EFI_STATUS
 (EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE)(\r
   IN  EFI_SCSI_IO_PROTOCOL            *This,\r
   OUT UINT8                           *DeviceType\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves the device location in the SCSI channel.\r
@@ -118,8 +117,7 @@ EFI_STATUS
   IN EFI_SCSI_IO_PROTOCOL           *This,\r
   IN OUT UINT8                      **Target,\r
   OUT UINT64                        *Lun\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Resets the SCSI Bus that the SCSI Controller is attached to.\r
@@ -138,8 +136,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_BUS)(\r
   IN EFI_SCSI_IO_PROTOCOL     *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Resets the SCSI Controller that the device handle specifies.\r
@@ -159,8 +156,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_DEVICE)(\r
   IN EFI_SCSI_IO_PROTOCOL     *This\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -217,43 +213,24 @@ EFI_STATUS
   IN EFI_SCSI_IO_PROTOCOL                   *This,\r
   IN OUT  EFI_SCSI_IO_SCSI_REQUEST_PACKET   *Packet,\r
   IN EFI_EVENT                              Event  OPTIONAL\r
-  )\r
-;\r
-\r
-/**  \r
-  @par Protocol Description:\r
-  Provides services to manage and communicate with SCSI devices.\r
-\r
-  @param GetDeviceType\r
-  Retrieves the information of the device type which the SCSI device belongs to. \r
-\r
-  @param GetDeviceLocation\r
-  Retrieves the device location information in the SCSI bus. \r
-\r
-  @param ResetBus\r
-  Resets the entire SCSI bus the SCSI device attaches to. \r
+  );\r
 \r
-  @param ResetDevice\r
-  Resets the SCSI Device that is specified by the device handle the SCSI I/O \r
-  protocol attaches. \r
-\r
-  @param ExecuteScsiCommand\r
-  Sends a SCSI command to the SCSI device and waits for the execution completion \r
-  until an exit condition is met, or a timeout occurs. \r
-\r
-  @param IoAlign\r
-  Supplies the alignment requirement for any buffer used in a data transfer. \r
-  IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. \r
-  Otherwise, IoAlign must be a power of 2, and the requirement is that the \r
-  start address of a buffer must be evenly divisible by IoAlign with no remainder.\r
-\r
-**/\r
+///\r
+/// Provides services to manage and communicate with SCSI devices.\r
+///\r
 struct _EFI_SCSI_IO_PROTOCOL {\r
   EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE      GetDeviceType;\r
   EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION  GetDeviceLocation;\r
   EFI_SCSI_IO_PROTOCOL_RESET_BUS            ResetBus;\r
   EFI_SCSI_IO_PROTOCOL_RESET_DEVICE         ResetDevice;\r
   EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND    ExecuteScsiCommand;    \r
+\r
+  ///\r
+  /// Supplies the alignment requirement for any buffer used in a data transfer. \r
+  /// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. \r
+  /// Otherwise, IoAlign must be a power of 2, and the requirement is that the \r
+  /// start address of a buffer must be evenly divisible by IoAlign with no remainder.\r
+  ///\r
   UINT32                                    IoAlign;\r
 };\r
 \r