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