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