include/linux/libata.h

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