ide: add ide_use_fast_pio() helper (v3)
[linux-2.6.git] / drivers / ide / ide-lib.c
1 #include <linux/module.h>
2 #include <linux/types.h>
3 #include <linux/string.h>
4 #include <linux/kernel.h>
5 #include <linux/timer.h>
6 #include <linux/mm.h>
7 #include <linux/interrupt.h>
8 #include <linux/major.h>
9 #include <linux/errno.h>
10 #include <linux/genhd.h>
11 #include <linux/blkpg.h>
12 #include <linux/slab.h>
13 #include <linux/pci.h>
14 #include <linux/delay.h>
15 #include <linux/hdreg.h>
16 #include <linux/ide.h>
17 #include <linux/bitops.h>
18
19 #include <asm/byteorder.h>
20 #include <asm/irq.h>
21 #include <asm/uaccess.h>
22 #include <asm/io.h>
23
24 /*
25  *      IDE library routines. These are plug in code that most 
26  *      drivers can use but occasionally may be weird enough
27  *      to want to do their own thing with
28  *
29  *      Add common non I/O op stuff here. Make sure it has proper
30  *      kernel-doc function headers or your patch will be rejected
31  */
32  
33
34 /**
35  *      ide_xfer_verbose        -       return IDE mode names
36  *      @xfer_rate: rate to name
37  *
38  *      Returns a constant string giving the name of the mode
39  *      requested.
40  */
41
42 char *ide_xfer_verbose (u8 xfer_rate)
43 {
44         switch(xfer_rate) {
45                 case XFER_UDMA_7:       return("UDMA 7");
46                 case XFER_UDMA_6:       return("UDMA 6");
47                 case XFER_UDMA_5:       return("UDMA 5");
48                 case XFER_UDMA_4:       return("UDMA 4");
49                 case XFER_UDMA_3:       return("UDMA 3");
50                 case XFER_UDMA_2:       return("UDMA 2");
51                 case XFER_UDMA_1:       return("UDMA 1");
52                 case XFER_UDMA_0:       return("UDMA 0");
53                 case XFER_MW_DMA_2:     return("MW DMA 2");
54                 case XFER_MW_DMA_1:     return("MW DMA 1");
55                 case XFER_MW_DMA_0:     return("MW DMA 0");
56                 case XFER_SW_DMA_2:     return("SW DMA 2");
57                 case XFER_SW_DMA_1:     return("SW DMA 1");
58                 case XFER_SW_DMA_0:     return("SW DMA 0");
59                 case XFER_PIO_4:        return("PIO 4");
60                 case XFER_PIO_3:        return("PIO 3");
61                 case XFER_PIO_2:        return("PIO 2");
62                 case XFER_PIO_1:        return("PIO 1");
63                 case XFER_PIO_0:        return("PIO 0");
64                 case XFER_PIO_SLOW:     return("PIO SLOW");
65                 default:                return("XFER ERROR");
66         }
67 }
68
69 EXPORT_SYMBOL(ide_xfer_verbose);
70
71 /**
72  *      ide_dma_speed   -       compute DMA speed
73  *      @drive: drive
74  *      @mode:  modes available
75  *
76  *      Checks the drive capabilities and returns the speed to use
77  *      for the DMA transfer.  Returns 0 if the drive is incapable
78  *      of DMA transfers.
79  */
80  
81 u8 ide_dma_speed(ide_drive_t *drive, u8 mode)
82 {
83         struct hd_driveid *id   = drive->id;
84         ide_hwif_t *hwif        = HWIF(drive);
85         u8 ultra_mask, mwdma_mask, swdma_mask;
86         u8 speed = 0;
87
88         if (drive->media != ide_disk && hwif->atapi_dma == 0)
89                 return 0;
90
91         /* Capable of UltraDMA modes? */
92         ultra_mask = id->dma_ultra & hwif->ultra_mask;
93
94         if (!(id->field_valid & 4))
95                 mode = 0;       /* fallback to MW/SW DMA if no UltraDMA */
96
97         switch (mode) {
98         case 4:
99                 if (ultra_mask & 0x40) {
100                         speed = XFER_UDMA_6;
101                         break;
102                 }
103         case 3:
104                 if (ultra_mask & 0x20) {
105                         speed = XFER_UDMA_5;
106                         break;
107                 }
108         case 2:
109                 if (ultra_mask & 0x10) {
110                         speed = XFER_UDMA_4;
111                         break;
112                 }
113                 if (ultra_mask & 0x08) {
114                         speed = XFER_UDMA_3;
115                         break;
116                 }
117         case 1:
118                 if (ultra_mask & 0x04) {
119                         speed = XFER_UDMA_2;
120                         break;
121                 }
122                 if (ultra_mask & 0x02) {
123                         speed = XFER_UDMA_1;
124                         break;
125                 }
126                 if (ultra_mask & 0x01) {
127                         speed = XFER_UDMA_0;
128                         break;
129                 }
130         case 0:
131                 mwdma_mask = id->dma_mword & hwif->mwdma_mask;
132
133                 if (mwdma_mask & 0x04) {
134                         speed = XFER_MW_DMA_2;
135                         break;
136                 }
137                 if (mwdma_mask & 0x02) {
138                         speed = XFER_MW_DMA_1;
139                         break;
140                 }
141                 if (mwdma_mask & 0x01) {
142                         speed = XFER_MW_DMA_0;
143                         break;
144                 }
145
146                 swdma_mask = id->dma_1word & hwif->swdma_mask;
147
148                 if (swdma_mask & 0x04) {
149                         speed = XFER_SW_DMA_2;
150                         break;
151                 }
152                 if (swdma_mask & 0x02) {
153                         speed = XFER_SW_DMA_1;
154                         break;
155                 }
156                 if (swdma_mask & 0x01) {
157                         speed = XFER_SW_DMA_0;
158                         break;
159                 }
160         }
161
162         return speed;
163 }
164 EXPORT_SYMBOL(ide_dma_speed);
165
166
167 /**
168  *      ide_rate_filter         -       return best speed for mode
169  *      @mode: modes available
170  *      @speed: desired speed
171  *
172  *      Given the available DMA/UDMA mode this function returns
173  *      the best available speed at or below the speed requested.
174  */
175
176 u8 ide_rate_filter (u8 mode, u8 speed) 
177 {
178 #ifdef CONFIG_BLK_DEV_IDEDMA
179         static u8 speed_max[] = {
180                 XFER_MW_DMA_2, XFER_UDMA_2, XFER_UDMA_4,
181                 XFER_UDMA_5, XFER_UDMA_6
182         };
183
184 //      printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);
185
186         /* So that we remember to update this if new modes appear */
187         BUG_ON(mode > 4);
188         return min(speed, speed_max[mode]);
189 #else /* !CONFIG_BLK_DEV_IDEDMA */
190         return min(speed, (u8)XFER_PIO_4);
191 #endif /* CONFIG_BLK_DEV_IDEDMA */
192 }
193
194 EXPORT_SYMBOL(ide_rate_filter);
195
196 int ide_dma_enable (ide_drive_t *drive)
197 {
198         ide_hwif_t *hwif        = HWIF(drive);
199         struct hd_driveid *id   = drive->id;
200
201         return ((int)   ((((id->dma_ultra >> 8) & hwif->ultra_mask) ||
202                           ((id->dma_mword >> 8) & hwif->mwdma_mask) ||
203                           ((id->dma_1word >> 8) & hwif->swdma_mask)) ? 1 : 0));
204 }
205
206 EXPORT_SYMBOL(ide_dma_enable);
207
208 int ide_use_fast_pio(ide_drive_t *drive)
209 {
210         struct hd_driveid *id = drive->id;
211
212         if ((id->capability & 1) && drive->autodma)
213                 return 1;
214
215         if ((id->capability & 8) || (id->field_valid & 2))
216                 return 1;
217
218         return 0;
219 }
220
221 EXPORT_SYMBOL_GPL(ide_use_fast_pio);
222
223 /*
224  * Standard (generic) timings for PIO modes, from ATA2 specification.
225  * These timings are for access to the IDE data port register *only*.
226  * Some drives may specify a mode, while also specifying a different
227  * value for cycle_time (from drive identification data).
228  */
229 const ide_pio_timings_t ide_pio_timings[6] = {
230         { 70,   165,    600 },  /* PIO Mode 0 */
231         { 50,   125,    383 },  /* PIO Mode 1 */
232         { 30,   100,    240 },  /* PIO Mode 2 */
233         { 30,   80,     180 },  /* PIO Mode 3 with IORDY */
234         { 25,   70,     120 },  /* PIO Mode 4 with IORDY */
235         { 20,   50,     100 }   /* PIO Mode 5 with IORDY (nonstandard) */
236 };
237
238 EXPORT_SYMBOL_GPL(ide_pio_timings);
239
240 /*
241  * Shared data/functions for determining best PIO mode for an IDE drive.
242  * Most of this stuff originally lived in cmd640.c, and changes to the
243  * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
244  * breaking the fragile cmd640.c support.
245  */
246
247 /*
248  * Black list. Some drives incorrectly report their maximal PIO mode,
249  * at least in respect to CMD640. Here we keep info on some known drives.
250  */
251 static struct ide_pio_info {
252         const char      *name;
253         int             pio;
254 } ide_pio_blacklist [] = {
255 /*      { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
256         { "Conner Peripherals 540MB - CFS540A", 3 },
257
258         { "WDC AC2700",  3 },
259         { "WDC AC2540",  3 },
260         { "WDC AC2420",  3 },
261         { "WDC AC2340",  3 },
262         { "WDC AC2250",  0 },
263         { "WDC AC2200",  0 },
264         { "WDC AC21200", 4 },
265         { "WDC AC2120",  0 },
266         { "WDC AC2850",  3 },
267         { "WDC AC1270",  3 },
268         { "WDC AC1170",  1 },
269         { "WDC AC1210",  1 },
270         { "WDC AC280",   0 },
271 /*      { "WDC AC21000", 4 }, */
272         { "WDC AC31000", 3 },
273         { "WDC AC31200", 3 },
274 /*      { "WDC AC31600", 4 }, */
275
276         { "Maxtor 7131 AT", 1 },
277         { "Maxtor 7171 AT", 1 },
278         { "Maxtor 7213 AT", 1 },
279         { "Maxtor 7245 AT", 1 },
280         { "Maxtor 7345 AT", 1 },
281         { "Maxtor 7546 AT", 3 },
282         { "Maxtor 7540 AV", 3 },
283
284         { "SAMSUNG SHD-3121A", 1 },
285         { "SAMSUNG SHD-3122A", 1 },
286         { "SAMSUNG SHD-3172A", 1 },
287
288 /*      { "ST51080A", 4 },
289  *      { "ST51270A", 4 },
290  *      { "ST31220A", 4 },
291  *      { "ST31640A", 4 },
292  *      { "ST32140A", 4 },
293  *      { "ST3780A",  4 },
294  */
295         { "ST5660A",  3 },
296         { "ST3660A",  3 },
297         { "ST3630A",  3 },
298         { "ST3655A",  3 },
299         { "ST3391A",  3 },
300         { "ST3390A",  1 },
301         { "ST3600A",  1 },
302         { "ST3290A",  0 },
303         { "ST3144A",  0 },
304         { "ST3491A",  1 },      /* reports 3, should be 1 or 2 (depending on */ 
305                                 /* drive) according to Seagates FIND-ATA program */
306
307         { "QUANTUM ELS127A", 0 },
308         { "QUANTUM ELS170A", 0 },
309         { "QUANTUM LPS240A", 0 },
310         { "QUANTUM LPS210A", 3 },
311         { "QUANTUM LPS270A", 3 },
312         { "QUANTUM LPS365A", 3 },
313         { "QUANTUM LPS540A", 3 },
314         { "QUANTUM LIGHTNING 540A", 3 },
315         { "QUANTUM LIGHTNING 730A", 3 },
316
317         { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
318         { "QUANTUM FIREBALL_640", 3 }, 
319         { "QUANTUM FIREBALL_1080", 3 },
320         { "QUANTUM FIREBALL_1280", 3 },
321         { NULL, 0 }
322 };
323
324 /**
325  *      ide_scan_pio_blacklist  -       check for a blacklisted drive
326  *      @model: Drive model string
327  *
328  *      This routine searches the ide_pio_blacklist for an entry
329  *      matching the start/whole of the supplied model name.
330  *
331  *      Returns -1 if no match found.
332  *      Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
333  */
334
335 static int ide_scan_pio_blacklist (char *model)
336 {
337         struct ide_pio_info *p;
338
339         for (p = ide_pio_blacklist; p->name != NULL; p++) {
340                 if (strncmp(p->name, model, strlen(p->name)) == 0)
341                         return p->pio;
342         }
343         return -1;
344 }
345
346 /**
347  *      ide_get_best_pio_mode   -       get PIO mode from drive
348  *      @driver: drive to consider
349  *      @mode_wanted: preferred mode
350  *      @max_mode: highest allowed
351  *      @d: pio data
352  *
353  *      This routine returns the recommended PIO settings for a given drive,
354  *      based on the drive->id information and the ide_pio_blacklist[].
355  *      This is used by most chipset support modules when "auto-tuning".
356  *
357  *      Drive PIO mode auto selection
358  */
359
360 u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d)
361 {
362         int pio_mode;
363         int cycle_time = 0;
364         int use_iordy = 0;
365         struct hd_driveid* id = drive->id;
366         int overridden  = 0;
367
368         if (mode_wanted != 255) {
369                 pio_mode = mode_wanted;
370         } else if (!drive->id) {
371                 pio_mode = 0;
372         } else if ((pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
373                 overridden = 1;
374                 use_iordy = (pio_mode > 2);
375         } else {
376                 pio_mode = id->tPIO;
377                 if (pio_mode > 2) {     /* 2 is maximum allowed tPIO value */
378                         pio_mode = 2;
379                         overridden = 1;
380                 }
381                 if (id->field_valid & 2) {        /* drive implements ATA2? */
382                         if (id->capability & 8) { /* drive supports use_iordy? */
383                                 use_iordy = 1;
384                                 cycle_time = id->eide_pio_iordy;
385                                 if (id->eide_pio_modes & 7) {
386                                         overridden = 0;
387                                         if (id->eide_pio_modes & 4)
388                                                 pio_mode = 5;
389                                         else if (id->eide_pio_modes & 2)
390                                                 pio_mode = 4;
391                                         else
392                                                 pio_mode = 3;
393                                 }
394                         } else {
395                                 cycle_time = id->eide_pio;
396                         }
397                 }
398
399 #if 0
400                 if (drive->id->major_rev_num & 0x0004) printk("ATA-2 ");
401 #endif
402
403                 /*
404                  * Conservative "downgrade" for all pre-ATA2 drives
405                  */
406                 if (pio_mode && pio_mode < 4) {
407                         pio_mode--;
408                         overridden = 1;
409 #if 0
410                         use_iordy = (pio_mode > 2);
411 #endif
412                         if (cycle_time && cycle_time < ide_pio_timings[pio_mode].cycle_time)
413                                 cycle_time = 0; /* use standard timing */
414                 }
415         }
416         if (pio_mode > max_mode) {
417                 pio_mode = max_mode;
418                 cycle_time = 0;
419         }
420         if (d) {
421                 d->pio_mode = pio_mode;
422                 d->cycle_time = cycle_time ? cycle_time : ide_pio_timings[pio_mode].cycle_time;
423                 d->use_iordy = use_iordy;
424                 d->overridden = overridden;
425         }
426         return pio_mode;
427 }
428
429 EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
430
431 /**
432  *      ide_toggle_bounce       -       handle bounce buffering
433  *      @drive: drive to update
434  *      @on: on/off boolean
435  *
436  *      Enable or disable bounce buffering for the device. Drives move
437  *      between PIO and DMA and that changes the rules we need.
438  */
439  
440 void ide_toggle_bounce(ide_drive_t *drive, int on)
441 {
442         u64 addr = BLK_BOUNCE_HIGH;     /* dma64_addr_t */
443
444         if (!PCI_DMA_BUS_IS_PHYS) {
445                 addr = BLK_BOUNCE_ANY;
446         } else if (on && drive->media == ide_disk) {
447                 if (HWIF(drive)->pci_dev)
448                         addr = HWIF(drive)->pci_dev->dma_mask;
449         }
450
451         if (drive->queue)
452                 blk_queue_bounce_limit(drive->queue, addr);
453 }
454
455 /**
456  *      ide_set_xfer_rate       -       set transfer rate
457  *      @drive: drive to set
458  *      @speed: speed to attempt to set
459  *      
460  *      General helper for setting the speed of an IDE device. This
461  *      function knows about user enforced limits from the configuration
462  *      which speedproc() does not.  High level drivers should never
463  *      invoke speedproc() directly.
464  */
465  
466 int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
467 {
468 #ifndef CONFIG_BLK_DEV_IDEDMA
469         rate = min(rate, (u8) XFER_PIO_4);
470 #endif
471         if(HWIF(drive)->speedproc)
472                 return HWIF(drive)->speedproc(drive, rate);
473         else
474                 return -1;
475 }
476
477 static void ide_dump_opcode(ide_drive_t *drive)
478 {
479         struct request *rq;
480         u8 opcode = 0;
481         int found = 0;
482
483         spin_lock(&ide_lock);
484         rq = NULL;
485         if (HWGROUP(drive))
486                 rq = HWGROUP(drive)->rq;
487         spin_unlock(&ide_lock);
488         if (!rq)
489                 return;
490         if (rq->cmd_type == REQ_TYPE_ATA_CMD ||
491             rq->cmd_type == REQ_TYPE_ATA_TASK) {
492                 char *args = rq->buffer;
493                 if (args) {
494                         opcode = args[0];
495                         found = 1;
496                 }
497         } else if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE) {
498                 ide_task_t *args = rq->special;
499                 if (args) {
500                         task_struct_t *tf = (task_struct_t *) args->tfRegister;
501                         opcode = tf->command;
502                         found = 1;
503                 }
504         }
505
506         printk("ide: failed opcode was: ");
507         if (!found)
508                 printk("unknown\n");
509         else
510                 printk("0x%02x\n", opcode);
511 }
512
513 static u8 ide_dump_ata_status(ide_drive_t *drive, const char *msg, u8 stat)
514 {
515         ide_hwif_t *hwif = HWIF(drive);
516         unsigned long flags;
517         u8 err = 0;
518
519         local_irq_save(flags);
520         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
521         if (stat & BUSY_STAT)
522                 printk("Busy ");
523         else {
524                 if (stat & READY_STAT)  printk("DriveReady ");
525                 if (stat & WRERR_STAT)  printk("DeviceFault ");
526                 if (stat & SEEK_STAT)   printk("SeekComplete ");
527                 if (stat & DRQ_STAT)    printk("DataRequest ");
528                 if (stat & ECC_STAT)    printk("CorrectedError ");
529                 if (stat & INDEX_STAT)  printk("Index ");
530                 if (stat & ERR_STAT)    printk("Error ");
531         }
532         printk("}\n");
533         if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
534                 err = hwif->INB(IDE_ERROR_REG);
535                 printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
536                 if (err & ABRT_ERR)     printk("DriveStatusError ");
537                 if (err & ICRC_ERR)
538                         printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
539                 if (err & ECC_ERR)      printk("UncorrectableError ");
540                 if (err & ID_ERR)       printk("SectorIdNotFound ");
541                 if (err & TRK0_ERR)     printk("TrackZeroNotFound ");
542                 if (err & MARK_ERR)     printk("AddrMarkNotFound ");
543                 printk("}");
544                 if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
545                     (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
546                         if (drive->addressing == 1) {
547                                 __u64 sectors = 0;
548                                 u32 low = 0, high = 0;
549                                 low = ide_read_24(drive);
550                                 hwif->OUTB(drive->ctl|0x80, IDE_CONTROL_REG);
551                                 high = ide_read_24(drive);
552                                 sectors = ((__u64)high << 24) | low;
553                                 printk(", LBAsect=%llu, high=%d, low=%d",
554                                        (unsigned long long) sectors,
555                                        high, low);
556                         } else {
557                                 u8 cur = hwif->INB(IDE_SELECT_REG);
558                                 if (cur & 0x40) {       /* using LBA? */
559                                         printk(", LBAsect=%ld", (unsigned long)
560                                          ((cur&0xf)<<24)
561                                          |(hwif->INB(IDE_HCYL_REG)<<16)
562                                          |(hwif->INB(IDE_LCYL_REG)<<8)
563                                          | hwif->INB(IDE_SECTOR_REG));
564                                 } else {
565                                         printk(", CHS=%d/%d/%d",
566                                          (hwif->INB(IDE_HCYL_REG)<<8) +
567                                           hwif->INB(IDE_LCYL_REG),
568                                           cur & 0xf,
569                                           hwif->INB(IDE_SECTOR_REG));
570                                 }
571                         }
572                         if (HWGROUP(drive) && HWGROUP(drive)->rq)
573                                 printk(", sector=%llu",
574                                         (unsigned long long)HWGROUP(drive)->rq->sector);
575                 }
576                 printk("\n");
577         }
578         ide_dump_opcode(drive);
579         local_irq_restore(flags);
580         return err;
581 }
582
583 /**
584  *      ide_dump_atapi_status       -       print human readable atapi status
585  *      @drive: drive that status applies to
586  *      @msg: text message to print
587  *      @stat: status byte to decode
588  *
589  *      Error reporting, in human readable form (luxurious, but a memory hog).
590  */
591
592 static u8 ide_dump_atapi_status(ide_drive_t *drive, const char *msg, u8 stat)
593 {
594         unsigned long flags;
595
596         atapi_status_t status;
597         atapi_error_t error;
598
599         status.all = stat;
600         error.all = 0;
601         local_irq_save(flags);
602         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
603         if (status.b.bsy)
604                 printk("Busy ");
605         else {
606                 if (status.b.drdy)      printk("DriveReady ");
607                 if (status.b.df)        printk("DeviceFault ");
608                 if (status.b.dsc)       printk("SeekComplete ");
609                 if (status.b.drq)       printk("DataRequest ");
610                 if (status.b.corr)      printk("CorrectedError ");
611                 if (status.b.idx)       printk("Index ");
612                 if (status.b.check)     printk("Error ");
613         }
614         printk("}\n");
615         if (status.b.check && !status.b.bsy) {
616                 error.all = HWIF(drive)->INB(IDE_ERROR_REG);
617                 printk("%s: %s: error=0x%02x { ", drive->name, msg, error.all);
618                 if (error.b.ili)        printk("IllegalLengthIndication ");
619                 if (error.b.eom)        printk("EndOfMedia ");
620                 if (error.b.abrt)       printk("AbortedCommand ");
621                 if (error.b.mcr)        printk("MediaChangeRequested ");
622                 if (error.b.sense_key)  printk("LastFailedSense=0x%02x ",
623                                                 error.b.sense_key);
624                 printk("}\n");
625         }
626         ide_dump_opcode(drive);
627         local_irq_restore(flags);
628         return error.all;
629 }
630
631 /**
632  *      ide_dump_status         -       translate ATA/ATAPI error
633  *      @drive: drive the error occured on
634  *      @msg: information string
635  *      @stat: status byte
636  *
637  *      Error reporting, in human readable form (luxurious, but a memory hog).
638  *      Combines the drive name, message and status byte to provide a
639  *      user understandable explanation of the device error.
640  */
641
642 u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
643 {
644         if (drive->media == ide_disk)
645                 return ide_dump_ata_status(drive, msg, stat);
646         return ide_dump_atapi_status(drive, msg, stat);
647 }
648
649 EXPORT_SYMBOL(ide_dump_status);