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