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