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 */
45 ATA_ID_SERNO_OFS
= 10,
46 ATA_ID_FW_REV_OFS
= 23,
48 ATA_ID_OLD_PIO_MODES
= 51,
49 ATA_ID_FIELD_VALID
= 53,
50 ATA_ID_MWDMA_MODES
= 63,
51 ATA_ID_PIO_MODES
= 64,
52 ATA_ID_EIDE_DMA_MIN
= 65,
54 ATA_ID_EIDE_PIO_IORDY
= 68,
55 ATA_ID_UDMA_MODES
= 88,
56 ATA_ID_MAJOR_VER
= 80,
57 ATA_ID_PIO4
= (1 << 1),
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?). */
71 ATA_UDMA_MASK_40C
= ATA_UDMA2
, /* udma0-2 */
75 ATA_PRD_TBL_SZ
= (ATA_MAX_PRD
* ATA_PRD_SZ
),
76 ATA_PRD_EOT
= (1 << 31), /* end-of-table flag */
78 ATA_DMA_TABLE_OFS
= 4,
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),
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 */
100 ATA_ICRC
= (1 << 7), /* interface CRC error */
101 ATA_UNC
= (1 << 6), /* uncorrectable media error */
102 ATA_IDNF
= (1 << 4), /* ID not found */
103 ATA_ABORTED
= (1 << 2), /* command aborted */
105 /* ATA command block registers */
108 ATA_REG_NSECT
= 0x02,
112 ATA_REG_DEVICE
= 0x06,
113 ATA_REG_STATUS
= 0x07,
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
,
122 /* ATA device commands */
123 ATA_CMD_CHK_POWER
= 0xE5, /* check power mode */
124 ATA_CMD_STANDBY
= 0xE2, /* place in standby power mode */
125 ATA_CMD_IDLE
= 0xE3, /* place in idle power mode */
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,
132 ATA_CMD_READ_EXT
= 0x25,
133 ATA_CMD_WRITE
= 0xCA,
134 ATA_CMD_WRITE_EXT
= 0x35,
135 ATA_CMD_WRITE_FUA_EXT
= 0x3D,
136 ATA_CMD_PIO_READ
= 0x20,
137 ATA_CMD_PIO_READ_EXT
= 0x24,
138 ATA_CMD_PIO_WRITE
= 0x30,
139 ATA_CMD_PIO_WRITE_EXT
= 0x34,
140 ATA_CMD_READ_MULTI
= 0xC4,
141 ATA_CMD_READ_MULTI_EXT
= 0x29,
142 ATA_CMD_WRITE_MULTI
= 0xC5,
143 ATA_CMD_WRITE_MULTI_EXT
= 0x39,
144 ATA_CMD_WRITE_MULTI_FUA_EXT
= 0xCE,
145 ATA_CMD_SET_FEATURES
= 0xEF,
146 ATA_CMD_PACKET
= 0xA0,
147 ATA_CMD_VERIFY
= 0x40,
148 ATA_CMD_VERIFY_EXT
= 0x42,
149 ATA_CMD_STANDBYNOW1
= 0xE0,
150 ATA_CMD_IDLEIMMEDIATE
= 0xE1,
151 ATA_CMD_INIT_DEV_PARAMS
= 0x91,
152 ATA_CMD_READ_NATIVE_MAX
= 0xF8,
153 ATA_CMD_READ_NATIVE_MAX_EXT
= 0x27,
155 /* SETFEATURES stuff */
156 SETFEATURES_XFER
= 0x03,
165 XFER_MW_DMA_2
= 0x22,
166 XFER_MW_DMA_1
= 0x21,
167 XFER_MW_DMA_0
= 0x20,
168 XFER_SW_DMA_2
= 0x12,
169 XFER_SW_DMA_1
= 0x11,
170 XFER_SW_DMA_0
= 0x10,
176 XFER_PIO_SLOW
= 0x00,
179 ATAPI_PKT_DMA
= (1 << 0),
180 ATAPI_DMADIR
= (1 << 2), /* ATAPI data dir:
181 0=to device, 1=to host */
188 ATA_CBL_PATA_UNK
= 3,
191 /* SATA Status and Control Registers */
196 SCR_NOTIFICATION
= 4,
199 SERR_DATA_RECOVERED
= (1 << 0), /* recovered data error */
200 SERR_COMM_RECOVERED
= (1 << 1), /* recovered comm failure */
201 SERR_DATA
= (1 << 8), /* unrecovered data error */
202 SERR_PERSISTENT
= (1 << 9), /* persistent data/comm error */
203 SERR_PROTOCOL
= (1 << 10), /* protocol violation */
204 SERR_INTERNAL
= (1 << 11), /* host internal error */
205 SERR_PHYRDY_CHG
= (1 << 16), /* PHY RDY changed */
206 SERR_DEV_XCHG
= (1 << 26), /* device exchanged */
208 /* struct ata_taskfile flags */
209 ATA_TFLAG_LBA48
= (1 << 0), /* enable 48-bit LBA and "HOB" */
210 ATA_TFLAG_ISADDR
= (1 << 1), /* enable r/w to nsect/lba regs */
211 ATA_TFLAG_DEVICE
= (1 << 2), /* enable r/w to device reg */
212 ATA_TFLAG_WRITE
= (1 << 3), /* data dir: host->dev==1 (write) */
213 ATA_TFLAG_LBA
= (1 << 4), /* enable LBA */
214 ATA_TFLAG_FUA
= (1 << 5), /* enable FUA */
215 ATA_TFLAG_POLLING
= (1 << 6), /* set nIEN to 1 and use polling */
218 enum ata_tf_protocols
{
219 /* ATA taskfile protocols */
220 ATA_PROT_UNKNOWN
, /* unknown/invalid */
221 ATA_PROT_NODATA
, /* no data */
222 ATA_PROT_PIO
, /* PIO single sector */
223 ATA_PROT_DMA
, /* DMA */
224 ATA_PROT_ATAPI
, /* packet command, PIO data xfer*/
225 ATA_PROT_ATAPI_NODATA
, /* packet command, no data */
226 ATA_PROT_ATAPI_DMA
, /* packet command with special DMA sauce */
230 ATA_IOC_GET_IO32
= 0x309,
231 ATA_IOC_SET_IO32
= 0x324,
234 /* core structures */
241 struct ata_taskfile
{
242 unsigned long flags
; /* ATA_TFLAG_xxx */
243 u8 protocol
; /* ATA_PROT_xxx */
245 u8 ctl
; /* control reg */
247 u8 hob_feature
; /* additional data */
248 u8 hob_nsect
; /* to support LBA48 */
261 u8 command
; /* IO operation */
264 #define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
265 #define ata_id_is_cfa(id) ((id)[0] == 0x848A)
266 #define ata_id_is_sata(id) ((id)[93] == 0)
267 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
268 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
269 #define ata_id_hpa_enabled(id) ((id)[85] & (1 << 10))
270 #define ata_id_has_fua(id) ((id)[84] & (1 << 6))
271 #define ata_id_has_flush(id) ((id)[83] & (1 << 12))
272 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
273 #define ata_id_has_lba48(id) ((id)[83] & (1 << 10))
274 #define ata_id_has_hpa(id) ((id)[82] & (1 << 10))
275 #define ata_id_has_wcache(id) ((id)[82] & (1 << 5))
276 #define ata_id_has_pm(id) ((id)[82] & (1 << 3))
277 #define ata_id_has_lba(id) ((id)[49] & (1 << 9))
278 #define ata_id_has_dma(id) ((id)[49] & (1 << 8))
279 #define ata_id_removeable(id) ((id)[0] & (1 << 7))
280 #define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
281 #define ata_id_u32(id,n) \
282 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
283 #define ata_id_u64(id,n) \
284 ( ((u64) (id)[(n) + 3] << 48) | \
285 ((u64) (id)[(n) + 2] << 32) | \
286 ((u64) (id)[(n) + 1] << 16) | \
287 ((u64) (id)[(n) + 0]) )
289 #define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
291 static inline unsigned int ata_id_major_version(const u16
*id
)
295 for (mver
= 14; mver
>= 1; mver
--)
296 if (id
[ATA_ID_MAJOR_VER
] & (1 << mver
))
301 static inline int ata_id_current_chs_valid(const u16
*id
)
303 /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
304 has not been issued to the device then the values of
305 id[54] to id[56] are vendor specific. */
306 return (id
[53] & 0x01) && /* Current translation valid */
307 id
[54] && /* cylinders in current translation */
308 id
[55] && /* heads in current translation */
310 id
[56]; /* sectors in current translation */
313 static inline int atapi_cdb_len(const u16
*dev_id
)
315 u16 tmp
= dev_id
[0] & 0x3;
323 static inline int is_atapi_taskfile(const struct ata_taskfile
*tf
)
325 return (tf
->protocol
== ATA_PROT_ATAPI
) ||
326 (tf
->protocol
== ATA_PROT_ATAPI_NODATA
) ||
327 (tf
->protocol
== ATA_PROT_ATAPI_DMA
);
330 static inline int is_multi_taskfile(struct ata_taskfile
*tf
)
332 return (tf
->command
== ATA_CMD_READ_MULTI
) ||
333 (tf
->command
== ATA_CMD_WRITE_MULTI
) ||
334 (tf
->command
== ATA_CMD_READ_MULTI_EXT
) ||
335 (tf
->command
== ATA_CMD_WRITE_MULTI_EXT
) ||
336 (tf
->command
== ATA_CMD_WRITE_MULTI_FUA_EXT
);
339 static inline int ata_ok(u8 status
)
341 return ((status
& (ATA_BUSY
| ATA_DRDY
| ATA_DF
| ATA_DRQ
| ATA_ERR
))
345 static inline int lba_28_ok(u64 block
, u32 n_block
)
347 /* check the ending block number */
348 return ((block
+ n_block
- 1) < ((u64
)1 << 28)) && (n_block
<= 256);
351 static inline int lba_48_ok(u64 block
, u32 n_block
)
353 /* check the ending block number */
354 return ((block
+ n_block
- 1) < ((u64
)1 << 48)) && (n_block
<= 65536);
357 #endif /* __LINUX_ATA_H__ */