Merge branch 'post-2.6.15' of git://brick.kernel.dk/data/git/linux-2.6-block
[sfrench/cifs-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_SERNO_OFS        = 10,
46         ATA_ID_FW_REV_OFS       = 23,
47         ATA_ID_PROD_OFS         = 27,
48         ATA_ID_OLD_PIO_MODES    = 51,
49         ATA_ID_FIELD_VALID      = 53,
50         ATA_ID_MWDMA_MODES      = 63,
51         ATA_ID_PIO_MODES        = 64,
52         ATA_ID_EIDE_DMA_MIN     = 65,
53         ATA_ID_EIDE_PIO         = 67,
54         ATA_ID_EIDE_PIO_IORDY   = 68,
55         ATA_ID_UDMA_MODES       = 88,
56         ATA_ID_MAJOR_VER        = 80,
57         ATA_ID_PIO4             = (1 << 1),
58
59         ATA_PCI_CTL_OFS         = 2,
60         ATA_SERNO_LEN           = 20,
61         ATA_UDMA0               = (1 << 0),
62         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
63         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
64         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
65         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
66         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
67         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
68         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
69         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
70
71         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
72
73         /* DMA-related */
74         ATA_PRD_SZ              = 8,
75         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
76         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
77
78         ATA_DMA_TABLE_OFS       = 4,
79         ATA_DMA_STATUS          = 2,
80         ATA_DMA_CMD             = 0,
81         ATA_DMA_WR              = (1 << 3),
82         ATA_DMA_START           = (1 << 0),
83         ATA_DMA_INTR            = (1 << 2),
84         ATA_DMA_ERR             = (1 << 1),
85         ATA_DMA_ACTIVE          = (1 << 0),
86
87         /* bits in ATA command block registers */
88         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
89         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
90         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
91         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
92         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
93         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
94         ATA_BUSY                = (1 << 7),     /* BSY status bit */
95         ATA_DRDY                = (1 << 6),     /* device ready */
96         ATA_DF                  = (1 << 5),     /* device fault */
97         ATA_DRQ                 = (1 << 3),     /* data request i/o */
98         ATA_ERR                 = (1 << 0),     /* have an error */
99         ATA_SRST                = (1 << 2),     /* software reset */
100         ATA_ABORTED             = (1 << 2),     /* command aborted */
101
102         /* ATA command block registers */
103         ATA_REG_DATA            = 0x00,
104         ATA_REG_ERR             = 0x01,
105         ATA_REG_NSECT           = 0x02,
106         ATA_REG_LBAL            = 0x03,
107         ATA_REG_LBAM            = 0x04,
108         ATA_REG_LBAH            = 0x05,
109         ATA_REG_DEVICE          = 0x06,
110         ATA_REG_STATUS          = 0x07,
111
112         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
113         ATA_REG_CMD             = ATA_REG_STATUS,
114         ATA_REG_BYTEL           = ATA_REG_LBAM,
115         ATA_REG_BYTEH           = ATA_REG_LBAH,
116         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
117         ATA_REG_IRQ             = ATA_REG_NSECT,
118
119         /* ATA device commands */
120         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
121         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
122         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
123         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
124         ATA_CMD_FLUSH           = 0xE7,
125         ATA_CMD_FLUSH_EXT       = 0xEA,
126         ATA_CMD_ID_ATA          = 0xEC,
127         ATA_CMD_ID_ATAPI        = 0xA1,
128         ATA_CMD_READ            = 0xC8,
129         ATA_CMD_READ_EXT        = 0x25,
130         ATA_CMD_WRITE           = 0xCA,
131         ATA_CMD_WRITE_EXT       = 0x35,
132         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
133         ATA_CMD_PIO_READ        = 0x20,
134         ATA_CMD_PIO_READ_EXT    = 0x24,
135         ATA_CMD_PIO_WRITE       = 0x30,
136         ATA_CMD_PIO_WRITE_EXT   = 0x34,
137         ATA_CMD_READ_MULTI      = 0xC4,
138         ATA_CMD_READ_MULTI_EXT  = 0x29,
139         ATA_CMD_WRITE_MULTI     = 0xC5,
140         ATA_CMD_WRITE_MULTI_EXT = 0x39,
141         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
142         ATA_CMD_SET_FEATURES    = 0xEF,
143         ATA_CMD_PACKET          = 0xA0,
144         ATA_CMD_VERIFY          = 0x40,
145         ATA_CMD_VERIFY_EXT      = 0x42,
146         ATA_CMD_STANDBYNOW1     = 0xE0,
147         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
148         ATA_CMD_INIT_DEV_PARAMS = 0x91,
149
150         /* SETFEATURES stuff */
151         SETFEATURES_XFER        = 0x03,
152         XFER_UDMA_7             = 0x47,
153         XFER_UDMA_6             = 0x46,
154         XFER_UDMA_5             = 0x45,
155         XFER_UDMA_4             = 0x44,
156         XFER_UDMA_3             = 0x43,
157         XFER_UDMA_2             = 0x42,
158         XFER_UDMA_1             = 0x41,
159         XFER_UDMA_0             = 0x40,
160         XFER_MW_DMA_2           = 0x22,
161         XFER_MW_DMA_1           = 0x21,
162         XFER_MW_DMA_0           = 0x20,
163         XFER_SW_DMA_2           = 0x12,
164         XFER_SW_DMA_1           = 0x11,
165         XFER_SW_DMA_0           = 0x10,
166         XFER_PIO_4              = 0x0C,
167         XFER_PIO_3              = 0x0B,
168         XFER_PIO_2              = 0x0A,
169         XFER_PIO_1              = 0x09,
170         XFER_PIO_0              = 0x08,
171         XFER_PIO_SLOW           = 0x00,
172
173         /* ATAPI stuff */
174         ATAPI_PKT_DMA           = (1 << 0),
175         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
176                                                    0=to device, 1=to host */
177         ATAPI_CDB_LEN           = 16,
178
179         /* cable types */
180         ATA_CBL_NONE            = 0,
181         ATA_CBL_PATA40          = 1,
182         ATA_CBL_PATA80          = 2,
183         ATA_CBL_PATA_UNK        = 3,
184         ATA_CBL_SATA            = 4,
185
186         /* SATA Status and Control Registers */
187         SCR_STATUS              = 0,
188         SCR_ERROR               = 1,
189         SCR_CONTROL             = 2,
190         SCR_ACTIVE              = 3,
191         SCR_NOTIFICATION        = 4,
192
193         /* struct ata_taskfile flags */
194         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
195         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
196         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
197         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
198         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
199         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
200 };
201
202 enum ata_tf_protocols {
203         /* ATA taskfile protocols */
204         ATA_PROT_UNKNOWN,       /* unknown/invalid */
205         ATA_PROT_NODATA,        /* no data */
206         ATA_PROT_PIO,           /* PIO single sector */
207         ATA_PROT_PIO_MULT,      /* PIO multiple sector */
208         ATA_PROT_DMA,           /* DMA */
209         ATA_PROT_ATAPI,         /* packet command, PIO data xfer*/
210         ATA_PROT_ATAPI_NODATA,  /* packet command, no data */
211         ATA_PROT_ATAPI_DMA,     /* packet command with special DMA sauce */
212 };
213
214 enum ata_ioctls {
215         ATA_IOC_GET_IO32        = 0x309,
216         ATA_IOC_SET_IO32        = 0x324,
217 };
218
219 /* core structures */
220
221 struct ata_prd {
222         u32                     addr;
223         u32                     flags_len;
224 };
225
226 struct ata_taskfile {
227         unsigned long           flags;          /* ATA_TFLAG_xxx */
228         u8                      protocol;       /* ATA_PROT_xxx */
229
230         u8                      ctl;            /* control reg */
231
232         u8                      hob_feature;    /* additional data */
233         u8                      hob_nsect;      /* to support LBA48 */
234         u8                      hob_lbal;
235         u8                      hob_lbam;
236         u8                      hob_lbah;
237
238         u8                      feature;
239         u8                      nsect;
240         u8                      lbal;
241         u8                      lbam;
242         u8                      lbah;
243
244         u8                      device;
245
246         u8                      command;        /* IO operation */
247 };
248
249 #define ata_id_is_ata(id)       (((id)[0] & (1 << 15)) == 0)
250 #define ata_id_is_sata(id)      ((id)[93] == 0)
251 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
252 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
253 #define ata_id_has_fua(id)      ((id)[84] & (1 << 6))
254 #define ata_id_has_flush(id)    ((id)[83] & (1 << 12))
255 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
256 #define ata_id_has_lba48(id)    ((id)[83] & (1 << 10))
257 #define ata_id_has_wcache(id)   ((id)[82] & (1 << 5))
258 #define ata_id_has_pm(id)       ((id)[82] & (1 << 3))
259 #define ata_id_has_lba(id)      ((id)[49] & (1 << 9))
260 #define ata_id_has_dma(id)      ((id)[49] & (1 << 8))
261 #define ata_id_removeable(id)   ((id)[0] & (1 << 7))
262 #define ata_id_u32(id,n)        \
263         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
264 #define ata_id_u64(id,n)        \
265         ( ((u64) (id)[(n) + 3] << 48) | \
266           ((u64) (id)[(n) + 2] << 32) | \
267           ((u64) (id)[(n) + 1] << 16) | \
268           ((u64) (id)[(n) + 0]) )
269
270 static inline int ata_id_current_chs_valid(const u16 *id)
271 {
272         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command 
273            has not been issued to the device then the values of 
274            id[54] to id[56] are vendor specific. */
275         return (id[53] & 0x01) && /* Current translation valid */
276                 id[54] &&  /* cylinders in current translation */
277                 id[55] &&  /* heads in current translation */
278                 id[55] <= 16 &&
279                 id[56];    /* sectors in current translation */
280 }
281
282 static inline int atapi_cdb_len(const u16 *dev_id)
283 {
284         u16 tmp = dev_id[0] & 0x3;
285         switch (tmp) {
286         case 0:         return 12;
287         case 1:         return 16;
288         default:        return -1;
289         }
290 }
291
292 static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
293 {
294         return (tf->protocol == ATA_PROT_ATAPI) ||
295                (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
296                (tf->protocol == ATA_PROT_ATAPI_DMA);
297 }
298
299 static inline int ata_ok(u8 status)
300 {
301         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
302                         == ATA_DRDY);
303 }
304
305 #endif /* __LINUX_ATA_H__ */