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/scatterlist.h>
  34 #include <asm/io.h>
  35 #include <linux/ata.h>
  36 #include <linux/workqueue.h>
  37 #include <scsi/scsi_host.h>
  38
  39 #include <asm/libata-portmap.h>
  40
  41 /*
  42  * compile-time options: to be removed as soon as all the drivers are
  43  * converted to the new debugging mechanism
  44  */
  45 #undef ATA_DEBUG                /* debugging output */
  46 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
  47 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
  48 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
  49 #undef ATA_ENABLE_PATA          /* define to enable PATA support in some
  50                                  * low-level drivers */
  51
  52
  53 /* note: prints function name for you */
  54 #ifdef ATA_DEBUG
  55 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  56 #ifdef ATA_VERBOSE_DEBUG
  57 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  58 #else
  59 #define VPRINTK(fmt, args...)
  60 #endif  /* ATA_VERBOSE_DEBUG */
  61 #else
  62 #define DPRINTK(fmt, args...)
  63 #define VPRINTK(fmt, args...)
  64 #endif  /* ATA_DEBUG */
  65
  66 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  67
  68 /* NEW: debug levels */
  69 #define HAVE_LIBATA_MSG 1
  70
  71 enum {
  72         ATA_MSG_DRV     = 0x0001,
  73         ATA_MSG_INFO    = 0x0002,
  74         ATA_MSG_PROBE   = 0x0004,
  75         ATA_MSG_WARN    = 0x0008,
  76         ATA_MSG_MALLOC  = 0x0010,
  77         ATA_MSG_CTL     = 0x0020,
  78         ATA_MSG_INTR    = 0x0040,
  79         ATA_MSG_ERR     = 0x0080,
  80 };
  81
  82 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
  83 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
  84 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
  85 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
  86 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  87 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
  88 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
  89 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
  90
  91 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  92 {
  93         if (dval < 0 || dval >= (sizeof(u32) * 8))
  94                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  95         if (!dval)
  96                 return 0;
  97         return (1 << dval) - 1;
  98 }
  99
 100 /* defines only for the constants which don't work well as enums */
 101 #define ATA_TAG_POISON          0xfafbfcfdU
 102
 103 /* move to PCI layer? */
 104 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
 105 {
 106         return &pdev->dev;
 107 }
 108
 109 enum {
 110         /* various global constants */
 111         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
 112         ATA_MAX_PORTS           = 8,
 113         ATA_DEF_QUEUE           = 1,
 114         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
 115         ATA_MAX_QUEUE           = 32,
 116         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
 117         ATA_MAX_SECTORS         = 200,  /* FIXME */
 118         ATA_MAX_SECTORS_LBA48   = 65535,
 119         ATA_MAX_BUS             = 2,
 120         ATA_DEF_BUSY_WAIT       = 10000,
 121         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
 122
 123         ATA_SHT_EMULATED        = 1,
 124         ATA_SHT_CMD_PER_LUN     = 1,
 125         ATA_SHT_THIS_ID         = -1,
 126         ATA_SHT_USE_CLUSTERING  = 1,
 127
 128         /* struct ata_device stuff */
 129         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
 130         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
 131         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
 132         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
 133         ATA_DFLAG_CFG_MASK      = (1 << 8) - 1,
 134
 135         ATA_DFLAG_PIO           = (1 << 8), /* device currently in PIO mode */
 136         ATA_DFLAG_SUSPENDED     = (1 << 9), /* device suspended */
 137         ATA_DFLAG_INIT_MASK     = (1 << 16) - 1,
 138
 139         ATA_DFLAG_DETACH        = (1 << 16),
 140         ATA_DFLAG_DETACHED      = (1 << 17),
 141
 142         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
 143         ATA_DEV_ATA             = 1,    /* ATA device */
 144         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
 145         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
 146         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
 147         ATA_DEV_NONE            = 5,    /* no device */
 148
 149         /* struct ata_port flags */
 150         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
 151                                             /* (doesn't imply presence) */
 152         ATA_FLAG_SATA           = (1 << 1),
 153         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
 154         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
 155         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
 156         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
 157         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
 158         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
 159         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
 160         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
 161                                              * doesn't handle PIO interrupts */
 162         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
 163         ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
 164         ATA_FLAG_SKIP_D2H_BSY   = (1 << 12), /* can't wait for the first D2H
 165                                               * Register FIS clearing BSY */
 166         ATA_FLAG_DEBUGMSG       = (1 << 13),
 167
 168         /* The following flag belongs to ap->pflags but is kept in
 169          * ap->flags because it's referenced in many LLDs and will be
 170          * removed in not-too-distant future.
 171          */
 172         ATA_FLAG_DISABLED       = (1 << 23), /* port is disabled, ignore it */
 173
 174         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
 175
 176         /* struct ata_port pflags */
 177         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
 178         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
 179         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
 180         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
 181         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
 182         ATA_PFLAG_UNLOADING     = (1 << 5), /* module is unloading */
 183         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
 184
 185         ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
 186         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
 187         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
 188
 189         /* struct ata_queued_cmd flags */
 190         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
 191         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
 192         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
 193         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
 194         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
 195         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
 196
 197         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
 198         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
 199         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
 200
 201         /* host set flags */
 202         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host_set only */
 203
 204         /* various lengths of time */
 205         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
 206         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
 207         ATA_TMOUT_INTERNAL      = 30 * HZ,
 208         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
 209
 210         /* ATA bus states */
 211         BUS_UNKNOWN             = 0,
 212         BUS_DMA                 = 1,
 213         BUS_IDLE                = 2,
 214         BUS_NOINTR              = 3,
 215         BUS_NODATA              = 4,
 216         BUS_TIMER               = 5,
 217         BUS_PIO                 = 6,
 218         BUS_EDD                 = 7,
 219         BUS_IDENTIFY            = 8,
 220         BUS_PACKET              = 9,
 221
 222         /* SATA port states */
 223         PORT_UNKNOWN            = 0,
 224         PORT_ENABLED            = 1,
 225         PORT_DISABLED           = 2,
 226
 227         /* encoding various smaller bitmaps into a single
 228          * unsigned int bitmap
 229          */
 230         ATA_BITS_PIO            = 5,
 231         ATA_BITS_MWDMA          = 3,
 232         ATA_BITS_UDMA           = 8,
 233
 234         ATA_SHIFT_PIO           = 0,
 235         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
 236         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
 237
 238         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
 239         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
 240         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
 241
 242         /* size of buffer to pad xfers ending on unaligned boundaries */
 243         ATA_DMA_PAD_SZ          = 4,
 244         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
 245
 246         /* masks for port functions */
 247         ATA_PORT_PRIMARY        = (1 << 0),
 248         ATA_PORT_SECONDARY      = (1 << 1),
 249
 250         /* ering size */
 251         ATA_ERING_SIZE          = 32,
 252
 253         /* desc_len for ata_eh_info and context */
 254         ATA_EH_DESC_LEN         = 80,
 255
 256         /* reset / recovery action types */
 257         ATA_EH_REVALIDATE       = (1 << 0),
 258         ATA_EH_SOFTRESET        = (1 << 1),
 259         ATA_EH_HARDRESET        = (1 << 2),
 260         ATA_EH_SUSPEND          = (1 << 3),
 261         ATA_EH_RESUME           = (1 << 4),
 262         ATA_EH_PM_FREEZE        = (1 << 5),
 263
 264         ATA_EH_RESET_MASK       = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
 265         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
 266                                   ATA_EH_RESUME | ATA_EH_PM_FREEZE,
 267
 268         /* ata_eh_info->flags */
 269         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
 270         ATA_EHI_RESUME_LINK     = (1 << 1),  /* resume link (reset modifier) */
 271         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
 272         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
 273
 274         ATA_EHI_DID_RESET       = (1 << 16), /* already reset this port */
 275
 276         ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
 277
 278         /* max repeat if error condition is still set after ->error_handler */
 279         ATA_EH_MAX_REPEAT       = 5,
 280
 281         /* how hard are we gonna try to probe/recover devices */
 282         ATA_PROBE_MAX_TRIES     = 3,
 283         ATA_EH_RESET_TRIES      = 3,
 284         ATA_EH_DEV_TRIES        = 3,
 285
 286         /* Drive spinup time (time from power-on to the first D2H FIS)
 287          * in msecs - 8s currently.  Failing to get ready in this time
 288          * isn't critical.  It will result in reset failure for
 289          * controllers which can't wait for the first D2H FIS.  libata
 290          * will retry, so it just has to be long enough to spin up
 291          * most devices.
 292          */
 293         ATA_SPINUP_WAIT         = 8000,
 294 };
 295
 296 enum hsm_task_states {
 297         HSM_ST_UNKNOWN,         /* state unknown */
 298         HSM_ST_IDLE,            /* no command on going */
 299         HSM_ST,                 /* (waiting the device to) transfer data */
 300         HSM_ST_LAST,            /* (waiting the device to) complete command */
 301         HSM_ST_ERR,             /* error */
 302         HSM_ST_FIRST,           /* (waiting the device to)
 303                                    write CDB or first data block */
 304 };
 305
 306 enum ata_completion_errors {
 307         AC_ERR_DEV              = (1 << 0), /* device reported error */
 308         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
 309         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
 310         AC_ERR_MEDIA            = (1 << 3), /* media error */
 311         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
 312         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
 313         AC_ERR_SYSTEM           = (1 << 6), /* system error */
 314         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
 315         AC_ERR_OTHER            = (1 << 8), /* unknown */
 316 };
 317
 318 /* forward declarations */
 319 struct scsi_device;
 320 struct ata_port_operations;
 321 struct ata_port;
 322 struct ata_queued_cmd;
 323
 324 /* typedefs */
 325 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 326 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
 327 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
 328 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
 329
 330 struct ata_ioports {
 331         unsigned long           cmd_addr;
 332         unsigned long           data_addr;
 333         unsigned long           error_addr;
 334         unsigned long           feature_addr;
 335         unsigned long           nsect_addr;
 336         unsigned long           lbal_addr;
 337         unsigned long           lbam_addr;
 338         unsigned long           lbah_addr;
 339         unsigned long           device_addr;
 340         unsigned long           status_addr;
 341         unsigned long           command_addr;
 342         unsigned long           altstatus_addr;
 343         unsigned long           ctl_addr;
 344         unsigned long           bmdma_addr;
 345         unsigned long           scr_addr;
 346 };
 347
 348 struct ata_probe_ent {
 349         struct list_head        node;
 350         struct device           *dev;
 351         const struct ata_port_operations *port_ops;
 352         struct scsi_host_template *sht;
 353         struct ata_ioports      port[ATA_MAX_PORTS];
 354         unsigned int            n_ports;
 355         unsigned int            hard_port_no;
 356         unsigned int            dummy_port_mask;
 357         unsigned int            pio_mask;
 358         unsigned int            mwdma_mask;
 359         unsigned int            udma_mask;
 360         unsigned int            legacy_mode;
 361         unsigned long           irq;
 362         unsigned long           irq2;
 363         unsigned int            irq_flags;
 364         unsigned long           host_flags;
 365         unsigned long           host_set_flags;
 366         void __iomem            *mmio_base;
 367         void                    *private_data;
 368 };
 369
 370 struct ata_host_set {
 371         spinlock_t              lock;
 372         struct device           *dev;
 373         unsigned long           irq;
 374         unsigned long           irq2;
 375         void __iomem            *mmio_base;
 376         unsigned int            n_ports;
 377         void                    *private_data;
 378         const struct ata_port_operations *ops;
 379         unsigned long           flags;
 380         int                     simplex_claimed;        /* Keep seperate in case we
 381                                                            ever need to do this locked */
 382         struct ata_port         *ports[0];
 383 };
 384
 385 struct ata_queued_cmd {
 386         struct ata_port         *ap;
 387         struct ata_device       *dev;
 388
 389         struct scsi_cmnd        *scsicmd;
 390         void                    (*scsidone)(struct scsi_cmnd *);
 391
 392         struct ata_taskfile     tf;
 393         u8                      cdb[ATAPI_CDB_LEN];
 394
 395         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 396         unsigned int            tag;
 397         unsigned int            n_elem;
 398         unsigned int            orig_n_elem;
 399
 400         int                     dma_dir;
 401
 402         unsigned int            pad_len;
 403
 404         unsigned int            nsect;
 405         unsigned int            cursect;
 406
 407         unsigned int            nbytes;
 408         unsigned int            curbytes;
 409
 410         unsigned int            cursg;
 411         unsigned int            cursg_ofs;
 412
 413         struct scatterlist      sgent;
 414         struct scatterlist      pad_sgent;
 415         void                    *buf_virt;
 416
 417         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
 418         struct scatterlist      *__sg;
 419
 420         unsigned int            err_mask;
 421         struct ata_taskfile     result_tf;
 422         ata_qc_cb_t             complete_fn;
 423
 424         void                    *private_data;
 425 };
 426
 427 struct ata_host_stats {
 428         unsigned long           unhandled_irq;
 429         unsigned long           idle_irq;
 430         unsigned long           rw_reqbuf;
 431 };
 432
 433 struct ata_ering_entry {
 434         int                     is_io;
 435         unsigned int            err_mask;
 436         u64                     timestamp;
 437 };
 438
 439 struct ata_ering {
 440         int                     cursor;
 441         struct ata_ering_entry  ring[ATA_ERING_SIZE];
 442 };
 443
 444 struct ata_device {
 445         struct ata_port         *ap;
 446         unsigned int            devno;          /* 0 or 1 */
 447         unsigned long           flags;          /* ATA_DFLAG_xxx */
 448         struct scsi_device      *sdev;          /* attached SCSI device */
 449         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
 450         u64                     n_sectors;      /* size of device, if ATA */
 451         unsigned int            class;          /* ATA_DEV_xxx */
 452         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 453         u8                      pio_mode;
 454         u8                      dma_mode;
 455         u8                      xfer_mode;
 456         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 457
 458         unsigned int            multi_count;    /* sectors count for
 459                                                    READ/WRITE MULTIPLE */
 460         unsigned int            max_sectors;    /* per-device max sectors */
 461         unsigned int            cdb_len;
 462
 463         /* per-dev xfer mask */
 464         unsigned int            pio_mask;
 465         unsigned int            mwdma_mask;
 466         unsigned int            udma_mask;
 467
 468         /* for CHS addressing */
 469         u16                     cylinders;      /* Number of cylinders */
 470         u16                     heads;          /* Number of heads */
 471         u16                     sectors;        /* Number of sectors per track */
 472
 473         /* error history */
 474         struct ata_ering        ering;
 475 };
 476
 477 /* Offset into struct ata_device.  Fields above it are maintained
 478  * acress device init.  Fields below are zeroed.
 479  */
 480 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
 481
 482 struct ata_eh_info {
 483         struct ata_device       *dev;           /* offending device */
 484         u32                     serror;         /* SError from LLDD */
 485         unsigned int            err_mask;       /* port-wide err_mask */
 486         unsigned int            action;         /* ATA_EH_* action mask */
 487         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
 488         unsigned int            flags;          /* ATA_EHI_* flags */
 489
 490         unsigned long           hotplug_timestamp;
 491         unsigned int            probe_mask;
 492
 493         char                    desc[ATA_EH_DESC_LEN];
 494         int                     desc_len;
 495 };
 496
 497 struct ata_eh_context {
 498         struct ata_eh_info      i;
 499         int                     tries[ATA_MAX_DEVICES];
 500         unsigned int            classes[ATA_MAX_DEVICES];
 501         unsigned int            did_probe_mask;
 502 };
 503
 504 struct ata_port {
 505         struct Scsi_Host        *host;  /* our co-allocated scsi host */
 506         const struct ata_port_operations *ops;
 507         spinlock_t              *lock;
 508         unsigned long           flags;  /* ATA_FLAG_xxx */
 509         unsigned int            pflags; /* ATA_PFLAG_xxx */
 510         unsigned int            id;     /* unique id req'd by scsi midlyr */
 511         unsigned int            port_no; /* unique port #; from zero */
 512         unsigned int            hard_port_no;   /* hardware port #; from zero */
 513
 514         struct ata_prd          *prd;    /* our SG list */
 515         dma_addr_t              prd_dma; /* and its DMA mapping */
 516
 517         void                    *pad;   /* array of DMA pad buffers */
 518         dma_addr_t              pad_dma;
 519
 520         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 521
 522         u8                      ctl;    /* cache of ATA control register */
 523         u8                      last_ctl;       /* Cache last written value */
 524         unsigned int            pio_mask;
 525         unsigned int            mwdma_mask;
 526         unsigned int            udma_mask;
 527         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 528         unsigned int            hw_sata_spd_limit;
 529         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
 530
 531         /* record runtime error info, protected by host_set lock */
 532         struct ata_eh_info      eh_info;
 533         /* EH context owned by EH */
 534         struct ata_eh_context   eh_context;
 535
 536         struct ata_device       device[ATA_MAX_DEVICES];
 537
 538         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 539         unsigned long           qc_allocated;
 540         unsigned int            qc_active;
 541
 542         unsigned int            active_tag;
 543         u32                     sactive;
 544
 545         struct ata_host_stats   stats;
 546         struct ata_host_set     *host_set;
 547         struct device           *dev;
 548
 549         struct work_struct      port_task;
 550         struct work_struct      hotplug_task;
 551         struct work_struct      scsi_rescan_task;
 552
 553         unsigned int            hsm_task_state;
 554
 555         u32                     msg_enable;
 556         struct list_head        eh_done_q;
 557         wait_queue_head_t       eh_wait_q;
 558
 559         pm_message_t            pm_mesg;
 560         int                     *pm_result;
 561
 562         void                    *private_data;
 563
 564         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
 565 };
 566
 567 struct ata_port_operations {
 568         void (*port_disable) (struct ata_port *);
 569
 570         void (*dev_config) (struct ata_port *, struct ata_device *);
 571
 572         void (*set_piomode) (struct ata_port *, struct ata_device *);
 573         void (*set_dmamode) (struct ata_port *, struct ata_device *);
 574         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
 575
 576         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
 577         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
 578
 579         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
 580         u8   (*check_status)(struct ata_port *ap);
 581         u8   (*check_altstatus)(struct ata_port *ap);
 582         void (*dev_select)(struct ata_port *ap, unsigned int device);
 583
 584         void (*phy_reset) (struct ata_port *ap); /* obsolete */
 585         void (*set_mode) (struct ata_port *ap);
 586
 587         void (*post_set_mode) (struct ata_port *ap);
 588
 589         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
 590
 591         void (*bmdma_setup) (struct ata_queued_cmd *qc);
 592         void (*bmdma_start) (struct ata_queued_cmd *qc);
 593
 594         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
 595
 596         void (*qc_prep) (struct ata_queued_cmd *qc);
 597         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
 598
 599         /* Error handlers.  ->error_handler overrides ->eng_timeout and
 600          * indicates that new-style EH is in place.
 601          */
 602         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
 603
 604         void (*freeze) (struct ata_port *ap);
 605         void (*thaw) (struct ata_port *ap);
 606         void (*error_handler) (struct ata_port *ap);
 607         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
 608
 609         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
 610         void (*irq_clear) (struct ata_port *);
 611
 612         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
 613         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
 614                            u32 val);
 615
 616         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
 617         int (*port_resume) (struct ata_port *ap);
 618
 619         int (*port_start) (struct ata_port *ap);
 620         void (*port_stop) (struct ata_port *ap);
 621
 622         void (*host_stop) (struct ata_host_set *host_set);
 623
 624         void (*bmdma_stop) (struct ata_queued_cmd *qc);
 625         u8   (*bmdma_status) (struct ata_port *ap);
 626 };
 627
 628 struct ata_port_info {
 629         struct scsi_host_template       *sht;
 630         unsigned long           host_flags;
 631         unsigned long           pio_mask;
 632         unsigned long           mwdma_mask;
 633         unsigned long           udma_mask;
 634         const struct ata_port_operations *port_ops;
 635         void                    *private_data;
 636 };
 637
 638 struct ata_timing {
 639         unsigned short mode;            /* ATA mode */
 640         unsigned short setup;           /* t1 */
 641         unsigned short act8b;           /* t2 for 8-bit I/O */
 642         unsigned short rec8b;           /* t2i for 8-bit I/O */
 643         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 644         unsigned short active;          /* t2 or tD */
 645         unsigned short recover;         /* t2i or tK */
 646         unsigned short cycle;           /* t0 */
 647         unsigned short udma;            /* t2CYCTYP/2 */
 648 };
 649
 650 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
 651
 652 extern const unsigned long sata_deb_timing_normal[];
 653 extern const unsigned long sata_deb_timing_hotplug[];
 654 extern const unsigned long sata_deb_timing_long[];
 655
 656 extern const struct ata_port_operations ata_dummy_port_ops;
 657
 658 static inline const unsigned long *
 659 sata_ehc_deb_timing(struct ata_eh_context *ehc)
 660 {
 661         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
 662                 return sata_deb_timing_hotplug;
 663         else
 664                 return sata_deb_timing_normal;
 665 }
 666
 667 static inline int ata_port_is_dummy(struct ata_port *ap)
 668 {
 669         return ap->ops == &ata_dummy_port_ops;
 670 }
 671
 672 extern void ata_port_probe(struct ata_port *);
 673 extern void __sata_phy_reset(struct ata_port *ap);
 674 extern void sata_phy_reset(struct ata_port *ap);
 675 extern void ata_bus_reset(struct ata_port *ap);
 676 extern int sata_set_spd(struct ata_port *ap);
 677 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
 678 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
 679 extern int ata_std_prereset(struct ata_port *ap);
 680 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
 681 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
 682 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
 683 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
 684 extern void ata_port_disable(struct ata_port *);
 685 extern void ata_std_ports(struct ata_ioports *ioaddr);
 686 #ifdef CONFIG_PCI
 687 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
 688                              unsigned int n_ports);
 689 extern void ata_pci_remove_one (struct pci_dev *pdev);
 690 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
 691 extern void ata_pci_device_do_resume(struct pci_dev *pdev);
 692 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
 693 extern int ata_pci_device_resume(struct pci_dev *pdev);
 694 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
 695 #endif /* CONFIG_PCI */
 696 extern int ata_device_add(const struct ata_probe_ent *ent);
 697 extern void ata_port_detach(struct ata_port *ap);
 698 extern void ata_host_set_init(struct ata_host_set *, struct device *,
 699                               unsigned long, const struct ata_port_operations *);
 700 extern void ata_host_set_remove(struct ata_host_set *host_set);
 701 extern int ata_scsi_detect(struct scsi_host_template *sht);
 702 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
 703 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
 704 extern int ata_scsi_release(struct Scsi_Host *host);
 705 extern void ata_sas_port_destroy(struct ata_port *);
 706 extern struct ata_port *ata_sas_port_alloc(struct ata_host_set *,
 707                                            struct ata_port_info *, struct Scsi_Host *);
 708 extern int ata_sas_port_init(struct ata_port *);
 709 extern int ata_sas_port_start(struct ata_port *ap);
 710 extern void ata_sas_port_stop(struct ata_port *ap);
 711 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
 712 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
 713                             struct ata_port *ap);
 714 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
 715 extern int sata_scr_valid(struct ata_port *ap);
 716 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
 717 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
 718 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
 719 extern int ata_port_online(struct ata_port *ap);
 720 extern int ata_port_offline(struct ata_port *ap);
 721 extern int ata_scsi_device_resume(struct scsi_device *);
 722 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
 723 extern int ata_host_set_suspend(struct ata_host_set *host_set,
 724                                 pm_message_t mesg);
 725 extern void ata_host_set_resume(struct ata_host_set *host_set);
 726 extern int ata_ratelimit(void);
 727 extern unsigned int ata_busy_sleep(struct ata_port *ap,
 728                                    unsigned long timeout_pat,
 729                                    unsigned long timeout);
 730 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
 731                                 void *data, unsigned long delay);
 732 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
 733                              unsigned long interval_msec,
 734                              unsigned long timeout_msec);
 735
 736 /*
 737  * Default driver ops implementations
 738  */
 739 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
 740 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
 741 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
 742 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
 743 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
 744 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
 745 extern u8 ata_check_status(struct ata_port *ap);
 746 extern u8 ata_altstatus(struct ata_port *ap);
 747 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
 748 extern int ata_port_start (struct ata_port *ap);
 749 extern void ata_port_stop (struct ata_port *ap);
 750 extern void ata_host_stop (struct ata_host_set *host_set);
 751 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
 752 extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
 753                                unsigned int buflen, int write_data);
 754 extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
 755                               unsigned int buflen, int write_data);
 756 extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
 757                               unsigned int buflen, int write_data);
 758 extern void ata_qc_prep(struct ata_queued_cmd *qc);
 759 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
 760 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
 761 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
 762                 unsigned int buflen);
 763 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
 764                  unsigned int n_elem);
 765 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
 766 extern void ata_id_string(const u16 *id, unsigned char *s,
 767                           unsigned int ofs, unsigned int len);
 768 extern void ata_id_c_string(const u16 *id, unsigned char *s,
 769                             unsigned int ofs, unsigned int len);
 770 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
 771 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
 772 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
 773 extern u8   ata_bmdma_status(struct ata_port *ap);
 774 extern void ata_bmdma_irq_clear(struct ata_port *ap);
 775 extern void ata_bmdma_freeze(struct ata_port *ap);
 776 extern void ata_bmdma_thaw(struct ata_port *ap);
 777 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
 778                                ata_reset_fn_t softreset,
 779                                ata_reset_fn_t hardreset,
 780                                ata_postreset_fn_t postreset);
 781 extern void ata_bmdma_error_handler(struct ata_port *ap);
 782 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
 783 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
 784                         u8 status, int in_wq);
 785 extern void ata_qc_complete(struct ata_queued_cmd *qc);
 786 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
 787                                     void (*finish_qc)(struct ata_queued_cmd *));
 788 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
 789                               void (*done)(struct scsi_cmnd *));
 790 extern int ata_std_bios_param(struct scsi_device *sdev,
 791                               struct block_device *bdev,
 792                               sector_t capacity, int geom[]);
 793 extern int ata_scsi_slave_config(struct scsi_device *sdev);
 794 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
 795 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
 796                                        int queue_depth);
 797 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
 798
 799 /*
 800  * Timing helpers
 801  */
 802
 803 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
 804 extern int ata_timing_compute(struct ata_device *, unsigned short,
 805                               struct ata_timing *, int, int);
 806 extern void ata_timing_merge(const struct ata_timing *,
 807                              const struct ata_timing *, struct ata_timing *,
 808                              unsigned int);
 809
 810 enum {
 811         ATA_TIMING_SETUP        = (1 << 0),
 812         ATA_TIMING_ACT8B        = (1 << 1),
 813         ATA_TIMING_REC8B        = (1 << 2),
 814         ATA_TIMING_CYC8B        = (1 << 3),
 815         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 816                                   ATA_TIMING_CYC8B,
 817         ATA_TIMING_ACTIVE       = (1 << 4),
 818         ATA_TIMING_RECOVER      = (1 << 5),
 819         ATA_TIMING_CYCLE        = (1 << 6),
 820         ATA_TIMING_UDMA         = (1 << 7),
 821         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 822                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 823                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 824                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
 825 };
 826
 827
 828 #ifdef CONFIG_PCI
 829 struct pci_bits {
 830         unsigned int            reg;    /* PCI config register to read */
 831         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
 832         unsigned long           mask;
 833         unsigned long           val;
 834 };
 835
 836 extern void ata_pci_host_stop (struct ata_host_set *host_set);
 837 extern struct ata_probe_ent *
 838 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
 839 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
 840 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
 841 #endif /* CONFIG_PCI */
 842
 843 /*
 844  * EH
 845  */
 846 extern void ata_eng_timeout(struct ata_port *ap);
 847
 848 extern void ata_port_schedule_eh(struct ata_port *ap);
 849 extern int ata_port_abort(struct ata_port *ap);
 850 extern int ata_port_freeze(struct ata_port *ap);
 851
 852 extern void ata_eh_freeze_port(struct ata_port *ap);
 853 extern void ata_eh_thaw_port(struct ata_port *ap);
 854
 855 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
 856 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
 857
 858 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
 859                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 860                       ata_postreset_fn_t postreset);
 861
 862 /*
 863  * printk helpers
 864  */
 865 #define ata_port_printk(ap, lv, fmt, args...) \
 866         printk(lv"ata%u: "fmt, (ap)->id , ##args)
 867
 868 #define ata_dev_printk(dev, lv, fmt, args...) \
 869         printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
 870
 871 /*
 872  * ata_eh_info helpers
 873  */
 874 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
 875         (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
 876                                      ATA_EH_DESC_LEN - (ehi)->desc_len, \
 877                                      fmt , ##args); \
 878 } while (0)
 879
 880 #define ata_ehi_clear_desc(ehi) do { \
 881         (ehi)->desc[0] = '\0'; \
 882         (ehi)->desc_len = 0; \
 883 } while (0)
 884
 885 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
 886 {
 887         if (ehi->flags & ATA_EHI_HOTPLUGGED)
 888                 return;
 889
 890         ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
 891         ehi->hotplug_timestamp = jiffies;
 892
 893         ehi->action |= ATA_EH_SOFTRESET;
 894         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
 895 }
 896
 897 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
 898 {
 899         __ata_ehi_hotplugged(ehi);
 900         ehi->err_mask |= AC_ERR_ATA_BUS;
 901 }
 902
 903 /*
 904  * qc helpers
 905  */
 906 static inline int
 907 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
 908 {
 909         if (sg == &qc->pad_sgent)
 910                 return 1;
 911         if (qc->pad_len)
 912                 return 0;
 913         if (((sg - qc->__sg) + 1) == qc->n_elem)
 914                 return 1;
 915         return 0;
 916 }
 917
 918 static inline struct scatterlist *
 919 ata_qc_first_sg(struct ata_queued_cmd *qc)
 920 {
 921         if (qc->n_elem)
 922                 return qc->__sg;
 923         if (qc->pad_len)
 924                 return &qc->pad_sgent;
 925         return NULL;
 926 }
 927
 928 static inline struct scatterlist *
 929 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
 930 {
 931         if (sg == &qc->pad_sgent)
 932                 return NULL;
 933         if (++sg - qc->__sg < qc->n_elem)
 934                 return sg;
 935         if (qc->pad_len)
 936                 return &qc->pad_sgent;
 937         return NULL;
 938 }
 939
 940 #define ata_for_each_sg(sg, qc) \
 941         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
 942
 943 static inline unsigned int ata_tag_valid(unsigned int tag)
 944 {
 945         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
 946 }
 947
 948 static inline unsigned int ata_tag_internal(unsigned int tag)
 949 {
 950         return tag == ATA_MAX_QUEUE - 1;
 951 }
 952
 953 /*
 954  * device helpers
 955  */
 956 static inline unsigned int ata_class_enabled(unsigned int class)
 957 {
 958         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
 959 }
 960
 961 static inline unsigned int ata_class_disabled(unsigned int class)
 962 {
 963         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
 964 }
 965
 966 static inline unsigned int ata_class_absent(unsigned int class)
 967 {
 968         return !ata_class_enabled(class) && !ata_class_disabled(class);
 969 }
 970
 971 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
 972 {
 973         return ata_class_enabled(dev->class);
 974 }
 975
 976 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
 977 {
 978         return ata_class_disabled(dev->class);
 979 }
 980
 981 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
 982 {
 983         return ata_class_absent(dev->class);
 984 }
 985
 986 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
 987 {
 988         return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
 989 }
 990
 991 /*
 992  * port helpers
 993  */
 994 static inline int ata_port_max_devices(const struct ata_port *ap)
 995 {
 996         if (ap->flags & ATA_FLAG_SLAVE_POSS)
 997                 return 2;
 998         return 1;
 999 }
