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