xref: /openbmc/qemu/include/scsi/constants.h (revision 464dacf6)
1 /* Copyright (C) 1998, 1999 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3 
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8 
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13 
14    You should have received a copy of the GNU Lesser General Public
15    License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 */
17 
18 /*
19  * This header file contains public constants and structures used by
20  * the scsi code for linux.
21  */
22 
23 #ifndef SCSI_CONSTANTS_H
24 #define SCSI_CONSTANTS_H
25 
26 /*
27  *      SCSI opcodes
28  */
29 
30 #define TEST_UNIT_READY       0x00
31 #define REWIND                0x01
32 #define REQUEST_SENSE         0x03
33 #define FORMAT_UNIT           0x04
34 #define READ_BLOCK_LIMITS     0x05
35 #define INITIALIZE_ELEMENT_STATUS 0x07
36 #define REASSIGN_BLOCKS       0x07
37 #define READ_6                0x08
38 #define WRITE_6               0x0a
39 #define SET_CAPACITY          0x0b
40 #define READ_REVERSE          0x0f
41 #define WRITE_FILEMARKS       0x10
42 #define SPACE                 0x11
43 #define INQUIRY               0x12
44 #define RECOVER_BUFFERED_DATA 0x14
45 #define MODE_SELECT           0x15
46 #define RESERVE               0x16
47 #define RELEASE               0x17
48 #define COPY                  0x18
49 #define ERASE                 0x19
50 #define MODE_SENSE            0x1a
51 #define LOAD_UNLOAD           0x1b
52 #define SCAN                  0x1b
53 #define START_STOP            0x1b
54 #define RECEIVE_DIAGNOSTIC    0x1c
55 #define SEND_DIAGNOSTIC       0x1d
56 #define ALLOW_MEDIUM_REMOVAL  0x1e
57 #define SET_WINDOW            0x24
58 #define READ_CAPACITY_10      0x25
59 #define GET_WINDOW            0x25
60 #define READ_10               0x28
61 #define WRITE_10              0x2a
62 #define SEND                  0x2a
63 #define SEEK_10               0x2b
64 #define LOCATE_10             0x2b
65 #define POSITION_TO_ELEMENT   0x2b
66 #define WRITE_VERIFY_10       0x2e
67 #define VERIFY_10             0x2f
68 #define SEARCH_HIGH           0x30
69 #define SEARCH_EQUAL          0x31
70 #define OBJECT_POSITION       0x31
71 #define SEARCH_LOW            0x32
72 #define SET_LIMITS            0x33
73 #define PRE_FETCH             0x34
74 #define READ_POSITION         0x34
75 #define GET_DATA_BUFFER_STATUS 0x34
76 #define SYNCHRONIZE_CACHE     0x35
77 #define LOCK_UNLOCK_CACHE     0x36
78 #define INITIALIZE_ELEMENT_STATUS_WITH_RANGE 0x37
79 #define READ_DEFECT_DATA      0x37
80 #define MEDIUM_SCAN           0x38
81 #define COMPARE               0x39
82 #define COPY_VERIFY           0x3a
83 #define WRITE_BUFFER          0x3b
84 #define READ_BUFFER           0x3c
85 #define UPDATE_BLOCK          0x3d
86 #define READ_LONG_10          0x3e
87 #define WRITE_LONG_10         0x3f
88 #define CHANGE_DEFINITION     0x40
89 #define WRITE_SAME_10         0x41
90 #define UNMAP                 0x42
91 #define READ_TOC              0x43
92 #define REPORT_DENSITY_SUPPORT 0x44
93 #define GET_CONFIGURATION     0x46
94 #define SANITIZE              0x48
95 #define GET_EVENT_STATUS_NOTIFICATION 0x4a
96 #define LOG_SELECT            0x4c
97 #define LOG_SENSE             0x4d
98 #define READ_DISC_INFORMATION 0x51
99 #define RESERVE_TRACK         0x53
100 #define MODE_SELECT_10        0x55
101 #define RESERVE_10            0x56
102 #define RELEASE_10            0x57
103 #define MODE_SENSE_10         0x5a
104 #define SEND_CUE_SHEET        0x5d
105 #define PERSISTENT_RESERVE_IN 0x5e
106 #define PERSISTENT_RESERVE_OUT 0x5f
107 #define VARLENGTH_CDB         0x7f
108 #define WRITE_FILEMARKS_16    0x80
109 #define READ_REVERSE_16       0x81
110 #define ALLOW_OVERWRITE       0x82
111 #define EXTENDED_COPY         0x83
112 #define ATA_PASSTHROUGH_16    0x85
113 #define ACCESS_CONTROL_IN     0x86
114 #define ACCESS_CONTROL_OUT    0x87
115 #define READ_16               0x88
116 #define COMPARE_AND_WRITE     0x89
117 #define WRITE_16              0x8a
118 #define WRITE_VERIFY_16       0x8e
119 #define VERIFY_16             0x8f
120 #define PRE_FETCH_16          0x90
121 #define SPACE_16              0x91
122 #define SYNCHRONIZE_CACHE_16  0x91
123 #define LOCATE_16             0x92
124 #define WRITE_SAME_16         0x93
125 #define ERASE_16              0x93
126 #define SERVICE_ACTION_IN_16  0x9e
127 #define WRITE_LONG_16         0x9f
128 #define REPORT_LUNS           0xa0
129 #define ATA_PASSTHROUGH_12    0xa1
130 #define MAINTENANCE_IN        0xa3
131 #define MAINTENANCE_OUT       0xa4
132 #define MOVE_MEDIUM           0xa5
133 #define EXCHANGE_MEDIUM       0xa6
134 #define SET_READ_AHEAD        0xa7
135 #define READ_12               0xa8
136 #define WRITE_12              0xaa
137 #define SERVICE_ACTION_IN_12  0xab
138 #define ERASE_12              0xac
139 #define READ_DVD_STRUCTURE    0xad
140 #define WRITE_VERIFY_12       0xae
141 #define VERIFY_12             0xaf
142 #define SEARCH_HIGH_12        0xb0
143 #define SEARCH_EQUAL_12       0xb1
144 #define SEARCH_LOW_12         0xb2
145 #define READ_ELEMENT_STATUS   0xb8
146 #define SEND_VOLUME_TAG       0xb6
147 #define READ_DEFECT_DATA_12   0xb7
148 #define SET_CD_SPEED          0xbb
149 #define MECHANISM_STATUS      0xbd
150 #define READ_CD               0xbe
151 #define SEND_DVD_STRUCTURE    0xbf
152 
153 /*
154  * SERVICE ACTION IN subcodes
155  */
156 #define SAI_READ_CAPACITY_16  0x10
157 
158 /*
159  * READ POSITION service action codes
160  */
161 #define SHORT_FORM_BLOCK_ID  0x00
162 #define SHORT_FORM_VENDOR_SPECIFIC 0x01
163 #define LONG_FORM            0x06
164 #define EXTENDED_FORM        0x08
165 
166 /*
167  *  SAM Status codes
168  */
169 
170 #define GOOD                 0x00
171 #define CHECK_CONDITION      0x02
172 #define CONDITION_GOOD       0x04
173 #define BUSY                 0x08
174 #define INTERMEDIATE_GOOD    0x10
175 #define INTERMEDIATE_C_GOOD  0x14
176 #define RESERVATION_CONFLICT 0x18
177 #define COMMAND_TERMINATED   0x22
178 #define TASK_SET_FULL        0x28
179 #define ACA_ACTIVE           0x30
180 #define TASK_ABORTED         0x40
181 
182 #define STATUS_MASK          0x3e
183 
184 /*
185  *  SENSE KEYS
186  */
187 
188 #define NO_SENSE            0x00
189 #define RECOVERED_ERROR     0x01
190 #define NOT_READY           0x02
191 #define MEDIUM_ERROR        0x03
192 #define HARDWARE_ERROR      0x04
193 #define ILLEGAL_REQUEST     0x05
194 #define UNIT_ATTENTION      0x06
195 #define DATA_PROTECT        0x07
196 #define BLANK_CHECK         0x08
197 #define COPY_ABORTED        0x0a
198 #define ABORTED_COMMAND     0x0b
199 #define VOLUME_OVERFLOW     0x0d
200 #define MISCOMPARE          0x0e
201 
202 
203 /*
204  *  DEVICE TYPES
205  */
206 
207 #define TYPE_DISK           0x00
208 #define TYPE_TAPE           0x01
209 #define TYPE_PRINTER        0x02
210 #define TYPE_PROCESSOR      0x03    /* HP scanners use this */
211 #define TYPE_WORM           0x04    /* Treated as ROM by our system */
212 #define TYPE_ROM            0x05
213 #define TYPE_SCANNER        0x06
214 #define TYPE_MOD            0x07    /* Magneto-optical disk -
215                                      * - treated as TYPE_DISK */
216 #define TYPE_MEDIUM_CHANGER 0x08
217 #define TYPE_STORAGE_ARRAY  0x0c    /* Storage array device */
218 #define TYPE_ENCLOSURE      0x0d    /* Enclosure Services Device */
219 #define TYPE_RBC            0x0e    /* Simplified Direct-Access Device */
220 #define TYPE_OSD            0x11    /* Object-storage Device */
221 #define TYPE_ZBC            0x14    /* Host-managed Zoned SCSI Device */
222 #define TYPE_WLUN           0x1e    /* Well known LUN */
223 #define TYPE_NOT_PRESENT    0x1f
224 #define TYPE_INACTIVE       0x20
225 #define TYPE_NO_LUN         0x7f
226 
227 /* Mode page codes for mode sense/set */
228 #define MODE_PAGE_VENDOR_SPECIFIC             0x00
229 #define MODE_PAGE_R_W_ERROR                   0x01
230 #define MODE_PAGE_HD_GEOMETRY                 0x04
231 #define MODE_PAGE_FLEXIBLE_DISK_GEOMETRY      0x05
232 #define MODE_PAGE_CACHING                     0x08
233 #define MODE_PAGE_AUDIO_CTL                   0x0e
234 #define MODE_PAGE_CONTROL                     0x0a
235 #define MODE_PAGE_POWER                       0x1a
236 #define MODE_PAGE_FAULT_FAIL                  0x1c
237 #define MODE_PAGE_TO_PROTECT                  0x1d
238 #define MODE_PAGE_CAPABILITIES                0x2a
239 #define MODE_PAGE_APPLE_VENDOR                0x30
240 #define MODE_PAGE_ALLS                        0x3f
241 /* Not in Mt. Fuji, but in ATAPI 2.6 -- deprecated now in favor
242  * of MODE_PAGE_SENSE_POWER */
243 #define MODE_PAGE_CDROM                       0x0d
244 
245 /* Event notification classes for GET EVENT STATUS NOTIFICATION */
246 #define GESN_NO_EVENTS                0
247 #define GESN_OPERATIONAL_CHANGE       1
248 #define GESN_POWER_MANAGEMENT         2
249 #define GESN_EXTERNAL_REQUEST         3
250 #define GESN_MEDIA                    4
251 #define GESN_MULTIPLE_HOSTS           5
252 #define GESN_DEVICE_BUSY              6
253 
254 /* Event codes for MEDIA event status notification */
255 #define MEC_NO_CHANGE                 0
256 #define MEC_EJECT_REQUESTED           1
257 #define MEC_NEW_MEDIA                 2
258 #define MEC_MEDIA_REMOVAL             3 /* only for media changers */
259 #define MEC_MEDIA_CHANGED             4 /* only for media changers */
260 #define MEC_BG_FORMAT_COMPLETED       5 /* MRW or DVD+RW b/g format completed */
261 #define MEC_BG_FORMAT_RESTARTED       6 /* MRW or DVD+RW b/g format restarted */
262 
263 #define MS_TRAY_OPEN                  1
264 #define MS_MEDIA_PRESENT              2
265 
266 /*
267  * Based on values from <linux/cdrom.h> but extending CD_MINS
268  * to the maximum common size allowed by the Orange's Book ATIP
269  *
270  * 90 and 99 min CDs are also available but using them as the
271  * upper limit reduces the effectiveness of the heuristic to
272  * detect DVDs burned to less than 25% of their maximum capacity
273  */
274 
275 /* Some generally useful CD-ROM information */
276 #define CD_MINS                       80 /* max. minutes per CD */
277 #define CD_SECS                       60 /* seconds per minute */
278 #define CD_FRAMES                     75 /* frames per second */
279 #define CD_FRAMESIZE                2048 /* bytes per frame, "cooked" mode */
280 #define CD_MAX_BYTES       (CD_MINS * CD_SECS * CD_FRAMES * CD_FRAMESIZE)
281 #define CD_MAX_SECTORS     (CD_MAX_BYTES / 512)
282 
283 /*
284  * The MMC values are not IDE specific and might need to be moved
285  * to a common header if they are also needed for the SCSI emulation
286  */
287 
288 /* Profile list from MMC-6 revision 1 table 91 */
289 #define MMC_PROFILE_NONE                0x0000
290 #define MMC_PROFILE_CD_ROM              0x0008
291 #define MMC_PROFILE_CD_R                0x0009
292 #define MMC_PROFILE_CD_RW               0x000A
293 #define MMC_PROFILE_DVD_ROM             0x0010
294 #define MMC_PROFILE_DVD_R_SR            0x0011
295 #define MMC_PROFILE_DVD_RAM             0x0012
296 #define MMC_PROFILE_DVD_RW_RO           0x0013
297 #define MMC_PROFILE_DVD_RW_SR           0x0014
298 #define MMC_PROFILE_DVD_R_DL_SR         0x0015
299 #define MMC_PROFILE_DVD_R_DL_JR         0x0016
300 #define MMC_PROFILE_DVD_RW_DL           0x0017
301 #define MMC_PROFILE_DVD_DDR             0x0018
302 #define MMC_PROFILE_DVD_PLUS_RW         0x001A
303 #define MMC_PROFILE_DVD_PLUS_R          0x001B
304 #define MMC_PROFILE_DVD_PLUS_RW_DL      0x002A
305 #define MMC_PROFILE_DVD_PLUS_R_DL       0x002B
306 #define MMC_PROFILE_BD_ROM              0x0040
307 #define MMC_PROFILE_BD_R_SRM            0x0041
308 #define MMC_PROFILE_BD_R_RRM            0x0042
309 #define MMC_PROFILE_BD_RE               0x0043
310 #define MMC_PROFILE_HDDVD_ROM           0x0050
311 #define MMC_PROFILE_HDDVD_R             0x0051
312 #define MMC_PROFILE_HDDVD_RAM           0x0052
313 #define MMC_PROFILE_HDDVD_RW            0x0053
314 #define MMC_PROFILE_HDDVD_R_DL          0x0058
315 #define MMC_PROFILE_HDDVD_RW_DL         0x005A
316 #define MMC_PROFILE_INVALID             0xFFFF
317 
318 #define XCOPY_DESC_OFFSET 16
319 #define IDENT_DESCR_TGT_DESCR_SIZE 32
320 #define XCOPY_BLK2BLK_SEG_DESC_SIZE 28
321 
322 #endif
323