Merge branch 'upstream-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jgarzi...
[linux-3.10.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_128     = 128,
44         ATA_MAX_SECTORS         = 256,
45         ATA_MAX_SECTORS_LBA48   = 65535,/* TODO: 65536? */
46         ATA_MAX_SECTORS_TAPE    = 65535,
47
48         ATA_ID_WORDS            = 256,
49         ATA_ID_CONFIG           = 0,
50         ATA_ID_CYLS             = 1,
51         ATA_ID_HEADS            = 3,
52         ATA_ID_SECTORS          = 6,
53         ATA_ID_SERNO            = 10,
54         ATA_ID_BUF_SIZE         = 21,
55         ATA_ID_FW_REV           = 23,
56         ATA_ID_PROD             = 27,
57         ATA_ID_MAX_MULTSECT     = 47,
58         ATA_ID_DWORD_IO         = 48,
59         ATA_ID_CAPABILITY       = 49,
60         ATA_ID_OLD_PIO_MODES    = 51,
61         ATA_ID_OLD_DMA_MODES    = 52,
62         ATA_ID_FIELD_VALID      = 53,
63         ATA_ID_CUR_CYLS         = 54,
64         ATA_ID_CUR_HEADS        = 55,
65         ATA_ID_CUR_SECTORS      = 56,
66         ATA_ID_MULTSECT         = 59,
67         ATA_ID_LBA_CAPACITY     = 60,
68         ATA_ID_SWDMA_MODES      = 62,
69         ATA_ID_MWDMA_MODES      = 63,
70         ATA_ID_PIO_MODES        = 64,
71         ATA_ID_EIDE_DMA_MIN     = 65,
72         ATA_ID_EIDE_DMA_TIME    = 66,
73         ATA_ID_EIDE_PIO         = 67,
74         ATA_ID_EIDE_PIO_IORDY   = 68,
75         ATA_ID_QUEUE_DEPTH      = 75,
76         ATA_ID_MAJOR_VER        = 80,
77         ATA_ID_COMMAND_SET_1    = 82,
78         ATA_ID_COMMAND_SET_2    = 83,
79         ATA_ID_CFSSE            = 84,
80         ATA_ID_CFS_ENABLE_1     = 85,
81         ATA_ID_CFS_ENABLE_2     = 86,
82         ATA_ID_CSF_DEFAULT      = 87,
83         ATA_ID_UDMA_MODES       = 88,
84         ATA_ID_HW_CONFIG        = 93,
85         ATA_ID_SPG              = 98,
86         ATA_ID_LBA_CAPACITY_2   = 100,
87         ATA_ID_LAST_LUN         = 126,
88         ATA_ID_DLF              = 128,
89         ATA_ID_CSFO             = 129,
90         ATA_ID_CFA_POWER        = 160,
91         ATA_ID_PIO4             = (1 << 1),
92
93         ATA_ID_SERNO_LEN        = 20,
94         ATA_ID_FW_REV_LEN       = 8,
95         ATA_ID_PROD_LEN         = 40,
96
97         ATA_PCI_CTL_OFS         = 2,
98
99         ATA_PIO0                = (1 << 0),
100         ATA_PIO1                = ATA_PIO0 | (1 << 1),
101         ATA_PIO2                = ATA_PIO1 | (1 << 2),
102         ATA_PIO3                = ATA_PIO2 | (1 << 3),
103         ATA_PIO4                = ATA_PIO3 | (1 << 4),
104         ATA_PIO5                = ATA_PIO4 | (1 << 5),
105         ATA_PIO6                = ATA_PIO5 | (1 << 6),
106
107         ATA_SWDMA0              = (1 << 0),
108         ATA_SWDMA1              = ATA_SWDMA0 | (1 << 1),
109         ATA_SWDMA2              = ATA_SWDMA1 | (1 << 2),
110
111         ATA_SWDMA2_ONLY         = (1 << 2),
112
113         ATA_MWDMA0              = (1 << 0),
114         ATA_MWDMA1              = ATA_MWDMA0 | (1 << 1),
115         ATA_MWDMA2              = ATA_MWDMA1 | (1 << 2),
116
117         ATA_MWDMA12_ONLY        = (1 << 1) | (1 << 2),
118         ATA_MWDMA2_ONLY         = (1 << 2),
119
120         ATA_UDMA0               = (1 << 0),
121         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
122         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
123         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
124         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
125         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
126         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
127         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
128         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
129
130         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
131
132         /* DMA-related */
133         ATA_PRD_SZ              = 8,
134         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
135         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
136
137         ATA_DMA_TABLE_OFS       = 4,
138         ATA_DMA_STATUS          = 2,
139         ATA_DMA_CMD             = 0,
140         ATA_DMA_WR              = (1 << 3),
141         ATA_DMA_START           = (1 << 0),
142         ATA_DMA_INTR            = (1 << 2),
143         ATA_DMA_ERR             = (1 << 1),
144         ATA_DMA_ACTIVE          = (1 << 0),
145
146         /* bits in ATA command block registers */
147         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
148         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
149         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
150         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
151         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
152         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
153         ATA_BUSY                = (1 << 7),     /* BSY status bit */
154         ATA_DRDY                = (1 << 6),     /* device ready */
155         ATA_DF                  = (1 << 5),     /* device fault */
156         ATA_DSC                 = (1 << 4),     /* drive seek complete */
157         ATA_DRQ                 = (1 << 3),     /* data request i/o */
158         ATA_CORR                = (1 << 2),     /* corrected data error */
159         ATA_IDX                 = (1 << 1),     /* index */
160         ATA_ERR                 = (1 << 0),     /* have an error */
161         ATA_SRST                = (1 << 2),     /* software reset */
162         ATA_ICRC                = (1 << 7),     /* interface CRC error */
163         ATA_BBK                 = ATA_ICRC,     /* pre-EIDE: block marked bad */
164         ATA_UNC                 = (1 << 6),     /* uncorrectable media error */
165         ATA_MC                  = (1 << 5),     /* media changed */
166         ATA_IDNF                = (1 << 4),     /* ID not found */
167         ATA_MCR                 = (1 << 3),     /* media change requested */
168         ATA_ABORTED             = (1 << 2),     /* command aborted */
169         ATA_TRK0NF              = (1 << 1),     /* track 0 not found */
170         ATA_AMNF                = (1 << 0),     /* address mark not found */
171         ATAPI_LFS               = 0xF0,         /* last failed sense */
172         ATAPI_EOM               = ATA_TRK0NF,   /* end of media */
173         ATAPI_ILI               = ATA_AMNF,     /* illegal length indication */
174         ATAPI_IO                = (1 << 1),
175         ATAPI_COD               = (1 << 0),
176
177         /* ATA command block registers */
178         ATA_REG_DATA            = 0x00,
179         ATA_REG_ERR             = 0x01,
180         ATA_REG_NSECT           = 0x02,
181         ATA_REG_LBAL            = 0x03,
182         ATA_REG_LBAM            = 0x04,
183         ATA_REG_LBAH            = 0x05,
184         ATA_REG_DEVICE          = 0x06,
185         ATA_REG_STATUS          = 0x07,
186
187         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
188         ATA_REG_CMD             = ATA_REG_STATUS,
189         ATA_REG_BYTEL           = ATA_REG_LBAM,
190         ATA_REG_BYTEH           = ATA_REG_LBAH,
191         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
192         ATA_REG_IRQ             = ATA_REG_NSECT,
193
194         /* ATA device commands */
195         ATA_CMD_DEV_RESET       = 0x08, /* ATAPI device reset */
196         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
197         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
198         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
199         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
200         ATA_CMD_FLUSH           = 0xE7,
201         ATA_CMD_FLUSH_EXT       = 0xEA,
202         ATA_CMD_ID_ATA          = 0xEC,
203         ATA_CMD_ID_ATAPI        = 0xA1,
204         ATA_CMD_READ            = 0xC8,
205         ATA_CMD_READ_EXT        = 0x25,
206         ATA_CMD_WRITE           = 0xCA,
207         ATA_CMD_WRITE_EXT       = 0x35,
208         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
209         ATA_CMD_FPDMA_READ      = 0x60,
210         ATA_CMD_FPDMA_WRITE     = 0x61,
211         ATA_CMD_PIO_READ        = 0x20,
212         ATA_CMD_PIO_READ_EXT    = 0x24,
213         ATA_CMD_PIO_WRITE       = 0x30,
214         ATA_CMD_PIO_WRITE_EXT   = 0x34,
215         ATA_CMD_READ_MULTI      = 0xC4,
216         ATA_CMD_READ_MULTI_EXT  = 0x29,
217         ATA_CMD_WRITE_MULTI     = 0xC5,
218         ATA_CMD_WRITE_MULTI_EXT = 0x39,
219         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
220         ATA_CMD_SET_FEATURES    = 0xEF,
221         ATA_CMD_SET_MULTI       = 0xC6,
222         ATA_CMD_PACKET          = 0xA0,
223         ATA_CMD_VERIFY          = 0x40,
224         ATA_CMD_VERIFY_EXT      = 0x42,
225         ATA_CMD_STANDBYNOW1     = 0xE0,
226         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
227         ATA_CMD_SLEEP           = 0xE6,
228         ATA_CMD_INIT_DEV_PARAMS = 0x91,
229         ATA_CMD_READ_NATIVE_MAX = 0xF8,
230         ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
231         ATA_CMD_SET_MAX         = 0xF9,
232         ATA_CMD_SET_MAX_EXT     = 0x37,
233         ATA_CMD_READ_LOG_EXT    = 0x2f,
234         ATA_CMD_PMP_READ        = 0xE4,
235         ATA_CMD_PMP_WRITE       = 0xE8,
236         ATA_CMD_CONF_OVERLAY    = 0xB1,
237         ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
238         ATA_CMD_SMART           = 0xB0,
239         ATA_CMD_MEDIA_LOCK      = 0xDE,
240         ATA_CMD_MEDIA_UNLOCK    = 0xDF,
241         /* marked obsolete in the ATA/ATAPI-7 spec */
242         ATA_CMD_RESTORE         = 0x10,
243         /* EXABYTE specific */
244         ATA_EXABYTE_ENABLE_NEST = 0xF0,
245
246         /* READ_LOG_EXT pages */
247         ATA_LOG_SATA_NCQ        = 0x10,
248
249         /* READ/WRITE LONG (obsolete) */
250         ATA_CMD_READ_LONG       = 0x22,
251         ATA_CMD_READ_LONG_ONCE  = 0x23,
252         ATA_CMD_WRITE_LONG      = 0x32,
253         ATA_CMD_WRITE_LONG_ONCE = 0x33,
254
255         /* SETFEATURES stuff */
256         SETFEATURES_XFER        = 0x03,
257         XFER_UDMA_7             = 0x47,
258         XFER_UDMA_6             = 0x46,
259         XFER_UDMA_5             = 0x45,
260         XFER_UDMA_4             = 0x44,
261         XFER_UDMA_3             = 0x43,
262         XFER_UDMA_2             = 0x42,
263         XFER_UDMA_1             = 0x41,
264         XFER_UDMA_0             = 0x40,
265         XFER_MW_DMA_4           = 0x24, /* CFA only */
266         XFER_MW_DMA_3           = 0x23, /* CFA only */
267         XFER_MW_DMA_2           = 0x22,
268         XFER_MW_DMA_1           = 0x21,
269         XFER_MW_DMA_0           = 0x20,
270         XFER_SW_DMA_2           = 0x12,
271         XFER_SW_DMA_1           = 0x11,
272         XFER_SW_DMA_0           = 0x10,
273         XFER_PIO_6              = 0x0E, /* CFA only */
274         XFER_PIO_5              = 0x0D, /* CFA only */
275         XFER_PIO_4              = 0x0C,
276         XFER_PIO_3              = 0x0B,
277         XFER_PIO_2              = 0x0A,
278         XFER_PIO_1              = 0x09,
279         XFER_PIO_0              = 0x08,
280         XFER_PIO_SLOW           = 0x00,
281
282         SETFEATURES_WC_ON       = 0x02, /* Enable write cache */
283         SETFEATURES_WC_OFF      = 0x82, /* Disable write cache */
284
285         /* Enable/Disable Automatic Acoustic Management */
286         SETFEATURES_AAM_ON      = 0x42,
287         SETFEATURES_AAM_OFF     = 0xC2,
288
289         SETFEATURES_SPINUP      = 0x07, /* Spin-up drive */
290
291         SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
292         SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
293
294         /* SETFEATURE Sector counts for SATA features */
295         SATA_AN                 = 0x05,  /* Asynchronous Notification */
296         SATA_DIPM               = 0x03,  /* Device Initiated Power Management */
297
298         /* feature values for SET_MAX */
299         ATA_SET_MAX_ADDR        = 0x00,
300         ATA_SET_MAX_PASSWD      = 0x01,
301         ATA_SET_MAX_LOCK        = 0x02,
302         ATA_SET_MAX_UNLOCK      = 0x03,
303         ATA_SET_MAX_FREEZE_LOCK = 0x04,
304
305         /* feature values for DEVICE CONFIGURATION OVERLAY */
306         ATA_DCO_RESTORE         = 0xC0,
307         ATA_DCO_FREEZE_LOCK     = 0xC1,
308         ATA_DCO_IDENTIFY        = 0xC2,
309         ATA_DCO_SET             = 0xC3,
310
311         /* feature values for SMART */
312         ATA_SMART_ENABLE        = 0xD8,
313         ATA_SMART_READ_VALUES   = 0xD0,
314         ATA_SMART_READ_THRESHOLDS = 0xD1,
315
316         /* password used in LBA Mid / LBA High for executing SMART commands */
317         ATA_SMART_LBAM_PASS     = 0x4F,
318         ATA_SMART_LBAH_PASS     = 0xC2,
319
320         /* ATAPI stuff */
321         ATAPI_PKT_DMA           = (1 << 0),
322         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
323                                                    0=to device, 1=to host */
324         ATAPI_CDB_LEN           = 16,
325
326         /* PMP stuff */
327         SATA_PMP_MAX_PORTS      = 15,
328         SATA_PMP_CTRL_PORT      = 15,
329
330         SATA_PMP_GSCR_DWORDS    = 128,
331         SATA_PMP_GSCR_PROD_ID   = 0,
332         SATA_PMP_GSCR_REV       = 1,
333         SATA_PMP_GSCR_PORT_INFO = 2,
334         SATA_PMP_GSCR_ERROR     = 32,
335         SATA_PMP_GSCR_ERROR_EN  = 33,
336         SATA_PMP_GSCR_FEAT      = 64,
337         SATA_PMP_GSCR_FEAT_EN   = 96,
338
339         SATA_PMP_PSCR_STATUS    = 0,
340         SATA_PMP_PSCR_ERROR     = 1,
341         SATA_PMP_PSCR_CONTROL   = 2,
342
343         SATA_PMP_FEAT_BIST      = (1 << 0),
344         SATA_PMP_FEAT_PMREQ     = (1 << 1),
345         SATA_PMP_FEAT_DYNSSC    = (1 << 2),
346         SATA_PMP_FEAT_NOTIFY    = (1 << 3),
347
348         /* cable types */
349         ATA_CBL_NONE            = 0,
350         ATA_CBL_PATA40          = 1,
351         ATA_CBL_PATA80          = 2,
352         ATA_CBL_PATA40_SHORT    = 3,    /* 40 wire cable to high UDMA spec */
353         ATA_CBL_PATA_UNK        = 4,    /* don't know, maybe 80c? */
354         ATA_CBL_PATA_IGN        = 5,    /* don't know, ignore cable handling */
355         ATA_CBL_SATA            = 6,
356
357         /* SATA Status and Control Registers */
358         SCR_STATUS              = 0,
359         SCR_ERROR               = 1,
360         SCR_CONTROL             = 2,
361         SCR_ACTIVE              = 3,
362         SCR_NOTIFICATION        = 4,
363
364         /* SError bits */
365         SERR_DATA_RECOVERED     = (1 << 0), /* recovered data error */
366         SERR_COMM_RECOVERED     = (1 << 1), /* recovered comm failure */
367         SERR_DATA               = (1 << 8), /* unrecovered data error */
368         SERR_PERSISTENT         = (1 << 9), /* persistent data/comm error */
369         SERR_PROTOCOL           = (1 << 10), /* protocol violation */
370         SERR_INTERNAL           = (1 << 11), /* host internal error */
371         SERR_PHYRDY_CHG         = (1 << 16), /* PHY RDY changed */
372         SERR_PHY_INT_ERR        = (1 << 17), /* PHY internal error */
373         SERR_COMM_WAKE          = (1 << 18), /* Comm wake */
374         SERR_10B_8B_ERR         = (1 << 19), /* 10b to 8b decode error */
375         SERR_DISPARITY          = (1 << 20), /* Disparity */
376         SERR_CRC                = (1 << 21), /* CRC error */
377         SERR_HANDSHAKE          = (1 << 22), /* Handshake error */
378         SERR_LINK_SEQ_ERR       = (1 << 23), /* Link sequence error */
379         SERR_TRANS_ST_ERROR     = (1 << 24), /* Transport state trans. error */
380         SERR_UNRECOG_FIS        = (1 << 25), /* Unrecognized FIS */
381         SERR_DEV_XCHG           = (1 << 26), /* device exchanged */
382
383         /* struct ata_taskfile flags */
384         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
385         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
386         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
387         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
388         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
389         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
390         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
391
392         /* protocol flags */
393         ATA_PROT_FLAG_PIO       = (1 << 0), /* is PIO */
394         ATA_PROT_FLAG_DMA       = (1 << 1), /* is DMA */
395         ATA_PROT_FLAG_DATA      = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
396         ATA_PROT_FLAG_NCQ       = (1 << 2), /* is NCQ */
397         ATA_PROT_FLAG_ATAPI     = (1 << 3), /* is ATAPI */
398 };
399
400 enum ata_tf_protocols {
401         /* ATA taskfile protocols */
402         ATA_PROT_UNKNOWN,       /* unknown/invalid */
403         ATA_PROT_NODATA,        /* no data */
404         ATA_PROT_PIO,           /* PIO data xfer */
405         ATA_PROT_DMA,           /* DMA */
406         ATA_PROT_NCQ,           /* NCQ */
407         ATAPI_PROT_NODATA,      /* packet command, no data */
408         ATAPI_PROT_PIO,         /* packet command, PIO data xfer*/
409         ATAPI_PROT_DMA,         /* packet command with special DMA sauce */
410 };
411
412 enum ata_ioctls {
413         ATA_IOC_GET_IO32        = 0x309,
414         ATA_IOC_SET_IO32        = 0x324,
415 };
416
417 /* core structures */
418
419 struct ata_prd {
420         __le32                  addr;
421         __le32                  flags_len;
422 };
423
424 struct ata_taskfile {
425         unsigned long           flags;          /* ATA_TFLAG_xxx */
426         u8                      protocol;       /* ATA_PROT_xxx */
427
428         u8                      ctl;            /* control reg */
429
430         u8                      hob_feature;    /* additional data */
431         u8                      hob_nsect;      /* to support LBA48 */
432         u8                      hob_lbal;
433         u8                      hob_lbam;
434         u8                      hob_lbah;
435
436         u8                      feature;
437         u8                      nsect;
438         u8                      lbal;
439         u8                      lbam;
440         u8                      lbah;
441
442         u8                      device;
443
444         u8                      command;        /* IO operation */
445 };
446
447 /*
448  * protocol tests
449  */
450 static inline unsigned int ata_prot_flags(u8 prot)
451 {
452         switch (prot) {
453         case ATA_PROT_NODATA:
454                 return 0;
455         case ATA_PROT_PIO:
456                 return ATA_PROT_FLAG_PIO;
457         case ATA_PROT_DMA:
458                 return ATA_PROT_FLAG_DMA;
459         case ATA_PROT_NCQ:
460                 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
461         case ATAPI_PROT_NODATA:
462                 return ATA_PROT_FLAG_ATAPI;
463         case ATAPI_PROT_PIO:
464                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
465         case ATAPI_PROT_DMA:
466                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
467         }
468         return 0;
469 }
470
471 static inline int ata_is_atapi(u8 prot)
472 {
473         return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
474 }
475
476 static inline int ata_is_nodata(u8 prot)
477 {
478         return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
479 }
480
481 static inline int ata_is_pio(u8 prot)
482 {
483         return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
484 }
485
486 static inline int ata_is_dma(u8 prot)
487 {
488         return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
489 }
490
491 static inline int ata_is_ncq(u8 prot)
492 {
493         return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
494 }
495
496 static inline int ata_is_data(u8 prot)
497 {
498         return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
499 }
500
501 /*
502  * id tests
503  */
504 #define ata_id_is_ata(id)       (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
505 #define ata_id_has_lba(id)      ((id)[ATA_ID_CAPABILITY] & (1 << 9))
506 #define ata_id_has_dma(id)      ((id)[ATA_ID_CAPABILITY] & (1 << 8))
507 #define ata_id_has_ncq(id)      ((id)[76] & (1 << 8))
508 #define ata_id_queue_depth(id)  (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
509 #define ata_id_removeable(id)   ((id)[ATA_ID_CONFIG] & (1 << 7))
510 #define ata_id_has_atapi_AN(id) \
511         ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
512           ((id)[78] & (1 << 5)) )
513 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
514 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
515 #define ata_id_u32(id,n)        \
516         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
517 #define ata_id_u64(id,n)        \
518         ( ((u64) (id)[(n) + 3] << 48) | \
519           ((u64) (id)[(n) + 2] << 32) | \
520           ((u64) (id)[(n) + 1] << 16) | \
521           ((u64) (id)[(n) + 0]) )
522
523 #define ata_id_cdb_intr(id)     (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
524
525 static inline bool ata_id_has_hipm(const u16 *id)
526 {
527         u16 val = id[76];
528
529         if (val == 0 || val == 0xffff)
530                 return false;
531
532         return val & (1 << 9);
533 }
534
535 static inline bool ata_id_has_dipm(const u16 *id)
536 {
537         u16 val = id[78];
538
539         if (val == 0 || val == 0xffff)
540                 return false;
541
542         return val & (1 << 3);
543 }
544
545
546 static inline int ata_id_has_fua(const u16 *id)
547 {
548         if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
549                 return 0;
550         return id[ATA_ID_CFSSE] & (1 << 6);
551 }
552
553 static inline int ata_id_has_flush(const u16 *id)
554 {
555         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
556                 return 0;
557         return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
558 }
559
560 static inline int ata_id_has_flush_ext(const u16 *id)
561 {
562         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
563                 return 0;
564         return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
565 }
566
567 static inline int ata_id_has_lba48(const u16 *id)
568 {
569         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
570                 return 0;
571         if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
572                 return 0;
573         return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
574 }
575
576 static inline int ata_id_hpa_enabled(const u16 *id)
577 {
578         /* Yes children, word 83 valid bits cover word 82 data */
579         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
580                 return 0;
581         /* And 87 covers 85-87 */
582         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
583                 return 0;
584         /* Check command sets enabled as well as supported */
585         if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
586                 return 0;
587         return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
588 }
589
590 static inline int ata_id_has_wcache(const u16 *id)
591 {
592         /* Yes children, word 83 valid bits cover word 82 data */
593         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
594                 return 0;
595         return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
596 }
597
598 static inline int ata_id_has_pm(const u16 *id)
599 {
600         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
601                 return 0;
602         return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
603 }
604
605 static inline int ata_id_rahead_enabled(const u16 *id)
606 {
607         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
608                 return 0;
609         return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
610 }
611
612 static inline int ata_id_wcache_enabled(const u16 *id)
613 {
614         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
615                 return 0;
616         return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
617 }
618
619 /**
620  *      ata_id_major_version    -       get ATA level of drive
621  *      @id: Identify data
622  *
623  *      Caveats:
624  *              ATA-1 considers identify optional
625  *              ATA-2 introduces mandatory identify
626  *              ATA-3 introduces word 80 and accurate reporting
627  *
628  *      The practical impact of this is that ata_id_major_version cannot
629  *      reliably report on drives below ATA3.
630  */
631
632 static inline unsigned int ata_id_major_version(const u16 *id)
633 {
634         unsigned int mver;
635
636         if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
637                 return 0;
638
639         for (mver = 14; mver >= 1; mver--)
640                 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
641                         break;
642         return mver;
643 }
644
645 static inline int ata_id_is_sata(const u16 *id)
646 {
647         return ata_id_major_version(id) >= 5 && id[ATA_ID_HW_CONFIG] == 0;
648 }
649
650 static inline int ata_id_has_tpm(const u16 *id)
651 {
652         /* The TPM bits are only valid on ATA8 */
653         if (ata_id_major_version(id) < 8)
654                 return 0;
655         if ((id[48] & 0xC000) != 0x4000)
656                 return 0;
657         return id[48] & (1 << 0);
658 }
659
660 static inline int ata_id_has_dword_io(const u16 *id)
661 {
662         /* ATA 8 reuses this flag for "trusted" computing */
663         if (ata_id_major_version(id) > 7)
664                 return 0;
665         if (id[ATA_ID_DWORD_IO] & (1 << 0))
666                 return 1;
667         return 0;
668 }
669
670 static inline int ata_id_current_chs_valid(const u16 *id)
671 {
672         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
673            has not been issued to the device then the values of
674            id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
675         return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
676                 id[ATA_ID_CUR_CYLS] &&  /* cylinders in current translation */
677                 id[ATA_ID_CUR_HEADS] &&  /* heads in current translation */
678                 id[ATA_ID_CUR_HEADS] <= 16 &&
679                 id[ATA_ID_CUR_SECTORS];    /* sectors in current translation */
680 }
681
682 static inline int ata_id_is_cfa(const u16 *id)
683 {
684         if (id[ATA_ID_CONFIG] == 0x848A)        /* Standard CF */
685                 return 1;
686         /* Could be CF hiding as standard ATA */
687         if (ata_id_major_version(id) >= 3 &&
688             id[ATA_ID_COMMAND_SET_1] != 0xFFFF &&
689            (id[ATA_ID_COMMAND_SET_1] & (1 << 2)))
690                 return 1;
691         return 0;
692 }
693
694 static inline int ata_drive_40wire(const u16 *dev_id)
695 {
696         if (ata_id_is_sata(dev_id))
697                 return 0;       /* SATA */
698         if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
699                 return 0;       /* 80 wire */
700         return 1;
701 }
702
703 static inline int ata_drive_40wire_relaxed(const u16 *dev_id)
704 {
705         if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
706                 return 0;       /* 80 wire */
707         return 1;
708 }
709
710 static inline int atapi_cdb_len(const u16 *dev_id)
711 {
712         u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
713         switch (tmp) {
714         case 0:         return 12;
715         case 1:         return 16;
716         default:        return -1;
717         }
718 }
719
720 static inline int atapi_command_packet_set(const u16 *dev_id)
721 {
722         return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
723 }
724
725 static inline int atapi_id_dmadir(const u16 *dev_id)
726 {
727         return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
728 }
729
730 static inline int is_multi_taskfile(struct ata_taskfile *tf)
731 {
732         return (tf->command == ATA_CMD_READ_MULTI) ||
733                (tf->command == ATA_CMD_WRITE_MULTI) ||
734                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
735                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
736                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
737 }
738
739 static inline int ata_ok(u8 status)
740 {
741         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
742                         == ATA_DRDY);
743 }
744
745 static inline int lba_28_ok(u64 block, u32 n_block)
746 {
747         /* check the ending block number */
748         return ((block + n_block) < ((u64)1 << 28)) && (n_block <= 256);
749 }
750
751 static inline int lba_48_ok(u64 block, u32 n_block)
752 {
753         /* check the ending block number */
754         return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
755 }
756
757 #define sata_pmp_gscr_vendor(gscr)      ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
758 #define sata_pmp_gscr_devid(gscr)       ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
759 #define sata_pmp_gscr_rev(gscr)         (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
760 #define sata_pmp_gscr_ports(gscr)       ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
761
762 #endif /* __LINUX_ATA_H__ */