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