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/hdreg.h>
  12 #include <linux/hdsmart.h>
  13 #include <linux/blkdev.h>
  14 #include <linux/proc_fs.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/bitops.h>
  17 #include <linux/bio.h>
  18 #include <linux/device.h>
  19 #include <linux/pci.h>
  20 #include <linux/completion.h>
  21 #include <asm/byteorder.h>
  22 #include <asm/system.h>
  23 #include <asm/io.h>
  24 #include <asm/semaphore.h>
  25
  26 /******************************************************************************
  27  * IDE driver configuration options (play with these as desired):
  28  *
  29  * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
  30  */
  31 #define INITIAL_MULT_COUNT      0       /* off=0; on=2,4,8,16,32, etc.. */
  32
  33 #ifndef SUPPORT_SLOW_DATA_PORTS         /* 1 to support slow data ports */
  34 #define SUPPORT_SLOW_DATA_PORTS 1       /* 0 to reduce kernel size */
  35 #endif
  36 #ifndef SUPPORT_VLB_SYNC                /* 1 to support weird 32-bit chips */
  37 #define SUPPORT_VLB_SYNC        1       /* 0 to reduce kernel size */
  38 #endif
  39 #ifndef OK_TO_RESET_CONTROLLER          /* 1 needed for good error recovery */
  40 #define OK_TO_RESET_CONTROLLER  1       /* 0 for use with AH2372A/B interface */
  41 #endif
  42
  43 #ifndef DISABLE_IRQ_NOSYNC
  44 #define DISABLE_IRQ_NOSYNC      0
  45 #endif
  46
  47 /*
  48  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
  49  * number.
  50  */
  51
  52 #define IDE_NO_IRQ              (-1)
  53
  54 /*
  55  *  "No user-serviceable parts" beyond this point  :)
  56  *****************************************************************************/
  57
  58 typedef unsigned char   byte;   /* used everywhere */
  59
  60 /*
  61  * Probably not wise to fiddle with these
  62  */
  63 #define ERROR_MAX       8       /* Max read/write errors per sector */
  64 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  65 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  66
  67 /*
  68  * Tune flags
  69  */
  70 #define IDE_TUNE_NOAUTO         2
  71 #define IDE_TUNE_AUTO           1
  72 #define IDE_TUNE_DEFAULT        0
  73
  74 /*
  75  * state flags
  76  */
  77
  78 #define DMA_PIO_RETRY   1       /* retrying in PIO */
  79
  80 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
  81 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  82
  83 /*
  84  * Definitions for accessing IDE controller registers
  85  */
  86 #define IDE_NR_PORTS            (10)
  87
  88 #define IDE_DATA_OFFSET         (0)
  89 #define IDE_ERROR_OFFSET        (1)
  90 #define IDE_NSECTOR_OFFSET      (2)
  91 #define IDE_SECTOR_OFFSET       (3)
  92 #define IDE_LCYL_OFFSET         (4)
  93 #define IDE_HCYL_OFFSET         (5)
  94 #define IDE_SELECT_OFFSET       (6)
  95 #define IDE_STATUS_OFFSET       (7)
  96 #define IDE_CONTROL_OFFSET      (8)
  97 #define IDE_IRQ_OFFSET          (9)
  98
  99 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
 100 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
 101
 102 #define IDE_CONTROL_OFFSET_HOB  (7)
 103
 104 #define IDE_DATA_REG            (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
 105 #define IDE_ERROR_REG           (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
 106 #define IDE_NSECTOR_REG         (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
 107 #define IDE_SECTOR_REG          (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
 108 #define IDE_LCYL_REG            (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
 109 #define IDE_HCYL_REG            (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
 110 #define IDE_SELECT_REG          (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
 111 #define IDE_STATUS_REG          (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
 112 #define IDE_CONTROL_REG         (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
 113 #define IDE_IRQ_REG             (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
 114
 115 #define IDE_FEATURE_REG         IDE_ERROR_REG
 116 #define IDE_COMMAND_REG         IDE_STATUS_REG
 117 #define IDE_ALTSTATUS_REG       IDE_CONTROL_REG
 118 #define IDE_IREASON_REG         IDE_NSECTOR_REG
 119 #define IDE_BCOUNTL_REG         IDE_LCYL_REG
 120 #define IDE_BCOUNTH_REG         IDE_HCYL_REG
 121
 122 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
 123 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
 124 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
 125 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
 126 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
 127 #define DATA_READY              (DRQ_STAT)
 128
 129 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
 130
 131 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
 132
 133 #define SATA_STATUS_OFFSET      (0)
 134 #define SATA_STATUS_REG         (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
 135 #define SATA_ERROR_OFFSET       (1)
 136 #define SATA_ERROR_REG          (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
 137 #define SATA_CONTROL_OFFSET     (2)
 138 #define SATA_CONTROL_REG        (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
 139
 140 #define SATA_MISC_OFFSET        (0)
 141 #define SATA_MISC_REG           (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
 142 #define SATA_PHY_OFFSET         (1)
 143 #define SATA_PHY_REG            (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
 144 #define SATA_IEN_OFFSET         (2)
 145 #define SATA_IEN_REG            (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
 146
 147 /*
 148  * Our Physical Region Descriptor (PRD) table should be large enough
 149  * to handle the biggest I/O request we are likely to see.  Since requests
 150  * can have no more than 256 sectors, and since the typical blocksize is
 151  * two or more sectors, we could get by with a limit of 128 entries here for
 152  * the usual worst case.  Most requests seem to include some contiguous blocks,
 153  * further reducing the number of table entries required.
 154  *
 155  * The driver reverts to PIO mode for individual requests that exceed
 156  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 157  * 100% of all crazy scenarios here is not necessary.
 158  *
 159  * As it turns out though, we must allocate a full 4KB page for this,
 160  * so the two PRD tables (ide0 & ide1) will each get half of that,
 161  * allowing each to have about 256 entries (8 bytes each) from this.
 162  */
 163 #define PRD_BYTES       8
 164 #define PRD_ENTRIES     256
 165
 166 /*
 167  * Some more useful definitions
 168  */
 169 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 170 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 171 #define SECTOR_SIZE     512
 172 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
 173 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
 174
 175 /*
 176  * Timeouts for various operations:
 177  */
 178 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
 179 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
 180 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
 181 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
 182 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
 183 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
 184
 185 /*
 186  * Check for an interrupt and acknowledge the interrupt status
 187  */
 188 struct hwif_s;
 189 typedef int (ide_ack_intr_t)(struct hwif_s *);
 190
 191 #ifndef NO_DMA
 192 #define NO_DMA  255
 193 #endif
 194
 195 /*
 196  * hwif_chipset_t is used to keep track of the specific hardware
 197  * chipset used by each IDE interface, if known.
 198  */
 199 typedef enum {  ide_unknown,    ide_generic,    ide_pci,
 200                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 201                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 202                 ide_rz1000,     ide_trm290,
 203                 ide_cmd646,     ide_cy82c693,   ide_4drives,
 204                 ide_pmac,       ide_etrax100,   ide_acorn,
 205                 ide_au1xxx, ide_forced
 206 } hwif_chipset_t;
 207
 208 /*
 209  * Structure to hold all information about the location of this port
 210  */
 211 typedef struct hw_regs_s {
 212         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
 213         int             irq;                    /* our irq number */
 214         int             dma;                    /* our dma entry */
 215         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 216         hwif_chipset_t  chipset;
 217         struct device   *dev;
 218 } hw_regs_t;
 219
 220 /*
 221  * Register new hardware with ide
 222  */
 223 int ide_register_hw(hw_regs_t *hw, struct hwif_s **hwifp);
 224 int ide_register_hw_with_fixup(hw_regs_t *, struct hwif_s **, void (*)(struct hwif_s *));
 225
 226 /*
 227  * Set up hw_regs_t structure before calling ide_register_hw (optional)
 228  */
 229 void ide_setup_ports(   hw_regs_t *hw,
 230                         unsigned long base,
 231                         int *offsets,
 232                         unsigned long ctrl,
 233                         unsigned long intr,
 234                         ide_ack_intr_t *ack_intr,
 235 #if 0
 236                         ide_io_ops_t *iops,
 237 #endif
 238                         int irq);
 239
 240 static inline void ide_std_init_ports(hw_regs_t *hw,
 241                                       unsigned long io_addr,
 242                                       unsigned long ctl_addr)
 243 {
 244         unsigned int i;
 245
 246         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
 247                 hw->io_ports[i] = io_addr++;
 248
 249         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
 250 }
 251
 252 #include <asm/ide.h>
 253
 254 #ifndef MAX_HWIFS
 255 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
 256 #endif
 257
 258 /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
 259 #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
 260 # define ide_default_io_base(index)     (0)
 261 # define ide_default_irq(base)          (0)
 262 # define ide_init_default_irq(base)     (0)
 263 #endif
 264
 265 /*
 266  * ide_init_hwif_ports() is OBSOLETE and will be removed in 2.7 series.
 267  * New ports shouldn't define IDE_ARCH_OBSOLETE_INIT in <asm/ide.h>.
 268  */
 269 #ifdef IDE_ARCH_OBSOLETE_INIT
 270 static inline void ide_init_hwif_ports(hw_regs_t *hw,
 271                                        unsigned long io_addr,
 272                                        unsigned long ctl_addr,
 273                                        int *irq)
 274 {
 275         if (!ctl_addr)
 276                 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
 277         else
 278                 ide_std_init_ports(hw, io_addr, ctl_addr);
 279
 280         if (irq)
 281                 *irq = 0;
 282
 283         hw->io_ports[IDE_IRQ_OFFSET] = 0;
 284
 285 #ifdef CONFIG_PPC32
 286         if (ppc_ide_md.ide_init_hwif)
 287                 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
 288 #endif
 289 }
 290 #else
 291 static inline void ide_init_hwif_ports(hw_regs_t *hw,
 292                                        unsigned long io_addr,
 293                                        unsigned long ctl_addr,
 294                                        int *irq)
 295 {
 296         if (io_addr || ctl_addr)
 297                 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
 298 }
 299 #endif /* IDE_ARCH_OBSOLETE_INIT */
 300
 301 /* Currently only m68k, apus and m8xx need it */
 302 #ifndef IDE_ARCH_ACK_INTR
 303 # define ide_ack_intr(hwif) (1)
 304 #endif
 305
 306 /* Currently only Atari needs it */
 307 #ifndef IDE_ARCH_LOCK
 308 # define ide_release_lock()                     do {} while (0)
 309 # define ide_get_lock(hdlr, data)               do {} while (0)
 310 #endif /* IDE_ARCH_LOCK */
 311
 312 /*
 313  * Now for the data we need to maintain per-drive:  ide_drive_t
 314  */
 315
 316 #define ide_scsi        0x21
 317 #define ide_disk        0x20
 318 #define ide_optical     0x7
 319 #define ide_cdrom       0x5
 320 #define ide_tape        0x1
 321 #define ide_floppy      0x0
 322
 323 /*
 324  * Special Driver Flags
 325  *
 326  * set_geometry : respecify drive geometry
 327  * recalibrate  : seek to cyl 0
 328  * set_multmode : set multmode count
 329  * set_tune     : tune interface for drive
 330  * serviced     : service command
 331  * reserved     : unused
 332  */
 333 typedef union {
 334         unsigned all                    : 8;
 335         struct {
 336 #if defined(__LITTLE_ENDIAN_BITFIELD)
 337                 unsigned set_geometry   : 1;
 338                 unsigned recalibrate    : 1;
 339                 unsigned set_multmode   : 1;
 340                 unsigned set_tune       : 1;
 341                 unsigned serviced       : 1;
 342                 unsigned reserved       : 3;
 343 #elif defined(__BIG_ENDIAN_BITFIELD)
 344                 unsigned reserved       : 3;
 345                 unsigned serviced       : 1;
 346                 unsigned set_tune       : 1;
 347                 unsigned set_multmode   : 1;
 348                 unsigned recalibrate    : 1;
 349                 unsigned set_geometry   : 1;
 350 #else
 351 #error "Please fix <asm/byteorder.h>"
 352 #endif
 353         } b;
 354 } special_t;
 355
 356 /*
 357  * ATA DATA Register Special.
 358  * ATA NSECTOR Count Register().
 359  * ATAPI Byte Count Register.
 360  * Channel index ordering pairs.
 361  */
 362 typedef union {
 363         unsigned all                    :16;
 364         struct {
 365 #if defined(__LITTLE_ENDIAN_BITFIELD)
 366                 unsigned low            :8;     /* LSB */
 367                 unsigned high           :8;     /* MSB */
 368 #elif defined(__BIG_ENDIAN_BITFIELD)
 369                 unsigned high           :8;     /* MSB */
 370                 unsigned low            :8;     /* LSB */
 371 #else
 372 #error "Please fix <asm/byteorder.h>"
 373 #endif
 374         } b;
 375 } ata_nsector_t, ata_data_t, atapi_bcount_t, ata_index_t;
 376
 377 /*
 378  * ATA-IDE Select Register, aka Device-Head
 379  *
 380  * head         : always zeros here
 381  * unit         : drive select number: 0/1
 382  * bit5         : always 1
 383  * lba          : using LBA instead of CHS
 384  * bit7         : always 1
 385  */
 386 typedef union {
 387         unsigned all                    : 8;
 388         struct {
 389 #if defined(__LITTLE_ENDIAN_BITFIELD)
 390                 unsigned head           : 4;
 391                 unsigned unit           : 1;
 392                 unsigned bit5           : 1;
 393                 unsigned lba            : 1;
 394                 unsigned bit7           : 1;
 395 #elif defined(__BIG_ENDIAN_BITFIELD)
 396                 unsigned bit7           : 1;
 397                 unsigned lba            : 1;
 398                 unsigned bit5           : 1;
 399                 unsigned unit           : 1;
 400                 unsigned head           : 4;
 401 #else
 402 #error "Please fix <asm/byteorder.h>"
 403 #endif
 404         } b;
 405 } select_t, ata_select_t;
 406
 407 /*
 408  * The ATA-IDE Status Register.
 409  * The ATAPI Status Register.
 410  *
 411  * check        : Error occurred
 412  * idx          : Index Error
 413  * corr         : Correctable error occurred
 414  * drq          : Data is request by the device
 415  * dsc          : Disk Seek Complete                    : ata
 416  *              : Media access command finished         : atapi
 417  * df           : Device Fault                          : ata
 418  *              : Reserved                              : atapi
 419  * drdy         : Ready, Command Mode Capable           : ata
 420  *              : Ignored for ATAPI commands            : atapi
 421  * bsy          : Disk is Busy
 422  *              : The device has access to the command block
 423  */
 424 typedef union {
 425         unsigned all                    :8;
 426         struct {
 427 #if defined(__LITTLE_ENDIAN_BITFIELD)
 428                 unsigned check          :1;
 429                 unsigned idx            :1;
 430                 unsigned corr           :1;
 431                 unsigned drq            :1;
 432                 unsigned dsc            :1;
 433                 unsigned df             :1;
 434                 unsigned drdy           :1;
 435                 unsigned bsy            :1;
 436 #elif defined(__BIG_ENDIAN_BITFIELD)
 437                 unsigned bsy            :1;
 438                 unsigned drdy           :1;
 439                 unsigned df             :1;
 440                 unsigned dsc            :1;
 441                 unsigned drq            :1;
 442                 unsigned corr           :1;
 443                 unsigned idx            :1;
 444                 unsigned check          :1;
 445 #else
 446 #error "Please fix <asm/byteorder.h>"
 447 #endif
 448         } b;
 449 } ata_status_t, atapi_status_t;
 450
 451 /*
 452  * ATAPI Feature Register
 453  *
 454  * dma          : Using DMA or PIO
 455  * reserved321  : Reserved
 456  * reserved654  : Reserved (Tag Type)
 457  * reserved7    : Reserved
 458  */
 459 typedef union {
 460         unsigned all                    :8;
 461         struct {
 462 #if defined(__LITTLE_ENDIAN_BITFIELD)
 463                 unsigned dma            :1;
 464                 unsigned reserved321    :3;
 465                 unsigned reserved654    :3;
 466                 unsigned reserved7      :1;
 467 #elif defined(__BIG_ENDIAN_BITFIELD)
 468                 unsigned reserved7      :1;
 469                 unsigned reserved654    :3;
 470                 unsigned reserved321    :3;
 471                 unsigned dma            :1;
 472 #else
 473 #error "Please fix <asm/byteorder.h>"
 474 #endif
 475         } b;
 476 } atapi_feature_t;
 477
 478 /*
 479  * ATAPI Interrupt Reason Register.
 480  *
 481  * cod          : Information transferred is command (1) or data (0)
 482  * io           : The device requests us to read (1) or write (0)
 483  * reserved     : Reserved
 484  */
 485 typedef union {
 486         unsigned all                    :8;
 487         struct {
 488 #if defined(__LITTLE_ENDIAN_BITFIELD)
 489                 unsigned cod            :1;
 490                 unsigned io             :1;
 491                 unsigned reserved       :6;
 492 #elif defined(__BIG_ENDIAN_BITFIELD)
 493                 unsigned reserved       :6;
 494                 unsigned io             :1;
 495                 unsigned cod            :1;
 496 #else
 497 #error "Please fix <asm/byteorder.h>"
 498 #endif
 499         } b;
 500 } atapi_ireason_t;
 501
 502 /*
 503  * The ATAPI error register.
 504  *
 505  * ili          : Illegal Length Indication
 506  * eom          : End Of Media Detected
 507  * abrt         : Aborted command - As defined by ATA
 508  * mcr          : Media Change Requested - As defined by ATA
 509  * sense_key    : Sense key of the last failed packet command
 510  */
 511 typedef union {
 512         unsigned all                    :8;
 513         struct {
 514 #if defined(__LITTLE_ENDIAN_BITFIELD)
 515                 unsigned ili            :1;
 516                 unsigned eom            :1;
 517                 unsigned abrt           :1;
 518                 unsigned mcr            :1;
 519                 unsigned sense_key      :4;
 520 #elif defined(__BIG_ENDIAN_BITFIELD)
 521                 unsigned sense_key      :4;
 522                 unsigned mcr            :1;
 523                 unsigned abrt           :1;
 524                 unsigned eom            :1;
 525                 unsigned ili            :1;
 526 #else
 527 #error "Please fix <asm/byteorder.h>"
 528 #endif
 529         } b;
 530 } atapi_error_t;
 531
 532 /*
 533  * Status returned from various ide_ functions
 534  */
 535 typedef enum {
 536         ide_stopped,    /* no drive operation was started */
 537         ide_started,    /* a drive operation was started, handler was set */
 538 } ide_startstop_t;
 539
 540 struct ide_driver_s;
 541 struct ide_settings_s;
 542
 543 typedef struct ide_drive_s {
 544         char            name[4];        /* drive name, such as "hda" */
 545         char            driver_req[10]; /* requests specific driver */
 546
 547         request_queue_t         *queue; /* request queue */
 548
 549         struct request          *rq;    /* current request */
 550         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
 551         void            *driver_data;   /* extra driver data */
 552         struct hd_driveid       *id;    /* drive model identification info */
 553         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 554         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
 555
 556         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 557
 558         unsigned long sleep;            /* sleep until this time */
 559         unsigned long service_start;    /* time we started last request */
 560         unsigned long service_time;     /* service time of last request */
 561         unsigned long timeout;          /* max time to wait for irq */
 562
 563         special_t       special;        /* special action flags */
 564         select_t        select;         /* basic drive/head select reg value */
 565
 566         u8      keep_settings;          /* restore settings after drive reset */
 567         u8      autodma;                /* device can safely use dma on host */
 568         u8      using_dma;              /* disk is using dma for read/write */
 569         u8      retry_pio;              /* retrying dma capable host in pio */
 570         u8      state;                  /* retry state */
 571         u8      waiting_for_dma;        /* dma currently in progress */
 572         u8      unmask;                 /* okay to unmask other irqs */
 573         u8      bswap;                  /* byte swap data */
 574         u8      noflush;                /* don't attempt flushes */
 575         u8      dsc_overlap;            /* DSC overlap */
 576         u8      nice1;                  /* give potential excess bandwidth */
 577
 578         unsigned present        : 1;    /* drive is physically present */
 579         unsigned dead           : 1;    /* device ejected hint */
 580         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
 581         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 582         unsigned removable      : 1;    /* 1 if need to do check_media_change */
 583         unsigned attach         : 1;    /* needed for removable devices */
 584         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
 585         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
 586         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
 587         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
 588         unsigned nice0          : 1;    /* give obvious excess bandwidth */
 589         unsigned nice2          : 1;    /* give a share in our own bandwidth */
 590         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
 591         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
 592         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
 593         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
 594         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
 595         unsigned addressing;            /*      : 3;
 596                                          *  0=28-bit
 597                                          *  1=48-bit
 598                                          *  2=48-bit doing 28-bit
 599                                          *  3=64-bit
 600                                          */
 601         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
 602         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
 603         unsigned post_reset     : 1;
 604
 605         u8      quirk_list;     /* considered quirky, set for a specific host */
 606         u8      init_speed;     /* transfer rate set at boot */
 607         u8      pio_speed;      /* unused by core, used by some drivers for fallback from DMA */
 608         u8      current_speed;  /* current transfer rate set */
 609         u8      dn;             /* now wide spread use */
 610         u8      wcache;         /* status of write cache */
 611         u8      acoustic;       /* acoustic management */
 612         u8      media;          /* disk, cdrom, tape, floppy, ... */
 613         u8      ctl;            /* "normal" value for IDE_CONTROL_REG */
 614         u8      ready_stat;     /* min status value for drive ready */
 615         u8      mult_count;     /* current multiple sector setting */
 616         u8      mult_req;       /* requested multiple sector setting */
 617         u8      tune_req;       /* requested drive tuning setting */
 618         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 619         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
 620         u8      nowerr;         /* used for ignoring WRERR_STAT */
 621         u8      sect0;          /* offset of first sector for DM6:DDO */
 622         u8      head;           /* "real" number of heads */
 623         u8      sect;           /* "real" sectors per track */
 624         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 625         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 626
 627         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 628         unsigned int    cyl;            /* "real" number of cyls */
 629         unsigned int    drive_data;     /* use by tuneproc/selectproc */
 630         unsigned int    usage;          /* current "open()" count for drive */
 631         unsigned int    failures;       /* current failure count */
 632         unsigned int    max_failures;   /* maximum allowed failure count */
 633         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
 634
 635         u64             capacity64;     /* total number of sectors */
 636
 637         int             lun;            /* logical unit */
 638         int             crc_count;      /* crc counter to reduce drive speed */
 639         struct list_head list;
 640         struct device   gendev;
 641         struct completion gendev_rel_comp;      /* to deal with device release() */
 642 } ide_drive_t;
 643
 644 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
 645
 646 #define IDE_CHIPSET_PCI_MASK    \
 647     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
 648 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
 649
 650 struct ide_pci_device_s;
 651
 652 typedef struct hwif_s {
 653         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
 654         struct hwif_s *mate;            /* other hwif from same PCI chip */
 655         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
 656         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 657
 658         char name[6];                   /* name of interface, eg. "ide0" */
 659
 660                 /* task file registers for pata and sata */
 661         unsigned long   io_ports[IDE_NR_PORTS];
 662         unsigned long   sata_scr[SATA_NR_PORTS];
 663         unsigned long   sata_misc[SATA_NR_PORTS];
 664
 665         hw_regs_t       hw;             /* Hardware info */
 666         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 667
 668         u8 major;       /* our major number */
 669         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 670         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 671         u8 straight8;   /* Alan's straight 8 check */
 672         u8 bus_state;   /* power state of the IDE bus */
 673
 674         u8 atapi_dma;   /* host supports atapi_dma */
 675         u8 ultra_mask;
 676         u8 mwdma_mask;
 677         u8 swdma_mask;
 678
 679         hwif_chipset_t chipset; /* sub-module for tuning.. */
 680
 681         struct pci_dev  *pci_dev;       /* for pci chipsets */
 682         struct ide_pci_device_s *cds;   /* chipset device struct */
 683
 684         void (*rw_disk)(ide_drive_t *, struct request *);
 685
 686 #if 0
 687         ide_hwif_ops_t  *hwifops;
 688 #else
 689         /* routine to tune PIO mode for drives */
 690         void    (*tuneproc)(ide_drive_t *, u8);
 691         /* routine to retune DMA modes for drives */
 692         int     (*speedproc)(ide_drive_t *, u8);
 693         /* tweaks hardware to select drive */
 694         void    (*selectproc)(ide_drive_t *);
 695         /* chipset polling based on hba specifics */
 696         int     (*reset_poll)(ide_drive_t *);
 697         /* chipset specific changes to default for device-hba resets */
 698         void    (*pre_reset)(ide_drive_t *);
 699         /* routine to reset controller after a disk reset */
 700         void    (*resetproc)(ide_drive_t *);
 701         /* special interrupt handling for shared pci interrupts */
 702         void    (*intrproc)(ide_drive_t *);
 703         /* special host masking for drive selection */
 704         void    (*maskproc)(ide_drive_t *, int);
 705         /* check host's drive quirk list */
 706         int     (*quirkproc)(ide_drive_t *);
 707         /* driver soft-power interface */
 708         int     (*busproc)(ide_drive_t *, int);
 709 //      /* host rate limiter */
 710 //      u8      (*ratemask)(ide_drive_t *);
 711 //      /* device rate limiter */
 712 //      u8      (*ratefilter)(ide_drive_t *, u8);
 713 #endif
 714
 715         void (*ata_input_data)(ide_drive_t *, void *, u32);
 716         void (*ata_output_data)(ide_drive_t *, void *, u32);
 717
 718         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
 719         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
 720
 721         int (*dma_setup)(ide_drive_t *);
 722         void (*dma_exec_cmd)(ide_drive_t *, u8);
 723         void (*dma_start)(ide_drive_t *);
 724         int (*ide_dma_end)(ide_drive_t *drive);
 725         int (*ide_dma_check)(ide_drive_t *drive);
 726         int (*ide_dma_on)(ide_drive_t *drive);
 727         int (*ide_dma_off_quietly)(ide_drive_t *drive);
 728         int (*ide_dma_test_irq)(ide_drive_t *drive);
 729         int (*ide_dma_host_on)(ide_drive_t *drive);
 730         int (*ide_dma_host_off)(ide_drive_t *drive);
 731         int (*ide_dma_lostirq)(ide_drive_t *drive);
 732         int (*ide_dma_timeout)(ide_drive_t *drive);
 733
 734         void (*OUTB)(u8 addr, unsigned long port);
 735         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
 736         void (*OUTW)(u16 addr, unsigned long port);
 737         void (*OUTL)(u32 addr, unsigned long port);
 738         void (*OUTSW)(unsigned long port, void *addr, u32 count);
 739         void (*OUTSL)(unsigned long port, void *addr, u32 count);
 740
 741         u8  (*INB)(unsigned long port);
 742         u16 (*INW)(unsigned long port);
 743         u32 (*INL)(unsigned long port);
 744         void (*INSW)(unsigned long port, void *addr, u32 count);
 745         void (*INSL)(unsigned long port, void *addr, u32 count);
 746
 747         /* dma physical region descriptor table (cpu view) */
 748         unsigned int    *dmatable_cpu;
 749         /* dma physical region descriptor table (dma view) */
 750         dma_addr_t      dmatable_dma;
 751         /* Scatter-gather list used to build the above */
 752         struct scatterlist *sg_table;
 753         int sg_max_nents;               /* Maximum number of entries in it */
 754         int sg_nents;                   /* Current number of entries in it */
 755         int sg_dma_direction;           /* dma transfer direction */
 756
 757         /* data phase of the active command (currently only valid for PIO/DMA) */
 758         int             data_phase;
 759
 760         unsigned int nsect;
 761         unsigned int nleft;
 762         unsigned int cursg;
 763         unsigned int cursg_ofs;
 764
 765         int             mmio;           /* hosts iomio (0) or custom (2) select */
 766         int             rqsize;         /* max sectors per request */
 767         int             irq;            /* our irq number */
 768
 769         unsigned long   dma_master;     /* reference base addr dmabase */
 770         unsigned long   dma_base;       /* base addr for dma ports */
 771         unsigned long   dma_command;    /* dma command register */
 772         unsigned long   dma_vendor1;    /* dma vendor 1 register */
 773         unsigned long   dma_status;     /* dma status register */
 774         unsigned long   dma_vendor3;    /* dma vendor 3 register */
 775         unsigned long   dma_prdtable;   /* actual prd table address */
 776         unsigned long   dma_base2;      /* extended base addr for dma ports */
 777
 778         unsigned long   config_data;    /* for use by chipset-specific code */
 779         unsigned long   select_data;    /* for use by chipset-specific code */
 780
 781         unsigned long   extra_base;     /* extra addr for dma ports */
 782         unsigned        extra_ports;    /* number of extra dma ports */
 783
 784         unsigned        noprobe    : 1; /* don't probe for this interface */
 785         unsigned        present    : 1; /* this interface exists */
 786         unsigned        hold       : 1; /* this interface is always present */
 787         unsigned        serialized : 1; /* serialized all channel operation */
 788         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
 789         unsigned        reset      : 1; /* reset after probe */
 790         unsigned        autodma    : 1; /* auto-attempt using DMA at boot */
 791         unsigned        udma_four  : 1; /* 1=ATA-66 capable, 0=default */
 792         unsigned        no_lba48   : 1; /* 1 = cannot do LBA48 */
 793         unsigned        no_lba48_dma : 1; /* 1 = cannot do LBA48 DMA */
 794         unsigned        no_dsc     : 1; /* 0 default, 1 dsc_overlap disabled */
 795         unsigned        auto_poll  : 1; /* supports nop auto-poll */
 796         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
 797         unsigned        no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
 798         unsigned        err_stops_fifo : 1; /* 1=data FIFO is cleared by an error */
 799
 800         struct device   gendev;
 801         struct completion gendev_rel_comp; /* To deal with device release() */
 802
 803         void            *hwif_data;     /* extra hwif data */
 804
 805         unsigned dma;
 806
 807         void (*led_act)(void *data, int rw);
 808 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 809
 810 /*
 811  *  internal ide interrupt handler type
 812  */
 813 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
 814 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 815 typedef int (ide_expiry_t)(ide_drive_t *);
 816
 817 typedef struct hwgroup_s {
 818                 /* irq handler, if active */
 819         ide_startstop_t (*handler)(ide_drive_t *);
 820                 /* irq handler, suspended if active */
 821         ide_startstop_t (*handler_save)(ide_drive_t *);
 822                 /* BOOL: protects all fields below */
 823         volatile int busy;
 824                 /* BOOL: wake us up on timer expiry */
 825         unsigned int sleeping   : 1;
 826                 /* BOOL: polling active & poll_timeout field valid */
 827         unsigned int polling    : 1;
 828                 /* current drive */
 829         ide_drive_t *drive;
 830                 /* ptr to current hwif in linked-list */
 831         ide_hwif_t *hwif;
 832
 833                 /* for pci chipsets */
 834         struct pci_dev *pci_dev;
 835                 /* chipset device struct */
 836         struct ide_pci_device_s *cds;
 837
 838                 /* current request */
 839         struct request *rq;
 840                 /* failsafe timer */
 841         struct timer_list timer;
 842                 /* local copy of current write rq */
 843         struct request wrq;
 844                 /* timeout value during long polls */
 845         unsigned long poll_timeout;
 846                 /* queried upon timeouts */
 847         int (*expiry)(ide_drive_t *);
 848                 /* ide_system_bus_speed */
 849         int pio_clock;
 850
 851         unsigned char cmd_buf[4];
 852 } ide_hwgroup_t;
 853
 854 /* structure attached to the request for IDE_TASK_CMDS */
 855
 856 /*
 857  * configurable drive settings
 858  */
 859
 860 #define TYPE_INT        0
 861 #define TYPE_INTA       1
 862 #define TYPE_BYTE       2
 863 #define TYPE_SHORT      3
 864
 865 #define SETTING_READ    (1 << 0)
 866 #define SETTING_WRITE   (1 << 1)
 867 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
 868
 869 typedef int (ide_procset_t)(ide_drive_t *, int);
 870 typedef struct ide_settings_s {
 871         char                    *name;
 872         int                     rw;
 873         int                     read_ioctl;
 874         int                     write_ioctl;
 875         int                     data_type;
 876         int                     min;
 877         int                     max;
 878         int                     mul_factor;
 879         int                     div_factor;
 880         void                    *data;
 881         ide_procset_t           *set;
 882         int                     auto_remove;
 883         struct ide_settings_s   *next;
 884 } ide_settings_t;
 885
 886 extern struct semaphore ide_setting_sem;
 887 extern int ide_add_setting(ide_drive_t *drive, const char *name, int rw, int read_ioctl, int write_ioctl, int data_type, int min, int max, int mul_factor, int div_factor, void *data, ide_procset_t *set);
 888 extern ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name);
 889 extern int ide_read_setting(ide_drive_t *t, ide_settings_t *setting);
 890 extern int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val);
 891 extern void ide_add_generic_settings(ide_drive_t *drive);
 892
 893 /*
 894  * /proc/ide interface
 895  */
 896 typedef struct {
 897         const char      *name;
 898         mode_t          mode;
 899         read_proc_t     *read_proc;
 900         write_proc_t    *write_proc;
 901 } ide_proc_entry_t;
 902
 903 #ifdef CONFIG_PROC_FS
 904 extern struct proc_dir_entry *proc_ide_root;
 905
 906 extern void proc_ide_create(void);
 907 extern void proc_ide_destroy(void);
 908 extern void create_proc_ide_interfaces(void);
 909 void destroy_proc_ide_interface(ide_hwif_t *);
 910 extern void ide_add_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *, void *);
 911 extern void ide_remove_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *);
 912 read_proc_t proc_ide_read_capacity;
 913 read_proc_t proc_ide_read_geometry;
 914
 915 #ifdef CONFIG_BLK_DEV_IDEPCI
 916 void ide_pci_create_host_proc(const char *, get_info_t *);
 917 #endif
 918
 919 /*
 920  * Standard exit stuff:
 921  */
 922 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 923 {                                       \
 924         len -= off;                     \
 925         if (len < count) {              \
 926                 *eof = 1;               \
 927                 if (len <= 0)           \
 928                         return 0;       \
 929         } else                          \
 930                 len = count;            \
 931         *start = page + off;            \
 932         return len;                     \
 933 }
 934 #else
 935 static inline void create_proc_ide_interfaces(void) { ; }
 936 static inline void destroy_proc_ide_interface(ide_hwif_t *hwif) { ; }
 937 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 938 #endif
 939
 940 /*
 941  * Power Management step value (rq->pm->pm_step).
 942  *
 943  * The step value starts at 0 (ide_pm_state_start_suspend) for a
 944  * suspend operation or 1000 (ide_pm_state_start_resume) for a
 945  * resume operation.
 946  *
 947  * For each step, the core calls the subdriver start_power_step() first.
 948  * This can return:
 949  *      - ide_stopped : In this case, the core calls us back again unless
 950  *                      step have been set to ide_power_state_completed.
 951  *      - ide_started : In this case, the channel is left busy until an
 952  *                      async event (interrupt) occurs.
 953  * Typically, start_power_step() will issue a taskfile request with
 954  * do_rw_taskfile().
 955  *
 956  * Upon reception of the interrupt, the core will call complete_power_step()
 957  * with the error code if any. This routine should update the step value
 958  * and return. It should not start a new request. The core will call
 959  * start_power_step for the new step value, unless step have been set to
 960  * ide_power_state_completed.
 961  *
 962  * Subdrivers are expected to define their own additional power
 963  * steps from 1..999 for suspend and from 1001..1999 for resume,
 964  * other values are reserved for future use.
 965  */
 966
 967 enum {
 968         ide_pm_state_completed          = -1,
 969         ide_pm_state_start_suspend      = 0,
 970         ide_pm_state_start_resume       = 1000,
 971 };
 972
 973 /*
 974  * Subdrivers support.
 975  *
 976  * The gendriver.owner field should be set to the module owner of this driver.
 977  * The gendriver.name field should be set to the name of this driver
 978  */
 979 typedef struct ide_driver_s {
 980         const char                      *version;
 981         u8                              media;
 982         unsigned supports_dsc_overlap   : 1;
 983         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
 984         int             (*end_request)(ide_drive_t *, int, int);
 985         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
 986         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
 987         ide_proc_entry_t        *proc;
 988         struct device_driver    gen_driver;
 989         int             (*probe)(ide_drive_t *);
 990         void            (*remove)(ide_drive_t *);
 991         void            (*shutdown)(ide_drive_t *);
 992 } ide_driver_t;
 993
 994 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
 995
 996 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
 997
 998 /*
 999  * ide_hwifs[] is the master data structure used to keep track
1000  * of just about everything in ide.c.  Whenever possible, routines
1001  * should be using pointers to a drive (ide_drive_t *) or
1002  * pointers to a hwif (ide_hwif_t *), rather than indexing this
1003  * structure directly (the allocation/layout may change!).
1004  *
1005  */
1006 #ifndef _IDE_C
1007 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
1008 #endif
1009 extern int noautodma;
1010
1011 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1012 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
1013                              int uptodate, int nr_sectors);
1014
1015 /*
1016  * This is used on exit from the driver to designate the next irq handler
1017  * and also to start the safety timer.
1018  */
1019 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1020
1021 /*
1022  * This is used on exit from the driver to designate the next irq handler
1023  * and start the safety time safely and atomically from the IRQ handler
1024  * with respect to the command issue (which it also does)
1025  */
1026 extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
1027
1028 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1029
1030 /*
1031  * ide_error() takes action based on the error returned by the controller.
1032  * The caller should return immediately after invoking this.
1033  *
1034  * (drive, msg, status)
1035  */
1036 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1037
1038 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
1039
1040 /*
1041  * Abort a running command on the controller triggering the abort
1042  * from a host side, non error situation
1043  * (drive, msg)
1044  */
1045 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1046
1047 extern void ide_fix_driveid(struct hd_driveid *);
1048 /*
1049  * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
1050  * removing leading/trailing blanks and compressing internal blanks.
1051  * It is primarily used to tidy up the model name/number fields as
1052  * returned by the WIN_[P]IDENTIFY commands.
1053  *
1054  * (s, bytecount, byteswap)
1055  */
1056 extern void ide_fixstring(u8 *, const int, const int);
1057
1058 /*
1059  * This routine busy-waits for the drive status to be not "busy".
1060  * It then checks the status for all of the "good" bits and none
1061  * of the "bad" bits, and if all is okay it returns 0.  All other
1062  * cases return 1 after doing "*startstop = ide_error()", and the
1063  * caller should return the updated value of "startstop" in this case.
1064  * "startstop" is unchanged when the function returns 0;
1065  * (startstop, drive, good, bad, timeout)
1066  */
1067 extern int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1068
1069 /*
1070  * Start a reset operation for an IDE interface.
1071  * The caller should return immediately after invoking this.
1072  */
1073 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1074
1075 /*
1076  * This function is intended to be used prior to invoking ide_do_drive_cmd().
1077  */
1078 extern void ide_init_drive_cmd (struct request *rq);
1079
1080 /*
1081  * this function returns error location sector offset in case of a write error
1082  */
1083 extern u64 ide_get_error_location(ide_drive_t *, char *);
1084
1085 /*
1086  * "action" parameter type for ide_do_drive_cmd() below.
1087  */
1088 typedef enum {
1089         ide_wait,       /* insert rq at end of list, and wait for it */
1090         ide_preempt,    /* insert rq in front of current request */
1091         ide_head_wait,  /* insert rq in front of current request and wait for it */
1092         ide_end         /* insert rq at end of list, but don't wait for it */
1093 } ide_action_t;
1094
1095 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1096
1097 /*
1098  * Clean up after success/failure of an explicit drive cmd.
1099  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
1100  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_TASK_MASK).
1101  *
1102  * (ide_drive_t *drive, u8 stat, u8 err)
1103  */
1104 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1105
1106 /*
1107  * Issue ATA command and wait for completion.
1108  * Use for implementing commands in kernel
1109  *
1110  *  (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1111  */
1112 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1113
1114 typedef struct ide_task_s {
1115 /*
1116  *      struct hd_drive_task_hdr        tf;
1117  *      task_struct_t           tf;
1118  *      struct hd_drive_hob_hdr         hobf;
1119  *      hob_struct_t            hobf;
1120  */
1121         task_ioreg_t            tfRegister[8];
1122         task_ioreg_t            hobRegister[8];
1123         ide_reg_valid_t         tf_out_flags;
1124         ide_reg_valid_t         tf_in_flags;
1125         int                     data_phase;
1126         int                     command_type;
1127         ide_pre_handler_t       *prehandler;
1128         ide_handler_t           *handler;
1129         struct request          *rq;            /* copy of request */
1130         void                    *special;       /* valid_t generally */
1131 } ide_task_t;
1132
1133 extern u32 ide_read_24(ide_drive_t *);
1134
1135 extern void SELECT_DRIVE(ide_drive_t *);
1136 extern void SELECT_INTERRUPT(ide_drive_t *);
1137 extern void SELECT_MASK(ide_drive_t *, int);
1138 extern void QUIRK_LIST(ide_drive_t *);
1139
1140 extern int drive_is_ready(ide_drive_t *);
1141 extern int wait_for_ready(ide_drive_t *, int /* timeout */);
1142
1143 /*
1144  * taskfile io for disks for now...and builds request from ide_ioctl
1145  */
1146 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1147
1148 /*
1149  * Special Flagged Register Validation Caller
1150  */
1151 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1152
1153 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1154 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1155 extern ide_startstop_t recal_intr(ide_drive_t *);
1156 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1157 extern ide_startstop_t task_in_intr(ide_drive_t *);
1158 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1159
1160 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1161
1162 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1163 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1164 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1165
1166 extern int system_bus_clock(void);
1167
1168 extern int ide_driveid_update(ide_drive_t *);
1169 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1170 extern int ide_config_drive_speed(ide_drive_t *, u8);
1171 extern u8 eighty_ninty_three (ide_drive_t *);
1172 extern int set_transfer(ide_drive_t *, ide_task_t *);
1173 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1174
1175 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1176
1177 /*
1178  * ide_stall_queue() can be used by a drive to give excess bandwidth back
1179  * to the hwgroup by sleeping for timeout jiffies.
1180  */
1181 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1182
1183 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1184 extern void ide_timer_expiry(unsigned long);
1185 extern irqreturn_t ide_intr(int irq, void *dev_id, struct pt_regs *regs);
1186 extern void do_ide_request(request_queue_t *);
1187
1188 void ide_init_disk(struct gendisk *, ide_drive_t *);
1189
1190 extern int ideprobe_init(void);
1191
1192 extern void ide_scan_pcibus(int scan_direction) __init;
1193 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner);
1194 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE)
1195 extern void ide_pci_unregister_driver(struct pci_driver *driver);
1196 void ide_pci_setup_ports(struct pci_dev *, struct ide_pci_device_s *, int, ata_index_t *);
1197 extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
1198
1199 extern void default_hwif_iops(ide_hwif_t *);
1200 extern void default_hwif_mmiops(ide_hwif_t *);
1201 extern void default_hwif_transport(ide_hwif_t *);
1202
1203 void ide_register_subdriver(ide_drive_t *, ide_driver_t *);
1204 void ide_unregister_subdriver(ide_drive_t *, ide_driver_t *);
1205
1206 #define ON_BOARD                1
1207 #define NEVER_BOARD             0
1208
1209 #ifdef CONFIG_BLK_DEV_OFFBOARD
1210 #  define OFF_BOARD             ON_BOARD
1211 #else /* CONFIG_BLK_DEV_OFFBOARD */
1212 #  define OFF_BOARD             NEVER_BOARD
1213 #endif /* CONFIG_BLK_DEV_OFFBOARD */
1214
1215 #define NODMA 0
1216 #define NOAUTODMA 1
1217 #define AUTODMA 2
1218
1219 typedef struct ide_pci_enablebit_s {
1220         u8      reg;    /* byte pci reg holding the enable-bit */
1221         u8      mask;   /* mask to isolate the enable-bit */
1222         u8      val;    /* value of masked reg when "enabled" */
1223 } ide_pci_enablebit_t;
1224
1225 enum {
1226         /* Uses ISA control ports not PCI ones. */
1227         IDEPCI_FLAG_ISA_PORTS           = (1 << 0),
1228 };
1229
1230 typedef struct ide_pci_device_s {
1231         char                    *name;
1232         int                     (*init_setup)(struct pci_dev *, struct ide_pci_device_s *);
1233         void                    (*init_setup_dma)(struct pci_dev *, struct ide_pci_device_s *, ide_hwif_t *);
1234         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1235         void                    (*init_iops)(ide_hwif_t *);
1236         void                    (*init_hwif)(ide_hwif_t *);
1237         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1238         void                    (*fixup)(ide_hwif_t *);
1239         u8                      channels;
1240         u8                      autodma;
1241         ide_pci_enablebit_t     enablebits[2];
1242         u8                      bootable;
1243         unsigned int            extra;
1244         struct ide_pci_device_s *next;
1245         u8                      flags;
1246 } ide_pci_device_t;
1247
1248 extern int ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
1249 extern int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
1250
1251 void ide_map_sg(ide_drive_t *, struct request *);
1252 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1253
1254 #define BAD_DMA_DRIVE           0
1255 #define GOOD_DMA_DRIVE          1
1256
1257 #ifdef CONFIG_BLK_DEV_IDEDMA
1258 struct drive_list_entry {
1259         const char *id_model;
1260         const char *id_firmware;
1261 };
1262
1263 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1264 int __ide_dma_bad_drive(ide_drive_t *);
1265 int __ide_dma_good_drive(ide_drive_t *);
1266 int ide_use_dma(ide_drive_t *);
1267 int __ide_dma_off(ide_drive_t *);
1268 void ide_dma_verbose(ide_drive_t *);
1269 ide_startstop_t ide_dma_intr(ide_drive_t *);
1270
1271 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1272 extern int ide_build_sglist(ide_drive_t *, struct request *);
1273 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1274 extern void ide_destroy_dmatable(ide_drive_t *);
1275 extern int ide_release_dma(ide_hwif_t *);
1276 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1277
1278 extern int __ide_dma_host_off(ide_drive_t *);
1279 extern int __ide_dma_off_quietly(ide_drive_t *);
1280 extern int __ide_dma_host_on(ide_drive_t *);
1281 extern int __ide_dma_on(ide_drive_t *);
1282 extern int __ide_dma_check(ide_drive_t *);
1283 extern int ide_dma_setup(ide_drive_t *);
1284 extern void ide_dma_start(ide_drive_t *);
1285 extern int __ide_dma_end(ide_drive_t *);
1286 extern int __ide_dma_lostirq(ide_drive_t *);
1287 extern int __ide_dma_timeout(ide_drive_t *);
1288 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1289
1290 #else
1291 static inline int ide_use_dma(ide_drive_t *drive) { return 0; }
1292 static inline int __ide_dma_off(ide_drive_t *drive) { return 0; }
1293 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1294 #endif /* CONFIG_BLK_DEV_IDEDMA */
1295
1296 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1297 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1298 #endif
1299
1300 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1301 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1302 extern void ide_unregister (unsigned int index);
1303
1304 void ide_register_region(struct gendisk *);
1305 void ide_unregister_region(struct gendisk *);
1306
1307 void ide_undecoded_slave(ide_hwif_t *);
1308
1309 int probe_hwif_init_with_fixup(ide_hwif_t *, void (*)(ide_hwif_t *));
1310 extern int probe_hwif_init(ide_hwif_t *);
1311
1312 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1313 {
1314         return hwif->hwif_data;
1315 }
1316
1317 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1318 {
1319         hwif->hwif_data = data;
1320 }
1321
1322 /* ide-lib.c */
1323 extern u8 ide_dma_speed(ide_drive_t *drive, u8 mode);
1324 extern u8 ide_rate_filter(u8 mode, u8 speed);
1325 extern int ide_dma_enable(ide_drive_t *drive);
1326 extern char *ide_xfer_verbose(u8 xfer_rate);
1327 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1328 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1329
1330 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1331
1332 typedef struct ide_pio_timings_s {
1333         int     setup_time;     /* Address setup (ns) minimum */
1334         int     active_time;    /* Active pulse (ns) minimum */
1335         int     cycle_time;     /* Cycle time (ns) minimum = (setup + active + recovery) */
1336 } ide_pio_timings_t;
1337
1338 typedef struct ide_pio_data_s {
1339         u8 pio_mode;
1340         u8 use_iordy;
1341         u8 overridden;
1342         u8 blacklisted;
1343         unsigned int cycle_time;
1344 } ide_pio_data_t;
1345
1346 extern u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d);
1347 extern const ide_pio_timings_t ide_pio_timings[6];
1348
1349
1350 extern spinlock_t ide_lock;
1351 extern struct semaphore ide_cfg_sem;
1352 /*
1353  * Structure locking:
1354  *
1355  * ide_cfg_sem and ide_lock together protect changes to
1356  * ide_hwif_t->{next,hwgroup}
1357  * ide_drive_t->next
1358  *
1359  * ide_hwgroup_t->busy: ide_lock
1360  * ide_hwgroup_t->hwif: ide_lock
1361  * ide_hwif_t->mate: constant, no locking
1362  * ide_drive_t->hwif: constant, no locking
1363  */
1364
1365 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1366
1367 extern struct bus_type ide_bus_type;
1368
1369 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1370 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1371
1372 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1373 #define ide_id_has_flush_cache_ext(id)  \
1374         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1375
1376 static inline int hwif_to_node(ide_hwif_t *hwif)
1377 {
1378         struct pci_dev *dev = hwif->pci_dev;
1379         return dev ? pcibus_to_node(dev->bus) : -1;
1380 }
1381
1382 #endif /* _IDE_H */