ide: mode limiting fixes for user requested speed changes
[linux-2.6] / 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_rate_filter         -       filter transfer mode
73  *      @drive: IDE device
74  *      @speed: desired speed
75  *
76  *      Given the available transfer modes this function returns
77  *      the best available speed at or below the speed requested.
78  *
79  *      TODO: check device PIO capabilities
80  */
81
82 u8 ide_rate_filter(ide_drive_t *drive, u8 speed)
83 {
84         ide_hwif_t *hwif = drive->hwif;
85         u8 mode = ide_find_dma_mode(drive, speed);
86
87         if (mode == 0) {
88                 if (hwif->pio_mask)
89                         mode = fls(hwif->pio_mask) - 1 + XFER_PIO_0;
90                 else
91                         mode = XFER_PIO_4;
92         }
93
94 //      printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);
95
96         return min(speed, mode);
97 }
98
99 EXPORT_SYMBOL(ide_rate_filter);
100
101 int ide_use_fast_pio(ide_drive_t *drive)
102 {
103         struct hd_driveid *id = drive->id;
104
105         if ((id->capability & 1) && drive->autodma)
106                 return 1;
107
108         if ((id->capability & 8) || (id->field_valid & 2))
109                 return 1;
110
111         return 0;
112 }
113
114 EXPORT_SYMBOL_GPL(ide_use_fast_pio);
115
116 /*
117  * Standard (generic) timings for PIO modes, from ATA2 specification.
118  * These timings are for access to the IDE data port register *only*.
119  * Some drives may specify a mode, while also specifying a different
120  * value for cycle_time (from drive identification data).
121  */
122 const ide_pio_timings_t ide_pio_timings[6] = {
123         { 70,   165,    600 },  /* PIO Mode 0 */
124         { 50,   125,    383 },  /* PIO Mode 1 */
125         { 30,   100,    240 },  /* PIO Mode 2 */
126         { 30,   80,     180 },  /* PIO Mode 3 with IORDY */
127         { 25,   70,     120 },  /* PIO Mode 4 with IORDY */
128         { 20,   50,     100 }   /* PIO Mode 5 with IORDY (nonstandard) */
129 };
130
131 EXPORT_SYMBOL_GPL(ide_pio_timings);
132
133 /*
134  * Shared data/functions for determining best PIO mode for an IDE drive.
135  * Most of this stuff originally lived in cmd640.c, and changes to the
136  * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
137  * breaking the fragile cmd640.c support.
138  */
139
140 /*
141  * Black list. Some drives incorrectly report their maximal PIO mode,
142  * at least in respect to CMD640. Here we keep info on some known drives.
143  */
144 static struct ide_pio_info {
145         const char      *name;
146         int             pio;
147 } ide_pio_blacklist [] = {
148 /*      { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
149         { "Conner Peripherals 540MB - CFS540A", 3 },
150
151         { "WDC AC2700",  3 },
152         { "WDC AC2540",  3 },
153         { "WDC AC2420",  3 },
154         { "WDC AC2340",  3 },
155         { "WDC AC2250",  0 },
156         { "WDC AC2200",  0 },
157         { "WDC AC21200", 4 },
158         { "WDC AC2120",  0 },
159         { "WDC AC2850",  3 },
160         { "WDC AC1270",  3 },
161         { "WDC AC1170",  1 },
162         { "WDC AC1210",  1 },
163         { "WDC AC280",   0 },
164 /*      { "WDC AC21000", 4 }, */
165         { "WDC AC31000", 3 },
166         { "WDC AC31200", 3 },
167 /*      { "WDC AC31600", 4 }, */
168
169         { "Maxtor 7131 AT", 1 },
170         { "Maxtor 7171 AT", 1 },
171         { "Maxtor 7213 AT", 1 },
172         { "Maxtor 7245 AT", 1 },
173         { "Maxtor 7345 AT", 1 },
174         { "Maxtor 7546 AT", 3 },
175         { "Maxtor 7540 AV", 3 },
176
177         { "SAMSUNG SHD-3121A", 1 },
178         { "SAMSUNG SHD-3122A", 1 },
179         { "SAMSUNG SHD-3172A", 1 },
180
181 /*      { "ST51080A", 4 },
182  *      { "ST51270A", 4 },
183  *      { "ST31220A", 4 },
184  *      { "ST31640A", 4 },
185  *      { "ST32140A", 4 },
186  *      { "ST3780A",  4 },
187  */
188         { "ST5660A",  3 },
189         { "ST3660A",  3 },
190         { "ST3630A",  3 },
191         { "ST3655A",  3 },
192         { "ST3391A",  3 },
193         { "ST3390A",  1 },
194         { "ST3600A",  1 },
195         { "ST3290A",  0 },
196         { "ST3144A",  0 },
197         { "ST3491A",  1 },      /* reports 3, should be 1 or 2 (depending on */ 
198                                 /* drive) according to Seagates FIND-ATA program */
199
200         { "QUANTUM ELS127A", 0 },
201         { "QUANTUM ELS170A", 0 },
202         { "QUANTUM LPS240A", 0 },
203         { "QUANTUM LPS210A", 3 },
204         { "QUANTUM LPS270A", 3 },
205         { "QUANTUM LPS365A", 3 },
206         { "QUANTUM LPS540A", 3 },
207         { "QUANTUM LIGHTNING 540A", 3 },
208         { "QUANTUM LIGHTNING 730A", 3 },
209
210         { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
211         { "QUANTUM FIREBALL_640", 3 }, 
212         { "QUANTUM FIREBALL_1080", 3 },
213         { "QUANTUM FIREBALL_1280", 3 },
214         { NULL, 0 }
215 };
216
217 /**
218  *      ide_scan_pio_blacklist  -       check for a blacklisted drive
219  *      @model: Drive model string
220  *
221  *      This routine searches the ide_pio_blacklist for an entry
222  *      matching the start/whole of the supplied model name.
223  *
224  *      Returns -1 if no match found.
225  *      Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
226  */
227
228 static int ide_scan_pio_blacklist (char *model)
229 {
230         struct ide_pio_info *p;
231
232         for (p = ide_pio_blacklist; p->name != NULL; p++) {
233                 if (strncmp(p->name, model, strlen(p->name)) == 0)
234                         return p->pio;
235         }
236         return -1;
237 }
238
239 unsigned int ide_pio_cycle_time(ide_drive_t *drive, u8 pio)
240 {
241         struct hd_driveid *id = drive->id;
242         int cycle_time = 0;
243
244         if (id->field_valid & 2) {
245                 if (id->capability & 8)
246                         cycle_time = id->eide_pio_iordy;
247                 else
248                         cycle_time = id->eide_pio;
249         }
250
251         /* conservative "downgrade" for all pre-ATA2 drives */
252         if (pio < 3) {
253                 if (cycle_time && cycle_time < ide_pio_timings[pio].cycle_time)
254                         cycle_time = 0; /* use standard timing */
255         }
256
257         return cycle_time ? cycle_time : ide_pio_timings[pio].cycle_time;
258 }
259
260 EXPORT_SYMBOL_GPL(ide_pio_cycle_time);
261
262 /**
263  *      ide_get_best_pio_mode   -       get PIO mode from drive
264  *      @drive: drive to consider
265  *      @mode_wanted: preferred mode
266  *      @max_mode: highest allowed mode
267  *
268  *      This routine returns the recommended PIO settings for a given drive,
269  *      based on the drive->id information and the ide_pio_blacklist[].
270  *
271  *      Drive PIO mode is auto-selected if 255 is passed as mode_wanted.
272  *      This is used by most chipset support modules when "auto-tuning".
273  */
274
275 u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode)
276 {
277         int pio_mode;
278         struct hd_driveid* id = drive->id;
279         int overridden  = 0;
280
281         if (mode_wanted != 255)
282                 return min_t(u8, mode_wanted, max_mode);
283
284         if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_BLACKLIST) == 0 &&
285             (pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
286                 printk(KERN_INFO "%s: is on PIO blacklist\n", drive->name);
287         } else {
288                 pio_mode = id->tPIO;
289                 if (pio_mode > 2) {     /* 2 is maximum allowed tPIO value */
290                         pio_mode = 2;
291                         overridden = 1;
292                 }
293                 if (id->field_valid & 2) {        /* drive implements ATA2? */
294                         if (id->capability & 8) { /* IORDY supported? */
295                                 if (id->eide_pio_modes & 7) {
296                                         overridden = 0;
297                                         if (id->eide_pio_modes & 4)
298                                                 pio_mode = 5;
299                                         else if (id->eide_pio_modes & 2)
300                                                 pio_mode = 4;
301                                         else
302                                                 pio_mode = 3;
303                                 }
304                         }
305                 }
306
307                 if (overridden)
308                         printk(KERN_INFO "%s: tPIO > 2, assuming tPIO = 2\n",
309                                          drive->name);
310
311                 /*
312                  * Conservative "downgrade" for all pre-ATA2 drives
313                  */
314                 if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_DOWNGRADE) == 0 &&
315                     pio_mode && pio_mode < 4) {
316                         pio_mode--;
317                         printk(KERN_INFO "%s: applying conservative "
318                                          "PIO \"downgrade\"\n", drive->name);
319                 }
320         }
321
322         if (pio_mode > max_mode)
323                 pio_mode = max_mode;
324
325         return pio_mode;
326 }
327
328 EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
329
330 /**
331  *      ide_toggle_bounce       -       handle bounce buffering
332  *      @drive: drive to update
333  *      @on: on/off boolean
334  *
335  *      Enable or disable bounce buffering for the device. Drives move
336  *      between PIO and DMA and that changes the rules we need.
337  */
338  
339 void ide_toggle_bounce(ide_drive_t *drive, int on)
340 {
341         u64 addr = BLK_BOUNCE_HIGH;     /* dma64_addr_t */
342
343         if (!PCI_DMA_BUS_IS_PHYS) {
344                 addr = BLK_BOUNCE_ANY;
345         } else if (on && drive->media == ide_disk) {
346                 if (HWIF(drive)->pci_dev)
347                         addr = HWIF(drive)->pci_dev->dma_mask;
348         }
349
350         if (drive->queue)
351                 blk_queue_bounce_limit(drive->queue, addr);
352 }
353
354 /**
355  *      ide_set_xfer_rate       -       set transfer rate
356  *      @drive: drive to set
357  *      @speed: speed to attempt to set
358  *      
359  *      General helper for setting the speed of an IDE device. This
360  *      function knows about user enforced limits from the configuration
361  *      which speedproc() does not.  High level drivers should never
362  *      invoke speedproc() directly.
363  */
364  
365 int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
366 {
367 #ifndef CONFIG_BLK_DEV_IDEDMA
368         rate = min(rate, (u8) XFER_PIO_4);
369 #endif
370         if(HWIF(drive)->speedproc)
371                 return HWIF(drive)->speedproc(drive, rate);
372         else
373                 return -1;
374 }
375
376 static void ide_dump_opcode(ide_drive_t *drive)
377 {
378         struct request *rq;
379         u8 opcode = 0;
380         int found = 0;
381
382         spin_lock(&ide_lock);
383         rq = NULL;
384         if (HWGROUP(drive))
385                 rq = HWGROUP(drive)->rq;
386         spin_unlock(&ide_lock);
387         if (!rq)
388                 return;
389         if (rq->cmd_type == REQ_TYPE_ATA_CMD ||
390             rq->cmd_type == REQ_TYPE_ATA_TASK) {
391                 char *args = rq->buffer;
392                 if (args) {
393                         opcode = args[0];
394                         found = 1;
395                 }
396         } else if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE) {
397                 ide_task_t *args = rq->special;
398                 if (args) {
399                         task_struct_t *tf = (task_struct_t *) args->tfRegister;
400                         opcode = tf->command;
401                         found = 1;
402                 }
403         }
404
405         printk("ide: failed opcode was: ");
406         if (!found)
407                 printk("unknown\n");
408         else
409                 printk("0x%02x\n", opcode);
410 }
411
412 static u8 ide_dump_ata_status(ide_drive_t *drive, const char *msg, u8 stat)
413 {
414         ide_hwif_t *hwif = HWIF(drive);
415         unsigned long flags;
416         u8 err = 0;
417
418         local_irq_save(flags);
419         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
420         if (stat & BUSY_STAT)
421                 printk("Busy ");
422         else {
423                 if (stat & READY_STAT)  printk("DriveReady ");
424                 if (stat & WRERR_STAT)  printk("DeviceFault ");
425                 if (stat & SEEK_STAT)   printk("SeekComplete ");
426                 if (stat & DRQ_STAT)    printk("DataRequest ");
427                 if (stat & ECC_STAT)    printk("CorrectedError ");
428                 if (stat & INDEX_STAT)  printk("Index ");
429                 if (stat & ERR_STAT)    printk("Error ");
430         }
431         printk("}\n");
432         if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
433                 err = hwif->INB(IDE_ERROR_REG);
434                 printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
435                 if (err & ABRT_ERR)     printk("DriveStatusError ");
436                 if (err & ICRC_ERR)
437                         printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
438                 if (err & ECC_ERR)      printk("UncorrectableError ");
439                 if (err & ID_ERR)       printk("SectorIdNotFound ");
440                 if (err & TRK0_ERR)     printk("TrackZeroNotFound ");
441                 if (err & MARK_ERR)     printk("AddrMarkNotFound ");
442                 printk("}");
443                 if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
444                     (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
445                         if (drive->addressing == 1) {
446                                 __u64 sectors = 0;
447                                 u32 low = 0, high = 0;
448                                 low = ide_read_24(drive);
449                                 hwif->OUTB(drive->ctl|0x80, IDE_CONTROL_REG);
450                                 high = ide_read_24(drive);
451                                 sectors = ((__u64)high << 24) | low;
452                                 printk(", LBAsect=%llu, high=%d, low=%d",
453                                        (unsigned long long) sectors,
454                                        high, low);
455                         } else {
456                                 u8 cur = hwif->INB(IDE_SELECT_REG);
457                                 if (cur & 0x40) {       /* using LBA? */
458                                         printk(", LBAsect=%ld", (unsigned long)
459                                          ((cur&0xf)<<24)
460                                          |(hwif->INB(IDE_HCYL_REG)<<16)
461                                          |(hwif->INB(IDE_LCYL_REG)<<8)
462                                          | hwif->INB(IDE_SECTOR_REG));
463                                 } else {
464                                         printk(", CHS=%d/%d/%d",
465                                          (hwif->INB(IDE_HCYL_REG)<<8) +
466                                           hwif->INB(IDE_LCYL_REG),
467                                           cur & 0xf,
468                                           hwif->INB(IDE_SECTOR_REG));
469                                 }
470                         }
471                         if (HWGROUP(drive) && HWGROUP(drive)->rq)
472                                 printk(", sector=%llu",
473                                         (unsigned long long)HWGROUP(drive)->rq->sector);
474                 }
475                 printk("\n");
476         }
477         ide_dump_opcode(drive);
478         local_irq_restore(flags);
479         return err;
480 }
481
482 /**
483  *      ide_dump_atapi_status       -       print human readable atapi status
484  *      @drive: drive that status applies to
485  *      @msg: text message to print
486  *      @stat: status byte to decode
487  *
488  *      Error reporting, in human readable form (luxurious, but a memory hog).
489  */
490
491 static u8 ide_dump_atapi_status(ide_drive_t *drive, const char *msg, u8 stat)
492 {
493         unsigned long flags;
494
495         atapi_status_t status;
496         atapi_error_t error;
497
498         status.all = stat;
499         error.all = 0;
500         local_irq_save(flags);
501         printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
502         if (status.b.bsy)
503                 printk("Busy ");
504         else {
505                 if (status.b.drdy)      printk("DriveReady ");
506                 if (status.b.df)        printk("DeviceFault ");
507                 if (status.b.dsc)       printk("SeekComplete ");
508                 if (status.b.drq)       printk("DataRequest ");
509                 if (status.b.corr)      printk("CorrectedError ");
510                 if (status.b.idx)       printk("Index ");
511                 if (status.b.check)     printk("Error ");
512         }
513         printk("}\n");
514         if (status.b.check && !status.b.bsy) {
515                 error.all = HWIF(drive)->INB(IDE_ERROR_REG);
516                 printk("%s: %s: error=0x%02x { ", drive->name, msg, error.all);
517                 if (error.b.ili)        printk("IllegalLengthIndication ");
518                 if (error.b.eom)        printk("EndOfMedia ");
519                 if (error.b.abrt)       printk("AbortedCommand ");
520                 if (error.b.mcr)        printk("MediaChangeRequested ");
521                 if (error.b.sense_key)  printk("LastFailedSense=0x%02x ",
522                                                 error.b.sense_key);
523                 printk("}\n");
524         }
525         ide_dump_opcode(drive);
526         local_irq_restore(flags);
527         return error.all;
528 }
529
530 /**
531  *      ide_dump_status         -       translate ATA/ATAPI error
532  *      @drive: drive the error occured on
533  *      @msg: information string
534  *      @stat: status byte
535  *
536  *      Error reporting, in human readable form (luxurious, but a memory hog).
537  *      Combines the drive name, message and status byte to provide a
538  *      user understandable explanation of the device error.
539  */
540
541 u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
542 {
543         if (drive->media == ide_disk)
544                 return ide_dump_ata_status(drive, msg, stat);
545         return ide_dump_atapi_status(drive, msg, stat);
546 }
547
548 EXPORT_SYMBOL(ide_dump_status);