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