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