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/jiffies.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/dma-mapping.h>
  33 #include <linux/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 #include <linux/cdrom.h>
  40 #include <linux/sched.h>
  41
  42 /*
  43  * Define if arch has non-standard setup.  This is a _PCI_ standard
  44  * not a legacy or ISA standard.
  45  */
  46 #ifdef CONFIG_ATA_NONSTANDARD
  47 #include <asm/libata-portmap.h>
  48 #else
  49 #include <asm-generic/libata-portmap.h>
  50 #endif
  51
  52 /*
  53  * compile-time options: to be removed as soon as all the drivers are
  54  * converted to the new debugging mechanism
  55  */
  56 #undef ATA_DEBUG                /* debugging output */
  57 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
  58 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
  59 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
  60
  61
  62 /* note: prints function name for you */
  63 #ifdef ATA_DEBUG
  64 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  65 #ifdef ATA_VERBOSE_DEBUG
  66 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  67 #else
  68 #define VPRINTK(fmt, args...)
  69 #endif  /* ATA_VERBOSE_DEBUG */
  70 #else
  71 #define DPRINTK(fmt, args...)
  72 #define VPRINTK(fmt, args...)
  73 #endif  /* ATA_DEBUG */
  74
  75 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  76
  77 #define ata_print_version_once(dev, version)                    \
  78 ({                                                              \
  79         static bool __print_once;                               \
  80                                                                 \
  81         if (!__print_once) {                                    \
  82                 __print_once = true;                            \
  83                 ata_print_version(dev, version);                \
  84         }                                                       \
  85 })
  86
  87 /* NEW: debug levels */
  88 #define HAVE_LIBATA_MSG 1
  89
  90 enum {
  91         ATA_MSG_DRV     = 0x0001,
  92         ATA_MSG_INFO    = 0x0002,
  93         ATA_MSG_PROBE   = 0x0004,
  94         ATA_MSG_WARN    = 0x0008,
  95         ATA_MSG_MALLOC  = 0x0010,
  96         ATA_MSG_CTL     = 0x0020,
  97         ATA_MSG_INTR    = 0x0040,
  98         ATA_MSG_ERR     = 0x0080,
  99 };
 100
 101 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
 102 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
 103 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
 104 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
 105 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
 106 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
 107 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
 108 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
 109
 110 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
 111 {
 112         if (dval < 0 || dval >= (sizeof(u32) * 8))
 113                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
 114         if (!dval)
 115                 return 0;
 116         return (1 << dval) - 1;
 117 }
 118
 119 /* defines only for the constants which don't work well as enums */
 120 #define ATA_TAG_POISON          0xfafbfcfdU
 121
 122 enum {
 123         /* various global constants */
 124         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
 125         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
 126         ATA_DEF_QUEUE           = 1,
 127         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
 128         ATA_MAX_QUEUE           = 32,
 129         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
 130         ATA_SHORT_PAUSE         = 16,
 131
 132         ATAPI_MAX_DRAIN         = 16 << 10,
 133
 134         ATA_ALL_DEVICES         = (1 << ATA_MAX_DEVICES) - 1,
 135
 136         ATA_SHT_EMULATED        = 1,
 137         ATA_SHT_CMD_PER_LUN     = 1,
 138         ATA_SHT_THIS_ID         = -1,
 139         ATA_SHT_USE_CLUSTERING  = 1,
 140
 141         /* struct ata_taskfile flags */
 142         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
 143         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
 144         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
 145         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
 146         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
 147         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
 148         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
 149
 150         /* protocol flags */
 151         ATA_PROT_FLAG_PIO       = (1 << 0), /* is PIO */
 152         ATA_PROT_FLAG_DMA       = (1 << 1), /* is DMA */
 153         ATA_PROT_FLAG_DATA      = ATA_PROT_FLAG_PIO | ATA_PROT_FLAG_DMA,
 154         ATA_PROT_FLAG_NCQ       = (1 << 2), /* is NCQ */
 155         ATA_PROT_FLAG_ATAPI     = (1 << 3), /* is ATAPI */
 156
 157         /* struct ata_device stuff */
 158         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
 159         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
 160         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
 161         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
 162         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
 163         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
 164         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
 165         ATA_DFLAG_AN            = (1 << 7), /* AN configured */
 166         ATA_DFLAG_DMADIR        = (1 << 10), /* device requires DMADIR */
 167         ATA_DFLAG_CFG_MASK      = (1 << 12) - 1,
 168
 169         ATA_DFLAG_PIO           = (1 << 12), /* device limited to PIO mode */
 170         ATA_DFLAG_NCQ_OFF       = (1 << 13), /* device limited to non-NCQ mode */
 171         ATA_DFLAG_SLEEPING      = (1 << 15), /* device is sleeping */
 172         ATA_DFLAG_DUBIOUS_XFER  = (1 << 16), /* data transfer not verified */
 173         ATA_DFLAG_NO_UNLOAD     = (1 << 17), /* device doesn't support unload */
 174         ATA_DFLAG_UNLOCK_HPA    = (1 << 18), /* unlock HPA */
 175         ATA_DFLAG_NCQ_SEND_RECV = (1 << 19), /* device supports NCQ SEND and RECV */
 176         ATA_DFLAG_INIT_MASK     = (1 << 24) - 1,
 177
 178         ATA_DFLAG_DETACH        = (1 << 24),
 179         ATA_DFLAG_DETACHED      = (1 << 25),
 180
 181         ATA_DFLAG_DA            = (1 << 26), /* device supports Device Attention */
 182         ATA_DFLAG_DEVSLP        = (1 << 27), /* device supports Device Sleep */
 183         ATA_DFLAG_ACPI_DISABLED = (1 << 28), /* ACPI for the device is disabled */
 184
 185         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
 186         ATA_DEV_ATA             = 1,    /* ATA device */
 187         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
 188         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
 189         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
 190         ATA_DEV_PMP             = 5,    /* SATA port multiplier */
 191         ATA_DEV_PMP_UNSUP       = 6,    /* SATA port multiplier (unsupported) */
 192         ATA_DEV_SEMB            = 7,    /* SEMB */
 193         ATA_DEV_SEMB_UNSUP      = 8,    /* SEMB (unsupported) */
 194         ATA_DEV_ZAC             = 9,    /* ZAC device */
 195         ATA_DEV_NONE            = 10,   /* no device */
 196
 197         /* struct ata_link flags */
 198         ATA_LFLAG_NO_HRST       = (1 << 1), /* avoid hardreset */
 199         ATA_LFLAG_NO_SRST       = (1 << 2), /* avoid softreset */
 200         ATA_LFLAG_ASSUME_ATA    = (1 << 3), /* assume ATA class */
 201         ATA_LFLAG_ASSUME_SEMB   = (1 << 4), /* assume SEMB class */
 202         ATA_LFLAG_ASSUME_CLASS  = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
 203         ATA_LFLAG_NO_RETRY      = (1 << 5), /* don't retry this link */
 204         ATA_LFLAG_DISABLED      = (1 << 6), /* link is disabled */
 205         ATA_LFLAG_SW_ACTIVITY   = (1 << 7), /* keep activity stats */
 206         ATA_LFLAG_NO_LPM        = (1 << 8), /* disable LPM on this link */
 207         ATA_LFLAG_RST_ONCE      = (1 << 9), /* limit recovery to one reset */
 208
 209         /* struct ata_port flags */
 210         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
 211                                             /* (doesn't imply presence) */
 212         ATA_FLAG_SATA           = (1 << 1),
 213         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
 214         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
 215         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
 216         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
 217                                              * doesn't handle PIO interrupts */
 218         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
 219         ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
 220         ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
 221         ATA_FLAG_DEBUGMSG       = (1 << 13),
 222         ATA_FLAG_FPDMA_AA               = (1 << 14), /* driver supports Auto-Activate */
 223         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
 224         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
 225         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
 226         ATA_FLAG_AN             = (1 << 18), /* controller supports AN */
 227         ATA_FLAG_PMP            = (1 << 19), /* controller supports PMP */
 228         ATA_FLAG_FPDMA_AUX      = (1 << 20), /* controller supports H2DFIS aux field */
 229         ATA_FLAG_EM             = (1 << 21), /* driver supports enclosure
 230                                               * management */
 231         ATA_FLAG_SW_ACTIVITY    = (1 << 22), /* driver supports sw activity
 232                                               * led */
 233         ATA_FLAG_NO_DIPM        = (1 << 23), /* host not happy with DIPM */
 234         ATA_FLAG_LOWTAG         = (1 << 24), /* host wants lowest available tag */
 235         ATA_FLAG_SAS_HOST       = (1 << 25), /* SAS host */
 236
 237         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
 238
 239
 240         /* struct ata_port pflags */
 241         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
 242         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
 243         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
 244         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
 245         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
 246         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
 247         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
 248         ATA_PFLAG_RESETTING     = (1 << 8), /* reset in progress */
 249         ATA_PFLAG_UNLOADING     = (1 << 9), /* driver is being unloaded */
 250         ATA_PFLAG_UNLOADED      = (1 << 10), /* driver is unloaded */
 251
 252         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
 253         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
 254         ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
 255
 256         ATA_PFLAG_PIO32         = (1 << 20),  /* 32bit PIO */
 257         ATA_PFLAG_PIO32CHANGE   = (1 << 21),  /* 32bit PIO can be turned on/off */
 258
 259         /* struct ata_queued_cmd flags */
 260         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
 261         ATA_QCFLAG_DMAMAP       = (1 << 1), /* SG table is DMA mapped */
 262         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
 263         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
 264         ATA_QCFLAG_CLEAR_EXCL   = (1 << 5), /* clear excl_link on completion */
 265         ATA_QCFLAG_QUIET        = (1 << 6), /* don't report device error */
 266         ATA_QCFLAG_RETRY        = (1 << 7), /* retry after failure */
 267
 268         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
 269         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
 270         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
 271
 272         /* host set flags */
 273         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
 274         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
 275         ATA_HOST_PARALLEL_SCAN  = (1 << 2),     /* Ports on this host can be scanned in parallel */
 276         ATA_HOST_IGNORE_ATA     = (1 << 3),     /* Ignore ATA devices on this host. */
 277
 278         /* bits 24:31 of host->flags are reserved for LLD specific flags */
 279
 280         /* various lengths of time */
 281         ATA_TMOUT_BOOT          = 30000,        /* heuristic */
 282         ATA_TMOUT_BOOT_QUICK    =  7000,        /* heuristic */
 283         ATA_TMOUT_INTERNAL_QUICK = 5000,
 284         ATA_TMOUT_MAX_PARK      = 30000,
 285
 286         /*
 287          * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms.  2s
 288          * is too much without parallel probing.  Use 2s if parallel
 289          * probing is available, 800ms otherwise.
 290          */
 291         ATA_TMOUT_FF_WAIT_LONG  =  2000,
 292         ATA_TMOUT_FF_WAIT       =   800,
 293
 294         /* Spec mandates to wait for ">= 2ms" before checking status
 295          * after reset.  We wait 150ms, because that was the magic
 296          * delay used for ATAPI devices in Hale Landis's ATADRVR, for
 297          * the period of time between when the ATA command register is
 298          * written, and then status is checked.  Because waiting for
 299          * "a while" before checking status is fine, post SRST, we
 300          * perform this magic delay here as well.
 301          *
 302          * Old drivers/ide uses the 2mS rule and then waits for ready.
 303          */
 304         ATA_WAIT_AFTER_RESET    =  150,
 305
 306         /* If PMP is supported, we have to do follow-up SRST.  As some
 307          * PMPs don't send D2H Reg FIS after hardreset, LLDs are
 308          * advised to wait only for the following duration before
 309          * doing SRST.
 310          */
 311         ATA_TMOUT_PMP_SRST_WAIT = 5000,
 312
 313         /* ATA bus states */
 314         BUS_UNKNOWN             = 0,
 315         BUS_DMA                 = 1,
 316         BUS_IDLE                = 2,
 317         BUS_NOINTR              = 3,
 318         BUS_NODATA              = 4,
 319         BUS_TIMER               = 5,
 320         BUS_PIO                 = 6,
 321         BUS_EDD                 = 7,
 322         BUS_IDENTIFY            = 8,
 323         BUS_PACKET              = 9,
 324
 325         /* SATA port states */
 326         PORT_UNKNOWN            = 0,
 327         PORT_ENABLED            = 1,
 328         PORT_DISABLED           = 2,
 329
 330         /* encoding various smaller bitmaps into a single
 331          * unsigned long bitmap
 332          */
 333         ATA_NR_PIO_MODES        = 7,
 334         ATA_NR_MWDMA_MODES      = 5,
 335         ATA_NR_UDMA_MODES       = 8,
 336
 337         ATA_SHIFT_PIO           = 0,
 338         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
 339         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
 340
 341         /* size of buffer to pad xfers ending on unaligned boundaries */
 342         ATA_DMA_PAD_SZ          = 4,
 343
 344         /* ering size */
 345         ATA_ERING_SIZE          = 32,
 346
 347         /* return values for ->qc_defer */
 348         ATA_DEFER_LINK          = 1,
 349         ATA_DEFER_PORT          = 2,
 350
 351         /* desc_len for ata_eh_info and context */
 352         ATA_EH_DESC_LEN         = 80,
 353
 354         /* reset / recovery action types */
 355         ATA_EH_REVALIDATE       = (1 << 0),
 356         ATA_EH_SOFTRESET        = (1 << 1), /* meaningful only in ->prereset */
 357         ATA_EH_HARDRESET        = (1 << 2), /* meaningful only in ->prereset */
 358         ATA_EH_RESET            = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
 359         ATA_EH_ENABLE_LINK      = (1 << 3),
 360         ATA_EH_PARK             = (1 << 5), /* unload heads and stop I/O */
 361
 362         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE | ATA_EH_PARK,
 363         ATA_EH_ALL_ACTIONS      = ATA_EH_REVALIDATE | ATA_EH_RESET |
 364                                   ATA_EH_ENABLE_LINK,
 365
 366         /* ata_eh_info->flags */
 367         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
 368         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
 369         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
 370         ATA_EHI_NO_RECOVERY     = (1 << 4),  /* no recovery */
 371
 372         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
 373         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
 374         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
 375         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
 376         ATA_EHI_POST_SETMODE    = (1 << 20), /* revalidating after setmode */
 377
 378         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
 379
 380         /* mask of flags to transfer *to* the slave link */
 381         ATA_EHI_TO_SLAVE_MASK   = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
 382
 383         /* max tries if error condition is still set after ->error_handler */
 384         ATA_EH_MAX_TRIES        = 5,
 385
 386         /* sometimes resuming a link requires several retries */
 387         ATA_LINK_RESUME_TRIES   = 5,
 388
 389         /* how hard are we gonna try to probe/recover devices */
 390         ATA_PROBE_MAX_TRIES     = 3,
 391         ATA_EH_DEV_TRIES        = 3,
 392         ATA_EH_PMP_TRIES        = 5,
 393         ATA_EH_PMP_LINK_TRIES   = 3,
 394
 395         SATA_PMP_RW_TIMEOUT     = 3000,         /* PMP read/write timeout */
 396
 397         /* This should match the actual table size of
 398          * ata_eh_cmd_timeout_table in libata-eh.c.
 399          */
 400         ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
 401
 402         /* Horkage types. May be set by libata or controller on drives
 403            (some horkage may be drive/controller pair dependent */
 404
 405         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
 406         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
 407         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
 408         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
 409         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
 410         ATA_HORKAGE_DISABLE     = (1 << 5),     /* Disable it */
 411         ATA_HORKAGE_HPA_SIZE    = (1 << 6),     /* native size off by one */
 412         ATA_HORKAGE_IVB         = (1 << 8),     /* cbl det validity bit bugs */
 413         ATA_HORKAGE_STUCK_ERR   = (1 << 9),     /* stuck ERR on next PACKET */
 414         ATA_HORKAGE_BRIDGE_OK   = (1 << 10),    /* no bridge limits */
 415         ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
 416                                                     not multiple of 16 bytes */
 417         ATA_HORKAGE_FIRMWARE_WARN = (1 << 12),  /* firmware update warning */
 418         ATA_HORKAGE_1_5_GBPS    = (1 << 13),    /* force 1.5 Gbps */
 419         ATA_HORKAGE_NOSETXFER   = (1 << 14),    /* skip SETXFER, SATA only */
 420         ATA_HORKAGE_BROKEN_FPDMA_AA     = (1 << 15),    /* skip AA */
 421         ATA_HORKAGE_DUMP_ID     = (1 << 16),    /* dump IDENTIFY data */
 422         ATA_HORKAGE_MAX_SEC_LBA48 = (1 << 17),  /* Set max sects to 65535 */
 423         ATA_HORKAGE_ATAPI_DMADIR = (1 << 18),   /* device requires dmadir */
 424         ATA_HORKAGE_NO_NCQ_TRIM = (1 << 19),    /* don't use queued TRIM */
 425         ATA_HORKAGE_NOLPM       = (1 << 20),    /* don't use LPM */
 426         ATA_HORKAGE_WD_BROKEN_LPM = (1 << 21),  /* some WDs have broken LPM */
 427         ATA_HORKAGE_ZERO_AFTER_TRIM = (1 << 22),/* guarantees zero after trim */
 428
 429          /* DMA mask for user DMA control: User visible values; DO NOT
 430             renumber */
 431         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
 432         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
 433         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
 434
 435         /* ATAPI command types */
 436         ATAPI_READ              = 0,            /* READs */
 437         ATAPI_WRITE             = 1,            /* WRITEs */
 438         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
 439         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
 440         ATAPI_MISC              = 4,            /* the rest */
 441
 442         /* Timing constants */
 443         ATA_TIMING_SETUP        = (1 << 0),
 444         ATA_TIMING_ACT8B        = (1 << 1),
 445         ATA_TIMING_REC8B        = (1 << 2),
 446         ATA_TIMING_CYC8B        = (1 << 3),
 447         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
 448                                   ATA_TIMING_CYC8B,
 449         ATA_TIMING_ACTIVE       = (1 << 4),
 450         ATA_TIMING_RECOVER      = (1 << 5),
 451         ATA_TIMING_DMACK_HOLD   = (1 << 6),
 452         ATA_TIMING_CYCLE        = (1 << 7),
 453         ATA_TIMING_UDMA         = (1 << 8),
 454         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
 455                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
 456                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
 457                                   ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
 458                                   ATA_TIMING_UDMA,
 459
 460         /* ACPI constants */
 461         ATA_ACPI_FILTER_SETXFER = 1 << 0,
 462         ATA_ACPI_FILTER_LOCK    = 1 << 1,
 463         ATA_ACPI_FILTER_DIPM    = 1 << 2,
 464         ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3,  /* FPDMA non-zero offset */
 465         ATA_ACPI_FILTER_FPDMA_AA = 1 << 4,      /* FPDMA auto activate */
 466
 467         ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
 468                                   ATA_ACPI_FILTER_LOCK |
 469                                   ATA_ACPI_FILTER_DIPM,
 470 };
 471
 472 enum ata_xfer_mask {
 473         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
 474                                         << ATA_SHIFT_PIO,
 475         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
 476                                         << ATA_SHIFT_MWDMA,
 477         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
 478                                         << ATA_SHIFT_UDMA,
 479 };
 480
 481 enum hsm_task_states {
 482         HSM_ST_IDLE,            /* no command on going */
 483         HSM_ST_FIRST,           /* (waiting the device to)
 484                                    write CDB or first data block */
 485         HSM_ST,                 /* (waiting the device to) transfer data */
 486         HSM_ST_LAST,            /* (waiting the device to) complete command */
 487         HSM_ST_ERR,             /* error */
 488 };
 489
 490 enum ata_completion_errors {
 491         AC_ERR_DEV              = (1 << 0), /* device reported error */
 492         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
 493         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
 494         AC_ERR_MEDIA            = (1 << 3), /* media error */
 495         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
 496         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
 497         AC_ERR_SYSTEM           = (1 << 6), /* system error */
 498         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
 499         AC_ERR_OTHER            = (1 << 8), /* unknown */
 500         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
 501         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
 502 };
 503
 504 /*
 505  * Link power management policy: If you alter this, you also need to
 506  * alter libata-scsi.c (for the ascii descriptions)
 507  */
 508 enum ata_lpm_policy {
 509         ATA_LPM_UNKNOWN,
 510         ATA_LPM_MAX_POWER,
 511         ATA_LPM_MED_POWER,
 512         ATA_LPM_MIN_POWER,
 513 };
 514
 515 enum ata_lpm_hints {
 516         ATA_LPM_EMPTY           = (1 << 0), /* port empty/probing */
 517         ATA_LPM_HIPM            = (1 << 1), /* may use HIPM */
 518 };
 519
 520 /* forward declarations */
 521 struct scsi_device;
 522 struct ata_port_operations;
 523 struct ata_port;
 524 struct ata_link;
 525 struct ata_queued_cmd;
 526
 527 /* typedefs */
 528 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
 529 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
 530 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
 531                               unsigned long deadline);
 532 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
 533
 534 extern struct device_attribute dev_attr_link_power_management_policy;
 535 extern struct device_attribute dev_attr_unload_heads;
 536 extern struct device_attribute dev_attr_em_message_type;
 537 extern struct device_attribute dev_attr_em_message;
 538 extern struct device_attribute dev_attr_sw_activity;
 539
 540 enum sw_activity {
 541         OFF,
 542         BLINK_ON,
 543         BLINK_OFF,
 544 };
 545
 546 struct ata_taskfile {
 547         unsigned long           flags;          /* ATA_TFLAG_xxx */
 548         u8                      protocol;       /* ATA_PROT_xxx */
 549
 550         u8                      ctl;            /* control reg */
 551
 552         u8                      hob_feature;    /* additional data */
 553         u8                      hob_nsect;      /* to support LBA48 */
 554         u8                      hob_lbal;
 555         u8                      hob_lbam;
 556         u8                      hob_lbah;
 557
 558         u8                      feature;
 559         u8                      nsect;
 560         u8                      lbal;
 561         u8                      lbam;
 562         u8                      lbah;
 563
 564         u8                      device;
 565
 566         u8                      command;        /* IO operation */
 567
 568         u32                     auxiliary;      /* auxiliary field */
 569                                                 /* from SATA 3.1 and */
 570                                                 /* ATA-8 ACS-3 */
 571 };
 572
 573 #ifdef CONFIG_ATA_SFF
 574 struct ata_ioports {
 575         void __iomem            *cmd_addr;
 576         void __iomem            *data_addr;
 577         void __iomem            *error_addr;
 578         void __iomem            *feature_addr;
 579         void __iomem            *nsect_addr;
 580         void __iomem            *lbal_addr;
 581         void __iomem            *lbam_addr;
 582         void __iomem            *lbah_addr;
 583         void __iomem            *device_addr;
 584         void __iomem            *status_addr;
 585         void __iomem            *command_addr;
 586         void __iomem            *altstatus_addr;
 587         void __iomem            *ctl_addr;
 588 #ifdef CONFIG_ATA_BMDMA
 589         void __iomem            *bmdma_addr;
 590 #endif /* CONFIG_ATA_BMDMA */
 591         void __iomem            *scr_addr;
 592 };
 593 #endif /* CONFIG_ATA_SFF */
 594
 595 struct ata_host {
 596         spinlock_t              lock;
 597         struct device           *dev;
 598         void __iomem * const    *iomap;
 599         unsigned int            n_ports;
 600         unsigned int            n_tags;                 /* nr of NCQ tags */
 601         void                    *private_data;
 602         struct ata_port_operations *ops;
 603         unsigned long           flags;
 604
 605         struct mutex            eh_mutex;
 606         struct task_struct      *eh_owner;
 607
 608         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
 609         struct ata_port         *ports[0];
 610 };
 611
 612 struct ata_queued_cmd {
 613         struct ata_port         *ap;
 614         struct ata_device       *dev;
 615
 616         struct scsi_cmnd        *scsicmd;
 617         void                    (*scsidone)(struct scsi_cmnd *);
 618
 619         struct ata_taskfile     tf;
 620         u8                      cdb[ATAPI_CDB_LEN];
 621
 622         unsigned long           flags;          /* ATA_QCFLAG_xxx */
 623         unsigned int            tag;
 624         unsigned int            n_elem;
 625         unsigned int            orig_n_elem;
 626
 627         int                     dma_dir;
 628
 629         unsigned int            sect_size;
 630
 631         unsigned int            nbytes;
 632         unsigned int            extrabytes;
 633         unsigned int            curbytes;
 634
 635         struct scatterlist      sgent;
 636
 637         struct scatterlist      *sg;
 638
 639         struct scatterlist      *cursg;
 640         unsigned int            cursg_ofs;
 641
 642         unsigned int            err_mask;
 643         struct ata_taskfile     result_tf;
 644         ata_qc_cb_t             complete_fn;
 645
 646         void                    *private_data;
 647         void                    *lldd_task;
 648 };
 649
 650 struct ata_port_stats {
 651         unsigned long           unhandled_irq;
 652         unsigned long           idle_irq;
 653         unsigned long           rw_reqbuf;
 654 };
 655
 656 struct ata_ering_entry {
 657         unsigned int            eflags;
 658         unsigned int            err_mask;
 659         u64                     timestamp;
 660 };
 661
 662 struct ata_ering {
 663         int                     cursor;
 664         struct ata_ering_entry  ring[ATA_ERING_SIZE];
 665 };
 666
 667 struct ata_device {
 668         struct ata_link         *link;
 669         unsigned int            devno;          /* 0 or 1 */
 670         unsigned int            horkage;        /* List of broken features */
 671         unsigned long           flags;          /* ATA_DFLAG_xxx */
 672         struct scsi_device      *sdev;          /* attached SCSI device */
 673         void                    *private_data;
 674 #ifdef CONFIG_ATA_ACPI
 675         union acpi_object       *gtf_cache;
 676         unsigned int            gtf_filter;
 677 #endif
 678 #ifdef CONFIG_SATA_ZPODD
 679         void                    *zpodd;
 680 #endif
 681         struct device           tdev;
 682         /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
 683         u64                     n_sectors;      /* size of device, if ATA */
 684         u64                     n_native_sectors; /* native size, if ATA */
 685         unsigned int            class;          /* ATA_DEV_xxx */
 686         unsigned long           unpark_deadline;
 687
 688         u8                      pio_mode;
 689         u8                      dma_mode;
 690         u8                      xfer_mode;
 691         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
 692
 693         unsigned int            multi_count;    /* sectors count for
 694                                                    READ/WRITE MULTIPLE */
 695         unsigned int            max_sectors;    /* per-device max sectors */
 696         unsigned int            cdb_len;
 697
 698         /* per-dev xfer mask */
 699         unsigned long           pio_mask;
 700         unsigned long           mwdma_mask;
 701         unsigned long           udma_mask;
 702
 703         /* for CHS addressing */
 704         u16                     cylinders;      /* Number of cylinders */
 705         u16                     heads;          /* Number of heads */
 706         u16                     sectors;        /* Number of sectors per track */
 707
 708         union {
 709                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
 710                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
 711         };
 712
 713         /* DEVSLP Timing Variables from Identify Device Data Log */
 714         u8                      devslp_timing[ATA_LOG_DEVSLP_SIZE];
 715
 716         /* NCQ send and receive log subcommand support */
 717         u8                      ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_SIZE];
 718
 719         /* error history */
 720         int                     spdn_cnt;
 721         /* ering is CLEAR_END, read comment above CLEAR_END */
 722         struct ata_ering        ering;
 723 };
 724
 725 /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
 726  * cleared to zero on ata_dev_init().
 727  */
 728 #define ATA_DEVICE_CLEAR_BEGIN          offsetof(struct ata_device, n_sectors)
 729 #define ATA_DEVICE_CLEAR_END            offsetof(struct ata_device, ering)
 730
 731 struct ata_eh_info {
 732         struct ata_device       *dev;           /* offending device */
 733         u32                     serror;         /* SError from LLDD */
 734         unsigned int            err_mask;       /* port-wide err_mask */
 735         unsigned int            action;         /* ATA_EH_* action mask */
 736         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
 737         unsigned int            flags;          /* ATA_EHI_* flags */
 738
 739         unsigned int            probe_mask;
 740
 741         char                    desc[ATA_EH_DESC_LEN];
 742         int                     desc_len;
 743 };
 744
 745 struct ata_eh_context {
 746         struct ata_eh_info      i;
 747         int                     tries[ATA_MAX_DEVICES];
 748         int                     cmd_timeout_idx[ATA_MAX_DEVICES]
 749                                                [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
 750         unsigned int            classes[ATA_MAX_DEVICES];
 751         unsigned int            did_probe_mask;
 752         unsigned int            unloaded_mask;
 753         unsigned int            saved_ncq_enabled;
 754         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
 755         /* timestamp for the last reset attempt or success */
 756         unsigned long           last_reset;
 757 };
 758
 759 struct ata_acpi_drive
 760 {
 761         u32 pio;
 762         u32 dma;
 763 } __packed;
 764
 765 struct ata_acpi_gtm {
 766         struct ata_acpi_drive drive[2];
 767         u32 flags;
 768 } __packed;
 769
 770 struct ata_link {
 771         struct ata_port         *ap;
 772         int                     pmp;            /* port multiplier port # */
 773
 774         struct device           tdev;
 775         unsigned int            active_tag;     /* active tag on this link */
 776         u32                     sactive;        /* active NCQ commands */
 777
 778         unsigned int            flags;          /* ATA_LFLAG_xxx */
 779
 780         u32                     saved_scontrol; /* SControl on probe */
 781         unsigned int            hw_sata_spd_limit;
 782         unsigned int            sata_spd_limit;
 783         unsigned int            sata_spd;       /* current SATA PHY speed */
 784         enum ata_lpm_policy     lpm_policy;
 785
 786         /* record runtime error info, protected by host_set lock */
 787         struct ata_eh_info      eh_info;
 788         /* EH context */
 789         struct ata_eh_context   eh_context;
 790
 791         struct ata_device       device[ATA_MAX_DEVICES];
 792 };
 793 #define ATA_LINK_CLEAR_BEGIN            offsetof(struct ata_link, active_tag)
 794 #define ATA_LINK_CLEAR_END              offsetof(struct ata_link, device[0])
 795
 796 struct ata_port {
 797         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
 798         struct ata_port_operations *ops;
 799         spinlock_t              *lock;
 800         /* Flags owned by the EH context. Only EH should touch these once the
 801            port is active */
 802         unsigned long           flags;  /* ATA_FLAG_xxx */
 803         /* Flags that change dynamically, protected by ap->lock */
 804         unsigned int            pflags; /* ATA_PFLAG_xxx */
 805         unsigned int            print_id; /* user visible unique port ID */
 806         unsigned int            local_port_no; /* host local port num */
 807         unsigned int            port_no; /* 0 based port no. inside the host */
 808
 809 #ifdef CONFIG_ATA_SFF
 810         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
 811         u8                      ctl;    /* cache of ATA control register */
 812         u8                      last_ctl;       /* Cache last written value */
 813         struct ata_link*        sff_pio_task_link; /* link currently used */
 814         struct delayed_work     sff_pio_task;
 815 #ifdef CONFIG_ATA_BMDMA
 816         struct ata_bmdma_prd    *bmdma_prd;     /* BMDMA SG list */
 817         dma_addr_t              bmdma_prd_dma;  /* and its DMA mapping */
 818 #endif /* CONFIG_ATA_BMDMA */
 819 #endif /* CONFIG_ATA_SFF */
 820
 821         unsigned int            pio_mask;
 822         unsigned int            mwdma_mask;
 823         unsigned int            udma_mask;
 824         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
 825
 826         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
 827         unsigned long           sas_tag_allocated; /* for sas tag allocation only */
 828         unsigned int            qc_active;
 829         int                     nr_active_links; /* #links with active qcs */
 830         unsigned int            sas_last_tag;   /* track next tag hw expects */
 831
 832         struct ata_link         link;           /* host default link */
 833         struct ata_link         *slave_link;    /* see ata_slave_link_init() */
 834
 835         int                     nr_pmp_links;   /* nr of available PMP links */
 836         struct ata_link         *pmp_link;      /* array of PMP links */
 837         struct ata_link         *excl_link;     /* for PMP qc exclusion */
 838
 839         struct ata_port_stats   stats;
 840         struct ata_host         *host;
 841         struct device           *dev;
 842         struct device           tdev;
 843
 844         struct mutex            scsi_scan_mutex;
 845         struct delayed_work     hotplug_task;
 846         struct work_struct      scsi_rescan_task;
 847
 848         unsigned int            hsm_task_state;
 849
 850         u32                     msg_enable;
 851         struct list_head        eh_done_q;
 852         wait_queue_head_t       eh_wait_q;
 853         int                     eh_tries;
 854         struct completion       park_req_pending;
 855
 856         pm_message_t            pm_mesg;
 857         enum ata_lpm_policy     target_lpm_policy;
 858
 859         struct timer_list       fastdrain_timer;
 860         unsigned long           fastdrain_cnt;
 861
 862         int                     em_message_type;
 863         void                    *private_data;
 864
 865 #ifdef CONFIG_ATA_ACPI
 866         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
 867 #endif
 868         /* owned by EH */
 869         u8                      sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
 870 };
 871
 872 /* The following initializer overrides a method to NULL whether one of
 873  * its parent has the method defined or not.  This is equivalent to
 874  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
 875  * expression and thus can't be used as an initializer.
 876  */
 877 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
 878
 879 struct ata_port_operations {
 880         /*
 881          * Command execution
 882          */
 883         int  (*qc_defer)(struct ata_queued_cmd *qc);
 884         int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
 885         void (*qc_prep)(struct ata_queued_cmd *qc);
 886         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
 887         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
 888
 889         /*
 890          * Configuration and exception handling
 891          */
 892         int  (*cable_detect)(struct ata_port *ap);
 893         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
 894         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
 895         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
 896         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
 897         unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
 898
 899         void (*dev_config)(struct ata_device *dev);
 900
 901         void (*freeze)(struct ata_port *ap);
 902         void (*thaw)(struct ata_port *ap);
 903         ata_prereset_fn_t       prereset;
 904         ata_reset_fn_t          softreset;
 905         ata_reset_fn_t          hardreset;
 906         ata_postreset_fn_t      postreset;
 907         ata_prereset_fn_t       pmp_prereset;
 908         ata_reset_fn_t          pmp_softreset;
 909         ata_reset_fn_t          pmp_hardreset;
 910         ata_postreset_fn_t      pmp_postreset;
 911         void (*error_handler)(struct ata_port *ap);
 912         void (*lost_interrupt)(struct ata_port *ap);
 913         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
 914         void (*sched_eh)(struct ata_port *ap);
 915         void (*end_eh)(struct ata_port *ap);
 916
 917         /*
 918          * Optional features
 919          */
 920         int  (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
 921         int  (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
 922         void (*pmp_attach)(struct ata_port *ap);
 923         void (*pmp_detach)(struct ata_port *ap);
 924         int  (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
 925                         unsigned hints);
 926
 927         /*
 928          * Start, stop, suspend and resume
 929          */
 930         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
 931         int  (*port_resume)(struct ata_port *ap);
 932         int  (*port_start)(struct ata_port *ap);
 933         void (*port_stop)(struct ata_port *ap);
 934         void (*host_stop)(struct ata_host *host);
 935
 936 #ifdef CONFIG_ATA_SFF
 937         /*
 938          * SFF / taskfile oriented ops
 939          */
 940         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
 941         void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
 942         u8   (*sff_check_status)(struct ata_port *ap);
 943         u8   (*sff_check_altstatus)(struct ata_port *ap);
 944         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
 945         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
 946         void (*sff_exec_command)(struct ata_port *ap,
 947                                  const struct ata_taskfile *tf);
 948         unsigned int (*sff_data_xfer)(struct ata_device *dev,
 949                         unsigned char *buf, unsigned int buflen, int rw);
 950         void (*sff_irq_on)(struct ata_port *);
 951         bool (*sff_irq_check)(struct ata_port *);
 952         void (*sff_irq_clear)(struct ata_port *);
 953         void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
 954
 955 #ifdef CONFIG_ATA_BMDMA
 956         void (*bmdma_setup)(struct ata_queued_cmd *qc);
 957         void (*bmdma_start)(struct ata_queued_cmd *qc);
 958         void (*bmdma_stop)(struct ata_queued_cmd *qc);
 959         u8   (*bmdma_status)(struct ata_port *ap);
 960 #endif /* CONFIG_ATA_BMDMA */
 961 #endif /* CONFIG_ATA_SFF */
 962
 963         ssize_t (*em_show)(struct ata_port *ap, char *buf);
 964         ssize_t (*em_store)(struct ata_port *ap, const char *message,
 965                             size_t size);
 966         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
 967         ssize_t (*sw_activity_store)(struct ata_device *dev,
 968                                      enum sw_activity val);
 969         ssize_t (*transmit_led_message)(struct ata_port *ap, u32 state,
 970                                         ssize_t size);
 971
 972         /*
 973          * Obsolete
 974          */
 975         void (*phy_reset)(struct ata_port *ap);
 976         void (*eng_timeout)(struct ata_port *ap);
 977
 978         /*
 979          * ->inherits must be the last field and all the preceding
 980          * fields must be pointers.
 981          */
 982         const struct ata_port_operations        *inherits;
 983 };
 984
 985 struct ata_port_info {
 986         unsigned long           flags;
 987         unsigned long           link_flags;
 988         unsigned long           pio_mask;
 989         unsigned long           mwdma_mask;
 990         unsigned long           udma_mask;
 991         struct ata_port_operations *port_ops;
 992         void                    *private_data;
 993 };
 994
 995 struct ata_timing {
 996         unsigned short mode;            /* ATA mode */
 997         unsigned short setup;           /* t1 */
 998         unsigned short act8b;           /* t2 for 8-bit I/O */
 999         unsigned short rec8b;           /* t2i for 8-bit I/O */
1000         unsigned short cyc8b;           /* t0 for 8-bit I/O */
1001         unsigned short active;          /* t2 or tD */
1002         unsigned short recover;         /* t2i or tK */
1003         unsigned short dmack_hold;      /* tj */
1004         unsigned short cycle;           /* t0 */
1005         unsigned short udma;            /* t2CYCTYP/2 */
1006 };
1007
1008 /*
1009  * Core layer - drivers/ata/libata-core.c
1010  */
1011 extern const unsigned long sata_deb_timing_normal[];
1012 extern const unsigned long sata_deb_timing_hotplug[];
1013 extern const unsigned long sata_deb_timing_long[];
1014
1015 extern struct ata_port_operations ata_dummy_port_ops;
1016 extern const struct ata_port_info ata_dummy_port_info;
1017
1018 /*
1019  * protocol tests
1020  */
1021 static inline unsigned int ata_prot_flags(u8 prot)
1022 {
1023         switch (prot) {
1024         case ATA_PROT_NODATA:
1025                 return 0;
1026         case ATA_PROT_PIO:
1027                 return ATA_PROT_FLAG_PIO;
1028         case ATA_PROT_DMA:
1029                 return ATA_PROT_FLAG_DMA;
1030         case ATA_PROT_NCQ:
1031                 return ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ;
1032         case ATAPI_PROT_NODATA:
1033                 return ATA_PROT_FLAG_ATAPI;
1034         case ATAPI_PROT_PIO:
1035                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO;
1036         case ATAPI_PROT_DMA:
1037                 return ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA;
1038         }
1039         return 0;
1040 }
1041
1042 static inline int ata_is_atapi(u8 prot)
1043 {
1044         return ata_prot_flags(prot) & ATA_PROT_FLAG_ATAPI;
1045 }
1046
1047 static inline int ata_is_nodata(u8 prot)
1048 {
1049         return !(ata_prot_flags(prot) & ATA_PROT_FLAG_DATA);
1050 }
1051
1052 static inline int ata_is_pio(u8 prot)
1053 {
1054         return ata_prot_flags(prot) & ATA_PROT_FLAG_PIO;
1055 }
1056
1057 static inline int ata_is_dma(u8 prot)
1058 {
1059         return ata_prot_flags(prot) & ATA_PROT_FLAG_DMA;
1060 }
1061
1062 static inline int ata_is_ncq(u8 prot)
1063 {
1064         return ata_prot_flags(prot) & ATA_PROT_FLAG_NCQ;
1065 }
1066
1067 static inline int ata_is_data(u8 prot)
1068 {
1069         return ata_prot_flags(prot) & ATA_PROT_FLAG_DATA;
1070 }
1071
1072 static inline int is_multi_taskfile(struct ata_taskfile *tf)
1073 {
1074         return (tf->command == ATA_CMD_READ_MULTI) ||
1075                (tf->command == ATA_CMD_WRITE_MULTI) ||
1076                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
1077                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
1078                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
1079 }
1080
1081 static inline const unsigned long *
1082 sata_ehc_deb_timing(struct ata_eh_context *ehc)
1083 {
1084         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
1085                 return sata_deb_timing_hotplug;
1086         else
1087                 return sata_deb_timing_normal;
1088 }
1089
1090 static inline int ata_port_is_dummy(struct ata_port *ap)
1091 {
1092         return ap->ops == &ata_dummy_port_ops;
1093 }
1094
1095 extern int sata_set_spd(struct ata_link *link);
1096 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
1097 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
1098                                 int (*check_ready)(struct ata_link *link));
1099 extern int sata_link_debounce(struct ata_link *link,
1100                         const unsigned long *params, unsigned long deadline);
1101 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
1102                             unsigned long deadline);
1103 extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
1104                              bool spm_wakeup);
1105 extern int sata_link_hardreset(struct ata_link *link,
1106                         const unsigned long *timing, unsigned long deadline,
1107                         bool *online, int (*check_ready)(struct ata_link *));
1108 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
1109                               unsigned long deadline);
1110 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
1111
1112 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
1113 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
1114                         const struct ata_port_info * const * ppi, int n_ports);
1115 extern int ata_slave_link_init(struct ata_port *ap);
1116 extern int ata_host_start(struct ata_host *host);
1117 extern int ata_host_register(struct ata_host *host,
1118                              struct scsi_host_template *sht);
1119 extern int ata_host_activate(struct ata_host *host, int irq,
1120                              irq_handler_t irq_handler, unsigned long irq_flags,
1121                              struct scsi_host_template *sht);
1122 extern void ata_host_detach(struct ata_host *host);
1123 extern void ata_host_init(struct ata_host *, struct device *, struct ata_port_operations *);
1124 extern int ata_scsi_detect(struct scsi_host_template *sht);
1125 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
1126 extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
1127 extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
1128                             int cmd, void __user *arg);
1129 extern void ata_sas_port_destroy(struct ata_port *);
1130 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
1131                                            struct ata_port_info *, struct Scsi_Host *);
1132 extern void ata_sas_async_probe(struct ata_port *ap);
1133 extern int ata_sas_sync_probe(struct ata_port *ap);
1134 extern int ata_sas_port_init(struct ata_port *);
1135 extern int ata_sas_port_start(struct ata_port *ap);
1136 extern void ata_sas_port_stop(struct ata_port *ap);
1137 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
1138 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
1139 extern int sata_scr_valid(struct ata_link *link);
1140 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
1141 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
1142 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
1143 extern bool ata_link_online(struct ata_link *link);
1144 extern bool ata_link_offline(struct ata_link *link);
1145 #ifdef CONFIG_PM
1146 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
1147 extern void ata_host_resume(struct ata_host *host);
1148 extern void ata_sas_port_suspend(struct ata_port *ap);
1149 extern void ata_sas_port_resume(struct ata_port *ap);
1150 #else
1151 static inline void ata_sas_port_suspend(struct ata_port *ap)
1152 {
1153 }
1154 static inline void ata_sas_port_resume(struct ata_port *ap)
1155 {
1156 }
1157 #endif
1158 extern int ata_ratelimit(void);
1159 extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
1160 extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
1161                         u32 val, unsigned long interval, unsigned long timeout);
1162 extern int atapi_cmd_type(u8 opcode);
1163 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
1164                           u8 pmp, int is_cmd, u8 *fis);
1165 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
1166 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
1167                         unsigned long mwdma_mask, unsigned long udma_mask);
1168 extern void ata_unpack_xfermask(unsigned long xfer_mask,
1169                         unsigned long *pio_mask, unsigned long *mwdma_mask,
1170                         unsigned long *udma_mask);
1171 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
1172 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
1173 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
1174 extern const char *ata_mode_string(unsigned long xfer_mask);
1175 extern unsigned long ata_id_xfermask(const u16 *id);
1176 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
1177 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
1178 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
1179                  unsigned int n_elem);
1180 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
1181 extern void ata_dev_disable(struct ata_device *adev);
1182 extern void ata_id_string(const u16 *id, unsigned char *s,
1183                           unsigned int ofs, unsigned int len);
1184 extern void ata_id_c_string(const u16 *id, unsigned char *s,
1185                             unsigned int ofs, unsigned int len);
1186 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
1187                                         struct ata_taskfile *tf, u16 *id);
1188 extern void ata_qc_complete(struct ata_queued_cmd *qc);
1189 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
1190 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
1191 extern int ata_std_bios_param(struct scsi_device *sdev,
1192                               struct block_device *bdev,
1193                               sector_t capacity, int geom[]);
1194 extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
1195 extern int ata_scsi_slave_config(struct scsi_device *sdev);
1196 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
1197 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
1198                                        int queue_depth);
1199 extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1200                                     int queue_depth);
1201 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
1202 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
1203 extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
1204 extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
1205
1206 extern int ata_cable_40wire(struct ata_port *ap);
1207 extern int ata_cable_80wire(struct ata_port *ap);
1208 extern int ata_cable_sata(struct ata_port *ap);
1209 extern int ata_cable_ignore(struct ata_port *ap);
1210 extern int ata_cable_unknown(struct ata_port *ap);
1211
1212 /* Timing helpers */
1213 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
1214 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
1215 extern int ata_timing_compute(struct ata_device *, unsigned short,
1216                               struct ata_timing *, int, int);
1217 extern void ata_timing_merge(const struct ata_timing *,
1218                              const struct ata_timing *, struct ata_timing *,
1219                              unsigned int);
1220 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
1221
1222 /* PCI */
1223 #ifdef CONFIG_PCI
1224 struct pci_dev;
1225
1226 struct pci_bits {
1227         unsigned int            reg;    /* PCI config register to read */
1228         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
1229         unsigned long           mask;
1230         unsigned long           val;
1231 };
1232
1233 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1234 extern void ata_pci_remove_one(struct pci_dev *pdev);
1235
1236 #ifdef CONFIG_PM
1237 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1238 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1239 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1240 extern int ata_pci_device_resume(struct pci_dev *pdev);
1241 #endif /* CONFIG_PM */
1242 #endif /* CONFIG_PCI */
1243
1244 struct platform_device;
1245
1246 extern int ata_platform_remove_one(struct platform_device *pdev);
1247
1248 /*
1249  * ACPI - drivers/ata/libata-acpi.c
1250  */
1251 #ifdef CONFIG_ATA_ACPI
1252 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1253 {
1254         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1255                 return &ap->__acpi_init_gtm;
1256         return NULL;
1257 }
1258 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1259 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1260 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1261                                     const struct ata_acpi_gtm *gtm);
1262 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1263 #else
1264 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1265 {
1266         return NULL;
1267 }
1268
1269 static inline int ata_acpi_stm(const struct ata_port *ap,
1270                                struct ata_acpi_gtm *stm)
1271 {
1272         return -ENOSYS;
1273 }
1274
1275 static inline int ata_acpi_gtm(const struct ata_port *ap,
1276                                struct ata_acpi_gtm *stm)
1277 {
1278         return -ENOSYS;
1279 }
1280
1281 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1282                                         const struct ata_acpi_gtm *gtm)
1283 {
1284         return 0;
1285 }
1286
1287 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1288                                       const struct ata_acpi_gtm *gtm)
1289 {
1290         return 0;
1291 }
1292 #endif
1293
1294 /*
1295  * EH - drivers/ata/libata-eh.c
1296  */
1297 extern void ata_port_schedule_eh(struct ata_port *ap);
1298 extern void ata_port_wait_eh(struct ata_port *ap);
1299 extern int ata_link_abort(struct ata_link *link);
1300 extern int ata_port_abort(struct ata_port *ap);
1301 extern int ata_port_freeze(struct ata_port *ap);
1302 extern int sata_async_notification(struct ata_port *ap);
1303
1304 extern void ata_eh_freeze_port(struct ata_port *ap);
1305 extern void ata_eh_thaw_port(struct ata_port *ap);
1306
1307 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1308 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1309 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1310
1311 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1312                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1313                       ata_postreset_fn_t postreset);
1314 extern void ata_std_error_handler(struct ata_port *ap);
1315 extern void ata_std_sched_eh(struct ata_port *ap);
1316 extern void ata_std_end_eh(struct ata_port *ap);
1317 extern int ata_link_nr_enabled(struct ata_link *link);
1318
1319 /*
1320  * Base operations to inherit from and initializers for sht
1321  *
1322  * Operations
1323  *
1324  * base  : Common to all libata drivers.
1325  * sata  : SATA controllers w/ native interface.
1326  * pmp   : SATA controllers w/ PMP support.
1327  * sff   : SFF ATA controllers w/o BMDMA support.
1328  * bmdma : SFF ATA controllers w/ BMDMA support.
1329  *
1330  * sht initializers
1331  *
1332  * BASE  : Common to all libata drivers.  The user must set
1333  *         sg_tablesize and dma_boundary.
1334  * PIO   : SFF ATA controllers w/ only PIO support.
1335  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1336  *         dma_boundary are set to BMDMA limits.
1337  * NCQ   : SATA controllers supporting NCQ.  The user must set
1338  *         sg_tablesize, dma_boundary and can_queue.
1339  */
1340 extern const struct ata_port_operations ata_base_port_ops;
1341 extern const struct ata_port_operations sata_port_ops;
1342 extern struct device_attribute *ata_common_sdev_attrs[];
1343
1344 /*
1345  * All sht initializers (BASE, PIO, BMDMA, NCQ) must be instantiated
1346  * by the edge drivers.  Because the 'module' field of sht must be the
1347  * edge driver's module reference, otherwise the driver can be unloaded
1348  * even if the scsi_device is being accessed.
1349  */
1350 #define ATA_BASE_SHT(drv_name)                                  \
1351         .module                 = THIS_MODULE,                  \
1352         .name                   = drv_name,                     \
1353         .ioctl                  = ata_scsi_ioctl,               \
1354         .queuecommand           = ata_scsi_queuecmd,            \
1355         .can_queue              = ATA_DEF_QUEUE,                \
1356         .tag_alloc_policy       = BLK_TAG_ALLOC_RR,             \
1357         .this_id                = ATA_SHT_THIS_ID,              \
1358         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,          \
1359         .emulated               = ATA_SHT_EMULATED,             \
1360         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1361         .proc_name              = drv_name,                     \
1362         .slave_configure        = ata_scsi_slave_config,        \
1363         .slave_destroy          = ata_scsi_slave_destroy,       \
1364         .bios_param             = ata_std_bios_param,           \
1365         .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
1366         .sdev_attrs             = ata_common_sdev_attrs
1367
1368 #define ATA_NCQ_SHT(drv_name)                                   \
1369         ATA_BASE_SHT(drv_name),                                 \
1370         .change_queue_depth     = ata_scsi_change_queue_depth
1371
1372 /*
1373  * PMP helpers
1374  */
1375 #ifdef CONFIG_SATA_PMP
1376 static inline bool sata_pmp_supported(struct ata_port *ap)
1377 {
1378         return ap->flags & ATA_FLAG_PMP;
1379 }
1380
1381 static inline bool sata_pmp_attached(struct ata_port *ap)
1382 {
1383         return ap->nr_pmp_links != 0;
1384 }
1385
1386 static inline int ata_is_host_link(const struct ata_link *link)
1387 {
1388         return link == &link->ap->link || link == link->ap->slave_link;
1389 }
1390 #else /* CONFIG_SATA_PMP */
1391 static inline bool sata_pmp_supported(struct ata_port *ap)
1392 {
1393         return false;
1394 }
1395
1396 static inline bool sata_pmp_attached(struct ata_port *ap)
1397 {
1398         return false;
1399 }
1400
1401 static inline int ata_is_host_link(const struct ata_link *link)
1402 {
1403         return 1;
1404 }
1405 #endif /* CONFIG_SATA_PMP */
1406
1407 static inline int sata_srst_pmp(struct ata_link *link)
1408 {
1409         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1410                 return SATA_PMP_CTRL_PORT;
1411         return link->pmp;
1412 }
1413
1414 /*
1415  * printk helpers
1416  */
1417 __printf(3, 4)
1418 void ata_port_printk(const struct ata_port *ap, const char *level,
1419                      const char *fmt, ...);
1420 __printf(3, 4)
1421 void ata_link_printk(const struct ata_link *link, const char *level,
1422                      const char *fmt, ...);
1423 __printf(3, 4)
1424 void ata_dev_printk(const struct ata_device *dev, const char *level,
1425                     const char *fmt, ...);
1426
1427 #define ata_port_err(ap, fmt, ...)                              \
1428         ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
1429 #define ata_port_warn(ap, fmt, ...)                             \
1430         ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
1431 #define ata_port_notice(ap, fmt, ...)                           \
1432         ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
1433 #define ata_port_info(ap, fmt, ...)                             \
1434         ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
1435 #define ata_port_dbg(ap, fmt, ...)                              \
1436         ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
1437
1438 #define ata_link_err(link, fmt, ...)                            \
1439         ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
1440 #define ata_link_warn(link, fmt, ...)                           \
1441         ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
1442 #define ata_link_notice(link, fmt, ...)                         \
1443         ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
1444 #define ata_link_info(link, fmt, ...)                           \
1445         ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
1446 #define ata_link_dbg(link, fmt, ...)                            \
1447         ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
1448
1449 #define ata_dev_err(dev, fmt, ...)                              \
1450         ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
1451 #define ata_dev_warn(dev, fmt, ...)                             \
1452         ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
1453 #define ata_dev_notice(dev, fmt, ...)                           \
1454         ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
1455 #define ata_dev_info(dev, fmt, ...)                             \
1456         ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
1457 #define ata_dev_dbg(dev, fmt, ...)                              \
1458         ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
1459
1460 void ata_print_version(const struct device *dev, const char *version);
1461
1462 /*
1463  * ata_eh_info helpers
1464  */
1465 extern __printf(2, 3)
1466 void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1467 extern __printf(2, 3)
1468 void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
1469 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1470
1471 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1472 {
1473         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1474         ehi->flags |= ATA_EHI_HOTPLUGGED;
1475         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1476         ehi->err_mask |= AC_ERR_ATA_BUS;
1477 }
1478
1479 /*
1480  * port description helpers
1481  */
1482 extern __printf(2, 3)
1483 void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
1484 #ifdef CONFIG_PCI
1485 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1486                                const char *name);
1487 #endif
1488
1489 static inline unsigned int ata_tag_valid(unsigned int tag)
1490 {
1491         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1492 }
1493
1494 static inline unsigned int ata_tag_internal(unsigned int tag)
1495 {
1496         return tag == ATA_TAG_INTERNAL;
1497 }
1498
1499 /*
1500  * device helpers
1501  */
1502 static inline unsigned int ata_class_enabled(unsigned int class)
1503 {
1504         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1505                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB ||
1506                 class == ATA_DEV_ZAC;
1507 }
1508
1509 static inline unsigned int ata_class_disabled(unsigned int class)
1510 {
1511         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1512                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1513 }
1514
1515 static inline unsigned int ata_class_absent(unsigned int class)
1516 {
1517         return !ata_class_enabled(class) && !ata_class_disabled(class);
1518 }
1519
1520 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1521 {
1522         return ata_class_enabled(dev->class);
1523 }
1524
1525 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1526 {
1527         return ata_class_disabled(dev->class);
1528 }
1529
1530 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1531 {
1532         return ata_class_absent(dev->class);
1533 }
1534
1535 /*
1536  * link helpers
1537  */
1538 static inline int ata_link_max_devices(const struct ata_link *link)
1539 {
1540         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1541                 return 2;
1542         return 1;
1543 }
1544
1545 static inline int ata_link_active(struct ata_link *link)
1546 {
1547         return ata_tag_valid(link->active_tag) || link->sactive;
1548 }
1549
1550 /*
1551  * Iterators
1552  *
1553  * ATA_LITER_* constants are used to select link iteration mode and
1554  * ATA_DITER_* device iteration mode.
1555  *
1556  * For a custom iteration directly using ata_{link|dev}_next(), if
1557  * @link or @dev, respectively, is NULL, the first element is
1558  * returned.  @dev and @link can be any valid device or link and the
1559  * next element according to the iteration mode will be returned.
1560  * After the last element, NULL is returned.
1561  */
1562 enum ata_link_iter_mode {
1563         ATA_LITER_EDGE,         /* if present, PMP links only; otherwise,
1564                                  * host link.  no slave link */
1565         ATA_LITER_HOST_FIRST,   /* host link followed by PMP or slave links */
1566         ATA_LITER_PMP_FIRST,    /* PMP links followed by host link,
1567                                  * slave link still comes after host link */
1568 };
1569
1570 enum ata_dev_iter_mode {
1571         ATA_DITER_ENABLED,
1572         ATA_DITER_ENABLED_REVERSE,
1573         ATA_DITER_ALL,
1574         ATA_DITER_ALL_REVERSE,
1575 };
1576
1577 extern struct ata_link *ata_link_next(struct ata_link *link,
1578                                       struct ata_port *ap,
1579                                       enum ata_link_iter_mode mode);
1580
1581 extern struct ata_device *ata_dev_next(struct ata_device *dev,
1582                                        struct ata_link *link,
1583                                        enum ata_dev_iter_mode mode);
1584
1585 /*
1586  * Shortcut notation for iterations
1587  *
1588  * ata_for_each_link() iterates over each link of @ap according to
1589  * @mode.  @link points to the current link in the loop.  @link is
1590  * NULL after loop termination.  ata_for_each_dev() works the same way
1591  * except that it iterates over each device of @link.
1592  *
1593  * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
1594  * specified when using the following shorthand notations.  Only the
1595  * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
1596  * specified.  This not only increases brevity but also makes it
1597  * impossible to use ATA_LITER_* for device iteration or vice-versa.
1598  */
1599 #define ata_for_each_link(link, ap, mode) \
1600         for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
1601              (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
1602
1603 #define ata_for_each_dev(dev, link, mode) \
1604         for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
1605              (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
1606
1607 /**
1608  *      ata_ncq_enabled - Test whether NCQ is enabled
1609  *      @dev: ATA device to test for
1610  *
1611  *      LOCKING:
1612  *      spin_lock_irqsave(host lock)
1613  *
1614  *      RETURNS:
1615  *      1 if NCQ is enabled for @dev, 0 otherwise.
1616  */
1617 static inline int ata_ncq_enabled(struct ata_device *dev)
1618 {
1619         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1620                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1621 }
1622
1623 static inline bool ata_fpdma_dsm_supported(struct ata_device *dev)
1624 {
1625         return (dev->flags & ATA_DFLAG_NCQ_SEND_RECV) &&
1626                 (dev->ncq_send_recv_cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &
1627                  ATA_LOG_NCQ_SEND_RECV_DSM_TRIM);
1628 }
1629
1630 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1631 {
1632         qc->tf.ctl |= ATA_NIEN;
1633 }
1634
1635 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1636                                                        unsigned int tag)
1637 {
1638         if (likely(ata_tag_valid(tag)))
1639                 return &ap->qcmd[tag];
1640         return NULL;
1641 }
1642
1643 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1644                                                      unsigned int tag)
1645 {
1646         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1647
1648         if (unlikely(!qc) || !ap->ops->error_handler)
1649                 return qc;
1650
1651         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1652                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1653                 return qc;
1654
1655         return NULL;
1656 }
1657
1658 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1659 {
1660         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1661 }
1662
1663 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1664 {
1665         memset(tf, 0, sizeof(*tf));
1666
1667 #ifdef CONFIG_ATA_SFF
1668         tf->ctl = dev->link->ap->ctl;
1669 #else
1670         tf->ctl = ATA_DEVCTL_OBS;
1671 #endif
1672         if (dev->devno == 0)
1673                 tf->device = ATA_DEVICE_OBS;
1674         else
1675                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1676 }
1677
1678 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1679 {
1680         qc->dma_dir = DMA_NONE;
1681         qc->sg = NULL;
1682         qc->flags = 0;
1683         qc->cursg = NULL;
1684         qc->cursg_ofs = 0;
1685         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1686         qc->n_elem = 0;
1687         qc->err_mask = 0;
1688         qc->sect_size = ATA_SECT_SIZE;
1689
1690         ata_tf_init(qc->dev, &qc->tf);
1691
1692         /* init result_tf such that it indicates normal completion */
1693         qc->result_tf.command = ATA_DRDY;
1694         qc->result_tf.feature = 0;
1695 }
1696
1697 static inline int ata_try_flush_cache(const struct ata_device *dev)
1698 {
1699         return ata_id_wcache_enabled(dev->id) ||
1700                ata_id_has_flush(dev->id) ||
1701                ata_id_has_flush_ext(dev->id);
1702 }
1703
1704 static inline unsigned int ac_err_mask(u8 status)
1705 {
1706         if (status & (ATA_BUSY | ATA_DRQ))
1707                 return AC_ERR_HSM;
1708         if (status & (ATA_ERR | ATA_DF))
1709                 return AC_ERR_DEV;
1710         return 0;
1711 }
1712
1713 static inline unsigned int __ac_err_mask(u8 status)
1714 {
1715         unsigned int mask = ac_err_mask(status);
1716         if (mask == 0)
1717                 return AC_ERR_OTHER;
1718         return mask;
1719 }
1720
1721 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1722 {
1723         return *(struct ata_port **)&host->hostdata[0];
1724 }
1725
1726 static inline int ata_check_ready(u8 status)
1727 {
1728         if (!(status & ATA_BUSY))
1729                 return 1;
1730
1731         /* 0xff indicates either no device or device not ready */
1732         if (status == 0xff)
1733                 return -ENODEV;
1734
1735         return 0;
1736 }
1737
1738 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1739                                          unsigned long timeout_msecs)
1740 {
1741         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1742 }
1743
1744 /* Don't open code these in drivers as there are traps. Firstly the range may
1745    change in future hardware and specs, secondly 0xFF means 'no DMA' but is
1746    > UDMA_0. Dyma ddreigiau */
1747
1748 static inline int ata_using_mwdma(struct ata_device *adev)
1749 {
1750         if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
1751                 return 1;
1752         return 0;
1753 }
1754
1755 static inline int ata_using_udma(struct ata_device *adev)
1756 {
1757         if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
1758                 return 1;
1759         return 0;
1760 }
1761
1762 static inline int ata_dma_enabled(struct ata_device *adev)
1763 {
1764         return (adev->dma_mode == 0xFF ? 0 : 1);
1765 }
1766
1767 /**************************************************************************
1768  * PMP - drivers/ata/libata-pmp.c
1769  */
1770 #ifdef CONFIG_SATA_PMP
1771
1772 extern const struct ata_port_operations sata_pmp_port_ops;
1773
1774 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1775 extern void sata_pmp_error_handler(struct ata_port *ap);
1776
1777 #else /* CONFIG_SATA_PMP */
1778
1779 #define sata_pmp_port_ops               sata_port_ops
1780 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1781 #define sata_pmp_error_handler          ata_std_error_handler
1782
1783 #endif /* CONFIG_SATA_PMP */
1784
1785
1786 /**************************************************************************
1787  * SFF - drivers/ata/libata-sff.c
1788  */
1789 #ifdef CONFIG_ATA_SFF
1790
1791 extern const struct ata_port_operations ata_sff_port_ops;
1792 extern const struct ata_port_operations ata_bmdma32_port_ops;
1793
1794 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1795 #define ATA_PIO_SHT(drv_name)                                   \
1796         ATA_BASE_SHT(drv_name),                                 \
1797         .sg_tablesize           = LIBATA_MAX_PRD,               \
1798         .dma_boundary           = ATA_DMA_BOUNDARY
1799
1800 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1801 extern u8 ata_sff_check_status(struct ata_port *ap);
1802 extern void ata_sff_pause(struct ata_port *ap);
1803 extern void ata_sff_dma_pause(struct ata_port *ap);
1804 extern int ata_sff_busy_sleep(struct ata_port *ap,
1805                               unsigned long timeout_pat, unsigned long timeout);
1806 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1807 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1808 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1809 extern void ata_sff_exec_command(struct ata_port *ap,
1810                                  const struct ata_taskfile *tf);
1811 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1812                         unsigned char *buf, unsigned int buflen, int rw);
1813 extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
1814                         unsigned char *buf, unsigned int buflen, int rw);
1815 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1816                         unsigned char *buf, unsigned int buflen, int rw);
1817 extern void ata_sff_irq_on(struct ata_port *ap);
1818 extern void ata_sff_irq_clear(struct ata_port *ap);
1819 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1820                             u8 status, int in_wq);
1821 extern void ata_sff_queue_work(struct work_struct *work);
1822 extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
1823                 unsigned long delay);
1824 extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
1825 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1826 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1827 extern unsigned int ata_sff_port_intr(struct ata_port *ap,
1828                                       struct ata_queued_cmd *qc);
1829 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1830 extern void ata_sff_lost_interrupt(struct ata_port *ap);
1831 extern void ata_sff_freeze(struct ata_port *ap);
1832 extern void ata_sff_thaw(struct ata_port *ap);
1833 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1834 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1835                                           u8 *r_err);
1836 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1837                                     unsigned long deadline);
1838 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1839                              unsigned long deadline);
1840 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1841                                unsigned long deadline);
1842 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1843 extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
1844 extern void ata_sff_error_handler(struct ata_port *ap);
1845 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1846 #ifdef CONFIG_PCI
1847 extern int ata_pci_sff_init_host(struct ata_host *host);
1848 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1849                                     const struct ata_port_info * const * ppi,
1850                                     struct ata_host **r_host);
1851 extern int ata_pci_sff_activate_host(struct ata_host *host,
1852                                      irq_handler_t irq_handler,
1853                                      struct scsi_host_template *sht);
1854 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1855                 const struct ata_port_info * const * ppi,
1856                 struct scsi_host_template *sht, void *host_priv, int hflags);
1857 #endif /* CONFIG_PCI */
1858
1859 #ifdef CONFIG_ATA_BMDMA
1860
1861 extern const struct ata_port_operations ata_bmdma_port_ops;
1862
1863 #define ATA_BMDMA_SHT(drv_name)                                 \
1864         ATA_BASE_SHT(drv_name),                                 \
1865         .sg_tablesize           = LIBATA_MAX_PRD,               \
1866         .dma_boundary           = ATA_DMA_BOUNDARY
1867
1868 extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
1869 extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
1870 extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
1871 extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
1872                                       struct ata_queued_cmd *qc);
1873 extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
1874 extern void ata_bmdma_error_handler(struct ata_port *ap);
1875 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
1876 extern void ata_bmdma_irq_clear(struct ata_port *ap);
1877 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1878 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1879 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1880 extern u8 ata_bmdma_status(struct ata_port *ap);
1881 extern int ata_bmdma_port_start(struct ata_port *ap);
1882 extern int ata_bmdma_port_start32(struct ata_port *ap);
1883
1884 #ifdef CONFIG_PCI
1885 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1886 extern void ata_pci_bmdma_init(struct ata_host *host);
1887 extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
1888                                       const struct ata_port_info * const * ppi,
1889                                       struct ata_host **r_host);
1890 extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
1891                                   const struct ata_port_info * const * ppi,
1892                                   struct scsi_host_template *sht,
1893                                   void *host_priv, int hflags);
1894 #endif /* CONFIG_PCI */
1895 #endif /* CONFIG_ATA_BMDMA */
1896
1897 /**
1898  *      ata_sff_busy_wait - Wait for a port status register
1899  *      @ap: Port to wait for.
1900  *      @bits: bits that must be clear
1901  *      @max: number of 10uS waits to perform
1902  *
1903  *      Waits up to max*10 microseconds for the selected bits in the port's
1904  *      status register to be cleared.
1905  *      Returns final value of status register.
1906  *
1907  *      LOCKING:
1908  *      Inherited from caller.
1909  */
1910 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1911                                    unsigned int max)
1912 {
1913         u8 status;
1914
1915         do {
1916                 udelay(10);
1917                 status = ap->ops->sff_check_status(ap);
1918                 max--;
1919         } while (status != 0xff && (status & bits) && (max > 0));
1920
1921         return status;
1922 }
1923
1924 /**
1925  *      ata_wait_idle - Wait for a port to be idle.
1926  *      @ap: Port to wait for.
1927  *
1928  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1929  *      Returns final value of status register.
1930  *
1931  *      LOCKING:
1932  *      Inherited from caller.
1933  */
1934 static inline u8 ata_wait_idle(struct ata_port *ap)
1935 {
1936         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1937
1938 #ifdef ATA_DEBUG
1939         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1940                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1941                                 status);
1942 #endif
1943
1944         return status;
1945 }
1946 #endif /* CONFIG_ATA_SFF */
1947
1948 #endif /* __LINUX_LIBATA_H__ */