SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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: to be removed as soon as all the drivers are
  39  * converted to the new debugging mechanism
  40  */
  41 #undef ATA_DEBUG                /* debugging output */
  42 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
  43 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
  44 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
  45 #undef ATA_ENABLE_PATA          /* define to enable PATA support in some
  46                                  * low-level drivers */
  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 /* NEW: debug levels */
  65 #define HAVE_LIBATA_MSG 1
  66
  67 enum {
  68         ATA_MSG_DRV     = 0x0001,
  69         ATA_MSG_INFO    = 0x0002,
  70         ATA_MSG_PROBE   = 0x0004,
  71         ATA_MSG_WARN    = 0x0008,
  72         ATA_MSG_MALLOC  = 0x0010,
  73         ATA_MSG_CTL     = 0x0020,
  74         ATA_MSG_INTR    = 0x0040,
  75         ATA_MSG_ERR     = 0x0080,
  76 };
  77
  78 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
  79 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
  80 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
  81 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
  82 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  83 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
  84 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
  85 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
  86
  87 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  88 {
  89         if (dval < 0 || dval >= (sizeof(u32) * 8))
  90                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  91         if (!dval)
  92                 return 0;
  93         return (1 << dval) - 1;
  94 }
  95
  96 /* defines only for the constants which don't work well as enums */
  97 #define ATA_TAG_POISON          0xfafbfcfdU
  98
  99 /* move to PCI layer? */
 100 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
 101 {
 102         return &pdev->dev;
 103 }
 104
 105 enum {
 106         /* various global constants */
 107         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
 108         ATA_MAX_PORTS           = 8,
 109         ATA_DEF_QUEUE           = 1,
 110         ATA_MAX_QUEUE           = 1,
 111         ATA_MAX_SECTORS         = 200,  /* FIXME */
 112         ATA_MAX_BUS             = 2,
 113         ATA_DEF_BUSY_WAIT       = 10000,
 114         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
 115
 116         ATA_SHT_EMULATED        = 1,
 117         ATA_SHT_CMD_PER_LUN     = 1,
 118         ATA_SHT_THIS_ID         = -1,
 119         ATA_SHT_USE_CLUSTERING  = 1,
 120
 121         /* struct ata_device stuff */
 122         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
 123         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
 124         ATA_DFLAG_CFG_MASK      = (1 << 8) - 1,
 125
 126         ATA_DFLAG_PIO           = (1 << 8), /* device currently in PIO mode */
 127
 128         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
 129         ATA_DEV_ATA             = 1,    /* ATA device */
 130         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
 131         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
 132         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
 133         ATA_DEV_NONE            = 5,    /* no device */
 134
 135         /* struct ata_port flags */
 136         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
 137                                             /* (doesn't imply presence) */
 138         ATA_FLAG_SATA           = (1 << 1),
 139         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
 140         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
 141         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
 142         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
 143         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
 144         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
 145         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
 146         ATA_FLAG_IRQ_MASK       = (1 << 9), /* Mask IRQ in PIO xfers */
 147
 148         ATA_FLAG_NOINTR         = (1 << 16), /* FIXME: Remove this once
 149                                               * proper HSM is in place. */
 150         ATA_FLAG_DEBUGMSG       = (1 << 17),
 151         ATA_FLAG_FLUSH_PORT_TASK = (1 << 18), /* flush port task */
 152
 153         ATA_FLAG_DISABLED       = (1 << 19), /* port is disabled, ignore it */
 154         ATA_FLAG_SUSPENDED      = (1 << 20), /* port is suspended */
 155
 156         /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
 157
 158         /* struct ata_queued_cmd flags */
 159         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
 160         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
 161         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
 162         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
 163         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
 164         ATA_QCFLAG_EH_SCHEDULED = (1 << 4), /* EH scheduled */
 165
 166         /* host set flags */
 167         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host_set only */
 168
 169         /* various lengths of time */
 170         ATA_TMOUT_PIO           = 30 * HZ,
 171         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
 172         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
 173         ATA_TMOUT_CDB           = 30 * HZ,
 174         ATA_TMOUT_CDB_QUICK     = 5 * HZ,
 175         ATA_TMOUT_INTERNAL      = 30 * HZ,
 176         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
 177
 178         /* ATA bus states */
 179         BUS_UNKNOWN             = 0,
 180         BUS_DMA                 = 1,
 181         BUS_IDLE                = 2,
 182         BUS_NOINTR              = 3,
 183         BUS_NODATA              = 4,
 184         BUS_TIMER               = 5,
 185         BUS_PIO                 = 6,
 186         BUS_EDD                 = 7,
 187         BUS_IDENTIFY            = 8,
 188         BUS_PACKET              = 9,
 189
 190         /* SATA port states */
 191         PORT_UNKNOWN            = 0,
 192         PORT_ENABLED            = 1,
 193         PORT_DISABLED           = 2,
 194
 195         /* encoding various smaller bitmaps into a single
 196          * unsigned int bitmap
 197          */
 198         ATA_BITS_PIO            = 5,
 199         ATA_BITS_MWDMA          = 3,
 200         ATA_BITS_UDMA           = 8,
 201
 202         ATA_SHIFT_PIO           = 0,
 203         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
 204         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
 205
 206         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
 207         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
 208         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
 209
 210         /* size of buffer to pad xfers ending on unaligned boundaries */
 211         ATA_DMA_PAD_SZ          = 4,
 212         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
 213
 214         /* masks for port functions */
 215         ATA_PORT_PRIMARY        = (1 << 0),
 216         ATA_PORT_SECONDARY      = (1 << 1),
 217
 218         /* how hard are we gonna try to probe/recover devices */
 219         ATA_PROBE_MAX_TRIES     = 3,
 220 };
 221
 222 enum hsm_task_states {
 223         HSM_ST_UNKNOWN,
 224         HSM_ST_IDLE,
 225         HSM_ST_POLL,
 226         HSM_ST_TMOUT,
 227         HSM_ST,
 228         HSM_ST_LAST,
 229         HSM_ST_LAST_POLL,
 230         HSM_ST_ERR,
 231 };
 232
 233 enum ata_completion_errors {
 234         AC_ERR_DEV              = (1 << 0), /* device reported error */
 235         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
 236         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
 237         AC_ERR_MEDIA            = (1 << 3), /* media error */
 238         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
 239         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
 240         AC_ERR_SYSTEM           = (1 << 6), /* system error */
 241         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
 242         AC_ERR_OTHER            = (1 << 8), /* unknown */
 243 };
 244
 245 /* forward declarations */
 246 struct scsi_device;
 247 struct ata_port_operations;
 248 struct ata_port;
 249 struct ata_queued_cmd;
 250
 251 /* typedefs */
 252 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 253 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
 254 typedef int (*ata_reset_fn_t)(struct ata_port *, int, unsigned int *);
 255 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
 256
 257 struct ata_ioports {
 258         unsigned long           cmd_addr;
 259         unsigned long           data_addr;
 260         unsigned long           error_addr;
 261         unsigned long           feature_addr;
 262         unsigned long           nsect_addr;
 263         unsigned long           lbal_addr;
 264         unsigned long           lbam_addr;
 265         unsigned long           lbah_addr;
 266         unsigned long           device_addr;
 267         unsigned long           status_addr;
 268         unsigned long           command_addr;
 269         unsigned long           altstatus_addr;
 270         unsigned long           ctl_addr;
 271         unsigned long           bmdma_addr;
 272         unsigned long           scr_addr;
 273 };
 274
 275 struct ata_probe_ent {
 276         struct list_head        node;
 277         struct device           *dev;
 278         const struct ata_port_operations *port_ops;
 279         struct scsi_host_template *sht;
 280         struct ata_ioports      port[ATA_MAX_PORTS];
 281         unsigned int            n_ports;
 282         unsigned int            hard_port_no;
 283         unsigned int            pio_mask;
 284         unsigned int            mwdma_mask;
 285         unsigned int            udma_mask;
 286         unsigned int            legacy_mode;
 287         unsigned long           irq;
 288         unsigned int            irq_flags;
 289         unsigned long           host_flags;
 290         unsigned long           host_set_flags;
 291         void __iomem            *mmio_base;
 292         void                    *private_data;
 293 };
 294
 295 struct ata_host_set {
 296         spinlock_t              lock;
 297         struct device           *dev;
 298         unsigned long           irq;
 299         void __iomem            *mmio_base;
 300         unsigned int            n_ports;
 301         void                    *private_data;
 302         const struct ata_port_operations *ops;
 303         unsigned long           flags;
 304         int                     simplex_claimed;        /* Keep seperate in case we
 305                                                            ever need to do this locked */
 306         struct ata_port *       ports[0];
 307 };
 308
 309 struct ata_queued_cmd {
 310         struct ata_port         *ap;
 311         struct ata_device       *dev;
 312
 313         struct scsi_cmnd        *scsicmd;
 314         void                    (*scsidone)(struct scsi_cmnd *);
 315
 316         struct ata_taskfile     tf;
 317         u8                      cdb[ATAPI_CDB_LEN];
 318
 319         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 320         unsigned int            tag;
 321         unsigned int            n_elem;
 322         unsigned int            orig_n_elem;
 323
 324         int                     dma_dir;
 325
 326         unsigned int            pad_len;
 327
 328         unsigned int            nsect;
 329         unsigned int            cursect;
 330
 331         unsigned int            nbytes;
 332         unsigned int            curbytes;
 333
 334         unsigned int            cursg;
 335         unsigned int            cursg_ofs;
 336
 337         struct scatterlist      sgent;
 338         struct scatterlist      pad_sgent;
 339         void                    *buf_virt;
 340
 341         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
 342         struct scatterlist      *__sg;
 343
 344         unsigned int            err_mask;
 345
 346         ata_qc_cb_t             complete_fn;
 347
 348         void                    *private_data;
 349 };
 350
 351 struct ata_host_stats {
 352         unsigned long           unhandled_irq;
 353         unsigned long           idle_irq;
 354         unsigned long           rw_reqbuf;
 355 };
 356
 357 struct ata_device {
 358         u64                     n_sectors;      /* size of device, if ATA */
 359         unsigned long           flags;          /* ATA_DFLAG_xxx */
 360         unsigned int            class;          /* ATA_DEV_xxx */
 361         unsigned int            devno;          /* 0 or 1 */
 362         u16                     *id;            /* IDENTIFY xxx DEVICE data */
 363         u8                      pio_mode;
 364         u8                      dma_mode;
 365         u8                      xfer_mode;
 366         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 367
 368         unsigned int            multi_count;    /* sectors count for
 369                                                    READ/WRITE MULTIPLE */
 370         unsigned int            max_sectors;    /* per-device max sectors */
 371         unsigned int            cdb_len;
 372
 373         /* per-dev xfer mask */
 374         unsigned int            pio_mask;
 375         unsigned int            mwdma_mask;
 376         unsigned int            udma_mask;
 377
 378         /* for CHS addressing */
 379         u16                     cylinders;      /* Number of cylinders */
 380         u16                     heads;          /* Number of heads */
 381         u16                     sectors;        /* Number of sectors per track */
 382 };
 383
 384 struct ata_port {
 385         struct Scsi_Host        *host;  /* our co-allocated scsi host */
 386         const struct ata_port_operations *ops;
 387         unsigned long           flags;  /* ATA_FLAG_xxx */
 388         unsigned int            id;     /* unique id req'd by scsi midlyr */
 389         unsigned int            port_no; /* unique port #; from zero */
 390         unsigned int            hard_port_no;   /* hardware port #; from zero */
 391
 392         struct ata_prd          *prd;    /* our SG list */
 393         dma_addr_t              prd_dma; /* and its DMA mapping */
 394
 395         void                    *pad;   /* array of DMA pad buffers */
 396         dma_addr_t              pad_dma;
 397
 398         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 399
 400         u8                      ctl;    /* cache of ATA control register */
 401         u8                      last_ctl;       /* Cache last written value */
 402         unsigned int            pio_mask;
 403         unsigned int            mwdma_mask;
 404         unsigned int            udma_mask;
 405         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 406         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
 407
 408         struct ata_device       device[ATA_MAX_DEVICES];
 409
 410         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 411         unsigned long           qactive;
 412         unsigned int            active_tag;
 413
 414         struct ata_host_stats   stats;
 415         struct ata_host_set     *host_set;
 416         struct device           *dev;
 417
 418         struct work_struct      port_task;
 419
 420         unsigned int            hsm_task_state;
 421         unsigned long           pio_task_timeout;
 422
 423         u32                     msg_enable;
 424         struct list_head        eh_done_q;
 425
 426         void                    *private_data;
 427 };
 428
 429 struct ata_port_operations {
 430         void (*port_disable) (struct ata_port *);
 431
 432         void (*dev_config) (struct ata_port *, struct ata_device *);
 433
 434         void (*set_piomode) (struct ata_port *, struct ata_device *);
 435         void (*set_dmamode) (struct ata_port *, struct ata_device *);
 436         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
 437
 438         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
 439         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
 440
 441         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
 442         u8   (*check_status)(struct ata_port *ap);
 443         u8   (*check_altstatus)(struct ata_port *ap);
 444         void (*dev_select)(struct ata_port *ap, unsigned int device);
 445
 446         void (*phy_reset) (struct ata_port *ap); /* obsolete */
 447         void (*set_mode) (struct ata_port *ap);
 448         int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
 449
 450         void (*post_set_mode) (struct ata_port *ap);
 451
 452         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
 453
 454         void (*bmdma_setup) (struct ata_queued_cmd *qc);
 455         void (*bmdma_start) (struct ata_queued_cmd *qc);
 456
 457         void (*qc_prep) (struct ata_queued_cmd *qc);
 458         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
 459
 460         void (*eng_timeout) (struct ata_port *ap);
 461
 462         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
 463         void (*irq_clear) (struct ata_port *);
 464
 465         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
 466         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
 467                            u32 val);
 468
 469         int (*port_start) (struct ata_port *ap);
 470         void (*port_stop) (struct ata_port *ap);
 471
 472         void (*host_stop) (struct ata_host_set *host_set);
 473
 474         void (*bmdma_stop) (struct ata_queued_cmd *qc);
 475         u8   (*bmdma_status) (struct ata_port *ap);
 476 };
 477
 478 struct ata_port_info {
 479         struct scsi_host_template       *sht;
 480         unsigned long           host_flags;
 481         unsigned long           pio_mask;
 482         unsigned long           mwdma_mask;
 483         unsigned long           udma_mask;
 484         const struct ata_port_operations *port_ops;
 485         void                    *private_data;
 486 };
 487
 488 struct ata_timing {
 489         unsigned short mode;            /* ATA mode */
 490         unsigned short setup;           /* t1 */
 491         unsigned short act8b;           /* t2 for 8-bit I/O */
 492         unsigned short rec8b;           /* t2i for 8-bit I/O */
 493         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 494         unsigned short active;          /* t2 or tD */
 495         unsigned short recover;         /* t2i or tK */
 496         unsigned short cycle;           /* t0 */
 497         unsigned short udma;            /* t2CYCTYP/2 */
 498 };
 499
 500 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
 501
 502 extern void ata_port_probe(struct ata_port *);
 503 extern void __sata_phy_reset(struct ata_port *ap);
 504 extern void sata_phy_reset(struct ata_port *ap);
 505 extern void ata_bus_reset(struct ata_port *ap);
 506 extern int ata_drive_probe_reset(struct ata_port *ap,
 507                         ata_probeinit_fn_t probeinit,
 508                         ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 509                         ata_postreset_fn_t postreset, unsigned int *classes);
 510 extern void ata_std_probeinit(struct ata_port *ap);
 511 extern int ata_std_softreset(struct ata_port *ap, int verbose,
 512                              unsigned int *classes);
 513 extern int sata_std_hardreset(struct ata_port *ap, int verbose,
 514                               unsigned int *class);
 515 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
 516 extern int ata_dev_revalidate(struct ata_port *ap, struct ata_device *dev,
 517                               int post_reset);
 518 extern void ata_port_disable(struct ata_port *);
 519 extern void ata_std_ports(struct ata_ioports *ioaddr);
 520 #ifdef CONFIG_PCI
 521 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
 522                              unsigned int n_ports);
 523 extern void ata_pci_remove_one (struct pci_dev *pdev);
 524 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
 525 extern int ata_pci_device_resume(struct pci_dev *pdev);
 526 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
 527 #endif /* CONFIG_PCI */
 528 extern int ata_device_add(const struct ata_probe_ent *ent);
 529 extern void ata_host_set_remove(struct ata_host_set *host_set);
 530 extern int ata_scsi_detect(struct scsi_host_template *sht);
 531 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
 532 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
 533 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
 534 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
 535 extern int ata_scsi_release(struct Scsi_Host *host);
 536 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
 537 extern int ata_scsi_device_resume(struct scsi_device *);
 538 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
 539 extern int ata_device_resume(struct ata_port *, struct ata_device *);
 540 extern int ata_device_suspend(struct ata_port *, struct ata_device *, pm_message_t state);
 541 extern int ata_ratelimit(void);
 542 extern unsigned int ata_busy_sleep(struct ata_port *ap,
 543                                    unsigned long timeout_pat,
 544                                    unsigned long timeout);
 545 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
 546                                 void *data, unsigned long delay);
 547
 548 /*
 549  * Default driver ops implementations
 550  */
 551 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
 552 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
 553 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
 554 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
 555 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
 556 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
 557 extern u8 ata_check_status(struct ata_port *ap);
 558 extern u8 ata_altstatus(struct ata_port *ap);
 559 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
 560 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
 561 extern int ata_port_start (struct ata_port *ap);
 562 extern void ata_port_stop (struct ata_port *ap);
 563 extern void ata_host_stop (struct ata_host_set *host_set);
 564 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
 565 extern void ata_qc_prep(struct ata_queued_cmd *qc);
 566 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
 567 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
 568 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
 569                 unsigned int buflen);
 570 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
 571                  unsigned int n_elem);
 572 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
 573 extern void ata_id_string(const u16 *id, unsigned char *s,
 574                           unsigned int ofs, unsigned int len);
 575 extern void ata_id_c_string(const u16 *id, unsigned char *s,
 576                             unsigned int ofs, unsigned int len);
 577 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
 578 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
 579 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
 580 extern u8   ata_bmdma_status(struct ata_port *ap);
 581 extern void ata_bmdma_irq_clear(struct ata_port *ap);
 582 extern void __ata_qc_complete(struct ata_queued_cmd *qc);
 583 extern void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
 584                               struct scsi_cmnd *cmd,
 585                               void (*done)(struct scsi_cmnd *));
 586 extern int ata_std_bios_param(struct scsi_device *sdev,
 587                               struct block_device *bdev,
 588                               sector_t capacity, int geom[]);
 589 extern int ata_scsi_slave_config(struct scsi_device *sdev);
 590 extern struct ata_device *ata_dev_pair(struct ata_port *ap,
 591                                        struct ata_device *adev);
 592
 593 /*
 594  * Timing helpers
 595  */
 596
 597 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
 598 extern int ata_timing_compute(struct ata_device *, unsigned short,
 599                               struct ata_timing *, int, int);
 600 extern void ata_timing_merge(const struct ata_timing *,
 601                              const struct ata_timing *, struct ata_timing *,
 602                              unsigned int);
 603
 604 enum {
 605         ATA_TIMING_SETUP        = (1 << 0),
 606         ATA_TIMING_ACT8B        = (1 << 1),
 607         ATA_TIMING_REC8B        = (1 << 2),
 608         ATA_TIMING_CYC8B        = (1 << 3),
 609         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 610                                   ATA_TIMING_CYC8B,
 611         ATA_TIMING_ACTIVE       = (1 << 4),
 612         ATA_TIMING_RECOVER      = (1 << 5),
 613         ATA_TIMING_CYCLE        = (1 << 6),
 614         ATA_TIMING_UDMA         = (1 << 7),
 615         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 616                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 617                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 618                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
 619 };
 620
 621
 622 #ifdef CONFIG_PCI
 623 struct pci_bits {
 624         unsigned int            reg;    /* PCI config register to read */
 625         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
 626         unsigned long           mask;
 627         unsigned long           val;
 628 };
 629
 630 extern void ata_pci_host_stop (struct ata_host_set *host_set);
 631 extern struct ata_probe_ent *
 632 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
 633 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
 634 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
 635 #endif /* CONFIG_PCI */
 636
 637 /*
 638  * EH
 639  */
 640 extern void ata_eng_timeout(struct ata_port *ap);
 641 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
 642 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
 643
 644
 645 static inline int
 646 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
 647 {
 648         if (sg == &qc->pad_sgent)
 649                 return 1;
 650         if (qc->pad_len)
 651                 return 0;
 652         if (((sg - qc->__sg) + 1) == qc->n_elem)
 653                 return 1;
 654         return 0;
 655 }
 656
 657 static inline struct scatterlist *
 658 ata_qc_first_sg(struct ata_queued_cmd *qc)
 659 {
 660         if (qc->n_elem)
 661                 return qc->__sg;
 662         if (qc->pad_len)
 663                 return &qc->pad_sgent;
 664         return NULL;
 665 }
 666
 667 static inline struct scatterlist *
 668 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
 669 {
 670         if (sg == &qc->pad_sgent)
 671                 return NULL;
 672         if (++sg - qc->__sg < qc->n_elem)
 673                 return sg;
 674         if (qc->pad_len)
 675                 return &qc->pad_sgent;
 676         return NULL;
 677 }
 678
 679 #define ata_for_each_sg(sg, qc) \
 680         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
 681
 682 static inline unsigned int ata_tag_valid(unsigned int tag)
 683 {
 684         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
 685 }
 686
 687 static inline unsigned int ata_class_enabled(unsigned int class)
 688 {
 689         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
 690 }
 691
 692 static inline unsigned int ata_class_disabled(unsigned int class)
 693 {
 694         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
 695 }
 696
 697 static inline unsigned int ata_class_absent(unsigned int class)
 698 {
 699         return !ata_class_enabled(class) && !ata_class_disabled(class);
 700 }
 701
 702 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
 703 {
 704         return ata_class_enabled(dev->class);
 705 }
 706
 707 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
 708 {
 709         return ata_class_disabled(dev->class);
 710 }
 711
 712 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
 713 {
 714         return ata_class_absent(dev->class);
 715 }
 716
 717 static inline u8 ata_chk_status(struct ata_port *ap)
 718 {
 719         return ap->ops->check_status(ap);
 720 }
 721
 722
 723 /**
 724  *      ata_pause - Flush writes and pause 400 nanoseconds.
 725  *      @ap: Port to wait for.
 726  *
 727  *      LOCKING:
 728  *      Inherited from caller.
 729  */
 730
 731 static inline void ata_pause(struct ata_port *ap)
 732 {
 733         ata_altstatus(ap);
 734         ndelay(400);
 735 }
 736
 737
 738 /**
 739  *      ata_busy_wait - Wait for a port status register
 740  *      @ap: Port to wait for.
 741  *
 742  *      Waits up to max*10 microseconds for the selected bits in the port's
 743  *      status register to be cleared.
 744  *      Returns final value of status register.
 745  *
 746  *      LOCKING:
 747  *      Inherited from caller.
 748  */
 749
 750 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
 751                                unsigned int max)
 752 {
 753         u8 status;
 754
 755         do {
 756                 udelay(10);
 757                 status = ata_chk_status(ap);
 758                 max--;
 759         } while ((status & bits) && (max > 0));
 760
 761         return status;
 762 }
 763
 764
 765 /**
 766  *      ata_wait_idle - Wait for a port to be idle.
 767  *      @ap: Port to wait for.
 768  *
 769  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
 770  *      Returns final value of status register.
 771  *
 772  *      LOCKING:
 773  *      Inherited from caller.
 774  */
 775
 776 static inline u8 ata_wait_idle(struct ata_port *ap)
 777 {
 778         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
 779
 780         if (status & (ATA_BUSY | ATA_DRQ)) {
 781                 unsigned long l = ap->ioaddr.status_addr;
 782                 if (ata_msg_warn(ap))
 783                         printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
 784                                 status, l);
 785         }
 786
 787         return status;
 788 }
 789
 790 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
 791 {
 792         qc->tf.ctl |= ATA_NIEN;
 793 }
 794
 795 static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
 796                                                       unsigned int tag)
 797 {
 798         if (likely(ata_tag_valid(tag)))
 799                 return &ap->qcmd[tag];
 800         return NULL;
 801 }
 802
 803 static inline void ata_tf_init(struct ata_port *ap, struct ata_taskfile *tf, unsigned int device)
 804 {
 805         memset(tf, 0, sizeof(*tf));
 806
 807         tf->ctl = ap->ctl;
 808         if (device == 0)
 809                 tf->device = ATA_DEVICE_OBS;
 810         else
 811                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
 812 }
 813
 814 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
 815 {
 816         qc->__sg = NULL;
 817         qc->flags = 0;
 818         qc->cursect = qc->cursg = qc->cursg_ofs = 0;
 819         qc->nsect = 0;
 820         qc->nbytes = qc->curbytes = 0;
 821         qc->err_mask = 0;
 822
 823         ata_tf_init(qc->ap, &qc->tf, qc->dev->devno);
 824 }
 825
 826 /**
 827  *      ata_qc_complete - Complete an active ATA command
 828  *      @qc: Command to complete
 829  *      @err_mask: ATA Status register contents
 830  *
 831  *      Indicate to the mid and upper layers that an ATA
 832  *      command has completed, with either an ok or not-ok status.
 833  *
 834  *      LOCKING:
 835  *      spin_lock_irqsave(host_set lock)
 836  */
 837 static inline void ata_qc_complete(struct ata_queued_cmd *qc)
 838 {
 839         if (unlikely(qc->flags & ATA_QCFLAG_EH_SCHEDULED))
 840                 return;
 841
 842         __ata_qc_complete(qc);
 843 }
 844
 845 /**
 846  *      ata_irq_on - Enable interrupts on a port.
 847  *      @ap: Port on which interrupts are enabled.
 848  *
 849  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
 850  *      wait for idle, clear any pending interrupts.
 851  *
 852  *      LOCKING:
 853  *      Inherited from caller.
 854  */
 855
 856 static inline u8 ata_irq_on(struct ata_port *ap)
 857 {
 858         struct ata_ioports *ioaddr = &ap->ioaddr;
 859         u8 tmp;
 860
 861         ap->ctl &= ~ATA_NIEN;
 862         ap->last_ctl = ap->ctl;
 863
 864         if (ap->flags & ATA_FLAG_MMIO)
 865                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
 866         else
 867                 outb(ap->ctl, ioaddr->ctl_addr);
 868         tmp = ata_wait_idle(ap);
 869
 870         ap->ops->irq_clear(ap);
 871
 872         return tmp;
 873 }
 874
 875
 876 /**
 877  *      ata_irq_ack - Acknowledge a device interrupt.
 878  *      @ap: Port on which interrupts are enabled.
 879  *
 880  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
 881  *      or BUSY+DRQ clear).  Obtain dma status and port status from
 882  *      device.  Clear the interrupt.  Return port status.
 883  *
 884  *      LOCKING:
 885  */
 886
 887 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
 888 {
 889         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
 890         u8 host_stat, post_stat, status;
 891
 892         status = ata_busy_wait(ap, bits, 1000);
 893         if (status & bits)
 894                 if (ata_msg_err(ap))
 895                         printk(KERN_ERR "abnormal status 0x%X\n", status);
 896
 897         /* get controller status; clear intr, err bits */
 898         if (ap->flags & ATA_FLAG_MMIO) {
 899                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
 900                 host_stat = readb(mmio + ATA_DMA_STATUS);
 901                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
 902                        mmio + ATA_DMA_STATUS);
 903
 904                 post_stat = readb(mmio + ATA_DMA_STATUS);
 905         } else {
 906                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
 907                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
 908                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
 909
 910                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
 911         }
 912
 913         if (ata_msg_intr(ap))
 914                 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
 915                         __FUNCTION__,
 916                         host_stat, post_stat, status);
 917
 918         return status;
 919 }
 920
 921 static inline u32 scr_read(struct ata_port *ap, unsigned int reg)
 922 {
 923         return ap->ops->scr_read(ap, reg);
 924 }
 925
 926 static inline void scr_write(struct ata_port *ap, unsigned int reg, u32 val)
 927 {
 928         ap->ops->scr_write(ap, reg, val);
 929 }
 930
 931 static inline void scr_write_flush(struct ata_port *ap, unsigned int reg,
 932                                    u32 val)
 933 {
 934         ap->ops->scr_write(ap, reg, val);
 935         (void) ap->ops->scr_read(ap, reg);
 936 }
 937
 938 static inline unsigned int sata_dev_present(struct ata_port *ap)
 939 {
 940         return ((scr_read(ap, SCR_STATUS) & 0xf) == 0x3) ? 1 : 0;
 941 }
 942
 943 static inline int ata_try_flush_cache(const struct ata_device *dev)
 944 {
 945         return ata_id_wcache_enabled(dev->id) ||
 946                ata_id_has_flush(dev->id) ||
 947                ata_id_has_flush_ext(dev->id);
 948 }
 949
 950 static inline unsigned int ac_err_mask(u8 status)
 951 {
 952         if (status & ATA_BUSY)
 953                 return AC_ERR_HSM;
 954         if (status & (ATA_ERR | ATA_DF))
 955                 return AC_ERR_DEV;
 956         return 0;
 957 }
 958
 959 static inline unsigned int __ac_err_mask(u8 status)
 960 {
 961         unsigned int mask = ac_err_mask(status);
 962         if (mask == 0)
 963                 return AC_ERR_OTHER;
 964         return mask;
 965 }
 966
 967 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
 968 {
 969         ap->pad_dma = 0;
 970         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
 971                                      &ap->pad_dma, GFP_KERNEL);
 972         return (ap->pad == NULL) ? -ENOMEM : 0;
 973 }
 974
 975 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
 976 {
 977         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
 978 }
 979
 980 #endif /* __LINUX_LIBATA_H__ */