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 #undefREALLY_FAST_IO/* define if ide ports are perfect */ 26 #defineINITIAL_MULT_COUNT 0 /* off=0; on=2,4,8,16,32, etc.. */ 27
28 #ifndefDISK_RECOVERY_TIME/* off=0; on=access_delay_time */ 29 #defineDISK_RECOVERY_TIME 0 /* for hardware that needs it */ 30 #endif 31 #ifndefOK_TO_RESET_CONTROLLER/* 1 needed for good error recovery */ 32 #defineOK_TO_RESET_CONTROLLER 1 /* 0 for use with AH2372A/B interface */ 33 #endif 34 #ifndefFAKE_FDISK_FOR_EZDRIVE/* 1 to help linux fdisk with EZDRIVE */ 35 #defineFAKE_FDISK_FOR_EZDRIVE 1 /* 0 to reduce kernel size */ 36 #endif 37 #ifndefSUPPORT_RZ1000/* 1 to support RZ1000 chipset */ 38 #defineSUPPORT_RZ1000 1 /* 0 to reduce kernel size */ 39 #endif 40 #ifndefSUPPORT_CMD640/* 1 to support CMD640 chipset */ 41 #defineSUPPORT_CMD640 1 /* 0 to reduce kernel size */ 42 #endif 43 #ifndefSUPPORT_HT6560B/* 1 to support HT6560B chipset */ 44 #defineSUPPORT_HT6560B 1 /* 0 to reduce kernel size */ 45 #endif 46 #ifndefSUPPORT_QD6580/* 1 to support QD6580 chipset */ 47 #defineSUPPORT_QD6580 1 /* 0 to reduce kernel size */ 48 #endif 49 #ifndefSUPPORT_DTC2278/* 1 to support DTC2278 chipset */ 50 #defineSUPPORT_DTC2278 1 /* 0 to reduce kernel size */ 51 #ifndefSET_DTC2278_MODE4 52 #defineSET_DTC2278_MODE4 0 /* 1 to init primary i/f for PIO mode4 */ 53 #endif 54 #endif 55 #ifndefFANCY_STATUS_DUMPS/* 1 for human-readable drive errors */ 56 #defineFANCY_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 #defineIDE_DRIVE_CMD 99 /* (magic) undef to reduce kernel size*/ 63
64 /* 65 * "No user-serviceable parts" beyond this point :) 66 *****************************************************************************/ 67
68 typedefunsignedcharbyte; /* used everywhere */ 69
70 /* 71 * Probably not wise to fiddle with these 72 */ 73 #defineERROR_MAX 8 /* Max read/write errors per sector */ 74 #defineERROR_RESET 3 /* Reset controller every 4th retry */ 75 #defineERROR_RECAL 1 /* Recalibrate every 2nd retry */ 76
77 /* 78 * Ensure that various configuration flags have compatible settings 79 */ 80 #ifdefREALLY_SLOW_IO 81 #undefREALLY_FAST_IO 82 #endif 83
84 /* 85 * Definitions for accessing IDE controller registers 86 */ 87
88 #defineHWIF(drive) ((ide_hwif_t *)drive->hwif)
89 #defineHWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
90
91 #defineIDE_DATA_OFFSET (0)
92 #defineIDE_ERROR_OFFSET (1)
93 #defineIDE_NSECTOR_OFFSET (2)
94 #defineIDE_SECTOR_OFFSET (3)
95 #defineIDE_LCYL_OFFSET (4)
96 #defineIDE_HCYL_OFFSET (5)
97 #defineIDE_SELECT_OFFSET (6)
98 #defineIDE_STATUS_OFFSET (7)
99 #defineIDE_FEATURE_OFFSETIDE_ERROR_OFFSET 100 #defineIDE_COMMAND_OFFSETIDE_STATUS_OFFSET 101
102 #defineIDE_DATA_REG (HWIF(drive)->io_base+IDE_DATA_OFFSET)
103 #defineIDE_ERROR_REG (HWIF(drive)->io_base+IDE_ERROR_OFFSET)
104 #defineIDE_NSECTOR_REG (HWIF(drive)->io_base+IDE_NSECTOR_OFFSET)
105 #defineIDE_SECTOR_REG (HWIF(drive)->io_base+IDE_SECTOR_OFFSET)
106 #defineIDE_LCYL_REG (HWIF(drive)->io_base+IDE_LCYL_OFFSET)
107 #defineIDE_HCYL_REG (HWIF(drive)->io_base+IDE_HCYL_OFFSET)
108 #defineIDE_SELECT_REG (HWIF(drive)->io_base+IDE_SELECT_OFFSET)
109 #defineIDE_STATUS_REG (HWIF(drive)->io_base+IDE_STATUS_OFFSET)
110 #defineIDE_CONTROL_REG (HWIF(drive)->ctl_port)
111 #defineIDE_FEATURE_REGIDE_ERROR_REG 112 #defineIDE_COMMAND_REGIDE_STATUS_REG 113 #defineIDE_ALTSTATUS_REGIDE_CONTROL_REG 114
115 #ifdefREALLY_FAST_IO 116 #defineOUT_BYTE(b,p) outb((b),p)
117 #defineIN_BYTE(p) (byte)inb(p)
118 #else 119 #defineOUT_BYTE(b,p) outb_p((b),p)
120 #defineIN_BYTE(p) (byte)inb_p(p)
121 #endif/* REALLY_FAST_IO */ 122
123 #defineGET_ERR() IN_BYTE(IDE_ERROR_REG)
124 #defineGET_STAT() IN_BYTE(IDE_STATUS_REG)
125 #defineOK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
126 #defineBAD_R_STAT (BUSY_STAT | ERR_STAT)
127 #defineBAD_W_STAT (BAD_R_STAT | WRERR_STAT)
128 #defineBAD_STAT (BAD_R_STAT | DRQ_STAT)
129 #defineDRIVE_READY (READY_STAT | SEEK_STAT)
130 #defineDATA_READY (DRIVE_READY | DRQ_STAT)
131
132 /* 133 * Some more useful definitions 134 */ 135 #defineIDE_MAJOR_NAME "ide" /* the same for all i/f; see also genhd.c */ 136 #define MAJOR_NAME IDE_MAJOR_NAME 137 #definePARTN_BITS 6 /* number of minor dev bits for partitions */ 138 #definePARTN_MASK ((1<<PARTN_BITS)-1) /* a useful bit mask */ 139 #defineMAX_DRIVES 2 /* per interface; 2 assumed by lots of code */ 140 #defineMAX_HWIFS 4 /* an arbitrary, but realistic limit */ 141 #defineSECTOR_WORDS (512 / 4) /* number of 32bit words per sector */ 142
143 /* 144 * Timeouts for various operations: 145 */ 146 #defineWAIT_DRQ (5*HZ/100) /* 50msec - spec allows up to 20ms */ 147 #defineWAIT_READY (3*HZ/100) /* 30msec - should be instantaneous */ 148 #defineWAIT_PIDENTIFY (1*HZ) /* 1sec - should be less than 3ms (?) */ 149 #defineWAIT_WORSTCASE (30*HZ) /* 30sec - worst case when spinning up */ 150 #defineWAIT_CMD (10*HZ) /* 10sec - maximum wait for an IRQ to happen */ 151
152 #ifdefCONFIG_BLK_DEV_IDECD 153
154 structatapi_request_sense{ 155 unsignedcharerror_code : 7;
156 unsignedcharvalid : 1;
157 bytereserved1;
158 unsignedcharsense_key : 4;
159 unsignedcharreserved2 : 1;
160 unsignedchar ili : 1;
161 unsignedcharreserved3 : 2;
162 byteinfo[4];
163 bytesense_len;
164 byte command_info[4];
165 byteasc;
166 byteascq;
167 byte fru;
168 bytesense_key_specific[3];
169 };
170
171 structpacket_command{ 172 char *buffer;
173 intbuflen;
174 intstat;
175 structatapi_request_sense *sense_data;
176 unsignedcharc[12];
177 };
178
179 /* Space to hold the disk TOC. */ 180
181 #defineMAX_TRACKS 99
182 structatapi_toc_header{ 183 unsignedshorttoc_length;
184 bytefirst_track;
185 bytelast_track;
186 };
187
188 structatapi_toc_entry{ 189 bytereserved1;
190 unsignedcontrol : 4;
191 unsignedadr : 4;
192 bytetrack;
193 bytereserved2;
194 unsignedlba;
195 };
196
197 structatapi_toc{ 198 intlast_session_lba;
199 intxa_flag;
200 unsignedcapacity;
201 structatapi_toc_headerhdr;
202 structatapi_toc_entryent[MAX_TRACKS+1]; /* One extra for the leadout. */ 203 };
204
205 /* Extra per-device info for cdrom drives. */ 206 structcdrom_info{ 207
208 /* Buffer for table of contents. NULL if we haven't allocated 209 a TOC buffer for this device yet. */ 210
211 structatapi_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 unsignedlongsector_buffered;
221 unsignedlongnsectors_buffered;
222 char *sector_buffer;
223
224 /* The result of the last successful request sense command 225 on this device. */ 226 structatapi_request_sensesense_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 typedefenum{disk, cdrom}media_t;
235
236 typedefunion{ 237 unsignedall : 8; /* all of the bits together */ 238 struct{ 239 unsignedset_geometry : 1; /* respecify drive geometry */ 240 unsignedrecalibrate : 1; /* seek to cyl 0 */ 241 unsignedset_multmode : 1; /* set multmode count */ 242 unsignedreserved : 5; /* unused */ 243 }b;
244 }special_t;
245
246 typedefunion{ 247 unsignedall : 8; /* all of the bits together */ 248 struct{ 249 unsignedhead : 4; /* always zeros here */ 250 unsignedunit : 1; /* drive select number, 0 or 1 */ 251 unsigned bit5 : 1; /* always 1 */ 252 unsignedlba : 1; /* using LBA instead of CHS */ 253 unsigned bit7 : 1; /* always 1 */ 254 }b;
255 }select_t;
256
257 typedefstruct ide_drive_s { 258 special_tspecial; /* special action flags */ 259 #ifFAKE_FDISK_FOR_EZDRIVE 260 unsignedezdrive : 1; /* flag: partitioned with ezdrive */ 261 #endif/* FAKE_FDISK_FOR_EZDRIVE */ 262 unsignedpresent : 1; /* drive is physically present */ 263 unsignednoprobe : 1; /* from: hdx=noprobe */ 264 unsignedkeep_settings : 1; /* restore settings after drive reset */ 265 unsignedbusy : 1; /* currently doing revalidate_disk() */ 266 unsignedvlb_32bit : 1; /* use 32bit in/out for data */ 267 unsignedvlb_sync : 1; /* needed for some 32bit chip sets */ 268 unsignedremoveable : 1; /* 1 if need to do check_media_change */ 269 unsignedusing_dma : 1; /* disk is using dma for read/write */ 270 unsignedunmask : 1; /* flag: okay to unmask other irqs */ 271 media_tmedia; /* disk, cdrom, tape */ 272 select_tselect; /* basic drive/head select reg value */ 273 void *hwif; /* actually (ide_hwif_t *) */ 274 bytectl; /* "normal" value for IDE_CONTROL_REG */ 275 byteready_stat; /* min status value for drive ready */ 276 bytemult_count; /* current multiple sector setting */ 277 bytemult_req; /* requested multiple sector setting */ 278 bytechipset; /* interface chipset access method */ 279 bytebad_wstat; /* used for ignoring WRERR_STAT */ 280 bytesect0; /* offset of first sector for DM6:DDO */ 281 byteusage; /* current "open()" count for drive */ 282 bytehead; /* "real" number of heads */ 283 bytesect; /* "real" sectors per track */ 284 bytebios_head; /* BIOS/fdisk/LILO number of heads */ 285 bytebios_sect; /* BIOS/fdisk/LILO sectors per track */ 286 unsignedshortbios_cyl; /* BIOS/fdisk/LILO number of cyls */ 287 unsignedshortcyl; /* "real" number of cyls */ 288 structwait_queue *wqueue; /* used to wait for drive in open() */ 289 structhd_driveid *id; /* drive model identification info */ 290 structhd_struct *part; /* drive partition table */ 291 charname[4]; /* drive name, such as "hda" */ 292 #ifdefCONFIG_BLK_DEV_IDECD 293 structcdrom_infocdrom_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 typedefenum{ide_dma_read = 0, ide_dma_write = 1, ide_dma_abort = 2, ide_dma_check = 3}ide_dma_action_t;
309 typedefint (ide_dmaproc_t)(ide_dma_action_t, ide_drive_t *);
310
311 typedefstructhwif_s{ 312 structhwif_s *next; /* for linked-list in ide_hwgroup_t */ 313 void *hwgroup; /* actually (ide_hwgroup_t *) */ 314 unsignedshortio_base; /* base io port addr */ 315 unsignedshortctl_port; /* usually io_base+0x206 */ 316 ide_drive_tdrives[MAX_DRIVES]; /* drive info */ 317 structgendisk *gd; /* gendisk structure */ 318 ide_dmaproc_t *dmaproc; /* dma read/write/abort routine */ 319 unsignedlong *dmatable; /* dma physical region descriptor table */ 320 unsignedshortdma_base; /* base addr for dma ports (triton) */ 321 byteirq; /* our irq number */ 322 bytemajor; /* our major number */ 323 byteselect; /* pri/sec hwif select for ht6560b */ 324 charname[5]; /* name of interface, eg. "ide0" */ 325 unsignednoprobe : 1; /* don't probe for this interface */ 326 unsignedpresent : 1; /* this interface exists */ 327 #if (DISK_RECOVERY_TIME > 0)
328 unsignedlonglast_time; /* time when previous rq was done */ 329 #endif 330 #ifdefCONFIG_BLK_DEV_IDECD 331 structrequestrequest_sense_request; /* from ide-cd.c */ 332 structpacket_commandrequest_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 typedefvoid (ide_handler_t)(ide_drive_t *);
340
341 typedefstruct 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 structrequest *rq; /* current request */ 346 structtimer_listtimer; /* failsafe timer */ 347 structrequestwrq; /* local copy of current write rq */ 348 unsignedlongreset_timeout; /* timeout value during ide resets */ 349 #ifdefCONFIG_BLK_DEV_IDECD 350 intdoing_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 #defineIDE_DRIVER/* "parameter" for blk.h */ 358 #include <linux/blk.h>
359
360 #if (DISK_RECOVERY_TIME > 0)
361 voidide_set_recovery_timer (ide_hwif_t *);
362 #defineSET_RECOVERY_TIMER(drive) ide_set_recovery_timer (drive)
363 #else 364 #defineSET_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 voidide_do_request (ide_hwgroup_t *);
374 #defineIDE_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 voidide_input_data (ide_drive_t *drive, void *buffer, unsignedintwcount);
381
382 /* 383 * This is used for (nearly) all data transfers to the IDE interface 384 */ 385 voidide_output_data (ide_drive_t *drive, void *buffer, unsignedintwcount);
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 voidide_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 byteide_dump_status (ide_drive_t *drive, constchar *msg, bytestat);
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 intide_error (ide_drive_t *drive, constchar *msg, bytestat);
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 intide_wait_stat (ide_drive_t *drive, bytegood, bytebad, unsignedlongtimeout);
415
416 /* 417 * This is called from genhd.c to correct DiskManager/EZ-Drive geometries 418 */ 419 intide_xlate_1024(kdev_t, int, constchar *);
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 intide_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 (unsignedlongbytecount, unsignedlong 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 intide_do_drive_cmd(kdev_trdev, char *args);
447
448
449 #ifdefCONFIG_BLK_DEV_IDECD 450 /* 451 * These are routines in ide-cd.c invoked from ide.c 452 */ 453 voidide_do_rw_cdrom (ide_drive_t *, unsignedlong);
454 intide_cdrom_ioctl (ide_drive_t *, structinode *, structfile *, unsignedint, unsignedlong);
455 intide_cdrom_check_media_change (ide_drive_t *);
456 intide_cdrom_open (structinode *, structfile *, ide_drive_t *);
457 voidide_cdrom_release (structinode *, structfile *, ide_drive_t *);
458 voidide_cdrom_setup (ide_drive_t *);
459 #endif/* CONFIG_BLK_DEV_IDECD */ 460
461 #ifdefCONFIG_BLK_DEV_TRITON 462 voidide_init_triton (byte, byte);
463 #endif/* CONFIG_BLK_DEV_TRITON */ 464