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