SAFE public projects git trees. - safe/jmp/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/blkdev.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/bitops.h>
  16 #include <linux/bio.h>
  17 #include <linux/device.h>
  18 #include <linux/pci.h>
  19 #include <linux/completion.h>
  20 #ifdef CONFIG_BLK_DEV_IDEACPI
  21 #include <acpi/acpi.h>
  22 #endif
  23 #include <asm/byteorder.h>
  24 #include <asm/system.h>
  25 #include <asm/io.h>
  26 #include <asm/mutex.h>
  27
  28 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV)
  29 # define SUPPORT_VLB_SYNC 0
  30 #else
  31 # define SUPPORT_VLB_SYNC 1
  32 #endif
  33
  34 /*
  35  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
  36  * number.
  37  */
  38
  39 #define IDE_NO_IRQ              (-1)
  40
  41 typedef unsigned char   byte;   /* used everywhere */
  42
  43 /*
  44  * Probably not wise to fiddle with these
  45  */
  46 #define ERROR_MAX       8       /* Max read/write errors per sector */
  47 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  48 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  49
  50 /*
  51  * Tune flags
  52  */
  53 #define IDE_TUNE_NOAUTO         2
  54 #define IDE_TUNE_AUTO           1
  55 #define IDE_TUNE_DEFAULT        0
  56
  57 /*
  58  * state flags
  59  */
  60
  61 #define DMA_PIO_RETRY   1       /* retrying in PIO */
  62
  63 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
  64 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  65
  66 /*
  67  * Definitions for accessing IDE controller registers
  68  */
  69 #define IDE_NR_PORTS            (10)
  70
  71 #define IDE_DATA_OFFSET         (0)
  72 #define IDE_ERROR_OFFSET        (1)
  73 #define IDE_NSECTOR_OFFSET      (2)
  74 #define IDE_SECTOR_OFFSET       (3)
  75 #define IDE_LCYL_OFFSET         (4)
  76 #define IDE_HCYL_OFFSET         (5)
  77 #define IDE_SELECT_OFFSET       (6)
  78 #define IDE_STATUS_OFFSET       (7)
  79 #define IDE_CONTROL_OFFSET      (8)
  80 #define IDE_IRQ_OFFSET          (9)
  81
  82 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
  83 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
  84 #define IDE_ALTSTATUS_OFFSET    IDE_CONTROL_OFFSET
  85 #define IDE_IREASON_OFFSET      IDE_NSECTOR_OFFSET
  86 #define IDE_BCOUNTL_OFFSET      IDE_LCYL_OFFSET
  87 #define IDE_BCOUNTH_OFFSET      IDE_HCYL_OFFSET
  88
  89 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
  90 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
  91 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
  92 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
  93 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
  94
  95 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
  96
  97 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
  98
  99 #define SATA_STATUS_OFFSET      (0)
 100 #define SATA_ERROR_OFFSET       (1)
 101 #define SATA_CONTROL_OFFSET     (2)
 102
 103 /*
 104  * Our Physical Region Descriptor (PRD) table should be large enough
 105  * to handle the biggest I/O request we are likely to see.  Since requests
 106  * can have no more than 256 sectors, and since the typical blocksize is
 107  * two or more sectors, we could get by with a limit of 128 entries here for
 108  * the usual worst case.  Most requests seem to include some contiguous blocks,
 109  * further reducing the number of table entries required.
 110  *
 111  * The driver reverts to PIO mode for individual requests that exceed
 112  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 113  * 100% of all crazy scenarios here is not necessary.
 114  *
 115  * As it turns out though, we must allocate a full 4KB page for this,
 116  * so the two PRD tables (ide0 & ide1) will each get half of that,
 117  * allowing each to have about 256 entries (8 bytes each) from this.
 118  */
 119 #define PRD_BYTES       8
 120 #define PRD_ENTRIES     256
 121
 122 /*
 123  * Some more useful definitions
 124  */
 125 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 126 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 127 #define SECTOR_SIZE     512
 128 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
 129 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
 130
 131 /*
 132  * Timeouts for various operations:
 133  */
 134 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
 135 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
 136 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
 137 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
 138 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
 139 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
 140
 141 /*
 142  * Check for an interrupt and acknowledge the interrupt status
 143  */
 144 struct hwif_s;
 145 typedef int (ide_ack_intr_t)(struct hwif_s *);
 146
 147 /*
 148  * hwif_chipset_t is used to keep track of the specific hardware
 149  * chipset used by each IDE interface, if known.
 150  */
 151 enum {          ide_unknown,    ide_generic,    ide_pci,
 152                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 153                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 154                 ide_rz1000,     ide_trm290,
 155                 ide_cmd646,     ide_cy82c693,   ide_4drives,
 156                 ide_pmac,       ide_etrax100,   ide_acorn,
 157                 ide_au1xxx,     ide_palm3710
 158 };
 159
 160 typedef u8 hwif_chipset_t;
 161
 162 /*
 163  * Structure to hold all information about the location of this port
 164  */
 165 typedef struct hw_regs_s {
 166         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
 167         int             irq;                    /* our irq number */
 168         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 169         hwif_chipset_t  chipset;
 170         struct device   *dev;
 171 } hw_regs_t;
 172
 173 void ide_init_port_data(struct hwif_s *, unsigned int);
 174 void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
 175
 176 static inline void ide_std_init_ports(hw_regs_t *hw,
 177                                       unsigned long io_addr,
 178                                       unsigned long ctl_addr)
 179 {
 180         unsigned int i;
 181
 182         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
 183                 hw->io_ports[i] = io_addr++;
 184
 185         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
 186 }
 187
 188 #include <asm/ide.h>
 189
 190 #if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
 191 #undef MAX_HWIFS
 192 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
 193 #endif
 194
 195 /* Currently only m68k, apus and m8xx need it */
 196 #ifndef IDE_ARCH_ACK_INTR
 197 # define ide_ack_intr(hwif) (1)
 198 #endif
 199
 200 /* Currently only Atari needs it */
 201 #ifndef IDE_ARCH_LOCK
 202 # define ide_release_lock()                     do {} while (0)
 203 # define ide_get_lock(hdlr, data)               do {} while (0)
 204 #endif /* IDE_ARCH_LOCK */
 205
 206 /*
 207  * Now for the data we need to maintain per-drive:  ide_drive_t
 208  */
 209
 210 #define ide_scsi        0x21
 211 #define ide_disk        0x20
 212 #define ide_optical     0x7
 213 #define ide_cdrom       0x5
 214 #define ide_tape        0x1
 215 #define ide_floppy      0x0
 216
 217 /*
 218  * Special Driver Flags
 219  *
 220  * set_geometry : respecify drive geometry
 221  * recalibrate  : seek to cyl 0
 222  * set_multmode : set multmode count
 223  * set_tune     : tune interface for drive
 224  * serviced     : service command
 225  * reserved     : unused
 226  */
 227 typedef union {
 228         unsigned all                    : 8;
 229         struct {
 230                 unsigned set_geometry   : 1;
 231                 unsigned recalibrate    : 1;
 232                 unsigned set_multmode   : 1;
 233                 unsigned set_tune       : 1;
 234                 unsigned serviced       : 1;
 235                 unsigned reserved       : 3;
 236         } b;
 237 } special_t;
 238
 239 /*
 240  * ATA-IDE Select Register, aka Device-Head
 241  *
 242  * head         : always zeros here
 243  * unit         : drive select number: 0/1
 244  * bit5         : always 1
 245  * lba          : using LBA instead of CHS
 246  * bit7         : always 1
 247  */
 248 typedef union {
 249         unsigned all                    : 8;
 250         struct {
 251 #if defined(__LITTLE_ENDIAN_BITFIELD)
 252                 unsigned head           : 4;
 253                 unsigned unit           : 1;
 254                 unsigned bit5           : 1;
 255                 unsigned lba            : 1;
 256                 unsigned bit7           : 1;
 257 #elif defined(__BIG_ENDIAN_BITFIELD)
 258                 unsigned bit7           : 1;
 259                 unsigned lba            : 1;
 260                 unsigned bit5           : 1;
 261                 unsigned unit           : 1;
 262                 unsigned head           : 4;
 263 #else
 264 #error "Please fix <asm/byteorder.h>"
 265 #endif
 266         } b;
 267 } select_t, ata_select_t;
 268
 269 /*
 270  * Status returned from various ide_ functions
 271  */
 272 typedef enum {
 273         ide_stopped,    /* no drive operation was started */
 274         ide_started,    /* a drive operation was started, handler was set */
 275 } ide_startstop_t;
 276
 277 struct ide_driver_s;
 278 struct ide_settings_s;
 279
 280 #ifdef CONFIG_BLK_DEV_IDEACPI
 281 struct ide_acpi_drive_link;
 282 struct ide_acpi_hwif_link;
 283 #endif
 284
 285 typedef struct ide_drive_s {
 286         char            name[4];        /* drive name, such as "hda" */
 287         char            driver_req[10]; /* requests specific driver */
 288
 289         struct request_queue    *queue; /* request queue */
 290
 291         struct request          *rq;    /* current request */
 292         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
 293         void            *driver_data;   /* extra driver data */
 294         struct hd_driveid       *id;    /* drive model identification info */
 295 #ifdef CONFIG_IDE_PROC_FS
 296         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 297         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
 298 #endif
 299         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 300
 301         unsigned long sleep;            /* sleep until this time */
 302         unsigned long service_start;    /* time we started last request */
 303         unsigned long service_time;     /* service time of last request */
 304         unsigned long timeout;          /* max time to wait for irq */
 305
 306         special_t       special;        /* special action flags */
 307         select_t        select;         /* basic drive/head select reg value */
 308
 309         u8      keep_settings;          /* restore settings after drive reset */
 310         u8      using_dma;              /* disk is using dma for read/write */
 311         u8      retry_pio;              /* retrying dma capable host in pio */
 312         u8      state;                  /* retry state */
 313         u8      waiting_for_dma;        /* dma currently in progress */
 314         u8      unmask;                 /* okay to unmask other irqs */
 315         u8      noflush;                /* don't attempt flushes */
 316         u8      dsc_overlap;            /* DSC overlap */
 317         u8      nice1;                  /* give potential excess bandwidth */
 318
 319         unsigned present        : 1;    /* drive is physically present */
 320         unsigned dead           : 1;    /* device ejected hint */
 321         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
 322         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 323         unsigned removable      : 1;    /* 1 if need to do check_media_change */
 324         unsigned attach         : 1;    /* needed for removable devices */
 325         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
 326         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
 327         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
 328         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
 329         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
 330         unsigned nodma          : 1;    /* disallow DMA */
 331         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
 332         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
 333         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
 334         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
 335         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
 336         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
 337         unsigned post_reset     : 1;
 338         unsigned udma33_warned  : 1;
 339
 340         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
 341         u8      quirk_list;     /* considered quirky, set for a specific host */
 342         u8      init_speed;     /* transfer rate set at boot */
 343         u8      current_speed;  /* current transfer rate set */
 344         u8      desired_speed;  /* desired transfer rate set */
 345         u8      dn;             /* now wide spread use */
 346         u8      wcache;         /* status of write cache */
 347         u8      acoustic;       /* acoustic management */
 348         u8      media;          /* disk, cdrom, tape, floppy, ... */
 349         u8      ctl;            /* "normal" value for Control register */
 350         u8      ready_stat;     /* min status value for drive ready */
 351         u8      mult_count;     /* current multiple sector setting */
 352         u8      mult_req;       /* requested multiple sector setting */
 353         u8      tune_req;       /* requested drive tuning setting */
 354         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 355         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
 356         u8      nowerr;         /* used for ignoring WRERR_STAT */
 357         u8      sect0;          /* offset of first sector for DM6:DDO */
 358         u8      head;           /* "real" number of heads */
 359         u8      sect;           /* "real" sectors per track */
 360         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 361         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 362
 363         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 364         unsigned int    cyl;            /* "real" number of cyls */
 365         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
 366         unsigned int    failures;       /* current failure count */
 367         unsigned int    max_failures;   /* maximum allowed failure count */
 368         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
 369
 370         u64             capacity64;     /* total number of sectors */
 371
 372         int             lun;            /* logical unit */
 373         int             crc_count;      /* crc counter to reduce drive speed */
 374 #ifdef CONFIG_BLK_DEV_IDEACPI
 375         struct ide_acpi_drive_link *acpidata;
 376 #endif
 377         struct list_head list;
 378         struct device   gendev;
 379         struct completion gendev_rel_comp;      /* to deal with device release() */
 380 } ide_drive_t;
 381
 382 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
 383
 384 #define IDE_CHIPSET_PCI_MASK    \
 385     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
 386 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
 387
 388 struct ide_port_info;
 389
 390 struct ide_port_ops {
 391         /* host specific initialization of devices on a port */
 392         void    (*port_init_devs)(struct hwif_s *);
 393         /* routine to program host for PIO mode */
 394         void    (*set_pio_mode)(ide_drive_t *, const u8);
 395         /* routine to program host for DMA mode */
 396         void    (*set_dma_mode)(ide_drive_t *, const u8);
 397         /* tweaks hardware to select drive */
 398         void    (*selectproc)(ide_drive_t *);
 399         /* chipset polling based on hba specifics */
 400         int     (*reset_poll)(ide_drive_t *);
 401         /* chipset specific changes to default for device-hba resets */
 402         void    (*pre_reset)(ide_drive_t *);
 403         /* routine to reset controller after a disk reset */
 404         void    (*resetproc)(ide_drive_t *);
 405         /* special host masking for drive selection */
 406         void    (*maskproc)(ide_drive_t *, int);
 407         /* check host's drive quirk list */
 408         void    (*quirkproc)(ide_drive_t *);
 409
 410         u8      (*mdma_filter)(ide_drive_t *);
 411         u8      (*udma_filter)(ide_drive_t *);
 412
 413         u8      (*cable_detect)(struct hwif_s *);
 414 };
 415
 416 typedef struct hwif_s {
 417         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
 418         struct hwif_s *mate;            /* other hwif from same PCI chip */
 419         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
 420         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 421
 422         char name[6];                   /* name of interface, eg. "ide0" */
 423
 424                 /* task file registers for pata and sata */
 425         unsigned long   io_ports[IDE_NR_PORTS];
 426         unsigned long   sata_scr[SATA_NR_PORTS];
 427
 428         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 429
 430         u8 major;       /* our major number */
 431         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 432         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 433         u8 bus_state;   /* power state of the IDE bus */
 434
 435         u32 host_flags;
 436
 437         u8 pio_mask;
 438
 439         u8 ultra_mask;
 440         u8 mwdma_mask;
 441         u8 swdma_mask;
 442
 443         u8 cbl;         /* cable type */
 444
 445         hwif_chipset_t chipset; /* sub-module for tuning.. */
 446
 447         struct device *dev;
 448
 449         ide_ack_intr_t *ack_intr;
 450
 451         void (*rw_disk)(ide_drive_t *, struct request *);
 452
 453         const struct ide_port_ops       *port_ops;
 454
 455         void (*ata_input_data)(ide_drive_t *, void *, u32);
 456         void (*ata_output_data)(ide_drive_t *, void *, u32);
 457
 458         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
 459         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
 460
 461         void (*dma_host_set)(ide_drive_t *, int);
 462         int (*dma_setup)(ide_drive_t *);
 463         void (*dma_exec_cmd)(ide_drive_t *, u8);
 464         void (*dma_start)(ide_drive_t *);
 465         int (*ide_dma_end)(ide_drive_t *drive);
 466         int (*ide_dma_test_irq)(ide_drive_t *drive);
 467         void (*ide_dma_clear_irq)(ide_drive_t *drive);
 468         void (*dma_lost_irq)(ide_drive_t *drive);
 469         void (*dma_timeout)(ide_drive_t *drive);
 470
 471         void (*OUTB)(u8 addr, unsigned long port);
 472         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
 473         void (*OUTW)(u16 addr, unsigned long port);
 474         void (*OUTSW)(unsigned long port, void *addr, u32 count);
 475         void (*OUTSL)(unsigned long port, void *addr, u32 count);
 476
 477         u8  (*INB)(unsigned long port);
 478         u16 (*INW)(unsigned long port);
 479         void (*INSW)(unsigned long port, void *addr, u32 count);
 480         void (*INSL)(unsigned long port, void *addr, u32 count);
 481
 482         /* dma physical region descriptor table (cpu view) */
 483         unsigned int    *dmatable_cpu;
 484         /* dma physical region descriptor table (dma view) */
 485         dma_addr_t      dmatable_dma;
 486         /* Scatter-gather list used to build the above */
 487         struct scatterlist *sg_table;
 488         int sg_max_nents;               /* Maximum number of entries in it */
 489         int sg_nents;                   /* Current number of entries in it */
 490         int sg_dma_direction;           /* dma transfer direction */
 491
 492         /* data phase of the active command (currently only valid for PIO/DMA) */
 493         int             data_phase;
 494
 495         unsigned int nsect;
 496         unsigned int nleft;
 497         struct scatterlist *cursg;
 498         unsigned int cursg_ofs;
 499
 500         int             rqsize;         /* max sectors per request */
 501         int             irq;            /* our irq number */
 502
 503         unsigned long   dma_base;       /* base addr for dma ports */
 504         unsigned long   dma_command;    /* dma command register */
 505         unsigned long   dma_vendor1;    /* dma vendor 1 register */
 506         unsigned long   dma_status;     /* dma status register */
 507         unsigned long   dma_vendor3;    /* dma vendor 3 register */
 508         unsigned long   dma_prdtable;   /* actual prd table address */
 509
 510         unsigned long   config_data;    /* for use by chipset-specific code */
 511         unsigned long   select_data;    /* for use by chipset-specific code */
 512
 513         unsigned long   extra_base;     /* extra addr for dma ports */
 514         unsigned        extra_ports;    /* number of extra dma ports */
 515
 516         unsigned        present    : 1; /* this interface exists */
 517         unsigned        serialized : 1; /* serialized all channel operation */
 518         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
 519         unsigned        reset      : 1; /* reset after probe */
 520         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
 521         unsigned        mmio       : 1; /* host uses MMIO */
 522
 523         struct device           gendev;
 524         struct device           *portdev;
 525
 526         struct completion gendev_rel_comp; /* To deal with device release() */
 527
 528         void            *hwif_data;     /* extra hwif data */
 529
 530         unsigned dma;
 531
 532 #ifdef CONFIG_BLK_DEV_IDEACPI
 533         struct ide_acpi_hwif_link *acpidata;
 534 #endif
 535 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 536
 537 /*
 538  *  internal ide interrupt handler type
 539  */
 540 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 541 typedef int (ide_expiry_t)(ide_drive_t *);
 542
 543 /* used by ide-cd, ide-floppy, etc. */
 544 typedef void (xfer_func_t)(ide_drive_t *, void *, u32);
 545
 546 typedef struct hwgroup_s {
 547                 /* irq handler, if active */
 548         ide_startstop_t (*handler)(ide_drive_t *);
 549
 550                 /* BOOL: protects all fields below */
 551         volatile int busy;
 552                 /* BOOL: wake us up on timer expiry */
 553         unsigned int sleeping   : 1;
 554                 /* BOOL: polling active & poll_timeout field valid */
 555         unsigned int polling    : 1;
 556                 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
 557         unsigned int resetting  : 1;
 558
 559                 /* current drive */
 560         ide_drive_t *drive;
 561                 /* ptr to current hwif in linked-list */
 562         ide_hwif_t *hwif;
 563
 564                 /* current request */
 565         struct request *rq;
 566
 567                 /* failsafe timer */
 568         struct timer_list timer;
 569                 /* timeout value during long polls */
 570         unsigned long poll_timeout;
 571                 /* queried upon timeouts */
 572         int (*expiry)(ide_drive_t *);
 573
 574         int req_gen;
 575         int req_gen_timer;
 576 } ide_hwgroup_t;
 577
 578 typedef struct ide_driver_s ide_driver_t;
 579
 580 extern struct mutex ide_setting_mtx;
 581
 582 int set_io_32bit(ide_drive_t *, int);
 583 int set_pio_mode(ide_drive_t *, int);
 584 int set_using_dma(ide_drive_t *, int);
 585
 586 /* ATAPI packet command flags */
 587 enum {
 588         /* set when an error is considered normal - no retry (ide-tape) */
 589         PC_FLAG_ABORT                   = (1 << 0),
 590         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
 591         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
 592         PC_FLAG_DMA_OK                  = (1 << 3),
 593         PC_FLAG_DMA_RECOMMENDED         = (1 << 4),
 594         PC_FLAG_DMA_IN_PROGRESS         = (1 << 5),
 595         PC_FLAG_DMA_ERROR               = (1 << 6),
 596         PC_FLAG_WRITING                 = (1 << 7),
 597         /* command timed out */
 598         PC_FLAG_TIMEDOUT                = (1 << 8),
 599 };
 600
 601 struct ide_atapi_pc {
 602         /* actual packet bytes */
 603         u8 c[12];
 604         /* incremented on each retry */
 605         int retries;
 606         int error;
 607
 608         /* bytes to transfer */
 609         int req_xfer;
 610         /* bytes actually transferred */
 611         int xferred;
 612
 613         /* data buffer */
 614         u8 *buf;
 615         /* current buffer position */
 616         u8 *cur_pos;
 617         int buf_size;
 618         /* missing/available data on the current buffer */
 619         int b_count;
 620
 621         /* the corresponding request */
 622         struct request *rq;
 623
 624         unsigned long flags;
 625
 626         /*
 627          * those are more or less driver-specific and some of them are subject
 628          * to change/removal later.
 629          */
 630         u8 pc_buf[256];
 631         void (*idefloppy_callback) (ide_drive_t *);
 632         ide_startstop_t (*idetape_callback) (ide_drive_t *);
 633
 634         /* idetape only */
 635         struct idetape_bh *bh;
 636         char *b_data;
 637
 638         /* idescsi only for now */
 639         struct scatterlist *sg;
 640         unsigned int sg_cnt;
 641
 642         struct scsi_cmnd *scsi_cmd;
 643         void (*done) (struct scsi_cmnd *);
 644
 645         unsigned long timeout;
 646 };
 647
 648 #ifdef CONFIG_IDE_PROC_FS
 649 /*
 650  * configurable drive settings
 651  */
 652
 653 #define TYPE_INT        0
 654 #define TYPE_BYTE       1
 655 #define TYPE_SHORT      2
 656
 657 #define SETTING_READ    (1 << 0)
 658 #define SETTING_WRITE   (1 << 1)
 659 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
 660
 661 typedef int (ide_procset_t)(ide_drive_t *, int);
 662 typedef struct ide_settings_s {
 663         char                    *name;
 664         int                     rw;
 665         int                     data_type;
 666         int                     min;
 667         int                     max;
 668         int                     mul_factor;
 669         int                     div_factor;
 670         void                    *data;
 671         ide_procset_t           *set;
 672         int                     auto_remove;
 673         struct ide_settings_s   *next;
 674 } ide_settings_t;
 675
 676 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
 677
 678 /*
 679  * /proc/ide interface
 680  */
 681 typedef struct {
 682         const char      *name;
 683         mode_t          mode;
 684         read_proc_t     *read_proc;
 685         write_proc_t    *write_proc;
 686 } ide_proc_entry_t;
 687
 688 void proc_ide_create(void);
 689 void proc_ide_destroy(void);
 690 void ide_proc_register_port(ide_hwif_t *);
 691 void ide_proc_port_register_devices(ide_hwif_t *);
 692 void ide_proc_unregister_device(ide_drive_t *);
 693 void ide_proc_unregister_port(ide_hwif_t *);
 694 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
 695 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
 696
 697 void ide_add_generic_settings(ide_drive_t *);
 698
 699 read_proc_t proc_ide_read_capacity;
 700 read_proc_t proc_ide_read_geometry;
 701
 702 #ifdef CONFIG_BLK_DEV_IDEPCI
 703 void ide_pci_create_host_proc(const char *, get_info_t *);
 704 #endif
 705
 706 /*
 707  * Standard exit stuff:
 708  */
 709 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 710 {                                       \
 711         len -= off;                     \
 712         if (len < count) {              \
 713                 *eof = 1;               \
 714                 if (len <= 0)           \
 715                         return 0;       \
 716         } else                          \
 717                 len = count;            \
 718         *start = page + off;            \
 719         return len;                     \
 720 }
 721 #else
 722 static inline void proc_ide_create(void) { ; }
 723 static inline void proc_ide_destroy(void) { ; }
 724 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 725 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
 726 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
 727 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 728 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 729 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 730 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
 731 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 732 #endif
 733
 734 /*
 735  * Power Management step value (rq->pm->pm_step).
 736  *
 737  * The step value starts at 0 (ide_pm_state_start_suspend) for a
 738  * suspend operation or 1000 (ide_pm_state_start_resume) for a
 739  * resume operation.
 740  *
 741  * For each step, the core calls the subdriver start_power_step() first.
 742  * This can return:
 743  *      - ide_stopped : In this case, the core calls us back again unless
 744  *                      step have been set to ide_power_state_completed.
 745  *      - ide_started : In this case, the channel is left busy until an
 746  *                      async event (interrupt) occurs.
 747  * Typically, start_power_step() will issue a taskfile request with
 748  * do_rw_taskfile().
 749  *
 750  * Upon reception of the interrupt, the core will call complete_power_step()
 751  * with the error code if any. This routine should update the step value
 752  * and return. It should not start a new request. The core will call
 753  * start_power_step for the new step value, unless step have been set to
 754  * ide_power_state_completed.
 755  *
 756  * Subdrivers are expected to define their own additional power
 757  * steps from 1..999 for suspend and from 1001..1999 for resume,
 758  * other values are reserved for future use.
 759  */
 760
 761 enum {
 762         ide_pm_state_completed          = -1,
 763         ide_pm_state_start_suspend      = 0,
 764         ide_pm_state_start_resume       = 1000,
 765 };
 766
 767 /*
 768  * Subdrivers support.
 769  *
 770  * The gendriver.owner field should be set to the module owner of this driver.
 771  * The gendriver.name field should be set to the name of this driver
 772  */
 773 struct ide_driver_s {
 774         const char                      *version;
 775         u8                              media;
 776         unsigned supports_dsc_overlap   : 1;
 777         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
 778         int             (*end_request)(ide_drive_t *, int, int);
 779         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
 780         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
 781         struct device_driver    gen_driver;
 782         int             (*probe)(ide_drive_t *);
 783         void            (*remove)(ide_drive_t *);
 784         void            (*resume)(ide_drive_t *);
 785         void            (*shutdown)(ide_drive_t *);
 786 #ifdef CONFIG_IDE_PROC_FS
 787         ide_proc_entry_t        *proc;
 788 #endif
 789 };
 790
 791 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
 792
 793 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
 794
 795 /*
 796  * ide_hwifs[] is the master data structure used to keep track
 797  * of just about everything in ide.c.  Whenever possible, routines
 798  * should be using pointers to a drive (ide_drive_t *) or
 799  * pointers to a hwif (ide_hwif_t *), rather than indexing this
 800  * structure directly (the allocation/layout may change!).
 801  *
 802  */
 803 #ifndef _IDE_C
 804 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
 805 #endif
 806 extern int noautodma;
 807
 808 ide_hwif_t *ide_find_port_slot(const struct ide_port_info *);
 809
 810 static inline ide_hwif_t *ide_find_port(void)
 811 {
 812         return ide_find_port_slot(NULL);
 813 }
 814
 815 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
 816 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
 817                              int uptodate, int nr_sectors);
 818
 819 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
 820
 821 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
 822                          ide_expiry_t *);
 823
 824 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
 825
 826 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
 827
 828 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
 829
 830 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
 831
 832 extern void ide_fix_driveid(struct hd_driveid *);
 833
 834 extern void ide_fixstring(u8 *, const int, const int);
 835
 836 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
 837
 838 extern ide_startstop_t ide_do_reset (ide_drive_t *);
 839
 840 extern void ide_init_drive_cmd (struct request *rq);
 841
 842 /*
 843  * "action" parameter type for ide_do_drive_cmd() below.
 844  */
 845 typedef enum {
 846         ide_wait,       /* insert rq at end of list, and wait for it */
 847         ide_preempt,    /* insert rq in front of current request */
 848         ide_head_wait,  /* insert rq in front of current request and wait for it */
 849         ide_end         /* insert rq at end of list, but don't wait for it */
 850 } ide_action_t;
 851
 852 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
 853
 854 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
 855
 856 enum {
 857         IDE_TFLAG_LBA48                 = (1 << 0),
 858         IDE_TFLAG_NO_SELECT_MASK        = (1 << 1),
 859         IDE_TFLAG_FLAGGED               = (1 << 2),
 860         IDE_TFLAG_OUT_DATA              = (1 << 3),
 861         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
 862         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
 863         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
 864         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
 865         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
 866         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
 867                                           IDE_TFLAG_OUT_HOB_NSECT |
 868                                           IDE_TFLAG_OUT_HOB_LBAL |
 869                                           IDE_TFLAG_OUT_HOB_LBAM |
 870                                           IDE_TFLAG_OUT_HOB_LBAH,
 871         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
 872         IDE_TFLAG_OUT_NSECT             = (1 << 10),
 873         IDE_TFLAG_OUT_LBAL              = (1 << 11),
 874         IDE_TFLAG_OUT_LBAM              = (1 << 12),
 875         IDE_TFLAG_OUT_LBAH              = (1 << 13),
 876         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
 877                                           IDE_TFLAG_OUT_NSECT |
 878                                           IDE_TFLAG_OUT_LBAL |
 879                                           IDE_TFLAG_OUT_LBAM |
 880                                           IDE_TFLAG_OUT_LBAH,
 881         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
 882         IDE_TFLAG_WRITE                 = (1 << 15),
 883         IDE_TFLAG_FLAGGED_SET_IN_FLAGS  = (1 << 16),
 884         IDE_TFLAG_IN_DATA               = (1 << 17),
 885         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 18),
 886         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 19),
 887         IDE_TFLAG_IN_HOB_FEATURE        = (1 << 20),
 888         IDE_TFLAG_IN_HOB_NSECT          = (1 << 21),
 889         IDE_TFLAG_IN_HOB_LBAL           = (1 << 22),
 890         IDE_TFLAG_IN_HOB_LBAM           = (1 << 23),
 891         IDE_TFLAG_IN_HOB_LBAH           = (1 << 24),
 892         IDE_TFLAG_IN_HOB_LBA            = IDE_TFLAG_IN_HOB_LBAL |
 893                                           IDE_TFLAG_IN_HOB_LBAM |
 894                                           IDE_TFLAG_IN_HOB_LBAH,
 895         IDE_TFLAG_IN_HOB                = IDE_TFLAG_IN_HOB_FEATURE |
 896                                           IDE_TFLAG_IN_HOB_NSECT |
 897                                           IDE_TFLAG_IN_HOB_LBA,
 898         IDE_TFLAG_IN_NSECT              = (1 << 25),
 899         IDE_TFLAG_IN_LBAL               = (1 << 26),
 900         IDE_TFLAG_IN_LBAM               = (1 << 27),
 901         IDE_TFLAG_IN_LBAH               = (1 << 28),
 902         IDE_TFLAG_IN_LBA                = IDE_TFLAG_IN_LBAL |
 903                                           IDE_TFLAG_IN_LBAM |
 904                                           IDE_TFLAG_IN_LBAH,
 905         IDE_TFLAG_IN_TF                 = IDE_TFLAG_IN_NSECT |
 906                                           IDE_TFLAG_IN_LBA,
 907         IDE_TFLAG_IN_DEVICE             = (1 << 29),
 908         IDE_TFLAG_HOB                   = IDE_TFLAG_OUT_HOB |
 909                                           IDE_TFLAG_IN_HOB,
 910         IDE_TFLAG_TF                    = IDE_TFLAG_OUT_TF |
 911                                           IDE_TFLAG_IN_TF,
 912         IDE_TFLAG_DEVICE                = IDE_TFLAG_OUT_DEVICE |
 913                                           IDE_TFLAG_IN_DEVICE,
 914         /* force 16-bit I/O operations */
 915         IDE_TFLAG_IO_16BIT              = (1 << 30),
 916         /* ide_task_t was allocated using kmalloc() */
 917         IDE_TFLAG_DYN                   = (1 << 31),
 918 };
 919
 920 struct ide_taskfile {
 921         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
 922
 923         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
 924         u8      hob_nsect;
 925         u8      hob_lbal;
 926         u8      hob_lbam;
 927         u8      hob_lbah;
 928
 929         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
 930
 931         union {                 /*  7: */
 932                 u8 error;       /*   read:  error */
 933                 u8 feature;     /*  write: feature */
 934         };
 935
 936         u8      nsect;          /*  8: number of sectors */
 937         u8      lbal;           /*  9: LBA low */
 938         u8      lbam;           /* 10: LBA mid */
 939         u8      lbah;           /* 11: LBA high */
 940
 941         u8      device;         /* 12: device select */
 942
 943         union {                 /* 13: */
 944                 u8 status;      /*  read: status  */
 945                 u8 command;     /* write: command */
 946         };
 947 };
 948
 949 typedef struct ide_task_s {
 950         union {
 951                 struct ide_taskfile     tf;
 952                 u8                      tf_array[14];
 953         };
 954         u32                     tf_flags;
 955         int                     data_phase;
 956         struct request          *rq;            /* copy of request */
 957         void                    *special;       /* valid_t generally */
 958 } ide_task_t;
 959
 960 void ide_tf_load(ide_drive_t *, ide_task_t *);
 961 void ide_tf_read(ide_drive_t *, ide_task_t *);
 962
 963 extern void SELECT_DRIVE(ide_drive_t *);
 964 extern void SELECT_MASK(ide_drive_t *, int);
 965
 966 extern int drive_is_ready(ide_drive_t *);
 967
 968 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
 969
 970 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
 971
 972 void task_end_request(ide_drive_t *, struct request *, u8);
 973
 974 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
 975 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
 976
 977 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
 978 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
 979 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
 980
 981 extern int system_bus_clock(void);
 982
 983 extern int ide_driveid_update(ide_drive_t *);
 984 extern int ide_config_drive_speed(ide_drive_t *, u8);
 985 extern u8 eighty_ninty_three (ide_drive_t *);
 986 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
 987
 988 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
 989
 990 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
 991
 992 extern int ide_spin_wait_hwgroup(ide_drive_t *);
 993 extern void ide_timer_expiry(unsigned long);
 994 extern irqreturn_t ide_intr(int irq, void *dev_id);
 995 extern void do_ide_request(struct request_queue *);
 996
 997 void ide_init_disk(struct gendisk *, ide_drive_t *);
 998
 999 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1000 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1001 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1002 #else
