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