1000
1001
1002 static inline u8 ata_chk_status(struct ata_port *ap)
1003 {
1004         return ap->ops->check_status(ap);
1005 }
1006
1007
1008 /**
1009  *      ata_pause - Flush writes and pause 400 nanoseconds.
1010  *      @ap: Port to wait for.
1011  *
1012  *      LOCKING:
1013  *      Inherited from caller.
1014  */
1015
1016 static inline void ata_pause(struct ata_port *ap)
1017 {
1018         ata_altstatus(ap);
1019         ndelay(400);
1020 }
1021
1022
1023 /**
1024  *      ata_busy_wait - Wait for a port status register
1025  *      @ap: Port to wait for.
1026  *
1027  *      Waits up to max*10 microseconds for the selected bits in the port's
1028  *      status register to be cleared.
1029  *      Returns final value of status register.
1030  *
1031  *      LOCKING:
1032  *      Inherited from caller.
1033  */
1034
1035 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1036                                unsigned int max)
1037 {
1038         u8 status;
1039
1040         do {
1041                 udelay(10);
1042                 status = ata_chk_status(ap);
1043                 max--;
1044         } while ((status & bits) && (max > 0));
1045
1046         return status;
1047 }
1048
1049
1050 /**
1051  *      ata_wait_idle - Wait for a port to be idle.
1052  *      @ap: Port to wait for.
1053  *
1054  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1055  *      Returns final value of status register.
1056  *
1057  *      LOCKING:
1058  *      Inherited from caller.
1059  */
1060
1061 static inline u8 ata_wait_idle(struct ata_port *ap)
1062 {
1063         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1064
1065         if (status & (ATA_BUSY | ATA_DRQ)) {
1066                 unsigned long l = ap->ioaddr.status_addr;
1067                 if (ata_msg_warn(ap))
1068                         printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1069                                 status, l);
1070         }
1071
1072         return status;
1073 }
1074
1075 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1076 {
1077         qc->tf.ctl |= ATA_NIEN;
1078 }
1079
1080 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1081                                                        unsigned int tag)
1082 {
1083         if (likely(ata_tag_valid(tag)))
1084                 return &ap->qcmd[tag];
1085         return NULL;
1086 }
1087
1088 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1089                                                      unsigned int tag)
1090 {
1091         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1092
1093         if (unlikely(!qc) || !ap->ops->error_handler)
1094                 return qc;
1095
1096         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1097                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1098                 return qc;
1099
1100         return NULL;
1101 }
1102
1103 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1104 {
1105         memset(tf, 0, sizeof(*tf));
1106
1107         tf->ctl = dev->ap->ctl;
1108         if (dev->devno == 0)
1109                 tf->device = ATA_DEVICE_OBS;
1110         else
1111                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1112 }
1113
1114 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1115 {
1116         qc->__sg = NULL;
1117         qc->flags = 0;
1118         qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1119         qc->nsect = 0;
1120         qc->nbytes = qc->curbytes = 0;
1121         qc->err_mask = 0;
1122
1123         ata_tf_init(qc->dev, &qc->tf);
1124
1125         /* init result_tf such that it indicates normal completion */
1126         qc->result_tf.command = ATA_DRDY;
1127         qc->result_tf.feature = 0;
1128 }
1129
1130 /**
1131  *      ata_irq_on - Enable interrupts on a port.
1132  *      @ap: Port on which interrupts are enabled.
1133  *
1134  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
1135  *      wait for idle, clear any pending interrupts.
1136  *
1137  *      LOCKING:
1138  *      Inherited from caller.
1139  */
1140
1141 static inline u8 ata_irq_on(struct ata_port *ap)
1142 {
1143         struct ata_ioports *ioaddr = &ap->ioaddr;
1144         u8 tmp;
1145
1146         ap->ctl &= ~ATA_NIEN;
1147         ap->last_ctl = ap->ctl;
1148
1149         if (ap->flags & ATA_FLAG_MMIO)
1150                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1151         else
1152                 outb(ap->ctl, ioaddr->ctl_addr);
1153         tmp = ata_wait_idle(ap);
1154
1155         ap->ops->irq_clear(ap);
1156
1157         return tmp;
1158 }
1159
1160
1161 /**
1162  *      ata_irq_ack - Acknowledge a device interrupt.
1163  *      @ap: Port on which interrupts are enabled.
1164  *
1165  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
1166  *      or BUSY+DRQ clear).  Obtain dma status and port status from
1167  *      device.  Clear the interrupt.  Return port status.
1168  *
1169  *      LOCKING:
1170  */
1171
1172 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1173 {
1174         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1175         u8 host_stat, post_stat, status;
1176
1177         status = ata_busy_wait(ap, bits, 1000);
1178         if (status & bits)
1179                 if (ata_msg_err(ap))
1180                         printk(KERN_ERR "abnormal status 0x%X\n", status);
1181
1182         /* get controller status; clear intr, err bits */
1183         if (ap->flags & ATA_FLAG_MMIO) {
1184                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1185                 host_stat = readb(mmio + ATA_DMA_STATUS);
1186                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1187                        mmio + ATA_DMA_STATUS);
1188
1189                 post_stat = readb(mmio + ATA_DMA_STATUS);
1190         } else {
1191                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1192                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1193                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1194
1195                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1196         }
1197
1198         if (ata_msg_intr(ap))
1199                 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1200                         __FUNCTION__,
1201                         host_stat, post_stat, status);
1202
1203         return status;
1204 }
1205
1206 static inline int ata_try_flush_cache(const struct ata_device *dev)
1207 {
1208         return ata_id_wcache_enabled(dev->id) ||
1209                ata_id_has_flush(dev->id) ||
1210                ata_id_has_flush_ext(dev->id);
1211 }
1212
1213 static inline unsigned int ac_err_mask(u8 status)
1214 {
1215         if (status & (ATA_BUSY | ATA_DRQ))
1216                 return AC_ERR_HSM;
1217         if (status & (ATA_ERR | ATA_DF))
1218                 return AC_ERR_DEV;
1219         return 0;
1220 }
1221
1222 static inline unsigned int __ac_err_mask(u8 status)
1223 {
1224         unsigned int mask = ac_err_mask(status);
1225         if (mask == 0)
1226                 return AC_ERR_OTHER;
1227         return mask;
1228 }
1229
1230 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1231 {
1232         ap->pad_dma = 0;
1233         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1234                                      &ap->pad_dma, GFP_KERNEL);
1235         return (ap->pad == NULL) ? -ENOMEM : 0;
1236 }
1237
1238 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1239 {
1240         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1241 }
1242
1243 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1244 {
1245         return (struct ata_port *) &host->hostdata[0];
1246 }
1247
1248 #endif /* __LINUX_LIBATA_H__ */