1003 #define ide_pci_register_driver(d) pci_register_driver(d)
1004 #endif
1005
1006 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
1007 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1008
1009 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1010 int ide_pci_set_master(struct pci_dev *, const char *);
1011 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1012 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1013 #else
1014 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1015                                      const struct ide_port_info *d)
1016 {
1017         return -EINVAL;
1018 }
1019 #endif
1020
1021 extern void default_hwif_iops(ide_hwif_t *);
1022 extern void default_hwif_mmiops(ide_hwif_t *);
1023 extern void default_hwif_transport(ide_hwif_t *);
1024
1025 typedef struct ide_pci_enablebit_s {
1026         u8      reg;    /* byte pci reg holding the enable-bit */
1027         u8      mask;   /* mask to isolate the enable-bit */
1028         u8      val;    /* value of masked reg when "enabled" */
1029 } ide_pci_enablebit_t;
1030
1031 enum {
1032         /* Uses ISA control ports not PCI ones. */
1033         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1034         /* single port device */
1035         IDE_HFLAG_SINGLE                = (1 << 1),
1036         /* don't use legacy PIO blacklist */
1037         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1038         /* set for the second port of QD65xx */
1039         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1040         /* use PIO8/9 for prefetch off/on */
1041         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1042         /* use PIO6/7 for fast-devsel off/on */
1043         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1044         /* use 100-102 and 200-202 PIO values to set DMA modes */
1045         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1046         /*
1047          * keep DMA setting when programming PIO mode, may be used only
1048          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1049          */
1050         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1051         /* program host for the transfer mode after programming device */
1052         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1053         /* don't program host/device for the transfer mode ("smart" hosts) */
1054         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1055         /* trust BIOS for programming chipset/device for DMA */
1056         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1057         /* host uses VDMA (tied with IDE_HFLAG_CS5520 for now) */
1058         IDE_HFLAG_VDMA                  = (1 << 11),
1059         /* ATAPI DMA is unsupported */
1060         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1061         /* set if host is a "non-bootable" controller */
1062         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1063         /* host doesn't support DMA */
1064         IDE_HFLAG_NO_DMA                = (1 << 14),
1065         /* check if host is PCI IDE device before allowing DMA */
1066         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1067         /* don't autotune PIO */
1068         IDE_HFLAG_NO_AUTOTUNE           = (1 << 16),
1069         /* host is CS5510/CS5520 */
1070         IDE_HFLAG_CS5520                = IDE_HFLAG_VDMA,
1071         /* no LBA48 */
1072         IDE_HFLAG_NO_LBA48              = (1 << 17),
1073         /* no LBA48 DMA */
1074         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1075         /* data FIFO is cleared by an error */
1076         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1077         /* serialize ports */
1078         IDE_HFLAG_SERIALIZE             = (1 << 20),
1079         /* use legacy IRQs */
1080         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1081         /* force use of legacy IRQs */
1082         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1083         /* limit LBA48 requests to 256 sectors */
1084         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1085         /* use 32-bit I/O ops */
1086         IDE_HFLAG_IO_32BIT              = (1 << 24),
1087         /* unmask IRQs */
1088         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1089         IDE_HFLAG_ABUSE_SET_DMA_MODE    = (1 << 26),
1090         /* serialize ports if DMA is possible (for sl82c105) */
1091         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1092         /* force host out of "simplex" mode */
1093         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1094         /* DSC overlap is unsupported */
1095         IDE_HFLAG_NO_DSC                = (1 << 29),
1096         /* never use 32-bit I/O ops */
1097         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1098         /* never unmask IRQs */
1099         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1100 };
1101
1102 #ifdef CONFIG_BLK_DEV_OFFBOARD
1103 # define IDE_HFLAG_OFF_BOARD    0
1104 #else
1105 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1106 #endif
1107
1108 struct ide_port_info {
1109         char                    *name;
1110         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1111         void                    (*init_iops)(ide_hwif_t *);
1112         void                    (*init_hwif)(ide_hwif_t *);
1113         int                     (*init_dma)(ide_hwif_t *,
1114                                             const struct ide_port_info *);
1115
1116         const struct ide_port_ops       *port_ops;
1117
1118         ide_pci_enablebit_t     enablebits[2];
1119         hwif_chipset_t          chipset;
1120         u32                     host_flags;
1121         u8                      pio_mask;
1122         u8                      swdma_mask;
1123         u8                      mwdma_mask;
1124         u8                      udma_mask;
1125 };
1126
1127 int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1128 int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1129
1130 void ide_map_sg(ide_drive_t *, struct request *);
1131 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1132
1133 #define BAD_DMA_DRIVE           0
1134 #define GOOD_DMA_DRIVE          1
1135
1136 struct drive_list_entry {
1137         const char *id_model;
1138         const char *id_firmware;
1139 };
1140
1141 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1142
1143 #ifdef CONFIG_BLK_DEV_IDEDMA
1144 int __ide_dma_bad_drive(ide_drive_t *);
1145 int ide_id_dma_bug(ide_drive_t *);
1146
1147 u8 ide_find_dma_mode(ide_drive_t *, u8);
1148
1149 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1150 {
1151         return ide_find_dma_mode(drive, XFER_UDMA_6);
1152 }
1153
1154 void ide_dma_off_quietly(ide_drive_t *);
1155 void ide_dma_off(ide_drive_t *);
1156 void ide_dma_on(ide_drive_t *);
1157 int ide_set_dma(ide_drive_t *);
1158 void ide_check_dma_crc(ide_drive_t *);
1159 ide_startstop_t ide_dma_intr(ide_drive_t *);
1160
1161 int ide_build_sglist(ide_drive_t *, struct request *);
1162 void ide_destroy_dmatable(ide_drive_t *);
1163
1164 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1165 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1166 int ide_allocate_dma_engine(ide_hwif_t *);
1167 void ide_release_dma_engine(ide_hwif_t *);
1168 extern void ide_setup_dma(ide_hwif_t *, unsigned long);
1169
1170 void ide_dma_host_set(ide_drive_t *, int);
1171 extern int ide_dma_setup(ide_drive_t *);
1172 extern void ide_dma_start(ide_drive_t *);
1173 extern int __ide_dma_end(ide_drive_t *);
1174 extern void ide_dma_lost_irq(ide_drive_t *);
1175 extern void ide_dma_timeout(ide_drive_t *);
1176 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1177
1178 #else
1179 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1180 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1181 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1182 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1183 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1184 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1185 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1186 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1187 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1188 #endif /* CONFIG_BLK_DEV_IDEDMA */
1189
1190 #ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1191 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1192 #endif
1193
1194 #ifdef CONFIG_BLK_DEV_IDEACPI
1195 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1196 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1197 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1198 extern void ide_acpi_init(ide_hwif_t *hwif);
1199 void ide_acpi_port_init_devices(ide_hwif_t *);
1200 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1201 #else
1202 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1203 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1204 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1205 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1206 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1207 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1208 #endif
1209
1210 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1211 void ide_unregister(unsigned int);
1212
1213 void ide_register_region(struct gendisk *);
1214 void ide_unregister_region(struct gendisk *);
1215
1216 void ide_undecoded_slave(ide_drive_t *);
1217
1218 int ide_device_add_all(u8 *idx, const struct ide_port_info *);
1219 int ide_device_add(u8 idx[4], const struct ide_port_info *);
1220 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1221 void ide_port_unregister_devices(ide_hwif_t *);
1222 void ide_port_scan(ide_hwif_t *);
1223
1224 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1225 {
1226         return hwif->hwif_data;
1227 }
1228
1229 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1230 {
1231         hwif->hwif_data = data;
1232 }
1233
1234 const char *ide_xfer_verbose(u8 mode);
1235 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1236 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1237
1238 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1239 {
1240         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1241 }
1242
1243 static inline int ide_dev_is_sata(struct hd_driveid *id)
1244 {
1245         /*
1246          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1247          * verifying that word 80 by casting it to a signed type --
1248          * this trick allows us to filter out the reserved values of
1249          * 0x0000 and 0xffff along with the earlier ATA revisions...
1250          */
1251         if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1252                 return 1;
1253         return 0;
1254 }
1255
1256 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1257 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1258
1259 typedef struct ide_pio_timings_s {
1260         int     setup_time;     /* Address setup (ns) minimum */
1261         int     active_time;    /* Active pulse (ns) minimum */
1262         int     cycle_time;     /* Cycle time (ns) minimum = */
1263                                 /* active + recovery (+ setup for some chips) */
1264 } ide_pio_timings_t;
1265
1266 unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1267 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1268 extern const ide_pio_timings_t ide_pio_timings[6];
1269
1270 int ide_set_pio_mode(ide_drive_t *, u8);
1271 int ide_set_dma_mode(ide_drive_t *, u8);
1272
1273 void ide_set_pio(ide_drive_t *, u8);
1274
1275 static inline void ide_set_max_pio(ide_drive_t *drive)
1276 {
1277         ide_set_pio(drive, 255);
1278 }
1279
1280 extern spinlock_t ide_lock;
1281 extern struct mutex ide_cfg_mtx;
1282 /*
1283  * Structure locking:
1284  *
1285  * ide_cfg_mtx and ide_lock together protect changes to
1286  * ide_hwif_t->{next,hwgroup}
1287  * ide_drive_t->next
1288  *
1289  * ide_hwgroup_t->busy: ide_lock
1290  * ide_hwgroup_t->hwif: ide_lock
1291  * ide_hwif_t->mate: constant, no locking
1292  * ide_drive_t->hwif: constant, no locking
1293  */
1294
1295 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1296
1297 extern struct bus_type ide_bus_type;
1298 extern struct class *ide_port_class;
1299
1300 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1301 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1302
1303 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1304 #define ide_id_has_flush_cache_ext(id)  \
1305         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1306
1307 static inline void ide_dump_identify(u8 *id)
1308 {
1309         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1310 }
1311
1312 static inline int hwif_to_node(ide_hwif_t *hwif)
1313 {
1314         struct pci_dev *dev = to_pci_dev(hwif->dev);
1315         return hwif->dev ? pcibus_to_node(dev->bus) : -1;
1316 }
1317
1318 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1319 {
1320         ide_hwif_t *hwif        = HWIF(drive);
1321
1322         return &hwif->drives[(drive->dn ^ 1) & 1];
1323 }
1324
1325 static inline void ide_set_irq(ide_drive_t *drive, int on)
1326 {
1327         ide_hwif_t *hwif = drive->hwif;
1328
1329         hwif->OUTB(drive->ctl | (on ? 0 : 2),
1330                    hwif->io_ports[IDE_CONTROL_OFFSET]);
1331 }
1332
1333 static inline u8 ide_read_status(ide_drive_t *drive)
1334 {
1335         ide_hwif_t *hwif = drive->hwif;
1336
1337         return hwif->INB(hwif->io_ports[IDE_STATUS_OFFSET]);
1338 }
1339
1340 static inline u8 ide_read_altstatus(ide_drive_t *drive)
1341 {
1342         ide_hwif_t *hwif = drive->hwif;
1343
1344         return hwif->INB(hwif->io_ports[IDE_CONTROL_OFFSET]);
1345 }
1346
1347 static inline u8 ide_read_error(ide_drive_t *drive)
1348 {
1349         ide_hwif_t *hwif = drive->hwif;
1350
1351         return hwif->INB(hwif->io_ports[IDE_ERROR_OFFSET]);
1352 }
1353
1354 /*
1355  * Too bad. The drive wants to send us data which we are not ready to accept.
1356  * Just throw it away.
1357  */
1358 static inline void ide_atapi_discard_data(ide_drive_t *drive, unsigned bcount)
1359 {
1360         ide_hwif_t *hwif = drive->hwif;
1361
1362         /* FIXME: use ->atapi_input_bytes */
1363         while (bcount--)
1364                 (void)hwif->INB(hwif->io_ports[IDE_DATA_OFFSET]);
1365 }
1366
1367 static inline void ide_atapi_write_zeros(ide_drive_t *drive, unsigned bcount)
1368 {
1369         ide_hwif_t *hwif = drive->hwif;
1370
1371         /* FIXME: use ->atapi_output_bytes */
1372         while (bcount--)
1373                 hwif->OUTB(0, hwif->io_ports[IDE_DATA_OFFSET]);
1374 }
1375
1376 #endif /* _IDE_H */