MdePkg/Include/IndustryStandard/Scsi.h

   1 /** @file
   2   support for SCSI-2 standard
   3
   4   Copyright (c) 2006, 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_REQUEST_SENSE     0x03
  37 #define EFI_SCSI_OP_SEND_DIAG         0x1d
  38 #define EFI_SCSI_OP_TEST_UNIT_READY   0x00
  39 #define EFI_SCSI_OP_WRITE_BUFF        0x3b
  40
  41 //
  42 // Commands unique to Direct Access Devices
  43 //
  44 #define EFI_SCSI_OP_COMPARE         0x39
  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_RECEIVE_DIAG    0x1c
  56 #define EFI_SCSI_OP_RELEASE         0x17
  57 #define EFI_SCSI_OP_REZERO          0x01
  58 #define EFI_SCSI_OP_SEARCH_DATA_E   0x31
  59 #define EFI_SCSI_OP_SEARCH_DATA_H   0x30
  60 #define EFI_SCSI_OP_SEARCH_DATA_L   0x32
  61 #define EFI_SCSI_OP_SEEK6           0x0b
  62 #define EFI_SCSI_OP_SEEK10          0x2b
  63 #define EFI_SCSI_OP_SEND_DIAG       0x1d
  64 #define EFI_SCSI_OP_SET_LIMIT       0x33
  65 #define EFI_SCSI_OP_START_STOP_UNIT 0x1b
  66 #define EFI_SCSI_OP_SYNC_CACHE      0x35
  67 #define EFI_SCSI_OP_VERIFY          0x2f
  68 #define EFI_SCSI_OP_WRITE6          0x0a
  69 #define EFI_SCSI_OP_WRITE10         0x2a
  70 #define EFI_SCSI_OP_WRITE_VERIFY    0x2e
  71 #define EFI_SCSI_OP_WRITE_LONG      0x3f
  72 #define EFI_SCSI_OP_WRITE_SAME      0x41
  73
  74 //
  75 // Commands unique to Sequential Access Devices
  76 //
  77 #define EFI_SCSI_OP_ERASE             0x19
  78 #define EFI_SCSI_OP_LOAD_UNLOAD       0x1b
  79 #define EFI_SCSI_OP_LOCATE            0x2b
  80 #define EFI_SCSI_OP_READ_BLOCK_LIMIT  0x05
  81 #define EFI_SCSI_OP_READ_POS          0x34
  82 #define EFI_SCSI_OP_READ_REVERSE      0x0f
  83 #define EFI_SCSI_OP_RECOVER_BUF_DATA  0x14
  84 #define EFI_SCSI_OP_RESERVE_UNIT      0x16
  85 #define EFI_SCSI_OP_REWIND            0x01
  86 #define EFI_SCSI_OP_SPACE             0x11
  87 #define EFI_SCSI_OP_VERIFY_TAPE       0x13
  88 #define EFI_SCSI_OP_WRITE_FILEMARK    0x10
  89
  90 //
  91 // Commands unique to Printer Devices
  92 //
  93 #define EFI_SCSI_OP_PRINT       0x0a
  94 #define EFI_SCSI_OP_SLEW_PRINT  0x0b
  95 #define EFI_SCSI_OP_STOP_PRINT  0x1b
  96 #define EFI_SCSI_OP_SYNC_BUFF   0x10
  97
  98 //
  99 // Commands unique to Processor Devices
 100 //
 101 #define EFI_SCSI_OP_RECEIVE 0x08
 102 #define EFI_SCSI_OP_SEND    0x0a
 103
 104 //
 105 // Commands unique to Write-Once Devices
 106 //
 107 #define EFI_SCSI_OP_MEDIUM_SCAN     0x38
 108 #define EFI_SCSI_OP_SEARCH_DAT_E10  0x31
 109 #define EFI_SCSI_OP_SEARCH_DAT_E12  0xb1
 110 #define EFI_SCSI_OP_SEARCH_DAT_H10  0x30
 111 #define EFI_SCSI_OP_SEARCH_DAT_H12  0xb0
 112 #define EFI_SCSI_OP_SEARCH_DAT_L10  0x32
 113 #define EFI_SCSI_OP_SEARCH_DAT_L12  0xb2
 114 #define EFI_SCSI_OP_SET_LIMIT10     0x33
 115 #define EFI_SCSI_OP_SET_LIMIT12     0xb3
 116 #define EFI_SCSI_OP_VERIFY10        0x2f
 117 #define EFI_SCSI_OP_VERIFY12        0xaf
 118 #define EFI_SCSI_OP_WRITE12         0xaa
 119 #define EFI_SCSI_OP_WRITE_VERIFY10  0x2e
 120 #define EFI_SCSI_OP_WRITE_VERIFY12  0xae
 121
 122 //
 123 // Commands unique to CD-ROM Devices
 124 //
 125 #define EFI_SCSI_OP_PLAY_AUD_10       0x45
 126 #define EFI_SCSI_OP_PLAY_AUD_12       0xa5
 127 #define EFI_SCSI_OP_PLAY_AUD_MSF      0x47
 128 #define EFI_SCSI_OP_PLAY_AUD_TKIN     0x48
 129 #define EFI_SCSI_OP_PLAY_TK_REL10     0x49
 130 #define EFI_SCSI_OP_PLAY_TK_REL12     0xa9
 131 #define EFI_SCSI_OP_READ_CD_CAPACITY  0x25
 132 #define EFI_SCSI_OP_READ_HEADER       0x44
 133 #define EFI_SCSI_OP_READ_SUB_CHANNEL  0x42
 134 #define EFI_SCSI_OP_READ_TOC          0x43
 135
 136 //
 137 // Commands unique to Scanner Devices
 138 //
 139 #define EFI_SCSI_OP_GET_DATABUFF_STAT 0x34
 140 #define EFI_SCSI_OP_GET_WINDOW        0x25
 141 #define EFI_SCSI_OP_OBJECT_POS        0x31
 142 #define EFI_SCSI_OP_SCAN              0x1b
 143 #define EFI_SCSI_OP_SET_WINDOW        0x24
 144
 145 //
 146 // Commands unique to Optical Memory Devices
 147 //
 148 #define EFI_SCSI_OP_UPDATE_BLOCK  0x3d
 149
 150 //
 151 // Commands unique to Medium Changer Devices
 152 //
 153 #define EFI_SCSI_OP_EXCHANGE_MEDIUM   0xa6
 154 #define EFI_SCSI_OP_INIT_ELEMENT_STAT 0x07
 155 #define EFI_SCSI_OP_POS_TO_ELEMENT    0x2b
 156 #define EFI_SCSI_OP_REQUEST_VE_ADDR   0xb5
 157 #define EFI_SCSI_OP_SEND_VOL_TAG      0xb6
 158
 159 //
 160 // Commands unique to Communition Devices
 161 //
 162 #define EFI_SCSI_OP_GET_MESSAGE6    0x08
 163 #define EFI_SCSI_OP_GET_MESSAGE10   0x28
 164 #define EFI_SCSI_OP_GET_MESSAGE12   0xa8
 165 #define EFI_SCSI_OP_SEND_MESSAGE6   0x0a
 166 #define EFI_SCSI_OP_SEND_MESSAGE10  0x2a
 167 #define EFI_SCSI_OP_SEND_MESSAGE12  0xaa
 168
 169 //
 170 // SCSI Data Transfer Direction
 171 //
 172 #define EFI_SCSI_DATA_IN  0
 173 #define EFI_SCSI_DATA_OUT 1
 174
 175 //
 176 // Peripheral Device Type Definitions
 177 //
 178 #define EFI_SCSI_TYPE_DISK          0x00  // Disk device
 179 #define EFI_SCSI_TYPE_TAPE          0x01  // Tape device
 180 #define EFI_SCSI_TYPE_PRINTER       0x02  // Printer
 181 #define EFI_SCSI_TYPE_PROCESSOR     0x03  // Processor
 182 #define EFI_SCSI_TYPE_WORM          0x04  // Write-once read-multiple
 183 #define EFI_SCSI_TYPE_CDROM         0x05  // CD-ROM device
 184 #define EFI_SCSI_TYPE_SCANNER       0x06  // Scanner device
 185 #define EFI_SCSI_TYPE_OPTICAL       0x07  // Optical memory device
 186 #define EFI_SCSI_TYPE_MEDIUMCHANGER 0x08  // Medium Changer device
 187 #define EFI_SCSI_TYPE_COMMUNICATION 0x09  // Communications device
 188 #define EFI_SCSI_TYPE_RESERVED_LOW  0x0A  // Reserved (low)
 189 #define EFI_SCSI_TYPE_RESERVED_HIGH 0x1E  // Reserved (high)
 190 #define EFI_SCSI_TYPE_UNKNOWN       0x1F  // Unknown or no device type
 191 #pragma pack(1)
 192 //
 193 // Data structures for scsi command use
 194 //
 195 typedef struct {
 196   UINT8 Peripheral_Type : 5;
 197   UINT8 Peripheral_Qualifier : 3;
 198   UINT8 DeviceType_Modifier : 7;
 199   UINT8 RMB : 1;
 200   UINT8 Version;
 201   UINT8 Response_Data_Format;
 202   UINT8 Addnl_Length;
 203   UINT8 Reserved_5_95[95 - 5 + 1];
 204 } EFI_SCSI_INQUIRY_DATA;
 205
 206 typedef struct {
 207   UINT8 Error_Code : 7;
 208   UINT8 Valid : 1;
 209   UINT8 Segment_Number;
 210   UINT8 Sense_Key : 4;
 211   UINT8 Reserved_21 : 1;
 212   UINT8 ILI : 1;
 213   UINT8 Reserved_22 : 2;
 214   UINT8 Information_3_6[4];
 215   UINT8 Addnl_Sense_Length;           // n - 7
 216   UINT8 Vendor_Specific_8_11[4];
 217   UINT8 Addnl_Sense_Code;             // mandatory
 218   UINT8 Addnl_Sense_Code_Qualifier;   // mandatory
 219   UINT8 Field_Replaceable_Unit_Code;  // optional
 220   UINT8 Reserved_15_17[3];
 221 } EFI_SCSI_SENSE_DATA;
 222
 223 typedef struct {
 224   UINT8 LastLba3;
 225   UINT8 LastLba2;
 226   UINT8 LastLba1;
 227   UINT8 LastLba0;
 228   UINT8 BlockSize3;
 229   UINT8 BlockSize2;
 230   UINT8 BlockSize1;
 231   UINT8 BlockSize0;
 232 } EFI_SCSI_DISK_CAPACITY_DATA;
 233
 234 #pragma pack()
 235 //
 236 // Sense Key
 237 //
 238 #define EFI_SCSI_REQUEST_SENSE_ERROR  (0x70)
 239 #define EFI_SCSI_SK_NO_SENSE          (0x0)
 240 #define EFI_SCSI_SK_RECOVERY_ERROR    (0x1)
 241 #define EFI_SCSI_SK_NOT_READY         (0x2)
 242 #define EFI_SCSI_SK_MEDIUM_ERROR      (0x3)
 243 #define EFI_SCSI_SK_HARDWARE_ERROR    (0x4)
 244 #define EFI_SCSI_SK_ILLEGAL_REQUEST   (0x5)
 245 #define EFI_SCSI_SK_UNIT_ATTENTION    (0x6)
 246 #define EFI_SCSI_SK_DATA_PROTECT      (0x7)
 247 #define EFI_SCSI_SK_BLANK_CHECK       (0x8)
 248 #define EFI_SCSI_SK_VENDOR_SPECIFIC   (0x9)
 249 #define EFI_SCSI_SK_RESERVED_A        (0xA)
 250 #define EFI_SCSI_SK_ABORT             (0xB)
 251 #define EFI_SCSI_SK_RESERVED_C        (0xC)
 252 #define EFI_SCSI_SK_OVERFLOW          (0xD)
 253 #define EFI_SCSI_SK_MISCOMPARE        (0xE)
 254 #define EFI_SCSI_SK_RESERVED_F        (0xF)
 255
 256 //
 257 // Additional Sense Codes
 258 //
 259 #define EFI_SCSI_ASC_NOT_READY                    (0x04)
 260 #define EFI_SCSI_ASC_MEDIA_ERR1                   (0x10)
 261 #define EFI_SCSI_ASC_MEDIA_ERR2                   (0x11)
 262 #define EFI_SCSI_ASC_MEDIA_ERR3                   (0x14)
 263 #define EFI_SCSI_ASC_MEDIA_ERR4                   (0x30)
 264 #define EFI_SCSI_ASC_MEDIA_UPSIDE_DOWN            (0x06)
 265 #define EFI_SCSI_ASC_INVALID_CMD                  (0x20)
 266 #define EFI_SCSI_ASC_LBA_OUT_OF_RANGE             (0x21)
 267 #define EFI_SCSI_ASC_INVALID_FIELD                (0x24)
 268 #define EFI_SCSI_ASC_WRITE_PROTECTED              (0x27)
 269 #define EFI_SCSI_ASC_MEDIA_CHANGE                 (0x28)
 270 #define EFI_SCSI_ASC_RESET                        (0x29)  /* Power On Reset or Bus Reset occurred */
 271 #define EFI_SCSI_ASC_ILLEGAL_FIELD                (0x26)
 272 #define EFI_SCSI_ASC_NO_MEDIA                     (0x3A)
 273 #define EFI_SCSI_ASC_ILLEGAL_MODE_FOR_THIS_TRACK  (0x64)
 274
 275 //
 276 // Additional Sense Code Qualifier
 277 //
 278 #define EFI_SCSI_ASCQ_IN_PROGRESS (0x01)
 279
 280 //
 281 // Max bytes needed to represent ID of a SCSI device
 282 //
 283 #define EFI_SCSI_TARGET_MAX_BYTES (0x10)
 284
 285 #endif