include/linux/libata.h

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