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