3 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
4 * Copyright 2003-2004 Jeff Garzik
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)
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.
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.
22 * libata documentation is available via 'make {ps|pdf}docs',
23 * as Documentation/DocBook/libata.*
25 * Hardware documentation available from http://www.t13.org/
29 #ifndef __LINUX_ATA_H__
30 #define __LINUX_ATA_H__
32 #include <linux/types.h>
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
39 /* various global constants */
40 ATA_MAX_DEVICES
= 2, /* per bus/port */
41 ATA_MAX_PRD
= 256, /* we could make these 256/256 */
43 ATA_MAX_SECTORS
= 256,
44 ATA_MAX_SECTORS_LBA48
= 65535,/* TODO: 65536? */
47 ATA_ID_SERNO_OFS
= 10,
48 ATA_ID_FW_REV_OFS
= 23,
50 ATA_ID_OLD_PIO_MODES
= 51,
51 ATA_ID_FIELD_VALID
= 53,
52 ATA_ID_MWDMA_MODES
= 63,
53 ATA_ID_PIO_MODES
= 64,
54 ATA_ID_EIDE_DMA_MIN
= 65,
56 ATA_ID_EIDE_PIO_IORDY
= 68,
57 ATA_ID_UDMA_MODES
= 88,
58 ATA_ID_MAJOR_VER
= 80,
59 ATA_ID_PIO4
= (1 << 1),
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?). */
73 ATA_UDMA_MASK_40C
= ATA_UDMA2
, /* udma0-2 */
77 ATA_PRD_TBL_SZ
= (ATA_MAX_PRD
* ATA_PRD_SZ
),
78 ATA_PRD_EOT
= (1 << 31), /* end-of-table flag */
80 ATA_DMA_TABLE_OFS
= 4,
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),
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 */
102 ATA_ICRC
= (1 << 7), /* interface CRC error */
103 ATA_UNC
= (1 << 6), /* uncorrectable media error */
104 ATA_IDNF
= (1 << 4), /* ID not found */
105 ATA_ABORTED
= (1 << 2), /* command aborted */
107 /* ATA command block registers */
110 ATA_REG_NSECT
= 0x02,
114 ATA_REG_DEVICE
= 0x06,
115 ATA_REG_STATUS
= 0x07,
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
,
124 /* ATA device commands */
125 ATA_CMD_CHK_POWER
= 0xE5, /* check power mode */
126 ATA_CMD_STANDBY
= 0xE2, /* place in standby power mode */
127 ATA_CMD_IDLE
= 0xE3, /* place in idle power mode */
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,
134 ATA_CMD_READ_EXT
= 0x25,
135 ATA_CMD_WRITE
= 0xCA,
136 ATA_CMD_WRITE_EXT
= 0x35,
137 ATA_CMD_WRITE_FUA_EXT
= 0x3D,
138 ATA_CMD_FPDMA_READ
= 0x60,
139 ATA_CMD_FPDMA_WRITE
= 0x61,
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,
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,
148 ATA_CMD_WRITE_MULTI_FUA_EXT
= 0xCE,
149 ATA_CMD_SET_FEATURES
= 0xEF,
150 ATA_CMD_PACKET
= 0xA0,
151 ATA_CMD_VERIFY
= 0x40,
152 ATA_CMD_VERIFY_EXT
= 0x42,
153 ATA_CMD_STANDBYNOW1
= 0xE0,
154 ATA_CMD_IDLEIMMEDIATE
= 0xE1,
155 ATA_CMD_INIT_DEV_PARAMS
= 0x91,
156 ATA_CMD_READ_NATIVE_MAX
= 0xF8,
157 ATA_CMD_READ_NATIVE_MAX_EXT
= 0x27,
158 ATA_CMD_READ_LOG_EXT
= 0x2f,
160 /* READ_LOG_EXT pages */
161 ATA_LOG_SATA_NCQ
= 0x10,
163 /* SETFEATURES stuff */
164 SETFEATURES_XFER
= 0x03,
173 XFER_MW_DMA_4
= 0x24, /* CFA only */
174 XFER_MW_DMA_3
= 0x23, /* CFA only */
175 XFER_MW_DMA_2
= 0x22,
176 XFER_MW_DMA_1
= 0x21,
177 XFER_MW_DMA_0
= 0x20,
178 XFER_SW_DMA_2
= 0x12,
179 XFER_SW_DMA_1
= 0x11,
180 XFER_SW_DMA_0
= 0x10,
181 XFER_PIO_6
= 0x0E, /* CFA only */
182 XFER_PIO_5
= 0x0D, /* CFA only */
188 XFER_PIO_SLOW
= 0x00,
190 SETFEATURES_WC_ON
= 0x02, /* Enable write cache */
191 SETFEATURES_WC_OFF
= 0x82, /* Disable write cache */
194 ATAPI_PKT_DMA
= (1 << 0),
195 ATAPI_DMADIR
= (1 << 2), /* ATAPI data dir:
196 0=to device, 1=to host */
203 ATA_CBL_PATA_UNK
= 3,
206 /* SATA Status and Control Registers */
211 SCR_NOTIFICATION
= 4,
214 SERR_DATA_RECOVERED
= (1 << 0), /* recovered data error */
215 SERR_COMM_RECOVERED
= (1 << 1), /* recovered comm failure */
216 SERR_DATA
= (1 << 8), /* unrecovered data error */
217 SERR_PERSISTENT
= (1 << 9), /* persistent data/comm error */
218 SERR_PROTOCOL
= (1 << 10), /* protocol violation */
219 SERR_INTERNAL
= (1 << 11), /* host internal error */
220 SERR_PHYRDY_CHG
= (1 << 16), /* PHY RDY changed */
221 SERR_DEV_XCHG
= (1 << 26), /* device exchanged */
223 /* struct ata_taskfile flags */
224 ATA_TFLAG_LBA48
= (1 << 0), /* enable 48-bit LBA and "HOB" */
225 ATA_TFLAG_ISADDR
= (1 << 1), /* enable r/w to nsect/lba regs */
226 ATA_TFLAG_DEVICE
= (1 << 2), /* enable r/w to device reg */
227 ATA_TFLAG_WRITE
= (1 << 3), /* data dir: host->dev==1 (write) */
228 ATA_TFLAG_LBA
= (1 << 4), /* enable LBA */
229 ATA_TFLAG_FUA
= (1 << 5), /* enable FUA */
230 ATA_TFLAG_POLLING
= (1 << 6), /* set nIEN to 1 and use polling */
233 enum ata_tf_protocols
{
234 /* ATA taskfile protocols */
235 ATA_PROT_UNKNOWN
, /* unknown/invalid */
236 ATA_PROT_NODATA
, /* no data */
237 ATA_PROT_PIO
, /* PIO single sector */
238 ATA_PROT_DMA
, /* DMA */
239 ATA_PROT_NCQ
, /* NCQ */
240 ATA_PROT_ATAPI
, /* packet command, PIO data xfer*/
241 ATA_PROT_ATAPI_NODATA
, /* packet command, no data */
242 ATA_PROT_ATAPI_DMA
, /* packet command with special DMA sauce */
246 ATA_IOC_GET_IO32
= 0x309,
247 ATA_IOC_SET_IO32
= 0x324,
250 /* core structures */
257 struct ata_taskfile
{
258 unsigned long flags
; /* ATA_TFLAG_xxx */
259 u8 protocol
; /* ATA_PROT_xxx */
261 u8 ctl
; /* control reg */
263 u8 hob_feature
; /* additional data */
264 u8 hob_nsect
; /* to support LBA48 */
277 u8 command
; /* IO operation */
280 #define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
281 #define ata_id_is_sata(id) ((id)[93] == 0)
282 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
283 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
284 #define ata_id_hpa_enabled(id) ((id)[85] & (1 << 10))
285 #define ata_id_has_fua(id) ((id)[84] & (1 << 6))
286 #define ata_id_has_flush(id) ((id)[83] & (1 << 12))
287 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
288 #define ata_id_has_lba48(id) ((id)[83] & (1 << 10))
289 #define ata_id_has_hpa(id) ((id)[82] & (1 << 10))
290 #define ata_id_has_wcache(id) ((id)[82] & (1 << 5))
291 #define ata_id_has_pm(id) ((id)[82] & (1 << 3))
292 #define ata_id_has_lba(id) ((id)[49] & (1 << 9))
293 #define ata_id_has_dma(id) ((id)[49] & (1 << 8))
294 #define ata_id_has_ncq(id) ((id)[76] & (1 << 8))
295 #define ata_id_queue_depth(id) (((id)[75] & 0x1f) + 1)
296 #define ata_id_removeable(id) ((id)[0] & (1 << 7))
297 #define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
298 #define ata_id_u32(id,n) \
299 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
300 #define ata_id_u64(id,n) \
301 ( ((u64) (id)[(n) + 3] << 48) | \
302 ((u64) (id)[(n) + 2] << 32) | \
303 ((u64) (id)[(n) + 1] << 16) | \
304 ((u64) (id)[(n) + 0]) )
306 #define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
308 static inline unsigned int ata_id_major_version(const u16
*id
)
312 if (id
[ATA_ID_MAJOR_VER
] == 0xFFFF)
315 for (mver
= 14; mver
>= 1; mver
--)
316 if (id
[ATA_ID_MAJOR_VER
] & (1 << mver
))
321 static inline int ata_id_current_chs_valid(const u16
*id
)
323 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
324 has not been issued to the device then the values of
325 id[54] to id[56] are vendor specific. */
326 return (id
[53] & 0x01) && /* Current translation valid */
327 id
[54] && /* cylinders in current translation */
328 id
[55] && /* heads in current translation */
330 id
[56]; /* sectors in current translation */
333 static inline int ata_id_is_cfa(const u16
*id
)
336 if (v
== 0x848A) /* Standard CF */
338 /* Could be CF hiding as standard ATA */
339 if (ata_id_major_version(id
) >= 3 && id
[82] != 0xFFFF &&
340 (id
[82] & ( 1 << 2)))
345 static inline int atapi_cdb_len(const u16
*dev_id
)
347 u16 tmp
= dev_id
[0] & 0x3;
355 static inline int is_atapi_taskfile(const struct ata_taskfile
*tf
)
357 return (tf
->protocol
== ATA_PROT_ATAPI
) ||
358 (tf
->protocol
== ATA_PROT_ATAPI_NODATA
) ||
359 (tf
->protocol
== ATA_PROT_ATAPI_DMA
);
362 static inline int is_multi_taskfile(struct ata_taskfile
*tf
)
364 return (tf
->command
== ATA_CMD_READ_MULTI
) ||
365 (tf
->command
== ATA_CMD_WRITE_MULTI
) ||
366 (tf
->command
== ATA_CMD_READ_MULTI_EXT
) ||
367 (tf
->command
== ATA_CMD_WRITE_MULTI_EXT
) ||
368 (tf
->command
== ATA_CMD_WRITE_MULTI_FUA_EXT
);
371 static inline int ata_ok(u8 status
)
373 return ((status
& (ATA_BUSY
| ATA_DRDY
| ATA_DF
| ATA_DRQ
| ATA_ERR
))
377 static inline int lba_28_ok(u64 block
, u32 n_block
)
379 /* check the ending block number */
380 return ((block
+ n_block
- 1) < ((u64
)1 << 28)) && (n_block
<= 256);
383 static inline int lba_48_ok(u64 block
, u32 n_block
)
385 /* check the ending block number */
386 return ((block
+ n_block
- 1) < ((u64
)1 << 48)) && (n_block
<= 65536);
389 #endif /* __LINUX_ATA_H__ */