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