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