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