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            dummy_port_mask;
 356         unsigned int            pio_mask;
 357         unsigned int            mwdma_mask;
 358         unsigned int            udma_mask;
 359         unsigned long           irq;
 360         unsigned long           irq2;
 361         unsigned int            irq_flags;
 362         unsigned long           host_flags;
 363         unsigned long           host_set_flags;
 364         void __iomem            *mmio_base;
 365         void                    *private_data;
 366 };
 367
 368 struct ata_host_set {
 369         spinlock_t              lock;
 370         struct device           *dev;
 371         unsigned long           irq;
 372         unsigned long           irq2;
 373         void __iomem            *mmio_base;
 374         unsigned int            n_ports;
 375         void                    *private_data;
 376         const struct ata_port_operations *ops;
 377         unsigned long           flags;
 378         int                     simplex_claimed;        /* Keep seperate in case we
 379                                                            ever need to do this locked */
 380         struct ata_port         *ports[0];
 381 };
 382
 383 struct ata_queued_cmd {
 384         struct ata_port         *ap;
 385         struct ata_device       *dev;
 386
 387         struct scsi_cmnd        *scsicmd;
 388         void                    (*scsidone)(struct scsi_cmnd *);
 389
 390         struct ata_taskfile     tf;
 391         u8                      cdb[ATAPI_CDB_LEN];
 392
 393         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 394         unsigned int            tag;
 395         unsigned int            n_elem;
 396         unsigned int            orig_n_elem;
 397
 398         int                     dma_dir;
 399
 400         unsigned int            pad_len;
 401
 402         unsigned int            nsect;
 403         unsigned int            cursect;
 404
 405         unsigned int            nbytes;
 406         unsigned int            curbytes;
 407
 408         unsigned int            cursg;
 409         unsigned int            cursg_ofs;
 410
 411         struct scatterlist      sgent;
 412         struct scatterlist      pad_sgent;
 413         void                    *buf_virt;
 414
 415         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
 416         struct scatterlist      *__sg;
 417
 418         unsigned int            err_mask;
 419         struct ata_taskfile     result_tf;
 420         ata_qc_cb_t             complete_fn;
 421
 422         void                    *private_data;
 423 };
 424
 425 struct ata_host_stats {
 426         unsigned long           unhandled_irq;
 427         unsigned long           idle_irq;
 428         unsigned long           rw_reqbuf;
 429 };
 430
 431 struct ata_ering_entry {
 432         int                     is_io;
 433         unsigned int            err_mask;
 434         u64                     timestamp;
 435 };
 436
 437 struct ata_ering {
 438         int                     cursor;
 439         struct ata_ering_entry  ring[ATA_ERING_SIZE];
 440 };
 441
 442 struct ata_device {
 443         struct ata_port         *ap;
 444         unsigned int            devno;          /* 0 or 1 */
 445         unsigned long           flags;          /* ATA_DFLAG_xxx */
 446         struct scsi_device      *sdev;          /* attached SCSI device */
 447         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
 448         u64                     n_sectors;      /* size of device, if ATA */
 449         unsigned int            class;          /* ATA_DEV_xxx */
 450         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 451         u8                      pio_mode;
 452         u8                      dma_mode;
 453         u8                      xfer_mode;
 454         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 455
 456         unsigned int            multi_count;    /* sectors count for
 457                                                    READ/WRITE MULTIPLE */
 458         unsigned int            max_sectors;    /* per-device max sectors */
 459         unsigned int            cdb_len;
 460
 461         /* per-dev xfer mask */
 462         unsigned int            pio_mask;
 463         unsigned int            mwdma_mask;
 464         unsigned int            udma_mask;
 465
 466         /* for CHS addressing */
 467         u16                     cylinders;      /* Number of cylinders */
 468         u16                     heads;          /* Number of heads */
 469         u16                     sectors;        /* Number of sectors per track */
 470
 471         /* error history */
 472         struct ata_ering        ering;
 473 };
 474
 475 /* Offset into struct ata_device.  Fields above it are maintained
 476  * acress device init.  Fields below are zeroed.
 477  */
 478 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
 479
 480 struct ata_eh_info {
 481         struct ata_device       *dev;           /* offending device */
 482         u32                     serror;         /* SError from LLDD */
 483         unsigned int            err_mask;       /* port-wide err_mask */
 484         unsigned int            action;         /* ATA_EH_* action mask */
 485         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
 486         unsigned int            flags;          /* ATA_EHI_* flags */
 487
 488         unsigned long           hotplug_timestamp;
 489         unsigned int            probe_mask;
 490
 491         char                    desc[ATA_EH_DESC_LEN];
 492         int                     desc_len;
 493 };
 494
 495 struct ata_eh_context {
 496         struct ata_eh_info      i;
 497         int                     tries[ATA_MAX_DEVICES];
 498         unsigned int            classes[ATA_MAX_DEVICES];
 499         unsigned int            did_probe_mask;
 500 };
 501
 502 struct ata_port {
 503         struct Scsi_Host        *host;  /* our co-allocated scsi host */
 504         const struct ata_port_operations *ops;
 505         spinlock_t              *lock;
 506         unsigned long           flags;  /* ATA_FLAG_xxx */
 507         unsigned int            pflags; /* ATA_PFLAG_xxx */
 508         unsigned int            id;     /* unique id req'd by scsi midlyr */
 509         unsigned int            port_no; /* unique port #; from zero */
 510
 511         struct ata_prd          *prd;    /* our SG list */
 512         dma_addr_t              prd_dma; /* and its DMA mapping */
 513
 514         void                    *pad;   /* array of DMA pad buffers */
 515         dma_addr_t              pad_dma;
 516
 517         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 518
 519         u8                      ctl;    /* cache of ATA control register */
 520         u8                      last_ctl;       /* Cache last written value */
 521         unsigned int            pio_mask;
 522         unsigned int            mwdma_mask;
 523         unsigned int            udma_mask;
 524         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 525         unsigned int            hw_sata_spd_limit;
 526         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
 527
 528         /* record runtime error info, protected by host_set lock */
 529         struct ata_eh_info      eh_info;
 530         /* EH context owned by EH */
 531         struct ata_eh_context   eh_context;
 532
 533         struct ata_device       device[ATA_MAX_DEVICES];
 534
 535         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 536         unsigned long           qc_allocated;
 537         unsigned int            qc_active;
 538
 539         unsigned int            active_tag;
 540         u32                     sactive;
 541
 542         struct ata_host_stats   stats;
 543         struct ata_host_set     *host_set;
 544         struct device           *dev;
 545
 546         struct work_struct      port_task;
 547         struct work_struct      hotplug_task;
 548         struct work_struct      scsi_rescan_task;
 549
 550         unsigned int            hsm_task_state;
 551
 552         u32                     msg_enable;
 553         struct list_head        eh_done_q;
 554         wait_queue_head_t       eh_wait_q;
 555
 556         pm_message_t            pm_mesg;
 557         int                     *pm_result;
 558
 559         void                    *private_data;
 560
 561         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
 562 };
 563
 564 struct ata_port_operations {
 565         void (*port_disable) (struct ata_port *);
 566
 567         void (*dev_config) (struct ata_port *, struct ata_device *);
 568
 569         void (*set_piomode) (struct ata_port *, struct ata_device *);
 570         void (*set_dmamode) (struct ata_port *, struct ata_device *);
 571         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
 572
 573         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
 574         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
 575
 576         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
 577         u8   (*check_status)(struct ata_port *ap);
 578         u8   (*check_altstatus)(struct ata_port *ap);
 579         void (*dev_select)(struct ata_port *ap, unsigned int device);
 580
 581         void (*phy_reset) (struct ata_port *ap); /* obsolete */
 582         void (*set_mode) (struct ata_port *ap);
 583
 584         void (*post_set_mode) (struct ata_port *ap);
 585
 586         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
 587
 588         void (*bmdma_setup) (struct ata_queued_cmd *qc);
 589         void (*bmdma_start) (struct ata_queued_cmd *qc);
 590
 591         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
 592
 593         void (*qc_prep) (struct ata_queued_cmd *qc);
 594         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
 595
 596         /* Error handlers.  ->error_handler overrides ->eng_timeout and
 597          * indicates that new-style EH is in place.
 598          */
 599         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
 600
 601         void (*freeze) (struct ata_port *ap);
 602         void (*thaw) (struct ata_port *ap);
 603         void (*error_handler) (struct ata_port *ap);
 604         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
 605
 606         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
 607         void (*irq_clear) (struct ata_port *);
 608
 609         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
 610         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
 611                            u32 val);
 612
 613         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
 614         int (*port_resume) (struct ata_port *ap);
 615
 616         int (*port_start) (struct ata_port *ap);
 617         void (*port_stop) (struct ata_port *ap);
 618
 619         void (*host_stop) (struct ata_host_set *host_set);
 620
 621         void (*bmdma_stop) (struct ata_queued_cmd *qc);
 622         u8   (*bmdma_status) (struct ata_port *ap);
 623 };
 624
 625 struct ata_port_info {
 626         struct scsi_host_template       *sht;
 627         unsigned long           host_flags;
 628         unsigned long           pio_mask;
 629         unsigned long           mwdma_mask;
 630         unsigned long           udma_mask;
 631         const struct ata_port_operations *port_ops;
 632         void                    *private_data;
 633 };
 634
 635 struct ata_timing {
 636         unsigned short mode;            /* ATA mode */
 637         unsigned short setup;           /* t1 */
 638         unsigned short act8b;           /* t2 for 8-bit I/O */
 639         unsigned short rec8b;           /* t2i for 8-bit I/O */
 640         unsigned short cyc8b;           /* t0 for 8-bit I/O */
 641         unsigned short active;          /* t2 or tD */
 642         unsigned short recover;         /* t2i or tK */
 643         unsigned short cycle;           /* t0 */
 644         unsigned short udma;            /* t2CYCTYP/2 */
 645 };
 646
 647 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
 648
 649 extern const unsigned long sata_deb_timing_normal[];
 650 extern const unsigned long sata_deb_timing_hotplug[];
 651 extern const unsigned long sata_deb_timing_long[];
 652
 653 extern const struct ata_port_operations ata_dummy_port_ops;
 654
 655 static inline const unsigned long *
 656 sata_ehc_deb_timing(struct ata_eh_context *ehc)
 657 {
 658         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
 659                 return sata_deb_timing_hotplug;
 660         else
 661                 return sata_deb_timing_normal;
 662 }
 663
 664 static inline int ata_port_is_dummy(struct ata_port *ap)
 665 {
 666         return ap->ops == &ata_dummy_port_ops;
 667 }
 668
 669 extern void ata_port_probe(struct ata_port *);
 670 extern void __sata_phy_reset(struct ata_port *ap);
 671 extern void sata_phy_reset(struct ata_port *ap);
 672 extern void ata_bus_reset(struct ata_port *ap);
 673 extern int sata_set_spd(struct ata_port *ap);
 674 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
 675 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
 676 extern int ata_std_prereset(struct ata_port *ap);
 677 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
 678 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
 679 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
 680 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
 681 extern void ata_port_disable(struct ata_port *);
 682 extern void ata_std_ports(struct ata_ioports *ioaddr);
 683 #ifdef CONFIG_PCI
 684 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
 685                              unsigned int n_ports);
 686 extern void ata_pci_remove_one (struct pci_dev *pdev);
 687 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
 688 extern void ata_pci_device_do_resume(struct pci_dev *pdev);
 689 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
 690 extern int ata_pci_device_resume(struct pci_dev *pdev);
 691 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
 692 #endif /* CONFIG_PCI */
 693 extern int ata_device_add(const struct ata_probe_ent *ent);
 694 extern void ata_port_detach(struct ata_port *ap);
 695 extern void ata_host_set_init(struct ata_host_set *, struct device *,
 696                               unsigned long, const struct ata_port_operations *);
 697 extern void ata_host_set_remove(struct ata_host_set *host_set);
 698 extern int ata_scsi_detect(struct scsi_host_template *sht);
 699 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
 700 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
 701 extern int ata_scsi_release(struct Scsi_Host *host);
 702 extern void ata_sas_port_destroy(struct ata_port *);
 703 extern struct ata_port *ata_sas_port_alloc(struct ata_host_set *,
 704                                            struct ata_port_info *, struct Scsi_Host *);
 705 extern int ata_sas_port_init(struct ata_port *);
 706 extern int ata_sas_port_start(struct ata_port *ap);
 707 extern void ata_sas_port_stop(struct ata_port *ap);
 708 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
 709 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
 710                             struct ata_port *ap);
 711 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
 712 extern int sata_scr_valid(struct ata_port *ap);
 713 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
 714 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
 715 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
 716 extern int ata_port_online(struct ata_port *ap);
 717 extern int ata_port_offline(struct ata_port *ap);
 718 extern int ata_scsi_device_resume(struct scsi_device *);
 719 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
 720 extern int ata_host_set_suspend(struct ata_host_set *host_set,
 721                                 pm_message_t mesg);
 722 extern void ata_host_set_resume(struct ata_host_set *host_set);
 723 extern int ata_ratelimit(void);
 724 extern unsigned int ata_busy_sleep(struct ata_port *ap,
 725                                    unsigned long timeout_pat,
 726                                    unsigned long timeout);
 727 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
 728                                 void *data, unsigned long delay);
 729 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
 730                              unsigned long interval_msec,
 731                              unsigned long timeout_msec);
 732
 733 /*
 734  * Default driver ops implementations
 735  */
 736 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
 737 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
 738 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
 739 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
 740 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
 741 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
 742 extern u8 ata_check_status(struct ata_port *ap);
 743 extern u8 ata_altstatus(struct ata_port *ap);
 744 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
 745 extern int ata_port_start (struct ata_port *ap);
 746 extern void ata_port_stop (struct ata_port *ap);
 747 extern void ata_host_stop (struct ata_host_set *host_set);
 748 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
 749 extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
 750                                unsigned int buflen, int write_data);
 751 extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
 752                               unsigned int buflen, int write_data);
 753 extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
 754                               unsigned int buflen, int write_data);
 755 extern void ata_qc_prep(struct ata_queued_cmd *qc);
 756 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
 757 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
 758 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
 759                 unsigned int buflen);
 760 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
 761                  unsigned int n_elem);
 762 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
 763 extern void ata_id_string(const u16 *id, unsigned char *s,
 764                           unsigned int ofs, unsigned int len);
 765 extern void ata_id_c_string(const u16 *id, unsigned char *s,
 766                             unsigned int ofs, unsigned int len);
 767 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
 768 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
 769 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
 770 extern u8   ata_bmdma_status(struct ata_port *ap);
 771 extern void ata_bmdma_irq_clear(struct ata_port *ap);
 772 extern void ata_bmdma_freeze(struct ata_port *ap);
 773 extern void ata_bmdma_thaw(struct ata_port *ap);
 774 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
 775                                ata_reset_fn_t softreset,
 776                                ata_reset_fn_t hardreset,
 777                                ata_postreset_fn_t postreset);
 778 extern void ata_bmdma_error_handler(struct ata_port *ap);
 779 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
 780 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
 781                         u8 status, int in_wq);
 782 extern void ata_qc_complete(struct ata_queued_cmd *qc);
 783 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
 784                                     void (*finish_qc)(struct ata_queued_cmd *));
 785 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
 786                               void (*done)(struct scsi_cmnd *));
 787 extern int ata_std_bios_param(struct scsi_device *sdev,
 788                               struct block_device *bdev,
 789                               sector_t capacity, int geom[]);
 790 extern int ata_scsi_slave_config(struct scsi_device *sdev);
 791 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
 792 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
 793                                        int queue_depth);
 794 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
 795
 796 /*
 797  * Timing helpers
 798  */
 799
 800 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
 801 extern int ata_timing_compute(struct ata_device *, unsigned short,
 802                               struct ata_timing *, int, int);
 803 extern void ata_timing_merge(const struct ata_timing *,
 804                              const struct ata_timing *, struct ata_timing *,
 805                              unsigned int);
 806
 807 enum {
 808         ATA_TIMING_SETUP        = (1 << 0),
 809         ATA_TIMING_ACT8B        = (1 << 1),
 810         ATA_TIMING_REC8B        = (1 << 2),
 811         ATA_TIMING_CYC8B        = (1 << 3),
 812         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 813                                   ATA_TIMING_CYC8B,
 814         ATA_TIMING_ACTIVE       = (1 << 4),
 815         ATA_TIMING_RECOVER      = (1 << 5),
 816         ATA_TIMING_CYCLE        = (1 << 6),
 817         ATA_TIMING_UDMA         = (1 << 7),
 818         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 819                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 820                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 821                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
 822 };
 823
 824
 825 #ifdef CONFIG_PCI
 826 struct pci_bits {
 827         unsigned int            reg;    /* PCI config register to read */
 828         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
 829         unsigned long           mask;
 830         unsigned long           val;
 831 };
 832
 833 extern void ata_pci_host_stop (struct ata_host_set *host_set);
 834 extern struct ata_probe_ent *
 835 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
 836 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
 837 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
 838 #endif /* CONFIG_PCI */
 839
 840 /*
 841  * EH
 842  */
 843 extern void ata_eng_timeout(struct ata_port *ap);
 844
 845 extern void ata_port_schedule_eh(struct ata_port *ap);
 846 extern int ata_port_abort(struct ata_port *ap);
 847 extern int ata_port_freeze(struct ata_port *ap);
 848
 849 extern void ata_eh_freeze_port(struct ata_port *ap);
 850 extern void ata_eh_thaw_port(struct ata_port *ap);
 851
 852 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
 853 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
 854
 855 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
 856                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
 857                       ata_postreset_fn_t postreset);
 858
 859 /*
 860  * printk helpers
 861  */
 862 #define ata_port_printk(ap, lv, fmt, args...) \
 863         printk(lv"ata%u: "fmt, (ap)->id , ##args)
 864
 865 #define ata_dev_printk(dev, lv, fmt, args...) \
 866         printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
 867
 868 /*
 869  * ata_eh_info helpers
 870  */
 871 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
 872         (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
 873                                      ATA_EH_DESC_LEN - (ehi)->desc_len, \
 874                                      fmt , ##args); \
 875 } while (0)
 876
 877 #define ata_ehi_clear_desc(ehi) do { \
 878         (ehi)->desc[0] = '\0'; \
 879         (ehi)->desc_len = 0; \
 880 } while (0)
 881
 882 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
 883 {
 884         if (ehi->flags & ATA_EHI_HOTPLUGGED)
 885                 return;
 886
 887         ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
 888         ehi->hotplug_timestamp = jiffies;
 889
 890         ehi->action |= ATA_EH_SOFTRESET;
 891         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
 892 }
 893
 894 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
 895 {
 896         __ata_ehi_hotplugged(ehi);
 897         ehi->err_mask |= AC_ERR_ATA_BUS;
 898 }
 899
 900 /*
 901  * qc helpers
 902  */
 903 static inline int
 904 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
 905 {
 906         if (sg == &qc->pad_sgent)
 907                 return 1;
 908         if (qc->pad_len)
 909                 return 0;
 910         if (((sg - qc->__sg) + 1) == qc->n_elem)
 911                 return 1;
 912         return 0;
 913 }
 914
 915 static inline struct scatterlist *
 916 ata_qc_first_sg(struct ata_queued_cmd *qc)
 917 {
 918         if (qc->n_elem)
 919                 return qc->__sg;
 920         if (qc->pad_len)
 921                 return &qc->pad_sgent;
 922         return NULL;
 923 }
 924
 925 static inline struct scatterlist *
 926 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
 927 {
 928         if (sg == &qc->pad_sgent)
 929                 return NULL;
 930         if (++sg - qc->__sg < qc->n_elem)
 931                 return sg;
 932         if (qc->pad_len)
 933                 return &qc->pad_sgent;
 934         return NULL;
 935 }
 936
 937 #define ata_for_each_sg(sg, qc) \
 938         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
 939
 940 static inline unsigned int ata_tag_valid(unsigned int tag)
 941 {
 942         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
 943 }
 944
 945 static inline unsigned int ata_tag_internal(unsigned int tag)
 946 {
 947         return tag == ATA_MAX_QUEUE - 1;
 948 }
 949
 950 /*
 951  * device helpers
 952  */
 953 static inline unsigned int ata_class_enabled(unsigned int class)
 954 {
 955         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
 956 }
 957
 958 static inline unsigned int ata_class_disabled(unsigned int class)
 959 {
 960         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
 961 }
 962
 963 static inline unsigned int ata_class_absent(unsigned int class)
 964 {
 965         return !ata_class_enabled(class) && !ata_class_disabled(class);
 966 }
 967
 968 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
 969 {
 970         return ata_class_enabled(dev->class);
 971 }
 972
 973 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
 974 {
 975         return ata_class_disabled(dev->class);
 976 }
 977
 978 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
 979 {
 980         return ata_class_absent(dev->class);
 981 }
 982
 983 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
 984 {
 985         return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
 986 }
 987
 988 /*
 989  * port helpers
 990  */
 991 static inline int ata_port_max_devices(const struct ata_port *ap)
 992 {
 993         if (ap->flags & ATA_FLAG_SLAVE_POSS)
 994                 return 2;
 995         return 1;
 996 }
 997
 998
 999 static inline u8 ata_chk_status(struct ata_port *ap)
