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