Merge branch 'upstream'
[linux-2.6.git] / include / linux / ata.h
1
2 /*
3  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
4  *  Copyright 2003-2004 Jeff Garzik
5  *
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2, or (at your option)
10  *  any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; see the file COPYING.  If not, write to
19  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  *
22  *  libata documentation is available via 'make {ps|pdf}docs',
23  *  as Documentation/DocBook/libata.*
24  *
25  *  Hardware documentation available from http://www.t13.org/
26  *
27  */
28
29 #ifndef __LINUX_ATA_H__
30 #define __LINUX_ATA_H__
31
32 #include <linux/types.h>
33
34 /* defines only for the constants which don't work well as enums */
35 #define ATA_DMA_BOUNDARY        0xffffUL
36 #define ATA_DMA_MASK            0xffffffffULL
37
38 enum {
39         /* various global constants */
40         ATA_MAX_DEVICES         = 2,    /* per bus/port */
41         ATA_MAX_PRD             = 256,  /* we could make these 256/256 */
42         ATA_SECT_SIZE           = 512,
43
44         ATA_ID_WORDS            = 256,
45         ATA_ID_PROD_OFS         = 27,
46         ATA_ID_FW_REV_OFS       = 23,
47         ATA_ID_SERNO_OFS        = 10,
48         ATA_ID_MAJOR_VER        = 80,
49         ATA_ID_PIO_MODES        = 64,
50         ATA_ID_MWDMA_MODES      = 63,
51         ATA_ID_UDMA_MODES       = 88,
52         ATA_ID_PIO4             = (1 << 1),
53
54         ATA_PCI_CTL_OFS         = 2,
55         ATA_SERNO_LEN           = 20,
56         ATA_UDMA0               = (1 << 0),
57         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
58         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
59         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
60         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
61         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
62         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
63         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
64         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
65
66         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
67
68         /* DMA-related */
69         ATA_PRD_SZ              = 8,
70         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
71         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
72
73         ATA_DMA_TABLE_OFS       = 4,
74         ATA_DMA_STATUS          = 2,
75         ATA_DMA_CMD             = 0,
76         ATA_DMA_WR              = (1 << 3),
77         ATA_DMA_START           = (1 << 0),
78         ATA_DMA_INTR            = (1 << 2),
79         ATA_DMA_ERR             = (1 << 1),
80         ATA_DMA_ACTIVE          = (1 << 0),
81
82         /* bits in ATA command block registers */
83         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
84         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
85         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
86         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
87         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
88         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
89         ATA_BUSY                = (1 << 7),     /* BSY status bit */
90         ATA_DRDY                = (1 << 6),     /* device ready */
91         ATA_DF                  = (1 << 5),     /* device fault */
92         ATA_DRQ                 = (1 << 3),     /* data request i/o */
93         ATA_ERR                 = (1 << 0),     /* have an error */
94         ATA_SRST                = (1 << 2),     /* software reset */
95         ATA_ABORTED             = (1 << 2),     /* command aborted */
96
97         /* ATA command block registers */
98         ATA_REG_DATA            = 0x00,
99         ATA_REG_ERR             = 0x01,
100         ATA_REG_NSECT           = 0x02,
101         ATA_REG_LBAL            = 0x03,
102         ATA_REG_LBAM            = 0x04,
103         ATA_REG_LBAH            = 0x05,
104         ATA_REG_DEVICE          = 0x06,
105         ATA_REG_STATUS          = 0x07,
106
107         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
108         ATA_REG_CMD             = ATA_REG_STATUS,
109         ATA_REG_BYTEL           = ATA_REG_LBAM,
110         ATA_REG_BYTEH           = ATA_REG_LBAH,
111         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
112         ATA_REG_IRQ             = ATA_REG_NSECT,
113
114         /* ATA device commands */
115         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
116         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
117         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
118         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
119         ATA_CMD_FLUSH           = 0xE7,
120         ATA_CMD_FLUSH_EXT       = 0xEA,
121         ATA_CMD_ID_ATA          = 0xEC,
122         ATA_CMD_ID_ATAPI        = 0xA1,
123         ATA_CMD_READ            = 0xC8,
124         ATA_CMD_READ_EXT        = 0x25,
125         ATA_CMD_WRITE           = 0xCA,
126         ATA_CMD_WRITE_EXT       = 0x35,
127         ATA_CMD_PIO_READ        = 0x20,
128         ATA_CMD_PIO_READ_EXT    = 0x24,
129         ATA_CMD_PIO_WRITE       = 0x30,
130         ATA_CMD_PIO_WRITE_EXT   = 0x34,
131         ATA_CMD_READ_MULTI      = 0xC4,
132         ATA_CMD_READ_MULTI_EXT  = 0x29,
133         ATA_CMD_WRITE_MULTI     = 0xC5,
134         ATA_CMD_WRITE_MULTI_EXT = 0x39,
135         ATA_CMD_SET_FEATURES    = 0xEF,
136         ATA_CMD_PACKET          = 0xA0,
137         ATA_CMD_VERIFY          = 0x40,
138         ATA_CMD_VERIFY_EXT      = 0x42,
139         ATA_CMD_INIT_DEV_PARAMS = 0x91,
140
141         /* SETFEATURES stuff */
142         SETFEATURES_XFER        = 0x03,
143         XFER_UDMA_7             = 0x47,
144         XFER_UDMA_6             = 0x46,
145         XFER_UDMA_5             = 0x45,
146         XFER_UDMA_4             = 0x44,
147         XFER_UDMA_3             = 0x43,
148         XFER_UDMA_2             = 0x42,
149         XFER_UDMA_1             = 0x41,
150         XFER_UDMA_0             = 0x40,
151         XFER_MW_DMA_2           = 0x22,
152         XFER_MW_DMA_1           = 0x21,
153         XFER_MW_DMA_0           = 0x20,
154         XFER_SW_DMA_2           = 0x12,
155         XFER_SW_DMA_1           = 0x11,
156         XFER_SW_DMA_0           = 0x10,
157         XFER_PIO_4              = 0x0C,
158         XFER_PIO_3              = 0x0B,
159         XFER_PIO_2              = 0x0A,
160         XFER_PIO_1              = 0x09,
161         XFER_PIO_0              = 0x08,
162         XFER_PIO_SLOW           = 0x00,
163
164         /* ATAPI stuff */
165         ATAPI_PKT_DMA           = (1 << 0),
166         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
167                                                    0=to device, 1=to host */
168         ATAPI_CDB_LEN           = 16,
169
170         /* cable types */
171         ATA_CBL_NONE            = 0,
172         ATA_CBL_PATA40          = 1,
173         ATA_CBL_PATA80          = 2,
174         ATA_CBL_PATA_UNK        = 3,
175         ATA_CBL_SATA            = 4,
176
177         /* SATA Status and Control Registers */
178         SCR_STATUS              = 0,
179         SCR_ERROR               = 1,
180         SCR_CONTROL             = 2,
181         SCR_ACTIVE              = 3,
182         SCR_NOTIFICATION        = 4,
183
184         /* struct ata_taskfile flags */
185         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
186         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
187         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
188         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
189         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
190         ATA_TFLAG_POLLING       = (1 << 5), /* set nIEN to 1 and use polling */
191 };
192
193 enum ata_tf_protocols {
194         /* ATA taskfile protocols */
195         ATA_PROT_UNKNOWN,       /* unknown/invalid */
196         ATA_PROT_NODATA,        /* no data */
197         ATA_PROT_PIO,           /* PIO single sector */
198         ATA_PROT_PIO_MULT,      /* PIO multiple sector */
199         ATA_PROT_DMA,           /* DMA */
200         ATA_PROT_ATAPI,         /* packet command, PIO data xfer*/
201         ATA_PROT_ATAPI_NODATA,  /* packet command, no data */
202         ATA_PROT_ATAPI_DMA,     /* packet command with special DMA sauce */
203 };
204
205 enum ata_ioctls {
206         ATA_IOC_GET_IO32        = 0x309,
207         ATA_IOC_SET_IO32        = 0x324,
208 };
209
210 /* core structures */
211
212 struct ata_prd {
213         u32                     addr;
214         u32                     flags_len;
215 };
216
217 struct ata_taskfile {
218         unsigned long           flags;          /* ATA_TFLAG_xxx */
219         u8                      protocol;       /* ATA_PROT_xxx */
220
221         u8                      ctl;            /* control reg */
222
223         u8                      hob_feature;    /* additional data */
224         u8                      hob_nsect;      /* to support LBA48 */
225         u8                      hob_lbal;
226         u8                      hob_lbam;
227         u8                      hob_lbah;
228
229         u8                      feature;
230         u8                      nsect;
231         u8                      lbal;
232         u8                      lbam;
233         u8                      lbah;
234
235         u8                      device;
236
237         u8                      command;        /* IO operation */
238 };
239
240 #define ata_id_is_ata(id)       (((id)[0] & (1 << 15)) == 0)
241 #define ata_id_is_sata(id)      ((id)[93] == 0)
242 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
243 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
244 #define ata_id_has_flush(id) ((id)[83] & (1 << 12))
245 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
246 #define ata_id_has_lba48(id)    ((id)[83] & (1 << 10))
247 #define ata_id_has_wcache(id)   ((id)[82] & (1 << 5))
248 #define ata_id_has_pm(id)       ((id)[82] & (1 << 3))
249 #define ata_id_has_lba(id)      ((id)[49] & (1 << 9))
250 #define ata_id_has_dma(id)      ((id)[49] & (1 << 8))
251 #define ata_id_removeable(id)   ((id)[0] & (1 << 7))
252 #define ata_id_u32(id,n)        \
253         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
254 #define ata_id_u64(id,n)        \
255         ( ((u64) (id)[(n) + 3] << 48) | \
256           ((u64) (id)[(n) + 2] << 32) | \
257           ((u64) (id)[(n) + 1] << 16) | \
258           ((u64) (id)[(n) + 0]) )
259
260 #define ata_id_cdb_intr(id)     (((id)[0] & 0x60) == 0x20)
261
262 static inline int ata_id_current_chs_valid(u16 *id)
263 {
264         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command 
265            has not been issued to the device then the values of 
266            id[54] to id[56] are vendor specific. */
267         return (id[53] & 0x01) && /* Current translation valid */
268                 id[54] &&  /* cylinders in current translation */
269                 id[55] &&  /* heads in current translation */
270                 id[55] <= 16 &&
271                 id[56];    /* sectors in current translation */
272 }
273
274 static inline int atapi_cdb_len(u16 *dev_id)
275 {
276         u16 tmp = dev_id[0] & 0x3;
277         switch (tmp) {
278         case 0:         return 12;
279         case 1:         return 16;
280         default:        return -1;
281         }
282 }
283
284 static inline int is_atapi_taskfile(struct ata_taskfile *tf)
285 {
286         return (tf->protocol == ATA_PROT_ATAPI) ||
287                (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
288                (tf->protocol == ATA_PROT_ATAPI_DMA);
289 }
290
291 static inline int ata_ok(u8 status)
292 {
293         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
294                         == ATA_DRDY);
295 }
296
297 #endif /* __LINUX_ATA_H__ */