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