include/linux/libata.h

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