ata.h revision 230132
174298Ssos/*-
2230132Suqs * Copyright (c) 2000 - 2008 S��ren Schmidt <sos@FreeBSD.org>
374298Ssos * All rights reserved.
474298Ssos *
574298Ssos * Redistribution and use in source and binary forms, with or without
674298Ssos * modification, are permitted provided that the following conditions
774298Ssos * are met:
874298Ssos * 1. Redistributions of source code must retain the above copyright
974298Ssos *    notice, this list of conditions and the following disclaimer,
1074298Ssos *    without modification, immediately at the beginning of the file.
1174298Ssos * 2. Redistributions in binary form must reproduce the above copyright
1274298Ssos *    notice, this list of conditions and the following disclaimer in the
1374298Ssos *    documentation and/or other materials provided with the distribution.
1474298Ssos *
1574298Ssos * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1674298Ssos * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1774298Ssos * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1874298Ssos * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1974298Ssos * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2074298Ssos * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2174298Ssos * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2274298Ssos * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2374298Ssos * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2474298Ssos * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2574298Ssos *
2674298Ssos * $FreeBSD: head/sys/sys/ata.h 230132 2012-01-15 13:23:18Z uqs $
2774298Ssos */
2874298Ssos
2974298Ssos#ifndef _SYS_ATA_H_
3074298Ssos#define _SYS_ATA_H_
3174298Ssos
3274298Ssos#include <sys/ioccom.h>
3374298Ssos
34119404Ssos/* ATA/ATAPI device parameters */
3593881Ssosstruct ata_params {
36146266Ssos/*000*/ u_int16_t       config;         /* configuration info */
37146266Ssos#define ATA_PROTO_MASK                  0x8003
38146266Ssos#define ATA_PROTO_ATAPI                 0x8000
39146266Ssos#define ATA_PROTO_ATAPI_12              0x8000
40146266Ssos#define ATA_PROTO_ATAPI_16              0x8001
41174682Sphk#define ATA_PROTO_CFA                   0x848a
42146266Ssos#define ATA_ATAPI_TYPE_MASK             0x1f00
43146266Ssos#define ATA_ATAPI_TYPE_DIRECT           0x0000  /* disk/floppy */
44146266Ssos#define ATA_ATAPI_TYPE_TAPE             0x0100  /* streaming tape */
45146266Ssos#define ATA_ATAPI_TYPE_CDROM            0x0500  /* CD-ROM device */
46146266Ssos#define ATA_ATAPI_TYPE_OPTICAL          0x0700  /* optical disk */
47146266Ssos#define ATA_DRQ_MASK                    0x0060
48146266Ssos#define ATA_DRQ_SLOW                    0x0000  /* cpu 3 ms delay */
49146266Ssos#define ATA_DRQ_INTR                    0x0020  /* interrupt 10 ms delay */
50146266Ssos#define ATA_DRQ_FAST                    0x0040  /* accel 50 us delay */
51203421Smav#define ATA_RESP_INCOMPLETE             0x0004
5293881Ssos
53146266Ssos/*001*/ u_int16_t       cylinders;              /* # of cylinders */
54204354Smav/*002*/ u_int16_t       specconf;		/* specific configuration */
55146266Ssos/*003*/ u_int16_t       heads;                  /* # heads */
56146266Ssos	u_int16_t       obsolete4;
57146266Ssos	u_int16_t       obsolete5;
58146266Ssos/*006*/ u_int16_t       sectors;                /* # sectors/track */
59146266Ssos/*007*/ u_int16_t       vendor7[3];
60146266Ssos/*010*/ u_int8_t        serial[20];             /* serial number */
61146266Ssos/*020*/ u_int16_t       retired20;
62146266Ssos	u_int16_t       retired21;
63146266Ssos	u_int16_t       obsolete22;
64146266Ssos/*023*/ u_int8_t        revision[8];            /* firmware revision */
65146266Ssos/*027*/ u_int8_t        model[40];              /* model name */
66146266Ssos/*047*/ u_int16_t       sectors_intr;           /* sectors per interrupt */
67146266Ssos/*048*/ u_int16_t       usedmovsd;              /* double word read/write? */
68146266Ssos/*049*/ u_int16_t       capabilities1;
69146266Ssos#define ATA_SUPPORT_DMA                 0x0100
70146266Ssos#define ATA_SUPPORT_LBA                 0x0200
71197540Smav#define ATA_SUPPORT_IORDY               0x0400
72197540Smav#define ATA_SUPPORT_IORDYDIS            0x0800
73146266Ssos#define ATA_SUPPORT_OVERLAP             0x4000
7493881Ssos
75146266Ssos/*050*/ u_int16_t       capabilities2;
76146266Ssos/*051*/ u_int16_t       retired_piomode;        /* PIO modes 0-2 */
77146266Ssos#define ATA_RETIRED_PIO_MASK            0x0300
7874298Ssos
79146266Ssos/*052*/ u_int16_t       retired_dmamode;        /* DMA modes */
80146266Ssos#define ATA_RETIRED_DMA_MASK            0x0003
8174298Ssos
82146266Ssos/*053*/ u_int16_t       atavalid;               /* fields valid */
83146266Ssos#define ATA_FLAG_54_58                  0x0001  /* words 54-58 valid */
84146266Ssos#define ATA_FLAG_64_70                  0x0002  /* words 64-70 valid */
85146266Ssos#define ATA_FLAG_88                     0x0004  /* word 88 valid */
8674298Ssos
87146266Ssos/*054*/ u_int16_t       current_cylinders;
88146266Ssos/*055*/ u_int16_t       current_heads;
89146266Ssos/*056*/ u_int16_t       current_sectors;
90146266Ssos/*057*/ u_int16_t       current_size_1;
91146266Ssos/*058*/ u_int16_t       current_size_2;
92146266Ssos/*059*/ u_int16_t       multi;
93146266Ssos#define ATA_MULTI_VALID                 0x0100
9493881Ssos
95146266Ssos/*060*/ u_int16_t       lba_size_1;
96146266Ssos	u_int16_t       lba_size_2;
97146266Ssos	u_int16_t       obsolete62;
98146266Ssos/*063*/ u_int16_t       mwdmamodes;             /* multiword DMA modes */
99146266Ssos/*064*/ u_int16_t       apiomodes;              /* advanced PIO modes */
10074298Ssos
101146266Ssos/*065*/ u_int16_t       mwdmamin;               /* min. M/W DMA time/word ns */
102146266Ssos/*066*/ u_int16_t       mwdmarec;               /* rec. M/W DMA time ns */
103146266Ssos/*067*/ u_int16_t       pioblind;               /* min. PIO cycle w/o flow */
104146266Ssos/*068*/ u_int16_t       pioiordy;               /* min. PIO cycle IORDY flow */
105201139Smav/*069*/ u_int16_t       support3;
106201139Smav#define ATA_SUPPORT_RZAT                0x0020
107201139Smav#define ATA_SUPPORT_DRAT                0x4000
108146266Ssos	u_int16_t       reserved70;
109146266Ssos/*071*/ u_int16_t       rlsovlap;               /* rel time (us) for overlap */
110146266Ssos/*072*/ u_int16_t       rlsservice;             /* rel time (us) for service */
111146266Ssos	u_int16_t       reserved73;
112146266Ssos	u_int16_t       reserved74;
113146266Ssos/*075*/ u_int16_t       queue;
114146266Ssos#define ATA_QUEUE_LEN(x)                ((x) & 0x001f)
11574298Ssos
116197540Smav/*76*/  u_int16_t       satacapabilities;
117146266Ssos#define ATA_SATA_GEN1                   0x0002
118146266Ssos#define ATA_SATA_GEN2                   0x0004
119197540Smav#define ATA_SATA_GEN3                   0x0008
120146266Ssos#define ATA_SUPPORT_NCQ                 0x0100
121146266Ssos#define ATA_SUPPORT_IFPWRMNGTRCV        0x0200
122194902Smav#define ATA_SUPPORT_PHYEVENTCNT         0x0400
123194902Smav#define ATA_SUPPORT_NCQ_UNLOAD          0x0800
124194902Smav#define ATA_SUPPORT_NCQ_PRIO            0x1000
125197540Smav#define ATA_SUPPORT_HAPST               0x2000
126197540Smav#define ATA_SUPPORT_DAPST               0x4000
127197540Smav#define ATA_SUPPORT_READLOGDMAEXT       0x8000
128127021Ssos
129197540Smav/*77*/  u_int16_t       satacapabilities2;
130197540Smav#define ATA_SATA_CURR_GEN_MASK          0x0006
131197540Smav#define ATA_SUPPORT_NCQ_STREAM          0x0010
132197540Smav#define ATA_SUPPORT_NCQ_QMANAGEMENT     0x0020
133197540Smav/*78*/  u_int16_t       satasupport;
134146266Ssos#define ATA_SUPPORT_NONZERO             0x0002
135146266Ssos#define ATA_SUPPORT_AUTOACTIVATE        0x0004
136146266Ssos#define ATA_SUPPORT_IFPWRMNGT           0x0008
137146266Ssos#define ATA_SUPPORT_INORDERDATA         0x0010
138220602Smav#define ATA_SUPPORT_ASYNCNOTIF          0x0020
139197540Smav#define ATA_SUPPORT_SOFTSETPRESERVE     0x0040
140197540Smav/*79*/  u_int16_t       sataenabled;
141197540Smav#define ATA_ENABLED_DAPST               0x0080
142127021Ssos
143146266Ssos/*080*/ u_int16_t       version_major;
144146266Ssos/*081*/ u_int16_t       version_minor;
145119404Ssos
14684584Ssos	struct {
147146266Ssos/*082/085*/ u_int16_t   command1;
148146266Ssos#define ATA_SUPPORT_SMART               0x0001
149146266Ssos#define ATA_SUPPORT_SECURITY            0x0002
150146266Ssos#define ATA_SUPPORT_REMOVABLE           0x0004
151146266Ssos#define ATA_SUPPORT_POWERMGT            0x0008
152146266Ssos#define ATA_SUPPORT_PACKET              0x0010
153146266Ssos#define ATA_SUPPORT_WRITECACHE          0x0020
154146266Ssos#define ATA_SUPPORT_LOOKAHEAD           0x0040
155146266Ssos#define ATA_SUPPORT_RELEASEIRQ          0x0080
156146266Ssos#define ATA_SUPPORT_SERVICEIRQ          0x0100
157146266Ssos#define ATA_SUPPORT_RESET               0x0200
158146266Ssos#define ATA_SUPPORT_PROTECTED           0x0400
159146266Ssos#define ATA_SUPPORT_WRITEBUFFER         0x1000
160146266Ssos#define ATA_SUPPORT_READBUFFER          0x2000
161146266Ssos#define ATA_SUPPORT_NOP                 0x4000
16284584Ssos
163146266Ssos/*083/086*/ u_int16_t   command2;
164146266Ssos#define ATA_SUPPORT_MICROCODE           0x0001
165146266Ssos#define ATA_SUPPORT_QUEUED              0x0002
166146266Ssos#define ATA_SUPPORT_CFA                 0x0004
167146266Ssos#define ATA_SUPPORT_APM                 0x0008
168146266Ssos#define ATA_SUPPORT_NOTIFY              0x0010
169146266Ssos#define ATA_SUPPORT_STANDBY             0x0020
170146266Ssos#define ATA_SUPPORT_SPINUP              0x0040
171146266Ssos#define ATA_SUPPORT_MAXSECURITY         0x0100
172146266Ssos#define ATA_SUPPORT_AUTOACOUSTIC        0x0200
173146266Ssos#define ATA_SUPPORT_ADDRESS48           0x0400
174146266Ssos#define ATA_SUPPORT_OVERLAY             0x0800
175146266Ssos#define ATA_SUPPORT_FLUSHCACHE          0x1000
176146266Ssos#define ATA_SUPPORT_FLUSHCACHE48        0x2000
17784584Ssos
178146266Ssos/*084/087*/ u_int16_t   extension;
179197540Smav#define ATA_SUPPORT_SMARTLOG		0x0001
180197540Smav#define ATA_SUPPORT_SMARTTEST		0x0002
181172606Sscottl#define ATA_SUPPORT_MEDIASN		0x0004
182172606Sscottl#define ATA_SUPPORT_MEDIAPASS		0x0008
183172606Sscottl#define ATA_SUPPORT_STREAMING		0x0010
184172606Sscottl#define ATA_SUPPORT_GENLOG		0x0020
185172606Sscottl#define ATA_SUPPORT_WRITEDMAFUAEXT	0x0040
186172606Sscottl#define ATA_SUPPORT_WRITEDMAQFUAEXT	0x0080
187172606Sscottl#define ATA_SUPPORT_64BITWWN		0x0100
188197540Smav#define ATA_SUPPORT_UNLOAD		0x2000
189144330Ssos	} __packed support, enabled;
19084584Ssos
191146266Ssos/*088*/ u_int16_t       udmamodes;              /* UltraDMA modes */
192146266Ssos/*089*/ u_int16_t       erase_time;
193146266Ssos/*090*/ u_int16_t       enhanced_erase_time;
194146266Ssos/*091*/ u_int16_t       apm_value;
195146266Ssos/*092*/ u_int16_t       master_passwd_revision;
196146266Ssos/*093*/ u_int16_t       hwres;
197146266Ssos#define ATA_CABLE_ID                    0x2000
19884584Ssos
199146266Ssos/*094*/ u_int16_t       acoustic;
200146266Ssos#define ATA_ACOUSTIC_CURRENT(x)         ((x) & 0x00ff)
201146266Ssos#define ATA_ACOUSTIC_VENDOR(x)          (((x) & 0xff00) >> 8)
20284584Ssos
203146266Ssos/*095*/ u_int16_t       stream_min_req_size;
204146266Ssos/*096*/ u_int16_t       stream_transfer_time;
205146266Ssos/*097*/ u_int16_t       stream_access_latency;
206146266Ssos/*098*/ u_int32_t       stream_granularity;
207146266Ssos/*100*/ u_int16_t       lba_size48_1;
208146266Ssos	u_int16_t       lba_size48_2;
209146266Ssos	u_int16_t       lba_size48_3;
210146266Ssos	u_int16_t       lba_size48_4;
211201139Smav	u_int16_t       reserved104;
212201139Smav/*105*/	u_int16_t       max_dsm_blocks;
213197540Smav/*106*/	u_int16_t       pss;
214197540Smav#define ATA_PSS_LSPPS			0x000F
215198865Smav#define ATA_PSS_LSSABOVE512		0x1000
216198865Smav#define ATA_PSS_MULTLS			0x2000
217197540Smav/*107*/ u_int16_t       isd;
218197540Smav/*108*/ u_int16_t       wwn[4];
219197540Smav	u_int16_t       reserved112[5];
220197540Smav/*117*/ u_int16_t       lss_1;
221197540Smav/*118*/ u_int16_t       lss_2;
222197540Smav/*119*/ u_int16_t       support2;
223197540Smav#define ATA_SUPPORT_WRITEREADVERIFY	0x0002
224197540Smav#define ATA_SUPPORT_WRITEUNCORREXT	0x0004
225197540Smav#define ATA_SUPPORT_RWLOGDMAEXT		0x0008
226197540Smav#define ATA_SUPPORT_MICROCODE3		0x0010
227197540Smav#define ATA_SUPPORT_FREEFALL		0x0020
228197540Smav/*120*/ u_int16_t       enabled2;
229197540Smav	u_int16_t       reserved121[6];
230146266Ssos/*127*/ u_int16_t       removable_status;
231146266Ssos/*128*/ u_int16_t       security_status;
232146266Ssos	u_int16_t       reserved129[31];
233146266Ssos/*160*/ u_int16_t       cfa_powermode1;
234198587Smav	u_int16_t       reserved161;
235198587Smav/*162*/ u_int16_t       cfa_kms_support;
236198587Smav/*163*/ u_int16_t       cfa_trueide_modes;
237198587Smav/*164*/ u_int16_t       cfa_memory_modes;
238201139Smav	u_int16_t       reserved165[4];
239201139Smav/*169*/	u_int16_t       support_dsm;
240201139Smav#define ATA_SUPPORT_DSM_TRIM		0x0001
241201139Smav	u_int16_t       reserved170[6];
242197540Smav/*176*/ u_int8_t        media_serial[60];
243197540Smav/*206*/ u_int16_t       sct;
244197540Smav	u_int16_t       reserved206[2];
245198897Smav/*209*/ u_int16_t       lsalign;
246197540Smav/*210*/ u_int16_t       wrv_sectors_m3_1;
247197540Smav	u_int16_t       wrv_sectors_m3_2;
248197540Smav/*212*/ u_int16_t       wrv_sectors_m2_1;
249197540Smav	u_int16_t       wrv_sectors_m2_2;
250197540Smav/*214*/ u_int16_t       nv_cache_caps;
251197540Smav/*215*/ u_int16_t       nv_cache_size_1;
252197540Smav	u_int16_t       nv_cache_size_2;
253197540Smav/*217*/ u_int16_t       media_rotation_rate;
254197540Smav	u_int16_t       reserved218;
255197540Smav/*219*/ u_int16_t       nv_cache_opt;
256197540Smav/*220*/ u_int16_t       wrv_mode;
257197540Smav	u_int16_t       reserved221;
258197540Smav/*222*/ u_int16_t       transport_major;
259197540Smav/*223*/ u_int16_t       transport_minor;
260197540Smav	u_int16_t       reserved224[31];
261146266Ssos/*255*/ u_int16_t       integrity;
262144330Ssos} __packed;
26374298Ssos
264146266Ssos
265119404Ssos/* ATA transfer modes */
266146266Ssos#define ATA_MODE_MASK           0x0f
267146266Ssos#define ATA_DMA_MASK            0xf0
268146266Ssos#define ATA_PIO                 0x00
269146266Ssos#define ATA_PIO0                0x08
270146266Ssos#define ATA_PIO1                0x09
271146266Ssos#define ATA_PIO2                0x0a
272146266Ssos#define ATA_PIO3                0x0b
273146266Ssos#define ATA_PIO4                0x0c
274146266Ssos#define ATA_PIO_MAX             0x0f
275146266Ssos#define ATA_DMA                 0x10
276146266Ssos#define ATA_WDMA0               0x20
277146266Ssos#define ATA_WDMA1               0x21
278146266Ssos#define ATA_WDMA2               0x22
279146266Ssos#define ATA_UDMA0               0x40
280146266Ssos#define ATA_UDMA1               0x41
281146266Ssos#define ATA_UDMA2               0x42
282146266Ssos#define ATA_UDMA3               0x43
283146266Ssos#define ATA_UDMA4               0x44
284146266Ssos#define ATA_UDMA5               0x45
285146266Ssos#define ATA_UDMA6               0x46
286146266Ssos#define ATA_SA150               0x47
287148991Ssos#define ATA_SA300               0x48
288146266Ssos#define ATA_DMA_MAX             0x4f
28974298Ssos
290146266Ssos
291119404Ssos/* ATA commands */
292146266Ssos#define ATA_NOP                         0x00    /* NOP */
293146266Ssos#define         ATA_NF_FLUSHQUEUE       0x00    /* flush queued cmd's */
294146266Ssos#define         ATA_NF_AUTOPOLL         0x01    /* start autopoll function */
295201139Smav#define ATA_DATA_SET_MANAGEMENT		0x06
296201139Smav#define 	ATA_DSM_TRIM		0x01
297146266Ssos#define ATA_DEVICE_RESET                0x08    /* reset device */
298146266Ssos#define ATA_READ                        0x20    /* read */
299146266Ssos#define ATA_READ48                      0x24    /* read 48bit LBA */
300146266Ssos#define ATA_READ_DMA48                  0x25    /* read DMA 48bit LBA */
301146266Ssos#define ATA_READ_DMA_QUEUED48           0x26    /* read DMA QUEUED 48bit LBA */
302178067Ssos#define ATA_READ_NATIVE_MAX_ADDRESS48   0x27    /* read native max addr 48bit */
303146266Ssos#define ATA_READ_MUL48                  0x29    /* read multi 48bit LBA */
304200008Smav#define ATA_READ_STREAM_DMA48           0x2a    /* read DMA stream 48bit LBA */
305200008Smav#define ATA_READ_STREAM48               0x2b    /* read stream 48bit LBA */
306146266Ssos#define ATA_WRITE                       0x30    /* write */
307146266Ssos#define ATA_WRITE48                     0x34    /* write 48bit LBA */
308146266Ssos#define ATA_WRITE_DMA48                 0x35    /* write DMA 48bit LBA */
309146266Ssos#define ATA_WRITE_DMA_QUEUED48          0x36    /* write DMA QUEUED 48bit LBA*/
310152270Ssos#define ATA_SET_MAX_ADDRESS48           0x37    /* set max address 48bit */
311146266Ssos#define ATA_WRITE_MUL48                 0x39    /* write multi 48bit LBA */
312200008Smav#define ATA_WRITE_STREAM_DMA48          0x3a
313200008Smav#define ATA_WRITE_STREAM48              0x3b
314200008Smav#define ATA_WRITE_DMA_FUA48             0x3d
315200008Smav#define ATA_WRITE_DMA_QUEUED_FUA48      0x3e
316200008Smav#define ATA_WRITE_LOG_EXT               0x3f
317200008Smav#define ATA_READ_VERIFY                 0x40
318200008Smav#define ATA_READ_VERIFY48               0x42
319146266Ssos#define ATA_READ_FPDMA_QUEUED           0x60    /* read DMA NCQ */
320146266Ssos#define ATA_WRITE_FPDMA_QUEUED          0x61    /* write DMA NCQ */
321146266Ssos#define ATA_SEEK                        0x70    /* seek */
322146266Ssos#define ATA_PACKET_CMD                  0xa0    /* packet command */
323146266Ssos#define ATA_ATAPI_IDENTIFY              0xa1    /* get ATAPI params*/
324146266Ssos#define ATA_SERVICE                     0xa2    /* service command */
325166287Sremko#define ATA_SMART_CMD                   0xb0    /* SMART command */
326146266Ssos#define ATA_CFA_ERASE                   0xc0    /* CFA erase */
327146266Ssos#define ATA_READ_MUL                    0xc4    /* read multi */
328146266Ssos#define ATA_WRITE_MUL                   0xc5    /* write multi */
329146266Ssos#define ATA_SET_MULTI                   0xc6    /* set multi size */
330146266Ssos#define ATA_READ_DMA_QUEUED             0xc7    /* read DMA QUEUED */
331146266Ssos#define ATA_READ_DMA                    0xc8    /* read DMA */
332146266Ssos#define ATA_WRITE_DMA                   0xca    /* write DMA */
333146266Ssos#define ATA_WRITE_DMA_QUEUED            0xcc    /* write DMA QUEUED */
334200008Smav#define ATA_WRITE_MUL_FUA48             0xce
335146266Ssos#define ATA_STANDBY_IMMEDIATE           0xe0    /* standby immediate */
336146266Ssos#define ATA_IDLE_IMMEDIATE              0xe1    /* idle immediate */
337146266Ssos#define ATA_STANDBY_CMD                 0xe2    /* standby */
338146266Ssos#define ATA_IDLE_CMD                    0xe3    /* idle */
339146266Ssos#define ATA_READ_BUFFER                 0xe4    /* read buffer */
340178067Ssos#define ATA_READ_PM                     0xe4    /* read portmultiplier */
341146266Ssos#define ATA_SLEEP                       0xe6    /* sleep */
342146266Ssos#define ATA_FLUSHCACHE                  0xe7    /* flush cache to disk */
343178067Ssos#define ATA_WRITE_PM                    0xe8    /* write portmultiplier */
344146266Ssos#define ATA_FLUSHCACHE48                0xea    /* flush cache to disk */
345146266Ssos#define ATA_ATA_IDENTIFY                0xec    /* get ATA params */
346146266Ssos#define ATA_SETFEATURES                 0xef    /* features command */
347146266Ssos#define         ATA_SF_SETXFER          0x03    /* set transfer mode */
348146266Ssos#define         ATA_SF_ENAB_WCACHE      0x02    /* enable write cache */
349146266Ssos#define         ATA_SF_DIS_WCACHE       0x82    /* disable write cache */
350203421Smav#define         ATA_SF_ENAB_PUIS        0x06    /* enable PUIS */
351203421Smav#define         ATA_SF_DIS_PUIS         0x86    /* disable PUIS */
352203421Smav#define         ATA_SF_PUIS_SPINUP      0x07    /* PUIS spin-up */
353146266Ssos#define         ATA_SF_ENAB_RCACHE      0xaa    /* enable readahead cache */
354146266Ssos#define         ATA_SF_DIS_RCACHE       0x55    /* disable readahead cache */
355146266Ssos#define         ATA_SF_ENAB_RELIRQ      0x5d    /* enable release interrupt */
356146266Ssos#define         ATA_SF_DIS_RELIRQ       0xdd    /* disable release interrupt */
357146266Ssos#define         ATA_SF_ENAB_SRVIRQ      0x5e    /* enable service interrupt */
358146266Ssos#define         ATA_SF_DIS_SRVIRQ       0xde    /* disable service interrupt */
359146266Ssos#define ATA_SECURITY_FREEE_LOCK         0xf5    /* freeze security config */
360178067Ssos#define ATA_READ_NATIVE_MAX_ADDRESS     0xf8    /* read native max address */
361146266Ssos#define ATA_SET_MAX_ADDRESS             0xf9    /* set max address */
362119404Ssos
363146266Ssos
364119404Ssos/* ATAPI commands */
365146266Ssos#define ATAPI_TEST_UNIT_READY           0x00    /* check if device is ready */
366146266Ssos#define ATAPI_REZERO                    0x01    /* rewind */
367146266Ssos#define ATAPI_REQUEST_SENSE             0x03    /* get sense data */
368146266Ssos#define ATAPI_FORMAT                    0x04    /* format unit */
369146266Ssos#define ATAPI_READ                      0x08    /* read data */
370146266Ssos#define ATAPI_WRITE                     0x0a    /* write data */
371146266Ssos#define ATAPI_WEOF                      0x10    /* write filemark */
372146266Ssos#define         ATAPI_WF_WRITE          0x01
373146266Ssos#define ATAPI_SPACE                     0x11    /* space command */
374146266Ssos#define         ATAPI_SP_FM             0x01
375146266Ssos#define         ATAPI_SP_EOD            0x03
376156317Ssos#define ATAPI_INQUIRY			0x12	/* get inquiry data */
377146266Ssos#define ATAPI_MODE_SELECT               0x15    /* mode select */
378146266Ssos#define ATAPI_ERASE                     0x19    /* erase */
379146266Ssos#define ATAPI_MODE_SENSE                0x1a    /* mode sense */
380146266Ssos#define ATAPI_START_STOP                0x1b    /* start/stop unit */
381146266Ssos#define         ATAPI_SS_LOAD           0x01
382146266Ssos#define         ATAPI_SS_RETENSION      0x02
383146266Ssos#define         ATAPI_SS_EJECT          0x04
384146266Ssos#define ATAPI_PREVENT_ALLOW             0x1e    /* media removal */
385146266Ssos#define ATAPI_READ_FORMAT_CAPACITIES    0x23    /* get format capacities */
386146266Ssos#define ATAPI_READ_CAPACITY             0x25    /* get volume capacity */
387146266Ssos#define ATAPI_READ_BIG                  0x28    /* read data */
388146266Ssos#define ATAPI_WRITE_BIG                 0x2a    /* write data */
389146266Ssos#define ATAPI_LOCATE                    0x2b    /* locate to position */
390146266Ssos#define ATAPI_READ_POSITION             0x34    /* read position */
391146266Ssos#define ATAPI_SYNCHRONIZE_CACHE         0x35    /* flush buf, close channel */
392146266Ssos#define ATAPI_WRITE_BUFFER              0x3b    /* write device buffer */
393146266Ssos#define ATAPI_READ_BUFFER               0x3c    /* read device buffer */
394146266Ssos#define ATAPI_READ_SUBCHANNEL           0x42    /* get subchannel info */
395146266Ssos#define ATAPI_READ_TOC                  0x43    /* get table of contents */
396146266Ssos#define ATAPI_PLAY_10                   0x45    /* play by lba */
397146266Ssos#define ATAPI_PLAY_MSF                  0x47    /* play by MSF address */
398146266Ssos#define ATAPI_PLAY_TRACK                0x48    /* play by track number */
399146266Ssos#define ATAPI_PAUSE                     0x4b    /* pause audio operation */
400146266Ssos#define ATAPI_READ_DISK_INFO            0x51    /* get disk info structure */
401146266Ssos#define ATAPI_READ_TRACK_INFO           0x52    /* get track info structure */
402146266Ssos#define ATAPI_RESERVE_TRACK             0x53    /* reserve track */
403146266Ssos#define ATAPI_SEND_OPC_INFO             0x54    /* send OPC structurek */
404146266Ssos#define ATAPI_MODE_SELECT_BIG           0x55    /* set device parameters */
405146266Ssos#define ATAPI_REPAIR_TRACK              0x58    /* repair track */
406146266Ssos#define ATAPI_READ_MASTER_CUE           0x59    /* read master CUE info */
407146266Ssos#define ATAPI_MODE_SENSE_BIG            0x5a    /* get device parameters */
408146266Ssos#define ATAPI_CLOSE_TRACK               0x5b    /* close track/session */
409146266Ssos#define ATAPI_READ_BUFFER_CAPACITY      0x5c    /* get buffer capicity */
410146266Ssos#define ATAPI_SEND_CUE_SHEET            0x5d    /* send CUE sheet */
411156317Ssos#define ATAPI_SERVICE_ACTION_IN         0x96	/* get service data */
412146266Ssos#define ATAPI_BLANK                     0xa1    /* blank the media */
413146266Ssos#define ATAPI_SEND_KEY                  0xa3    /* send DVD key structure */
414146266Ssos#define ATAPI_REPORT_KEY                0xa4    /* get DVD key structure */
415146266Ssos#define ATAPI_PLAY_12                   0xa5    /* play by lba */
416146266Ssos#define ATAPI_LOAD_UNLOAD               0xa6    /* changer control command */
417146266Ssos#define ATAPI_READ_STRUCTURE            0xad    /* get DVD structure */
418146266Ssos#define ATAPI_PLAY_CD                   0xb4    /* universal play command */
419146266Ssos#define ATAPI_SET_SPEED                 0xbb    /* set drive speed */
420146266Ssos#define ATAPI_MECH_STATUS               0xbd    /* get changer status */
421146266Ssos#define ATAPI_READ_CD                   0xbe    /* read data */
422146266Ssos#define ATAPI_POLL_DSC                  0xff    /* poll DSC status bit */
423119404Ssos
42474298Ssos
425146266Ssosstruct ata_ioc_devices {
426146266Ssos    int                 channel;
427146266Ssos    char                name[2][32];
428146266Ssos    struct ata_params   params[2];
429146266Ssos};
430119404Ssos
431146266Ssos/* pr channel ATA ioctl calls */
432146266Ssos#define IOCATAGMAXCHANNEL       _IOR('a',  1, int)
433146266Ssos#define IOCATAREINIT            _IOW('a',  2, int)
434146266Ssos#define IOCATAATTACH            _IOW('a',  3, int)
435146266Ssos#define IOCATADETACH            _IOW('a',  4, int)
436146266Ssos#define IOCATADEVICES           _IOWR('a',  5, struct ata_ioc_devices)
437119404Ssos
438157329Ssos/* ATAPI request sense structure */
439157329Ssosstruct atapi_sense {
440157329Ssos    u_int8_t	error;				/* current or deferred errors */
441157329Ssos#define	ATA_SENSE_VALID			0x80
442157329Ssos
443157329Ssos    u_int8_t	segment;			/* segment number */
444157329Ssos    u_int8_t	key;				/* sense key */
445157329Ssos#define ATA_SENSE_KEY_MASK		0x0f    /* sense key mask */
446157329Ssos#define ATA_SENSE_NO_SENSE		0x00    /* no specific sense key info */
447157329Ssos#define ATA_SENSE_RECOVERED_ERROR 	0x01    /* command OK, data recovered */
448157329Ssos#define ATA_SENSE_NOT_READY		0x02    /* no access to drive */
449157329Ssos#define ATA_SENSE_MEDIUM_ERROR		0x03    /* non-recovered data error */
450157329Ssos#define ATA_SENSE_HARDWARE_ERROR	0x04    /* non-recoverable HW failure */
451157329Ssos#define ATA_SENSE_ILLEGAL_REQUEST	0x05    /* invalid command param(s) */
452157329Ssos#define ATA_SENSE_UNIT_ATTENTION	0x06    /* media changed */
453157329Ssos#define ATA_SENSE_DATA_PROTECT		0x07    /* write protect */
454157329Ssos#define ATA_SENSE_BLANK_CHECK		0x08    /* blank check */
455157329Ssos#define ATA_SENSE_VENDOR_SPECIFIC	0x09    /* vendor specific skey */
456157329Ssos#define ATA_SENSE_COPY_ABORTED		0x0a    /* copy aborted */
457157329Ssos#define ATA_SENSE_ABORTED_COMMAND	0x0b    /* command aborted, try again */
458157329Ssos#define ATA_SENSE_EQUAL			0x0c    /* equal */
459157329Ssos#define ATA_SENSE_VOLUME_OVERFLOW	0x0d    /* volume overflow */
460157329Ssos#define ATA_SENSE_MISCOMPARE		0x0e    /* data dont match the medium */
461157329Ssos#define ATA_SENSE_RESERVED		0x0f
462157329Ssos#define	ATA_SENSE_ILI			0x20;
463157329Ssos#define	ATA_SENSE_EOM			0x40;
464157329Ssos#define	ATA_SENSE_FILEMARK		0x80;
465157329Ssos
466157329Ssos    u_int32_t   cmd_info;		/* cmd information */
467157329Ssos    u_int8_t	sense_length;		/* additional sense len (n-7) */
468157329Ssos    u_int32_t   cmd_specific_info;	/* additional cmd spec info */
469157329Ssos    u_int8_t    asc;			/* additional sense code */
470157329Ssos    u_int8_t    ascq;			/* additional sense code qual */
471157329Ssos    u_int8_t    replaceable_unit_code;	/* replaceable unit code */
472157329Ssos    u_int8_t	specific;		/* sense key specific */
473157329Ssos#define	ATA_SENSE_SPEC_VALID	0x80
474157329Ssos#define	ATA_SENSE_SPEC_MASK	0x7f
475157329Ssos
476157329Ssos    u_int8_t	specific1;		/* sense key specific */
477157329Ssos    u_int8_t	specific2;		/* sense key specific */
478157329Ssos} __packed;
479157329Ssos
480146266Ssosstruct ata_ioc_request {
481146266Ssos    union {
482119404Ssos	struct {
483146266Ssos	    u_int8_t            command;
484146266Ssos	    u_int8_t            feature;
485146266Ssos	    u_int64_t           lba;
486146266Ssos	    u_int16_t           count;
487146266Ssos	} ata;
488119404Ssos	struct {
489146266Ssos	    char                ccb[16];
490157329Ssos	    struct atapi_sense	sense;
491146266Ssos	} atapi;
492146266Ssos    } u;
493146266Ssos    caddr_t             data;
494146266Ssos    int                 count;
495146266Ssos    int                 flags;
496146266Ssos#define ATA_CMD_CONTROL                 0x01
497146266Ssos#define ATA_CMD_READ                    0x02
498146266Ssos#define ATA_CMD_WRITE                   0x04
499146266Ssos#define ATA_CMD_ATAPI                   0x08
500119404Ssos
501146266Ssos    int                 timeout;
502146266Ssos    int                 error;
503146266Ssos};
504119404Ssos
505146266Ssos/* pr device ATA ioctl calls */
506146266Ssos#define IOCATAREQUEST           _IOWR('a', 100, struct ata_ioc_request)
507146266Ssos#define IOCATAGPARM             _IOR('a', 101, struct ata_params)
508146266Ssos#define IOCATAGMODE             _IOR('a', 102, int)
509146266Ssos#define IOCATASMODE             _IOW('a', 103, int)
51093662Ssos
511177298Sphk#define IOCATAGSPINDOWN		_IOR('a', 104, int)
512177298Sphk#define IOCATASSPINDOWN		_IOW('a', 105, int)
513119404Ssos
514177298Sphk
515146266Ssosstruct ata_ioc_raid_config {
516146266Ssos	    int                 lun;
517146266Ssos	    int                 type;
518146266Ssos#define AR_JBOD                         0x0001
519146266Ssos#define AR_SPAN                         0x0002
520146266Ssos#define AR_RAID0                        0x0004
521146266Ssos#define AR_RAID1                        0x0008
522146266Ssos#define AR_RAID01                       0x0010
523146266Ssos#define AR_RAID3                        0x0020
524146266Ssos#define AR_RAID4                        0x0040
525146266Ssos#define AR_RAID5                        0x0080
52693662Ssos
527146266Ssos	    int                 interleave;
528146266Ssos	    int                 status;
529146266Ssos#define AR_READY                        1
530146266Ssos#define AR_DEGRADED                     2
531146266Ssos#define AR_REBUILDING                   4
532119404Ssos
533146266Ssos	    int                 progress;
534146266Ssos	    int                 total_disks;
535146266Ssos	    int                 disks[16];
53674298Ssos};
53774298Ssos
538171819Sjhbstruct ata_ioc_raid_status {
539171819Sjhb	    int                 lun;
540171819Sjhb	    int                 type;
541171819Sjhb	    int                 interleave;
542171819Sjhb	    int                 status;
543171819Sjhb	    int                 progress;
544171819Sjhb	    int                 total_disks;
545171819Sjhb	    struct {
546171819Sjhb		    int		state;
547171819Sjhb#define AR_DISK_ONLINE			0x01
548171819Sjhb#define AR_DISK_PRESENT			0x02
549171819Sjhb#define AR_DISK_SPARE			0x04
550171819Sjhb		    int		lun;
551171819Sjhb	    } disks[16];
552171819Sjhb};
553171819Sjhb
554146266Ssos/* ATA RAID ioctl calls */
555148737Ssos#define IOCATARAIDCREATE        _IOWR('a', 200, struct ata_ioc_raid_config)
556146266Ssos#define IOCATARAIDDELETE        _IOW('a', 201, int)
557171819Sjhb#define IOCATARAIDSTATUS        _IOWR('a', 202, struct ata_ioc_raid_status)
558146266Ssos#define IOCATARAIDADDSPARE      _IOW('a', 203, struct ata_ioc_raid_config)
559146266Ssos#define IOCATARAIDREBUILD       _IOW('a', 204, int)
56074298Ssos
56174298Ssos#endif /* _SYS_ATA_H_ */
562