root/drivers/block/ide.h

/* [previous][next][first][last][top][bottom][index][help] */

INCLUDED FROM


   1 /*
   2  *  linux/drivers/block/ide.h
   3  *
   4  *  Copyright (C) 1994, 1995  Linus Torvalds & authors
   5  */
   6 
   7 #include <linux/config.h>
   8 
   9 /*
  10  * This is the multiple IDE interface driver, as evolved from hd.c.  
  11  * It supports up to four IDE interfaces, on one or more IRQs (usually 14 & 15).
  12  * There can be up to two drives per interface, as per the ATA-2 spec.
  13  *
  14  * Primary i/f:    ide0: major=3;  (hda)         minor=0; (hdb)         minor=64
  15  * Secondary i/f:  ide1: major=22; (hdc or hd1a) minor=0; (hdd or hd1b) minor=64
  16  * Tertiary i/f:   ide2: major=33; (hde)         minor=0; (hdf)         minor=64
  17  * Quaternary i/f: ide3: major=34; (hdg)         minor=0; (hdh)         minor=64
  18  */
  19 
  20 /******************************************************************************
  21  * IDE driver configuration options (play with these as desired):
  22  * 
  23  * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
  24  */
  25 #undef REALLY_FAST_IO                   /* define if ide ports are perfect */
  26 #define INITIAL_MULT_COUNT      0       /* off=0; on=2,4,8,16,32, etc.. */
  27 
  28 #ifndef DISK_RECOVERY_TIME              /* off=0; on=access_delay_time */
  29 #define DISK_RECOVERY_TIME      0       /*  for hardware that needs it */
  30 #endif
  31 #ifndef OK_TO_RESET_CONTROLLER          /* 1 needed for good error recovery */
  32 #define OK_TO_RESET_CONTROLLER  1       /* 0 for use with AH2372A/B interface */
  33 #endif
  34 #ifndef FAKE_FDISK_FOR_EZDRIVE          /* 1 to help linux fdisk with EZDRIVE */
  35 #define FAKE_FDISK_FOR_EZDRIVE  1       /* 0 to reduce kernel size */
  36 #endif
  37 #ifndef SUPPORT_RZ1000                  /* 1 to support RZ1000 chipset */
  38 #define SUPPORT_RZ1000          1       /* 0 to reduce kernel size */
  39 #endif
  40 #ifndef SUPPORT_CMD640                  /* 1 to support CMD640 chipset */
  41 #define SUPPORT_CMD640          1       /* 0 to reduce kernel size */
  42 #endif
  43 #ifndef SUPPORT_HT6560B                 /* 1 to support HT6560B chipset */
  44 #define SUPPORT_HT6560B         1       /* 0 to reduce kernel size */
  45 #endif
  46 #ifndef SUPPORT_QD6580                  /* 1 to support QD6580 chipset */
  47 #define SUPPORT_QD6580          1       /* 0 to reduce kernel size */
  48 #endif
  49 #ifndef SUPPORT_DTC2278                 /* 1 to support DTC2278 chipset */
  50 #define SUPPORT_DTC2278         1       /* 0 to reduce kernel size */
  51 #ifndef SET_DTC2278_MODE4
  52 #define SET_DTC2278_MODE4       0       /* 1 to init primary i/f for PIO mode4 */
  53 #endif
  54 #endif
  55 #ifndef FANCY_STATUS_DUMPS              /* 1 for human-readable drive errors */
  56 #define FANCY_STATUS_DUMPS      1       /* 0 to reduce kernel size */
  57 #endif
  58 
  59 /*
  60  * IDE_DRIVE_CMD is used to implement many features of the hdparm utility
  61  */
  62 #define IDE_DRIVE_CMD           99      /* (magic) undef to reduce kernel size*/
  63 
  64 /*
  65  *  "No user-serviceable parts" beyond this point  :)
  66  *****************************************************************************/
  67 
  68 typedef unsigned char   byte;   /* used everywhere */
  69 
  70 /*
  71  * Probably not wise to fiddle with these
  72  */
  73 #define ERROR_MAX       8       /* Max read/write errors per sector */
  74 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  75 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  76 
  77 /*
  78  * Ensure that various configuration flags have compatible settings
  79  */
  80 #ifdef REALLY_SLOW_IO
  81 #undef REALLY_FAST_IO
  82 #endif
  83 
  84 /*
  85  * Definitions for accessing IDE controller registers
  86  */
  87 
  88 #define HWIF(drive)             ((ide_hwif_t *)drive->hwif)
  89 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  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_FEATURE_OFFSET      IDE_ERROR_OFFSET
 100 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
 101 
 102 #define IDE_DATA_REG            (HWIF(drive)->io_base+IDE_DATA_OFFSET)
 103 #define IDE_ERROR_REG           (HWIF(drive)->io_base+IDE_ERROR_OFFSET)
 104 #define IDE_NSECTOR_REG         (HWIF(drive)->io_base+IDE_NSECTOR_OFFSET)
 105 #define IDE_SECTOR_REG          (HWIF(drive)->io_base+IDE_SECTOR_OFFSET)
 106 #define IDE_LCYL_REG            (HWIF(drive)->io_base+IDE_LCYL_OFFSET)
 107 #define IDE_HCYL_REG            (HWIF(drive)->io_base+IDE_HCYL_OFFSET)
 108 #define IDE_SELECT_REG          (HWIF(drive)->io_base+IDE_SELECT_OFFSET)
 109 #define IDE_STATUS_REG          (HWIF(drive)->io_base+IDE_STATUS_OFFSET)
 110 #define IDE_CONTROL_REG         (HWIF(drive)->ctl_port)
 111 #define IDE_FEATURE_REG         IDE_ERROR_REG
 112 #define IDE_COMMAND_REG         IDE_STATUS_REG
 113 #define IDE_ALTSTATUS_REG       IDE_CONTROL_REG
 114 
 115 #ifdef REALLY_FAST_IO
 116 #define OUT_BYTE(b,p)           outb((b),p)
 117 #define IN_BYTE(p)              (byte)inb(p)
 118 #else
 119 #define OUT_BYTE(b,p)           outb_p((b),p)
 120 #define IN_BYTE(p)              (byte)inb_p(p)
 121 #endif /* REALLY_FAST_IO */
 122 
 123 #define GET_ERR()               IN_BYTE(IDE_ERROR_REG)
 124 #define GET_STAT()              IN_BYTE(IDE_STATUS_REG)
 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              (DRIVE_READY | DRQ_STAT)
 131 
 132 /*
 133  * Some more useful definitions
 134  */
 135 #define IDE_MAJOR_NAME  "ide"   /* the same for all i/f; see also genhd.c */
 136 #define MAJOR_NAME      IDE_MAJOR_NAME
 137 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 138 #define PARTN_MASK      ((1<<PARTN_BITS)-1)     /* a useful bit mask */
 139 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 140 #define MAX_HWIFS       4       /* an arbitrary, but realistic limit */
 141 #define SECTOR_WORDS    (512 / 4)       /* number of 32bit words per sector */
 142 
 143 /*
 144  * Timeouts for various operations:
 145  */
 146 #define WAIT_DRQ        (5*HZ/100)      /* 50msec - spec allows up to 20ms */
 147 #define WAIT_READY      (3*HZ/100)      /* 30msec - should be instantaneous */
 148 #define WAIT_PIDENTIFY  (1*HZ)  /* 1sec   - should be less than 3ms (?) */
 149 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
 150 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
 151 
 152 #ifdef CONFIG_BLK_DEV_IDECD
 153 
 154 struct atapi_request_sense {
 155   unsigned char error_code : 7;
 156   unsigned char valid      : 1;
 157   byte reserved1;
 158   unsigned char sense_key  : 4;
 159   unsigned char reserved2  : 1;
 160   unsigned char ili        : 1;
 161   unsigned char reserved3  : 2;
 162   byte info[4];
 163   byte sense_len;
 164   byte command_info[4];
 165   byte asc;
 166   byte ascq;
 167   byte fru;
 168   byte sense_key_specific[3];
 169 };
 170 
 171 struct packet_command {
 172   char *buffer;
 173   int buflen;
 174   int stat;
 175   struct atapi_request_sense *sense_data;
 176   unsigned char c[12];
 177 };
 178 
 179 /* Space to hold the disk TOC. */
 180 
 181 #define MAX_TRACKS 99
 182 struct atapi_toc_header {
 183   unsigned short toc_length;
 184   byte first_track;
 185   byte last_track;
 186 };
 187 
 188 struct atapi_toc_entry {
 189   byte reserved1;
 190   unsigned control : 4;
 191   unsigned adr     : 4;
 192   byte track;
 193   byte reserved2;
 194   unsigned lba;
 195 };
 196 
 197 struct atapi_toc {
 198   int    last_session_lba;
 199   int    xa_flag;
 200   unsigned capacity;
 201   struct atapi_toc_header hdr;
 202   struct atapi_toc_entry  ent[MAX_TRACKS+1];  /* One extra for the leadout. */
 203 };
 204 
 205 /* Extra per-device info for cdrom drives. */
 206 struct cdrom_info {
 207 
 208   /* Buffer for table of contents.  NULL if we haven't allocated
 209      a TOC buffer for this device yet. */
 210 
 211   struct atapi_toc *toc;
 212 
 213   /* Sector buffer.  If a read request wants only the first part of a cdrom
 214      block, we cache the rest of the block here, in the expectation that that
 215      data is going to be wanted soon.  SECTOR_BUFFERED is the number of the
 216      first buffered sector, and NSECTORS_BUFFERED is the number of sectors
 217      in the buffer.  Before the buffer is allocated, we should have
 218      SECTOR_BUFFER == NULL and NSECTORS_BUFFERED == 0. */
 219 
 220   unsigned long sector_buffered;
 221   unsigned long nsectors_buffered;
 222   char *sector_buffer;
 223 
 224   /* The result of the last successful request sense command
 225      on this device. */
 226   struct atapi_request_sense sense_data;
 227 };
 228 
 229 #endif /* CONFIG_BLK_DEV_IDECD */
 230 
 231 /*
 232  * Now for the data we need to maintain per-drive:  ide_drive_t
 233  */
 234 typedef enum {disk, cdrom} media_t;
 235 
 236 typedef union {
 237         unsigned all                    : 8;    /* all of the bits together */
 238         struct {
 239                 unsigned set_geometry   : 1;    /* respecify drive geometry */
 240                 unsigned recalibrate    : 1;    /* seek to cyl 0      */
 241                 unsigned set_multmode   : 1;    /* set multmode count */
 242                 unsigned reserved       : 5;    /* unused */
 243                 } b;
 244         } special_t;
 245 
 246 typedef union {
 247         unsigned all                    : 8;    /* all of the bits together */
 248         struct {
 249                 unsigned head           : 4;    /* always zeros here */
 250                 unsigned unit           : 1;    /* drive select number, 0 or 1 */
 251                 unsigned bit5           : 1;    /* always 1 */
 252                 unsigned lba            : 1;    /* using LBA instead of CHS */
 253                 unsigned bit7           : 1;    /* always 1 */
 254         } b;
 255         } select_t;
 256 
 257 typedef struct ide_drive_s {
 258         special_t       special;        /* special action flags */
 259 #if FAKE_FDISK_FOR_EZDRIVE
 260         unsigned ezdrive        : 1;    /* flag: partitioned with ezdrive */
 261 #endif /* FAKE_FDISK_FOR_EZDRIVE */
 262         unsigned present        : 1;    /* drive is physically present */
 263         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 264         unsigned keep_settings  : 1;    /* restore settings after drive reset */
 265         unsigned busy           : 1;    /* currently doing revalidate_disk() */
 266         unsigned vlb_32bit      : 1;    /* use 32bit in/out for data */
 267         unsigned vlb_sync       : 1;    /* needed for some 32bit chip sets */
 268         unsigned removeable     : 1;    /* 1 if need to do check_media_change */
 269         unsigned using_dma      : 1;    /* disk is using dma for read/write */
 270         unsigned unmask         : 1;    /* flag: okay to unmask other irqs */
 271         media_t         media;          /* disk, cdrom, tape */
 272         select_t        select;         /* basic drive/head select reg value */
 273         void            *hwif;          /* actually (ide_hwif_t *) */
 274         byte            ctl;            /* "normal" value for IDE_CONTROL_REG */
 275         byte            ready_stat;     /* min status value for drive ready */
 276         byte            mult_count;     /* current multiple sector setting */
 277         byte            mult_req;       /* requested multiple sector setting */
 278         byte            chipset;        /* interface chipset access method */
 279         byte            bad_wstat;      /* used for ignoring WRERR_STAT */
 280         byte            sect0;          /* offset of first sector for DM6:DDO */
 281         byte            usage;          /* current "open()" count for drive */
 282         byte            head;           /* "real" number of heads */
 283         byte            sect;           /* "real" sectors per track */
 284         byte            bios_head;      /* BIOS/fdisk/LILO number of heads */
 285         byte            bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 286         unsigned short  bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 287         unsigned short  cyl;            /* "real" number of cyls */
 288         struct wait_queue *wqueue;      /* used to wait for drive in open() */
 289         struct hd_driveid *id;          /* drive model identification info */
 290         struct hd_struct  *part;        /* drive partition table */
 291         char            name[4];        /* drive name, such as "hda" */
 292 #ifdef CONFIG_BLK_DEV_IDECD
 293         struct cdrom_info cdrom_info;   /* from ide-cd.c */
 294 #endif /* CONFIG_BLK_DEV_IDECD */
 295         } ide_drive_t;
 296 
 297 /*
 298  * An ide_dmaproc_t() initiates/aborts DMA read/write operations on a drive.
 299  *
 300  * The caller is assumed to have selected the drive and programmed the drive's
 301  * sector address using CHS or LBA.  All that remains is to prepare for DMA
 302  * and then issue the actual read/write DMA/PIO command to the drive.
 303  *
 304  * Returns 0 if all went well.
 305  * Returns 1 if DMA read/write could not be started, in which case the caller
 306  * should either try again later, or revert to PIO for the current request.
 307  */
 308 typedef enum {ide_dma_read = 0, ide_dma_write = 1, ide_dma_abort = 2, ide_dma_check = 3} ide_dma_action_t;
 309 typedef int (ide_dmaproc_t)(ide_dma_action_t, ide_drive_t *);
 310 
 311 typedef struct hwif_s {
 312         struct hwif_s   *next;          /* for linked-list in ide_hwgroup_t */
 313         void            *hwgroup;       /* actually (ide_hwgroup_t *) */
 314         unsigned short  io_base;        /* base io port addr */
 315         unsigned short  ctl_port;       /* usually io_base+0x206 */
 316         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 317         struct gendisk  *gd;            /* gendisk structure */
 318         ide_dmaproc_t   *dmaproc;       /* dma read/write/abort routine */
 319         unsigned long   *dmatable;      /* dma physical region descriptor table */
 320         unsigned short  dma_base;       /* base addr for dma ports (triton) */
 321         byte            irq;            /* our irq number */
 322         byte            major;          /* our major number */
 323         byte            select;         /* pri/sec hwif select for ht6560b */
 324         char            name[5];        /* name of interface, eg. "ide0" */
 325         unsigned        noprobe : 1;    /* don't probe for this interface */
 326         unsigned        present : 1;    /* this interface exists */
 327 #if (DISK_RECOVERY_TIME > 0)
 328         unsigned long   last_time;      /* time when previous rq was done */
 329 #endif
 330 #ifdef CONFIG_BLK_DEV_IDECD
 331         struct request request_sense_request;   /* from ide-cd.c */
 332         struct packet_command request_sense_pc; /* from ide-cd.c */
 333 #endif /* CONFIG_BLK_DEV_IDECD */
 334         } ide_hwif_t;
 335 
 336 /*
 337  *  internal ide interrupt handler type
 338  */
 339 typedef void (ide_handler_t)(ide_drive_t *);
 340 
 341 typedef struct hwgroup_s {
 342         ide_handler_t           *handler;/* irq handler, if active */
 343         ide_drive_t             *drive; /* current drive */
 344         ide_hwif_t              *hwif;  /* ptr to current hwif in linked-list */
 345         struct request          *rq;    /* current request */
 346         struct timer_list       timer;  /* failsafe timer */
 347         struct request          wrq;    /* local copy of current write rq */
 348         unsigned long   reset_timeout;  /* timeout value during ide resets */
 349 #ifdef CONFIG_BLK_DEV_IDECD
 350         int                     doing_atapi_reset;
 351 #endif /* CONFIG_BLK_DEV_IDECD */
 352         } ide_hwgroup_t;
 353 
 354 /*
 355  * One final include file, which references some of the data/defns from above
 356  */
 357 #define IDE_DRIVER      /* "parameter" for blk.h */
 358 #include <linux/blk.h>
 359 
 360 #if (DISK_RECOVERY_TIME > 0)
 361 void ide_set_recovery_timer (ide_hwif_t *);
 362 #define SET_RECOVERY_TIMER(drive) ide_set_recovery_timer (drive)
 363 #else
 364 #define SET_RECOVERY_TIMER(drive)
 365 #endif
 366 
 367 /*
 368  * The main (re-)entry point for handling a new request is IDE_DO_REQUEST.
 369  * Note that IDE_DO_REQUEST should *only* ever be invoked from an interrupt
 370  * handler.  All others, such as a timer expiry handler, should call
 371  * do_hwgroup_request() instead (currently local to ide.c).
 372  */
 373 void ide_do_request (ide_hwgroup_t *);
 374 #define IDE_DO_REQUEST { SET_RECOVERY_TIMER(HWIF(drive)); ide_do_request(HWGROUP(drive)); }
 375 
 376 
 377 /*
 378  * This is used for (nearly) all data transfers from the IDE interface
 379  */
 380 void ide_input_data (ide_drive_t *drive, void *buffer, unsigned int wcount);
 381 
 382 /*
 383  * This is used for (nearly) all data transfers to the IDE interface
 384  */
 385 void ide_output_data (ide_drive_t *drive, void *buffer, unsigned int wcount);
 386 
 387 /*
 388  * This is used on exit from the driver, to designate the next irq handler
 389  * and also to start the safety timer.
 390  */
 391 void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler);
 392 
 393 /*
 394  * Error reporting, in human readable form (luxurious, but a memory hog).
 395  */
 396 byte ide_dump_status (ide_drive_t *drive, const char *msg, byte stat);
 397 
 398 /*
 399  * ide_error() takes action based on the error returned by the controller.
 400  *
 401  * Returns 1 if an ide reset operation has been initiated, in which case
 402  * the caller MUST simply return from the driver (through however many levels).
 403  * Returns 0 otherwise.
 404  */
 405 int ide_error (ide_drive_t *drive, const char *msg, byte stat);
 406 
 407 /*
 408  * This routine busy-waits for the drive status to be not "busy".
 409  * It then checks the status for all of the "good" bits and none
 410  * of the "bad" bits, and if all is okay it returns 0.  All other
 411  * cases return 1 after invoking ide_error()
 412  *
 413  */
 414 int ide_wait_stat (ide_drive_t *drive, byte good, byte bad, unsigned long timeout);
 415 
 416 /*
 417  * This is called from genhd.c to correct DiskManager/EZ-Drive geometries
 418  */
 419 int ide_xlate_1024(kdev_t, int, const char *);
 420 
 421 /*
 422  * Start a reset operation for an IDE interface.
 423  * Returns 0 if the reset operation is still in progress,
 424  *  in which case the drive MUST return, to await completion.
 425  * Returns 1 if the reset is complete (success or failure).
 426  */
 427 int ide_do_reset (ide_drive_t *);
 428 
 429 /*
 430  * ide_alloc(): memory allocation for use *only* during driver initialization.
 431  * If "within_area" is non-zero, the memory will be allocated such that
 432  * it lies entirely within a "within_area" sized area (eg. 4096).  This is
 433  * needed for DMA stuff.  "within_area" must be a power of two (not validated).
 434  * All allocations are longword aligned.
 435  */
 436 void *ide_alloc (unsigned long bytecount, unsigned long within_area);
 437 
 438 /*
 439  * This function issues a specific IDE drive command onto the
 440  * tail of the request queue, and waits for it to be completed.
 441  * If arg is NULL, it goes through all the motions,
 442  * but without actually sending a command to the drive.
 443  *
 444  * The value of arg is passed to the internal handler as rq->buffer.
 445  */
 446 int ide_do_drive_cmd(kdev_t rdev, char *args);
 447 
 448 
 449 #ifdef CONFIG_BLK_DEV_IDECD
 450 /*
 451  * These are routines in ide-cd.c invoked from ide.c
 452  */
 453 void ide_do_rw_cdrom (ide_drive_t *, unsigned long);
 454 int ide_cdrom_ioctl (ide_drive_t *, struct inode *, struct file *, unsigned int, unsigned long);
 455 int ide_cdrom_check_media_change (ide_drive_t *);
 456 int ide_cdrom_open (struct inode *, struct file *, ide_drive_t *);
 457 void ide_cdrom_release (struct inode *, struct file *, ide_drive_t *);
 458 void ide_cdrom_setup (ide_drive_t *);
 459 #endif /* CONFIG_BLK_DEV_IDECD */
 460 
 461 #ifdef CONFIG_BLK_DEV_TRITON
 462 void ide_init_triton (byte, byte);
 463 #endif /* CONFIG_BLK_DEV_TRITON */
 464 

/* [previous][next][first][last][top][bottom][index][help] */