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