libata: more verbose request_irq() failure
[GitHub/LineageOS/android_kernel_samsung_universal7580.git] / include / linux / ata.h
CommitLineData
1da177e4
LT
1
2/*
af36d7f0
JG
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 *
1da177e4
LT
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
38enum {
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,
1da177e4 45 ATA_ID_SERNO_OFS = 10,
11e29e21
AC
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,
1da177e4 50 ATA_ID_MWDMA_MODES = 63,
11e29e21
AC
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,
1da177e4 55 ATA_ID_UDMA_MODES = 88,
11e29e21 56 ATA_ID_MAJOR_VER = 80,
1da177e4
LT
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 */
9be1e979
TH
100 ATA_ICRC = (1 << 7), /* interface CRC error */
101 ATA_UNC = (1 << 6), /* uncorrectable media error */
102 ATA_IDNF = (1 << 4), /* ID not found */
1da177e4
LT
103 ATA_ABORTED = (1 << 2), /* command aborted */
104
105 /* ATA command block registers */
106 ATA_REG_DATA = 0x00,
107 ATA_REG_ERR = 0x01,
108 ATA_REG_NSECT = 0x02,
109 ATA_REG_LBAL = 0x03,
110 ATA_REG_LBAM = 0x04,
111 ATA_REG_LBAH = 0x05,
112 ATA_REG_DEVICE = 0x06,
113 ATA_REG_STATUS = 0x07,
114
115 ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
116 ATA_REG_CMD = ATA_REG_STATUS,
117 ATA_REG_BYTEL = ATA_REG_LBAM,
118 ATA_REG_BYTEH = ATA_REG_LBAH,
119 ATA_REG_DEVSEL = ATA_REG_DEVICE,
120 ATA_REG_IRQ = ATA_REG_NSECT,
121
122 /* ATA device commands */
123 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
972dcafb
DG
124 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
125 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
1da177e4
LT
126 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
127 ATA_CMD_FLUSH = 0xE7,
128 ATA_CMD_FLUSH_EXT = 0xEA,
129 ATA_CMD_ID_ATA = 0xEC,
130 ATA_CMD_ID_ATAPI = 0xA1,
131 ATA_CMD_READ = 0xC8,
132 ATA_CMD_READ_EXT = 0x25,
133 ATA_CMD_WRITE = 0xCA,
134 ATA_CMD_WRITE_EXT = 0x35,
9a3dccc4 135 ATA_CMD_WRITE_FUA_EXT = 0x3D,
88e49034
TH
136 ATA_CMD_FPDMA_READ = 0x60,
137 ATA_CMD_FPDMA_WRITE = 0x61,
1da177e4
LT
138 ATA_CMD_PIO_READ = 0x20,
139 ATA_CMD_PIO_READ_EXT = 0x24,
140 ATA_CMD_PIO_WRITE = 0x30,
141 ATA_CMD_PIO_WRITE_EXT = 0x34,
8cbd6df1
AL
142 ATA_CMD_READ_MULTI = 0xC4,
143 ATA_CMD_READ_MULTI_EXT = 0x29,
144 ATA_CMD_WRITE_MULTI = 0xC5,
145 ATA_CMD_WRITE_MULTI_EXT = 0x39,
9a3dccc4 146 ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
1da177e4
LT
147 ATA_CMD_SET_FEATURES = 0xEF,
148 ATA_CMD_PACKET = 0xA0,
149 ATA_CMD_VERIFY = 0x40,
150 ATA_CMD_VERIFY_EXT = 0x42,
9b847548
JA
151 ATA_CMD_STANDBYNOW1 = 0xE0,
152 ATA_CMD_IDLEIMMEDIATE = 0xE1,
8bf62ece 153 ATA_CMD_INIT_DEV_PARAMS = 0x91,
b6782728
AC
154 ATA_CMD_READ_NATIVE_MAX = 0xF8,
155 ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
88e49034
TH
156 ATA_CMD_READ_LOG_EXT = 0x2f,
157
158 /* READ_LOG_EXT pages */
159 ATA_LOG_SATA_NCQ = 0x10,
1da177e4
LT
160
161 /* SETFEATURES stuff */
162 SETFEATURES_XFER = 0x03,
163 XFER_UDMA_7 = 0x47,
164 XFER_UDMA_6 = 0x46,
165 XFER_UDMA_5 = 0x45,
166 XFER_UDMA_4 = 0x44,
167 XFER_UDMA_3 = 0x43,
168 XFER_UDMA_2 = 0x42,
169 XFER_UDMA_1 = 0x41,
170 XFER_UDMA_0 = 0x40,
171 XFER_MW_DMA_2 = 0x22,
172 XFER_MW_DMA_1 = 0x21,
173 XFER_MW_DMA_0 = 0x20,
b4b52db7
AC
174 XFER_SW_DMA_2 = 0x12,
175 XFER_SW_DMA_1 = 0x11,
176 XFER_SW_DMA_0 = 0x10,
1da177e4
LT
177 XFER_PIO_4 = 0x0C,
178 XFER_PIO_3 = 0x0B,
179 XFER_PIO_2 = 0x0A,
180 XFER_PIO_1 = 0x09,
181 XFER_PIO_0 = 0x08,
1da177e4
LT
182 XFER_PIO_SLOW = 0x00,
183
184 /* ATAPI stuff */
185 ATAPI_PKT_DMA = (1 << 0),
186 ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
187 0=to device, 1=to host */
188 ATAPI_CDB_LEN = 16,
189
190 /* cable types */
191 ATA_CBL_NONE = 0,
192 ATA_CBL_PATA40 = 1,
193 ATA_CBL_PATA80 = 2,
194 ATA_CBL_PATA_UNK = 3,
195 ATA_CBL_SATA = 4,
196
197 /* SATA Status and Control Registers */
198 SCR_STATUS = 0,
199 SCR_ERROR = 1,
200 SCR_CONTROL = 2,
201 SCR_ACTIVE = 3,
202 SCR_NOTIFICATION = 4,
203
9be1e979
TH
204 /* SError bits */
205 SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
206 SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
207 SERR_DATA = (1 << 8), /* unrecovered data error */
208 SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
209 SERR_PROTOCOL = (1 << 10), /* protocol violation */
210 SERR_INTERNAL = (1 << 11), /* host internal error */
211 SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
212 SERR_DEV_XCHG = (1 << 26), /* device exchanged */
213
1da177e4
LT
214 /* struct ata_taskfile flags */
215 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
216 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
217 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
218 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
8bf62ece 219 ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
9a3dccc4 220 ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
ea9b395f 221 ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
1da177e4
LT
222};
223
224enum ata_tf_protocols {
225 /* ATA taskfile protocols */
226 ATA_PROT_UNKNOWN, /* unknown/invalid */
227 ATA_PROT_NODATA, /* no data */
228 ATA_PROT_PIO, /* PIO single sector */
1da177e4 229 ATA_PROT_DMA, /* DMA */
88e49034 230 ATA_PROT_NCQ, /* NCQ */
1da177e4
LT
231 ATA_PROT_ATAPI, /* packet command, PIO data xfer*/
232 ATA_PROT_ATAPI_NODATA, /* packet command, no data */
233 ATA_PROT_ATAPI_DMA, /* packet command with special DMA sauce */
234};
235
236enum ata_ioctls {
237 ATA_IOC_GET_IO32 = 0x309,
238 ATA_IOC_SET_IO32 = 0x324,
239};
240
241/* core structures */
242
243struct ata_prd {
244 u32 addr;
245 u32 flags_len;
246};
247
248struct ata_taskfile {
249 unsigned long flags; /* ATA_TFLAG_xxx */
250 u8 protocol; /* ATA_PROT_xxx */
251
252 u8 ctl; /* control reg */
253
254 u8 hob_feature; /* additional data */
255 u8 hob_nsect; /* to support LBA48 */
256 u8 hob_lbal;
257 u8 hob_lbam;
258 u8 hob_lbah;
259
260 u8 feature;
261 u8 nsect;
262 u8 lbal;
263 u8 lbam;
264 u8 lbah;
265
266 u8 device;
267
268 u8 command; /* IO operation */
269};
270
271#define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
b6782728 272#define ata_id_is_cfa(id) ((id)[0] == 0x848A)
6f2f3812 273#define ata_id_is_sata(id) ((id)[93] == 0)
1da177e4
LT
274#define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
275#define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
b6782728 276#define ata_id_hpa_enabled(id) ((id)[85] & (1 << 10))
9a3dccc4
TH
277#define ata_id_has_fua(id) ((id)[84] & (1 << 6))
278#define ata_id_has_flush(id) ((id)[83] & (1 << 12))
1da177e4
LT
279#define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
280#define ata_id_has_lba48(id) ((id)[83] & (1 << 10))
b6782728 281#define ata_id_has_hpa(id) ((id)[82] & (1 << 10))
1da177e4
LT
282#define ata_id_has_wcache(id) ((id)[82] & (1 << 5))
283#define ata_id_has_pm(id) ((id)[82] & (1 << 3))
284#define ata_id_has_lba(id) ((id)[49] & (1 << 9))
285#define ata_id_has_dma(id) ((id)[49] & (1 << 8))
88e49034
TH
286#define ata_id_has_ncq(id) ((id)[76] & (1 << 8))
287#define ata_id_queue_depth(id) (((id)[75] & 0x1f) + 1)
1da177e4 288#define ata_id_removeable(id) ((id)[0] & (1 << 7))
b6782728 289#define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
1da177e4
LT
290#define ata_id_u32(id,n) \
291 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
292#define ata_id_u64(id,n) \
293 ( ((u64) (id)[(n) + 3] << 48) | \
294 ((u64) (id)[(n) + 2] << 32) | \
295 ((u64) (id)[(n) + 1] << 16) | \
296 ((u64) (id)[(n) + 0]) )
297
312f7da2
AL
298#define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
299
3d2ca910
TH
300static inline unsigned int ata_id_major_version(const u16 *id)
301{
302 unsigned int mver;
303
304 for (mver = 14; mver >= 1; mver--)
305 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
306 break;
307 return mver;
308}
309
057ace5e 310static inline int ata_id_current_chs_valid(const u16 *id)
8bf62ece
AL
311{
312 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
313 has not been issued to the device then the values of
314 id[54] to id[56] are vendor specific. */
315 return (id[53] & 0x01) && /* Current translation valid */
316 id[54] && /* cylinders in current translation */
317 id[55] && /* heads in current translation */
318 id[55] <= 16 &&
319 id[56]; /* sectors in current translation */
320}
321
057ace5e 322static inline int atapi_cdb_len(const u16 *dev_id)
1da177e4
LT
323{
324 u16 tmp = dev_id[0] & 0x3;
325 switch (tmp) {
326 case 0: return 12;
327 case 1: return 16;
328 default: return -1;
329 }
330}
331
057ace5e 332static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
1da177e4
LT
333{
334 return (tf->protocol == ATA_PROT_ATAPI) ||
335 (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
336 (tf->protocol == ATA_PROT_ATAPI_DMA);
337}
338
07f6f7d0
AL
339static inline int is_multi_taskfile(struct ata_taskfile *tf)
340{
341 return (tf->command == ATA_CMD_READ_MULTI) ||
342 (tf->command == ATA_CMD_WRITE_MULTI) ||
343 (tf->command == ATA_CMD_READ_MULTI_EXT) ||
c2956a3b
AL
344 (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
345 (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
07f6f7d0
AL
346}
347
1da177e4
LT
348static inline int ata_ok(u8 status)
349{
350 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
351 == ATA_DRDY);
352}
353
c6a33e24
AL
354static inline int lba_28_ok(u64 block, u32 n_block)
355{
356 /* check the ending block number */
357 return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
358}
359
360static inline int lba_48_ok(u64 block, u32 n_block)
361{
362 /* check the ending block number */
363 return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
364}
365
1da177e4 366#endif /* __LINUX_ATA_H__ */