libata: straighten out ATA_ID_* constants
[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         ATA_MAX_SECTORS         = 256,
44         ATA_MAX_SECTORS_LBA48   = 65535,/* TODO: 65536? */
45
46         ATA_ID_WORDS            = 256,
47         ATA_ID_SERNO            = 10,
48         ATA_ID_FW_REV           = 23,
49         ATA_ID_PROD             = 27,
50         ATA_ID_OLD_PIO_MODES    = 51,
51         ATA_ID_FIELD_VALID      = 53,
52         ATA_ID_MWDMA_MODES      = 63,
53         ATA_ID_PIO_MODES        = 64,
54         ATA_ID_EIDE_DMA_MIN     = 65,
55         ATA_ID_EIDE_PIO         = 67,
56         ATA_ID_EIDE_PIO_IORDY   = 68,
57         ATA_ID_UDMA_MODES       = 88,
58         ATA_ID_MAJOR_VER        = 80,
59         ATA_ID_PIO4             = (1 << 1),
60
61         ATA_ID_SERNO_LEN        = 20,
62         ATA_ID_FW_REV_LEN       = 8,
63         ATA_ID_PROD_LEN         = 40,
64
65         ATA_PCI_CTL_OFS         = 2,
66         ATA_UDMA0               = (1 << 0),
67         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
68         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
69         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
70         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
71         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
72         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
73         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
74         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
75
76         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
77
78         /* DMA-related */
79         ATA_PRD_SZ              = 8,
80         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
81         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
82
83         ATA_DMA_TABLE_OFS       = 4,
84         ATA_DMA_STATUS          = 2,
85         ATA_DMA_CMD             = 0,
86         ATA_DMA_WR              = (1 << 3),
87         ATA_DMA_START           = (1 << 0),
88         ATA_DMA_INTR            = (1 << 2),
89         ATA_DMA_ERR             = (1 << 1),
90         ATA_DMA_ACTIVE          = (1 << 0),
91
92         /* bits in ATA command block registers */
93         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
94         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
95         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
96         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
97         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
98         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
99         ATA_BUSY                = (1 << 7),     /* BSY status bit */
100         ATA_DRDY                = (1 << 6),     /* device ready */
101         ATA_DF                  = (1 << 5),     /* device fault */
102         ATA_DRQ                 = (1 << 3),     /* data request i/o */
103         ATA_ERR                 = (1 << 0),     /* have an error */
104         ATA_SRST                = (1 << 2),     /* software reset */
105         ATA_ICRC                = (1 << 7),     /* interface CRC error */
106         ATA_UNC                 = (1 << 6),     /* uncorrectable media error */
107         ATA_IDNF                = (1 << 4),     /* ID not found */
108         ATA_ABORTED             = (1 << 2),     /* command aborted */
109
110         /* ATA command block registers */
111         ATA_REG_DATA            = 0x00,
112         ATA_REG_ERR             = 0x01,
113         ATA_REG_NSECT           = 0x02,
114         ATA_REG_LBAL            = 0x03,
115         ATA_REG_LBAM            = 0x04,
116         ATA_REG_LBAH            = 0x05,
117         ATA_REG_DEVICE          = 0x06,
118         ATA_REG_STATUS          = 0x07,
119
120         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
121         ATA_REG_CMD             = ATA_REG_STATUS,
122         ATA_REG_BYTEL           = ATA_REG_LBAM,
123         ATA_REG_BYTEH           = ATA_REG_LBAH,
124         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
125         ATA_REG_IRQ             = ATA_REG_NSECT,
126
127         /* ATA device commands */
128         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
129         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
130         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
131         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
132         ATA_CMD_FLUSH           = 0xE7,
133         ATA_CMD_FLUSH_EXT       = 0xEA,
134         ATA_CMD_ID_ATA          = 0xEC,
135         ATA_CMD_ID_ATAPI        = 0xA1,
136         ATA_CMD_READ            = 0xC8,
137         ATA_CMD_READ_EXT        = 0x25,
138         ATA_CMD_WRITE           = 0xCA,
139         ATA_CMD_WRITE_EXT       = 0x35,
140         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
141         ATA_CMD_FPDMA_READ      = 0x60,
142         ATA_CMD_FPDMA_WRITE     = 0x61,
143         ATA_CMD_PIO_READ        = 0x20,
144         ATA_CMD_PIO_READ_EXT    = 0x24,
145         ATA_CMD_PIO_WRITE       = 0x30,
146         ATA_CMD_PIO_WRITE_EXT   = 0x34,
147         ATA_CMD_READ_MULTI      = 0xC4,
148         ATA_CMD_READ_MULTI_EXT  = 0x29,
149         ATA_CMD_WRITE_MULTI     = 0xC5,
150         ATA_CMD_WRITE_MULTI_EXT = 0x39,
151         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
152         ATA_CMD_SET_FEATURES    = 0xEF,
153         ATA_CMD_PACKET          = 0xA0,
154         ATA_CMD_VERIFY          = 0x40,
155         ATA_CMD_VERIFY_EXT      = 0x42,
156         ATA_CMD_STANDBYNOW1     = 0xE0,
157         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
158         ATA_CMD_INIT_DEV_PARAMS = 0x91,
159         ATA_CMD_READ_NATIVE_MAX = 0xF8,
160         ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
161         ATA_CMD_READ_LOG_EXT    = 0x2f,
162
163         /* READ_LOG_EXT pages */
164         ATA_LOG_SATA_NCQ        = 0x10,
165
166         /* SETFEATURES stuff */
167         SETFEATURES_XFER        = 0x03,
168         XFER_UDMA_7             = 0x47,
169         XFER_UDMA_6             = 0x46,
170         XFER_UDMA_5             = 0x45,
171         XFER_UDMA_4             = 0x44,
172         XFER_UDMA_3             = 0x43,
173         XFER_UDMA_2             = 0x42,
174         XFER_UDMA_1             = 0x41,
175         XFER_UDMA_0             = 0x40,
176         XFER_MW_DMA_4           = 0x24, /* CFA only */
177         XFER_MW_DMA_3           = 0x23, /* CFA only */
178         XFER_MW_DMA_2           = 0x22,
179         XFER_MW_DMA_1           = 0x21,
180         XFER_MW_DMA_0           = 0x20,
181         XFER_SW_DMA_2           = 0x12,
182         XFER_SW_DMA_1           = 0x11,
183         XFER_SW_DMA_0           = 0x10,
184         XFER_PIO_6              = 0x0E, /* CFA only */
185         XFER_PIO_5              = 0x0D, /* CFA only */
186         XFER_PIO_4              = 0x0C,
187         XFER_PIO_3              = 0x0B,
188         XFER_PIO_2              = 0x0A,
189         XFER_PIO_1              = 0x09,
190         XFER_PIO_0              = 0x08,
191         XFER_PIO_SLOW           = 0x00,
192
193         SETFEATURES_WC_ON       = 0x02, /* Enable write cache */
194         SETFEATURES_WC_OFF      = 0x82, /* Disable write cache */
195
196         /* ATAPI stuff */
197         ATAPI_PKT_DMA           = (1 << 0),
198         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
199                                                    0=to device, 1=to host */
200         ATAPI_CDB_LEN           = 16,
201
202         /* cable types */
203         ATA_CBL_NONE            = 0,
204         ATA_CBL_PATA40          = 1,
205         ATA_CBL_PATA80          = 2,
206         ATA_CBL_PATA40_SHORT    = 3,            /* 40 wire cable to high UDMA spec */
207         ATA_CBL_PATA_UNK        = 4,
208         ATA_CBL_SATA            = 5,
209
210         /* SATA Status and Control Registers */
211         SCR_STATUS              = 0,
212         SCR_ERROR               = 1,
213         SCR_CONTROL             = 2,
214         SCR_ACTIVE              = 3,
215         SCR_NOTIFICATION        = 4,
216
217         /* SError bits */
218         SERR_DATA_RECOVERED     = (1 << 0), /* recovered data error */
219         SERR_COMM_RECOVERED     = (1 << 1), /* recovered comm failure */
220         SERR_DATA               = (1 << 8), /* unrecovered data error */
221         SERR_PERSISTENT         = (1 << 9), /* persistent data/comm error */
222         SERR_PROTOCOL           = (1 << 10), /* protocol violation */
223         SERR_INTERNAL           = (1 << 11), /* host internal error */
224         SERR_PHYRDY_CHG         = (1 << 16), /* PHY RDY changed */
225         SERR_DEV_XCHG           = (1 << 26), /* device exchanged */
226
227         /* struct ata_taskfile flags */
228         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
229         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
230         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
231         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
232         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
233         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
234         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
235 };
236
237 enum ata_tf_protocols {
238         /* ATA taskfile protocols */
239         ATA_PROT_UNKNOWN,       /* unknown/invalid */
240         ATA_PROT_NODATA,        /* no data */
241         ATA_PROT_PIO,           /* PIO single sector */
242         ATA_PROT_DMA,           /* DMA */
243         ATA_PROT_NCQ,           /* NCQ */
244         ATA_PROT_ATAPI,         /* packet command, PIO data xfer*/
245         ATA_PROT_ATAPI_NODATA,  /* packet command, no data */
246         ATA_PROT_ATAPI_DMA,     /* packet command with special DMA sauce */
247 };
248
249 enum ata_ioctls {
250         ATA_IOC_GET_IO32        = 0x309,
251         ATA_IOC_SET_IO32        = 0x324,
252 };
253
254 /* core structures */
255
256 struct ata_prd {
257         u32                     addr;
258         u32                     flags_len;
259 };
260
261 struct ata_taskfile {
262         unsigned long           flags;          /* ATA_TFLAG_xxx */
263         u8                      protocol;       /* ATA_PROT_xxx */
264
265         u8                      ctl;            /* control reg */
266
267         u8                      hob_feature;    /* additional data */
268         u8                      hob_nsect;      /* to support LBA48 */
269         u8                      hob_lbal;
270         u8                      hob_lbam;
271         u8                      hob_lbah;
272
273         u8                      feature;
274         u8                      nsect;
275         u8                      lbal;
276         u8                      lbam;
277         u8                      lbah;
278
279         u8                      device;
280
281         u8                      command;        /* IO operation */
282 };
283
284 #define ata_id_is_ata(id)       (((id)[0] & (1 << 15)) == 0)
285 #define ata_id_is_sata(id)      ((id)[93] == 0)
286 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
287 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
288 #define ata_id_hpa_enabled(id)  ((id)[85] & (1 << 10))
289 #define ata_id_has_fua(id)      ((id)[84] & (1 << 6))
290 #define ata_id_has_flush(id)    ((id)[83] & (1 << 12))
291 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
292 #define ata_id_has_lba48(id)    ((id)[83] & (1 << 10))
293 #define ata_id_has_hpa(id)      ((id)[82] & (1 << 10))
294 #define ata_id_has_wcache(id)   ((id)[82] & (1 << 5))
295 #define ata_id_has_pm(id)       ((id)[82] & (1 << 3))
296 #define ata_id_has_lba(id)      ((id)[49] & (1 << 9))
297 #define ata_id_has_dma(id)      ((id)[49] & (1 << 8))
298 #define ata_id_has_ncq(id)      ((id)[76] & (1 << 8))
299 #define ata_id_queue_depth(id)  (((id)[75] & 0x1f) + 1)
300 #define ata_id_removeable(id)   ((id)[0] & (1 << 7))
301 #define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
302 #define ata_id_u32(id,n)        \
303         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
304 #define ata_id_u64(id,n)        \
305         ( ((u64) (id)[(n) + 3] << 48) | \
306           ((u64) (id)[(n) + 2] << 32) | \
307           ((u64) (id)[(n) + 1] << 16) | \
308           ((u64) (id)[(n) + 0]) )
309
310 #define ata_id_cdb_intr(id)     (((id)[0] & 0x60) == 0x20)
311
312 static inline unsigned int ata_id_major_version(const u16 *id)
313 {
314         unsigned int mver;
315
316         if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
317                 return 0;
318
319         for (mver = 14; mver >= 1; mver--)
320                 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
321                         break;
322         return mver;
323 }
324
325 static inline int ata_id_current_chs_valid(const u16 *id)
326 {
327         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
328            has not been issued to the device then the values of
329            id[54] to id[56] are vendor specific. */
330         return (id[53] & 0x01) && /* Current translation valid */
331                 id[54] &&  /* cylinders in current translation */
332                 id[55] &&  /* heads in current translation */
333                 id[55] <= 16 &&
334                 id[56];    /* sectors in current translation */
335 }
336
337 static inline int ata_id_is_cfa(const u16 *id)
338 {
339         u16 v = id[0];
340         if (v == 0x848A)        /* Standard CF */
341                 return 1;
342         /* Could be CF hiding as standard ATA */
343         if (ata_id_major_version(id) >= 3 &&  id[82] != 0xFFFF &&
344                         (id[82] & ( 1 << 2)))
345                 return 1;
346         return 0;
347 }
348
349 static inline int ata_drive_40wire(const u16 *dev_id)
350 {
351         if (ata_id_major_version(dev_id) >= 5 && ata_id_is_sata(dev_id))
352                 return 0;       /* SATA */
353         if (dev_id[93] & 0x4000)
354                 return 0;       /* 80 wire */
355         return 1;
356 }
357
358 static inline int atapi_cdb_len(const u16 *dev_id)
359 {
360         u16 tmp = dev_id[0] & 0x3;
361         switch (tmp) {
362         case 0:         return 12;
363         case 1:         return 16;
364         default:        return -1;
365         }
366 }
367
368 static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
369 {
370         return (tf->protocol == ATA_PROT_ATAPI) ||
371                (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
372                (tf->protocol == ATA_PROT_ATAPI_DMA);
373 }
374
375 static inline int is_multi_taskfile(struct ata_taskfile *tf)
376 {
377         return (tf->command == ATA_CMD_READ_MULTI) ||
378                (tf->command == ATA_CMD_WRITE_MULTI) ||
379                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
380                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
381                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
382 }
383
384 static inline int ata_ok(u8 status)
385 {
386         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
387                         == ATA_DRDY);
388 }
389
390 static inline int lba_28_ok(u64 block, u32 n_block)
391 {
392         /* check the ending block number */
393         return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
394 }
395
396 static inline int lba_48_ok(u64 block, u32 n_block)
397 {
398         /* check the ending block number */
399         return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
400 }
401
402 #endif /* __LINUX_ATA_H__ */