• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Apache NuttX
3  * Copyright 2020 The Apache Software Foundation
4  *
5  * SPDX-License-Identifier: Apache-2.0
6  */
7 #ifndef __INCLUDE_NUTTX_SCSI_H
8 #define __INCLUDE_NUTTX_SCSI_H
9 
10 /****************************************************************************
11  * Included Files
12  ****************************************************************************/
13 
14 #include <stdint.h>
15 
16 /****************************************************************************
17  * Pre-processor Definitions
18  ****************************************************************************/
19 
20 /* SCSI commands ************************************************************/
21 
22 #define SCSI_CMD_TESTUNITREADY                   0x00
23 #define SCSI_CMD_REZEROUNIT                      0x01
24 #define SCSI_CMD_REQUESTSENSE                    0x03
25 #define SCSI_CMD_FORMAT_UNIT                     0x04
26 #define SCSI_CMD_REASSIGNBLOCKS                  0x07
27 #define SCSI_CMD_READ6                           0x08
28 #define SCSI_CMD_WRITE6                          0x0a
29 #define SCSI_CMD_SEEK6                           0x0b
30 #define SCSI_CMD_SPACE6                          0x11
31 #define SCSI_CMD_INQUIRY                         0x12
32 #define SCSI_CMD_MODESELECT6                     0x15
33 #define SCSI_CMD_RESERVE6                        0x16
34 #define SCSI_CMD_RELEASE6                        0x17
35 #define SCSI_CMD_COPY                            0x18
36 #define SCSI_CMD_MODESENSE6                      0x1a
37 #define SCSI_CMD_STARTSTOPUNIT                   0x1b
38 #define SCSI_CMD_RECEIVEDIAGNOSTICRESULTS        0x1c
39 #define SCSI_CMD_SENDDIAGNOSTIC                  0x1d
40 #define SCSI_CMD_PREVENTMEDIAREMOVAL             0x1e
41 #define SCSI_CMD_READFORMATCAPACITIES            0x23
42 #define SCSI_CMD_READCAPACITY10                  0x25
43 #define SCSI_CMD_READ10                          0x28
44 #define SCSI_CMD_WRITE10                         0x2a
45 #define SCSI_CMD_SEEK10                          0x2b
46 #define SCSI_CMD_WRITEANDVERIFY                  0x2e
47 #define SCSI_CMD_VERIFY10                        0x2f
48 #define SCSI_CMD_SEARCHDATAHIGH                  0x30
49 #define SCSI_CMD_SEARCHDATAEQUAL                 0x31
50 #define SCSI_CMD_SEARCHDATALOW                   0x32
51 #define SCSI_CMD_SETLIMITS10                     0x33
52 #define SCSI_CMD_PREFETCH10                      0x34
53 #define SCSI_CMD_SYNCHCACHE10                    0x35
54 #define SCSI_CMD_LOCKCACHE                       0x36
55 #define SCSI_CMD_READDEFECTDATA10                0x37
56 #define SCSI_CMD_COMPARE                         0x39
57 #define SCSI_CMD_COPYANDVERIFY                   0x3a
58 #define SCSI_CMD_WRITEBUFFER                     0x3b
59 #define SCSI_CMD_READBUFFER                      0x3c
60 #define SCSI_CMD_READLONG10                      0x3e
61 #define SCSI_CMD_WRITELONG10                     0x3f
62 #define SCSI_CMD_CHANGEDEFINITION                0x40
63 #define SCSI_CMD_WRITESAME10                     0x41
64 #define SCSI_CMD_LOGSELECT                       0x4c
65 #define SCSI_CMD_LOGSENSE                        0x4d
66 #define SCSI_CMD_XDWRITE10                       0x50
67 #define SCSI_CMD_XPWRITE10                       0x51
68 #define SCSI_CMD_XDREAD10                        0x52
69 #define SCSI_CMD_MODESELECT10                    0x55
70 #define SCSI_CMD_RESERVE10                       0x56
71 #define SCSI_CMD_RELEASE10                       0x57
72 #define SCSI_CMD_MODESENSE10                     0x5a
73 #define SCSI_CMD_PERSISTENTRESERVEIN             0x5e
74 #define SCSI_CMD_PERSISTENTRESERVEOUT            0x5f
75 #define SCSI_CMD_32                              0x7f
76 #define SCSI_CMD_XDWRITEEXTENDED                 0x80
77 #define SCSI_CMD_REBUILD                         0x82
78 #define SCSI_CMD_REGENERATE                      0x82
79 #define SCSI_CMD_EXTENDEDCOPY                    0x83
80 #define SCSI_CMD_COPYRESULTS                     0x84
81 #define SCSI_CMD_ACCESSCONTROLIN                 0x86
82 #define SCSI_CMD_ACCESSCONTROLOUT                0x87
83 #define SCSI_CMD_READ16                          0x88
84 #define SCSI_CMD_WRITE16                         0x8a
85 #define SCSI_CMD_READATTRIBUTE                   0x8c
86 #define SCSI_CMD_WRITEATTRIBUTE                  0x8d
87 #define SCSI_CMD_WRITEANDVERIFY16                0x8e
88 #define SCSI_CMD_PREFETCH16                      0x90
89 #define SCSI_CMD_SYNCHCACHE16                    0x91
90 #define SCSI_CMD_LOCKUNLOCKACACHE                0x92
91 #define SCSI_CMD_WRITESAME16                     0x93
92 #define SCSI_CMD_READCAPACITY16                  0x9e
93 #define SCSI_CMD_READLONG16                      0x9e
94 #define SCSI_CMD_WRITELONG106                    0x9f
95 #define SCSI_CMD_REPORTLUNS                      0xa0
96 #define SCSI_CMD_MAINTENANCEIN                   0xa3
97 #define SCSI_CMD_MAINTENANCEOUT                  0xa4
98 #define SCSI_CMD_MOVEMEDIUM                      0xa5
99 #define SCSI_CMD_MOVEMEDIUMATTACHED              0xa7
100 #define SCSI_CMD_READ12                          0xa8
101 #define SCSI_CMD_WRITE12                         0xaa
102 #define SCSI_CMD_READMEDIASERIALNUMBER           0xab
103 #define SCSI_CMD_WRITEANDVERIFY12                0xae
104 #define SCSI_CMD_VERIFY12                        0xaf
105 #define SCSI_CMD_SETLIMITS12                     0xb3
106 #define SCSI_CMD_READELEMENTSTATUS               0xb4
107 #define SCSI_CMD_READDEFECTDATA12                0xb7
108 #define SCSI_CMD_REDUNDANCYGROUPIN               0xba
109 #define SCSI_CMD_REDUNDANCYGROUPOUT              0xbb
110 #define SCSI_CMD_SPAREIN                         0xbc
111 #define SCSI_CMD_SPAREOUT                        0xbd
112 #define SCSI_CMD_VOLUMESETIN                     0xbe
113 #define SCSI_CMD_VOLUMESETOUT                    0xbf
114 
115 /* Common SCSI KCQ values (sense Key/additional sense Code/ASC Qualifier) ***
116  *
117  *   0xnn0386  Write Fault Data Corruption
118  *   0xnn0500  Illegal request
119  *   0xnn0600  Unit attention
120  *   0xnn0700  Data protect
121  *   0xnn0800  LUN communication failure
122  *   0xnn0801  LUN communication timeout
123  *   0xnn0802  LUN communication parity error
124  *   0xnn0803  LUN communication CRC error
125  *   0xnn0900  vendor specific sense key
126  *   0xnn0901  servo fault
127  *   0xnn0904  head select fault
128  *   0xnn0a00  error log overflow
129  *   0xnn0b00  aborted command
130  *   0xnn0c00  write error
131  *   0xnn0c02  write error - auto-realloc failed
132  *   0xnn0e00  data miscompare
133  *   0xnn1200  address mark not founf for ID field
134  *   0xnn1400  logical block not found
135  *   0xnn1500  random positioning error
136  *   0xnn1501  mechanical positioning error
137  *   0xnn1502  positioning error detected by read of medium
138  *   0xnn2700  write protected
139  *   0xnn2900  POR or bus reset occurred
140  *   0xnn3101  format failed
141  *   0xnn3191  format corrupted
142  *   0xnn3201  defect list update error
143  *   0xnn3202  no spares available
144  *   0xnn3501  unspecified enclosure services failure
145  *   0xnn3700  parameter rounded
146  *   0xnn3d00  invalid bits in identify message
147  *   0xnn3e00  LUN not self-configured yet
148  *   0xnn4001  DRAM parity error
149  *   0xnn4002  DRAM parity error
150  *   0xnn4200  power-on or self-test failure
151  *   0xnn4c00  LUN failed self-configuration
152  *   0xnn5c00  RPL status change
153  *   0xnn5c01  spindles synchronized
154  *   0xnn5c02  spindles not synchronized
155  *   0xnn6500  voltage fault
156  *   0xnn8000  general firmware error
157  */
158 
159 /* No sense KCQ values */
160 
161 #define SCSI_KCQ_NOSENSE                         0x000000  /* No error */
162 #define SCSI_KCQ_PFATHRESHOLDREACHED             0x005c00  /* No sense - PFA threshold reached */
163 
164 /* Soft error KCQ values */
165 
166 #define SCSI_KCQSE_RWENOINDEX                    0x010100  /* Recovered Write error - no index */
167 #define SCSI_KCQSE_RECOVEREDNOSEEKCOMPLETION     0x010200  /* Recovered no seek completion */
168 #define SCSI_KCQSE_RWEWRITEFAULT                 0x010300  /* Recovered Write error - write fault */
169 #define SCSI_KCQSE_TRACKFOLLOWINGERROR           0x010900  /* Track following error */
170 #define SCSI_KCQSE_TEMPERATUREWARNING            0x010b01  /* Temperature warning */
171 #define SCSI_KCQSE_RWEWARREALLOCATED             0x010c01  /* Recovered Write error with auto-realloc - reallocated */
172 #define SCSI_KCQSE_RWERECOMMENDREASSIGN          0x010c03  /* Recovered Write error - recommend reassign */
173 #define SCSI_KCQSE_RDWOEUSINGPREVLBI             0x011201  /* Recovered data without ECC using prev logical block ID */
174 #define SCSI_KCQSE_RDWEUSINGPREVLBI              0x011202  /* Recovered data with ECC using prev logical block ID */
175 #define SCSI_KCQSE_RECOVEREDRECORDNOTFOUND       0x011401  /* Recovered Record Not Found */
176 #define SCSI_KCQSE_RWEDSME                       0x011600  /* Recovered Write error - Data Sync Mark Error */
177 #define SCSI_KCQSE_RWEDSEDATAREWRITTEN           0x011601  /* Recovered Write error - Data Sync Error - data rewritten */
178 #define SCSI_KCQSE_RWEDSERECOMMENDREWRITE        0x011602  /* Recovered Write error - Data Sync Error - recommend rewrite */
179 #define SCSI_KCQSE_RWEDSEDATAAUTOREALLOCATED     0x011603  /* Recovered Write error - Data Sync Error - data auto-reallocated */
180 #define SCSI_KCQSE_RWEDSERECOMMENDREASSIGNMENT   0x011604  /* Recovered Write error - Data Sync Error - recommend reassignment */
181 #define SCSI_KCQSE_RDWNECORRECTIONAPPLIED        0x011700  /* Recovered data with no error correction applied */
182 #define SCSI_KCQSE_RREWITHRETRIES                0x011701  /* Recovered Read error - with retries */
183 #define SCSI_KCQSE_RDUSINGPOSITIVEOFFSET         0x011702  /* Recovered data using positive offset */
184 #define SCSI_KCQSE_RDUSINGNEGATIVEOFFSET         0x011703  /* Recovered data using negative offset */
185 #define SCSI_KCQSE_RDUSINGPREVIOUSLBI            0x011705  /* Recovered data using previous logical block ID */
186 #define SCSI_KCQSE_RREWOEAUTOREALLOCATED         0x011706  /* Recovered Read error - without ECC, auto reallocated */
187 #define SCSI_KCQSE_RREWOERECOMMENDREASSIGN       0x011707  /* Recovered Read error - without ECC, recommend reassign */
188 #define SCSI_KCQSE_RREWOERECOMMENDREWRITE        0x011708  /* Recovered Read error - without ECC, recommend rewrite */
189 #define SCSI_KCQSE_RREWOEDATAREWRITTEN           0x011709  /* Recovered Read error - without ECC, data rewritten */
190 #define SCSI_KCQSE_RREWE                         0x011800  /* Recovered Read error - with ECC */
191 #define SCSI_KCQSE_RDWEANDRETRIES                0x011801  /* Recovered data with ECC and retries */
192 #define SCSI_KCQSE_RREWEAUTOREALLOCATED          0x011802  /* Recovered Read error - with ECC, auto reallocated */
193 #define SCSI_KCQSE_RREWERECOMMENDREASSIGN        0x011805  /* Recovered Read error - with ECC, recommend reassign */
194 #define SCSI_KCQSE_RDUSINGECCANDOFFSETS          0x011806  /* Recovered data using ECC and offsets */
195 #define SCSI_KCQSE_RREWEDATAREWRITTEN            0x011807  /* Recovered Read error - with ECC, data rewritten */
196 #define SCSI_KCQSE_DLNOTFOUND                    0x011c00  /* Defect List not found */
197 #define SCSI_KCQSE_PRIMARYDLNOTFOUND             0x011c01  /* Primary defect list not found */
198 #define SCSI_KCQSE_GROWNDLNOTFOUND               0x011c02  /* Grown defect list not found */
199 #define SCSI_KCQSE_PARTIALDLTRANSFERRED          0x011f00  /* Partial defect list transferred */
200 #define SCSI_KCQSE_INTERNALTARGETFAILURE         0x014400  /* Internal target failure */
201 #define SCSI_KCQSE_PFATHRESHOLDREACHED           0x015d00  /* PFA threshold reached */
202 #define SCSI_KCQSE_PFATESTWARNING                0x015dff  /* PFA test warning */
203 #define SCSI_KCQSE_INTERNALLOGICFAILURE          0x018100  /* Internal logic failure */
204 
205 /* Not Ready / Diagnostic Failure KCQ values */
206 
207 #define SCSI_KCQNR_CAUSENOTREPORTABLE            0x020400  /* Not Ready - Cause not reportable. */
208 #define SCSI_KCQNR_BECOMINGREADY                 0x020401  /* Not Ready - becoming ready */
209 #define SCSI_KCQNR_NEEDINITIALIZECOMMAND         0x020402  /* Not Ready - need initialize command (start unit) */
210 #define SCSI_KCQNR_MANUALINTERVENTIONREQUIRED    0x020403  /* Not Ready - manual intervention required */
211 #define SCSI_KCQNR_FORMATINPROGRESS              0x020404  /* Not Ready - format in progress */
212 #define SCSI_KCQNR_SELFTESTINPROGRESS            0x020409  /* Not Ready - self-test in progress */
213 #define SCSI_KCQNR_MEDIUMFORMATCORRUPTED         0x023100  /* Not Ready - medium format corrupted */
214 #define SCSI_KCQNR_FORMATCOMMANDFAILED           0x023101  /* Not Ready - format command failed */
215 #define SCSI_KCQNR_ESUNAVAILABLE                 0x023502  /* Not Ready - enclosure services unavailable */
216 #define SCSI_KCQNR_MEDIANOTPRESENT               0x023a00  /* Not Ready - media not present */
217 #define SCSI_KCQDF_BRINGUPFAILORDEGRADEDMODE     0x024080  /* Diagnostic Failure - bring-up fail or degraded mode */
218 #define SCSI_KCQDF_HARDDISKCONTROLLER            0x024081  /* Diagnostic Failure - Hard Disk Controller */
219 #define SCSI_KCQDF_RAMMICROCODENOTLOADED         0x024085  /* Diagnostic Failure - RAM microcode not loaded */
220 #define SCSI_KCQDF_RROCALIBRATION                0x024090  /* Diagnostic Failure - RRO Calibration */
221 #define SCSI_KCQDF_CHANNELCALIBRATION            0x024091  /* Diagnostic Failure - Channel Calibration */
222 #define SCSI_KCQDF_HEADLOAD                      0x024092  /* Diagnostic Failure - Head Load */
223 #define SCSI_KCQDF_WRITEAE                       0x024093  /* Diagnostic Failure - Write AE */
224 #define SCSI_KCQDF_12VOVERCURRENT                0x024094  /* Diagnostic Failure - 12V over current */
225 #define SCSI_KCQDF_OTHERSPINDLEFAILURE           0x024095  /* Diagnostic Failure - Other spindle failure */
226 #define SCSI_KCQDF_SELFRESET                     0x0240b0  /* Diagnostic Failure - self-reset */
227 #define SCSI_KCQDF_CONFIGNOTLOADED               0x024c00  /* Diagnostic Failure - config not loaded */
228 
229 /* Medium error KCQ values */
230 
231 #define SCSI_KCQME_WRITEFAULT                    0x030300  /* Medium Error - write fault */
232 #define SCSI_KCQME_WRITEFAULTAUTOREALLOCFAILED   0x030c02  /* Medium Error - write error - auto-realloc failed */
233 #define SCSI_KCQME_WRITERTLIMITEXCEEDED          0x030cbb  /* Medium Error - write recovery time limit exceeded */
234 #define SCSI_KCQME_IDCRCERROR                    0x031000  /* Medium Error - ID CRC error */
235 #define SCSI_KCQME_UNRRE1                        0x031100  /* Medium Error - unrecovered read error */
236 #define SCSI_KCQME_READRETRIESEXHAUSTED          0x031101  /* Medium Error - read retries exhausted */
237 #define SCSI_KCQME_ERRORTOOLONGTOCORRECT         0x031102  /* Medium Error - error too long to correct */
238 #define SCSI_KCQME_UREAUTOREALLOCFAILED          0x031104  /* Medium Error - unrecovered read error - auto re-alloc failed */
239 #define SCSI_KCQME_URERECOMMENDREASSIGN          0x03110b  /* Medium Error - unrecovered read error - recommend reassign */
240 #define SCSI_KCQME_READRTLIMITEXCEEDED           0x0311ff  /* Medium Error - read recovery time limit exceeded */
241 #define SCSI_KCQME_RECORDNOTFOUND                0x031401  /* Medium Error - record not found */
242 #define SCSI_KCQME_DSME                          0x031600  /* Medium Error - Data Sync Mark error */
243 #define SCSI_KCQME_DSERECOMMENDREASSIGN          0x031604  /* Medium Error - Data Sync Error - recommend reassign */
244 #define SCSI_KCQME_DLE                           0x031900  /* Medium Error - defect list error */
245 #define SCSI_KCQME_DLNOTAVAILABLE                0x031901  /* Medium Error - defect list not available */
246 #define SCSI_KCQME_DLEINPRIMARYLIST              0x031902  /* Medium Error - defect list error in primary list */
247 #define SCSI_KCQME_DLEINGROWNLIST                0x031903  /* Medium Error - defect list error in grown list */
248 #define SCSI_KCQME_FEWERTHAN50PCTDLCOPIES        0x03190e  /* Medium Error - fewer than 50% defect list copies */
249 #define SCSI_KCQME_MEDIUMFORMATCORRUPTED         0x033100  /* Medium Error - medium format corrupted */
250 #define SCSI_KCQME_FORMATCOMMANDFAILED           0x033101  /* Medium Error - format command failed */
251 #define SCSI_KCQME_DATAAUTOREALLOCATED           0x038000  /* Medium Error - data auto-reallocated */
252 
253 /* Hardware Error KCQ values */
254 
255 #define SCSI_KCQHE_NOINDEXORSECTOR               0x040100  /* Hardware Error - no index or sector */
256 #define SCSI_KCQHE_NOSEEKCOMPLETE                0x040200  /* Hardware Error - no seek complete */
257 #define SCSI_KCQHE_WRITEFAULT                    0x040300  /* Hardware Error - write fault */
258 #define SCSI_KCQHE_COMMUNICATIONFAILURE          0x040800  /* Hardware Error - communication failure */
259 #define SCSI_KCQHE_TRACKFOLLOWINGERROR           0x040900  /* Hardware Error - track following error */
260 #define SCSI_KCQHE_UREINRESERVEDAREA             0x041100  /* Hardware Error - unrecovered read error in reserved area */
261 #define SCSI_KCQHE_DSMEINRESERVEDAREA            0x041600  /* Hardware Error - Data Sync Mark error in reserved area */
262 #define SCSI_KCQHE_DLE                           0x041900  /* Hardware Error - defect list error */
263 #define SCSI_KCQHE_DLEINPRIMARYLIST              0x041902  /* Hardware Error - defect list error in Primary List */
264 #define SCSI_KCQHE_DLEINGROWNLIST                0x041903  /* Hardware Error - defect list error in Grown List */
265 #define SCSI_KCQHE_REASSIGNFAILED                0x043100  /* Hardware Error - reassign failed */
266 #define SCSI_KCQHE_NODEFECTSPAREAVAILABLE        0x043200  /* Hardware Error - no defect spare available */
267 #define SCSI_KCQHE_UNSUPPORTEDENCLOSUREFUNCTION  0x043501  /* Hardware Error - unsupported enclosure function */
268 #define SCSI_KCQHE_ESUNAVAILABLE                 0x043502  /* Hardware Error - enclosure services unavailable */
269 #define SCSI_KCQHE_ESTRANSFERFAILURE             0x043503  /* Hardware Error - enclosure services transfer failure */
270 #define SCSI_KCQHE_ESREFUSED                     0x043504  /* Hardware Error - enclosure services refused */
271 #define SCSI_KCQHE_SELFTESTFAILED                0x043e03  /* Hardware Error - self-test failed */
272 #define SCSI_KCQHE_UNABLETOUPDATESELFTEST        0x043e04  /* Hardware Error - unable to update self-test */
273 #define SCSI_KCQHE_DMDIAGNOSTICFAIL              0x044080  /* Hardware Error - Degrade Mode. Diagnostic Fail */
274 #define SCSI_KCQHE_DMHWERROR                     0x044081  /* Hardware Error - Degrade Mode. H/W Error */
275 #define SCSI_KCQHE_DMRAMMICROCODENOTLOADED       0x044085  /* Hardware Error - Degrade Mode. RAM microcode not loaded */
276 #define SCSI_KCQHE_SEEKTESTFAILURE               0x044090  /* Hardware Error - seek test failure */
277 #define SCSI_KCQHE_READWRITETESTFAILURE          0x0440a0  /* Hardware Error - read/write test failure */
278 #define SCSI_KCQHE_DEVICESELFRESET               0x0440b0  /* Hardware Error - device self-reset */
279 #define SCSI_KCQHE_COMPONENTMISMATCH             0x0440d0  /* Hardware Error - component mismatch */
280 #define SCSI_KCQHE_INTERNALTARGETFAILURE         0x044400  /* Hardware Error - internal target failure */
281 #define SCSI_KCQHE_INTERNALLOGICERROR            0x048100  /* Hardware Error - internal logic error */
282 #define SCSI_KCQHE_COMMANDTIMEOUT                0x048200  /* Hardware Error - command timeout */
283 
284 /* Illegal Request KCQ values */
285 
286 #define SCSI_KCQIR_PARMLISTLENGTHERROR           0x051a00  /* Illegal Request - parm list length error */
287 #define SCSI_KCQIR_INVALIDCOMMAND                0x052000  /* Illegal Request - invalid/unsupported command code */
288 #define SCSI_KCQIR_LBAOUTOFRANGE                 0x052100  /* Illegal Request - LBA out of range */
289 #define SCSI_KCQIR_INVALIDFIELDINCBA             0x052400  /* Illegal Request - invalid field in CDB (Command Descriptor Block) */
290 #define SCSI_KCQIR_INVALIDLUN                    0x052500  /* Illegal Request - invalid LUN */
291 #define SCSI_KCQIR_INVALIDFIELDSINPARMLIST       0x052600  /* Illegal Request - invalid fields in parm list */
292 #define SCSI_KCQIR_PARAMETERNOTSUPPORTED         0x052601  /* Illegal Request - parameter not supported */
293 #define SCSI_KCQIR_INVALIDPARMVALUE              0x052602  /* Illegal Request - invalid parm value */
294 #define SCSI_KCQIR_IFPTHRESHOLDPARAMETER         0x052603  /* Illegal Request - invalid field parameter - threshold parameter */
295 #define SCSI_KCQIR_INVALIDRELEASEOFPR            0x052604  /* Illegal Request - invalid release of persistent reservation */
296 #define SCSI_KCQIR_IFPTMSFIRMWARETAG             0x052697  /* Illegal Request - invalid field parameter - TMS firmware tag */
297 #define SCSI_KCQIR_IFPCHECKSUM                   0x052698  /* Illegal Request - invalid field parameter - check sum */
298 #define SCSI_KCQIR_IFPFIRMWARETAG                0x052699  /* Illegal Request - invalid field parameter - firmware tag */
299 #define SCSI_KCQIR_COMMANDSEQUENCEERROR          0x052c00  /* Illegal Request - command sequence error */
300 #define SCSI_KCQIR_UNSUPPORTEDENCLOSUREFUNCTION  0x053501  /* Illegal Request - unsupported enclosure function */
301 #define SCSI_KCQIR_SAVINGPARMSNOTSUPPORTED       0x053900  /* Illegal Request - Saving parameters not supported */
302 #define SCSI_KCQIR_INVALIDMESSAGE                0x054900  /* Illegal Request - invalid message */
303 #define SCSI_KCQIR_MEDIALOADOREJECTFAILED        0x055300  /* Illegal Request - media load or eject failed */
304 #define SCSI_KCQIR_UNLOADTAPEFAILURE             0x055301  /* Illegal Request - unload tape failure */
305 #define SCSI_KCQIR_MEDIUMREMOVALPREVENTED        0x055302  /* Illegal Request - medium removal prevented */
306 #define SCSI_KCQIR_SYSTEMRESOURCEFAILURE         0x055500  /* Illegal Request - system resource failure */
307 #define SCSI_KCQIR_SYSTEMBUFFERFULL              0x055501  /* Illegal Request - system buffer full */
308 #define SCSI_KCQIR_INSUFFICIENTRR                0x055504  /* Illegal Request - Insufficient Registration Resources */
309 
310 /* Unit Attention KCQ values */
311 
312 #define SCSI_KCQUA_NOTREADYTOTRANSITION          0x062800  /* Unit Attention - not-ready to ready transition (format complete) */
313 #define SCSI_KCQUA_DEVICERESETOCCURRED           0x062900  /* Unit Attention - POR or device reset occurred */
314 #define SCSI_KCQUA_POROCCURRED                   0x062901  /* Unit Attention - POR occurred */
315 #define SCSI_KCQUA_SCSIBUSRESETOCCURRED          0x062902  /* Unit Attention - SCSI bus reset occurred */
316 #define SCSI_KCQUA_TARGETRESETOCCURRED           0x062903  /* Unit Attention - TARGET RESET occurred */
317 #define SCSI_KCQUA_SELFINITIATEDRESETOCCURRED    0x062904  /* Unit Attention - self-initiated-reset occurred */
318 #define SCSI_KCQUA_TRANSCEIVERMODECHANGETOSE     0x062905  /* Unit Attention - transceiver mode change to SE */
319 #define SCSI_KCQUA_TRANSCEIVERMODECHANGETOLVD    0x062906  /* Unit Attention - transceiver mode change to LVD */
320 #define SCSI_KCQUA_PARAMETERSCHANGED             0x062a00  /* Unit Attention - parameters changed */
321 #define SCSI_KCQUA_MODEPARAMETERSCHANGED         0x062a01  /* Unit Attention - mode parameters changed */
322 #define SCSI_KCQUA_LOGSELECTPARMSCHANGED         0x062a02  /* Unit Attention - log select parms changed */
323 #define SCSI_KCQUA_RESERVATIONSPREEMPTED         0x062a03  /* Unit Attention - Reservations pre-empted */
324 #define SCSI_KCQUA_RESERVATIONSRELEASED          0x062a04  /* Unit Attention - Reservations released */
325 #define SCSI_KCQUA_REGISTRATIONSPREEMPTED        0x062a05  /* Unit Attention - Registrations pre-empted */
326 #define SCSI_KCQUA_COMMANDSCLEARED               0x062f00  /* Unit Attention - commands cleared by another initiator */
327 #define SCSI_KCQUA_OPERATINGCONDITIONSCHANGED    0x063f00  /* Unit Attention - target operating conditions have changed */
328 #define SCSI_KCQUA_MICROCODECHANGED              0x063f01  /* Unit Attention - microcode changed */
329 #define SCSI_KCQUA_CHANGEDOPERATINGDEFINITION    0x063f02  /* Unit Attention - changed operating definition */
330 #define SCSI_KCQUA_INQUIRYPARAMETERSCHANGED      0x063f03  /* Unit Attention - inquiry parameters changed */
331 #define SCSI_KCQUA_DEVICEIDENTIFIERCHANGED       0x063f05  /* Unit Attention - device identifier changed */
332 #define SCSI_KCQUA_INVALIDAPMPARAMETERS          0x063f90  /* Unit Attention - invalid APM parameters */
333 #define SCSI_KCQUA_WORLDWIDENAMEMISMATCH         0x063f91  /* Unit Attention - world-wide name mismatch */
334 #define SCSI_KCQUA_PFATHRESHOLDREACHED           0x065d00  /* Unit Attention - PFA threshold reached */
335 #define SCSI_KCQUA_PFATHRESHOLDEXCEEDED          0x065dff  /* Unit Attention - PFA threshold exceeded */
336 
337 /* Write Protect KCQ values */
338 
339 #define SCSI_KCQWP_COMMANDNOTALLOWED             0x072700 /* Write Protect - command not allowed */
340 
341 /* Aborted Command KCQ values */
342 
343 #define SCSI_KCQAC_NOADDITIONALSENSECODE         0x0b0000  /* Aborted Command - no additional sense code */
344 #define SCSI_KCQAC_SYNCDATATRANSFERERROR         0x0b1b00  /* Aborted Command - sync data transfer error (extra ACK) */
345 #define SCSI_KCQAC_UNSUPPORTEDLUN                0x0b2500  /* Aborted Command - unsupported LUN */
346 #define SCSI_KCQAC_ECHOBUFFEROVERWRITTEN         0x0b3f0f  /* Aborted Command - echo buffer overwritten */
347 #define SCSI_KCQAC_MESSAGEREJECTERROR            0x0b4300  /* Aborted Command - message reject error */
348 #define SCSI_KCQAC_INTERNALTARGETFAILURE         0x0b4400  /* Aborted Command - internal target failure */
349 #define SCSI_KCQAC_SELECTIONFAILURE              0x0b4500  /* Aborted Command - Selection/Reselection failure */
350 #define SCSI_KCQAC_SCSIPARITYERROR               0x0b4700  /* Aborted Command - SCSI parity error */
351 #define SCSI_KCQAC_INITIATORDETECTEDERRORECEIVED 0x0b4800  /* Aborted Command - initiator-detected error message received */
352 #define SCSI_KCQAC_ILLEGALMESSAGE                0x0b4900  /* Aborted Command - inappropriate/illegal message */
353 #define SCSI_KCQAC_DATAPHASEERROR                0x0b4b00  /* Aborted Command - data phase error */
354 #define SCSI_KCQAC_OVERLAPPEDCOMMANDSATTEMPTED   0x0b4e00  /* Aborted Command - overlapped commands attempted */
355 #define SCSI_KCQAC_LOOPINITIALIZATION            0x0b4f00  /* Aborted Command - due to loop initialization */
356 
357 /* Other KCQ values: */
358 
359 #define SCSO_KCQOTHER_MISCOMPARE                 0x0e1d00  /* Miscompare - during verify byte check operation */
360 
361 /* SSCSI Status Codes *******************************************************/
362 
363 #define SCSI_STATUS_OK                           0x00  /* OK */
364 #define SCSI_STATUS_CHECKCONDITION               0x02  /* Check condition */
365 #define SCSI_STATUS_CONDITIONMET                 0x04  /* Condition met */
366 #define SCSI_STATUS_BUSY                         0x08  /* Busy */
367 #define SCSI_STATUS_INTERMEDIATE                 0x10  /* Intermediate */
368 #define SCSI_STATUS_DATAOVERUNDERRUN             0x12  /* Data Under/Over Run? */
369 #define SCSI_STATUS_INTERMEDIATECONDITIONMET     0x14  /* Intermediate - Condition met */
370 #define SCSI_STATUS_RESERVATIONCONFLICT          0x18  /* Reservation conflict */
371 #define SCSI_STATUS_COMMANDTERMINATED            0x22  /* Command terminated */
372 #define SCSI_STATUS_QUEUEFULL                    0x28  /* Queue (task set) full */
373 #define SCSI_STATUS_ACAACTIVE                    0x30  /* ACA active */
374 #define SCSI_STATUS_TASKABORTED                  0x40  /* Task aborted */
375 
376 /* Definitions for selected SCSI commands ***********************************/
377 
378 /* Inquiry */
379 
380 #define SCSICMD_INQUIRYFLAGS_EVPD                0x01  /* Bit 0: EVPD */
381                                                        /* Bits 5-7: Peripheral Qualifier */
382 #define SCSIRESP_INQUIRYPQ_CONNECTED             0x00  /*   000: Device is connected */
383 #define SCSIRESP_INQUIRYPQ_NOTCONNECTED          0x20  /*   001: Device is NOT connected */
384 #define SCSIRESP_INQUIRYPQ_NOTCAPABLE            0x60  /*   011: LUN not supported */
385                                                        /* Bits 0-4: Peripheral Device */
386 #define SCSIRESP_INQUIRYPD_DIRECTACCESS          0x00  /*   Direct-access block device */
387 #define SCSIRESP_INQUIRYPD_SEQUENTIALACCESS      0x01  /*   Sequential-access block device */
388 #define SCSIRESP_INQUIRYPD_PRINTER               0x02  /*   Printer device */
389 #define SCSIRESP_INQUIRYPD_PROCESSOR             0x03  /*   Processor device */
390 #define SCSIRESP_INQUIRYPD_WRONCE                0x04  /*   Write once device */
391 #define SCSIRESP_INQUIRYPD_CDDVD                 0x05  /*   CD/DVD device */
392 #define SCSIRESP_INQUIRYPD_SCANNER               0x06  /*   Scanner device (obsolete) */
393 #define SCSIRESP_INQUIRYPD_OPTICAL               0x07  /*   Optical memory device */
394 #define SCSIRESP_INQUIRYPD_MEDIUMCHANGER         0x08  /*   Medium changer device (Jukebox) */
395 #define SCSIRESP_INQUIRYPD_COMMUNICATIONS        0x09  /*   Communications device (obsolete) */
396 #define SCSIRESP_INQUIRYPD_STORAGEARRAY          0x0c  /*   Storage array controller device */
397 #define SCSIRESP_INQUIRYPD_ENCLOSURESERVICES     0x0d  /*   Enclosure services device */
398 #define SCSIRESP_INQUIRYPD_RBC                   0x0e  /*   Simplified direct-access device */
399 #define SCSIRESP_INQUIRYPD_OCRW                  0x0f  /*   Optical reader/writer device */
400 #define SCSIRESP_INQUIRYPD_BCC                   0x10  /*   Bridge controller commands */
401 #define SCSIRESP_INQUIRYPD_OSD                   0x11  /*   Object-based storage device */
402 #define SCSIRESP_INQUIRYPD_ADC                   0x12  /*   Automation/drive interface */
403 #define SCSIRESP_INQUIRYPD_WKLU                  0x1e  /*   Well-known logical unit */
404 #define SCSIRESP_INQUIRYPD_UNKNOWN               0x1f  /*   Direct-access block device */
405 
406 #define SCSIRESP_INQUIRYFLAGS1_RMB               0x80  /* Bit 7: RMB */
407 #define SCSIRESP_INQUIRYFLAGS2_NORMACA           0x20  /* Bit 5: NormACA */
408 #define SCSIRESP_INQUIRYFLAGS2_HISUP             0x10  /* Bit 4: HiSup */
409 #define SCSIRESP_INQUIRYFLAGS2_FMTMASK           0x0f  /* Bits 0-3: Response data format */
410 
411 #define SCSIRESP_INQUIRYFLAGS3_SCCS              0x80  /* Bit 8: SCCS */
412 #define SCSIRESP_INQUIRYFLAGS3_ACC               0x40  /* Bit 7: ACC */
413 #define SCSIRESP_INQUIRYFLAGS3_TPGSMASK          0x30  /* Bits 4-5: TPGS */
414 #define SCSIRESP_INQUIRYFLAGS3_3PC               0x08  /* Bit 3: 3PC */
415 #define SCSIRESP_INQUIRYFLAGS3_PROTECT           0x01  /* Bit 0: Protect */
416 
417 #define SCSIRESP_INQUIRYFLAGS4_BQUE              0x80  /* Bit 7: BQue */
418 #define SCSIRESP_INQUIRYFLAGS4_ENCSERV           0x40  /* Bit 6: EncServ */
419 #define SCSIRESP_INQUIRYFLAGS4_VS                0x20  /* Bit 5: VS */
420 #define SCSIRESP_INQUIRYFLAGS4_MULTIP            0x10  /* Bit 4: MultIP */
421 #define SCSIRESP_INQUIRYFLAGS4_MCHNGR            0x08  /* Bit 3: MChngr */
422 #define SCSIRESP_INQUIRYFLAGS4_ADDR16            0x01  /* Bit 0: Addr16 */
423 
424 #define SCSIRESP_INQUIRYFLAGS5_WBUS16            0x20  /* Bit 5: WBus16 */
425 #define SCSIRESP_INQUIRYFLAGS5_SYNC              0x10  /* Bit 4: SYNC */
426 #define SCSIRESP_INQUIRYFLAGS5_LINKED            0x08  /* Bit 3: LINKED */
427 #define SCSIRESP_INQUIRYFLAGS5_CMDQUEUE          0x02  /* Bit 1: CmdQue */
428 #define SCSIRESP_INQUIRYFLAGS5_VS                0x01  /* Bit 0: VS */
429 
430 #define SCSIRESP_INQUIRYFLAGS6_CLOCKINGMASK      0xc0  /* Bits 2-3: Clocking */
431 #define SCSIRESP_INQUIRYFLAGS6_QAS               0x02  /* Bit 1: QAS */
432 #define SCSIRESP_INQUIRYFLAGS6_IUS               0x01  /* Bit 0: IUS */
433 
434 /* Sense data */
435 
436 /* Sense data response codes */
437 
438 #define SCSIRESP_SENSEDATA_CURRENTFIXED          0x70 /* Byte 1 is always the response code */
439 #define SCSIRESP_SENSEDATA_DEFERREDFIXED         0x71
440 #define SCSIRESP_SENSEDATA_CURRENTDESC           0x72
441 #define SCSIRESP_SENSEDATA_DEFERREDDESC          0x73
442 
443 #define SCSIRESP_SENSEDATA_RESPVALID             0x80
444 
445 /* Fixed sense data flags */
446 
447 #define SCSIRESP_SENSEDATA_FILEMARK              0x80 /* Bit 7: FileMark */
448 #define SCSIRESP_SENSEDATA_EOM                   0x40 /* Bit 6: EOM */
449 #define SCSIRESP_SENSEDATA_ILI                   0x20 /* Bit 5: ILI */
450 #define SCSIRESP_SENSEDATA_SENSEKEYMASK          0x0f /* Bits 0-3: Sense key */
451 #define SCSIRESP_SENSEDATA_NOSENSE               0x00 /*   Nothing to be reported */
452 #define SCSIRESP_SENSEDATA_RECOVEREDERROR        0x01 /*   Successful after recovery action */
453 #define SCSIRESP_SENSEDATA_NOTREADY              0x02 /*   Logical unit is not accessible */
454 #define SCSIRESP_SENSEDATA_MEDIUMERROR           0x03 /*   Error possibly caused by flaw in medium */
455 #define SCSIRESP_SENSEDATA_HARDWAREERROR         0x04 /*   Non-recoverable hardware error */
456 #define SCSIRESP_SENSEDATA_ILLEGALREQUEST        0x05 /*   Error in received request */
457 #define SCSIRESP_SENSEDATA_UNITATTENTION         0x06 /*   Unit attention condition */
458 #define SCSIRESP_SENSEDATA_DATAPROTECT           0x07 /*   Action failed, medium protected */
459 #define SCSIRESP_SENSEDATA_BLANKCHECK            0x08 /*   Encountered blank media */
460 #define SCSIRESP_SENSEDATA_VENDORSPECIFIC        0x09 /*   Vendor specific condition */
461 #define SCSIRESP_SENSEDATA_ABORTEDCOMMAND        0x0b /*   Command was aborted */
462 
463 #define SCSIRESP_SENSEDATA_KEYVALID              0x80 /* Sense-specific data valid */
464 
465 /* Mode Select 6 */
466 
467 #define SCSICMD_MODESELECT6_PF                   0x10 /* Bit 4: PF */
468 #define SCSICMD_MODESELECT6_SP                   0x01 /* Bit 0: SP */
469 
470 /* Mode Sense 6 */
471 
472 #define SCSICMD_MODESENSE6_DBD                   0x08 /* Bit 3: PF */
473 
474 #define SCSICMD_MODESENSE_PCMASK                 0xc0 /* Bits 6-7: Page control (PC) */
475 #define SCSICMD_MODESENSE_PCCURRENT              0x00 /*   Current values */
476 #define SCSICMD_MODESENSE_PCCHANGEABLE           0x40 /*   Changeable values */
477 #define SCSICMD_MODESENSE_PCDEFAULT              0x80 /*   Default values */
478 #define SCSICMD_MODESENSE_PCSAVED                0xc0 /*   Saved values */
479 #define SCSICMD_MODESENSE_PGCODEMASK             0x3f /* Bits 0-5: Page code */
480 
481 #define SCSICMD_MODESENSE6_PCDEFAULT             0x80 /*   Default values */
482                                                       /* Direct-access device page codes */
483 #define SCSIRESP_MODESENSE_PGCCODE_VENDOR        0x00 /*   Vendor-specific */
484 #define SCSIRESP_MODESENSE_PGCCODE_RWERROR       0x01 /*   Read/Write error recovery mode page */
485 #define SCSIRESP_MODESENSE_PGCCODE_RECONNECT     0x02 /*   Disconnect-reconnect mode page */
486 #define SCSIRESP_MODESENSE_PGCCODE_FORMATDEV     0x03 /*   Format device mode page (obsolete) */
487 #define SCSIRESP_MODESENSE_PGCCODE_RIGID         0x04 /*   Rigid disk geometry mode page (obsolete) */
488 #define SCSIRESP_MODESENSE_PGCCODE_FLEXIBLE      0x05 /*   Flexible disk geometry mode page (obsolete) */
489 #define SCSIRESP_MODESENSE_PGCCODE_VERIFY        0x07 /*   Verify error recovery mode page */
490 #define SCSIRESP_MODESENSE_PGCCODE_CACHING       0x08 /*   Caching mode page */
491 #define SCSIRESP_MODESENSE_PGCCODE_CONTROL       0x0a /*   Control mode page (0x0a/0x00) */
492 #define SCSIRESP_MODESENSE_PGCCODE_CONTROLEXT    0x0a /*   Control extension mode page (0x0a/0x01) */
493 #define SCSIRESP_MODESENSE_PGCCODE_MEDIUMTYPES   0x0b /*   Medum types supported mode page (obsolete) */
494 #define SCSIRESP_MODESENSE_PGCCODE_NP            0x0c /*   Notch and partition mode page (obsolete) */
495 #define SCSIRESP_MODESENSE_PGCCODE_XOR           0x10 /*   XOR control mode page */
496 #define SCSIRESP_MODESENSE_PGCCODE_ES            0x14 /*   Enclosure services mode page */
497 #define SCSIRESP_MODESENSE_PGCCODE_PSLUN         0x18 /*   Protocol-specific LUN mode page */
498 #define SCSIRESP_MODESENSE_PGCCODE_PSPORT        0x19 /*   Protocol-specific port mode page */
499 #define SCSIRESP_MODESENSE_PGCCODE_POWER         0x1a /*   Power condition mode page */
500 #define SCSIRESP_MODESENSE_PGCCODE_IE            0x1c /*   Informational exceptions control mode page (0x1c/0x00) */
501 #define SCSIRESP_MODESENSE_PGCCODE_BC            0x1c /*   Background control mode page (0x1c/0x01) */
502 #define SCSIRESP_MODESENSE_PGCCODE_RETURNALL     0x3f /*   Return all mode pages */
503                                                       /* Direct-access caching mode page */
504 #define SCSIRESP_CACHINGMODEPG_PS                0x80 /*   Byte 0, Bit 7: PS */
505 #define SCSIRESP_CACHINGMODEPG_SPF               0x60 /*   Byte 0, Bit 6: SPF */
506 #define SCSIRESP_CACHINGMODEPG_IC                0x80 /*   Byte 2, Bit 7: IC */
507 #define SCSIRESP_CACHINGMODEPG_ABPF              0x40 /*   Byte 2, Bit 6: ABPF */
508 #define SCSIRESP_CACHINGMODEPG_CAP               0x20 /*   Byte 2, Bit 5: CAP */
509 #define SCSIRESP_CACHINGMODEPG_DISC              0x10 /*   Byte 2, Bit 4: DISC */
510 #define SCSIRESP_CACHINGMODEPG_SIZE              0x08 /*   Byte 2, Bit 3: SIZE */
511 #define SCSIRESP_CACHINGMODEPG_WCE               0x04 /*   Byte 2, Bit 2: Write cache enable (WCE) */
512 #define SCSIRESP_CACHINGMODEPG_MF                0x02 /*   Byte 2, Bit 1: MF */
513 #define SCSIRESP_CACHINGMODEPG_RCD               0x01 /*   Byte 2, Bit 0: Read cache disable (RCD) */
514 
515 #define SCSIRESP_MODEPARMHDR_DAPARM_WP           0x80 /* Bit 7: WP (Direct-access block devices only) */
516 #define SCSIRESP_MODEPARMHDR_DAPARM_DBPFUA       0x10 /* Bit 4: DBOFUA (Direct-access block devices only) */
517 
518 #define SCSIRESP_PAGEFMT_PS                      0x80 /* Bit 7: PS */
519 #define SCSIRESP_PAGEFMT_SPF                     0x40 /* Bit 6: SPF */
520 #define SCSIRESP_PAGEFMT_PGCODEMASK              0x3f /* Bits 0-5: Page code */
521 
522 /* Prevent / Allow Medium Removal */
523 
524 #define SCSICMD_PREVENTMEDIUMREMOVAL_TRANSPORT   0x01 /* Removal prohibited from data transport */
525 #define SCSICMD_PREVENTMEDIUMREMOVAL_MCHANGER    0x02 /* Removal prohibited from medium changer */
526 
527 /* Read format capacities */
528 
529 #define SCIRESP_RDFMTCAPACITIES_UNFORMATED       0x01 /* Unformatted media */
530 #define SCIRESP_RDFMTCAPACITIES_FORMATED         0x02 /* Formatted media */
531 #define SCIRESP_RDFMTCAPACITIES_NOMEDIA          0x03 /* No media */
532 
533 /* Read 6 */
534 
535 #define SCSICMD_READ6_MSLBAMASK                  0x1f
536 
537 /* Write 6 */
538 
539 #define SCSICMD_WRITE6_MSLBAMASK                 0x1f
540 
541 /* Mode Select 10 */
542 
543 #define SCSICMD_MODESELECT10_PF                  0x10 /* Bit 4: PF */
544 #define SCSICMD_MODESELECT10_SP                  0x01 /* Bit 0: SP */
545 
546 /* Mode Sense 10 */
547 
548 #define SCSICMD_MODESENSE10_LLBAA                0x10 /* Bit 4: LLBAA */
549 #define SCSICMD_MODESENSE10_DBD                  0x08 /* Bit 3: PF */
550 
551 /* Read 10 */
552 
553 #define SCSICMD_READ10FLAGS_RDPROTECTMASK        0xe0
554 #define SCSICMD_READ10FLAGS_DPO                  0x10 /* Disable Page Out */
555 #define SCSICMD_READ10FLAGS_FUA                  0x08
556 #define SCSICMD_READ10FLAGS_FUANV                0x02
557 
558 /* Write 10 */
559 
560 #define SCSICMD_WRITE10FLAGS_WRPROTECTMASK       0xe0
561 #define SCSICMD_WRITE10FLAGS_DPO                 0x10 /* Disable Page Out */
562 #define SCSICMD_WRITE10FLAGS_FUA                 0x08
563 #define SCSICMD_WRITE10FLAGS_FUANV               0x02
564 
565 /* Verify 10 */
566 
567 #define SCSICMD_VERIFY10_VRPROTECTMASK           0xe0 /* Byte 1: Bits 5-7: VRPROTECT */
568 #define SCSICMD_VERIFY10_DPO                     0x10 /* Byte 1: Bit 4: Disable Page Out (DPO) */
569 #define SCSICMD_VERIFY10_BYTCHK                  0x02 /* Byte 1: Bit 2: BytChk */
570 
571 /* Read 12 */
572 
573 #define SCSICMD_READ12FLAGS_RDPROTECTMASK        0xe0
574 #define SCSICMD_READ12FLAGS_DPO                  0x10 /* Disable Page Out */
575 #define SCSICMD_READ12FLAGS_FUA                  0x08
576 #define SCSICMD_READ12FLAGS_FUANV                0x02
577 
578 /* Write 12 */
579 
580 #define SCSICMD_WRITE12FLAGS_WRPROTECTMASK       0xe0
581 #define SCSICMD_WRITE12FLAGS_DPO                 0x10 /* Disable Page Out */
582 #define SCSICMD_WRITE12FLAGS_FUA                 0x08
583 #define SCSICMD_WRITE12FLAGS_FUANV               0x02
584 
585 /* Verify 12 */
586 
587 #define SCSICMD_VERIFY12_VRPROTECTMASK           0xe0 /* Byte 1: Bits 5-7: VRPROTECT */
588 #define SCSICMD_VERIFY12_DPO                     0x10 /* Byte 1: Bit 4: Disable Page Out (DPO) */
589 #define SCSICMD_VERIFY12_BYTCHK                  0x02 /* Byte 1: Bit 2: BytChk */
590 
591 /****************************************************************************
592  * Public Types
593  ****************************************************************************/
594 
595 /* Format structures for selected SCSI primary commands */
596 
597 #define SCSICMD_TESTUNITREADY_SIZEOF 6
598 
599 struct scsicmd_requestsense_s
600 {
601   uint8_t opcode;        /* 0: 0x03 */
602   uint8_t flags;         /* 1: See SCSICMD_REQUESTSENSE_FLAGS_* */
603   uint8_t reserved[2];   /* 2-3: Reserved */
604   uint8_t alloclen;      /* 4: Allocation length */
605   uint8_t control;       /* 5: Control */
606 };
607 #define SCSICMD_REQUESTSENSE_SIZEOF 6
608 #define SCSICMD_REQUESTSENSE_MSSIZEOF 12 /* MS-Windows REQUEST SENSE with cbw->cdblen == 12 */
609 
610 struct scsiresp_fixedsensedata_s
611 {
612   uint8_t code;          /* 0: Response code See  SCSIRESP_SENSEDATA_*FIXED defns */
613   uint8_t obsolete;      /* 1: */
614   uint8_t flags;         /* 2: See SCSIRESP_SENSEDATA_* definitions */
615   uint8_t info[4];       /* 3-6: Information */
616   uint8_t len;           /* 7: Additional length */
617   uint8_t cmdinfo[4];    /* 8-11: Command-specific information */
618   uint8_t code2;         /* 12: Additional sense code */
619   uint8_t qual2;         /* 13: Additional sense code qualifier */
620   uint8_t fru;           /* 14: Field replacement unit code */
621   uint8_t key[3];        /* 15-17: Sense key specific */
622                          /* 18-: Additional bytes may follow */
623 };
624 #define SCSIRESP_FIXEDSENSEDATA_SIZEOF 18 /* Minimum size */
625 
626 struct scscicmd_inquiry_s
627 {
628   uint8_t opcode;        /* 0: 0x12 */
629   uint8_t flags;         /* 1: See SCSICMD_INQUIRY_FLAGS_* */
630   uint8_t pagecode;      /* 2: Page code */
631   uint8_t alloclen[2];   /* 3-4: Allocation length */
632   uint8_t control;       /* 5: Control */
633 };
634 #define SCSICMD_INQUIRY_SIZEOF 6
635 
636 struct scsiresp_inquiry_s
637 {
638   /* Mandatory */
639 
640   uint8_t qualtype;      /* 0: Bits 5-7: Peripheral qualifier; Bits 0-4: Peripheral device type */
641   uint8_t flags1;        /* 1: See SCSIRESP_INQUIRY_FLAGS1_* */
642   uint8_t version;       /* 2: Version */
643   uint8_t flags2;        /* 3: See SCSIRESP_INQUIRY_FLAGS2_* */
644   uint8_t len;           /* 4: Additional length */
645   uint8_t flags3;        /* 5: See SCSIRESP_INQUIRY_FLAGS3_* */
646   uint8_t flags4;        /* 6: See SCSIRESP_INQUIRY_FLAGS4_* */
647   uint8_t flags5;        /* 7: See SCSIRESP_INQUIRY_FLAGS5_* */
648   uint8_t vendorid[8];   /* 8-15: T10 Vendor Identification */
649   uint8_t productid[16]; /* 16-31: Product Identification */
650   uint8_t revision[4];   /* 32-35: Product Revision Level */
651 
652   /* Optional */
653 
654   uint8_t vendor[20];    /* 36-55: Vendor specific */
655   uint8_t flags6;        /* 56: See SCSIRESP_INQUIRY_FLAGS6_* */
656   uint8_t reserved1;     /* 57: Reserved */
657   uint8_t version1[2];   /* 58-59: Version Descriptor 1 */
658   uint8_t version2[2];   /* 60-61: Version Descriptor 2 */
659   uint8_t version3[2];   /* 62-63: Version Descriptor 3 */
660   uint8_t version4[2];   /* 64-65: Version Descriptor 4 */
661   uint8_t version5[2];   /* 66-67: Version Descriptor 5 */
662   uint8_t version6[2];   /* 68-69: Version Descriptor 6 */
663   uint8_t version7[2];   /* 70-71: Version Descriptor 7 */
664   uint8_t version8[2];   /* 72-73: Version Descriptor 8 */
665   uint8_t reserved2[22]; /* 74-95: Reserved */
666                          /* 96-: Vendor-specific parameters may follow */
667 };
668 #define SCSIRESP_INQUIRY_SIZEOF 36 /* Minimum size */
669 
670 struct scsicmd_modeselect6_s
671 {
672   uint8_t opcode;        /* 0x15 */
673   uint8_t flags;         /* 1: See SCSICMD_MODESELECT6_FLAGS_* */
674   uint8_t reserved[2];   /* 2-3: Reserved */
675   uint8_t plen;          /* 4: Parameter list length */
676   uint8_t control;       /* 5: Control */
677 };
678 #define SCSICMD_MODESELECT6_SIZEOF 6
679 
680 struct scsicmd_modesense6_s
681 {
682   uint8_t opcode;        /* 0x1a */
683   uint8_t flags;         /* 1: See SCSICMD_MODESENSE6_FLAGS_* */
684   uint8_t pcpgcode;      /* 2: Bits 6-7: PC, bits 0-5: page code */
685   uint8_t subpgcode;     /* 3: subpage code */
686   uint8_t alloclen;      /* 4: Allocation length */
687   uint8_t control;       /* 5: Control */
688 };
689 #define SCSICMD_MODESENSE6_SIZEOF 6
690 
691 struct scsiresp_modeparameterhdr6_s
692 {
693   uint8_t mdlen;         /* 0: Mode data length */
694   uint8_t type;          /* 1: Medium type */
695   uint8_t param;         /* 2: Device-specific parameter */
696   uint8_t bdlen;         /* 3: Block descriptor length */
697 };
698 #define SCSIRESP_MODEPARAMETERHDR6_SIZEOF 4
699 
700 struct scsiresp_blockdesc_s
701 {
702   uint8_t density;       /* 0: density code */
703   uint8_t nblocks[3];    /* 1-3: Number of blocks */
704   uint8_t reserved;      /* 4: reserved */
705   uint8_t blklen[3];     /* 5-7: Block len */
706 };
707 #define SCSIRESP_BLOCKDESC_SIZEOF 8
708 
709 struct scsiresp_pageformat_s
710 {
711   uint8_t pgcode;       /* 0: See SCSIRESP_PAGEFMT_* definitions */
712   uint8_t pglen;        /* 1: Page length (n-1) */
713   uint8_t parms[1];     /* 2-n: Mode parameters */
714 };
715 
716 struct scsiresp_subpageformat_s
717 {
718   uint8_t pgcode;       /* 0: See SCSIRESP_PAGEFMT_* definitions */
719   uint8_t subpgcode;    /* 1: sub-page code */
720   uint8_t pglen[2];     /* 2-3: Page length (n-3) */
721   uint8_t parms[1];     /* 4-n: Mode parameters */
722 };
723 
724 struct scsiresp_cachingmodepage_s
725 {
726   uint8_t pgcode;      /* 0: Bit 7: PS; Bit 6: SPF, Bits 0-5: page code == 8 */
727   uint8_t len;         /* 1: Page length (18) */
728   uint8_t flags1;      /* 2: See SCSIRESP_CACHINGMODEPG_* definitions */
729   uint8_t priority;    /* 3: Bits 4-7: Demand read retention priority; Bits 0-3: Write retention priority */
730   uint8_t dpflen[2];   /* 4-5: Disable prefetch transfer length */
731   uint8_t minpf[2];    /* 6-7: Minimum pre-fetch */
732   uint8_t maxpf[2];    /* 8-9: Maximum pre-fetch */
733   uint8_t maxpfc[2];   /* 10-11: Maximum pref-fetch ceiling */
734   uint8_t flags2;      /* 12: See SCSIRESP_CACHINGMODEPG_* definitions */
735   uint8_t nsegments;   /* 13: Number of cache segments */
736   uint8_t segsize[2];  /* 14-15: Cache segment size */
737   uint8_t reserved;    /* 16: Reserved */
738   uint8_t obsolete[3]; /* 17-19: Obsolete */
739 };
740 
741 /* Format structures for selected SCSI block commands */
742 
743 struct scsicmd_read6_s
744 {
745   uint8_t opcode;        /* 0: 0x08 */
746   uint8_t mslba;         /* 1: Bits 5-7: reserved; Bits 0-6: MS Logical Block Address (LBA) */
747   uint8_t lslba[2];      /* 2-3: LS Logical Block Address (LBA) */
748   uint8_t xfrlen;        /* 4: Transfer length (in contiguous logical blocks) */
749   uint8_t control;       /* 5: Control */
750 };
751 #define SCSICMD_READ6_SIZEOF 6
752 
753 struct scsicmd_write6_s
754 {
755   uint8_t opcode;        /* 0: 0x0a */
756   uint8_t mslba;         /* 1: Bits 5-7: reserved; Bits 0-6: MS Logical Block Address (LBA) */
757   uint8_t lslba[2];      /* 2-3: LS Logical Block Address (LBA) */
758   uint8_t xfrlen;        /* 4: Transfer length (in contiguous logical blocks) */
759   uint8_t control;       /* 5: Control */
760 };
761 #define SCSICMD_WRITE6_SIZEOF 6
762 
763 struct scsicmd_startstopunit_s
764 {
765   uint8_t opcode;        /* 0: 0x1b */
766   uint8_t immed;         /* 1: Bits 2-7: Reserved, Bit 0: Immed */
767   uint8_t reserved;      /* 2: reserved */
768   uint8_t pcm;           /* 3: Bits 4-7: Reserved, Bits 0-3: Power condition modifier */
769   uint8_t pc;            /* 4: Bits 4-7: Power condition, Bit 2: NO_FLUSH, Bit 1: LOEJ, Bit 0: START */
770   uint8_t control;       /* 5: Control */
771 };
772 #define SCSICMD_STARTSTOPUNIT_SIZEOF 6
773 
774 struct scsicmd_preventmediumremoval_s
775 {
776   uint8_t opcode;        /* 0: 0x1e */
777   uint8_t reserved[3];   /* 1-3: Reserved */
778   uint8_t prevent;       /* 4: Bits 2-7: Reserved, Bits 0:1: prevent */
779   uint8_t control;       /* 5: Control */
780 };
781 #define SCSICMD_PREVENTMEDIUMREMOVAL_SIZEOF 6
782 
783 struct scsicmd_readformatcapcacities_s
784 {
785   uint8_t opcode;        /* 0: 0x23 */
786   uint8_t reserved[6];   /* 1-6: Reserved */
787   uint8_t alloclen[2];   /* 7-8: Allocation length */
788   uint8_t control;       /* 9: Control */
789 };
790 #define SCSICMD_READFORMATCAPACITIES_SIZEOF 10
791 
792 struct scsiresp_readformatcapacities_s
793 {
794   /* Current capacity header */
795 
796   uint8_t reserved[3];  /* 0-2: Reserved */
797   uint8_t listlen;      /* 3: Capacity list length */
798 
799   /* Current/Maximum Capacity Descriptor (actually a separate structure) */
800 
801   uint8_t nblocks[4];   /* 4-7: Number of blocks */
802   uint8_t type;         /* 8: Bits 2-7: Reserved, Bits 0-1: Descriptor type */
803   uint8_t blocklen[3];  /* 9-11: Block length */
804 };
805 #define SCSIRESP_READFORMATCAPACITIES_SIZEOF 12
806 #define SCSIRESP_CURRCAPACITYDESC_SIZEOF 8
807 
808 struct scsiresp_formattedcapacitydesc_s
809 {
810   uint8_t nblocks[4];   /* 0-3: Number of blocks */
811   uint8_t type;         /* 4: Bits 2-7: Type, bits 0-1, reserved */
812   uint8_t param[3];     /* 5-7: Type dependent parameter */
813 };
814 #define SCSIRESP_FORMATTEDCAPACITYDESC_SIZEOF 8
815 
816 struct scsicmd_readcapacity10_s
817 {
818   uint8_t opcode;        /* 0: 0x25 */
819   uint8_t reserved1;     /* 1: Bits 1-7: Reserved, Bit 0: Obsolete */
820   uint8_t lba[4];        /* 2-5: Logical block address (LBA) */
821   uint8_t reserved2[2];  /* 6-7: Reserved */
822   uint8_t pmi;           /* 8: Bits 1-7 Reserved; Bit 0: PMI */
823   uint8_t control;       /* 9: Control */
824 };
825 #define SCSICMD_READCAPACITY10_SIZEOF 10
826 
827 struct scsiresp_readcapacity10_s
828 {
829   uint8_t lba[4];        /* 0-3: Returned logical block address (LBA) */
830   uint8_t blklen[4];     /* 4-7: Logical block length (in bytes) */
831 };
832 #define SCSIRESP_READCAPACITY10_SIZEOF 8
833 
834 struct scsicmd_read10_s
835 {
836   uint8_t opcode;        /* 0: 0x28 */
837   uint8_t flags;         /* 1: See SCSICMD_READ10FLAGS_* */
838   uint8_t lba[4];        /* 2-5: Logical Block Address (LBA) */
839   uint8_t groupno;       /* 6: Bits 5-7: reserved; Bits 0-6: group number */
840   uint8_t xfrlen[2];     /* 7-8: Transfer length (in contiguous logical blocks) */
841   uint8_t control;       /* 9: Control */
842 };
843 #define SCSICMD_READ10_SIZEOF 10
844 
845 struct scsicmd_write10_s
846 {
847   uint8_t opcode;        /* 0: 0x2a */
848   uint8_t flags;         /* 1: See SCSICMD_WRITE10FLAGS_* */
849   uint8_t lba[4];        /* 2-5: Logical Block Address (LBA) */
850   uint8_t groupno;       /* 6: Bits 5-7: reserved; Bits 0-6: group number */
851   uint8_t xfrlen[2];     /* 7-8: Transfer length (in contiguous logical blocks) */
852   uint8_t control;       /* 9: Control */
853 };
854 #define SCSICMD_WRITE10_SIZEOF 10
855 
856 struct scsicmd_verify10_s
857 {
858   uint8_t opcode;        /* 0: 0x2f */
859   uint8_t flags;         /* 1: See SCSICMD_VERIFY10_* definitions */
860   uint8_t lba[4];        /* 2-5: Logical block address (LBA) */
861   uint8_t groupno;       /* 6: Bit 7: restricted; Bits 5-6: Reserved, Bits 0-4: Group number */
862   uint8_t len[2];        /* 7-8: Verification length (in blocks) */
863   uint8_t control;       /* 9: Control */
864 };
865 #define SCSICMD_VERIFY10_SIZEOF 10
866 
867 struct scsicmd_synchronizecache10_s
868 {
869   uint8_t opcode;        /* 0: 0x35 */
870   uint8_t flags;         /* 1: See SCSICMD_SYNCHRONIZECACHE10_* definitions */
871   uint8_t lba[4];        /* 2-5: Logical block address (LBA) */
872   uint8_t groupno;       /* 6: Bit 7: restricted; Bits 5-6: Reserved, Bits 0-4: Group number */
873   uint8_t len[2];        /* 7-8: Number of logical blocks */
874   uint8_t control;       /* 9: Control */
875 };
876 #define SCSICMD_SYNCHRONIZECACHE10_SIZEOF 10
877 
878 struct scsicmd_modeselect10_s
879 {
880   uint8_t opcode;        /* 0: 0x55 */
881   uint8_t flags;         /* 1: See SCSICMD_MODESELECT10_FLAGS_* */
882   uint8_t reserved[5];   /* 2-6: Reserved */
883   uint8_t parmlen[2];    /* 7-8: Parameter list length */
884   uint8_t control;       /* 9: Control */
885 };
886 #define SCSICMD_MODESELECT10_SIZEOF 10
887 
888 struct scsiresp_modeparameterhdr10_s
889 {
890   uint8_t mdlen[2];      /* 0-1: Mode data length */
891   uint8_t type;          /* 2: Medium type */
892   uint8_t param;         /* 3: Device-specific parameter */
893   uint8_t reserved[2];   /* 4-5: reserved */
894   uint8_t bdlen[2];      /* 6-7: Block descriptor length */
895 };
896 #define SCSIRESP_MODEPARAMETERHDR10_SIZEOF 8
897 
898 struct scsicmd_modesense10_s
899 {
900   uint8_t opcode;        /* O: 0x5a */
901   uint8_t flags;         /* 1: See SCSICMD_MODESENSE10_FLAGS_* */
902   uint8_t pcpgcode;      /* 2: Bits 6-7: PC, bits 0-5: page code */
903   uint8_t subpgcode;     /* 3: subpage code */
904   uint8_t reserved[3];   /* 4-6: reserved */
905   uint8_t alloclen[2];   /* 7-8: Allocation length */
906   uint8_t control;       /* 9: Control */
907 };
908 #define SCSICMD_MODESENSE10_SIZEOF 10
909 
910 struct scsicmd_readcapacity16_s
911 {
912   uint8_t opcode;        /* 0: 0x9e */
913   uint8_t action;        /* 1: Bits 5-7: Reserved, Bits 0-4: Service action */
914   uint8_t lba[8];        /* 2-9: Logical block address (LBA) */
915   uint8_t len[4];        /* 10-13: Allocation length */
916   uint8_t reserved;      /* 14: Reserved */
917   uint8_t control;       /* 15: Control */
918 };
919 #define SCSICMD_READCAPACITY16_SIZEOF 16
920 
921 struct scsicmd_read12_s
922 {
923   uint8_t opcode;        /* 0: 0xa8 */
924   uint8_t flags;         /* 1: See SCSICMD_READ12FLAGS_* */
925   uint8_t lba[4];        /* 2-5: Logical Block Address (LBA) */
926   uint8_t xfrlen[4];     /* 6-9: Transfer length (in contiguous logical blocks) */
927   uint8_t groupno;       /* 10: Bit 7: restricted; Bits 5-6: reserved; Bits 0-6: group number */
928   uint8_t control;       /* 11: Control */
929 };
930 #define SCSICMD_READ12_SIZEOF 12
931 
932 struct scsicmd_write12_s
933 {
934   uint8_t opcode;        /* 0: 0xaa */
935   uint8_t flags;         /* 1: See SCSICMD_WRITE12FLAGS_* */
936   uint8_t lba[4];        /* 2-5: Logical Block Address (LBA) */
937   uint8_t xfrlen[4];     /* 6-9: Transfer length (in contiguous logical blocks) */
938   uint8_t groupno;       /* 10: Bit 7: restricted; Bits 5-6: reserved; Bits 0-6: group number */
939   uint8_t control;       /* 11: Control */
940 };
941 #define SCSICMD_WRITE12_SIZEOF 12
942 
943 struct scsicmd_verify12_s
944 {
945   uint8_t opcode;        /* 0: 0xaf */
946   uint8_t flags;         /* 1: See SCSICMD_VERIFY12_* definitions */
947   uint8_t lba[4];        /* 2-5: Logical block address (LBA) */
948   uint8_t len[4];        /* 6-9: Verification length */
949   uint8_t groupno;       /* 10: Bit 7: restricted; Bits 5-6: Reserved, Bits 0-4: Group number */
950   uint8_t control;       /* 11: Control */
951 };
952 #define SCSICMD_VERIFY12_SIZEOF 12
953 
954 /****************************************************************************
955  * Public Functions Definitions
956  ****************************************************************************/
957 
958 #undef EXTERN
959 #if defined(__cplusplus)
960 #define EXTERN extern "C"
961 extern "C"
962 {
963 #else
964 #define EXTERN extern
965 #endif
966 
967 #undef EXTERN
968 #if defined(__cplusplus)
969 }
970 #endif
971 
972 #endif /* __INCLUDE_NUTTX_SCSI_H */
973