/** @file\r
- support for SCSI-2 standard\r
+ Support for SCSI-2 standard\r
\r
- Copyright (c) 2006, 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
-\r
- Module Name: scsi.h\r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
-#ifndef _SCSI_H\r
-#define _SCSI_H\r
+#ifndef __SCSI_H__\r
+#define __SCSI_H__\r
\r
//\r
// SCSI command OP Code\r
#define EFI_SCSI_OP_MODE_SEN6 0x1a\r
#define EFI_SCSI_OP_MODE_SEN10 0x5a\r
#define EFI_SCSI_OP_READ_BUFFER 0x3c\r
+#define EFI_SCSI_OP_RECEIVE_DIAG 0x1c\r
#define EFI_SCSI_OP_REQUEST_SENSE 0x03\r
#define EFI_SCSI_OP_SEND_DIAG 0x1d\r
#define EFI_SCSI_OP_TEST_UNIT_READY 0x00\r
#define EFI_SCSI_OP_WRITE_BUFF 0x3b\r
\r
//\r
-// Commands unique to Direct Access Devices\r
+// Additional commands for Direct Access Devices\r
//\r
-#define EFI_SCSI_OP_COMPARE 0x39\r
#define EFI_SCSI_OP_FORMAT 0x04\r
#define EFI_SCSI_OP_LOCK_UN_CACHE 0x36\r
#define EFI_SCSI_OP_PREFETCH 0x34\r
#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_RECEIVE_DIAG 0x1c\r
#define EFI_SCSI_OP_RELEASE 0x17\r
#define EFI_SCSI_OP_REZERO 0x01\r
#define EFI_SCSI_OP_SEARCH_DATA_E 0x31\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
-// Commands unique to Sequential Access Devices\r
+// Additional commands for Sequential Access Devices\r
//\r
#define EFI_SCSI_OP_ERASE 0x19\r
#define EFI_SCSI_OP_LOAD_UNLOAD 0x1b\r
#define EFI_SCSI_OP_WRITE_FILEMARK 0x10\r
\r
//\r
-// Commands unique to Printer Devices\r
+// Additional commands for Printer Devices\r
//\r
#define EFI_SCSI_OP_PRINT 0x0a\r
#define EFI_SCSI_OP_SLEW_PRINT 0x0b\r
#define EFI_SCSI_OP_SYNC_BUFF 0x10\r
\r
//\r
-// Commands unique to Processor Devices\r
+// Additional commands for Processor Devices\r
//\r
#define EFI_SCSI_OP_RECEIVE 0x08\r
#define EFI_SCSI_OP_SEND 0x0a\r
\r
//\r
-// Commands unique to Write-Once Devices\r
+// Additional commands for Write-Once Devices\r
//\r
#define EFI_SCSI_OP_MEDIUM_SCAN 0x38\r
#define EFI_SCSI_OP_SEARCH_DAT_E10 0x31\r
#define EFI_SCSI_OP_WRITE_VERIFY12 0xae\r
\r
//\r
-// Commands unique to CD-ROM Devices\r
+// Additional commands for CD-ROM Devices\r
//\r
#define EFI_SCSI_OP_PLAY_AUD_10 0x45\r
#define EFI_SCSI_OP_PLAY_AUD_12 0xa5\r
#define EFI_SCSI_OP_READ_TOC 0x43\r
\r
//\r
-// Commands unique to Scanner Devices\r
+// Additional commands for Scanner Devices\r
//\r
#define EFI_SCSI_OP_GET_DATABUFF_STAT 0x34\r
#define EFI_SCSI_OP_GET_WINDOW 0x25\r
#define EFI_SCSI_OP_SET_WINDOW 0x24\r
\r
//\r
-// Commands unique to Optical Memory Devices\r
+// Additional commands for Optical Memory Devices\r
//\r
#define EFI_SCSI_OP_UPDATE_BLOCK 0x3d\r
\r
//\r
-// Commands unique to Medium Changer Devices\r
+// Additional commands for Medium Changer Devices\r
//\r
#define EFI_SCSI_OP_EXCHANGE_MEDIUM 0xa6\r
#define EFI_SCSI_OP_INIT_ELEMENT_STAT 0x07\r
#define EFI_SCSI_OP_SEND_VOL_TAG 0xb6\r
\r
//\r
-// Commands unique to Communition Devices\r
+// Additional commands for Communition Devices\r
//\r
#define EFI_SCSI_OP_GET_MESSAGE6 0x08\r
#define EFI_SCSI_OP_GET_MESSAGE10 0x28\r
//\r
// Peripheral Device Type Definitions\r
//\r
-#define EFI_SCSI_TYPE_DISK 0x00 // Disk device\r
-#define EFI_SCSI_TYPE_TAPE 0x01 // Tape device\r
-#define EFI_SCSI_TYPE_PRINTER 0x02 // Printer\r
-#define EFI_SCSI_TYPE_PROCESSOR 0x03 // Processor\r
-#define EFI_SCSI_TYPE_WORM 0x04 // Write-once read-multiple\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\r
-#define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08 // Medium Changer device\r
-#define EFI_SCSI_TYPE_COMMUNICATION 0x09 // Communications device\r
-#define EFI_SCSI_TYPE_RESERVED_LOW 0x0A // Reserved (low)\r
-#define EFI_SCSI_TYPE_RESERVED_HIGH 0x1E // Reserved (high)\r
-#define EFI_SCSI_TYPE_UNKNOWN 0x1F // Unknown or no device type\r
-#pragma pack(1)\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
+//\r
+// 0Ch - 1Eh are reserved\r
+//\r
+#define EFI_SCSI_TYPE_UNKNOWN 0x1F ///< Unknown or no device type\r
+\r
//\r
-// Data structures for scsi command use\r
+// Page Codes for INQUIRY command\r
//\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
typedef struct {\r
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
typedef struct {\r
UINT8 Error_Code : 7;\r
UINT8 Valid : 1;\r
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; // n - 7\r
+ UINT8 Addnl_Sense_Length; ///< Additional sense length (n-7)\r
UINT8 Vendor_Specific_8_11[4];\r
- UINT8 Addnl_Sense_Code; // mandatory\r
- UINT8 Addnl_Sense_Code_Qualifier; // mandatory\r
- UINT8 Field_Replaceable_Unit_Code; // optional\r
+ UINT8 Addnl_Sense_Code; ///< Additional sense code\r
+ UINT8 Addnl_Sense_Code_Qualifier; ///< Additional sense code qualifier\r
+ UINT8 Field_Replaceable_Unit_Code; ///< Field replaceable unit code\r
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
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
-#define EFI_SCSI_REQUEST_SENSE_ERROR (0x70)\r
#define EFI_SCSI_SK_NO_SENSE (0x0)\r
#define EFI_SCSI_SK_RECOVERY_ERROR (0x1)\r
#define EFI_SCSI_SK_NOT_READY (0x2)\r
#define EFI_SCSI_SK_RESERVED_F (0xF)\r
\r
//\r
-// Additional Sense Codes\r
+// Additional Sense Codes and Sense Code Qualifiers.\r
+// Only some frequently used additional sense codes and qualifiers are\r
+// 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
+\r
#define EFI_SCSI_ASC_MEDIA_ERR1 (0x10)\r
#define EFI_SCSI_ASC_MEDIA_ERR2 (0x11)\r
#define EFI_SCSI_ASC_MEDIA_ERR3 (0x14)\r
#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
\r
-//\r
-// Additional Sense Code Qualifier\r
-//\r
-#define EFI_SCSI_ASCQ_IN_PROGRESS (0x01)\r
-\r
#endif\r