2 * Copyright (c) 2000 - 2005 Søren Schmidt <sos@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/ioccom.h>
36 /* ATA/ATAPI device parameters */
38 /*000*/ u_int16_t config; /* configuration info */
39 #define ATA_PROTO_MASK 0x8003
40 #define ATA_PROTO_ATAPI 0x8000
41 #define ATA_PROTO_ATAPI_12 0x8000
42 #define ATA_PROTO_ATAPI_16 0x8001
43 #define ATA_ATAPI_TYPE_MASK 0x1f00
44 #define ATA_ATAPI_TYPE_DIRECT 0x0000 /* disk/floppy */
45 #define ATA_ATAPI_TYPE_TAPE 0x0100 /* streaming tape */
46 #define ATA_ATAPI_TYPE_CDROM 0x0500 /* CD-ROM device */
47 #define ATA_ATAPI_TYPE_OPTICAL 0x0700 /* optical disk */
48 #define ATA_DRQ_MASK 0x0060
49 #define ATA_DRQ_SLOW 0x0000 /* cpu 3 ms delay */
50 #define ATA_DRQ_INTR 0x0020 /* interrupt 10 ms delay */
51 #define ATA_DRQ_FAST 0x0040 /* accel 50 us delay */
53 /*001*/ u_int16_t cylinders; /* # of cylinders */
55 /*003*/ u_int16_t heads; /* # heads */
58 /*006*/ u_int16_t sectors; /* # sectors/track */
59 /*007*/ u_int16_t vendor7[3];
60 /*010*/ u_int8_t serial[20]; /* serial number */
61 /*020*/ u_int16_t retired20;
64 /*023*/ u_int8_t revision[8]; /* firmware revision */
65 /*027*/ u_int8_t model[40]; /* model name */
66 /*047*/ u_int16_t sectors_intr; /* sectors per interrupt */
67 /*048*/ u_int16_t usedmovsd; /* double word read/write? */
68 /*049*/ u_int16_t capabilities1;
69 #define ATA_SUPPORT_DMA 0x0100
70 #define ATA_SUPPORT_LBA 0x0200
71 #define ATA_SUPPORT_OVERLAP 0x4000
73 /*050*/ u_int16_t capabilities2;
74 /*051*/ u_int16_t retired_piomode; /* PIO modes 0-2 */
75 #define ATA_RETIRED_PIO_MASK 0x0300
77 /*052*/ u_int16_t retired_dmamode; /* DMA modes */
78 #define ATA_RETIRED_DMA_MASK 0x0003
80 /*053*/ u_int16_t atavalid; /* fields valid */
81 #define ATA_FLAG_54_58 0x0001 /* words 54-58 valid */
82 #define ATA_FLAG_64_70 0x0002 /* words 64-70 valid */
83 #define ATA_FLAG_88 0x0004 /* word 88 valid */
85 /*054*/ u_int16_t current_cylinders;
86 /*055*/ u_int16_t current_heads;
87 /*056*/ u_int16_t current_sectors;
88 /*057*/ u_int16_t current_size_1;
89 /*058*/ u_int16_t current_size_2;
90 /*059*/ u_int16_t multi;
91 #define ATA_MULTI_VALID 0x0100
93 /*060*/ u_int16_t lba_size_1;
96 /*063*/ u_int16_t mwdmamodes; /* multiword DMA modes */
97 /*064*/ u_int16_t apiomodes; /* advanced PIO modes */
99 /*065*/ u_int16_t mwdmamin; /* min. M/W DMA time/word ns */
100 /*066*/ u_int16_t mwdmarec; /* rec. M/W DMA time ns */
101 /*067*/ u_int16_t pioblind; /* min. PIO cycle w/o flow */
102 /*068*/ u_int16_t pioiordy; /* min. PIO cycle IORDY flow */
103 u_int16_t reserved69;
104 u_int16_t reserved70;
105 /*071*/ u_int16_t rlsovlap; /* rel time (us) for overlap */
106 /*072*/ u_int16_t rlsservice; /* rel time (us) for service */
107 u_int16_t reserved73;
108 u_int16_t reserved74;
109 /*075*/ u_int16_t queue;
110 #define ATA_QUEUE_LEN(x) ((x) & 0x001f)
112 u_int16_t satacapabilities;
113 #define ATA_SATA_GEN1 0x0002
114 #define ATA_SATA_GEN2 0x0004
115 #define ATA_SUPPORT_NCQ 0x0100
116 #define ATA_SUPPORT_IFPWRMNGTRCV 0x0200
118 u_int16_t reserved77;
119 u_int16_t satasupport;
120 #define ATA_SUPPORT_NONZERO 0x0002
121 #define ATA_SUPPORT_AUTOACTIVATE 0x0004
122 #define ATA_SUPPORT_IFPWRMNGT 0x0008
123 #define ATA_SUPPORT_INORDERDATA 0x0010
124 u_int16_t sataenabled;
126 /*080*/ u_int16_t version_major;
127 /*081*/ u_int16_t version_minor;
130 /*082/085*/ u_int16_t command1;
131 #define ATA_SUPPORT_SMART 0x0001
132 #define ATA_SUPPORT_SECURITY 0x0002
133 #define ATA_SUPPORT_REMOVABLE 0x0004
134 #define ATA_SUPPORT_POWERMGT 0x0008
135 #define ATA_SUPPORT_PACKET 0x0010
136 #define ATA_SUPPORT_WRITECACHE 0x0020
137 #define ATA_SUPPORT_LOOKAHEAD 0x0040
138 #define ATA_SUPPORT_RELEASEIRQ 0x0080
139 #define ATA_SUPPORT_SERVICEIRQ 0x0100
140 #define ATA_SUPPORT_RESET 0x0200
141 #define ATA_SUPPORT_PROTECTED 0x0400
142 #define ATA_SUPPORT_WRITEBUFFER 0x1000
143 #define ATA_SUPPORT_READBUFFER 0x2000
144 #define ATA_SUPPORT_NOP 0x4000
146 /*083/086*/ u_int16_t command2;
147 #define ATA_SUPPORT_MICROCODE 0x0001
148 #define ATA_SUPPORT_QUEUED 0x0002
149 #define ATA_SUPPORT_CFA 0x0004
150 #define ATA_SUPPORT_APM 0x0008
151 #define ATA_SUPPORT_NOTIFY 0x0010
152 #define ATA_SUPPORT_STANDBY 0x0020
153 #define ATA_SUPPORT_SPINUP 0x0040
154 #define ATA_SUPPORT_MAXSECURITY 0x0100
155 #define ATA_SUPPORT_AUTOACOUSTIC 0x0200
156 #define ATA_SUPPORT_ADDRESS48 0x0400
157 #define ATA_SUPPORT_OVERLAY 0x0800
158 #define ATA_SUPPORT_FLUSHCACHE 0x1000
159 #define ATA_SUPPORT_FLUSHCACHE48 0x2000
161 /*084/087*/ u_int16_t extension;
162 } __packed support, enabled;
164 /*088*/ u_int16_t udmamodes; /* UltraDMA modes */
165 /*089*/ u_int16_t erase_time;
166 /*090*/ u_int16_t enhanced_erase_time;
167 /*091*/ u_int16_t apm_value;
168 /*092*/ u_int16_t master_passwd_revision;
169 /*093*/ u_int16_t hwres;
170 #define ATA_CABLE_ID 0x2000
172 /*094*/ u_int16_t acoustic;
173 #define ATA_ACOUSTIC_CURRENT(x) ((x) & 0x00ff)
174 #define ATA_ACOUSTIC_VENDOR(x) (((x) & 0xff00) >> 8)
176 /*095*/ u_int16_t stream_min_req_size;
177 /*096*/ u_int16_t stream_transfer_time;
178 /*097*/ u_int16_t stream_access_latency;
179 /*098*/ u_int32_t stream_granularity;
180 /*100*/ u_int16_t lba_size48_1;
181 u_int16_t lba_size48_2;
182 u_int16_t lba_size48_3;
183 u_int16_t lba_size48_4;
184 u_int16_t reserved104[23];
185 /*127*/ u_int16_t removable_status;
186 /*128*/ u_int16_t security_status;
187 u_int16_t reserved129[31];
188 /*160*/ u_int16_t cfa_powermode1;
189 u_int16_t reserved161[15];
190 /*176*/ u_int16_t media_serial[30];
191 u_int16_t reserved206[49];
192 /*255*/ u_int16_t integrity;
196 /* ATA transfer modes */
197 #define ATA_MODE_MASK 0x0f
198 #define ATA_DMA_MASK 0xf0
200 #define ATA_PIO0 0x08
201 #define ATA_PIO1 0x09
202 #define ATA_PIO2 0x0a
203 #define ATA_PIO3 0x0b
204 #define ATA_PIO4 0x0c
205 #define ATA_PIO_MAX 0x0f
207 #define ATA_WDMA0 0x20
208 #define ATA_WDMA1 0x21
209 #define ATA_WDMA2 0x22
210 #define ATA_UDMA0 0x40
211 #define ATA_UDMA1 0x41
212 #define ATA_UDMA2 0x42
213 #define ATA_UDMA3 0x43
214 #define ATA_UDMA4 0x44
215 #define ATA_UDMA5 0x45
216 #define ATA_UDMA6 0x46
217 #define ATA_SA150 0x47
218 #define ATA_DMA_MAX 0x4f
222 #define ATA_NOP 0x00 /* NOP */
223 #define ATA_NF_FLUSHQUEUE 0x00 /* flush queued cmd's */
224 #define ATA_NF_AUTOPOLL 0x01 /* start autopoll function */
225 #define ATA_DEVICE_RESET 0x08 /* reset device */
226 #define ATA_READ 0x20 /* read */
227 #define ATA_READ48 0x24 /* read 48bit LBA */
228 #define ATA_READ_DMA48 0x25 /* read DMA 48bit LBA */
229 #define ATA_READ_DMA_QUEUED48 0x26 /* read DMA QUEUED 48bit LBA */
230 #define ATA_READ_MUL48 0x29 /* read multi 48bit LBA */
231 #define ATA_WRITE 0x30 /* write */
232 #define ATA_WRITE48 0x34 /* write 48bit LBA */
233 #define ATA_WRITE_DMA48 0x35 /* write DMA 48bit LBA */
234 #define ATA_WRITE_DMA_QUEUED48 0x36 /* write DMA QUEUED 48bit LBA*/
235 #define ATA_WRITE_MUL48 0x39 /* write multi 48bit LBA */
236 #define ATA_READ_FPDMA_QUEUED 0x60 /* read DMA NCQ */
237 #define ATA_WRITE_FPDMA_QUEUED 0x61 /* write DMA NCQ */
238 #define ATA_SEEK 0x70 /* seek */
239 #define ATA_PACKET_CMD 0xa0 /* packet command */
240 #define ATA_ATAPI_IDENTIFY 0xa1 /* get ATAPI params*/
241 #define ATA_SERVICE 0xa2 /* service command */
242 #define ATA_CFA_ERASE 0xc0 /* CFA erase */
243 #define ATA_READ_MUL 0xc4 /* read multi */
244 #define ATA_WRITE_MUL 0xc5 /* write multi */
245 #define ATA_SET_MULTI 0xc6 /* set multi size */
246 #define ATA_READ_DMA_QUEUED 0xc7 /* read DMA QUEUED */
247 #define ATA_READ_DMA 0xc8 /* read DMA */
248 #define ATA_WRITE_DMA 0xca /* write DMA */
249 #define ATA_WRITE_DMA_QUEUED 0xcc /* write DMA QUEUED */
250 #define ATA_STANDBY_IMMEDIATE 0xe0 /* standby immediate */
251 #define ATA_IDLE_IMMEDIATE 0xe1 /* idle immediate */
252 #define ATA_STANDBY_CMD 0xe2 /* standby */
253 #define ATA_IDLE_CMD 0xe3 /* idle */
254 #define ATA_READ_BUFFER 0xe4 /* read buffer */
255 #define ATA_SLEEP 0xe6 /* sleep */
256 #define ATA_FLUSHCACHE 0xe7 /* flush cache to disk */
257 #define ATA_FLUSHCACHE48 0xea /* flush cache to disk */
258 #define ATA_ATA_IDENTIFY 0xec /* get ATA params */
259 #define ATA_SETFEATURES 0xef /* features command */
260 #define ATA_SF_SETXFER 0x03 /* set transfer mode */
261 #define ATA_SF_ENAB_WCACHE 0x02 /* enable write cache */
262 #define ATA_SF_DIS_WCACHE 0x82 /* disable write cache */
263 #define ATA_SF_ENAB_RCACHE 0xaa /* enable readahead cache */
264 #define ATA_SF_DIS_RCACHE 0x55 /* disable readahead cache */
265 #define ATA_SF_ENAB_RELIRQ 0x5d /* enable release interrupt */
266 #define ATA_SF_DIS_RELIRQ 0xdd /* disable release interrupt */
267 #define ATA_SF_ENAB_SRVIRQ 0x5e /* enable service interrupt */
268 #define ATA_SF_DIS_SRVIRQ 0xde /* disable service interrupt */
269 #define ATA_SECURITY_FREEE_LOCK 0xf5 /* freeze security config */
270 #define ATA_READ_NATIVE_MAX_ADDDRESS 0xf8 /* read native max address */
271 #define ATA_SET_MAX_ADDRESS 0xf9 /* set max address */
275 #define ATAPI_TEST_UNIT_READY 0x00 /* check if device is ready */
276 #define ATAPI_REZERO 0x01 /* rewind */
277 #define ATAPI_REQUEST_SENSE 0x03 /* get sense data */
278 #define ATAPI_FORMAT 0x04 /* format unit */
279 #define ATAPI_READ 0x08 /* read data */
280 #define ATAPI_WRITE 0x0a /* write data */
281 #define ATAPI_WEOF 0x10 /* write filemark */
282 #define ATAPI_WF_WRITE 0x01
283 #define ATAPI_SPACE 0x11 /* space command */
284 #define ATAPI_SP_FM 0x01
285 #define ATAPI_SP_EOD 0x03
286 #define ATAPI_MODE_SELECT 0x15 /* mode select */
287 #define ATAPI_ERASE 0x19 /* erase */
288 #define ATAPI_MODE_SENSE 0x1a /* mode sense */
289 #define ATAPI_START_STOP 0x1b /* start/stop unit */
290 #define ATAPI_SS_LOAD 0x01
291 #define ATAPI_SS_RETENSION 0x02
292 #define ATAPI_SS_EJECT 0x04
293 #define ATAPI_PREVENT_ALLOW 0x1e /* media removal */
294 #define ATAPI_READ_FORMAT_CAPACITIES 0x23 /* get format capacities */
295 #define ATAPI_READ_CAPACITY 0x25 /* get volume capacity */
296 #define ATAPI_READ_BIG 0x28 /* read data */
297 #define ATAPI_WRITE_BIG 0x2a /* write data */
298 #define ATAPI_LOCATE 0x2b /* locate to position */
299 #define ATAPI_READ_POSITION 0x34 /* read position */
300 #define ATAPI_SYNCHRONIZE_CACHE 0x35 /* flush buf, close channel */
301 #define ATAPI_WRITE_BUFFER 0x3b /* write device buffer */
302 #define ATAPI_READ_BUFFER 0x3c /* read device buffer */
303 #define ATAPI_READ_SUBCHANNEL 0x42 /* get subchannel info */
304 #define ATAPI_READ_TOC 0x43 /* get table of contents */
305 #define ATAPI_PLAY_10 0x45 /* play by lba */
306 #define ATAPI_PLAY_MSF 0x47 /* play by MSF address */
307 #define ATAPI_PLAY_TRACK 0x48 /* play by track number */
308 #define ATAPI_PAUSE 0x4b /* pause audio operation */
309 #define ATAPI_READ_DISK_INFO 0x51 /* get disk info structure */
310 #define ATAPI_READ_TRACK_INFO 0x52 /* get track info structure */
311 #define ATAPI_RESERVE_TRACK 0x53 /* reserve track */
312 #define ATAPI_SEND_OPC_INFO 0x54 /* send OPC structurek */
313 #define ATAPI_MODE_SELECT_BIG 0x55 /* set device parameters */
314 #define ATAPI_REPAIR_TRACK 0x58 /* repair track */
315 #define ATAPI_READ_MASTER_CUE 0x59 /* read master CUE info */
316 #define ATAPI_MODE_SENSE_BIG 0x5a /* get device parameters */
317 #define ATAPI_CLOSE_TRACK 0x5b /* close track/session */
318 #define ATAPI_READ_BUFFER_CAPACITY 0x5c /* get buffer capicity */
319 #define ATAPI_SEND_CUE_SHEET 0x5d /* send CUE sheet */
320 #define ATAPI_BLANK 0xa1 /* blank the media */
321 #define ATAPI_SEND_KEY 0xa3 /* send DVD key structure */
322 #define ATAPI_REPORT_KEY 0xa4 /* get DVD key structure */
323 #define ATAPI_PLAY_12 0xa5 /* play by lba */
324 #define ATAPI_LOAD_UNLOAD 0xa6 /* changer control command */
325 #define ATAPI_READ_STRUCTURE 0xad /* get DVD structure */
326 #define ATAPI_PLAY_CD 0xb4 /* universal play command */
327 #define ATAPI_SET_SPEED 0xbb /* set drive speed */
328 #define ATAPI_MECH_STATUS 0xbd /* get changer status */
329 #define ATAPI_READ_CD 0xbe /* read data */
330 #define ATAPI_POLL_DSC 0xff /* poll DSC status bit */
333 struct ata_ioc_devices {
336 struct ata_params params[2];
339 /* pr channel ATA ioctl calls */
340 #define IOCATAGMAXCHANNEL _IOR('a', 1, int)
341 #define IOCATAREINIT _IOW('a', 2, int)
342 #define IOCATAATTACH _IOW('a', 3, int)
343 #define IOCATADETACH _IOW('a', 4, int)
344 #define IOCATADEVICES _IOWR('a', 5, struct ata_ioc_devices)
346 struct ata_ioc_request {
361 #define ATA_CMD_CONTROL 0x01
362 #define ATA_CMD_READ 0x02
363 #define ATA_CMD_WRITE 0x04
364 #define ATA_CMD_ATAPI 0x08
370 /* pr device ATA ioctl calls */
371 #define IOCATAREQUEST _IOWR('a', 100, struct ata_ioc_request)
372 #define IOCATAGPARM _IOR('a', 101, struct ata_params)
373 #define IOCATAGMODE _IOR('a', 102, int)
374 #define IOCATASMODE _IOW('a', 103, int)
377 struct ata_ioc_raid_config {
380 #define AR_JBOD 0x0001
381 #define AR_SPAN 0x0002
382 #define AR_RAID0 0x0004
383 #define AR_RAID1 0x0008
384 #define AR_RAID01 0x0010
385 #define AR_RAID3 0x0020
386 #define AR_RAID4 0x0040
387 #define AR_RAID5 0x0080
392 #define AR_DEGRADED 2
393 #define AR_REBUILDING 4
400 /* ATA RAID ioctl calls */
401 #define IOCATARAIDCREATE _IOW('a', 200, struct ata_ioc_raid_config)
402 #define IOCATARAIDDELETE _IOW('a', 201, int)
403 #define IOCATARAIDSTATUS _IOR('a', 202, struct ata_ioc_raid_config)
404 #define IOCATARAIDADDSPARE _IOW('a', 203, struct ata_ioc_raid_config)
405 #define IOCATARAIDREBUILD _IOW('a', 204, int)
407 #endif /* _SYS_ATA_H_ */