]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/ScsiIo.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / ScsiIo.h
index e0204cce22847cc1a7af562473434dd256f500ce..1e7bc86b2967252bf3938c45383d8cf2536a6c5e 100644 (file)
@@ -1,17 +1,17 @@
 /** @file\r
   EFI_SCSI_IO_PROTOCOL as defined in UEFI 2.0.\r
-  This protocol is used by code, typically drivers, running in the EFI boot \r
-  services environment to access SCSI devices. In particular, functions for \r
+  This protocol is used by code, typically drivers, running in the EFI boot\r
+  services environment to access SCSI devices. In particular, functions for\r
   managing devices on SCSI buses are defined here.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
 ///\r
 typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;\r
 \r
+//\r
+// SCSI Device type information, defined in the SCSI Primary Commands standard (e.g., SPC-4)\r
+//\r
+#define EFI_SCSI_IO_TYPE_DISK                                  0x00    ///< Disk device\r
+#define EFI_SCSI_IO_TYPE_TAPE                                  0x01    ///< Tape device\r
+#define EFI_SCSI_IO_TYPE_PRINTER                               0x02    ///< Printer\r
+#define EFI_SCSI_IO_TYPE_PROCESSOR                             0x03    ///< Processor\r
+#define EFI_SCSI_IO_TYPE_WORM                                  0x04    ///< Write-once read-multiple\r
+#define EFI_SCSI_IO_TYPE_CDROM                                 0x05    ///< CD or DVD device\r
+#define EFI_SCSI_IO_TYPE_SCANNER                               0x06    ///< Scanner device\r
+#define EFI_SCSI_IO_TYPE_OPTICAL                               0x07    ///< Optical memory device\r
+#define EFI_SCSI_IO_TYPE_MEDIUMCHANGER                         0x08    ///< Medium Changer device\r
+#define EFI_SCSI_IO_TYPE_COMMUNICATION                         0x09    ///< Communications device\r
+#define MFI_SCSI_IO_TYPE_A                                     0x0A    ///< Obsolete\r
+#define MFI_SCSI_IO_TYPE_B                                     0x0B    ///< Obsolete\r
+#define MFI_SCSI_IO_TYPE_RAID                                  0x0C    ///< Storage array controller device (e.g., RAID)\r
+#define MFI_SCSI_IO_TYPE_SES                                   0x0D    ///< Enclosure services device\r
+#define MFI_SCSI_IO_TYPE_RBC                                   0x0E    ///< Simplified direct-access device (e.g., magnetic disk)\r
+#define MFI_SCSI_IO_TYPE_OCRW                                  0x0F    ///< Optical card reader/writer device\r
+#define MFI_SCSI_IO_TYPE_BRIDGE                                0x10    ///< Bridge Controller Commands\r
+#define MFI_SCSI_IO_TYPE_OSD                                   0x11    ///< Object-based Storage Device\r
+#define EFI_SCSI_IO_TYPE_RESERVED_LOW                          0x12    ///< Reserved (low)\r
+#define EFI_SCSI_IO_TYPE_RESERVED_HIGH                         0x1E    ///< Reserved (high)\r
+#define EFI_SCSI_IO_TYPE_UNKNOWN                               0x1F    ///< Unknown no device type\r
+\r
 //\r
 // SCSI Data Direction definition\r
 //\r
@@ -140,7 +165,7 @@ typedef struct {
   @param  DeviceType A pointer to the device type information\r
                      retrieved from the SCSI Controller.\r
 \r
-  @retval EFI_SUCCESS           Retrieves the device type information successfully.\r
+  @retval EFI_SUCCESS           Retrieved the device type information successfully.\r
   @retval EFI_INVALID_PARAMETER The DeviceType is NULL.\r
 \r
 **/\r
@@ -197,7 +222,7 @@ EFI_STATUS
   @param  This Protocol instance pointer.\r
 \r
   @retval EFI_SUCCESS      Reset the SCSI controller successfully.\r
-  @retval EFI_DEVICE_ERROR Errors are encountered when resetting the\r
+  @retval EFI_DEVICE_ERROR Errors were encountered when resetting the\r
                            SCSI Controller.\r
   @retval EFI_UNSUPPORTED  The SCSI bus does not support a device\r
                            reset operation.\r
@@ -218,7 +243,7 @@ EFI_STATUS
   @param  This    Protocol instance pointer.\r
   @param  Packet  The SCSI request packet to send to the SCSI\r
                   Controller specified by the device handle.\r
-  @param  Event   If the SCSI bus where the SCSI device is attached\r
+  @param  Event   If the SCSI bus to which the SCSI device is attached\r
                   does not support non-blocking I/O, then Event is\r
                   ignored, and blocking I/O is performed.\r
                   If Event is NULL, then blocking I/O is performed.\r
@@ -229,7 +254,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS               The SCSI Request Packet was sent by the host\r
                                     successfully, and TransferLength bytes were\r
-                                    transferred to/from DataBuffer.See\r
+                                    transferred to/from DataBuffer. See\r
                                     HostAdapterStatus, TargetStatus,\r
                                     SenseDataLength, and SenseData in that order\r
                                     for additional status information.\r
@@ -276,12 +301,12 @@ struct _EFI_SCSI_IO_PROTOCOL {
   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
+  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
+  /// 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