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 */
46 ATA_ID_FW_REV_OFS = 23,
47 ATA_ID_SERNO_OFS = 10,
48 ATA_ID_MAJOR_VER = 80,
49 ATA_ID_PIO_MODES = 64,
50 ATA_ID_MWDMA_MODES = 63,
51 ATA_ID_UDMA_MODES = 88,
52 ATA_ID_PIO4 = (1 << 1),
57 ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
58 ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
59 ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
60 ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
61 ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
62 ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
63 ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
64 /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
66 ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
70 ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
71 ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
73 ATA_DMA_TABLE_OFS = 4,
76 ATA_DMA_WR = (1 << 3),
77 ATA_DMA_START = (1 << 0),
78 ATA_DMA_INTR = (1 << 2),
79 ATA_DMA_ERR = (1 << 1),
80 ATA_DMA_ACTIVE = (1 << 0),
82 /* bits in ATA command block registers */
83 ATA_HOB = (1 << 7), /* LBA48 selector */
84 ATA_NIEN = (1 << 1), /* disable-irq flag */
85 ATA_LBA = (1 << 6), /* LBA28 selector */
86 ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
87 ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
88 ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
89 ATA_BUSY = (1 << 7), /* BSY status bit */
90 ATA_DRDY = (1 << 6), /* device ready */
91 ATA_DF = (1 << 5), /* device fault */
92 ATA_DRQ = (1 << 3), /* data request i/o */
93 ATA_ERR = (1 << 0), /* have an error */
94 ATA_SRST = (1 << 2), /* software reset */
95 ATA_ABORTED = (1 << 2), /* command aborted */
97 /* ATA command block registers */
100 ATA_REG_NSECT = 0x02,
104 ATA_REG_DEVICE = 0x06,
105 ATA_REG_STATUS = 0x07,
107 ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
108 ATA_REG_CMD = ATA_REG_STATUS,
109 ATA_REG_BYTEL = ATA_REG_LBAM,
110 ATA_REG_BYTEH = ATA_REG_LBAH,
111 ATA_REG_DEVSEL = ATA_REG_DEVICE,
112 ATA_REG_IRQ = ATA_REG_NSECT,
114 /* ATA device commands */
115 ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
116 ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
117 ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
118 ATA_CMD_EDD = 0x90, /* execute device diagnostic */
119 ATA_CMD_FLUSH = 0xE7,
120 ATA_CMD_FLUSH_EXT = 0xEA,
121 ATA_CMD_ID_ATA = 0xEC,
122 ATA_CMD_ID_ATAPI = 0xA1,
124 ATA_CMD_READ_EXT = 0x25,
125 ATA_CMD_WRITE = 0xCA,
126 ATA_CMD_WRITE_EXT = 0x35,
127 ATA_CMD_PIO_READ = 0x20,
128 ATA_CMD_PIO_READ_EXT = 0x24,
129 ATA_CMD_PIO_WRITE = 0x30,
130 ATA_CMD_PIO_WRITE_EXT = 0x34,
131 ATA_CMD_SET_FEATURES = 0xEF,
132 ATA_CMD_PACKET = 0xA0,
133 ATA_CMD_VERIFY = 0x40,
134 ATA_CMD_VERIFY_EXT = 0x42,
136 /* SETFEATURES stuff */
137 SETFEATURES_XFER = 0x03,
146 XFER_MW_DMA_2 = 0x22,
147 XFER_MW_DMA_1 = 0x21,
148 XFER_MW_DMA_0 = 0x20,
154 XFER_SW_DMA_2 = 0x12,
155 XFER_SW_DMA_1 = 0x11,
156 XFER_SW_DMA_0 = 0x10,
157 XFER_PIO_SLOW = 0x00,
160 ATAPI_PKT_DMA = (1 << 0),
161 ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
162 0=to device, 1=to host */
169 ATA_CBL_PATA_UNK = 3,
172 /* SATA Status and Control Registers */
177 SCR_NOTIFICATION = 4,
179 /* struct ata_taskfile flags */
180 ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
181 ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
182 ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
183 ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
184 ATA_TFLAG_POLLING = (1 << 4), /* set nIEN to 1 and use polling */
187 enum ata_tf_protocols {
188 /* ATA taskfile protocols */
189 ATA_PROT_UNKNOWN, /* unknown/invalid */
190 ATA_PROT_NODATA, /* no data */
191 ATA_PROT_PIO, /* PIO single sector */
192 ATA_PROT_PIO_MULT, /* PIO multiple sector */
193 ATA_PROT_DMA, /* DMA */
194 ATA_PROT_ATAPI, /* packet command, PIO data xfer*/
195 ATA_PROT_ATAPI_NODATA, /* packet command, no data */
196 ATA_PROT_ATAPI_DMA, /* packet command with special DMA sauce */
200 ATA_IOC_GET_IO32 = 0x309,
201 ATA_IOC_SET_IO32 = 0x324,
204 /* core structures */
211 struct ata_taskfile {
212 unsigned long flags; /* ATA_TFLAG_xxx */
213 u8 protocol; /* ATA_PROT_xxx */
215 u8 ctl; /* control reg */
217 u8 hob_feature; /* additional data */
218 u8 hob_nsect; /* to support LBA48 */
231 u8 command; /* IO operation */
234 #define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
235 #define ata_id_is_sata(id) ((id)[93] == 0)
236 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
237 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
238 #define ata_id_has_flush(id) ((id)[83] & (1 << 12))
239 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
240 #define ata_id_has_lba48(id) ((id)[83] & (1 << 10))
241 #define ata_id_has_wcache(id) ((id)[82] & (1 << 5))
242 #define ata_id_has_pm(id) ((id)[82] & (1 << 3))
243 #define ata_id_has_lba(id) ((id)[49] & (1 << 9))
244 #define ata_id_has_dma(id) ((id)[49] & (1 << 8))
245 #define ata_id_removeable(id) ((id)[0] & (1 << 7))
246 #define ata_id_u32(id,n) \
247 (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
248 #define ata_id_u64(id,n) \
249 ( ((u64) (id)[(n) + 3] << 48) | \
250 ((u64) (id)[(n) + 2] << 32) | \
251 ((u64) (id)[(n) + 1] << 16) | \
252 ((u64) (id)[(n) + 0]) )
254 #define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
256 static inline int atapi_cdb_len(u16 *dev_id)
258 u16 tmp = dev_id[0] & 0x3;
266 static inline int is_atapi_taskfile(struct ata_taskfile *tf)
268 return (tf->protocol == ATA_PROT_ATAPI) ||
269 (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
270 (tf->protocol == ATA_PROT_ATAPI_DMA);
273 static inline int ata_ok(u8 status)
275 return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
279 #endif /* __LINUX_ATA_H__ */