include/linux/ide.h

   1 #ifndef _IDE_H
   2 #define _IDE_H
   3 /*
   4  *  linux/include/linux/ide.h
   5  *
   6  *  Copyright (C) 1994-2002  Linus Torvalds & authors
   7  */
   8
   9 #include <linux/init.h>
  10 #include <linux/ioport.h>
  11 #include <linux/ata.h>
  12 #include <linux/blkdev.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/bitops.h>
  16 #include <linux/bio.h>
  17 #include <linux/device.h>
  18 #include <linux/pci.h>
  19 #include <linux/completion.h>
  20 #include <linux/pm.h>
  21 #ifdef CONFIG_BLK_DEV_IDEACPI
  22 #include <acpi/acpi.h>
  23 #endif
  24 #include <asm/byteorder.h>
  25 #include <asm/system.h>
  26 #include <asm/io.h>
  27 #include <asm/mutex.h>
  28
  29 /* for request_sense */
  30 #include <linux/cdrom.h>
  31
  32 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV) || defined(CONFIG_MN10300)
  33 # define SUPPORT_VLB_SYNC 0
  34 #else
  35 # define SUPPORT_VLB_SYNC 1
  36 #endif
  37
  38 /*
  39  * Probably not wise to fiddle with these
  40  */
  41 #define IDE_DEFAULT_MAX_FAILURES        1
  42 #define ERROR_MAX       8       /* Max read/write errors per sector */
  43 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  44 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  45
  46 /* Error codes returned in rq->errors to the higher part of the driver. */
  47 enum {
  48         IDE_DRV_ERROR_GENERAL   = 101,
  49         IDE_DRV_ERROR_FILEMARK  = 102,
  50         IDE_DRV_ERROR_EOD       = 103,
  51 };
  52
  53 /*
  54  * Definitions for accessing IDE controller registers
  55  */
  56 #define IDE_NR_PORTS            (10)
  57
  58 struct ide_io_ports {
  59         unsigned long   data_addr;
  60
  61         union {
  62                 unsigned long error_addr;       /*   read:  error */
  63                 unsigned long feature_addr;     /*  write: feature */
  64         };
  65
  66         unsigned long   nsect_addr;
  67         unsigned long   lbal_addr;
  68         unsigned long   lbam_addr;
  69         unsigned long   lbah_addr;
  70
  71         unsigned long   device_addr;
  72
  73         union {
  74                 unsigned long status_addr;      /*  read: status  */
  75                 unsigned long command_addr;     /* write: command */
  76         };
  77
  78         unsigned long   ctl_addr;
  79
  80         unsigned long   irq_addr;
  81 };
  82
  83 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
  84
  85 #define BAD_R_STAT      (ATA_BUSY | ATA_ERR)
  86 #define BAD_W_STAT      (BAD_R_STAT | ATA_DF)
  87 #define BAD_STAT        (BAD_R_STAT | ATA_DRQ)
  88 #define DRIVE_READY     (ATA_DRDY | ATA_DSC)
  89
  90 #define BAD_CRC         (ATA_ABORTED | ATA_ICRC)
  91
  92 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
  93
  94 #define SATA_STATUS_OFFSET      (0)
  95 #define SATA_ERROR_OFFSET       (1)
  96 #define SATA_CONTROL_OFFSET     (2)
  97
  98 /*
  99  * Our Physical Region Descriptor (PRD) table should be large enough
 100  * to handle the biggest I/O request we are likely to see.  Since requests
 101  * can have no more than 256 sectors, and since the typical blocksize is
 102  * two or more sectors, we could get by with a limit of 128 entries here for
 103  * the usual worst case.  Most requests seem to include some contiguous blocks,
 104  * further reducing the number of table entries required.
 105  *
 106  * The driver reverts to PIO mode for individual requests that exceed
 107  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 108  * 100% of all crazy scenarios here is not necessary.
 109  *
 110  * As it turns out though, we must allocate a full 4KB page for this,
 111  * so the two PRD tables (ide0 & ide1) will each get half of that,
 112  * allowing each to have about 256 entries (8 bytes each) from this.
 113  */
 114 #define PRD_BYTES       8
 115 #define PRD_ENTRIES     256
 116
 117 /*
 118  * Some more useful definitions
 119  */
 120 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 121 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 122 #define SECTOR_SIZE     512
 123
 124 /*
 125  * Timeouts for various operations:
 126  */
 127 enum {
 128         /* spec allows up to 20ms */
 129         WAIT_DRQ        = HZ / 10,      /* 100ms */
 130         /* some laptops are very slow */
 131         WAIT_READY      = 5 * HZ,       /* 5s */
 132         /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
 133         WAIT_PIDENTIFY  = 10 * HZ,      /* 10s */
 134         /* worst case when spinning up */
 135         WAIT_WORSTCASE  = 30 * HZ,      /* 30s */
 136         /* maximum wait for an IRQ to happen */
 137         WAIT_CMD        = 10 * HZ,      /* 10s */
 138         /* Some drives require a longer IRQ timeout. */
 139         WAIT_FLOPPY_CMD = 50 * HZ,      /* 50s */
 140         /*
 141          * Some drives (for example, Seagate STT3401A Travan) require a very
 142          * long timeout, because they don't return an interrupt or clear their
 143          * BSY bit until after the command completes (even retension commands).
 144          */
 145         WAIT_TAPE_CMD   = 900 * HZ,     /* 900s */
 146         /* minimum sleep time */
 147         WAIT_MIN_SLEEP  = HZ / 50,      /* 20ms */
 148 };
 149
 150 /*
 151  * Op codes for special requests to be handled by ide_special_rq().
 152  * Values should be in the range of 0x20 to 0x3f.
 153  */
 154 #define REQ_DRIVE_RESET         0x20
 155 #define REQ_DEVSET_EXEC         0x21
 156 #define REQ_PARK_HEADS          0x22
 157 #define REQ_UNPARK_HEADS        0x23
 158
 159 /*
 160  * Check for an interrupt and acknowledge the interrupt status
 161  */
 162 struct hwif_s;
 163 typedef int (ide_ack_intr_t)(struct hwif_s *);
 164
 165 /*
 166  * hwif_chipset_t is used to keep track of the specific hardware
 167  * chipset used by each IDE interface, if known.
 168  */
 169 enum {          ide_unknown,    ide_generic,    ide_pci,
 170                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 171                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 172                 ide_4drives,    ide_pmac,       ide_acorn,
 173                 ide_au1xxx,     ide_palm3710
 174 };
 175
 176 typedef u8 hwif_chipset_t;
 177
 178 /*
 179  * Structure to hold all information about the location of this port
 180  */
 181 typedef struct hw_regs_s {
 182         union {
 183                 struct ide_io_ports     io_ports;
 184                 unsigned long           io_ports_array[IDE_NR_PORTS];
 185         };
 186
 187         int             irq;                    /* our irq number */
 188         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 189         struct device   *dev, *parent;
 190         unsigned long   config;
 191 } hw_regs_t;
 192
 193 static inline void ide_std_init_ports(hw_regs_t *hw,
 194                                       unsigned long io_addr,
 195                                       unsigned long ctl_addr)
 196 {
 197         unsigned int i;
 198
 199         for (i = 0; i <= 7; i++)
 200                 hw->io_ports_array[i] = io_addr++;
 201
 202         hw->io_ports.ctl_addr = ctl_addr;
 203 }
 204
 205 #define MAX_HWIFS       10
 206
 207 /*
 208  * Now for the data we need to maintain per-drive:  ide_drive_t
 209  */
 210
 211 #define ide_scsi        0x21
 212 #define ide_disk        0x20
 213 #define ide_optical     0x7
 214 #define ide_cdrom       0x5
 215 #define ide_tape        0x1
 216 #define ide_floppy      0x0
 217
 218 /*
 219  * Special Driver Flags
 220  */
 221 enum {
 222         IDE_SFLAG_SET_GEOMETRY          = (1 << 0),
 223         IDE_SFLAG_RECALIBRATE           = (1 << 1),
 224         IDE_SFLAG_SET_MULTMODE          = (1 << 2),
 225 };
 226
 227 /*
 228  * Status returned from various ide_ functions
 229  */
 230 typedef enum {
 231         ide_stopped,    /* no drive operation was started */
 232         ide_started,    /* a drive operation was started, handler was set */
 233 } ide_startstop_t;
 234
 235 enum {
 236         IDE_VALID_ERROR                 = (1 << 1),
 237         IDE_VALID_FEATURE               = IDE_VALID_ERROR,
 238         IDE_VALID_NSECT                 = (1 << 2),
 239         IDE_VALID_LBAL                  = (1 << 3),
 240         IDE_VALID_LBAM                  = (1 << 4),
 241         IDE_VALID_LBAH                  = (1 << 5),
 242         IDE_VALID_DEVICE                = (1 << 6),
 243         IDE_VALID_LBA                   = IDE_VALID_LBAL |
 244                                           IDE_VALID_LBAM |
 245                                           IDE_VALID_LBAH,
 246         IDE_VALID_OUT_TF                = IDE_VALID_FEATURE |
 247                                           IDE_VALID_NSECT |
 248                                           IDE_VALID_LBA,
 249         IDE_VALID_IN_TF                 = IDE_VALID_NSECT |
 250                                           IDE_VALID_LBA,
 251         IDE_VALID_OUT_HOB               = IDE_VALID_OUT_TF,
 252         IDE_VALID_IN_HOB                = IDE_VALID_ERROR |
 253                                           IDE_VALID_NSECT |
 254                                           IDE_VALID_LBA,
 255 };
 256
 257 enum {
 258         IDE_TFLAG_LBA48                 = (1 << 0),
 259         IDE_TFLAG_WRITE                 = (1 << 1),
 260         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 2),
 261         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 3),
 262         /* force 16-bit I/O operations */
 263         IDE_TFLAG_IO_16BIT              = (1 << 4),
 264         /* struct ide_cmd was allocated using kmalloc() */
 265         IDE_TFLAG_DYN                   = (1 << 5),
 266         IDE_TFLAG_FS                    = (1 << 6),
 267         IDE_TFLAG_MULTI_PIO             = (1 << 7),
 268 };
 269
 270 enum {
 271         IDE_FTFLAG_FLAGGED              = (1 << 0),
 272         IDE_FTFLAG_SET_IN_FLAGS         = (1 << 1),
 273         IDE_FTFLAG_OUT_DATA             = (1 << 2),
 274         IDE_FTFLAG_IN_DATA              = (1 << 3),
 275 };
 276
 277 struct ide_taskfile {
 278         u8      data;           /* 0: data byte (for TASKFILE ioctl) */
 279         union {                 /* 1: */
 280                 u8 error;       /*  read: error */
 281                 u8 feature;     /* write: feature */
 282         };
 283         u8      nsect;          /* 2: number of sectors */
 284         u8      lbal;           /* 3: LBA low */
 285         u8      lbam;           /* 4: LBA mid */
 286         u8      lbah;           /* 5: LBA high */
 287         u8      device;         /* 6: device select */
 288         union {                 /* 7: */
 289                 u8 status;      /*  read: status */
 290                 u8 command;     /* write: command */
 291         };
 292 };
 293
 294 struct ide_cmd {
 295         struct ide_taskfile     tf;
 296         struct ide_taskfile     hob;
 297         struct {
 298                 struct {
 299                         u8              tf;
 300                         u8              hob;
 301                 } out, in;
 302         } valid;
 303
 304         u8                      tf_flags;
 305         u8                      ftf_flags;      /* for TASKFILE ioctl */
 306         int                     protocol;
 307
 308         int                     sg_nents;         /* number of sg entries */
 309         int                     orig_sg_nents;
 310         int                     sg_dma_direction; /* DMA transfer direction */
 311
 312         unsigned int            nbytes;
 313         unsigned int            nleft;
 314         unsigned int            last_xfer_len;
 315
 316         struct scatterlist      *cursg;
 317         unsigned int            cursg_ofs;
 318
 319         struct request          *rq;            /* copy of request */
 320 };
 321
 322 /* ATAPI packet command flags */
 323 enum {
 324         /* set when an error is considered normal - no retry (ide-tape) */
 325         PC_FLAG_ABORT                   = (1 << 0),
 326         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
 327         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
 328         PC_FLAG_DMA_OK                  = (1 << 3),
 329         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
 330         PC_FLAG_DMA_ERROR               = (1 << 5),
 331         PC_FLAG_WRITING                 = (1 << 6),
 332 };
 333
 334 /*
 335  * With each packet command, we allocate a buffer of IDE_PC_BUFFER_SIZE bytes.
 336  * This is used for several packet commands (not for READ/WRITE commands).
 337  */
 338 #define IDE_PC_BUFFER_SIZE      64
 339 #define ATAPI_WAIT_PC           (60 * HZ)
 340
 341 struct ide_atapi_pc {
 342         /* actual packet bytes */
 343         u8 c[12];
 344         /* incremented on each retry */
 345         int retries;
 346         int error;
 347
 348         /* bytes to transfer */
 349         int req_xfer;
 350         /* bytes actually transferred */
 351         int xferred;
 352
 353         /* data buffer */
 354         u8 *buf;
 355         int buf_size;
 356
 357         /* the corresponding request */
 358         struct request *rq;
 359
 360         unsigned long flags;
 361
 362         /*
 363          * those are more or less driver-specific and some of them are subject
 364          * to change/removal later.
 365          */
 366         u8 pc_buf[IDE_PC_BUFFER_SIZE];
 367
 368         unsigned long timeout;
 369 };
 370
 371 struct ide_devset;
 372 struct ide_driver;
 373
 374 #ifdef CONFIG_BLK_DEV_IDEACPI
 375 struct ide_acpi_drive_link;
 376 struct ide_acpi_hwif_link;
 377 #endif
 378
 379 struct ide_drive_s;
 380
 381 struct ide_disk_ops {
 382         int             (*check)(struct ide_drive_s *, const char *);
 383         int             (*get_capacity)(struct ide_drive_s *);
 384         void            (*setup)(struct ide_drive_s *);
 385         void            (*flush)(struct ide_drive_s *);
 386         int             (*init_media)(struct ide_drive_s *, struct gendisk *);
 387         int             (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
 388                                         int);
 389         ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
 390                                       sector_t);
 391         int             (*ioctl)(struct ide_drive_s *, struct block_device *,
 392                                  fmode_t, unsigned int, unsigned long);
 393 };
 394
 395 /* ATAPI device flags */
 396 enum {
 397         IDE_AFLAG_DRQ_INTERRUPT         = (1 << 0),
 398
 399         /* ide-cd */
 400         /* Drive cannot eject the disc. */
 401         IDE_AFLAG_NO_EJECT              = (1 << 1),
 402         /* Drive is a pre ATAPI 1.2 drive. */
 403         IDE_AFLAG_PRE_ATAPI12           = (1 << 2),
 404         /* TOC addresses are in BCD. */
 405         IDE_AFLAG_TOCADDR_AS_BCD        = (1 << 3),
 406         /* TOC track numbers are in BCD. */
 407         IDE_AFLAG_TOCTRACKS_AS_BCD      = (1 << 4),
 408         /* Saved TOC information is current. */
 409         IDE_AFLAG_TOC_VALID             = (1 << 6),
 410         /* We think that the drive door is locked. */
 411         IDE_AFLAG_DOOR_LOCKED           = (1 << 7),
 412         /* SET_CD_SPEED command is unsupported. */
 413         IDE_AFLAG_NO_SPEED_SELECT       = (1 << 8),
 414         IDE_AFLAG_VERTOS_300_SSD        = (1 << 9),
 415         IDE_AFLAG_VERTOS_600_ESD        = (1 << 10),
 416         IDE_AFLAG_SANYO_3CD             = (1 << 11),
 417         IDE_AFLAG_FULL_CAPS_PAGE        = (1 << 12),
 418         IDE_AFLAG_PLAY_AUDIO_OK         = (1 << 13),
 419         IDE_AFLAG_LE_SPEED_FIELDS       = (1 << 14),
 420
 421         /* ide-floppy */
 422         /* Avoid commands not supported in Clik drive */
 423         IDE_AFLAG_CLIK_DRIVE            = (1 << 15),
 424         /* Requires BH algorithm for packets */
 425         IDE_AFLAG_ZIP_DRIVE             = (1 << 16),
 426         /* Supports format progress report */
 427         IDE_AFLAG_SRFP                  = (1 << 17),
 428
 429         /* ide-tape */
 430         IDE_AFLAG_IGNORE_DSC            = (1 << 18),
 431         /* 0 When the tape position is unknown */
 432         IDE_AFLAG_ADDRESS_VALID         = (1 << 19),
 433         /* Device already opened */
 434         IDE_AFLAG_BUSY                  = (1 << 20),
 435         /* Attempt to auto-detect the current user block size */
 436         IDE_AFLAG_DETECT_BS             = (1 << 21),
 437         /* Currently on a filemark */
 438         IDE_AFLAG_FILEMARK              = (1 << 22),
 439         /* 0 = no tape is loaded, so we don't rewind after ejecting */
 440         IDE_AFLAG_MEDIUM_PRESENT        = (1 << 23),
 441
 442         IDE_AFLAG_NO_AUTOCLOSE          = (1 << 24),
 443 };
 444
 445 /* device flags */
 446 enum {
 447         /* restore settings after device reset */
 448         IDE_DFLAG_KEEP_SETTINGS         = (1 << 0),
 449         /* device is using DMA for read/write */
 450         IDE_DFLAG_USING_DMA             = (1 << 1),
 451         /* okay to unmask other IRQs */
 452         IDE_DFLAG_UNMASK                = (1 << 2),
 453         /* don't attempt flushes */
 454         IDE_DFLAG_NOFLUSH               = (1 << 3),
 455         /* DSC overlap */
 456         IDE_DFLAG_DSC_OVERLAP           = (1 << 4),
 457         /* give potential excess bandwidth */
 458         IDE_DFLAG_NICE1                 = (1 << 5),
 459         /* device is physically present */
 460         IDE_DFLAG_PRESENT               = (1 << 6),
 461         /* id read from device (synthetic if not set) */
 462         IDE_DFLAG_ID_READ               = (1 << 8),
 463         IDE_DFLAG_NOPROBE               = (1 << 9),
 464         /* need to do check_media_change() */
 465         IDE_DFLAG_REMOVABLE             = (1 << 10),
 466         /* needed for removable devices */
 467         IDE_DFLAG_ATTACH                = (1 << 11),
 468         IDE_DFLAG_FORCED_GEOM           = (1 << 12),
 469         /* disallow setting unmask bit */
 470         IDE_DFLAG_NO_UNMASK             = (1 << 13),
 471         /* disallow enabling 32-bit I/O */
 472         IDE_DFLAG_NO_IO_32BIT           = (1 << 14),
 473         /* for removable only: door lock/unlock works */
 474         IDE_DFLAG_DOORLOCKING           = (1 << 15),
 475         /* disallow DMA */
 476         IDE_DFLAG_NODMA                 = (1 << 16),
 477         /* powermanagment told us not to do anything, so sleep nicely */
 478         IDE_DFLAG_BLOCKED               = (1 << 17),
 479         /* sleeping & sleep field valid */
 480         IDE_DFLAG_SLEEPING              = (1 << 18),
 481         IDE_DFLAG_POST_RESET            = (1 << 19),
 482         IDE_DFLAG_UDMA33_WARNED         = (1 << 20),
 483         IDE_DFLAG_LBA48                 = (1 << 21),
 484         /* status of write cache */
 485         IDE_DFLAG_WCACHE                = (1 << 22),
 486         /* used for ignoring ATA_DF */
 487         IDE_DFLAG_NOWERR                = (1 << 23),
 488         /* retrying in PIO */
 489         IDE_DFLAG_DMA_PIO_RETRY         = (1 << 24),
 490         IDE_DFLAG_LBA                   = (1 << 25),
 491         /* don't unload heads */
 492         IDE_DFLAG_NO_UNLOAD             = (1 << 26),
 493         /* heads unloaded, please don't reset port */
 494         IDE_DFLAG_PARKED                = (1 << 27),
 495         IDE_DFLAG_MEDIA_CHANGED         = (1 << 28),
 496         /* write protect */
 497         IDE_DFLAG_WP                    = (1 << 29),
 498         IDE_DFLAG_FORMAT_IN_PROGRESS    = (1 << 30),
 499 };
 500
 501 struct ide_drive_s {
 502         char            name[4];        /* drive name, such as "hda" */
 503         char            driver_req[10]; /* requests specific driver */
 504
 505         struct request_queue    *queue; /* request queue */
 506
 507         struct request          *rq;    /* current request */
 508         void            *driver_data;   /* extra driver data */
 509         u16                     *id;    /* identification info */
 510 #ifdef CONFIG_IDE_PROC_FS
 511         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 512         const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
 513 #endif
 514         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 515
 516         const struct ide_disk_ops *disk_ops;
 517
 518         unsigned long dev_flags;
 519
 520         unsigned long sleep;            /* sleep until this time */
 521         unsigned long timeout;          /* max time to wait for irq */
 522
 523         u8      special_flags;          /* special action flags */
 524
 525         u8      select;                 /* basic drive/head select reg value */
 526         u8      retry_pio;              /* retrying dma capable host in pio */
 527         u8      waiting_for_dma;        /* dma currently in progress */
 528         u8      dma;                    /* atapi dma flag */
 529
 530         u8      quirk_list;     /* considered quirky, set for a specific host */
 531         u8      init_speed;     /* transfer rate set at boot */
 532         u8      current_speed;  /* current transfer rate set */
 533         u8      desired_speed;  /* desired transfer rate set */
 534         u8      dn;             /* now wide spread use */
 535         u8      acoustic;       /* acoustic management */
 536         u8      media;          /* disk, cdrom, tape, floppy, ... */
 537         u8      ready_stat;     /* min status value for drive ready */
 538         u8      mult_count;     /* current multiple sector setting */
 539         u8      mult_req;       /* requested multiple sector setting */
 540         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 541         u8      bad_wstat;      /* used for ignoring ATA_DF */
 542         u8      head;           /* "real" number of heads */
 543         u8      sect;           /* "real" sectors per track */
 544         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 545         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 546
 547         /* delay this long before sending packet command */
 548         u8 pc_delay;
 549
 550         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 551         unsigned int    cyl;            /* "real" number of cyls */
 552         unsigned int    drive_data;     /* used by set_pio_mode/dev_select() */
 553         unsigned int    failures;       /* current failure count */
 554         unsigned int    max_failures;   /* maximum allowed failure count */
 555         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
 556
 557         u64             capacity64;     /* total number of sectors */
 558
 559         int             lun;            /* logical unit */
 560         int             crc_count;      /* crc counter to reduce drive speed */
 561
 562         unsigned long   debug_mask;     /* debugging levels switch */
 563
 564 #ifdef CONFIG_BLK_DEV_IDEACPI
 565         struct ide_acpi_drive_link *acpidata;
 566 #endif
 567         struct list_head list;
 568         struct device   gendev;
 569         struct completion gendev_rel_comp;      /* to deal with device release() */
 570
 571         /* current packet command */
 572         struct ide_atapi_pc *pc;
 573
 574         /* last failed packet command */
 575         struct ide_atapi_pc *failed_pc;
 576
 577         /* callback for packet commands */
 578         int  (*pc_callback)(struct ide_drive_s *, int);
 579
 580         ide_startstop_t (*irq_handler)(struct ide_drive_s *);
 581
 582         unsigned long atapi_flags;
 583
 584         struct ide_atapi_pc request_sense_pc;
 585
 586         /* current sense rq and buffer */
 587         bool sense_rq_armed;
 588         struct request sense_rq;
 589         struct request_sense sense_data;
 590 };
 591
 592 typedef struct ide_drive_s ide_drive_t;
 593
 594 #define to_ide_device(dev)              container_of(dev, ide_drive_t, gendev)
 595
 596 #define to_ide_drv(obj, cont_type)      \
 597         container_of(obj, struct cont_type, dev)
 598
 599 #define ide_drv_g(disk, cont_type)      \
 600         container_of((disk)->private_data, struct cont_type, driver)
 601
 602 struct ide_port_info;
 603
 604 struct ide_tp_ops {
 605         void    (*exec_command)(struct hwif_s *, u8);
 606         u8      (*read_status)(struct hwif_s *);
 607         u8      (*read_altstatus)(struct hwif_s *);
 608         void    (*write_devctl)(struct hwif_s *, u8);
 609
 610         void    (*dev_select)(ide_drive_t *);
 611         void    (*tf_load)(ide_drive_t *, struct ide_taskfile *, u8);
 612         void    (*tf_read)(ide_drive_t *, struct ide_taskfile *, u8);
 613
 614         void    (*input_data)(ide_drive_t *, struct ide_cmd *,
 615                               void *, unsigned int);
 616         void    (*output_data)(ide_drive_t *, struct ide_cmd *,
 617                                void *, unsigned int);
 618 };
 619
 620 extern const struct ide_tp_ops default_tp_ops;
 621
 622 /**
 623  * struct ide_port_ops - IDE port operations
 624  *
 625  * @init_dev:           host specific initialization of a device
 626  * @set_pio_mode:       routine to program host for PIO mode
 627  * @set_dma_mode:       routine to program host for DMA mode
 628  * @reset_poll:         chipset polling based on hba specifics
 629  * @pre_reset:          chipset specific changes to default for device-hba resets
 630  * @resetproc:          routine to reset controller after a disk reset
 631  * @maskproc:           special host masking for drive selection
 632  * @quirkproc:          check host's drive quirk list
 633  * @clear_irq:          clear IRQ
 634  *
 635  * @mdma_filter:        filter MDMA modes
 636  * @udma_filter:        filter UDMA modes
 637  *
 638  * @cable_detect:       detect cable type
 639  */
 640 struct ide_port_ops {
 641         void    (*init_dev)(ide_drive_t *);
 642         void    (*set_pio_mode)(ide_drive_t *, const u8);
 643         void    (*set_dma_mode)(ide_drive_t *, const u8);
 644         int     (*reset_poll)(ide_drive_t *);
 645         void    (*pre_reset)(ide_drive_t *);
 646         void    (*resetproc)(ide_drive_t *);
 647         void    (*maskproc)(ide_drive_t *, int);
 648         void    (*quirkproc)(ide_drive_t *);
 649         void    (*clear_irq)(ide_drive_t *);
 650
 651         u8      (*mdma_filter)(ide_drive_t *);
 652         u8      (*udma_filter)(ide_drive_t *);
 653
 654         u8      (*cable_detect)(struct hwif_s *);
 655 };
 656
 657 struct ide_dma_ops {
 658         void    (*dma_host_set)(struct ide_drive_s *, int);
 659         int     (*dma_setup)(struct ide_drive_s *, struct ide_cmd *);
 660         void    (*dma_start)(struct ide_drive_s *);
 661         int     (*dma_end)(struct ide_drive_s *);
 662         int     (*dma_test_irq)(struct ide_drive_s *);
 663         void    (*dma_lost_irq)(struct ide_drive_s *);
 664         /* below ones are optional */
 665         int     (*dma_check)(struct ide_drive_s *, struct ide_cmd *);
 666         int     (*dma_timer_expiry)(struct ide_drive_s *);
 667         void    (*dma_clear)(struct ide_drive_s *);
 668         /*
 669          * The following method is optional and only required to be
 670          * implemented for the SFF-8038i compatible controllers.
 671          */
 672         u8      (*dma_sff_read_status)(struct hwif_s *);
 673 };
 674
 675 struct ide_host;
 676
 677 typedef struct hwif_s {
 678         struct hwif_s *mate;            /* other hwif from same PCI chip */
 679         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 680
 681         struct ide_host *host;
 682
 683         char name[6];                   /* name of interface, eg. "ide0" */
 684
 685         struct ide_io_ports     io_ports;
 686
 687         unsigned long   sata_scr[SATA_NR_PORTS];
 688
 689         ide_drive_t     *devices[MAX_DRIVES + 1];
 690
 691         u8 major;       /* our major number */
 692         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 693         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 694
 695         u32 host_flags;
 696
 697         u8 pio_mask;
 698
 699         u8 ultra_mask;
 700         u8 mwdma_mask;
 701         u8 swdma_mask;
 702
 703         u8 cbl;         /* cable type */
 704
 705         hwif_chipset_t chipset; /* sub-module for tuning.. */
 706
 707         struct device *dev;
 708
 709         ide_ack_intr_t *ack_intr;
 710
 711         void (*rw_disk)(ide_drive_t *, struct request *);
 712
 713         const struct ide_tp_ops         *tp_ops;
 714         const struct ide_port_ops       *port_ops;
 715         const struct ide_dma_ops        *dma_ops;
 716
 717         /* dma physical region descriptor table (cpu view) */
 718         unsigned int    *dmatable_cpu;
 719         /* dma physical region descriptor table (dma view) */
 720         dma_addr_t      dmatable_dma;
 721
 722         /* maximum number of PRD table entries */
 723         int prd_max_nents;
 724         /* PRD entry size in bytes */
 725         int prd_ent_size;
 726
 727         /* Scatter-gather list used to build the above */
 728         struct scatterlist *sg_table;
 729         int sg_max_nents;               /* Maximum number of entries in it */
 730
 731         struct ide_cmd cmd;             /* current command */
 732
 733         int             rqsize;         /* max sectors per request */
 734         int             irq;            /* our irq number */
 735
 736         unsigned long   dma_base;       /* base addr for dma ports */
 737
 738         unsigned long   config_data;    /* for use by chipset-specific code */
 739         unsigned long   select_data;    /* for use by chipset-specific code */
 740
 741         unsigned long   extra_base;     /* extra addr for dma ports */
 742         unsigned        extra_ports;    /* number of extra dma ports */
 743
 744         unsigned        present    : 1; /* this interface exists */
 745         unsigned        busy       : 1; /* serializes devices on a port */
 746
 747         struct device           gendev;
 748         struct device           *portdev;
 749
 750         struct completion gendev_rel_comp; /* To deal with device release() */
 751
 752         void            *hwif_data;     /* extra hwif data */
 753
 754 #ifdef CONFIG_BLK_DEV_IDEACPI
 755         struct ide_acpi_hwif_link *acpidata;
 756 #endif
 757
 758         /* IRQ handler, if active */
 759         ide_startstop_t (*handler)(ide_drive_t *);
 760
 761         /* BOOL: polling active & poll_timeout field valid */
 762         unsigned int polling : 1;
 763
 764         /* current drive */
 765         ide_drive_t *cur_dev;
 766
 767         /* current request */
 768         struct request *rq;
 769
 770         /* failsafe timer */
 771         struct timer_list timer;
 772         /* timeout value during long polls */
 773         unsigned long poll_timeout;
 774         /* queried upon timeouts */
 775         int (*expiry)(ide_drive_t *);
 776
 777         int req_gen;
 778         int req_gen_timer;
 779
 780         spinlock_t lock;
 781 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 782
 783 #define MAX_HOST_PORTS 4
 784
 785 struct ide_host {
 786         ide_hwif_t      *ports[MAX_HOST_PORTS + 1];
 787         unsigned int    n_ports;
 788         struct device   *dev[2];
 789
 790         int             (*init_chipset)(struct pci_dev *);
 791
 792         void            (*get_lock)(irq_handler_t, void *);
 793         void            (*release_lock)(void);
 794
 795         irq_handler_t   irq_handler;
 796
 797         unsigned long   host_flags;
 798
 799         int             irq_flags;
 800
 801         void            *host_priv;
 802         ide_hwif_t      *cur_port;      /* for hosts requiring serialization */
 803
 804         /* used for hosts requiring serialization */
 805         volatile unsigned long  host_busy;
 806 };
 807
 808 #define IDE_HOST_BUSY 0
 809
 810 /*
 811  *  internal ide interrupt handler type
 812  */
 813 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 814 typedef int (ide_expiry_t)(ide_drive_t *);
 815
 816 /* used by ide-cd, ide-floppy, etc. */
 817 typedef void (xfer_func_t)(ide_drive_t *, struct ide_cmd *, void *, unsigned);
 818
 819 extern struct mutex ide_setting_mtx;
 820
 821 /*
 822  * configurable drive settings
 823  */
 824
 825 #define DS_SYNC (1 << 0)
 826
 827 struct ide_devset {
 828         int             (*get)(ide_drive_t *);
 829         int             (*set)(ide_drive_t *, int);
 830         unsigned int    flags;
 831 };
 832
 833 #define __DEVSET(_flags, _get, _set) { \
 834         .flags  = _flags, \
 835         .get    = _get, \
 836         .set    = _set, \
 837 }
 838
 839 #define ide_devset_get(name, field) \
 840 static int get_##name(ide_drive_t *drive) \
 841 { \
 842         return drive->field; \
 843 }
 844
 845 #define ide_devset_set(name, field) \
 846 static int set_##name(ide_drive_t *drive, int arg) \
 847 { \
 848         drive->field = arg; \
 849         return 0; \
 850 }
 851
 852 #define ide_devset_get_flag(name, flag) \
 853 static int get_##name(ide_drive_t *drive) \
 854 { \
 855         return !!(drive->dev_flags & flag); \
 856 }
 857
 858 #define ide_devset_set_flag(name, flag) \
 859 static int set_##name(ide_drive_t *drive, int arg) \
 860 { \
 861         if (arg) \
 862                 drive->dev_flags |= flag; \
 863         else \
 864                 drive->dev_flags &= ~flag; \
 865         return 0; \
 866 }
 867
 868 #define __IDE_DEVSET(_name, _flags, _get, _set) \
 869 const struct ide_devset ide_devset_##_name = \
 870         __DEVSET(_flags, _get, _set)
 871
 872 #define IDE_DEVSET(_name, _flags, _get, _set) \
 873 static __IDE_DEVSET(_name, _flags, _get, _set)
 874
 875 #define ide_devset_rw(_name, _func) \
 876 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 877
 878 #define ide_devset_w(_name, _func) \
 879 IDE_DEVSET(_name, 0, NULL, set_##_func)
 880
 881 #define ide_ext_devset_rw(_name, _func) \
 882 __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 883
 884 #define ide_ext_devset_rw_sync(_name, _func) \
 885 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
 886
 887 #define ide_decl_devset(_name) \
 888 extern const struct ide_devset ide_devset_##_name
 889
 890 ide_decl_devset(io_32bit);
 891 ide_decl_devset(keepsettings);
 892 ide_decl_devset(pio_mode);
 893 ide_decl_devset(unmaskirq);
 894 ide_decl_devset(using_dma);
 895
 896 #ifdef CONFIG_IDE_PROC_FS
 897 /*
 898  * /proc/ide interface
 899  */
 900
 901 #define ide_devset_rw_field(_name, _field) \
 902 ide_devset_get(_name, _field); \
 903 ide_devset_set(_name, _field); \
 904 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 905
 906 #define ide_devset_rw_flag(_name, _field) \
 907 ide_devset_get_flag(_name, _field); \
 908 ide_devset_set_flag(_name, _field); \
 909 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 910
 911 struct ide_proc_devset {
 912         const char              *name;
 913         const struct ide_devset *setting;
 914         int                     min, max;
 915         int                     (*mulf)(ide_drive_t *);
 916         int                     (*divf)(ide_drive_t *);
 917 };
 918
 919 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
 920         .name = __stringify(_name), \
 921         .setting = &ide_devset_##_name, \
 922         .min = _min, \
 923         .max = _max, \
 924         .mulf = _mulf, \
 925         .divf = _divf, \
 926 }
 927
 928 #define IDE_PROC_DEVSET(_name, _min, _max) \
 929 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
 930
 931 typedef struct {
 932         const char      *name;
 933         mode_t          mode;
 934         read_proc_t     *read_proc;
 935         write_proc_t    *write_proc;
 936 } ide_proc_entry_t;
 937
 938 void proc_ide_create(void);
 939 void proc_ide_destroy(void);
 940 void ide_proc_register_port(ide_hwif_t *);
 941 void ide_proc_port_register_devices(ide_hwif_t *);
 942 void ide_proc_unregister_device(ide_drive_t *);
 943 void ide_proc_unregister_port(ide_hwif_t *);
 944 void ide_proc_register_driver(ide_drive_t *, struct ide_driver *);
 945 void ide_proc_unregister_driver(ide_drive_t *, struct ide_driver *);
 946
 947 read_proc_t proc_ide_read_capacity;
 948 read_proc_t proc_ide_read_geometry;
 949
 950 /*
 951  * Standard exit stuff:
 952  */
 953 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 954 {                                       \
 955         len -= off;                     \
 956         if (len < count) {              \
 957                 *eof = 1;               \
 958                 if (len <= 0)           \
 959                         return 0;       \
 960         } else                          \
 961                 len = count;            \
 962         *start = page + off;            \
 963         return len;                     \
 964 }
 965 #else
 966 static inline void proc_ide_create(void) { ; }
 967 static inline void proc_ide_destroy(void) { ; }
 968 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 969 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
 970 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
 971 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 972 static inline void ide_proc_register_driver(ide_drive_t *drive,
 973                                             struct ide_driver *driver) { ; }
 974 static inline void ide_proc_unregister_driver(ide_drive_t *drive,
 975                                               struct ide_driver *driver) { ; }
 976 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 977 #endif
 978
 979 enum {
 980         /* enter/exit functions */
 981         IDE_DBG_FUNC =                  (1 << 0),
 982         /* sense key/asc handling */
 983         IDE_DBG_SENSE =                 (1 << 1),
 984         /* packet commands handling */
 985         IDE_DBG_PC =                    (1 << 2),
 986         /* request handling */
 987         IDE_DBG_RQ =                    (1 << 3),
 988         /* driver probing/setup */
 989         IDE_DBG_PROBE =                 (1 << 4),
 990 };
 991
 992 /* DRV_NAME has to be defined in the driver before using the macro below */
 993 #define __ide_debug_log(lvl, fmt, args...)                              \
 994 {                                                                       \
 995         if (unlikely(drive->debug_mask & lvl))                          \
 996                 printk(KERN_INFO DRV_NAME ": %s: " fmt "\n",            \
 997                                           __func__, ## args);           \
 998 }
 999
1000 /*
1001  * Power Management state machine (rq->pm->pm_step).
1002  *
1003  * For each step, the core calls ide_start_power_step() first.
1004  * This can return:
1005  *      - ide_stopped : In this case, the core calls us back again unless
1006  *                      step have been set to ide_power_state_completed.
1007  *      - ide_started : In this case, the channel is left busy until an
1008  *                      async event (interrupt) occurs.
1009  * Typically, ide_start_power_step() will issue a taskfile request with
1010  * do_rw_taskfile().
1011  *
1012  * Upon reception of the interrupt, the core will call ide_complete_power_step()
1013  * with the error code if any. This routine should update the step value
1014  * and return. It should not start a new request. The core will call
1015  * ide_start_power_step() for the new step value, unless step have been
1016  * set to IDE_PM_COMPLETED.
1017  */
1018 enum {
1019         IDE_PM_START_SUSPEND,
1020         IDE_PM_FLUSH_CACHE      = IDE_PM_START_SUSPEND,
1021         IDE_PM_STANDBY,
1022
1023         IDE_PM_START_RESUME,
1024         IDE_PM_RESTORE_PIO      = IDE_PM_START_RESUME,
1025         IDE_PM_IDLE,
1026         IDE_PM_RESTORE_DMA,
1027
1028         IDE_PM_COMPLETED,
1029 };
1030
1031 int generic_ide_suspend(struct device *, pm_message_t);
1032 int generic_ide_resume(struct device *);
1033
1034 void ide_complete_power_step(ide_drive_t *, struct request *);
1035 ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1036 void ide_complete_pm_rq(ide_drive_t *, struct request *);
1037 void ide_check_pm_state(ide_drive_t *, struct request *);
1038
1039 /*
1040  * Subdrivers support.
1041  *
1042  * The gendriver.owner field should be set to the module owner of this driver.
1043  * The gendriver.name field should be set to the name of this driver
1044  */
1045 struct ide_driver {
1046         const char                      *version;
1047         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1048         struct device_driver    gen_driver;
1049         int             (*probe)(ide_drive_t *);
1050         void            (*remove)(ide_drive_t *);
1051         void            (*resume)(ide_drive_t *);
1052         void            (*shutdown)(ide_drive_t *);
1053 #ifdef CONFIG_IDE_PROC_FS
1054         ide_proc_entry_t *              (*proc_entries)(ide_drive_t *);
1055         const struct ide_proc_devset *  (*proc_devsets)(ide_drive_t *);
1056 #endif
1057 };
1058
1059 #define to_ide_driver(drv) container_of(drv, struct ide_driver, gen_driver)
1060
1061 int ide_device_get(ide_drive_t *);
1062 void ide_device_put(ide_drive_t *);
1063
1064 struct ide_ioctl_devset {
1065         unsigned int    get_ioctl;
1066         unsigned int    set_ioctl;
1067         const struct ide_devset *setting;
1068 };
1069
1070 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1071                       unsigned long, const struct ide_ioctl_devset *);
1072
1073 int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1074
1075 extern int ide_vlb_clk;
1076 extern int ide_pci_clk;
1077
1078 unsigned int ide_rq_bytes(struct request *);
1079 int ide_end_rq(ide_drive_t *, struct request *, int, unsigned int);
1080 void ide_kill_rq(ide_drive_t *, struct request *);
1081
1082 void __ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1083 void ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1084
1085 void ide_execute_command(ide_drive_t *, struct ide_cmd *, ide_handler_t *,
1086                          unsigned int);
1087
1088 void ide_pad_transfer(ide_drive_t *, int, int);
1089
1090 ide_startstop_t ide_error(ide_drive_t *, const char *, u8);
1091
1092 void ide_fix_driveid(u16 *);
1093
1094 extern void ide_fixstring(u8 *, const int, const int);
1095
1096 int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
1097
1098 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1099
1100 ide_startstop_t ide_do_park_unpark(ide_drive_t *, struct request *);
1101 ide_startstop_t ide_do_devset(ide_drive_t *, struct request *);
1102
1103 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1104
1105 extern int ide_devset_execute(ide_drive_t *drive,
1106                               const struct ide_devset *setting, int arg);
1107
1108 void ide_complete_cmd(ide_drive_t *, struct ide_cmd *, u8, u8);
1109 int ide_complete_rq(ide_drive_t *, int, unsigned int);
1110
1111 void ide_tf_readback(ide_drive_t *drive, struct ide_cmd *cmd);
1112 void ide_tf_dump(const char *, struct ide_cmd *);
1113
1114 void ide_exec_command(ide_hwif_t *, u8);
1115 u8 ide_read_status(ide_hwif_t *);
1116 u8 ide_read_altstatus(ide_hwif_t *);
1117 void ide_write_devctl(ide_hwif_t *, u8);
1118
1119 void ide_dev_select(ide_drive_t *);
1120 void ide_tf_load(ide_drive_t *, struct ide_taskfile *, u8);
1121 void ide_tf_read(ide_drive_t *, struct ide_taskfile *, u8);
1122
1123 void ide_input_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1124 void ide_output_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1125
1126 void SELECT_MASK(ide_drive_t *, int);
1127
1128 u8 ide_read_error(ide_drive_t *);
1129 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1130
1131 int ide_check_atapi_device(ide_drive_t *, const char *);
1132
1133 void ide_init_pc(struct ide_atapi_pc *);
1134
1135 /* Disk head parking */
1136 extern wait_queue_head_t ide_park_wq;
1137 ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1138                       char *buf);
1139 ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1140                        const char *buf, size_t len);
1141
1142 /*
1143  * Special requests for ide-tape block device strategy routine.
1144  *
1145  * In order to service a character device command, we add special requests to
1146  * the tail of our block device request queue and wait for their completion.
1147  */
1148 enum {
1149         REQ_IDETAPE_PC1         = (1 << 0), /* packet command (first stage) */
1150         REQ_IDETAPE_PC2         = (1 << 1), /* packet command (second stage) */
1151         REQ_IDETAPE_READ        = (1 << 2),
1152         REQ_IDETAPE_WRITE       = (1 << 3),
1153 };
1154
1155 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *);
1156
1157 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1158 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1159 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1160 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1161 void ide_retry_pc(ide_drive_t *drive);
1162
1163 void ide_prep_sense(ide_drive_t *drive, struct request *rq);
1164 int ide_queue_sense_rq(ide_drive_t *drive, void *special);
1165
1166 int ide_cd_expiry(ide_drive_t *);
1167
1168 int ide_cd_get_xferlen(struct request *);
1169
1170 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_cmd *);
1171
1172 ide_startstop_t do_rw_taskfile(ide_drive_t *, struct ide_cmd *);
1173
1174 void ide_pio_bytes(ide_drive_t *, struct ide_cmd *, unsigned int, unsigned int);
1175
1176 void ide_finish_cmd(ide_drive_t *, struct ide_cmd *, u8);
1177
1178 int ide_raw_taskfile(ide_drive_t *, struct ide_cmd *, u8 *, u16);
1179 int ide_no_data_taskfile(ide_drive_t *, struct ide_cmd *);
1180
1181 int ide_taskfile_ioctl(ide_drive_t *, unsigned long);
1182
1183 int ide_dev_read_id(ide_drive_t *, u8, u16 *);
1184
1185 extern int ide_driveid_update(ide_drive_t *);
1186 extern int ide_config_drive_speed(ide_drive_t *, u8);
1187 extern u8 eighty_ninty_three (ide_drive_t *);
1188 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1189
1190 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1191
1192 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1193
1194 extern void ide_timer_expiry(unsigned long);
1195 extern irqreturn_t ide_intr(int irq, void *dev_id);
1196 extern void do_ide_request(struct request_queue *);
1197
1198 void ide_init_disk(struct gendisk *, ide_drive_t *);
1199
1200 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1201 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1202 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1203 #else
1204 #define ide_pci_register_driver(d) pci_register_driver(d)
1205 #endif
1206
1207 static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1208 {
1209         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1210                 return 1;
1211         return 0;
1212 }
1213
1214 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *,
1215                          hw_regs_t *, hw_regs_t **);
1216 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1217
1218 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1219 int ide_pci_set_master(struct pci_dev *, const char *);
1220 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1221 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1222 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1223 #else
1224 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1225                                      const struct ide_port_info *d)
1226 {
1227         return -EINVAL;
1228 }
1229 #endif
1230
1231 struct ide_pci_enablebit {
1232         u8      reg;    /* byte pci reg holding the enable-bit */
1233         u8      mask;   /* mask to isolate the enable-bit */
1234         u8      val;    /* value of masked reg when "enabled" */
1235 };
1236
1237 enum {
1238         /* Uses ISA control ports not PCI ones. */
1239         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1240         /* single port device */
1241         IDE_HFLAG_SINGLE                = (1 << 1),
1242         /* don't use legacy PIO blacklist */
1243         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1244         /* set for the second port of QD65xx */
1245         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1246         /* use PIO8/9 for prefetch off/on */
1247         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1248         /* use PIO6/7 for fast-devsel off/on */
1249         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1250         /* use 100-102 and 200-202 PIO values to set DMA modes */
1251         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1252         /*
1253          * keep DMA setting when programming PIO mode, may be used only
1254          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1255          */
1256         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1257         /* program host for the transfer mode after programming device */
1258         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1259         /* don't program host/device for the transfer mode ("smart" hosts) */
1260         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1261         /* trust BIOS for programming chipset/device for DMA */
1262         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1263         /* host is CS5510/CS5520 */
1264         IDE_HFLAG_CS5520                = (1 << 11),
1265         /* ATAPI DMA is unsupported */
1266         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1267         /* set if host is a "non-bootable" controller */
1268         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1269         /* host doesn't support DMA */
1270         IDE_HFLAG_NO_DMA                = (1 << 14),
1271         /* check if host is PCI IDE device before allowing DMA */
1272         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1273         /* host uses MMIO */
1274         IDE_HFLAG_MMIO                  = (1 << 16),
1275         /* no LBA48 */
1276         IDE_HFLAG_NO_LBA48              = (1 << 17),
1277         /* no LBA48 DMA */
1278         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1279         /* data FIFO is cleared by an error */
1280         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1281         /* serialize ports */
1282         IDE_HFLAG_SERIALIZE             = (1 << 20),
1283         /* host is DTC2278 */
1284         IDE_HFLAG_DTC2278               = (1 << 21),
1285         /* 4 devices on a single set of I/O ports */
1286         IDE_HFLAG_4DRIVES               = (1 << 22),
1287         /* host is TRM290 */
1288         IDE_HFLAG_TRM290                = (1 << 23),
1289         /* use 32-bit I/O ops */
1290         IDE_HFLAG_IO_32BIT              = (1 << 24),
1291         /* unmask IRQs */
1292         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1293         IDE_HFLAG_BROKEN_ALTSTATUS      = (1 << 26),
1294         /* serialize ports if DMA is possible (for sl82c105) */
1295         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1296         /* force host out of "simplex" mode */
1297         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1298         /* DSC overlap is unsupported */
1299         IDE_HFLAG_NO_DSC                = (1 << 29),
1300         /* never use 32-bit I/O ops */
1301         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1302         /* never unmask IRQs */
1303         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1304 };
1305
1306 #ifdef CONFIG_BLK_DEV_OFFBOARD
1307 # define IDE_HFLAG_OFF_BOARD    0
1308 #else
1309 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1310 #endif
1311
1312 struct ide_port_info {
1313         char                    *name;
1314
1315         int                     (*init_chipset)(struct pci_dev *);
1316
1317         void                    (*get_lock)(irq_handler_t, void *);
1318         void                    (*release_lock)(void);
1319
1320         void                    (*init_iops)(ide_hwif_t *);
1321         void                    (*init_hwif)(ide_hwif_t *);
1322         int                     (*init_dma)(ide_hwif_t *,
1323                                             const struct ide_port_info *);
1324
1325         const struct ide_tp_ops         *tp_ops;
1326         const struct ide_port_ops       *port_ops;
1327         const struct ide_dma_ops        *dma_ops;
1328
1329         struct ide_pci_enablebit        enablebits[2];
1330
1331         hwif_chipset_t          chipset;
1332
1333         u16                     max_sectors;    /* if < than the default one */
1334
1335         u32                     host_flags;
1336
1337         int                     irq_flags;
1338
1339         u8                      pio_mask;
1340         u8                      swdma_mask;
1341         u8                      mwdma_mask;
1342         u8                      udma_mask;
1343 };
1344
1345 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1346 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1347                      const struct ide_port_info *, void *);
1348 void ide_pci_remove(struct pci_dev *);
1349
1350 #ifdef CONFIG_PM
1351 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1352 int ide_pci_resume(struct pci_dev *);
1353 #else
1354 #define ide_pci_suspend NULL
1355 #define ide_pci_resume NULL
1356 #endif
1357
1358 void ide_map_sg(ide_drive_t *, struct ide_cmd *);
1359 void ide_init_sg_cmd(struct ide_cmd *, unsigned int);
1360
1361 #define BAD_DMA_DRIVE           0
1362 #define GOOD_DMA_DRIVE          1
1363
1364 struct drive_list_entry {
1365         const char *id_model;
1366         const char *id_firmware;
1367 };
1368
1369 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1370
1371 #ifdef CONFIG_BLK_DEV_IDEDMA
1372 int ide_dma_good_drive(ide_drive_t *);
1373 int __ide_dma_bad_drive(ide_drive_t *);
1374 int ide_id_dma_bug(ide_drive_t *);
1375
1376 u8 ide_find_dma_mode(ide_drive_t *, u8);
1377
1378 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1379 {
1380         return ide_find_dma_mode(drive, XFER_UDMA_6);
1381 }
1382
1383 void ide_dma_off_quietly(ide_drive_t *);
1384 void ide_dma_off(ide_drive_t *);
1385 void ide_dma_on(ide_drive_t *);
1386 int ide_set_dma(ide_drive_t *);
1387 void ide_check_dma_crc(ide_drive_t *);
1388 ide_startstop_t ide_dma_intr(ide_drive_t *);
1389
1390 int ide_allocate_dma_engine(ide_hwif_t *);
1391 void ide_release_dma_engine(ide_hwif_t *);
1392
1393 int ide_dma_prepare(ide_drive_t *, struct ide_cmd *);
1394 void ide_dma_unmap_sg(ide_drive_t *, struct ide_cmd *);
1395
1396 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1397 int config_drive_for_dma(ide_drive_t *);
1398 int ide_build_dmatable(ide_drive_t *, struct ide_cmd *);
1399 void ide_dma_host_set(ide_drive_t *, int);
1400 int ide_dma_setup(ide_drive_t *, struct ide_cmd *);
1401 extern void ide_dma_start(ide_drive_t *);
1402 int ide_dma_end(ide_drive_t *);
1403 int ide_dma_test_irq(ide_drive_t *);
1404 int ide_dma_sff_timer_expiry(ide_drive_t *);
1405 u8 ide_dma_sff_read_status(ide_hwif_t *);
1406 extern const struct ide_dma_ops sff_dma_ops;
1407 #else
1408 static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1409 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1410
1411 void ide_dma_lost_irq(ide_drive_t *);
1412 ide_startstop_t ide_dma_timeout_retry(ide_drive_t *, int);
1413
1414 #else
1415 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1416 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1417 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1418 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1419 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1420 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1421 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1422 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1423 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1424 static inline ide_startstop_t ide_dma_intr(ide_drive_t *drive) { return ide_stopped; }
1425 static inline ide_startstop_t ide_dma_timeout_retry(ide_drive_t *drive, int error) { return ide_stopped; }
1426 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1427 static inline int ide_dma_prepare(ide_drive_t *drive,
1428                                   struct ide_cmd *cmd) { return 1; }
1429 static inline void ide_dma_unmap_sg(ide_drive_t *drive,
1430                                     struct ide_cmd *cmd) { ; }
1431 #endif /* CONFIG_BLK_DEV_IDEDMA */
1432
1433 #ifdef CONFIG_BLK_DEV_IDEACPI
1434 int ide_acpi_init(void);
1435 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1436 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1437 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1438 void ide_acpi_init_port(ide_hwif_t *);
1439 void ide_acpi_port_init_devices(ide_hwif_t *);
1440 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1441 #else
1442 static inline int ide_acpi_init(void) { return 0; }
1443 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1444 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1445 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1446 static inline void ide_acpi_init_port(ide_hwif_t *hwif) { ; }
1447 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1448 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1449 #endif
1450
1451 void ide_register_region(struct gendisk *);
1452 void ide_unregister_region(struct gendisk *);
1453
1454 void ide_undecoded_slave(ide_drive_t *);
1455
1456 void ide_port_apply_params(ide_hwif_t *);
1457 int ide_sysfs_register_port(ide_hwif_t *);
1458
1459 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **,
1460                                 unsigned int);
1461 void ide_host_free(struct ide_host *);
1462 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1463                       hw_regs_t **);
1464 int ide_host_add(const struct ide_port_info *, hw_regs_t **, unsigned int,
1465                  struct ide_host **);
1466 void ide_host_remove(struct ide_host *);
1467 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1468 void ide_port_unregister_devices(ide_hwif_t *);
1469 void ide_port_scan(ide_hwif_t *);
1470
1471 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1472 {
1473         return hwif->hwif_data;
1474 }
1475
1476 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1477 {
1478         hwif->hwif_data = data;
1479 }
1480
1481 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1482
1483 u64 ide_get_lba_addr(struct ide_cmd *, int);
1484 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1485
1486 struct ide_timing {
1487         u8  mode;
1488         u8  setup;      /* t1 */
1489         u16 act8b;      /* t2 for 8-bit io */
1490         u16 rec8b;      /* t2i for 8-bit io */
1491         u16 cyc8b;      /* t0 for 8-bit io */
1492         u16 active;     /* t2 or tD */
1493         u16 recover;    /* t2i or tK */
1494         u16 cycle;      /* t0 */
1495         u16 udma;       /* t2CYCTYP/2 */
1496 };
1497
1498 enum {
1499         IDE_TIMING_SETUP        = (1 << 0),
1500         IDE_TIMING_ACT8B        = (1 << 1),
1501         IDE_TIMING_REC8B        = (1 << 2),
1502         IDE_TIMING_CYC8B        = (1 << 3),
1503         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1504                                   IDE_TIMING_CYC8B,
1505         IDE_TIMING_ACTIVE       = (1 << 4),
1506         IDE_TIMING_RECOVER      = (1 << 5),
1507         IDE_TIMING_CYCLE        = (1 << 6),
1508         IDE_TIMING_UDMA         = (1 << 7),
1509         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1510                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1511                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1512 };
1513
1514 struct ide_timing *ide_timing_find_mode(u8);
1515 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1516 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1517                       struct ide_timing *, unsigned int);
1518 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1519
1520 #ifdef CONFIG_IDE_XFER_MODE
1521 int ide_scan_pio_blacklist(char *);
1522 const char *ide_xfer_verbose(u8);
1523 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1524 int ide_set_pio_mode(ide_drive_t *, u8);
1525 int ide_set_dma_mode(ide_drive_t *, u8);
1526 void ide_set_pio(ide_drive_t *, u8);
1527 int ide_set_xfer_rate(ide_drive_t *, u8);
1528 #else
1529 static inline void ide_set_pio(ide_drive_t *drive, u8 pio) { ; }
1530 static inline int ide_set_xfer_rate(ide_drive_t *drive, u8 rate) { return -1; }
1531 #endif
1532
1533 static inline void ide_set_max_pio(ide_drive_t *drive)
1534 {
1535         ide_set_pio(drive, 255);
1536 }
1537
1538 char *ide_media_string(ide_drive_t *);
1539
1540 extern struct device_attribute ide_dev_attrs[];
1541 extern struct bus_type ide_bus_type;
1542 extern struct class *ide_port_class;
1543
1544 static inline void ide_dump_identify(u8 *id)
1545 {
1546         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1547 }
1548
1549 static inline int hwif_to_node(ide_hwif_t *hwif)
1550 {
1551         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1552 }
1553
1554 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1555 {
1556         ide_drive_t *peer = drive->hwif->devices[(drive->dn ^ 1) & 1];
1557
1558         return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1559 }
1560
1561 #define ide_port_for_each_dev(i, dev, port) \
1562         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++)
1563
1564 #define ide_port_for_each_present_dev(i, dev, port) \
1565         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++) \
1566                 if ((dev)->dev_flags & IDE_DFLAG_PRESENT)
1567
1568 #define ide_host_for_each_port(i, port, host) \
1569         for ((i) = 0; ((port) = (host)->ports[i]) || (i) < MAX_HOST_PORTS; (i)++)
1570
1571 #endif /* _IDE_H */