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