e2595e877e44345e0655dc52ad857ce4a31d522b
[safe/jmp/linux-2.6] / 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/kernel.h>
33 #include <linux/string.h>
34 #include <linux/types.h>
35 #include <asm/byteorder.h>
36
37 /* defines only for the constants which don't work well as enums */
38 #define ATA_DMA_BOUNDARY        0xffffUL
39 #define ATA_DMA_MASK            0xffffffffULL
40
41 enum {
42         /* various global constants */
43         ATA_MAX_DEVICES         = 2,    /* per bus/port */
44         ATA_MAX_PRD             = 256,  /* we could make these 256/256 */
45         ATA_SECT_SIZE           = 512,
46         ATA_MAX_SECTORS_128     = 128,
47         ATA_MAX_SECTORS         = 256,
48         ATA_MAX_SECTORS_LBA48   = 65535,/* TODO: 65536? */
49         ATA_MAX_SECTORS_TAPE    = 65535,
50
51         ATA_ID_WORDS            = 256,
52         ATA_ID_CONFIG           = 0,
53         ATA_ID_CYLS             = 1,
54         ATA_ID_HEADS            = 3,
55         ATA_ID_SECTORS          = 6,
56         ATA_ID_SERNO            = 10,
57         ATA_ID_BUF_SIZE         = 21,
58         ATA_ID_FW_REV           = 23,
59         ATA_ID_PROD             = 27,
60         ATA_ID_MAX_MULTSECT     = 47,
61         ATA_ID_DWORD_IO         = 48,
62         ATA_ID_CAPABILITY       = 49,
63         ATA_ID_OLD_PIO_MODES    = 51,
64         ATA_ID_OLD_DMA_MODES    = 52,
65         ATA_ID_FIELD_VALID      = 53,
66         ATA_ID_CUR_CYLS         = 54,
67         ATA_ID_CUR_HEADS        = 55,
68         ATA_ID_CUR_SECTORS      = 56,
69         ATA_ID_MULTSECT         = 59,
70         ATA_ID_LBA_CAPACITY     = 60,
71         ATA_ID_SWDMA_MODES      = 62,
72         ATA_ID_MWDMA_MODES      = 63,
73         ATA_ID_PIO_MODES        = 64,
74         ATA_ID_EIDE_DMA_MIN     = 65,
75         ATA_ID_EIDE_DMA_TIME    = 66,
76         ATA_ID_EIDE_PIO         = 67,
77         ATA_ID_EIDE_PIO_IORDY   = 68,
78         ATA_ID_QUEUE_DEPTH      = 75,
79         ATA_ID_MAJOR_VER        = 80,
80         ATA_ID_COMMAND_SET_1    = 82,
81         ATA_ID_COMMAND_SET_2    = 83,
82         ATA_ID_CFSSE            = 84,
83         ATA_ID_CFS_ENABLE_1     = 85,
84         ATA_ID_CFS_ENABLE_2     = 86,
85         ATA_ID_CSF_DEFAULT      = 87,
86         ATA_ID_UDMA_MODES       = 88,
87         ATA_ID_HW_CONFIG        = 93,
88         ATA_ID_SPG              = 98,
89         ATA_ID_LBA_CAPACITY_2   = 100,
90         ATA_ID_SECTOR_SIZE      = 106,
91         ATA_ID_LAST_LUN         = 126,
92         ATA_ID_DLF              = 128,
93         ATA_ID_CSFO             = 129,
94         ATA_ID_CFA_POWER        = 160,
95         ATA_ID_CFA_KEY_MGMT     = 162,
96         ATA_ID_CFA_MODES        = 163,
97         ATA_ID_DATA_SET_MGMT    = 169,
98         ATA_ID_ROT_SPEED        = 217,
99         ATA_ID_PIO4             = (1 << 1),
100
101         ATA_ID_SERNO_LEN        = 20,
102         ATA_ID_FW_REV_LEN       = 8,
103         ATA_ID_PROD_LEN         = 40,
104
105         ATA_PCI_CTL_OFS         = 2,
106
107         ATA_PIO0                = (1 << 0),
108         ATA_PIO1                = ATA_PIO0 | (1 << 1),
109         ATA_PIO2                = ATA_PIO1 | (1 << 2),
110         ATA_PIO3                = ATA_PIO2 | (1 << 3),
111         ATA_PIO4                = ATA_PIO3 | (1 << 4),
112         ATA_PIO5                = ATA_PIO4 | (1 << 5),
113         ATA_PIO6                = ATA_PIO5 | (1 << 6),
114
115         ATA_PIO4_ONLY           = (1 << 4),
116
117         ATA_SWDMA0              = (1 << 0),
118         ATA_SWDMA1              = ATA_SWDMA0 | (1 << 1),
119         ATA_SWDMA2              = ATA_SWDMA1 | (1 << 2),
120
121         ATA_SWDMA2_ONLY         = (1 << 2),
122
123         ATA_MWDMA0              = (1 << 0),
124         ATA_MWDMA1              = ATA_MWDMA0 | (1 << 1),
125         ATA_MWDMA2              = ATA_MWDMA1 | (1 << 2),
126         ATA_MWDMA3              = ATA_MWDMA2 | (1 << 3),
127         ATA_MWDMA4              = ATA_MWDMA3 | (1 << 4),
128
129         ATA_MWDMA12_ONLY        = (1 << 1) | (1 << 2),
130         ATA_MWDMA2_ONLY         = (1 << 2),
131
132         ATA_UDMA0               = (1 << 0),
133         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
134         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
135         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
136         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
137         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
138         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
139         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
140         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
141
142         ATA_UDMA24_ONLY         = (1 << 2) | (1 << 4),
143
144         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
145
146         /* DMA-related */
147         ATA_PRD_SZ              = 8,
148         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
149         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
150
151         ATA_DMA_TABLE_OFS       = 4,
152         ATA_DMA_STATUS          = 2,
153         ATA_DMA_CMD             = 0,
154         ATA_DMA_WR              = (1 << 3),
155         ATA_DMA_START           = (1 << 0),
156         ATA_DMA_INTR            = (1 << 2),
157         ATA_DMA_ERR             = (1 << 1),
158         ATA_DMA_ACTIVE          = (1 << 0),
159
160         /* bits in ATA command block registers */
161         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
162         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
163         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
164         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
165         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
166         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
167         ATA_BUSY                = (1 << 7),     /* BSY status bit */
168         ATA_DRDY                = (1 << 6),     /* device ready */
169         ATA_DF                  = (1 << 5),     /* device fault */
170         ATA_DSC                 = (1 << 4),     /* drive seek complete */
171         ATA_DRQ                 = (1 << 3),     /* data request i/o */
172         ATA_CORR                = (1 << 2),     /* corrected data error */
173         ATA_IDX                 = (1 << 1),     /* index */
174         ATA_ERR                 = (1 << 0),     /* have an error */
175         ATA_SRST                = (1 << 2),     /* software reset */
176         ATA_ICRC                = (1 << 7),     /* interface CRC error */
177         ATA_BBK                 = ATA_ICRC,     /* pre-EIDE: block marked bad */
178         ATA_UNC                 = (1 << 6),     /* uncorrectable media error */
179         ATA_MC                  = (1 << 5),     /* media changed */
180         ATA_IDNF                = (1 << 4),     /* ID not found */
181         ATA_MCR                 = (1 << 3),     /* media change requested */
182         ATA_ABORTED             = (1 << 2),     /* command aborted */
183         ATA_TRK0NF              = (1 << 1),     /* track 0 not found */
184         ATA_AMNF                = (1 << 0),     /* address mark not found */
185         ATAPI_LFS               = 0xF0,         /* last failed sense */
186         ATAPI_EOM               = ATA_TRK0NF,   /* end of media */
187         ATAPI_ILI               = ATA_AMNF,     /* illegal length indication */
188         ATAPI_IO                = (1 << 1),
189         ATAPI_COD               = (1 << 0),
190
191         /* ATA command block registers */
192         ATA_REG_DATA            = 0x00,
193         ATA_REG_ERR             = 0x01,
194         ATA_REG_NSECT           = 0x02,
195         ATA_REG_LBAL            = 0x03,
196         ATA_REG_LBAM            = 0x04,
197         ATA_REG_LBAH            = 0x05,
198         ATA_REG_DEVICE          = 0x06,
199         ATA_REG_STATUS          = 0x07,
200
201         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
202         ATA_REG_CMD             = ATA_REG_STATUS,
203         ATA_REG_BYTEL           = ATA_REG_LBAM,
204         ATA_REG_BYTEH           = ATA_REG_LBAH,
205         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
206         ATA_REG_IRQ             = ATA_REG_NSECT,
207
208         /* ATA device commands */
209         ATA_CMD_DEV_RESET       = 0x08, /* ATAPI device reset */
210         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
211         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
212         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
213         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
214         ATA_CMD_DOWNLOAD_MICRO  = 0x92,
215         ATA_CMD_NOP             = 0x00,
216         ATA_CMD_FLUSH           = 0xE7,
217         ATA_CMD_FLUSH_EXT       = 0xEA,
218         ATA_CMD_ID_ATA          = 0xEC,
219         ATA_CMD_ID_ATAPI        = 0xA1,
220         ATA_CMD_SERVICE         = 0xA2,
221         ATA_CMD_READ            = 0xC8,
222         ATA_CMD_READ_EXT        = 0x25,
223         ATA_CMD_READ_QUEUED     = 0x26,
224         ATA_CMD_READ_STREAM_EXT = 0x2B,
225         ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
226         ATA_CMD_WRITE           = 0xCA,
227         ATA_CMD_WRITE_EXT       = 0x35,
228         ATA_CMD_WRITE_QUEUED    = 0x36,
229         ATA_CMD_WRITE_STREAM_EXT = 0x3B,
230         ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
231         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
232         ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
233         ATA_CMD_FPDMA_READ      = 0x60,
234         ATA_CMD_FPDMA_WRITE     = 0x61,
235         ATA_CMD_PIO_READ        = 0x20,
236         ATA_CMD_PIO_READ_EXT    = 0x24,
237         ATA_CMD_PIO_WRITE       = 0x30,
238         ATA_CMD_PIO_WRITE_EXT   = 0x34,
239         ATA_CMD_READ_MULTI      = 0xC4,
240         ATA_CMD_READ_MULTI_EXT  = 0x29,
241         ATA_CMD_WRITE_MULTI     = 0xC5,
242         ATA_CMD_WRITE_MULTI_EXT = 0x39,
243         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
244         ATA_CMD_SET_FEATURES    = 0xEF,
245         ATA_CMD_SET_MULTI       = 0xC6,
246         ATA_CMD_PACKET          = 0xA0,
247         ATA_CMD_VERIFY          = 0x40,
248         ATA_CMD_VERIFY_EXT      = 0x42,
249         ATA_CMD_WRITE_UNCORR_EXT = 0x45,
250         ATA_CMD_STANDBYNOW1     = 0xE0,
251         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
252         ATA_CMD_SLEEP           = 0xE6,
253         ATA_CMD_INIT_DEV_PARAMS = 0x91,
254         ATA_CMD_READ_NATIVE_MAX = 0xF8,
255         ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
256         ATA_CMD_SET_MAX         = 0xF9,
257         ATA_CMD_SET_MAX_EXT     = 0x37,
258         ATA_CMD_READ_LOG_EXT    = 0x2F,
259         ATA_CMD_WRITE_LOG_EXT   = 0x3F,
260         ATA_CMD_READ_LOG_DMA_EXT = 0x47,
261         ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
262         ATA_CMD_TRUSTED_RCV     = 0x5C,
263         ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
264         ATA_CMD_TRUSTED_SND     = 0x5E,
265         ATA_CMD_TRUSTED_SND_DMA = 0x5F,
266         ATA_CMD_PMP_READ        = 0xE4,
267         ATA_CMD_PMP_WRITE       = 0xE8,
268         ATA_CMD_CONF_OVERLAY    = 0xB1,
269         ATA_CMD_SEC_SET_PASS    = 0xF1,
270         ATA_CMD_SEC_UNLOCK      = 0xF2,
271         ATA_CMD_SEC_ERASE_PREP  = 0xF3,
272         ATA_CMD_SEC_ERASE_UNIT  = 0xF4,
273         ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
274         ATA_CMD_SEC_DISABLE_PASS = 0xF6,
275         ATA_CMD_CONFIG_STREAM   = 0x51,
276         ATA_CMD_SMART           = 0xB0,
277         ATA_CMD_MEDIA_LOCK      = 0xDE,
278         ATA_CMD_MEDIA_UNLOCK    = 0xDF,
279         ATA_CMD_DSM             = 0x06,
280         ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
281         ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
282         ATA_CMD_CFA_WRITE_NE    = 0x38,
283         ATA_CMD_CFA_TRANS_SECT  = 0x87,
284         ATA_CMD_CFA_ERASE       = 0xC0,
285         ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
286         /* marked obsolete in the ATA/ATAPI-7 spec */
287         ATA_CMD_RESTORE         = 0x10,
288
289         /* READ_LOG_EXT pages */
290         ATA_LOG_SATA_NCQ        = 0x10,
291
292         /* READ/WRITE LONG (obsolete) */
293         ATA_CMD_READ_LONG       = 0x22,
294         ATA_CMD_READ_LONG_ONCE  = 0x23,
295         ATA_CMD_WRITE_LONG      = 0x32,
296         ATA_CMD_WRITE_LONG_ONCE = 0x33,
297
298         /* SETFEATURES stuff */
299         SETFEATURES_XFER        = 0x03,
300         XFER_UDMA_7             = 0x47,
301         XFER_UDMA_6             = 0x46,
302         XFER_UDMA_5             = 0x45,
303         XFER_UDMA_4             = 0x44,
304         XFER_UDMA_3             = 0x43,
305         XFER_UDMA_2             = 0x42,
306         XFER_UDMA_1             = 0x41,
307         XFER_UDMA_0             = 0x40,
308         XFER_MW_DMA_4           = 0x24, /* CFA only */
309         XFER_MW_DMA_3           = 0x23, /* CFA only */
310         XFER_MW_DMA_2           = 0x22,
311         XFER_MW_DMA_1           = 0x21,
312         XFER_MW_DMA_0           = 0x20,
313         XFER_SW_DMA_2           = 0x12,
314         XFER_SW_DMA_1           = 0x11,
315         XFER_SW_DMA_0           = 0x10,
316         XFER_PIO_6              = 0x0E, /* CFA only */
317         XFER_PIO_5              = 0x0D, /* CFA only */
318         XFER_PIO_4              = 0x0C,
319         XFER_PIO_3              = 0x0B,
320         XFER_PIO_2              = 0x0A,
321         XFER_PIO_1              = 0x09,
322         XFER_PIO_0              = 0x08,
323         XFER_PIO_SLOW           = 0x00,
324
325         SETFEATURES_WC_ON       = 0x02, /* Enable write cache */
326         SETFEATURES_WC_OFF      = 0x82, /* Disable write cache */
327
328         /* Enable/Disable Automatic Acoustic Management */
329         SETFEATURES_AAM_ON      = 0x42,
330         SETFEATURES_AAM_OFF     = 0xC2,
331
332         SETFEATURES_SPINUP      = 0x07, /* Spin-up drive */
333
334         SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
335         SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
336
337         /* SETFEATURE Sector counts for SATA features */
338         SATA_FPDMA_OFFSET       = 0x01, /* FPDMA non-zero buffer offsets */
339         SATA_FPDMA_AA           = 0x02, /* FPDMA Setup FIS Auto-Activate */
340         SATA_DIPM               = 0x03, /* Device Initiated Power Management */
341         SATA_FPDMA_IN_ORDER     = 0x04, /* FPDMA in-order data delivery */
342         SATA_AN                 = 0x05, /* Asynchronous Notification */
343         SATA_SSP                = 0x06, /* Software Settings Preservation */
344
345         /* feature values for SET_MAX */
346         ATA_SET_MAX_ADDR        = 0x00,
347         ATA_SET_MAX_PASSWD      = 0x01,
348         ATA_SET_MAX_LOCK        = 0x02,
349         ATA_SET_MAX_UNLOCK      = 0x03,
350         ATA_SET_MAX_FREEZE_LOCK = 0x04,
351
352         /* feature values for DEVICE CONFIGURATION OVERLAY */
353         ATA_DCO_RESTORE         = 0xC0,
354         ATA_DCO_FREEZE_LOCK     = 0xC1,
355         ATA_DCO_IDENTIFY        = 0xC2,
356         ATA_DCO_SET             = 0xC3,
357
358         /* feature values for SMART */
359         ATA_SMART_ENABLE        = 0xD8,
360         ATA_SMART_READ_VALUES   = 0xD0,
361         ATA_SMART_READ_THRESHOLDS = 0xD1,
362
363         /* feature values for Data Set Management */
364         ATA_DSM_TRIM            = 0x01,
365
366         /* password used in LBA Mid / LBA High for executing SMART commands */
367         ATA_SMART_LBAM_PASS     = 0x4F,
368         ATA_SMART_LBAH_PASS     = 0xC2,
369
370         /* ATAPI stuff */
371         ATAPI_PKT_DMA           = (1 << 0),
372         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
373                                                    0=to device, 1=to host */
374         ATAPI_CDB_LEN           = 16,
375
376         /* PMP stuff */
377         SATA_PMP_MAX_PORTS      = 15,
378         SATA_PMP_CTRL_PORT      = 15,
379
380         SATA_PMP_GSCR_DWORDS    = 128,
381         SATA_PMP_GSCR_PROD_ID   = 0,
382         SATA_PMP_GSCR_REV       = 1,
383         SATA_PMP_GSCR_PORT_INFO = 2,
384         SATA_PMP_GSCR_ERROR     = 32,
385         SATA_PMP_GSCR_ERROR_EN  = 33,
386         SATA_PMP_GSCR_FEAT      = 64,
387         SATA_PMP_GSCR_FEAT_EN   = 96,
388
389         SATA_PMP_PSCR_STATUS    = 0,
390         SATA_PMP_PSCR_ERROR     = 1,
391         SATA_PMP_PSCR_CONTROL   = 2,
392
393         SATA_PMP_FEAT_BIST      = (1 << 0),
394         SATA_PMP_FEAT_PMREQ     = (1 << 1),
395         SATA_PMP_FEAT_DYNSSC    = (1 << 2),
396         SATA_PMP_FEAT_NOTIFY    = (1 << 3),
397
398         /* cable types */
399         ATA_CBL_NONE            = 0,
400         ATA_CBL_PATA40          = 1,
401         ATA_CBL_PATA80          = 2,
402         ATA_CBL_PATA40_SHORT    = 3,    /* 40 wire cable to high UDMA spec */
403         ATA_CBL_PATA_UNK        = 4,    /* don't know, maybe 80c? */
404         ATA_CBL_PATA_IGN        = 5,    /* don't know, ignore cable handling */
405         ATA_CBL_SATA            = 6,
406
407         /* SATA Status and Control Registers */
408         SCR_STATUS              = 0,
409         SCR_ERROR               = 1,
410         SCR_CONTROL             = 2,
411         SCR_ACTIVE              = 3,
412         SCR_NOTIFICATION        = 4,
413
414         /* SError bits */
415         SERR_DATA_RECOVERED     = (1 << 0), /* recovered data error */
416         SERR_COMM_RECOVERED     = (1 << 1), /* recovered comm failure */
417         SERR_DATA               = (1 << 8), /* unrecovered data error */
418         SERR_PERSISTENT         = (1 << 9), /* persistent data/comm error */
419         SERR_PROTOCOL           = (1 << 10), /* protocol violation */
420         SERR_INTERNAL           = (1 << 11), /* host internal error */
421         SERR_PHYRDY_CHG         = (1 << 16), /* PHY RDY changed */
422         SERR_PHY_INT_ERR        = (1 << 17), /* PHY internal error */
423         SERR_COMM_WAKE          = (1 << 18), /* Comm wake */
424         SERR_10B_8B_ERR         = (1 << 19), /* 10b to 8b decode error */
425         SERR_DISPARITY          = (1 << 20), /* Disparity */
426         SERR_CRC                = (1 << 21), /* CRC error */
427         SERR_HANDSHAKE          = (1 << 22), /* Handshake error */
428         SERR_LINK_SEQ_ERR       = (1 << 23), /* Link sequence error */
429         SERR_TRANS_ST_ERROR     = (1 << 24), /* Transport state trans. error */
430         SERR_UNRECOG_FIS        = (1 << 25), /* Unrecognized FIS */
431         SERR_DEV_XCHG           = (1 << 26), /* device exchanged */
432
433         /* struct ata_taskfile flags */
434         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
435         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
436         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
437         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
438         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
439         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
440         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
441
442         /* protocol flags */
443         ATA_PROT_FLAG_PIO       = (1 << 0), /* is PIO */
444         ATA_PROT_FLAG_DMA       = (1 << 1), /* is DMA */
445         ATA_PROT_FLAG_DATA      = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
446         ATA_PROT_FLAG_NCQ       = (1 << 2), /* is NCQ */
447         ATA_PROT_FLAG_ATAPI     = (1 << 3), /* is ATAPI */
448 };
449
450 enum ata_tf_protocols {
451         /* ATA taskfile protocols */
452         ATA_PROT_UNKNOWN,       /* unknown/invalid */
453         ATA_PROT_NODATA,        /* no data */
454         ATA_PROT_PIO,           /* PIO data xfer */
455         ATA_PROT_DMA,           /* DMA */
456         ATA_PROT_NCQ,           /* NCQ */
457         ATAPI_PROT_NODATA,      /* packet command, no data */
458         ATAPI_PROT_PIO,         /* packet command, PIO data xfer*/
459         ATAPI_PROT_DMA,         /* packet command with special DMA sauce */
460 };
461
462 enum ata_ioctls {
463         ATA_IOC_GET_IO32        = 0x309,
464         ATA_IOC_SET_IO32        = 0x324,
465 };
466
467 /* core structures */
468
469 struct ata_prd {
470         __le32                  addr;
471         __le32                  flags_len;
472 };
473
474 struct ata_taskfile {
475         unsigned long           flags;          /* ATA_TFLAG_xxx */
476         u8                      protocol;       /* ATA_PROT_xxx */
477
478         u8                      ctl;            /* control reg */
479
480         u8                      hob_feature;    /* additional data */
481         u8                      hob_nsect;      /* to support LBA48 */
482         u8                      hob_lbal;
483         u8                      hob_lbam;
484         u8                      hob_lbah;
485
486         u8                      feature;
487         u8                      nsect;
488         u8                      lbal;
489         u8                      lbam;
490         u8                      lbah;
491
492         u8                      device;
493
494         u8                      command;        /* IO operation */
495 };
496
497 /*
498  * protocol tests
499  */
500 static inline unsigned int ata_prot_flags(u8 prot)
501 {
502         switch (prot) {
503         case ATA_PROT_NODATA:
504                 return 0;
505         case ATA_PROT_PIO:
506                 return ATA_PROT_FLAG_PIO;
507         case ATA_PROT_DMA:
508                 return ATA_PROT_FLAG_DMA;
509         case ATA_PROT_NCQ:
510                 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
511         case ATAPI_PROT_NODATA:
512                 return ATA_PROT_FLAG_ATAPI;
513         case ATAPI_PROT_PIO:
514                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
515         case ATAPI_PROT_DMA:
516                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
517         }
518         return 0;
519 }
520
521 static inline int ata_is_atapi(u8 prot)
522 {
523         return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
524 }
525
526 static inline int ata_is_nodata(u8 prot)
527 {
528         return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
529 }
530
531 static inline int ata_is_pio(u8 prot)
532 {
533         return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
534 }
535
536 static inline int ata_is_dma(u8 prot)
537 {
538         return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
539 }
540
541 static inline int ata_is_ncq(u8 prot)
542 {
543         return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
544 }
545
546 static inline int ata_is_data(u8 prot)
547 {
548         return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
549 }
550
551 /*
552  * id tests
553  */
554 #define ata_id_is_ata(id)       (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
555 #define ata_id_has_lba(id)      ((id)[ATA_ID_CAPABILITY] & (1 << 9))
556 #define ata_id_has_dma(id)      ((id)[ATA_ID_CAPABILITY] & (1 << 8))
557 #define ata_id_has_ncq(id)      ((id)[76] & (1 << 8))
558 #define ata_id_queue_depth(id)  (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
559 #define ata_id_removeable(id)   ((id)[ATA_ID_CONFIG] & (1 << 7))
560 #define ata_id_has_atapi_AN(id) \
561         ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
562           ((id)[78] & (1 << 5)) )
563 #define ata_id_has_fpdma_aa(id) \
564         ( (((id)[76] != 0x0000) && ((id)[76] != 0xffff)) && \
565           ((id)[78] & (1 << 2)) )
566 #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
567 #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
568 #define ata_id_u32(id,n)        \
569         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
570 #define ata_id_u64(id,n)        \
571         ( ((u64) (id)[(n) + 3] << 48) | \
572           ((u64) (id)[(n) + 2] << 32) | \
573           ((u64) (id)[(n) + 1] << 16) | \
574           ((u64) (id)[(n) + 0]) )
575
576 #define ata_id_cdb_intr(id)     (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
577
578 static inline bool ata_id_has_hipm(const u16 *id)
579 {
580         u16 val = id[76];
581
582         if (val == 0 || val == 0xffff)
583                 return false;
584
585         return val & (1 << 9);
586 }
587
588 static inline bool ata_id_has_dipm(const u16 *id)
589 {
590         u16 val = id[78];
591
592         if (val == 0 || val == 0xffff)
593                 return false;
594
595         return val & (1 << 3);
596 }
597
598
599 static inline int ata_id_has_fua(const u16 *id)
600 {
601         if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
602                 return 0;
603         return id[ATA_ID_CFSSE] & (1 << 6);
604 }
605
606 static inline int ata_id_has_flush(const u16 *id)
607 {
608         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
609                 return 0;
610         return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
611 }
612
613 static inline int ata_id_flush_enabled(const u16 *id)
614 {
615         if (ata_id_has_flush(id) == 0)
616                 return 0;
617         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
618                 return 0;
619         return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
620 }
621
622 static inline int ata_id_has_flush_ext(const u16 *id)
623 {
624         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
625                 return 0;
626         return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
627 }
628
629 static inline int ata_id_flush_ext_enabled(const u16 *id)
630 {
631         if (ata_id_has_flush_ext(id) == 0)
632                 return 0;
633         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
634                 return 0;
635         /*
636          * some Maxtor disks have bit 13 defined incorrectly
637          * so check bit 10 too
638          */
639         return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
640 }
641
642 static inline int ata_id_has_large_logical_sectors(const u16 *id)
643 {
644         if ((id[ATA_ID_SECTOR_SIZE] & 0xc000) != 0x4000)
645                 return 0;
646         return id[ATA_ID_SECTOR_SIZE] & (1 << 13);
647 }
648
649 static inline u8 ata_id_logical_per_physical_sectors(const u16 *id)
650 {
651         return id[ATA_ID_SECTOR_SIZE] & 0xf;
652 }
653
654 static inline int ata_id_has_lba48(const u16 *id)
655 {
656         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
657                 return 0;
658         if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
659                 return 0;
660         return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
661 }
662
663 static inline int ata_id_lba48_enabled(const u16 *id)
664 {
665         if (ata_id_has_lba48(id) == 0)
666                 return 0;
667         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
668                 return 0;
669         return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
670 }
671
672 static inline int ata_id_hpa_enabled(const u16 *id)
673 {
674         /* Yes children, word 83 valid bits cover word 82 data */
675         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
676                 return 0;
677         /* And 87 covers 85-87 */
678         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
679                 return 0;
680         /* Check command sets enabled as well as supported */
681         if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
682                 return 0;
683         return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
684 }
685
686 static inline int ata_id_has_wcache(const u16 *id)
687 {
688         /* Yes children, word 83 valid bits cover word 82 data */
689         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
690                 return 0;
691         return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
692 }
693
694 static inline int ata_id_has_pm(const u16 *id)
695 {
696         if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
697                 return 0;
698         return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
699 }
700
701 static inline int ata_id_rahead_enabled(const u16 *id)
702 {
703         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
704                 return 0;
705         return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
706 }
707
708 static inline int ata_id_wcache_enabled(const u16 *id)
709 {
710         if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
711                 return 0;
712         return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
713 }
714
715 /**
716  *      ata_id_major_version    -       get ATA level of drive
717  *      @id: Identify data
718  *
719  *      Caveats:
720  *              ATA-1 considers identify optional
721  *              ATA-2 introduces mandatory identify
722  *              ATA-3 introduces word 80 and accurate reporting
723  *
724  *      The practical impact of this is that ata_id_major_version cannot
725  *      reliably report on drives below ATA3.
726  */
727
728 static inline unsigned int ata_id_major_version(const u16 *id)
729 {
730         unsigned int mver;
731
732         if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
733                 return 0;
734
735         for (mver = 14; mver >= 1; mver--)
736                 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
737                         break;
738         return mver;
739 }
740
741 static inline int ata_id_is_sata(const u16 *id)
742 {
743         /*
744          * See if word 93 is 0 AND drive is at least ATA-5 compatible
745          * verifying that word 80 by casting it to a signed type --
746          * this trick allows us to filter out the reserved values of
747          * 0x0000 and 0xffff along with the earlier ATA revisions...
748          */
749         if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
750                 return 1;
751         return 0;
752 }
753
754 static inline int ata_id_has_tpm(const u16 *id)
755 {
756         /* The TPM bits are only valid on ATA8 */
757         if (ata_id_major_version(id) < 8)
758                 return 0;
759         if ((id[48] & 0xC000) != 0x4000)
760                 return 0;
761         return id[48] & (1 << 0);
762 }
763
764 static inline int ata_id_has_dword_io(const u16 *id)
765 {
766         /* ATA 8 reuses this flag for "trusted" computing */
767         if (ata_id_major_version(id) > 7)
768                 return 0;
769         if (id[ATA_ID_DWORD_IO] & (1 << 0))
770                 return 1;
771         return 0;
772 }
773
774 static inline int ata_id_has_unload(const u16 *id)
775 {
776         if (ata_id_major_version(id) >= 7 &&
777             (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
778             id[ATA_ID_CFSSE] & (1 << 13))
779                 return 1;
780         return 0;
781 }
782
783 static inline int ata_id_form_factor(const u16 *id)
784 {
785         u16 val = id[168];
786
787         if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
788                 return 0;
789
790         val &= 0xf;
791
792         if (val > 5)
793                 return 0;
794
795         return val;
796 }
797
798 static inline int ata_id_rotation_rate(const u16 *id)
799 {
800         u16 val = id[217];
801
802         if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
803                 return 0;
804
805         if (val > 1 && val < 0x401)
806                 return 0;
807
808         return val;
809 }
810
811 static inline int ata_id_has_trim(const u16 *id)
812 {
813         if (ata_id_major_version(id) >= 7 &&
814             (id[ATA_ID_DATA_SET_MGMT] & 1))
815                 return 1;
816         return 0;
817 }
818
819 static inline int ata_id_current_chs_valid(const u16 *id)
820 {
821         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
822            has not been issued to the device then the values of
823            id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
824         return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
825                 id[ATA_ID_CUR_CYLS] &&  /* cylinders in current translation */
826                 id[ATA_ID_CUR_HEADS] &&  /* heads in current translation */
827                 id[ATA_ID_CUR_HEADS] <= 16 &&
828                 id[ATA_ID_CUR_SECTORS];    /* sectors in current translation */
829 }
830
831 static inline int ata_id_is_cfa(const u16 *id)
832 {
833         if (id[ATA_ID_CONFIG] == 0x848A)        /* Traditional CF */
834                 return 1;
835         /*
836          * CF specs don't require specific value in the word 0 anymore and yet
837          * they forbid to report the ATA version in the word 80 and require the
838          * CFA feature set support to be indicated in the word 83 in this case.
839          * Unfortunately, some cards only follow either of this requirements,
840          * and while those that don't indicate CFA feature support need some
841          * sort of quirk list, it seems impractical for the ones that do...
842          */
843         if ((id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004)
844                 return 1;
845         return 0;
846 }
847
848 static inline int ata_id_is_ssd(const u16 *id)
849 {
850         return id[ATA_ID_ROT_SPEED] == 0x01;
851 }
852
853 static inline int ata_id_pio_need_iordy(const u16 *id, const u8 pio)
854 {
855         /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
856         if (pio > 4 && ata_id_is_cfa(id))
857                 return 0;
858         /* For PIO3 and higher it is mandatory. */
859         if (pio > 2)
860                 return 1;
861         /* Turn it on when possible. */
862         if (ata_id_has_iordy(id))
863                 return 1;
864         return 0;
865 }
866
867 static inline int ata_drive_40wire(const u16 *dev_id)
868 {
869         if (ata_id_is_sata(dev_id))
870                 return 0;       /* SATA */
871         if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
872                 return 0;       /* 80 wire */
873         return 1;
874 }
875
876 static inline int ata_drive_40wire_relaxed(const u16 *dev_id)
877 {
878         if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
879                 return 0;       /* 80 wire */
880         return 1;
881 }
882
883 static inline int atapi_cdb_len(const u16 *dev_id)
884 {
885         u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
886         switch (tmp) {
887         case 0:         return 12;
888         case 1:         return 16;
889         default:        return -1;
890         }
891 }
892
893 static inline int atapi_command_packet_set(const u16 *dev_id)
894 {
895         return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
896 }
897
898 static inline int atapi_id_dmadir(const u16 *dev_id)
899 {
900         return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
901 }
902
903 /*
904  * ata_id_is_lba_capacity_ok() performs a sanity check on
905  * the claimed LBA capacity value for the device.
906  *
907  * Returns 1 if LBA capacity looks sensible, 0 otherwise.
908  *
909  * It is called only once for each device.
910  */
911 static inline int ata_id_is_lba_capacity_ok(u16 *id)
912 {
913         unsigned long lba_sects, chs_sects, head, tail;
914
915         /* No non-LBA info .. so valid! */
916         if (id[ATA_ID_CYLS] == 0)
917                 return 1;
918
919         lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
920
921         /*
922          * The ATA spec tells large drives to return
923          * C/H/S = 16383/16/63 independent of their size.
924          * Some drives can be jumpered to use 15 heads instead of 16.
925          * Some drives can be jumpered to use 4092 cyls instead of 16383.
926          */
927         if ((id[ATA_ID_CYLS] == 16383 ||
928              (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
929             id[ATA_ID_SECTORS] == 63 &&
930             (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
931             (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
932                 return 1;
933
934         chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
935
936         /* perform a rough sanity check on lba_sects: within 10% is OK */
937         if (lba_sects - chs_sects < chs_sects/10)
938                 return 1;
939
940         /* some drives have the word order reversed */
941         head = (lba_sects >> 16) & 0xffff;
942         tail = lba_sects & 0xffff;
943         lba_sects = head | (tail << 16);
944
945         if (lba_sects - chs_sects < chs_sects/10) {
946                 *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
947                 return 1;       /* LBA capacity is (now) good */
948         }
949
950         return 0;       /* LBA capacity value may be bad */
951 }
952
953 static inline void ata_id_to_hd_driveid(u16 *id)
954 {
955 #ifdef __BIG_ENDIAN
956         /* accessed in struct hd_driveid as 8-bit values */
957         id[ATA_ID_MAX_MULTSECT]  = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
958         id[ATA_ID_CAPABILITY]    = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
959         id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
960         id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
961         id[ATA_ID_MULTSECT]      = __cpu_to_le16(id[ATA_ID_MULTSECT]);
962
963         /* as 32-bit values */
964         *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
965         *(u32 *)&id[ATA_ID_SPG]          = ata_id_u32(id, ATA_ID_SPG);
966
967         /* as 64-bit value */
968         *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
969                 ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
970 #endif
971 }
972
973 /*
974  * Write up to 'max' LBA Range Entries to the buffer that will cover the
975  * extent from sector to sector + count.  This is used for TRIM and for
976  * ADD LBA(S) TO NV CACHE PINNED SET.
977  */
978 static inline unsigned ata_set_lba_range_entries(void *_buffer, unsigned max,
979                                                 u64 sector, unsigned long count)
980 {
981         __le64 *buffer = _buffer;
982         unsigned i = 0;
983
984         while (i < max) {
985                 u64 entry = sector |
986                         ((u64)(count > 0xffff ? 0xffff : count) << 48);
987                 buffer[i++] = __cpu_to_le64(entry);
988                 if (count <= 0xffff)
989                         break;
990                 count -= 0xffff;
991                 sector += 0xffff;
992         }
993
994         max = ALIGN(i * 8, 512);
995         memset(buffer + i, 0, max - i * 8);
996         return max;
997 }
998
999 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1000 {
1001         return (tf->command == ATA_CMD_READ_MULTI) ||
1002                (tf->command == ATA_CMD_WRITE_MULTI) ||
1003                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1004                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1005                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1006 }
1007
1008 static inline int ata_ok(u8 status)
1009 {
1010         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
1011                         == ATA_DRDY);
1012 }
1013
1014 static inline int lba_28_ok(u64 block, u32 n_block)
1015 {
1016         /* check the ending block number */
1017         return ((block + n_block) < ((u64)1 << 28)) && (n_block <= 256);
1018 }
1019
1020 static inline int lba_48_ok(u64 block, u32 n_block)
1021 {
1022         /* check the ending block number */
1023         return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
1024 }
1025
1026 #define sata_pmp_gscr_vendor(gscr)      ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
1027 #define sata_pmp_gscr_devid(gscr)       ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
1028 #define sata_pmp_gscr_rev(gscr)         (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
1029 #define sata_pmp_gscr_ports(gscr)       ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
1030
1031 #endif /* __LINUX_ATA_H__ */