Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Jeff Garzik | af36d7f | 2005-08-28 20:18:39 -0400 | [diff] [blame] | 2 | * Copyright 2003-2005 Red Hat, Inc. All rights reserved. |
| 3 | * Copyright 2003-2005 Jeff Garzik |
| 4 | * |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2, or (at your option) |
| 9 | * any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; see the file COPYING. If not, write to |
| 18 | * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
| 19 | * |
| 20 | * |
| 21 | * libata documentation is available via 'make {ps|pdf}docs', |
| 22 | * as Documentation/DocBook/libata.* |
| 23 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | */ |
| 25 | |
| 26 | #ifndef __LINUX_LIBATA_H__ |
| 27 | #define __LINUX_LIBATA_H__ |
| 28 | |
| 29 | #include <linux/delay.h> |
| 30 | #include <linux/interrupt.h> |
| 31 | #include <linux/pci.h> |
Andrew Morton | 1c72d8d | 2005-11-10 16:21:38 -0800 | [diff] [blame] | 32 | #include <linux/dma-mapping.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | #include <asm/io.h> |
| 34 | #include <linux/ata.h> |
| 35 | #include <linux/workqueue.h> |
Jeff Garzik | 35bb94b | 2006-04-11 13:12:34 -0400 | [diff] [blame] | 36 | #include <scsi/scsi_host.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | |
| 38 | /* |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 39 | * compile-time options: to be removed as soon as all the drivers are |
| 40 | * converted to the new debugging mechanism |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | */ |
| 42 | #undef ATA_DEBUG /* debugging output */ |
| 43 | #undef ATA_VERBOSE_DEBUG /* yet more debugging output */ |
| 44 | #undef ATA_IRQ_TRAP /* define to ack screaming irqs */ |
| 45 | #undef ATA_NDEBUG /* define to disable quick runtime checks */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | #undef ATA_ENABLE_PATA /* define to enable PATA support in some |
| 47 | * low-level drivers */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | |
| 49 | |
| 50 | /* note: prints function name for you */ |
| 51 | #ifdef ATA_DEBUG |
| 52 | #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
| 53 | #ifdef ATA_VERBOSE_DEBUG |
| 54 | #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
| 55 | #else |
| 56 | #define VPRINTK(fmt, args...) |
| 57 | #endif /* ATA_VERBOSE_DEBUG */ |
| 58 | #else |
| 59 | #define DPRINTK(fmt, args...) |
| 60 | #define VPRINTK(fmt, args...) |
| 61 | #endif /* ATA_DEBUG */ |
| 62 | |
Jeff Garzik | 2c13b7c | 2005-11-14 14:14:16 -0500 | [diff] [blame] | 63 | #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
| 64 | |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 65 | /* NEW: debug levels */ |
| 66 | #define HAVE_LIBATA_MSG 1 |
| 67 | |
| 68 | enum { |
| 69 | ATA_MSG_DRV = 0x0001, |
| 70 | ATA_MSG_INFO = 0x0002, |
| 71 | ATA_MSG_PROBE = 0x0004, |
| 72 | ATA_MSG_WARN = 0x0008, |
| 73 | ATA_MSG_MALLOC = 0x0010, |
| 74 | ATA_MSG_CTL = 0x0020, |
| 75 | ATA_MSG_INTR = 0x0040, |
| 76 | ATA_MSG_ERR = 0x0080, |
| 77 | }; |
| 78 | |
| 79 | #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV) |
| 80 | #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO) |
| 81 | #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE) |
| 82 | #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN) |
| 83 | #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC) |
| 84 | #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL) |
| 85 | #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR) |
| 86 | #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR) |
| 87 | |
| 88 | static inline u32 ata_msg_init(int dval, int default_msg_enable_bits) |
| 89 | { |
| 90 | if (dval < 0 || dval >= (sizeof(u32) * 8)) |
| 91 | return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */ |
| 92 | if (!dval) |
| 93 | return 0; |
| 94 | return (1 << dval) - 1; |
| 95 | } |
| 96 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 97 | /* defines only for the constants which don't work well as enums */ |
| 98 | #define ATA_TAG_POISON 0xfafbfcfdU |
| 99 | |
| 100 | /* move to PCI layer? */ |
| 101 | static inline struct device *pci_dev_to_dev(struct pci_dev *pdev) |
| 102 | { |
| 103 | return &pdev->dev; |
| 104 | } |
| 105 | |
| 106 | enum { |
| 107 | /* various global constants */ |
| 108 | LIBATA_MAX_PRD = ATA_MAX_PRD / 2, |
| 109 | ATA_MAX_PORTS = 8, |
| 110 | ATA_DEF_QUEUE = 1, |
Tejun Heo | 2ab7db1 | 2006-05-15 20:58:02 +0900 | [diff] [blame] | 111 | /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */ |
Tejun Heo | a6e6ce8 | 2006-05-15 21:03:48 +0900 | [diff] [blame] | 112 | ATA_MAX_QUEUE = 32, |
Tejun Heo | 2ab7db1 | 2006-05-15 20:58:02 +0900 | [diff] [blame] | 113 | ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | ATA_MAX_SECTORS = 200, /* FIXME */ |
Tejun Heo | 200d5a76 | 2006-02-15 16:24:49 +0900 | [diff] [blame] | 115 | ATA_MAX_SECTORS_LBA48 = 65535, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | ATA_MAX_BUS = 2, |
| 117 | ATA_DEF_BUSY_WAIT = 10000, |
| 118 | ATA_SHORT_PAUSE = (HZ >> 6) + 1, |
| 119 | |
| 120 | ATA_SHT_EMULATED = 1, |
| 121 | ATA_SHT_CMD_PER_LUN = 1, |
| 122 | ATA_SHT_THIS_ID = -1, |
Jeff Garzik | cf48293 | 2005-10-22 00:19:33 -0400 | [diff] [blame] | 123 | ATA_SHT_USE_CLUSTERING = 1, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | |
| 125 | /* struct ata_device stuff */ |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 126 | ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */ |
| 127 | ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */ |
Jeff Garzik | 029f546 | 2006-04-02 10:30:40 -0400 | [diff] [blame] | 128 | ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */ |
Tejun Heo | 88e4903 | 2006-05-15 21:03:38 +0900 | [diff] [blame] | 129 | ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */ |
Tejun Heo | ea1dd4e | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 130 | ATA_DFLAG_CFG_MASK = (1 << 8) - 1, |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 131 | |
| 132 | ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */ |
Tejun Heo | 72fa4b7 | 2006-05-31 18:27:32 +0900 | [diff] [blame] | 133 | ATA_DFLAG_INIT_MASK = (1 << 16) - 1, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | |
Tejun Heo | abdda73 | 2006-05-31 18:27:29 +0900 | [diff] [blame] | 135 | ATA_DFLAG_DETACH = (1 << 16), |
| 136 | ATA_DFLAG_DETACHED = (1 << 17), |
| 137 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | ATA_DEV_UNKNOWN = 0, /* unknown device */ |
| 139 | ATA_DEV_ATA = 1, /* ATA device */ |
| 140 | ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ |
| 141 | ATA_DEV_ATAPI = 3, /* ATAPI device */ |
| 142 | ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ |
| 143 | ATA_DEV_NONE = 5, /* no device */ |
| 144 | |
| 145 | /* struct ata_port flags */ |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 146 | ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | /* (doesn't imply presence) */ |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 148 | ATA_FLAG_SATA = (1 << 1), |
| 149 | ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */ |
| 150 | ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */ |
| 151 | ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */ |
| 152 | ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */ |
| 153 | ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */ |
| 154 | ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */ |
| 155 | ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */ |
Tejun Heo | 7395acb | 2006-05-31 18:27:25 +0900 | [diff] [blame] | 156 | ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD |
| 157 | * doesn't handle PIO interrupts */ |
| 158 | ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */ |
Tejun Heo | abdda73 | 2006-05-31 18:27:29 +0900 | [diff] [blame] | 159 | ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */ |
| 160 | ATA_FLAG_SKIP_D2H_BSY = (1 << 12), /* can't wait for the first D2H |
| 161 | * Register FIS clearing BSY */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
Tejun Heo | 7395acb | 2006-05-31 18:27:25 +0900 | [diff] [blame] | 163 | ATA_FLAG_DEBUGMSG = (1 << 13), |
| 164 | ATA_FLAG_FLUSH_PORT_TASK = (1 << 14), /* flush port task */ |
Jens Axboe | 9b84754 | 2006-01-06 09:28:07 +0100 | [diff] [blame] | 165 | |
Tejun Heo | 7395acb | 2006-05-31 18:27:25 +0900 | [diff] [blame] | 166 | ATA_FLAG_EH_PENDING = (1 << 15), /* EH pending */ |
Tejun Heo | c6cf9e9 | 2006-05-31 18:27:27 +0900 | [diff] [blame] | 167 | ATA_FLAG_EH_IN_PROGRESS = (1 << 16), /* EH in progress */ |
Tejun Heo | 9ec957f | 2006-05-15 20:57:58 +0900 | [diff] [blame] | 168 | ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */ |
Tejun Heo | 9be1e97 | 2006-05-15 20:58:17 +0900 | [diff] [blame] | 169 | ATA_FLAG_RECOVERED = (1 << 18), /* recovery action performed */ |
Tejun Heo | abdda73 | 2006-05-31 18:27:29 +0900 | [diff] [blame] | 170 | ATA_FLAG_LOADING = (1 << 19), /* boot/loading probe */ |
| 171 | ATA_FLAG_UNLOADING = (1 << 20), /* module is unloading */ |
| 172 | ATA_FLAG_SCSI_HOTPLUG = (1 << 21), /* SCSI hotplug scheduled */ |
Tejun Heo | 9ec957f | 2006-05-15 20:57:58 +0900 | [diff] [blame] | 173 | |
| 174 | ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */ |
| 175 | ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */ |
Alan Cox | 8d238e0 | 2006-01-17 20:50:31 +0000 | [diff] [blame] | 176 | |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 177 | /* bits 24:31 of ap->flags are reserved for LLDD specific flags */ |
Tejun Heo | dde4458 | 2006-02-02 00:56:10 +0900 | [diff] [blame] | 178 | |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 179 | /* struct ata_queued_cmd flags */ |
| 180 | ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */ |
| 181 | ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */ |
| 182 | ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 183 | ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE, |
Tejun Heo | 2719736 | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 184 | ATA_QCFLAG_IO = (1 << 3), /* standard IO command */ |
Tejun Heo | e61e067 | 2006-05-15 20:57:40 +0900 | [diff] [blame] | 185 | ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */ |
| 186 | |
Tejun Heo | 9ec957f | 2006-05-15 20:57:58 +0900 | [diff] [blame] | 187 | ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */ |
| 188 | ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */ |
| 189 | ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 190 | |
Alan Cox | 4e5ec5d | 2006-03-27 18:42:40 +0100 | [diff] [blame] | 191 | /* host set flags */ |
| 192 | ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */ |
| 193 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 194 | /* various lengths of time */ |
Alan Cox | 8d238e0 | 2006-01-17 20:50:31 +0000 | [diff] [blame] | 195 | ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */ |
| 196 | ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */ |
Tejun Heo | a2a7a66 | 2005-12-13 14:48:31 +0900 | [diff] [blame] | 197 | ATA_TMOUT_INTERNAL = 30 * HZ, |
| 198 | ATA_TMOUT_INTERNAL_QUICK = 5 * HZ, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | |
| 200 | /* ATA bus states */ |
| 201 | BUS_UNKNOWN = 0, |
| 202 | BUS_DMA = 1, |
| 203 | BUS_IDLE = 2, |
| 204 | BUS_NOINTR = 3, |
| 205 | BUS_NODATA = 4, |
| 206 | BUS_TIMER = 5, |
| 207 | BUS_PIO = 6, |
| 208 | BUS_EDD = 7, |
| 209 | BUS_IDENTIFY = 8, |
| 210 | BUS_PACKET = 9, |
| 211 | |
| 212 | /* SATA port states */ |
| 213 | PORT_UNKNOWN = 0, |
| 214 | PORT_ENABLED = 1, |
| 215 | PORT_DISABLED = 2, |
| 216 | |
| 217 | /* encoding various smaller bitmaps into a single |
Tejun Heo | 1da7b0d | 2006-03-06 04:31:56 +0900 | [diff] [blame] | 218 | * unsigned int bitmap |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 219 | */ |
Tejun Heo | 1da7b0d | 2006-03-06 04:31:56 +0900 | [diff] [blame] | 220 | ATA_BITS_PIO = 5, |
| 221 | ATA_BITS_MWDMA = 3, |
| 222 | ATA_BITS_UDMA = 8, |
| 223 | |
| 224 | ATA_SHIFT_PIO = 0, |
| 225 | ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO, |
| 226 | ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA, |
| 227 | |
| 228 | ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO, |
| 229 | ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA, |
| 230 | ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA, |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 231 | |
| 232 | /* size of buffer to pad xfers ending on unaligned boundaries */ |
| 233 | ATA_DMA_PAD_SZ = 4, |
| 234 | ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE, |
Tejun Heo | 949b38a | 2006-04-02 18:51:52 +0900 | [diff] [blame] | 235 | |
| 236 | /* masks for port functions */ |
Alan Cox | 47a8659 | 2005-10-04 08:09:19 -0400 | [diff] [blame] | 237 | ATA_PORT_PRIMARY = (1 << 0), |
| 238 | ATA_PORT_SECONDARY = (1 << 1), |
Tejun Heo | 14d2bac | 2006-04-02 17:54:46 +0900 | [diff] [blame] | 239 | |
Tejun Heo | 0c247c5 | 2006-05-15 20:58:19 +0900 | [diff] [blame] | 240 | /* ering size */ |
| 241 | ATA_ERING_SIZE = 32, |
| 242 | |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 243 | /* desc_len for ata_eh_info and context */ |
| 244 | ATA_EH_DESC_LEN = 80, |
| 245 | |
Tejun Heo | 9be1e97 | 2006-05-15 20:58:17 +0900 | [diff] [blame] | 246 | /* reset / recovery action types */ |
| 247 | ATA_EH_REVALIDATE = (1 << 0), |
| 248 | ATA_EH_SOFTRESET = (1 << 1), |
| 249 | ATA_EH_HARDRESET = (1 << 2), |
| 250 | |
| 251 | ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET, |
| 252 | |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 253 | /* ata_eh_info->flags */ |
Tejun Heo | abdda73 | 2006-05-31 18:27:29 +0900 | [diff] [blame] | 254 | ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */ |
| 255 | |
| 256 | ATA_EHI_DID_RESET = (1 << 16), /* already reset this port */ |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 257 | |
Tejun Heo | ad9e276 | 2006-05-15 20:58:12 +0900 | [diff] [blame] | 258 | /* max repeat if error condition is still set after ->error_handler */ |
| 259 | ATA_EH_MAX_REPEAT = 5, |
| 260 | |
Tejun Heo | 14d2bac | 2006-04-02 17:54:46 +0900 | [diff] [blame] | 261 | /* how hard are we gonna try to probe/recover devices */ |
| 262 | ATA_PROBE_MAX_TRIES = 3, |
Tejun Heo | 022bdb0 | 2006-05-15 20:58:22 +0900 | [diff] [blame] | 263 | ATA_EH_RESET_TRIES = 3, |
| 264 | ATA_EH_DEV_TRIES = 3, |
Tejun Heo | f5914a4 | 2006-05-31 18:27:48 +0900 | [diff] [blame] | 265 | |
| 266 | /* Drive spinup time (time from power-on to the first D2H FIS) |
| 267 | * in msecs - 8s currently. Failing to get ready in this time |
| 268 | * isn't critical. It will result in reset failure for |
| 269 | * controllers which can't wait for the first D2H FIS. libata |
| 270 | * will retry, so it just has to be long enough to spin up |
| 271 | * most devices. |
| 272 | */ |
| 273 | ATA_SPINUP_WAIT = 8000, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | }; |
| 275 | |
Albert Lee | 14be71f | 2005-09-27 17:36:35 +0800 | [diff] [blame] | 276 | enum hsm_task_states { |
Albert Lee | c56b14d2 | 2005-09-30 19:07:39 +0800 | [diff] [blame] | 277 | HSM_ST_UNKNOWN, /* state unknown */ |
| 278 | HSM_ST_IDLE, /* no command on going */ |
Albert Lee | c56b14d2 | 2005-09-30 19:07:39 +0800 | [diff] [blame] | 279 | HSM_ST, /* (waiting the device to) transfer data */ |
| 280 | HSM_ST_LAST, /* (waiting the device to) complete command */ |
Albert Lee | c56b14d2 | 2005-09-30 19:07:39 +0800 | [diff] [blame] | 281 | HSM_ST_ERR, /* error */ |
| 282 | HSM_ST_FIRST, /* (waiting the device to) |
| 283 | write CDB or first data block */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 284 | }; |
| 285 | |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 286 | enum ata_completion_errors { |
Tejun Heo | 11a56d2 | 2006-01-23 13:09:36 +0900 | [diff] [blame] | 287 | AC_ERR_DEV = (1 << 0), /* device reported error */ |
| 288 | AC_ERR_HSM = (1 << 1), /* host state machine violation */ |
| 289 | AC_ERR_TIMEOUT = (1 << 2), /* timeout */ |
| 290 | AC_ERR_MEDIA = (1 << 3), /* media error */ |
| 291 | AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */ |
| 292 | AC_ERR_HOST_BUS = (1 << 5), /* host bus error */ |
| 293 | AC_ERR_SYSTEM = (1 << 6), /* system error */ |
| 294 | AC_ERR_INVALID = (1 << 7), /* invalid argument */ |
| 295 | AC_ERR_OTHER = (1 << 8), /* unknown */ |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 296 | }; |
| 297 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 298 | /* forward declarations */ |
| 299 | struct scsi_device; |
| 300 | struct ata_port_operations; |
| 301 | struct ata_port; |
| 302 | struct ata_queued_cmd; |
| 303 | |
| 304 | /* typedefs */ |
Tejun Heo | 77853bf | 2006-01-23 13:09:36 +0900 | [diff] [blame] | 305 | typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc); |
Tejun Heo | f5914a4 | 2006-05-31 18:27:48 +0900 | [diff] [blame] | 306 | typedef void (*ata_probeinit_fn_t)(struct ata_port *ap); |
| 307 | typedef int (*ata_prereset_fn_t)(struct ata_port *ap); |
| 308 | typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes); |
| 309 | typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 310 | |
| 311 | struct ata_ioports { |
| 312 | unsigned long cmd_addr; |
| 313 | unsigned long data_addr; |
| 314 | unsigned long error_addr; |
| 315 | unsigned long feature_addr; |
| 316 | unsigned long nsect_addr; |
| 317 | unsigned long lbal_addr; |
| 318 | unsigned long lbam_addr; |
| 319 | unsigned long lbah_addr; |
| 320 | unsigned long device_addr; |
| 321 | unsigned long status_addr; |
| 322 | unsigned long command_addr; |
| 323 | unsigned long altstatus_addr; |
| 324 | unsigned long ctl_addr; |
| 325 | unsigned long bmdma_addr; |
| 326 | unsigned long scr_addr; |
| 327 | }; |
| 328 | |
| 329 | struct ata_probe_ent { |
| 330 | struct list_head node; |
| 331 | struct device *dev; |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 332 | const struct ata_port_operations *port_ops; |
Jeff Garzik | 193515d | 2005-11-07 00:59:37 -0500 | [diff] [blame] | 333 | struct scsi_host_template *sht; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 334 | struct ata_ioports port[ATA_MAX_PORTS]; |
| 335 | unsigned int n_ports; |
| 336 | unsigned int hard_port_no; |
| 337 | unsigned int pio_mask; |
| 338 | unsigned int mwdma_mask; |
| 339 | unsigned int udma_mask; |
| 340 | unsigned int legacy_mode; |
| 341 | unsigned long irq; |
| 342 | unsigned int irq_flags; |
| 343 | unsigned long host_flags; |
Alan Cox | 4e5ec5d | 2006-03-27 18:42:40 +0100 | [diff] [blame] | 344 | unsigned long host_set_flags; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | void __iomem *mmio_base; |
| 346 | void *private_data; |
| 347 | }; |
| 348 | |
| 349 | struct ata_host_set { |
| 350 | spinlock_t lock; |
| 351 | struct device *dev; |
| 352 | unsigned long irq; |
| 353 | void __iomem *mmio_base; |
| 354 | unsigned int n_ports; |
| 355 | void *private_data; |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 356 | const struct ata_port_operations *ops; |
Alan Cox | 5444a6f | 2006-03-27 18:58:20 +0100 | [diff] [blame] | 357 | unsigned long flags; |
| 358 | int simplex_claimed; /* Keep seperate in case we |
| 359 | ever need to do this locked */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 360 | struct ata_port * ports[0]; |
| 361 | }; |
| 362 | |
| 363 | struct ata_queued_cmd { |
| 364 | struct ata_port *ap; |
| 365 | struct ata_device *dev; |
| 366 | |
| 367 | struct scsi_cmnd *scsicmd; |
| 368 | void (*scsidone)(struct scsi_cmnd *); |
| 369 | |
| 370 | struct ata_taskfile tf; |
| 371 | u8 cdb[ATAPI_CDB_LEN]; |
| 372 | |
| 373 | unsigned long flags; /* ATA_QCFLAG_xxx */ |
| 374 | unsigned int tag; |
| 375 | unsigned int n_elem; |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 376 | unsigned int orig_n_elem; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 377 | |
| 378 | int dma_dir; |
| 379 | |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 380 | unsigned int pad_len; |
| 381 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 382 | unsigned int nsect; |
| 383 | unsigned int cursect; |
| 384 | |
| 385 | unsigned int nbytes; |
| 386 | unsigned int curbytes; |
| 387 | |
| 388 | unsigned int cursg; |
| 389 | unsigned int cursg_ofs; |
| 390 | |
| 391 | struct scatterlist sgent; |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 392 | struct scatterlist pad_sgent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 393 | void *buf_virt; |
| 394 | |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 395 | /* DO NOT iterate over __sg manually, use ata_for_each_sg() */ |
| 396 | struct scatterlist *__sg; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 397 | |
Albert Lee | a22e2eb | 2005-12-05 15:38:02 +0800 | [diff] [blame] | 398 | unsigned int err_mask; |
Tejun Heo | e61e067 | 2006-05-15 20:57:40 +0900 | [diff] [blame] | 399 | struct ata_taskfile result_tf; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 400 | ata_qc_cb_t complete_fn; |
| 401 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 402 | void *private_data; |
| 403 | }; |
| 404 | |
| 405 | struct ata_host_stats { |
| 406 | unsigned long unhandled_irq; |
| 407 | unsigned long idle_irq; |
| 408 | unsigned long rw_reqbuf; |
| 409 | }; |
| 410 | |
Tejun Heo | 0c247c5 | 2006-05-15 20:58:19 +0900 | [diff] [blame] | 411 | struct ata_ering_entry { |
| 412 | int is_io; |
| 413 | unsigned int err_mask; |
| 414 | u64 timestamp; |
| 415 | }; |
| 416 | |
| 417 | struct ata_ering { |
| 418 | int cursor; |
| 419 | struct ata_ering_entry ring[ATA_ERING_SIZE]; |
| 420 | }; |
| 421 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 422 | struct ata_device { |
Tejun Heo | 38d8723 | 2006-05-15 20:57:51 +0900 | [diff] [blame] | 423 | struct ata_port *ap; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 424 | unsigned int devno; /* 0 or 1 */ |
Tejun Heo | 72fa4b7 | 2006-05-31 18:27:32 +0900 | [diff] [blame] | 425 | unsigned long flags; /* ATA_DFLAG_xxx */ |
Tejun Heo | 3edebac | 2006-05-31 18:27:40 +0900 | [diff] [blame] | 426 | struct scsi_device *sdev; /* attached SCSI device */ |
Tejun Heo | 72fa4b7 | 2006-05-31 18:27:32 +0900 | [diff] [blame] | 427 | /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */ |
| 428 | u64 n_sectors; /* size of device, if ATA */ |
| 429 | unsigned int class; /* ATA_DEV_xxx */ |
Tejun Heo | fe635c7 | 2006-05-15 20:57:35 +0900 | [diff] [blame] | 430 | u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 431 | u8 pio_mode; |
| 432 | u8 dma_mode; |
| 433 | u8 xfer_mode; |
| 434 | unsigned int xfer_shift; /* ATA_SHIFT_xxx */ |
| 435 | |
Albert Lee | 8cbd6df | 2005-10-12 15:06:27 +0800 | [diff] [blame] | 436 | unsigned int multi_count; /* sectors count for |
| 437 | READ/WRITE MULTIPLE */ |
Tejun Heo | b00eec1 | 2006-02-12 23:32:59 +0900 | [diff] [blame] | 438 | unsigned int max_sectors; /* per-device max sectors */ |
Tejun Heo | 6e7846e | 2006-02-12 23:32:58 +0900 | [diff] [blame] | 439 | unsigned int cdb_len; |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 440 | |
Tejun Heo | acf356b | 2006-03-24 14:07:50 +0900 | [diff] [blame] | 441 | /* per-dev xfer mask */ |
| 442 | unsigned int pio_mask; |
| 443 | unsigned int mwdma_mask; |
| 444 | unsigned int udma_mask; |
| 445 | |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 446 | /* for CHS addressing */ |
| 447 | u16 cylinders; /* Number of cylinders */ |
| 448 | u16 heads; /* Number of heads */ |
| 449 | u16 sectors; /* Number of sectors per track */ |
Tejun Heo | 0c247c5 | 2006-05-15 20:58:19 +0900 | [diff] [blame] | 450 | |
| 451 | /* error history */ |
| 452 | struct ata_ering ering; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 453 | }; |
| 454 | |
Tejun Heo | 72fa4b7 | 2006-05-31 18:27:32 +0900 | [diff] [blame] | 455 | /* Offset into struct ata_device. Fields above it are maintained |
| 456 | * acress device init. Fields below are zeroed. |
| 457 | */ |
| 458 | #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors) |
| 459 | |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 460 | struct ata_eh_info { |
| 461 | struct ata_device *dev; /* offending device */ |
| 462 | u32 serror; /* SError from LLDD */ |
| 463 | unsigned int err_mask; /* port-wide err_mask */ |
| 464 | unsigned int action; /* ATA_EH_* action mask */ |
| 465 | unsigned int flags; /* ATA_EHI_* flags */ |
Tejun Heo | abdda73 | 2006-05-31 18:27:29 +0900 | [diff] [blame] | 466 | |
| 467 | unsigned long hotplug_timestamp; |
| 468 | unsigned int probe_mask; |
| 469 | |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 470 | char desc[ATA_EH_DESC_LEN]; |
| 471 | int desc_len; |
| 472 | }; |
| 473 | |
| 474 | struct ata_eh_context { |
| 475 | struct ata_eh_info i; |
| 476 | int tries[ATA_MAX_DEVICES]; |
Tejun Heo | abdda73 | 2006-05-31 18:27:29 +0900 | [diff] [blame] | 477 | unsigned int classes[ATA_MAX_DEVICES]; |
| 478 | unsigned int did_probe_mask; |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 479 | }; |
| 480 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 481 | struct ata_port { |
| 482 | struct Scsi_Host *host; /* our co-allocated scsi host */ |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 483 | const struct ata_port_operations *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 484 | unsigned long flags; /* ATA_FLAG_xxx */ |
| 485 | unsigned int id; /* unique id req'd by scsi midlyr */ |
| 486 | unsigned int port_no; /* unique port #; from zero */ |
| 487 | unsigned int hard_port_no; /* hardware port #; from zero */ |
| 488 | |
| 489 | struct ata_prd *prd; /* our SG list */ |
| 490 | dma_addr_t prd_dma; /* and its DMA mapping */ |
| 491 | |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 492 | void *pad; /* array of DMA pad buffers */ |
| 493 | dma_addr_t pad_dma; |
| 494 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 495 | struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ |
| 496 | |
| 497 | u8 ctl; /* cache of ATA control register */ |
| 498 | u8 last_ctl; /* Cache last written value */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 499 | unsigned int pio_mask; |
| 500 | unsigned int mwdma_mask; |
| 501 | unsigned int udma_mask; |
| 502 | unsigned int cbl; /* cable type; ATA_CBL_xxx */ |
Tejun Heo | 5a04bf4 | 2006-05-31 18:27:38 +0900 | [diff] [blame] | 503 | unsigned int hw_sata_spd_limit; |
Tejun Heo | 1c3fae4 | 2006-04-02 20:53:28 +0900 | [diff] [blame] | 504 | unsigned int sata_spd_limit; /* SATA PHY speed limit */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 505 | |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 506 | /* record runtime error info, protected by host_set lock */ |
| 507 | struct ata_eh_info eh_info; |
| 508 | /* EH context owned by EH */ |
| 509 | struct ata_eh_context eh_context; |
| 510 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 511 | struct ata_device device[ATA_MAX_DEVICES]; |
| 512 | |
| 513 | struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; |
Tejun Heo | 6cec4a3 | 2006-05-15 21:03:41 +0900 | [diff] [blame] | 514 | unsigned long qc_allocated; |
Tejun Heo | dedaf2b | 2006-05-15 21:03:43 +0900 | [diff] [blame] | 515 | unsigned int qc_active; |
| 516 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 517 | unsigned int active_tag; |
Tejun Heo | dedaf2b | 2006-05-15 21:03:43 +0900 | [diff] [blame] | 518 | u32 sactive; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 519 | |
| 520 | struct ata_host_stats stats; |
| 521 | struct ata_host_set *host_set; |
Brian King | 2f1f610 | 2006-03-23 17:30:15 -0600 | [diff] [blame] | 522 | struct device *dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 523 | |
Tejun Heo | 86e45b6 | 2006-03-05 15:29:09 +0900 | [diff] [blame] | 524 | struct work_struct port_task; |
| 525 | |
Albert Lee | 14be71f | 2005-09-27 17:36:35 +0800 | [diff] [blame] | 526 | unsigned int hsm_task_state; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 527 | |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 528 | u32 msg_enable; |
Tejun Heo | a72ec4c | 2006-01-23 13:09:37 +0900 | [diff] [blame] | 529 | struct list_head eh_done_q; |
Tejun Heo | c6cf9e9 | 2006-05-31 18:27:27 +0900 | [diff] [blame] | 530 | wait_queue_head_t eh_wait_q; |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 531 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 532 | void *private_data; |
Tejun Heo | fe635c7 | 2006-05-15 20:57:35 +0900 | [diff] [blame] | 533 | |
| 534 | u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 535 | }; |
| 536 | |
| 537 | struct ata_port_operations { |
| 538 | void (*port_disable) (struct ata_port *); |
| 539 | |
| 540 | void (*dev_config) (struct ata_port *, struct ata_device *); |
| 541 | |
| 542 | void (*set_piomode) (struct ata_port *, struct ata_device *); |
| 543 | void (*set_dmamode) (struct ata_port *, struct ata_device *); |
Alan Cox | 5444a6f | 2006-03-27 18:58:20 +0100 | [diff] [blame] | 544 | unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 545 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 546 | void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 547 | void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); |
| 548 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 549 | void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 550 | u8 (*check_status)(struct ata_port *ap); |
| 551 | u8 (*check_altstatus)(struct ata_port *ap); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 552 | void (*dev_select)(struct ata_port *ap, unsigned int device); |
| 553 | |
Tejun Heo | c19ba8a | 2006-01-24 17:05:22 +0900 | [diff] [blame] | 554 | void (*phy_reset) (struct ata_port *ap); /* obsolete */ |
Alan Cox | e35a9e0 | 2006-03-27 18:46:37 +0100 | [diff] [blame] | 555 | void (*set_mode) (struct ata_port *ap); |
Tejun Heo | c19ba8a | 2006-01-24 17:05:22 +0900 | [diff] [blame] | 556 | int (*probe_reset) (struct ata_port *ap, unsigned int *classes); |
| 557 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 558 | void (*post_set_mode) (struct ata_port *ap); |
| 559 | |
| 560 | int (*check_atapi_dma) (struct ata_queued_cmd *qc); |
| 561 | |
| 562 | void (*bmdma_setup) (struct ata_queued_cmd *qc); |
| 563 | void (*bmdma_start) (struct ata_queued_cmd *qc); |
| 564 | |
Alan Cox | a6b2c5d | 2006-05-22 16:59:59 +0100 | [diff] [blame] | 565 | void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int); |
| 566 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 567 | void (*qc_prep) (struct ata_queued_cmd *qc); |
Tejun Heo | 9a3d9eb | 2006-01-23 13:09:36 +0900 | [diff] [blame] | 568 | unsigned int (*qc_issue) (struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 569 | |
Tejun Heo | 9ec957f | 2006-05-15 20:57:58 +0900 | [diff] [blame] | 570 | /* Error handlers. ->error_handler overrides ->eng_timeout and |
| 571 | * indicates that new-style EH is in place. |
| 572 | */ |
| 573 | void (*eng_timeout) (struct ata_port *ap); /* obsolete */ |
| 574 | |
| 575 | void (*freeze) (struct ata_port *ap); |
| 576 | void (*thaw) (struct ata_port *ap); |
| 577 | void (*error_handler) (struct ata_port *ap); |
| 578 | void (*post_internal_cmd) (struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 579 | |
| 580 | irqreturn_t (*irq_handler)(int, void *, struct pt_regs *); |
| 581 | void (*irq_clear) (struct ata_port *); |
| 582 | |
| 583 | u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg); |
| 584 | void (*scr_write) (struct ata_port *ap, unsigned int sc_reg, |
| 585 | u32 val); |
| 586 | |
| 587 | int (*port_start) (struct ata_port *ap); |
| 588 | void (*port_stop) (struct ata_port *ap); |
| 589 | |
| 590 | void (*host_stop) (struct ata_host_set *host_set); |
| 591 | |
Alan Cox | b73fc89 | 2005-08-26 16:03:19 +0100 | [diff] [blame] | 592 | void (*bmdma_stop) (struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 593 | u8 (*bmdma_status) (struct ata_port *ap); |
| 594 | }; |
| 595 | |
| 596 | struct ata_port_info { |
Christoph Hellwig | d0be4a7d | 2005-10-31 18:31:40 +0100 | [diff] [blame] | 597 | struct scsi_host_template *sht; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 598 | unsigned long host_flags; |
| 599 | unsigned long pio_mask; |
| 600 | unsigned long mwdma_mask; |
| 601 | unsigned long udma_mask; |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 602 | const struct ata_port_operations *port_ops; |
Alan Cox | e99f8b5 | 2005-11-08 14:09:44 +0000 | [diff] [blame] | 603 | void *private_data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 604 | }; |
| 605 | |
Alan Cox | 452503f | 2005-10-21 19:01:32 -0400 | [diff] [blame] | 606 | struct ata_timing { |
| 607 | unsigned short mode; /* ATA mode */ |
| 608 | unsigned short setup; /* t1 */ |
| 609 | unsigned short act8b; /* t2 for 8-bit I/O */ |
| 610 | unsigned short rec8b; /* t2i for 8-bit I/O */ |
| 611 | unsigned short cyc8b; /* t0 for 8-bit I/O */ |
| 612 | unsigned short active; /* t2 or tD */ |
| 613 | unsigned short recover; /* t2i or tK */ |
| 614 | unsigned short cycle; /* t0 */ |
| 615 | unsigned short udma; /* t2CYCTYP/2 */ |
| 616 | }; |
| 617 | |
| 618 | #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 619 | |
Tejun Heo | d7bb4cc | 2006-05-31 18:27:46 +0900 | [diff] [blame] | 620 | extern const unsigned long sata_deb_timing_boot[]; |
| 621 | extern const unsigned long sata_deb_timing_eh[]; |
| 622 | extern const unsigned long sata_deb_timing_before_fsrst[]; |
| 623 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 624 | extern void ata_port_probe(struct ata_port *); |
| 625 | extern void __sata_phy_reset(struct ata_port *ap); |
| 626 | extern void sata_phy_reset(struct ata_port *ap); |
| 627 | extern void ata_bus_reset(struct ata_port *ap); |
Tejun Heo | 3c567b7 | 2006-05-15 20:57:23 +0900 | [diff] [blame] | 628 | extern int sata_set_spd(struct ata_port *ap); |
Tejun Heo | d7bb4cc | 2006-05-31 18:27:46 +0900 | [diff] [blame] | 629 | extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param); |
| 630 | extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param); |
Tejun Heo | a62c0fc | 2006-01-24 17:05:22 +0900 | [diff] [blame] | 631 | extern int ata_drive_probe_reset(struct ata_port *ap, |
Tejun Heo | 7944ea9 | 2006-02-02 18:20:00 +0900 | [diff] [blame] | 632 | ata_probeinit_fn_t probeinit, |
Tejun Heo | a62c0fc | 2006-01-24 17:05:22 +0900 | [diff] [blame] | 633 | ata_reset_fn_t softreset, ata_reset_fn_t hardreset, |
| 634 | ata_postreset_fn_t postreset, unsigned int *classes); |
Tejun Heo | 8a19ac8 | 2006-02-02 18:20:00 +0900 | [diff] [blame] | 635 | extern void ata_std_probeinit(struct ata_port *ap); |
Tejun Heo | f5914a4 | 2006-05-31 18:27:48 +0900 | [diff] [blame] | 636 | extern int ata_std_prereset(struct ata_port *ap); |
Tejun Heo | 2bf2cb2 | 2006-04-11 22:16:45 +0900 | [diff] [blame] | 637 | extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes); |
| 638 | extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class); |
Tejun Heo | c2bd580 | 2006-01-24 17:05:22 +0900 | [diff] [blame] | 639 | extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes); |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 640 | extern int ata_dev_revalidate(struct ata_device *dev, int post_reset); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 641 | extern void ata_port_disable(struct ata_port *); |
| 642 | extern void ata_std_ports(struct ata_ioports *ioaddr); |
| 643 | #ifdef CONFIG_PCI |
| 644 | extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, |
| 645 | unsigned int n_ports); |
| 646 | extern void ata_pci_remove_one (struct pci_dev *pdev); |
Jens Axboe | 9b84754 | 2006-01-06 09:28:07 +0100 | [diff] [blame] | 647 | extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state); |
| 648 | extern int ata_pci_device_resume(struct pci_dev *pdev); |
Jeff Garzik | 17bb34a | 2006-03-21 21:29:21 -0500 | [diff] [blame] | 649 | extern int ata_pci_clear_simplex(struct pci_dev *pdev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 650 | #endif /* CONFIG_PCI */ |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 651 | extern int ata_device_add(const struct ata_probe_ent *ent); |
Alan Cox | 17b1445 | 2005-09-15 15:44:00 +0100 | [diff] [blame] | 652 | extern void ata_host_set_remove(struct ata_host_set *host_set); |
Jeff Garzik | 193515d | 2005-11-07 00:59:37 -0500 | [diff] [blame] | 653 | extern int ata_scsi_detect(struct scsi_host_template *sht); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 654 | extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); |
| 655 | extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 656 | extern int ata_scsi_release(struct Scsi_Host *host); |
| 657 | extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); |
Tejun Heo | 34bf217 | 2006-05-15 20:57:46 +0900 | [diff] [blame] | 658 | extern int sata_scr_valid(struct ata_port *ap); |
| 659 | extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val); |
| 660 | extern int sata_scr_write(struct ata_port *ap, int reg, u32 val); |
| 661 | extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val); |
| 662 | extern int ata_port_online(struct ata_port *ap); |
| 663 | extern int ata_port_offline(struct ata_port *ap); |
Jens Axboe | 9b84754 | 2006-01-06 09:28:07 +0100 | [diff] [blame] | 664 | extern int ata_scsi_device_resume(struct scsi_device *); |
Nigel Cunningham | 082776e | 2006-03-23 23:22:16 +1000 | [diff] [blame] | 665 | extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state); |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 666 | extern int ata_device_resume(struct ata_device *); |
| 667 | extern int ata_device_suspend(struct ata_device *, pm_message_t state); |
Jeff Garzik | 67846b3 | 2005-10-05 02:58:32 -0400 | [diff] [blame] | 668 | extern int ata_ratelimit(void); |
Tejun Heo | 6f8b995 | 2006-01-24 17:05:21 +0900 | [diff] [blame] | 669 | extern unsigned int ata_busy_sleep(struct ata_port *ap, |
| 670 | unsigned long timeout_pat, |
| 671 | unsigned long timeout); |
Tejun Heo | 86e45b6 | 2006-03-05 15:29:09 +0900 | [diff] [blame] | 672 | extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *), |
| 673 | void *data, unsigned long delay); |
Tejun Heo | c22daff | 2006-04-11 22:22:29 +0900 | [diff] [blame] | 674 | extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val, |
| 675 | unsigned long interval_msec, |
| 676 | unsigned long timeout_msec); |
Jeff Garzik | 67846b3 | 2005-10-05 02:58:32 -0400 | [diff] [blame] | 677 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 678 | /* |
| 679 | * Default driver ops implementations |
| 680 | */ |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 681 | extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 682 | extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf); |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 683 | extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp); |
| 684 | extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 685 | extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device); |
| 686 | extern void ata_std_dev_select (struct ata_port *ap, unsigned int device); |
| 687 | extern u8 ata_check_status(struct ata_port *ap); |
| 688 | extern u8 ata_altstatus(struct ata_port *ap); |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 689 | extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); |
Tejun Heo | c2bd580 | 2006-01-24 17:05:22 +0900 | [diff] [blame] | 690 | extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 691 | extern int ata_port_start (struct ata_port *ap); |
| 692 | extern void ata_port_stop (struct ata_port *ap); |
Jeff Garzik | aa8f0dc | 2005-05-26 21:54:27 -0400 | [diff] [blame] | 693 | extern void ata_host_stop (struct ata_host_set *host_set); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 694 | extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs); |
Alan Cox | a6b2c5d | 2006-05-22 16:59:59 +0100 | [diff] [blame] | 695 | extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf, |
| 696 | unsigned int buflen, int write_data); |
| 697 | extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf, |
| 698 | unsigned int buflen, int write_data); |
Alan Cox | 75e9958 | 2006-05-24 14:14:41 +0100 | [diff] [blame] | 699 | extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf, |
| 700 | unsigned int buflen, int write_data); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 701 | extern void ata_qc_prep(struct ata_queued_cmd *qc); |
Brian King | e46834c | 2006-03-17 17:04:03 -0600 | [diff] [blame] | 702 | extern void ata_noop_qc_prep(struct ata_queued_cmd *qc); |
Tejun Heo | 9a3d9eb | 2006-01-23 13:09:36 +0900 | [diff] [blame] | 703 | extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 704 | extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, |
| 705 | unsigned int buflen); |
| 706 | extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, |
| 707 | unsigned int n_elem); |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 708 | extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); |
Tejun Heo | 6a62a04 | 2006-02-13 10:02:46 +0900 | [diff] [blame] | 709 | extern void ata_id_string(const u16 *id, unsigned char *s, |
| 710 | unsigned int ofs, unsigned int len); |
| 711 | extern void ata_id_c_string(const u16 *id, unsigned char *s, |
| 712 | unsigned int ofs, unsigned int len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 713 | extern void ata_bmdma_setup (struct ata_queued_cmd *qc); |
| 714 | extern void ata_bmdma_start (struct ata_queued_cmd *qc); |
Alan Cox | b73fc89 | 2005-08-26 16:03:19 +0100 | [diff] [blame] | 715 | extern void ata_bmdma_stop(struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 716 | extern u8 ata_bmdma_status(struct ata_port *ap); |
| 717 | extern void ata_bmdma_irq_clear(struct ata_port *ap); |
Tejun Heo | 6d97dbd | 2006-05-15 20:58:24 +0900 | [diff] [blame] | 718 | extern void ata_bmdma_freeze(struct ata_port *ap); |
| 719 | extern void ata_bmdma_thaw(struct ata_port *ap); |
Tejun Heo | f5914a4 | 2006-05-31 18:27:48 +0900 | [diff] [blame] | 720 | extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset, |
Tejun Heo | 6d97dbd | 2006-05-15 20:58:24 +0900 | [diff] [blame] | 721 | ata_reset_fn_t softreset, |
| 722 | ata_reset_fn_t hardreset, |
| 723 | ata_postreset_fn_t postreset); |
| 724 | extern void ata_bmdma_error_handler(struct ata_port *ap); |
| 725 | extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc); |
Tejun Heo | 9a1004d | 2006-05-31 18:27:52 +0900 | [diff] [blame^] | 726 | extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc, |
| 727 | u8 status, int in_wq); |
Tejun Heo | f686bcb | 2006-05-15 20:58:05 +0900 | [diff] [blame] | 728 | extern void ata_qc_complete(struct ata_queued_cmd *qc); |
Tejun Heo | dedaf2b | 2006-05-15 21:03:43 +0900 | [diff] [blame] | 729 | extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active, |
| 730 | void (*finish_qc)(struct ata_queued_cmd *)); |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 731 | extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 732 | void (*done)(struct scsi_cmnd *)); |
| 733 | extern int ata_std_bios_param(struct scsi_device *sdev, |
| 734 | struct block_device *bdev, |
| 735 | sector_t capacity, int geom[]); |
| 736 | extern int ata_scsi_slave_config(struct scsi_device *sdev); |
Tejun Heo | a6e6ce8 | 2006-05-15 21:03:48 +0900 | [diff] [blame] | 737 | extern int ata_scsi_change_queue_depth(struct scsi_device *sdev, |
| 738 | int queue_depth); |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 739 | extern struct ata_device *ata_dev_pair(struct ata_device *adev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 740 | |
Alan Cox | 452503f | 2005-10-21 19:01:32 -0400 | [diff] [blame] | 741 | /* |
| 742 | * Timing helpers |
| 743 | */ |
Alan Cox | 1bc4ccf | 2006-01-09 17:18:14 +0000 | [diff] [blame] | 744 | |
| 745 | extern unsigned int ata_pio_need_iordy(const struct ata_device *); |
Alan Cox | 452503f | 2005-10-21 19:01:32 -0400 | [diff] [blame] | 746 | extern int ata_timing_compute(struct ata_device *, unsigned short, |
| 747 | struct ata_timing *, int, int); |
| 748 | extern void ata_timing_merge(const struct ata_timing *, |
| 749 | const struct ata_timing *, struct ata_timing *, |
| 750 | unsigned int); |
| 751 | |
| 752 | enum { |
| 753 | ATA_TIMING_SETUP = (1 << 0), |
| 754 | ATA_TIMING_ACT8B = (1 << 1), |
| 755 | ATA_TIMING_REC8B = (1 << 2), |
| 756 | ATA_TIMING_CYC8B = (1 << 3), |
| 757 | ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | |
| 758 | ATA_TIMING_CYC8B, |
| 759 | ATA_TIMING_ACTIVE = (1 << 4), |
| 760 | ATA_TIMING_RECOVER = (1 << 5), |
| 761 | ATA_TIMING_CYCLE = (1 << 6), |
| 762 | ATA_TIMING_UDMA = (1 << 7), |
| 763 | ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | |
| 764 | ATA_TIMING_REC8B | ATA_TIMING_CYC8B | |
| 765 | ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | |
| 766 | ATA_TIMING_CYCLE | ATA_TIMING_UDMA, |
| 767 | }; |
| 768 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 769 | |
| 770 | #ifdef CONFIG_PCI |
| 771 | struct pci_bits { |
| 772 | unsigned int reg; /* PCI config register to read */ |
| 773 | unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ |
| 774 | unsigned long mask; |
| 775 | unsigned long val; |
| 776 | }; |
| 777 | |
Jeff Garzik | 374b187 | 2005-08-30 05:42:52 -0400 | [diff] [blame] | 778 | extern void ata_pci_host_stop (struct ata_host_set *host_set); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 779 | extern struct ata_probe_ent * |
Alan Cox | 47a8659 | 2005-10-04 08:09:19 -0400 | [diff] [blame] | 780 | ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask); |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 781 | extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); |
Jeff Garzik | 17bb34a | 2006-03-21 21:29:21 -0500 | [diff] [blame] | 782 | extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 783 | #endif /* CONFIG_PCI */ |
| 784 | |
Tejun Heo | ece1d63 | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 785 | /* |
| 786 | * EH |
| 787 | */ |
Tejun Heo | ece1d63 | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 788 | extern void ata_eng_timeout(struct ata_port *ap); |
Tejun Heo | 7b70fc0 | 2006-05-15 20:58:07 +0900 | [diff] [blame] | 789 | |
| 790 | extern void ata_port_schedule_eh(struct ata_port *ap); |
| 791 | extern int ata_port_abort(struct ata_port *ap); |
Tejun Heo | e318049 | 2006-05-15 20:58:09 +0900 | [diff] [blame] | 792 | extern int ata_port_freeze(struct ata_port *ap); |
| 793 | |
| 794 | extern void ata_eh_freeze_port(struct ata_port *ap); |
| 795 | extern void ata_eh_thaw_port(struct ata_port *ap); |
Tejun Heo | 7b70fc0 | 2006-05-15 20:58:07 +0900 | [diff] [blame] | 796 | |
Tejun Heo | ece1d63 | 2006-04-02 18:51:53 +0900 | [diff] [blame] | 797 | extern void ata_eh_qc_complete(struct ata_queued_cmd *qc); |
| 798 | extern void ata_eh_qc_retry(struct ata_queued_cmd *qc); |
| 799 | |
Tejun Heo | f5914a4 | 2006-05-31 18:27:48 +0900 | [diff] [blame] | 800 | extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset, |
| 801 | ata_reset_fn_t softreset, ata_reset_fn_t hardreset, |
| 802 | ata_postreset_fn_t postreset); |
Tejun Heo | 022bdb0 | 2006-05-15 20:58:22 +0900 | [diff] [blame] | 803 | |
Tejun Heo | 61440db | 2006-05-15 20:57:55 +0900 | [diff] [blame] | 804 | /* |
| 805 | * printk helpers |
| 806 | */ |
| 807 | #define ata_port_printk(ap, lv, fmt, args...) \ |
| 808 | printk(lv"ata%u: "fmt, (ap)->id , ##args) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 809 | |
Tejun Heo | 61440db | 2006-05-15 20:57:55 +0900 | [diff] [blame] | 810 | #define ata_dev_printk(dev, lv, fmt, args...) \ |
| 811 | printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args) |
| 812 | |
| 813 | /* |
Tejun Heo | f3e81b1 | 2006-05-15 20:58:21 +0900 | [diff] [blame] | 814 | * ata_eh_info helpers |
| 815 | */ |
| 816 | #define ata_ehi_push_desc(ehi, fmt, args...) do { \ |
| 817 | (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \ |
| 818 | ATA_EH_DESC_LEN - (ehi)->desc_len, \ |
| 819 | fmt , ##args); \ |
| 820 | } while (0) |
| 821 | |
| 822 | #define ata_ehi_clear_desc(ehi) do { \ |
| 823 | (ehi)->desc[0] = '\0'; \ |
| 824 | (ehi)->desc_len = 0; \ |
| 825 | } while (0) |
| 826 | |
| 827 | /* |
Tejun Heo | 61440db | 2006-05-15 20:57:55 +0900 | [diff] [blame] | 828 | * qc helpers |
| 829 | */ |
Jeff Garzik | 972c26b | 2005-10-18 22:14:54 -0400 | [diff] [blame] | 830 | static inline int |
| 831 | ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc) |
| 832 | { |
| 833 | if (sg == &qc->pad_sgent) |
| 834 | return 1; |
| 835 | if (qc->pad_len) |
| 836 | return 0; |
| 837 | if (((sg - qc->__sg) + 1) == qc->n_elem) |
| 838 | return 1; |
| 839 | return 0; |
| 840 | } |
| 841 | |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 842 | static inline struct scatterlist * |
Tejun Heo | cc1887f3 | 2006-02-20 23:48:38 +0900 | [diff] [blame] | 843 | ata_qc_first_sg(struct ata_queued_cmd *qc) |
| 844 | { |
| 845 | if (qc->n_elem) |
| 846 | return qc->__sg; |
| 847 | if (qc->pad_len) |
| 848 | return &qc->pad_sgent; |
| 849 | return NULL; |
| 850 | } |
| 851 | |
| 852 | static inline struct scatterlist * |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 853 | ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc) |
| 854 | { |
| 855 | if (sg == &qc->pad_sgent) |
| 856 | return NULL; |
| 857 | if (++sg - qc->__sg < qc->n_elem) |
| 858 | return sg; |
Tejun Heo | cc1887f3 | 2006-02-20 23:48:38 +0900 | [diff] [blame] | 859 | if (qc->pad_len) |
| 860 | return &qc->pad_sgent; |
| 861 | return NULL; |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 862 | } |
| 863 | |
| 864 | #define ata_for_each_sg(sg, qc) \ |
Tejun Heo | cc1887f3 | 2006-02-20 23:48:38 +0900 | [diff] [blame] | 865 | for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc)) |
Jeff Garzik | cedc9a4 | 2005-10-05 07:13:30 -0400 | [diff] [blame] | 866 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 867 | static inline unsigned int ata_tag_valid(unsigned int tag) |
| 868 | { |
| 869 | return (tag < ATA_MAX_QUEUE) ? 1 : 0; |
| 870 | } |
| 871 | |
Tejun Heo | 2ab7db1 | 2006-05-15 20:58:02 +0900 | [diff] [blame] | 872 | static inline unsigned int ata_tag_internal(unsigned int tag) |
| 873 | { |
| 874 | return tag == ATA_MAX_QUEUE - 1; |
| 875 | } |
| 876 | |
Tejun Heo | e1211e3 | 2006-04-01 01:38:18 +0900 | [diff] [blame] | 877 | static inline unsigned int ata_class_enabled(unsigned int class) |
Tejun Heo | 597afd2 | 2006-03-01 01:25:38 +0900 | [diff] [blame] | 878 | { |
| 879 | return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI; |
| 880 | } |
| 881 | |
Tejun Heo | e1211e3 | 2006-04-01 01:38:18 +0900 | [diff] [blame] | 882 | static inline unsigned int ata_class_disabled(unsigned int class) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 883 | { |
Tejun Heo | e1211e3 | 2006-04-01 01:38:18 +0900 | [diff] [blame] | 884 | return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP; |
| 885 | } |
| 886 | |
Tejun Heo | 002c805 | 2006-04-02 17:54:46 +0900 | [diff] [blame] | 887 | static inline unsigned int ata_class_absent(unsigned int class) |
| 888 | { |
| 889 | return !ata_class_enabled(class) && !ata_class_disabled(class); |
| 890 | } |
| 891 | |
Tejun Heo | e1211e3 | 2006-04-01 01:38:18 +0900 | [diff] [blame] | 892 | static inline unsigned int ata_dev_enabled(const struct ata_device *dev) |
| 893 | { |
| 894 | return ata_class_enabled(dev->class); |
| 895 | } |
| 896 | |
| 897 | static inline unsigned int ata_dev_disabled(const struct ata_device *dev) |
| 898 | { |
| 899 | return ata_class_disabled(dev->class); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 900 | } |
| 901 | |
Tejun Heo | 002c805 | 2006-04-02 17:54:46 +0900 | [diff] [blame] | 902 | static inline unsigned int ata_dev_absent(const struct ata_device *dev) |
| 903 | { |
| 904 | return ata_class_absent(dev->class); |
| 905 | } |
| 906 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 907 | static inline u8 ata_chk_status(struct ata_port *ap) |
| 908 | { |
| 909 | return ap->ops->check_status(ap); |
| 910 | } |
| 911 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 912 | |
| 913 | /** |
| 914 | * ata_pause - Flush writes and pause 400 nanoseconds. |
| 915 | * @ap: Port to wait for. |
| 916 | * |
| 917 | * LOCKING: |
| 918 | * Inherited from caller. |
| 919 | */ |
| 920 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 921 | static inline void ata_pause(struct ata_port *ap) |
| 922 | { |
| 923 | ata_altstatus(ap); |
| 924 | ndelay(400); |
| 925 | } |
| 926 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 927 | |
| 928 | /** |
| 929 | * ata_busy_wait - Wait for a port status register |
| 930 | * @ap: Port to wait for. |
| 931 | * |
| 932 | * Waits up to max*10 microseconds for the selected bits in the port's |
| 933 | * status register to be cleared. |
| 934 | * Returns final value of status register. |
| 935 | * |
| 936 | * LOCKING: |
| 937 | * Inherited from caller. |
| 938 | */ |
| 939 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 940 | static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, |
| 941 | unsigned int max) |
| 942 | { |
| 943 | u8 status; |
| 944 | |
| 945 | do { |
| 946 | udelay(10); |
| 947 | status = ata_chk_status(ap); |
| 948 | max--; |
| 949 | } while ((status & bits) && (max > 0)); |
| 950 | |
| 951 | return status; |
| 952 | } |
| 953 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 954 | |
| 955 | /** |
| 956 | * ata_wait_idle - Wait for a port to be idle. |
| 957 | * @ap: Port to wait for. |
| 958 | * |
| 959 | * Waits up to 10ms for port's BUSY and DRQ signals to clear. |
| 960 | * Returns final value of status register. |
| 961 | * |
| 962 | * LOCKING: |
| 963 | * Inherited from caller. |
| 964 | */ |
| 965 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 966 | static inline u8 ata_wait_idle(struct ata_port *ap) |
| 967 | { |
| 968 | u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); |
| 969 | |
| 970 | if (status & (ATA_BUSY | ATA_DRQ)) { |
| 971 | unsigned long l = ap->ioaddr.status_addr; |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 972 | if (ata_msg_warn(ap)) |
| 973 | printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n", |
| 974 | status, l); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 975 | } |
| 976 | |
| 977 | return status; |
| 978 | } |
| 979 | |
| 980 | static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) |
| 981 | { |
| 982 | qc->tf.ctl |= ATA_NIEN; |
| 983 | } |
| 984 | |
Tejun Heo | f69499f | 2006-05-15 20:58:03 +0900 | [diff] [blame] | 985 | static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap, |
| 986 | unsigned int tag) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 987 | { |
| 988 | if (likely(ata_tag_valid(tag))) |
| 989 | return &ap->qcmd[tag]; |
| 990 | return NULL; |
| 991 | } |
| 992 | |
Tejun Heo | f69499f | 2006-05-15 20:58:03 +0900 | [diff] [blame] | 993 | static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap, |
| 994 | unsigned int tag) |
| 995 | { |
| 996 | struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag); |
| 997 | |
| 998 | if (unlikely(!qc) || !ap->ops->error_handler) |
| 999 | return qc; |
| 1000 | |
| 1001 | if ((qc->flags & (ATA_QCFLAG_ACTIVE | |
| 1002 | ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE) |
| 1003 | return qc; |
| 1004 | |
| 1005 | return NULL; |
| 1006 | } |
| 1007 | |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 1008 | static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1009 | { |
| 1010 | memset(tf, 0, sizeof(*tf)); |
| 1011 | |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 1012 | tf->ctl = dev->ap->ctl; |
| 1013 | if (dev->devno == 0) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1014 | tf->device = ATA_DEVICE_OBS; |
| 1015 | else |
| 1016 | tf->device = ATA_DEVICE_OBS | ATA_DEV1; |
| 1017 | } |
| 1018 | |
Jeff Garzik | 2c13b7c | 2005-11-14 14:14:16 -0500 | [diff] [blame] | 1019 | static inline void ata_qc_reinit(struct ata_queued_cmd *qc) |
| 1020 | { |
| 1021 | qc->__sg = NULL; |
| 1022 | qc->flags = 0; |
| 1023 | qc->cursect = qc->cursg = qc->cursg_ofs = 0; |
| 1024 | qc->nsect = 0; |
| 1025 | qc->nbytes = qc->curbytes = 0; |
Albert Lee | a22e2eb | 2005-12-05 15:38:02 +0800 | [diff] [blame] | 1026 | qc->err_mask = 0; |
Jeff Garzik | 2c13b7c | 2005-11-14 14:14:16 -0500 | [diff] [blame] | 1027 | |
Tejun Heo | 3373efd | 2006-05-15 20:57:53 +0900 | [diff] [blame] | 1028 | ata_tf_init(qc->dev, &qc->tf); |
Tejun Heo | e61e067 | 2006-05-15 20:57:40 +0900 | [diff] [blame] | 1029 | |
| 1030 | /* init result_tf such that it indicates normal completion */ |
| 1031 | qc->result_tf.command = ATA_DRDY; |
| 1032 | qc->result_tf.feature = 0; |
Jeff Garzik | 2c13b7c | 2005-11-14 14:14:16 -0500 | [diff] [blame] | 1033 | } |
| 1034 | |
Tejun Heo | 7601442 | 2006-02-11 15:13:49 +0900 | [diff] [blame] | 1035 | /** |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 1036 | * ata_irq_on - Enable interrupts on a port. |
| 1037 | * @ap: Port on which interrupts are enabled. |
| 1038 | * |
| 1039 | * Enable interrupts on a legacy IDE device using MMIO or PIO, |
| 1040 | * wait for idle, clear any pending interrupts. |
| 1041 | * |
| 1042 | * LOCKING: |
| 1043 | * Inherited from caller. |
| 1044 | */ |
| 1045 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1046 | static inline u8 ata_irq_on(struct ata_port *ap) |
| 1047 | { |
| 1048 | struct ata_ioports *ioaddr = &ap->ioaddr; |
| 1049 | u8 tmp; |
| 1050 | |
| 1051 | ap->ctl &= ~ATA_NIEN; |
| 1052 | ap->last_ctl = ap->ctl; |
| 1053 | |
| 1054 | if (ap->flags & ATA_FLAG_MMIO) |
| 1055 | writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr); |
| 1056 | else |
| 1057 | outb(ap->ctl, ioaddr->ctl_addr); |
| 1058 | tmp = ata_wait_idle(ap); |
| 1059 | |
| 1060 | ap->ops->irq_clear(ap); |
| 1061 | |
| 1062 | return tmp; |
| 1063 | } |
| 1064 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 1065 | |
| 1066 | /** |
| 1067 | * ata_irq_ack - Acknowledge a device interrupt. |
| 1068 | * @ap: Port on which interrupts are enabled. |
| 1069 | * |
| 1070 | * Wait up to 10 ms for legacy IDE device to become idle (BUSY |
| 1071 | * or BUSY+DRQ clear). Obtain dma status and port status from |
| 1072 | * device. Clear the interrupt. Return port status. |
| 1073 | * |
| 1074 | * LOCKING: |
| 1075 | */ |
| 1076 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1077 | static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq) |
| 1078 | { |
| 1079 | unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY; |
| 1080 | u8 host_stat, post_stat, status; |
| 1081 | |
| 1082 | status = ata_busy_wait(ap, bits, 1000); |
| 1083 | if (status & bits) |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 1084 | if (ata_msg_err(ap)) |
| 1085 | printk(KERN_ERR "abnormal status 0x%X\n", status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1086 | |
| 1087 | /* get controller status; clear intr, err bits */ |
| 1088 | if (ap->flags & ATA_FLAG_MMIO) { |
| 1089 | void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr; |
| 1090 | host_stat = readb(mmio + ATA_DMA_STATUS); |
| 1091 | writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, |
| 1092 | mmio + ATA_DMA_STATUS); |
| 1093 | |
| 1094 | post_stat = readb(mmio + ATA_DMA_STATUS); |
| 1095 | } else { |
| 1096 | host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); |
| 1097 | outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, |
| 1098 | ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); |
| 1099 | |
| 1100 | post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); |
| 1101 | } |
| 1102 | |
Randy Dunlap | bfd6057 | 2006-01-17 19:34:42 -0500 | [diff] [blame] | 1103 | if (ata_msg_intr(ap)) |
| 1104 | printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n", |
| 1105 | __FUNCTION__, |
| 1106 | host_stat, post_stat, status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1107 | |
| 1108 | return status; |
| 1109 | } |
| 1110 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 1111 | static inline int ata_try_flush_cache(const struct ata_device *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1112 | { |
| 1113 | return ata_id_wcache_enabled(dev->id) || |
| 1114 | ata_id_has_flush(dev->id) || |
| 1115 | ata_id_has_flush_ext(dev->id); |
| 1116 | } |
| 1117 | |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 1118 | static inline unsigned int ac_err_mask(u8 status) |
| 1119 | { |
Albert Lee | 3655d1d | 2006-05-19 11:43:04 +0800 | [diff] [blame] | 1120 | if (status & (ATA_BUSY | ATA_DRQ)) |
Tejun Heo | 11a56d2 | 2006-01-23 13:09:36 +0900 | [diff] [blame] | 1121 | return AC_ERR_HSM; |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 1122 | if (status & (ATA_ERR | ATA_DF)) |
| 1123 | return AC_ERR_DEV; |
| 1124 | return 0; |
| 1125 | } |
| 1126 | |
| 1127 | static inline unsigned int __ac_err_mask(u8 status) |
| 1128 | { |
| 1129 | unsigned int mask = ac_err_mask(status); |
| 1130 | if (mask == 0) |
| 1131 | return AC_ERR_OTHER; |
| 1132 | return mask; |
| 1133 | } |
| 1134 | |
Jeff Garzik | 6037d6b | 2005-11-04 22:08:00 -0500 | [diff] [blame] | 1135 | static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev) |
| 1136 | { |
| 1137 | ap->pad_dma = 0; |
| 1138 | ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ, |
| 1139 | &ap->pad_dma, GFP_KERNEL); |
| 1140 | return (ap->pad == NULL) ? -ENOMEM : 0; |
| 1141 | } |
| 1142 | |
| 1143 | static inline void ata_pad_free(struct ata_port *ap, struct device *dev) |
| 1144 | { |
| 1145 | dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma); |
| 1146 | } |
| 1147 | |
Jeff Garzik | 35bb94b | 2006-04-11 13:12:34 -0400 | [diff] [blame] | 1148 | static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host) |
| 1149 | { |
| 1150 | return (struct ata_port *) &host->hostdata[0]; |
| 1151 | } |
| 1152 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1153 | #endif /* __LINUX_LIBATA_H__ */ |