1000 {
1001         return ap->ops->check_status(ap);
1002 }
1003
1004
1005 /**
1006  *      ata_pause - Flush writes and pause 400 nanoseconds.
1007  *      @ap: Port to wait for.
1008  *
1009  *      LOCKING:
1010  *      Inherited from caller.
1011  */
1012
1013 static inline void ata_pause(struct ata_port *ap)
1014 {
1015         ata_altstatus(ap);
1016         ndelay(400);
1017 }
1018
1019
1020 /**
1021  *      ata_busy_wait - Wait for a port status register
1022  *      @ap: Port to wait for.
1023  *
1024  *      Waits up to max*10 microseconds for the selected bits in the port's
1025  *      status register to be cleared.
1026  *      Returns final value of status register.
1027  *
1028  *      LOCKING:
1029  *      Inherited from caller.
1030  */
1031
1032 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1033                                unsigned int max)
1034 {
1035         u8 status;
1036
1037         do {
1038                 udelay(10);
1039                 status = ata_chk_status(ap);
1040                 max--;
1041         } while ((status & bits) && (max > 0));
1042
1043         return status;
1044 }
1045
1046
1047 /**
1048  *      ata_wait_idle - Wait for a port to be idle.
1049  *      @ap: Port to wait for.
1050  *
1051  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1052  *      Returns final value of status register.
1053  *
1054  *      LOCKING:
1055  *      Inherited from caller.
1056  */
1057
1058 static inline u8 ata_wait_idle(struct ata_port *ap)
1059 {
1060         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1061
1062         if (status & (ATA_BUSY | ATA_DRQ)) {
1063                 unsigned long l = ap->ioaddr.status_addr;
1064                 if (ata_msg_warn(ap))
1065                         printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1066                                 status, l);
1067         }
1068
1069         return status;
1070 }
1071
1072 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1073 {
1074         qc->tf.ctl |= ATA_NIEN;
1075 }
1076
1077 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1078                                                        unsigned int tag)
1079 {
1080         if (likely(ata_tag_valid(tag)))
1081                 return &ap->qcmd[tag];
1082         return NULL;
1083 }
1084
1085 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1086                                                      unsigned int tag)
1087 {
1088         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1089
1090         if (unlikely(!qc) || !ap->ops->error_handler)
1091                 return qc;
1092
1093         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1094                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1095                 return qc;
1096
1097         return NULL;
1098 }
1099
1100 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1101 {
1102         memset(tf, 0, sizeof(*tf));
1103
1104         tf->ctl = dev->ap->ctl;
1105         if (dev->devno == 0)
1106                 tf->device = ATA_DEVICE_OBS;
1107         else
1108                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1109 }
1110
1111 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1112 {
1113         qc->__sg = NULL;
1114         qc->flags = 0;
1115         qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1116         qc->nsect = 0;
1117         qc->nbytes = qc->curbytes = 0;
1118         qc->err_mask = 0;
1119
1120         ata_tf_init(qc->dev, &qc->tf);
1121
1122         /* init result_tf such that it indicates normal completion */
1123         qc->result_tf.command = ATA_DRDY;
1124         qc->result_tf.feature = 0;
1125 }
1126
1127 /**
1128  *      ata_irq_on - Enable interrupts on a port.
1129  *      @ap: Port on which interrupts are enabled.
1130  *
1131  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
1132  *      wait for idle, clear any pending interrupts.
1133  *
1134  *      LOCKING:
1135  *      Inherited from caller.
1136  */
1137
1138 static inline u8 ata_irq_on(struct ata_port *ap)
1139 {
1140         struct ata_ioports *ioaddr = &ap->ioaddr;
1141         u8 tmp;
1142
1143         ap->ctl &= ~ATA_NIEN;
1144         ap->last_ctl = ap->ctl;
1145
1146         if (ap->flags & ATA_FLAG_MMIO)
1147                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1148         else
1149                 outb(ap->ctl, ioaddr->ctl_addr);
1150         tmp = ata_wait_idle(ap);
1151
1152         ap->ops->irq_clear(ap);
1153
1154         return tmp;
1155 }
1156
1157
1158 /**
1159  *      ata_irq_ack - Acknowledge a device interrupt.
1160  *      @ap: Port on which interrupts are enabled.
1161  *
1162  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
1163  *      or BUSY+DRQ clear).  Obtain dma status and port status from
1164  *      device.  Clear the interrupt.  Return port status.
1165  *
1166  *      LOCKING:
1167  */
1168
1169 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1170 {
1171         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1172         u8 host_stat, post_stat, status;
1173
1174         status = ata_busy_wait(ap, bits, 1000);
1175         if (status & bits)
1176                 if (ata_msg_err(ap))
1177                         printk(KERN_ERR "abnormal status 0x%X\n", status);
1178
1179         /* get controller status; clear intr, err bits */
1180         if (ap->flags & ATA_FLAG_MMIO) {
1181                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1182                 host_stat = readb(mmio + ATA_DMA_STATUS);
1183                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1184                        mmio + ATA_DMA_STATUS);
1185
1186                 post_stat = readb(mmio + ATA_DMA_STATUS);
1187         } else {
1188                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1189                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1190                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1191
1192                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1193         }
1194
1195         if (ata_msg_intr(ap))
1196                 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1197                         __FUNCTION__,
1198                         host_stat, post_stat, status);
1199
1200         return status;
1201 }
1202
1203 static inline int ata_try_flush_cache(const struct ata_device *dev)
1204 {
1205         return ata_id_wcache_enabled(dev->id) ||
1206                ata_id_has_flush(dev->id) ||
1207                ata_id_has_flush_ext(dev->id);
1208 }
1209
1210 static inline unsigned int ac_err_mask(u8 status)
1211 {
1212         if (status & (ATA_BUSY | ATA_DRQ))
1213                 return AC_ERR_HSM;
1214         if (status & (ATA_ERR | ATA_DF))
1215                 return AC_ERR_DEV;
1216         return 0;
1217 }
1218
1219 static inline unsigned int __ac_err_mask(u8 status)
1220 {
1221         unsigned int mask = ac_err_mask(status);
1222         if (mask == 0)
1223                 return AC_ERR_OTHER;
1224         return mask;
1225 }
1226
1227 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1228 {
1229         ap->pad_dma = 0;
1230         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1231                                      &ap->pad_dma, GFP_KERNEL);
1232         return (ap->pad == NULL) ? -ENOMEM : 0;
1233 }
1234
1235 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1236 {
1237         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1238 }
1239
1240 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1241 {
1242         return (struct ata_port *) &host->hostdata[0];
1243 }
1244
1245 #endif /* __LINUX_LIBATA_H__ */