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> |
| 32 | #include <asm/io.h> |
| 33 | #include <linux/ata.h> |
| 34 | #include <linux/workqueue.h> |
| 35 | |
| 36 | /* |
| 37 | * compile-time options |
| 38 | */ |
| 39 | #undef ATA_DEBUG /* debugging output */ |
| 40 | #undef ATA_VERBOSE_DEBUG /* yet more debugging output */ |
| 41 | #undef ATA_IRQ_TRAP /* define to ack screaming irqs */ |
| 42 | #undef ATA_NDEBUG /* define to disable quick runtime checks */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | #undef ATA_ENABLE_PATA /* define to enable PATA support in some |
| 44 | * low-level drivers */ |
| 45 | #undef ATAPI_ENABLE_DMADIR /* enables ATAPI DMADIR bridge support */ |
| 46 | |
| 47 | |
| 48 | /* note: prints function name for you */ |
| 49 | #ifdef ATA_DEBUG |
| 50 | #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
| 51 | #ifdef ATA_VERBOSE_DEBUG |
| 52 | #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args) |
| 53 | #else |
| 54 | #define VPRINTK(fmt, args...) |
| 55 | #endif /* ATA_VERBOSE_DEBUG */ |
| 56 | #else |
| 57 | #define DPRINTK(fmt, args...) |
| 58 | #define VPRINTK(fmt, args...) |
| 59 | #endif /* ATA_DEBUG */ |
| 60 | |
| 61 | #ifdef ATA_NDEBUG |
| 62 | #define assert(expr) |
| 63 | #else |
| 64 | #define assert(expr) \ |
| 65 | if(unlikely(!(expr))) { \ |
| 66 | printk(KERN_ERR "Assertion failed! %s,%s,%s,line=%d\n", \ |
| 67 | #expr,__FILE__,__FUNCTION__,__LINE__); \ |
| 68 | } |
| 69 | #endif |
| 70 | |
| 71 | /* defines only for the constants which don't work well as enums */ |
| 72 | #define ATA_TAG_POISON 0xfafbfcfdU |
| 73 | |
| 74 | /* move to PCI layer? */ |
| 75 | static inline struct device *pci_dev_to_dev(struct pci_dev *pdev) |
| 76 | { |
| 77 | return &pdev->dev; |
| 78 | } |
| 79 | |
| 80 | enum { |
| 81 | /* various global constants */ |
| 82 | LIBATA_MAX_PRD = ATA_MAX_PRD / 2, |
| 83 | ATA_MAX_PORTS = 8, |
| 84 | ATA_DEF_QUEUE = 1, |
| 85 | ATA_MAX_QUEUE = 1, |
| 86 | ATA_MAX_SECTORS = 200, /* FIXME */ |
| 87 | ATA_MAX_BUS = 2, |
| 88 | ATA_DEF_BUSY_WAIT = 10000, |
| 89 | ATA_SHORT_PAUSE = (HZ >> 6) + 1, |
| 90 | |
| 91 | ATA_SHT_EMULATED = 1, |
| 92 | ATA_SHT_CMD_PER_LUN = 1, |
| 93 | ATA_SHT_THIS_ID = -1, |
Jeff Garzik | cf48293 | 2005-10-22 00:19:33 -0400 | [diff] [blame] | 94 | ATA_SHT_USE_CLUSTERING = 1, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | |
| 96 | /* struct ata_device stuff */ |
| 97 | ATA_DFLAG_LBA48 = (1 << 0), /* device supports LBA48 */ |
| 98 | ATA_DFLAG_PIO = (1 << 1), /* device currently in PIO mode */ |
| 99 | ATA_DFLAG_LOCK_SECTORS = (1 << 2), /* don't adjust max_sectors */ |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 100 | ATA_DFLAG_LBA = (1 << 3), /* device supports LBA */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | |
| 102 | ATA_DEV_UNKNOWN = 0, /* unknown device */ |
| 103 | ATA_DEV_ATA = 1, /* ATA device */ |
| 104 | ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */ |
| 105 | ATA_DEV_ATAPI = 3, /* ATAPI device */ |
| 106 | ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */ |
| 107 | ATA_DEV_NONE = 5, /* no device */ |
| 108 | |
| 109 | /* struct ata_port flags */ |
| 110 | ATA_FLAG_SLAVE_POSS = (1 << 1), /* host supports slave dev */ |
| 111 | /* (doesn't imply presence) */ |
| 112 | ATA_FLAG_PORT_DISABLED = (1 << 2), /* port is disabled, ignore it */ |
| 113 | ATA_FLAG_SATA = (1 << 3), |
| 114 | ATA_FLAG_NO_LEGACY = (1 << 4), /* no legacy mode check */ |
| 115 | ATA_FLAG_SRST = (1 << 5), /* use ATA SRST, not E.D.D. */ |
| 116 | ATA_FLAG_MMIO = (1 << 6), /* use MMIO, not PIO */ |
| 117 | ATA_FLAG_SATA_RESET = (1 << 7), /* use COMRESET */ |
| 118 | ATA_FLAG_PIO_DMA = (1 << 8), /* PIO cmds via DMA */ |
Tejun Heo | c138950 | 2005-08-22 14:59:24 +0900 | [diff] [blame] | 119 | ATA_FLAG_NOINTR = (1 << 9), /* FIXME: Remove this once |
| 120 | * proper HSM is in place. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | |
| 122 | ATA_QCFLAG_ACTIVE = (1 << 1), /* cmd not yet ack'd to scsi lyer */ |
| 123 | ATA_QCFLAG_SG = (1 << 3), /* have s/g table? */ |
| 124 | ATA_QCFLAG_SINGLE = (1 << 4), /* no s/g, just a single buffer */ |
| 125 | ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE, |
| 126 | |
| 127 | /* various lengths of time */ |
| 128 | ATA_TMOUT_EDD = 5 * HZ, /* hueristic */ |
| 129 | ATA_TMOUT_PIO = 30 * HZ, |
| 130 | ATA_TMOUT_BOOT = 30 * HZ, /* hueristic */ |
| 131 | ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* hueristic */ |
| 132 | ATA_TMOUT_CDB = 30 * HZ, |
| 133 | ATA_TMOUT_CDB_QUICK = 5 * HZ, |
| 134 | |
| 135 | /* ATA bus states */ |
| 136 | BUS_UNKNOWN = 0, |
| 137 | BUS_DMA = 1, |
| 138 | BUS_IDLE = 2, |
| 139 | BUS_NOINTR = 3, |
| 140 | BUS_NODATA = 4, |
| 141 | BUS_TIMER = 5, |
| 142 | BUS_PIO = 6, |
| 143 | BUS_EDD = 7, |
| 144 | BUS_IDENTIFY = 8, |
| 145 | BUS_PACKET = 9, |
| 146 | |
| 147 | /* SATA port states */ |
| 148 | PORT_UNKNOWN = 0, |
| 149 | PORT_ENABLED = 1, |
| 150 | PORT_DISABLED = 2, |
| 151 | |
| 152 | /* encoding various smaller bitmaps into a single |
| 153 | * unsigned long bitmap |
| 154 | */ |
| 155 | ATA_SHIFT_UDMA = 0, |
| 156 | ATA_SHIFT_MWDMA = 8, |
| 157 | ATA_SHIFT_PIO = 11, |
Alan Cox | 47a8659 | 2005-10-04 08:09:19 -0400 | [diff] [blame] | 158 | |
| 159 | /* Masks for port functions */ |
| 160 | ATA_PORT_PRIMARY = (1 << 0), |
| 161 | ATA_PORT_SECONDARY = (1 << 1), |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | }; |
| 163 | |
Albert Lee | 14be71f | 2005-09-27 17:36:35 +0800 | [diff] [blame] | 164 | enum hsm_task_states { |
| 165 | HSM_ST_UNKNOWN, |
| 166 | HSM_ST_IDLE, |
| 167 | HSM_ST_POLL, |
| 168 | HSM_ST_TMOUT, |
| 169 | HSM_ST, |
| 170 | HSM_ST_LAST, |
| 171 | HSM_ST_LAST_POLL, |
| 172 | HSM_ST_ERR, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | }; |
| 174 | |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 175 | enum ata_completion_errors { |
| 176 | AC_ERR_OTHER = (1 << 0), |
| 177 | AC_ERR_DEV = (1 << 1), |
| 178 | AC_ERR_ATA_BUS = (1 << 2), |
| 179 | AC_ERR_HOST_BUS = (1 << 3), |
| 180 | }; |
| 181 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | /* forward declarations */ |
| 183 | struct scsi_device; |
| 184 | struct ata_port_operations; |
| 185 | struct ata_port; |
| 186 | struct ata_queued_cmd; |
| 187 | |
| 188 | /* typedefs */ |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 189 | typedef int (*ata_qc_cb_t) (struct ata_queued_cmd *qc, unsigned int err_mask); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 190 | |
| 191 | struct ata_ioports { |
| 192 | unsigned long cmd_addr; |
| 193 | unsigned long data_addr; |
| 194 | unsigned long error_addr; |
| 195 | unsigned long feature_addr; |
| 196 | unsigned long nsect_addr; |
| 197 | unsigned long lbal_addr; |
| 198 | unsigned long lbam_addr; |
| 199 | unsigned long lbah_addr; |
| 200 | unsigned long device_addr; |
| 201 | unsigned long status_addr; |
| 202 | unsigned long command_addr; |
| 203 | unsigned long altstatus_addr; |
| 204 | unsigned long ctl_addr; |
| 205 | unsigned long bmdma_addr; |
| 206 | unsigned long scr_addr; |
| 207 | }; |
| 208 | |
| 209 | struct ata_probe_ent { |
| 210 | struct list_head node; |
| 211 | struct device *dev; |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 212 | const struct ata_port_operations *port_ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | Scsi_Host_Template *sht; |
| 214 | struct ata_ioports port[ATA_MAX_PORTS]; |
| 215 | unsigned int n_ports; |
| 216 | unsigned int hard_port_no; |
| 217 | unsigned int pio_mask; |
| 218 | unsigned int mwdma_mask; |
| 219 | unsigned int udma_mask; |
| 220 | unsigned int legacy_mode; |
| 221 | unsigned long irq; |
| 222 | unsigned int irq_flags; |
| 223 | unsigned long host_flags; |
| 224 | void __iomem *mmio_base; |
| 225 | void *private_data; |
| 226 | }; |
| 227 | |
| 228 | struct ata_host_set { |
| 229 | spinlock_t lock; |
| 230 | struct device *dev; |
| 231 | unsigned long irq; |
| 232 | void __iomem *mmio_base; |
| 233 | unsigned int n_ports; |
| 234 | void *private_data; |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 235 | const struct ata_port_operations *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | struct ata_port * ports[0]; |
| 237 | }; |
| 238 | |
| 239 | struct ata_queued_cmd { |
| 240 | struct ata_port *ap; |
| 241 | struct ata_device *dev; |
| 242 | |
| 243 | struct scsi_cmnd *scsicmd; |
| 244 | void (*scsidone)(struct scsi_cmnd *); |
| 245 | |
| 246 | struct ata_taskfile tf; |
| 247 | u8 cdb[ATAPI_CDB_LEN]; |
| 248 | |
| 249 | unsigned long flags; /* ATA_QCFLAG_xxx */ |
| 250 | unsigned int tag; |
| 251 | unsigned int n_elem; |
| 252 | |
| 253 | int dma_dir; |
| 254 | |
| 255 | unsigned int nsect; |
| 256 | unsigned int cursect; |
| 257 | |
| 258 | unsigned int nbytes; |
| 259 | unsigned int curbytes; |
| 260 | |
| 261 | unsigned int cursg; |
| 262 | unsigned int cursg_ofs; |
| 263 | |
| 264 | struct scatterlist sgent; |
| 265 | void *buf_virt; |
| 266 | |
| 267 | struct scatterlist *sg; |
| 268 | |
| 269 | ata_qc_cb_t complete_fn; |
| 270 | |
| 271 | struct completion *waiting; |
| 272 | |
| 273 | void *private_data; |
| 274 | }; |
| 275 | |
| 276 | struct ata_host_stats { |
| 277 | unsigned long unhandled_irq; |
| 278 | unsigned long idle_irq; |
| 279 | unsigned long rw_reqbuf; |
| 280 | }; |
| 281 | |
| 282 | struct ata_device { |
| 283 | u64 n_sectors; /* size of device, if ATA */ |
| 284 | unsigned long flags; /* ATA_DFLAG_xxx */ |
| 285 | unsigned int class; /* ATA_DEV_xxx */ |
| 286 | unsigned int devno; /* 0 or 1 */ |
| 287 | u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */ |
| 288 | u8 pio_mode; |
| 289 | u8 dma_mode; |
| 290 | u8 xfer_mode; |
| 291 | unsigned int xfer_shift; /* ATA_SHIFT_xxx */ |
| 292 | |
Albert Lee | 8cbd6df | 2005-10-12 15:06:27 +0800 | [diff] [blame] | 293 | unsigned int multi_count; /* sectors count for |
| 294 | READ/WRITE MULTIPLE */ |
Albert Lee | 8bf62ece | 2005-05-12 15:29:42 -0400 | [diff] [blame] | 295 | |
| 296 | /* for CHS addressing */ |
| 297 | u16 cylinders; /* Number of cylinders */ |
| 298 | u16 heads; /* Number of heads */ |
| 299 | u16 sectors; /* Number of sectors per track */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 300 | }; |
| 301 | |
| 302 | struct ata_port { |
| 303 | struct Scsi_Host *host; /* our co-allocated scsi host */ |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 304 | const struct ata_port_operations *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 305 | unsigned long flags; /* ATA_FLAG_xxx */ |
| 306 | unsigned int id; /* unique id req'd by scsi midlyr */ |
| 307 | unsigned int port_no; /* unique port #; from zero */ |
| 308 | unsigned int hard_port_no; /* hardware port #; from zero */ |
| 309 | |
| 310 | struct ata_prd *prd; /* our SG list */ |
| 311 | dma_addr_t prd_dma; /* and its DMA mapping */ |
| 312 | |
| 313 | struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */ |
| 314 | |
| 315 | u8 ctl; /* cache of ATA control register */ |
| 316 | u8 last_ctl; /* Cache last written value */ |
| 317 | unsigned int bus_state; |
| 318 | unsigned int port_state; |
| 319 | unsigned int pio_mask; |
| 320 | unsigned int mwdma_mask; |
| 321 | unsigned int udma_mask; |
| 322 | unsigned int cbl; /* cable type; ATA_CBL_xxx */ |
| 323 | unsigned int cdb_len; |
| 324 | |
| 325 | struct ata_device device[ATA_MAX_DEVICES]; |
| 326 | |
| 327 | struct ata_queued_cmd qcmd[ATA_MAX_QUEUE]; |
| 328 | unsigned long qactive; |
| 329 | unsigned int active_tag; |
| 330 | |
| 331 | struct ata_host_stats stats; |
| 332 | struct ata_host_set *host_set; |
| 333 | |
| 334 | struct work_struct packet_task; |
| 335 | |
| 336 | struct work_struct pio_task; |
Albert Lee | 14be71f | 2005-09-27 17:36:35 +0800 | [diff] [blame] | 337 | unsigned int hsm_task_state; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 338 | unsigned long pio_task_timeout; |
| 339 | |
| 340 | void *private_data; |
| 341 | }; |
| 342 | |
| 343 | struct ata_port_operations { |
| 344 | void (*port_disable) (struct ata_port *); |
| 345 | |
| 346 | void (*dev_config) (struct ata_port *, struct ata_device *); |
| 347 | |
| 348 | void (*set_piomode) (struct ata_port *, struct ata_device *); |
| 349 | void (*set_dmamode) (struct ata_port *, struct ata_device *); |
| 350 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 351 | void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 352 | void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf); |
| 353 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 354 | void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 355 | u8 (*check_status)(struct ata_port *ap); |
| 356 | u8 (*check_altstatus)(struct ata_port *ap); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 357 | void (*dev_select)(struct ata_port *ap, unsigned int device); |
| 358 | |
| 359 | void (*phy_reset) (struct ata_port *ap); |
| 360 | void (*post_set_mode) (struct ata_port *ap); |
| 361 | |
| 362 | int (*check_atapi_dma) (struct ata_queued_cmd *qc); |
| 363 | |
| 364 | void (*bmdma_setup) (struct ata_queued_cmd *qc); |
| 365 | void (*bmdma_start) (struct ata_queued_cmd *qc); |
| 366 | |
| 367 | void (*qc_prep) (struct ata_queued_cmd *qc); |
| 368 | int (*qc_issue) (struct ata_queued_cmd *qc); |
| 369 | |
| 370 | void (*eng_timeout) (struct ata_port *ap); |
| 371 | |
| 372 | irqreturn_t (*irq_handler)(int, void *, struct pt_regs *); |
| 373 | void (*irq_clear) (struct ata_port *); |
| 374 | |
| 375 | u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg); |
| 376 | void (*scr_write) (struct ata_port *ap, unsigned int sc_reg, |
| 377 | u32 val); |
| 378 | |
| 379 | int (*port_start) (struct ata_port *ap); |
| 380 | void (*port_stop) (struct ata_port *ap); |
| 381 | |
| 382 | void (*host_stop) (struct ata_host_set *host_set); |
| 383 | |
Alan Cox | b73fc89 | 2005-08-26 16:03:19 +0100 | [diff] [blame] | 384 | void (*bmdma_stop) (struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 385 | u8 (*bmdma_status) (struct ata_port *ap); |
| 386 | }; |
| 387 | |
| 388 | struct ata_port_info { |
| 389 | Scsi_Host_Template *sht; |
| 390 | unsigned long host_flags; |
| 391 | unsigned long pio_mask; |
| 392 | unsigned long mwdma_mask; |
| 393 | unsigned long udma_mask; |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 394 | const struct ata_port_operations *port_ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 395 | }; |
| 396 | |
Alan Cox | 452503f | 2005-10-21 19:01:32 -0400 | [diff] [blame] | 397 | struct ata_timing { |
| 398 | unsigned short mode; /* ATA mode */ |
| 399 | unsigned short setup; /* t1 */ |
| 400 | unsigned short act8b; /* t2 for 8-bit I/O */ |
| 401 | unsigned short rec8b; /* t2i for 8-bit I/O */ |
| 402 | unsigned short cyc8b; /* t0 for 8-bit I/O */ |
| 403 | unsigned short active; /* t2 or tD */ |
| 404 | unsigned short recover; /* t2i or tK */ |
| 405 | unsigned short cycle; /* t0 */ |
| 406 | unsigned short udma; /* t2CYCTYP/2 */ |
| 407 | }; |
| 408 | |
| 409 | #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] | 410 | |
| 411 | extern void ata_port_probe(struct ata_port *); |
| 412 | extern void __sata_phy_reset(struct ata_port *ap); |
| 413 | extern void sata_phy_reset(struct ata_port *ap); |
| 414 | extern void ata_bus_reset(struct ata_port *ap); |
| 415 | extern void ata_port_disable(struct ata_port *); |
| 416 | extern void ata_std_ports(struct ata_ioports *ioaddr); |
| 417 | #ifdef CONFIG_PCI |
| 418 | extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, |
| 419 | unsigned int n_ports); |
| 420 | extern void ata_pci_remove_one (struct pci_dev *pdev); |
| 421 | #endif /* CONFIG_PCI */ |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 422 | extern int ata_device_add(const struct ata_probe_ent *ent); |
Alan Cox | 17b1445 | 2005-09-15 15:44:00 +0100 | [diff] [blame] | 423 | extern void ata_host_set_remove(struct ata_host_set *host_set); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 424 | extern int ata_scsi_detect(Scsi_Host_Template *sht); |
| 425 | extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg); |
| 426 | extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *)); |
| 427 | extern int ata_scsi_error(struct Scsi_Host *host); |
| 428 | extern int ata_scsi_release(struct Scsi_Host *host); |
| 429 | extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc); |
Jeff Garzik | 67846b3 | 2005-10-05 02:58:32 -0400 | [diff] [blame] | 430 | extern int ata_ratelimit(void); |
| 431 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 432 | /* |
| 433 | * Default driver ops implementations |
| 434 | */ |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 435 | 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] | 436 | 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] | 437 | extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp); |
| 438 | 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] | 439 | extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device); |
| 440 | extern void ata_std_dev_select (struct ata_port *ap, unsigned int device); |
| 441 | extern u8 ata_check_status(struct ata_port *ap); |
| 442 | extern u8 ata_altstatus(struct ata_port *ap); |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 443 | extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 444 | extern int ata_port_start (struct ata_port *ap); |
| 445 | extern void ata_port_stop (struct ata_port *ap); |
Jeff Garzik | aa8f0dc | 2005-05-26 21:54:27 -0400 | [diff] [blame] | 446 | extern void ata_host_stop (struct ata_host_set *host_set); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 447 | extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs); |
| 448 | extern void ata_qc_prep(struct ata_queued_cmd *qc); |
| 449 | extern int ata_qc_issue_prot(struct ata_queued_cmd *qc); |
| 450 | extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf, |
| 451 | unsigned int buflen); |
| 452 | extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg, |
| 453 | unsigned int n_elem); |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 454 | extern unsigned int ata_dev_classify(const struct ata_taskfile *tf); |
| 455 | extern void ata_dev_id_string(const u16 *id, unsigned char *s, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 456 | unsigned int ofs, unsigned int len); |
Brad Campbell | 6f2f381 | 2005-05-12 15:07:47 -0400 | [diff] [blame] | 457 | extern void ata_dev_config(struct ata_port *ap, unsigned int i); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 458 | extern void ata_bmdma_setup (struct ata_queued_cmd *qc); |
| 459 | extern void ata_bmdma_start (struct ata_queued_cmd *qc); |
Alan Cox | b73fc89 | 2005-08-26 16:03:19 +0100 | [diff] [blame] | 460 | extern void ata_bmdma_stop(struct ata_queued_cmd *qc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 461 | extern u8 ata_bmdma_status(struct ata_port *ap); |
| 462 | extern void ata_bmdma_irq_clear(struct ata_port *ap); |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 463 | extern void ata_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 464 | extern void ata_eng_timeout(struct ata_port *ap); |
| 465 | extern void ata_scsi_simulate(u16 *id, struct scsi_cmnd *cmd, |
| 466 | void (*done)(struct scsi_cmnd *)); |
| 467 | extern int ata_std_bios_param(struct scsi_device *sdev, |
| 468 | struct block_device *bdev, |
| 469 | sector_t capacity, int geom[]); |
| 470 | extern int ata_scsi_slave_config(struct scsi_device *sdev); |
| 471 | |
Alan Cox | 452503f | 2005-10-21 19:01:32 -0400 | [diff] [blame] | 472 | /* |
| 473 | * Timing helpers |
| 474 | */ |
| 475 | extern int ata_timing_compute(struct ata_device *, unsigned short, |
| 476 | struct ata_timing *, int, int); |
| 477 | extern void ata_timing_merge(const struct ata_timing *, |
| 478 | const struct ata_timing *, struct ata_timing *, |
| 479 | unsigned int); |
| 480 | |
| 481 | enum { |
| 482 | ATA_TIMING_SETUP = (1 << 0), |
| 483 | ATA_TIMING_ACT8B = (1 << 1), |
| 484 | ATA_TIMING_REC8B = (1 << 2), |
| 485 | ATA_TIMING_CYC8B = (1 << 3), |
| 486 | ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B | |
| 487 | ATA_TIMING_CYC8B, |
| 488 | ATA_TIMING_ACTIVE = (1 << 4), |
| 489 | ATA_TIMING_RECOVER = (1 << 5), |
| 490 | ATA_TIMING_CYCLE = (1 << 6), |
| 491 | ATA_TIMING_UDMA = (1 << 7), |
| 492 | ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B | |
| 493 | ATA_TIMING_REC8B | ATA_TIMING_CYC8B | |
| 494 | ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER | |
| 495 | ATA_TIMING_CYCLE | ATA_TIMING_UDMA, |
| 496 | }; |
| 497 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 498 | |
| 499 | #ifdef CONFIG_PCI |
| 500 | struct pci_bits { |
| 501 | unsigned int reg; /* PCI config register to read */ |
| 502 | unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */ |
| 503 | unsigned long mask; |
| 504 | unsigned long val; |
| 505 | }; |
| 506 | |
Jeff Garzik | 374b187 | 2005-08-30 05:42:52 -0400 | [diff] [blame] | 507 | extern void ata_pci_host_stop (struct ata_host_set *host_set); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 508 | extern struct ata_probe_ent * |
Alan Cox | 47a8659 | 2005-10-04 08:09:19 -0400 | [diff] [blame] | 509 | 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] | 510 | extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 511 | |
| 512 | #endif /* CONFIG_PCI */ |
| 513 | |
| 514 | |
| 515 | static inline unsigned int ata_tag_valid(unsigned int tag) |
| 516 | { |
| 517 | return (tag < ATA_MAX_QUEUE) ? 1 : 0; |
| 518 | } |
| 519 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 520 | static inline unsigned int ata_dev_present(const struct ata_device *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 521 | { |
| 522 | return ((dev->class == ATA_DEV_ATA) || |
| 523 | (dev->class == ATA_DEV_ATAPI)); |
| 524 | } |
| 525 | |
| 526 | static inline u8 ata_chk_status(struct ata_port *ap) |
| 527 | { |
| 528 | return ap->ops->check_status(ap); |
| 529 | } |
| 530 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 531 | |
| 532 | /** |
| 533 | * ata_pause - Flush writes and pause 400 nanoseconds. |
| 534 | * @ap: Port to wait for. |
| 535 | * |
| 536 | * LOCKING: |
| 537 | * Inherited from caller. |
| 538 | */ |
| 539 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 540 | static inline void ata_pause(struct ata_port *ap) |
| 541 | { |
| 542 | ata_altstatus(ap); |
| 543 | ndelay(400); |
| 544 | } |
| 545 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 546 | |
| 547 | /** |
| 548 | * ata_busy_wait - Wait for a port status register |
| 549 | * @ap: Port to wait for. |
| 550 | * |
| 551 | * Waits up to max*10 microseconds for the selected bits in the port's |
| 552 | * status register to be cleared. |
| 553 | * Returns final value of status register. |
| 554 | * |
| 555 | * LOCKING: |
| 556 | * Inherited from caller. |
| 557 | */ |
| 558 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 559 | static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits, |
| 560 | unsigned int max) |
| 561 | { |
| 562 | u8 status; |
| 563 | |
| 564 | do { |
| 565 | udelay(10); |
| 566 | status = ata_chk_status(ap); |
| 567 | max--; |
| 568 | } while ((status & bits) && (max > 0)); |
| 569 | |
| 570 | return status; |
| 571 | } |
| 572 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 573 | |
| 574 | /** |
| 575 | * ata_wait_idle - Wait for a port to be idle. |
| 576 | * @ap: Port to wait for. |
| 577 | * |
| 578 | * Waits up to 10ms for port's BUSY and DRQ signals to clear. |
| 579 | * Returns final value of status register. |
| 580 | * |
| 581 | * LOCKING: |
| 582 | * Inherited from caller. |
| 583 | */ |
| 584 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 585 | static inline u8 ata_wait_idle(struct ata_port *ap) |
| 586 | { |
| 587 | u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000); |
| 588 | |
| 589 | if (status & (ATA_BUSY | ATA_DRQ)) { |
| 590 | unsigned long l = ap->ioaddr.status_addr; |
| 591 | printk(KERN_WARNING |
| 592 | "ATA: abnormal status 0x%X on port 0x%lX\n", |
| 593 | status, l); |
| 594 | } |
| 595 | |
| 596 | return status; |
| 597 | } |
| 598 | |
| 599 | static inline void ata_qc_set_polling(struct ata_queued_cmd *qc) |
| 600 | { |
| 601 | qc->tf.ctl |= ATA_NIEN; |
| 602 | } |
| 603 | |
| 604 | static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap, |
| 605 | unsigned int tag) |
| 606 | { |
| 607 | if (likely(ata_tag_valid(tag))) |
| 608 | return &ap->qcmd[tag]; |
| 609 | return NULL; |
| 610 | } |
| 611 | |
| 612 | static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device) |
| 613 | { |
| 614 | memset(tf, 0, sizeof(*tf)); |
| 615 | |
| 616 | tf->ctl = ap->ctl; |
| 617 | if (device == 0) |
| 618 | tf->device = ATA_DEVICE_OBS; |
| 619 | else |
| 620 | tf->device = ATA_DEVICE_OBS | ATA_DEV1; |
| 621 | } |
| 622 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 623 | |
| 624 | /** |
| 625 | * ata_irq_on - Enable interrupts on a port. |
| 626 | * @ap: Port on which interrupts are enabled. |
| 627 | * |
| 628 | * Enable interrupts on a legacy IDE device using MMIO or PIO, |
| 629 | * wait for idle, clear any pending interrupts. |
| 630 | * |
| 631 | * LOCKING: |
| 632 | * Inherited from caller. |
| 633 | */ |
| 634 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 635 | static inline u8 ata_irq_on(struct ata_port *ap) |
| 636 | { |
| 637 | struct ata_ioports *ioaddr = &ap->ioaddr; |
| 638 | u8 tmp; |
| 639 | |
| 640 | ap->ctl &= ~ATA_NIEN; |
| 641 | ap->last_ctl = ap->ctl; |
| 642 | |
| 643 | if (ap->flags & ATA_FLAG_MMIO) |
| 644 | writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr); |
| 645 | else |
| 646 | outb(ap->ctl, ioaddr->ctl_addr); |
| 647 | tmp = ata_wait_idle(ap); |
| 648 | |
| 649 | ap->ops->irq_clear(ap); |
| 650 | |
| 651 | return tmp; |
| 652 | } |
| 653 | |
Edward Falk | 0baab86 | 2005-06-02 18:17:13 -0400 | [diff] [blame] | 654 | |
| 655 | /** |
| 656 | * ata_irq_ack - Acknowledge a device interrupt. |
| 657 | * @ap: Port on which interrupts are enabled. |
| 658 | * |
| 659 | * Wait up to 10 ms for legacy IDE device to become idle (BUSY |
| 660 | * or BUSY+DRQ clear). Obtain dma status and port status from |
| 661 | * device. Clear the interrupt. Return port status. |
| 662 | * |
| 663 | * LOCKING: |
| 664 | */ |
| 665 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 666 | static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq) |
| 667 | { |
| 668 | unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY; |
| 669 | u8 host_stat, post_stat, status; |
| 670 | |
| 671 | status = ata_busy_wait(ap, bits, 1000); |
| 672 | if (status & bits) |
| 673 | DPRINTK("abnormal status 0x%X\n", status); |
| 674 | |
| 675 | /* get controller status; clear intr, err bits */ |
| 676 | if (ap->flags & ATA_FLAG_MMIO) { |
| 677 | void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr; |
| 678 | host_stat = readb(mmio + ATA_DMA_STATUS); |
| 679 | writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, |
| 680 | mmio + ATA_DMA_STATUS); |
| 681 | |
| 682 | post_stat = readb(mmio + ATA_DMA_STATUS); |
| 683 | } else { |
| 684 | host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); |
| 685 | outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR, |
| 686 | ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); |
| 687 | |
| 688 | post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS); |
| 689 | } |
| 690 | |
| 691 | VPRINTK("irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n", |
| 692 | host_stat, post_stat, status); |
| 693 | |
| 694 | return status; |
| 695 | } |
| 696 | |
| 697 | static inline u32 scr_read(struct ata_port *ap, unsigned int reg) |
| 698 | { |
| 699 | return ap->ops->scr_read(ap, reg); |
| 700 | } |
| 701 | |
| 702 | static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val) |
| 703 | { |
| 704 | ap->ops->scr_write(ap, reg, val); |
| 705 | } |
| 706 | |
Jeff Garzik | 8a60a07 | 2005-07-31 13:13:24 -0400 | [diff] [blame] | 707 | static inline void scr_write_flush(struct ata_port *ap, unsigned int reg, |
Brett Russ | cdcca89e | 2005-03-28 15:10:27 -0500 | [diff] [blame] | 708 | u32 val) |
| 709 | { |
| 710 | ap->ops->scr_write(ap, reg, val); |
| 711 | (void) ap->ops->scr_read(ap, reg); |
| 712 | } |
| 713 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 714 | static inline unsigned int sata_dev_present(struct ata_port *ap) |
| 715 | { |
| 716 | return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0; |
| 717 | } |
| 718 | |
Jeff Garzik | 057ace5 | 2005-10-22 14:27:05 -0400 | [diff] [blame] | 719 | static inline int ata_try_flush_cache(const struct ata_device *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 720 | { |
| 721 | return ata_id_wcache_enabled(dev->id) || |
| 722 | ata_id_has_flush(dev->id) || |
| 723 | ata_id_has_flush_ext(dev->id); |
| 724 | } |
| 725 | |
Jeff Garzik | a7dac44 | 2005-10-30 04:44:42 -0500 | [diff] [blame] | 726 | static inline unsigned int ac_err_mask(u8 status) |
| 727 | { |
| 728 | if (status & ATA_BUSY) |
| 729 | return AC_ERR_ATA_BUS; |
| 730 | if (status & (ATA_ERR | ATA_DF)) |
| 731 | return AC_ERR_DEV; |
| 732 | return 0; |
| 733 | } |
| 734 | |
| 735 | static inline unsigned int __ac_err_mask(u8 status) |
| 736 | { |
| 737 | unsigned int mask = ac_err_mask(status); |
| 738 | if (mask == 0) |
| 739 | return AC_ERR_OTHER; |
| 740 | return mask; |
| 741 | } |
| 742 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 743 | #endif /* __LINUX_LIBATA_H__ */ |