MdePkg/Include/IndustryStandard/Scsi.h

   1 /** @file
   2   Support for SCSI-2 standard
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __SCSI_H__
  16 #define __SCSI_H__
  17
  18 //
  19 // SCSI command OP Code
  20 //
  21 //
  22 // Commands for all device types
  23 //
  24 #define EFI_SCSI_OP_CHANGE_DEFINITION 0x40
  25 #define EFI_SCSI_OP_COMPARE           0x39
  26 #define EFI_SCSI_OP_COPY              0x18
  27 #define EFI_SCSI_OP_COPY_VERIFY       0x3a
  28 #define EFI_SCSI_OP_INQUIRY           0x12
  29 #define EFI_SCSI_OP_LOG_SELECT        0x4c
  30 #define EFI_SCSI_OP_LOG_SENSE         0x4d
  31 #define EFI_SCSI_OP_MODE_SEL6         0x15
  32 #define EFI_SCSI_OP_MODE_SEL10        0x55
  33 #define EFI_SCSI_OP_MODE_SEN6         0x1a
  34 #define EFI_SCSI_OP_MODE_SEN10        0x5a
  35 #define EFI_SCSI_OP_READ_BUFFER       0x3c
  36 #define EFI_SCSI_OP_RECEIVE_DIAG      0x1c
  37 #define EFI_SCSI_OP_REQUEST_SENSE     0x03
  38 #define EFI_SCSI_OP_SEND_DIAG         0x1d
  39 #define EFI_SCSI_OP_TEST_UNIT_READY   0x00
  40 #define EFI_SCSI_OP_WRITE_BUFF        0x3b
  41
  42 //
  43 // Additional commands for Direct Access Devices
  44 //
  45 #define EFI_SCSI_OP_FORMAT          0x04
  46 #define EFI_SCSI_OP_LOCK_UN_CACHE   0x36
  47 #define EFI_SCSI_OP_PREFETCH        0x34
  48 #define EFI_SCSI_OP_MEDIA_REMOVAL   0x1e
  49 #define EFI_SCSI_OP_READ6           0x08
  50 #define EFI_SCSI_OP_READ10          0x28
  51 #define EFI_SCSI_OP_READ_CAPACITY   0x25
  52 #define EFI_SCSI_OP_READ_DEFECT     0x37
  53 #define EFI_SCSI_OP_READ_LONG       0x3e
  54 #define EFI_SCSI_OP_REASSIGN_BLK    0x07
  55 #define EFI_SCSI_OP_RELEASE         0x17
  56 #define EFI_SCSI_OP_REZERO          0x01
  57 #define EFI_SCSI_OP_SEARCH_DATA_E   0x31
  58 #define EFI_SCSI_OP_SEARCH_DATA_H   0x30
  59 #define EFI_SCSI_OP_SEARCH_DATA_L   0x32
  60 #define EFI_SCSI_OP_SEEK6           0x0b
  61 #define EFI_SCSI_OP_SEEK10          0x2b
  62 #define EFI_SCSI_OP_SEND_DIAG       0x1d
  63 #define EFI_SCSI_OP_SET_LIMIT       0x33
  64 #define EFI_SCSI_OP_START_STOP_UNIT 0x1b
  65 #define EFI_SCSI_OP_SYNC_CACHE      0x35
  66 #define EFI_SCSI_OP_VERIFY          0x2f
  67 #define EFI_SCSI_OP_WRITE6          0x0a
  68 #define EFI_SCSI_OP_WRITE10         0x2a
  69 #define EFI_SCSI_OP_WRITE_VERIFY    0x2e
  70 #define EFI_SCSI_OP_WRITE_LONG      0x3f
  71 #define EFI_SCSI_OP_WRITE_SAME      0x41
  72
  73 //
  74 // Additional commands for Sequential Access Devices
  75 //
  76 #define EFI_SCSI_OP_ERASE             0x19
  77 #define EFI_SCSI_OP_LOAD_UNLOAD       0x1b
  78 #define EFI_SCSI_OP_LOCATE            0x2b
  79 #define EFI_SCSI_OP_READ_BLOCK_LIMIT  0x05
  80 #define EFI_SCSI_OP_READ_POS          0x34
  81 #define EFI_SCSI_OP_READ_REVERSE      0x0f
  82 #define EFI_SCSI_OP_RECOVER_BUF_DATA  0x14
  83 #define EFI_SCSI_OP_RESERVE_UNIT      0x16
  84 #define EFI_SCSI_OP_REWIND            0x01
  85 #define EFI_SCSI_OP_SPACE             0x11
  86 #define EFI_SCSI_OP_VERIFY_TAPE       0x13
  87 #define EFI_SCSI_OP_WRITE_FILEMARK    0x10
  88
  89 //
  90 // Additional commands for Printer Devices
  91 //
  92 #define EFI_SCSI_OP_PRINT       0x0a
  93 #define EFI_SCSI_OP_SLEW_PRINT  0x0b
  94 #define EFI_SCSI_OP_STOP_PRINT  0x1b
  95 #define EFI_SCSI_OP_SYNC_BUFF   0x10
  96
  97 //
  98 // Additional commands for Processor Devices
  99 //
 100 #define EFI_SCSI_OP_RECEIVE 0x08
 101 #define EFI_SCSI_OP_SEND    0x0a
 102
 103 //
 104 // Additional commands for Write-Once Devices
 105 //
 106 #define EFI_SCSI_OP_MEDIUM_SCAN     0x38
 107 #define EFI_SCSI_OP_SEARCH_DAT_E10  0x31
 108 #define EFI_SCSI_OP_SEARCH_DAT_E12  0xb1
 109 #define EFI_SCSI_OP_SEARCH_DAT_H10  0x30
 110 #define EFI_SCSI_OP_SEARCH_DAT_H12  0xb0
 111 #define EFI_SCSI_OP_SEARCH_DAT_L10  0x32
 112 #define EFI_SCSI_OP_SEARCH_DAT_L12  0xb2
 113 #define EFI_SCSI_OP_SET_LIMIT10     0x33
 114 #define EFI_SCSI_OP_SET_LIMIT12     0xb3
 115 #define EFI_SCSI_OP_VERIFY10        0x2f
 116 #define EFI_SCSI_OP_VERIFY12        0xaf
 117 #define EFI_SCSI_OP_WRITE12         0xaa
 118 #define EFI_SCSI_OP_WRITE_VERIFY10  0x2e
 119 #define EFI_SCSI_OP_WRITE_VERIFY12  0xae
 120
 121 //
 122 // Additional commands for CD-ROM Devices
 123 //
 124 #define EFI_SCSI_OP_PLAY_AUD_10       0x45
 125 #define EFI_SCSI_OP_PLAY_AUD_12       0xa5
 126 #define EFI_SCSI_OP_PLAY_AUD_MSF      0x47
 127 #define EFI_SCSI_OP_PLAY_AUD_TKIN     0x48
 128 #define EFI_SCSI_OP_PLAY_TK_REL10     0x49
 129 #define EFI_SCSI_OP_PLAY_TK_REL12     0xa9
 130 #define EFI_SCSI_OP_READ_CD_CAPACITY  0x25
 131 #define EFI_SCSI_OP_READ_HEADER       0x44
 132 #define EFI_SCSI_OP_READ_SUB_CHANNEL  0x42
 133 #define EFI_SCSI_OP_READ_TOC          0x43
 134
 135 //
 136 // Additional commands for Scanner Devices
 137 //
 138 #define EFI_SCSI_OP_GET_DATABUFF_STAT 0x34
 139 #define EFI_SCSI_OP_GET_WINDOW        0x25
 140 #define EFI_SCSI_OP_OBJECT_POS        0x31
 141 #define EFI_SCSI_OP_SCAN              0x1b
 142 #define EFI_SCSI_OP_SET_WINDOW        0x24
 143
 144 //
 145 // Additional commands for Optical Memory Devices
 146 //
 147 #define EFI_SCSI_OP_UPDATE_BLOCK  0x3d
 148
 149 //
 150 // Additional commands for Medium Changer Devices
 151 //
 152 #define EFI_SCSI_OP_EXCHANGE_MEDIUM   0xa6
 153 #define EFI_SCSI_OP_INIT_ELEMENT_STAT 0x07
 154 #define EFI_SCSI_OP_POS_TO_ELEMENT    0x2b
 155 #define EFI_SCSI_OP_REQUEST_VE_ADDR   0xb5
 156 #define EFI_SCSI_OP_SEND_VOL_TAG      0xb6
 157
 158 //
 159 // Additional commands for Communition Devices
 160 //
 161 #define EFI_SCSI_OP_GET_MESSAGE6    0x08
 162 #define EFI_SCSI_OP_GET_MESSAGE10   0x28
 163 #define EFI_SCSI_OP_GET_MESSAGE12   0xa8
 164 #define EFI_SCSI_OP_SEND_MESSAGE6   0x0a
 165 #define EFI_SCSI_OP_SEND_MESSAGE10  0x2a
 166 #define EFI_SCSI_OP_SEND_MESSAGE12  0xaa
 167
 168 //
 169 // SCSI Data Transfer Direction
 170 //
 171 #define EFI_SCSI_DATA_IN  0
 172 #define EFI_SCSI_DATA_OUT 1
 173
 174 //
 175 // Peripheral Device Type Definitions
 176 //
 177 #define EFI_SCSI_TYPE_DISK          0x00  ///< Direct-access device (e.g. magnetic disk)
 178 #define EFI_SCSI_TYPE_TAPE          0x01  ///< Sequential-access device (e.g. magnetic tape)
 179 #define EFI_SCSI_TYPE_PRINTER       0x02  ///< Printer device
 180 #define EFI_SCSI_TYPE_PROCESSOR     0x03  ///< Processor device
 181 #define EFI_SCSI_TYPE_WORM          0x04  ///< Write-once device (e.g. some optical disks)
 182 #define EFI_SCSI_TYPE_CDROM         0x05  ///< CD-ROM device
 183 #define EFI_SCSI_TYPE_SCANNER       0x06  ///< Scanner device
 184 #define EFI_SCSI_TYPE_OPTICAL       0x07  ///< Optical memory device (e.g. some optical disks)
 185 #define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08  ///< Medium changer device (e.g. jukeboxes)
 186 #define EFI_SCSI_TYPE_COMMUNICATION 0x09  ///< Communications device
 187 #define EFI_SCSI_TYPE_ASCIT8_1      0x0A  ///< Defined by ASC IT8 (Graphic arts pre-press devices)
 188 #define EFI_SCSI_TYPE_ASCIT8_2      0x0B  ///< Defined by ASC IT8 (Graphic arts pre-press devices)
 189 //
 190 // 0Ch - 1Eh are reserved
 191 //
 192 #define EFI_SCSI_TYPE_UNKNOWN       0x1F  ///< Unknown or no device type
 193
 194 #pragma pack(1)
 195 ///
 196 /// Standard INQUIRY data format
 197 ///
 198 typedef struct {
 199   UINT8 Peripheral_Type : 5;
 200   UINT8 Peripheral_Qualifier : 3;
 201   UINT8 DeviceType_Modifier : 7;
 202   UINT8 RMB : 1;
 203   UINT8 Version;
 204   UINT8 Response_Data_Format;
 205   UINT8 Addnl_Length;
 206   UINT8 Reserved_5_95[95 - 5 + 1];
 207 } EFI_SCSI_INQUIRY_DATA;
 208
 209 ///
 210 /// Error codes 70h and 71h sense data format
 211 ///
 212 typedef struct {
 213   UINT8 Error_Code : 7;
 214   UINT8 Valid : 1;
 215   UINT8 Segment_Number;
 216   UINT8 Sense_Key : 4;
 217   UINT8 Reserved_21 : 1;
 218   UINT8 ILI : 1;
 219   UINT8 Reserved_22 : 2;
 220   UINT8 Information_3_6[4];
 221   UINT8 Addnl_Sense_Length;           ///< Additional sense length (n-7)
 222   UINT8 Vendor_Specific_8_11[4];
 223   UINT8 Addnl_Sense_Code;             ///< Additional sense code
 224   UINT8 Addnl_Sense_Code_Qualifier;   ///< Additional sense code qualifier
 225   UINT8 Field_Replaceable_Unit_Code;  ///< Field replaceable unit code
 226   UINT8 Reserved_15_17[3];
 227 } EFI_SCSI_SENSE_DATA;
 228
 229 ///
 230 /// SCSI Disk READ CAPACITY Data
 231 ///
 232 typedef struct {
 233   UINT8 LastLba3;
 234   UINT8 LastLba2;
 235   UINT8 LastLba1;
 236   UINT8 LastLba0;
 237   UINT8 BlockSize3;
 238   UINT8 BlockSize2;
 239   UINT8 BlockSize1;
 240   UINT8 BlockSize0;
 241 } EFI_SCSI_DISK_CAPACITY_DATA;
 242
 243 #pragma pack()
 244
 245 //
 246 // Sense Key
 247 //
 248 #define EFI_SCSI_SK_NO_SENSE          (0x0)
 249 #define EFI_SCSI_SK_RECOVERY_ERROR    (0x1)
 250 #define EFI_SCSI_SK_NOT_READY         (0x2)
 251 #define EFI_SCSI_SK_MEDIUM_ERROR      (0x3)
 252 #define EFI_SCSI_SK_HARDWARE_ERROR    (0x4)
 253 #define EFI_SCSI_SK_ILLEGAL_REQUEST   (0x5)
 254 #define EFI_SCSI_SK_UNIT_ATTENTION    (0x6)
 255 #define EFI_SCSI_SK_DATA_PROTECT      (0x7)
 256 #define EFI_SCSI_SK_BLANK_CHECK       (0x8)
 257 #define EFI_SCSI_SK_VENDOR_SPECIFIC   (0x9)
 258 #define EFI_SCSI_SK_RESERVED_A        (0xA)
 259 #define EFI_SCSI_SK_ABORT             (0xB)
 260 #define EFI_SCSI_SK_RESERVED_C        (0xC)
 261 #define EFI_SCSI_SK_OVERFLOW          (0xD)
 262 #define EFI_SCSI_SK_MISCOMPARE        (0xE)
 263 #define EFI_SCSI_SK_RESERVED_F        (0xF)
 264
 265 //
 266 // Additional Sense Codes and Sense Code Qualifiers.
 267 // Only some frequently used additional sense codes and qualifiers are
 268 // defined here. Please refer to SCSI standard for full value definition.
 269 //
 270 #define EFI_SCSI_ASC_NOT_READY                    (0x04)
 271 #define EFI_SCSI_ASCQ_IN_PROGRESS                 (0x01)
 272
 273 #define EFI_SCSI_ASC_MEDIA_ERR1                   (0x10)
 274 #define EFI_SCSI_ASC_MEDIA_ERR2                   (0x11)
 275 #define EFI_SCSI_ASC_MEDIA_ERR3                   (0x14)
 276 #define EFI_SCSI_ASC_MEDIA_ERR4                   (0x30)
 277 #define EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN            (0x06)
 278 #define EFI_SCSI_ASC_INVALID_CMD                  (0x20)
 279 #define EFI_SCSI_ASC_LBA_OUT_OF_RANGE             (0x21)
 280 #define EFI_SCSI_ASC_INVALID_FIELD                (0x24)
 281 #define EFI_SCSI_ASC_WRITE_PROTECTED              (0x27)
 282 #define EFI_SCSI_ASC_MEDIA_CHANGE                 (0x28)
 283 #define EFI_SCSI_ASC_RESET                        (0x29)   ///< Power On Reset or Bus Reset occurred
 284 #define EFI_SCSI_ASC_ILLEGAL_FIELD                (0x26)
 285 #define EFI_SCSI_ASC_NO_MEDIA                     (0x3A)
 286 #define EFI_SCSI_ASC_ILLEGAL_MODE_FOR_THIS_TRACK  (0x64)
 287
 288 #endif