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