]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/IndustryStandard/Scsi.h
MdePkg/UefiScsiLib: Set FUA bit for synchronous SCSI Write operations
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Scsi.h
index 8b7c3d48557e6cf1607e26187900178cc2a0c13a..64b9918b82a01d5f5667fb68dc65358ca1d07510 100644 (file)
@@ -1,14 +1,8 @@
 /** @file\r
   Support for SCSI-2 standard\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
-\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
+  Copyright (c) 2006 - 2020, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -48,7 +42,9 @@
 #define EFI_SCSI_OP_MEDIA_REMOVAL   0x1e\r
 #define EFI_SCSI_OP_READ6           0x08\r
 #define EFI_SCSI_OP_READ10          0x28\r
+#define EFI_SCSI_OP_READ16          0x88\r
 #define EFI_SCSI_OP_READ_CAPACITY   0x25\r
+#define EFI_SCSI_OP_READ_CAPACITY16 0x9e\r
 #define EFI_SCSI_OP_READ_DEFECT     0x37\r
 #define EFI_SCSI_OP_READ_LONG       0x3e\r
 #define EFI_SCSI_OP_REASSIGN_BLK    0x07\r
 #define EFI_SCSI_OP_VERIFY          0x2f\r
 #define EFI_SCSI_OP_WRITE6          0x0a\r
 #define EFI_SCSI_OP_WRITE10         0x2a\r
+#define EFI_SCSI_OP_WRITE16         0x8a\r
 #define EFI_SCSI_OP_WRITE_VERIFY    0x2e\r
 #define EFI_SCSI_OP_WRITE_LONG      0x3f\r
 #define EFI_SCSI_OP_WRITE_SAME      0x41\r
+#define EFI_SCSI_OP_UNMAP           0x42\r
 \r
 //\r
 // Additional commands for Sequential Access Devices\r
 #define EFI_SCSI_OP_SEND_VOL_TAG      0xb6\r
 \r
 //\r
-// Additional commands for Communition Devices\r
+// Additional commands for Communication Devices\r
 //\r
 #define EFI_SCSI_OP_GET_MESSAGE6    0x08\r
 #define EFI_SCSI_OP_GET_MESSAGE10   0x28\r
 #define EFI_SCSI_OP_SEND_MESSAGE10  0x2a\r
 #define EFI_SCSI_OP_SEND_MESSAGE12  0xaa\r
 \r
+//\r
+// Additional commands for Secure Transactions\r
+//\r
+#define EFI_SCSI_OP_SECURITY_PROTOCOL_IN  0xa2\r
+#define EFI_SCSI_OP_SECURITY_PROTOCOL_OUT 0xb5\r
+\r
 //\r
 // SCSI Data Transfer Direction\r
 //\r
 #define EFI_SCSI_DATA_IN  0\r
 #define EFI_SCSI_DATA_OUT 1\r
 \r
+//\r
+// SCSI Block Command Cache Control Parameters\r
+//\r
+#define EFI_SCSI_BLOCK_FUA  BIT3  ///< Force Unit Access\r
+#define EFI_SCSI_BLOCK_DPO  BIT4  ///< Disable Page Out\r
+\r
 //\r
 // Peripheral Device Type Definitions\r
 //\r
-#define EFI_SCSI_TYPE_DISK          0x00  ///< Direct-access device (e.g. magnetic disk)\r
-#define EFI_SCSI_TYPE_TAPE          0x01  ///< Sequential-access device (e.g. magnetic tape)\r
-#define EFI_SCSI_TYPE_PRINTER       0x02  ///< Printer device\r
-#define EFI_SCSI_TYPE_PROCESSOR     0x03  ///< Processor device\r
-#define EFI_SCSI_TYPE_WORM          0x04  ///< Write-once device (e.g. some optical disks)\r
-#define EFI_SCSI_TYPE_CDROM         0x05  ///< CD-ROM device\r
-#define EFI_SCSI_TYPE_SCANNER       0x06  ///< Scanner device\r
-#define EFI_SCSI_TYPE_OPTICAL       0x07  ///< Optical memory device (e.g. some optical disks)\r
-#define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08  ///< Medium changer device (e.g. jukeboxes)\r
-#define EFI_SCSI_TYPE_COMMUNICATION 0x09  ///< Communications device\r
-#define EFI_SCSI_TYPE_ASCIT8_1      0x0A  ///< Defined by ASC IT8 (Graphic arts pre-press devices)\r
-#define EFI_SCSI_TYPE_ASCIT8_2      0x0B  ///< Defined by ASC IT8 (Graphic arts pre-press devices)\r
+#define EFI_SCSI_TYPE_DISK            0x00  ///< Direct-access device (e.g. magnetic disk)\r
+#define EFI_SCSI_TYPE_TAPE            0x01  ///< Sequential-access device (e.g. magnetic tape)\r
+#define EFI_SCSI_TYPE_PRINTER         0x02  ///< Printer device\r
+#define EFI_SCSI_TYPE_PROCESSOR       0x03  ///< Processor device\r
+#define EFI_SCSI_TYPE_WORM            0x04  ///< Write-once device (e.g. some optical disks)\r
+#define EFI_SCSI_TYPE_CDROM           0x05  ///< CD/DVD device\r
+#define EFI_SCSI_TYPE_SCANNER         0x06  ///< Scanner device (obsolete)\r
+#define EFI_SCSI_TYPE_OPTICAL         0x07  ///< Optical memory device (e.g. some optical disks)\r
+#define EFI_SCSI_TYPE_MEDIUMCHANGER   0x08  ///< Medium changer device (e.g. jukeboxes)\r
+#define EFI_SCSI_TYPE_COMMUNICATION   0x09  ///< Communications device (obsolete)\r
+#define EFI_SCSI_TYPE_ASCIT8_1        0x0A  ///< Defined by ASC IT8 (Graphic arts pre-press devices)\r
+#define EFI_SCSI_TYPE_ASCIT8_2        0x0B  ///< Defined by ASC IT8 (Graphic arts pre-press devices)\r
+#define EFI_SCSI_TYPE_RAID            0x0C  ///< Storage array controller device (e.g., RAID)\r
+#define EFI_SCSI_TYPE_SES             0x0D  ///< Enclosure services device\r
+#define EFI_SCSI_TYPE_RBC             0x0E  ///< Simplified direct-access device (e.g., magnetic disk)\r
+#define EFI_SCSI_TYPE_OCRW            0x0F  ///< Optical card reader/writer device\r
+#define EFI_SCSI_TYPE_BRIDGE          0x10  ///< Bridge Controller Commands\r
+#define EFI_SCSI_TYPE_OSD             0x11  ///< Object-based Storage Device\r
+#define EFI_SCSI_TYPE_AUTOMATION      0x12  ///< Automation/Drive Interface\r
+#define EFI_SCSI_TYPE_SECURITYMANAGER 0x13  ///< Security manager device\r
+#define EFI_SCSI_TYPE_RESERVED_LOW    0x14  ///< Reserved (low)\r
+#define EFI_SCSI_TYPE_RESERVED_HIGH   0x1D  ///< Reserved (high)\r
+#define EFI_SCSI_TYPE_WLUN            0x1E  ///< Well known logical unit\r
+#define EFI_SCSI_TYPE_UNKNOWN         0x1F  ///< Unknown or no device type\r
+\r
 //\r
-// 0Ch - 1Eh are reserved\r
+// Page Codes for INQUIRY command\r
 //\r
-#define EFI_SCSI_TYPE_UNKNOWN       0x1F  ///< Unknown or no device type\r
+#define EFI_SCSI_PAGE_CODE_SUPPORTED_VPD    0x00\r
+#define EFI_SCSI_PAGE_CODE_BLOCK_LIMITS_VPD 0xB0\r
 \r
+#pragma pack(1)\r
 ///\r
 /// Standard INQUIRY data format\r
 ///\r
@@ -198,13 +223,94 @@ typedef struct {
   UINT8 Peripheral_Type : 5;\r
   UINT8 Peripheral_Qualifier : 3;\r
   UINT8 DeviceType_Modifier : 7;\r
-  UINT8 RMB : 1;\r
+  UINT8 Rmb : 1;\r
   UINT8 Version;\r
   UINT8 Response_Data_Format;\r
   UINT8 Addnl_Length;\r
   UINT8 Reserved_5_95[95 - 5 + 1];\r
 } EFI_SCSI_INQUIRY_DATA;\r
 \r
+///\r
+/// Supported VPD Pages VPD page\r
+///\r
+typedef struct {\r
+  UINT8 Peripheral_Type : 5;\r
+  UINT8 Peripheral_Qualifier : 3;\r
+  UINT8 PageCode;\r
+  UINT8 PageLength2;\r
+  UINT8 PageLength1;\r
+  UINT8 SupportedVpdPageList[0x100];\r
+} EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE;\r
+\r
+///\r
+/// Block Limits VPD page\r
+///\r
+typedef struct {\r
+  UINT8 Peripheral_Type : 5;\r
+  UINT8 Peripheral_Qualifier : 3;\r
+  UINT8 PageCode;\r
+  UINT8 PageLength2;\r
+  UINT8 PageLength1;\r
+  UINT8 WriteSameNonZero : 1;\r
+  UINT8 Reserved_4 : 7;\r
+  UINT8 MaximumCompareAndWriteLength;\r
+  UINT8 OptimalTransferLengthGranularity2;\r
+  UINT8 OptimalTransferLengthGranularity1;\r
+  UINT8 MaximumTransferLength4;\r
+  UINT8 MaximumTransferLength3;\r
+  UINT8 MaximumTransferLength2;\r
+  UINT8 MaximumTransferLength1;\r
+  UINT8 OptimalTransferLength4;\r
+  UINT8 OptimalTransferLength3;\r
+  UINT8 OptimalTransferLength2;\r
+  UINT8 OptimalTransferLength1;\r
+  UINT8 MaximumPrefetchXdreadXdwriteTransferLength4;\r
+  UINT8 MaximumPrefetchXdreadXdwriteTransferLength3;\r
+  UINT8 MaximumPrefetchXdreadXdwriteTransferLength2;\r
+  UINT8 MaximumPrefetchXdreadXdwriteTransferLength1;\r
+  UINT8 MaximumUnmapLbaCount4;\r
+  UINT8 MaximumUnmapLbaCount3;\r
+  UINT8 MaximumUnmapLbaCount2;\r
+  UINT8 MaximumUnmapLbaCount1;\r
+  UINT8 MaximumUnmapBlockDescriptorCount4;\r
+  UINT8 MaximumUnmapBlockDescriptorCount3;\r
+  UINT8 MaximumUnmapBlockDescriptorCount2;\r
+  UINT8 MaximumUnmapBlockDescriptorCount1;\r
+  UINT8 OptimalUnmapGranularity4;\r
+  UINT8 OptimalUnmapGranularity3;\r
+  UINT8 OptimalUnmapGranularity2;\r
+  UINT8 OptimalUnmapGranularity1;\r
+  UINT8 UnmapGranularityAlignment4 : 7;\r
+  UINT8 UnmapGranularityAlignmentValid : 1;\r
+  UINT8 UnmapGranularityAlignment3;\r
+  UINT8 UnmapGranularityAlignment2;\r
+  UINT8 UnmapGranularityAlignment1;\r
+  UINT8 MaximumWriteSameLength4;\r
+  UINT8 MaximumWriteSameLength3;\r
+  UINT8 MaximumWriteSameLength2;\r
+  UINT8 MaximumWriteSameLength1;\r
+  UINT8 MaximumAtomicTransferLength4;\r
+  UINT8 MaximumAtomicTransferLength3;\r
+  UINT8 MaximumAtomicTransferLength2;\r
+  UINT8 MaximumAtomicTransferLength1;\r
+  UINT8 AtomicAlignment4;\r
+  UINT8 AtomicAlignment3;\r
+  UINT8 AtomicAlignment2;\r
+  UINT8 AtomicAlignment1;\r
+  UINT8 AtomicTransferLengthGranularity4;\r
+  UINT8 AtomicTransferLengthGranularity3;\r
+  UINT8 AtomicTransferLengthGranularity2;\r
+  UINT8 AtomicTransferLengthGranularity1;\r
+  UINT8 MaximumAtomicTransferLengthWithAtomicBoundary4;\r
+  UINT8 MaximumAtomicTransferLengthWithAtomicBoundary3;\r
+  UINT8 MaximumAtomicTransferLengthWithAtomicBoundary2;\r
+  UINT8 MaximumAtomicTransferLengthWithAtomicBoundary1;\r
+  UINT8 MaximumAtomicBoundarySize4;\r
+  UINT8 MaximumAtomicBoundarySize3;\r
+  UINT8 MaximumAtomicBoundarySize2;\r
+  UINT8 MaximumAtomicBoundarySize1;\r
+} EFI_SCSI_BLOCK_LIMITS_VPD_PAGE;\r
+\r
 ///\r
 /// Error codes 70h and 71h sense data format\r
 ///\r
@@ -214,7 +320,7 @@ typedef struct {
   UINT8 Segment_Number;\r
   UINT8 Sense_Key : 4;\r
   UINT8 Reserved_21 : 1;\r
-  UINT8 ILI : 1;\r
+  UINT8 Ili : 1;\r
   UINT8 Reserved_22 : 2;\r
   UINT8 Information_3_6[4];\r
   UINT8 Addnl_Sense_Length;           ///< Additional sense length (n-7)\r
@@ -225,6 +331,9 @@ typedef struct {
   UINT8 Reserved_15_17[3];\r
 } EFI_SCSI_SENSE_DATA;\r
 \r
+///\r
+/// SCSI Disk READ CAPACITY Data\r
+///\r
 typedef struct {\r
   UINT8 LastLba3;\r
   UINT8 LastLba2;\r
@@ -236,6 +345,41 @@ typedef struct {
   UINT8 BlockSize0;\r
 } EFI_SCSI_DISK_CAPACITY_DATA;\r
 \r
+typedef struct {\r
+  UINT8 LastLba7;\r
+  UINT8 LastLba6;\r
+  UINT8 LastLba5;\r
+  UINT8 LastLba4;\r
+  UINT8 LastLba3;\r
+  UINT8 LastLba2;\r
+  UINT8 LastLba1;\r
+  UINT8 LastLba0;\r
+  UINT8 BlockSize3;\r
+  UINT8 BlockSize2;\r
+  UINT8 BlockSize1;\r
+  UINT8 BlockSize0;\r
+  UINT8 Protection;\r
+  UINT8 LogicPerPhysical;\r
+  UINT8 LowestAlignLogic2;\r
+  UINT8 LowestAlignLogic1;\r
+  UINT8 Reserved[16];\r
+} EFI_SCSI_DISK_CAPACITY_DATA16;\r
+\r
+typedef struct {\r
+  UINT16 DataLen;\r
+  UINT16 BlkDespDataLen;\r
+  UINT8  Reserved[4];\r
+} EFI_SCSI_DISK_UNMAP_PARAM_LIST_HEADER;\r
+\r
+typedef struct {\r
+  UINT64 Lba;\r
+  UINT32 BlockNum;\r
+  UINT8  Reserved[4];\r
+} EFI_SCSI_DISK_UNMAP_BLOCK_DESP;\r
+\r
+\r
+#pragma pack()\r
+\r
 //\r
 // Sense Key\r
 //\r
@@ -262,7 +406,7 @@ typedef struct {
 // defined here. Please refer to SCSI standard for full value definition.\r
 //\r
 #define EFI_SCSI_ASC_NOT_READY                    (0x04)\r
-#define   EFI_SCSI_ASCQ_IN_PROGRESS                 (0x01)\r
+#define EFI_SCSI_ASCQ_IN_PROGRESS                 (0x01)\r
 \r
 #define EFI_SCSI_ASC_MEDIA_ERR1                   (0x10)\r
 #define EFI_SCSI_ASC_MEDIA_ERR2                   (0x11)\r
@@ -274,7 +418,7 @@ typedef struct {
 #define EFI_SCSI_ASC_INVALID_FIELD                (0x24)\r
 #define EFI_SCSI_ASC_WRITE_PROTECTED              (0x27)\r
 #define EFI_SCSI_ASC_MEDIA_CHANGE                 (0x28)\r
-#define EFI_SCSI_ASC_RESET                        (0x29)   ///<Power On Reset or Bus Reset occurred\r
+#define EFI_SCSI_ASC_RESET                        (0x29)   ///< Power On Reset or Bus Reset occurred\r
 #define EFI_SCSI_ASC_ILLEGAL_FIELD                (0x26)\r
 #define EFI_SCSI_ASC_NO_MEDIA                     (0x3A)\r
 #define EFI_SCSI_ASC_ILLEGAL_MODE_FOR_THIS_TRACK  (0x64)\r