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