]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/ide/ide-lib.c
bea5e13ee3613bd8ead4a800bf333ac7589829ef
[mirror_ubuntu-bionic-kernel.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 /*
209 * Standard (generic) timings for PIO modes, from ATA2 specification.
210 * These timings are for access to the IDE data port register *only*.
211 * Some drives may specify a mode, while also specifying a different
212 * value for cycle_time (from drive identification data).
213 */
214 const ide_pio_timings_t ide_pio_timings[6] = {
215 { 70, 165, 600 }, /* PIO Mode 0 */
216 { 50, 125, 383 }, /* PIO Mode 1 */
217 { 30, 100, 240 }, /* PIO Mode 2 */
218 { 30, 80, 180 }, /* PIO Mode 3 with IORDY */
219 { 25, 70, 120 }, /* PIO Mode 4 with IORDY */
220 { 20, 50, 100 } /* PIO Mode 5 with IORDY (nonstandard) */
221 };
222
223 EXPORT_SYMBOL_GPL(ide_pio_timings);
224
225 /*
226 * Shared data/functions for determining best PIO mode for an IDE drive.
227 * Most of this stuff originally lived in cmd640.c, and changes to the
228 * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
229 * breaking the fragile cmd640.c support.
230 */
231
232 /*
233 * Black list. Some drives incorrectly report their maximal PIO mode,
234 * at least in respect to CMD640. Here we keep info on some known drives.
235 */
236 static struct ide_pio_info {
237 const char *name;
238 int pio;
239 } ide_pio_blacklist [] = {
240 /* { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
241 { "Conner Peripherals 540MB - CFS540A", 3 },
242
243 { "WDC AC2700", 3 },
244 { "WDC AC2540", 3 },
245 { "WDC AC2420", 3 },
246 { "WDC AC2340", 3 },
247 { "WDC AC2250", 0 },
248 { "WDC AC2200", 0 },
249 { "WDC AC21200", 4 },
250 { "WDC AC2120", 0 },
251 { "WDC AC2850", 3 },
252 { "WDC AC1270", 3 },
253 { "WDC AC1170", 1 },
254 { "WDC AC1210", 1 },
255 { "WDC AC280", 0 },
256 /* { "WDC AC21000", 4 }, */
257 { "WDC AC31000", 3 },
258 { "WDC AC31200", 3 },
259 /* { "WDC AC31600", 4 }, */
260
261 { "Maxtor 7131 AT", 1 },
262 { "Maxtor 7171 AT", 1 },
263 { "Maxtor 7213 AT", 1 },
264 { "Maxtor 7245 AT", 1 },
265 { "Maxtor 7345 AT", 1 },
266 { "Maxtor 7546 AT", 3 },
267 { "Maxtor 7540 AV", 3 },
268
269 { "SAMSUNG SHD-3121A", 1 },
270 { "SAMSUNG SHD-3122A", 1 },
271 { "SAMSUNG SHD-3172A", 1 },
272
273 /* { "ST51080A", 4 },
274 * { "ST51270A", 4 },
275 * { "ST31220A", 4 },
276 * { "ST31640A", 4 },
277 * { "ST32140A", 4 },
278 * { "ST3780A", 4 },
279 */
280 { "ST5660A", 3 },
281 { "ST3660A", 3 },
282 { "ST3630A", 3 },
283 { "ST3655A", 3 },
284 { "ST3391A", 3 },
285 { "ST3390A", 1 },
286 { "ST3600A", 1 },
287 { "ST3290A", 0 },
288 { "ST3144A", 0 },
289 { "ST3491A", 1 }, /* reports 3, should be 1 or 2 (depending on */
290 /* drive) according to Seagates FIND-ATA program */
291
292 { "QUANTUM ELS127A", 0 },
293 { "QUANTUM ELS170A", 0 },
294 { "QUANTUM LPS240A", 0 },
295 { "QUANTUM LPS210A", 3 },
296 { "QUANTUM LPS270A", 3 },
297 { "QUANTUM LPS365A", 3 },
298 { "QUANTUM LPS540A", 3 },
299 { "QUANTUM LIGHTNING 540A", 3 },
300 { "QUANTUM LIGHTNING 730A", 3 },
301
302 { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
303 { "QUANTUM FIREBALL_640", 3 },
304 { "QUANTUM FIREBALL_1080", 3 },
305 { "QUANTUM FIREBALL_1280", 3 },
306 { NULL, 0 }
307 };
308
309 /**
310 * ide_scan_pio_blacklist - check for a blacklisted drive
311 * @model: Drive model string
312 *
313 * This routine searches the ide_pio_blacklist for an entry
314 * matching the start/whole of the supplied model name.
315 *
316 * Returns -1 if no match found.
317 * Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
318 */
319
320 static int ide_scan_pio_blacklist (char *model)
321 {
322 struct ide_pio_info *p;
323
324 for (p = ide_pio_blacklist; p->name != NULL; p++) {
325 if (strncmp(p->name, model, strlen(p->name)) == 0)
326 return p->pio;
327 }
328 return -1;
329 }
330
331 /**
332 * ide_get_best_pio_mode - get PIO mode from drive
333 * @driver: drive to consider
334 * @mode_wanted: preferred mode
335 * @max_mode: highest allowed
336 * @d: pio data
337 *
338 * This routine returns the recommended PIO settings for a given drive,
339 * based on the drive->id information and the ide_pio_blacklist[].
340 * This is used by most chipset support modules when "auto-tuning".
341 *
342 * Drive PIO mode auto selection
343 */
344
345 u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d)
346 {
347 int pio_mode;
348 int cycle_time = 0;
349 int use_iordy = 0;
350 struct hd_driveid* id = drive->id;
351 int overridden = 0;
352
353 if (mode_wanted != 255) {
354 pio_mode = mode_wanted;
355 } else if (!drive->id) {
356 pio_mode = 0;
357 } else if ((pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
358 overridden = 1;
359 use_iordy = (pio_mode > 2);
360 } else {
361 pio_mode = id->tPIO;
362 if (pio_mode > 2) { /* 2 is maximum allowed tPIO value */
363 pio_mode = 2;
364 overridden = 1;
365 }
366 if (id->field_valid & 2) { /* drive implements ATA2? */
367 if (id->capability & 8) { /* drive supports use_iordy? */
368 use_iordy = 1;
369 cycle_time = id->eide_pio_iordy;
370 if (id->eide_pio_modes & 7) {
371 overridden = 0;
372 if (id->eide_pio_modes & 4)
373 pio_mode = 5;
374 else if (id->eide_pio_modes & 2)
375 pio_mode = 4;
376 else
377 pio_mode = 3;
378 }
379 } else {
380 cycle_time = id->eide_pio;
381 }
382 }
383
384 #if 0
385 if (drive->id->major_rev_num & 0x0004) printk("ATA-2 ");
386 #endif
387
388 /*
389 * Conservative "downgrade" for all pre-ATA2 drives
390 */
391 if (pio_mode && pio_mode < 4) {
392 pio_mode--;
393 overridden = 1;
394 #if 0
395 use_iordy = (pio_mode > 2);
396 #endif
397 if (cycle_time && cycle_time < ide_pio_timings[pio_mode].cycle_time)
398 cycle_time = 0; /* use standard timing */
399 }
400 }
401 if (pio_mode > max_mode) {
402 pio_mode = max_mode;
403 cycle_time = 0;
404 }
405 if (d) {
406 d->pio_mode = pio_mode;
407 d->cycle_time = cycle_time ? cycle_time : ide_pio_timings[pio_mode].cycle_time;
408 d->use_iordy = use_iordy;
409 d->overridden = overridden;
410 }
411 return pio_mode;
412 }
413
414 EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
415
416 /**
417 * ide_toggle_bounce - handle bounce buffering
418 * @drive: drive to update
419 * @on: on/off boolean
420 *
421 * Enable or disable bounce buffering for the device. Drives move
422 * between PIO and DMA and that changes the rules we need.
423 */
424
425 void ide_toggle_bounce(ide_drive_t *drive, int on)
426 {
427 u64 addr = BLK_BOUNCE_HIGH; /* dma64_addr_t */
428
429 if (!PCI_DMA_BUS_IS_PHYS) {
430 addr = BLK_BOUNCE_ANY;
431 } else if (on && drive->media == ide_disk) {
432 if (HWIF(drive)->pci_dev)
433 addr = HWIF(drive)->pci_dev->dma_mask;
434 }
435
436 if (drive->queue)
437 blk_queue_bounce_limit(drive->queue, addr);
438 }
439
440 /**
441 * ide_set_xfer_rate - set transfer rate
442 * @drive: drive to set
443 * @speed: speed to attempt to set
444 *
445 * General helper for setting the speed of an IDE device. This
446 * function knows about user enforced limits from the configuration
447 * which speedproc() does not. High level drivers should never
448 * invoke speedproc() directly.
449 */
450
451 int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
452 {
453 #ifndef CONFIG_BLK_DEV_IDEDMA
454 rate = min(rate, (u8) XFER_PIO_4);
455 #endif
456 if(HWIF(drive)->speedproc)
457 return HWIF(drive)->speedproc(drive, rate);
458 else
459 return -1;
460 }
461
462 static void ide_dump_opcode(ide_drive_t *drive)
463 {
464 struct request *rq;
465 u8 opcode = 0;
466 int found = 0;
467
468 spin_lock(&ide_lock);
469 rq = NULL;
470 if (HWGROUP(drive))
471 rq = HWGROUP(drive)->rq;
472 spin_unlock(&ide_lock);
473 if (!rq)
474 return;
475 if (rq->cmd_type == REQ_TYPE_ATA_CMD ||
476 rq->cmd_type == REQ_TYPE_ATA_TASK) {
477 char *args = rq->buffer;
478 if (args) {
479 opcode = args[0];
480 found = 1;
481 }
482 } else if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE) {
483 ide_task_t *args = rq->special;
484 if (args) {
485 task_struct_t *tf = (task_struct_t *) args->tfRegister;
486 opcode = tf->command;
487 found = 1;
488 }
489 }
490
491 printk("ide: failed opcode was: ");
492 if (!found)
493 printk("unknown\n");
494 else
495 printk("0x%02x\n", opcode);
496 }
497
498 static u8 ide_dump_ata_status(ide_drive_t *drive, const char *msg, u8 stat)
499 {
500 ide_hwif_t *hwif = HWIF(drive);
501 unsigned long flags;
502 u8 err = 0;
503
504 local_irq_save(flags);
505 printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
506 if (stat & BUSY_STAT)
507 printk("Busy ");
508 else {
509 if (stat & READY_STAT) printk("DriveReady ");
510 if (stat & WRERR_STAT) printk("DeviceFault ");
511 if (stat & SEEK_STAT) printk("SeekComplete ");
512 if (stat & DRQ_STAT) printk("DataRequest ");
513 if (stat & ECC_STAT) printk("CorrectedError ");
514 if (stat & INDEX_STAT) printk("Index ");
515 if (stat & ERR_STAT) printk("Error ");
516 }
517 printk("}\n");
518 if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
519 err = hwif->INB(IDE_ERROR_REG);
520 printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
521 if (err & ABRT_ERR) printk("DriveStatusError ");
522 if (err & ICRC_ERR)
523 printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
524 if (err & ECC_ERR) printk("UncorrectableError ");
525 if (err & ID_ERR) printk("SectorIdNotFound ");
526 if (err & TRK0_ERR) printk("TrackZeroNotFound ");
527 if (err & MARK_ERR) printk("AddrMarkNotFound ");
528 printk("}");
529 if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
530 (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
531 if (drive->addressing == 1) {
532 __u64 sectors = 0;
533 u32 low = 0, high = 0;
534 low = ide_read_24(drive);
535 hwif->OUTB(drive->ctl|0x80, IDE_CONTROL_REG);
536 high = ide_read_24(drive);
537 sectors = ((__u64)high << 24) | low;
538 printk(", LBAsect=%llu, high=%d, low=%d",
539 (unsigned long long) sectors,
540 high, low);
541 } else {
542 u8 cur = hwif->INB(IDE_SELECT_REG);
543 if (cur & 0x40) { /* using LBA? */
544 printk(", LBAsect=%ld", (unsigned long)
545 ((cur&0xf)<<24)
546 |(hwif->INB(IDE_HCYL_REG)<<16)
547 |(hwif->INB(IDE_LCYL_REG)<<8)
548 | hwif->INB(IDE_SECTOR_REG));
549 } else {
550 printk(", CHS=%d/%d/%d",
551 (hwif->INB(IDE_HCYL_REG)<<8) +
552 hwif->INB(IDE_LCYL_REG),
553 cur & 0xf,
554 hwif->INB(IDE_SECTOR_REG));
555 }
556 }
557 if (HWGROUP(drive) && HWGROUP(drive)->rq)
558 printk(", sector=%llu",
559 (unsigned long long)HWGROUP(drive)->rq->sector);
560 }
561 printk("\n");
562 }
563 ide_dump_opcode(drive);
564 local_irq_restore(flags);
565 return err;
566 }
567
568 /**
569 * ide_dump_atapi_status - print human readable atapi status
570 * @drive: drive that status applies to
571 * @msg: text message to print
572 * @stat: status byte to decode
573 *
574 * Error reporting, in human readable form (luxurious, but a memory hog).
575 */
576
577 static u8 ide_dump_atapi_status(ide_drive_t *drive, const char *msg, u8 stat)
578 {
579 unsigned long flags;
580
581 atapi_status_t status;
582 atapi_error_t error;
583
584 status.all = stat;
585 error.all = 0;
586 local_irq_save(flags);
587 printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
588 if (status.b.bsy)
589 printk("Busy ");
590 else {
591 if (status.b.drdy) printk("DriveReady ");
592 if (status.b.df) printk("DeviceFault ");
593 if (status.b.dsc) printk("SeekComplete ");
594 if (status.b.drq) printk("DataRequest ");
595 if (status.b.corr) printk("CorrectedError ");
596 if (status.b.idx) printk("Index ");
597 if (status.b.check) printk("Error ");
598 }
599 printk("}\n");
600 if (status.b.check && !status.b.bsy) {
601 error.all = HWIF(drive)->INB(IDE_ERROR_REG);
602 printk("%s: %s: error=0x%02x { ", drive->name, msg, error.all);
603 if (error.b.ili) printk("IllegalLengthIndication ");
604 if (error.b.eom) printk("EndOfMedia ");
605 if (error.b.abrt) printk("AbortedCommand ");
606 if (error.b.mcr) printk("MediaChangeRequested ");
607 if (error.b.sense_key) printk("LastFailedSense=0x%02x ",
608 error.b.sense_key);
609 printk("}\n");
610 }
611 ide_dump_opcode(drive);
612 local_irq_restore(flags);
613 return error.all;
614 }
615
616 /**
617 * ide_dump_status - translate ATA/ATAPI error
618 * @drive: drive the error occured on
619 * @msg: information string
620 * @stat: status byte
621 *
622 * Error reporting, in human readable form (luxurious, but a memory hog).
623 * Combines the drive name, message and status byte to provide a
624 * user understandable explanation of the device error.
625 */
626
627 u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
628 {
629 if (drive->media == ide_disk)
630 return ide_dump_ata_status(drive, msg, stat);
631 return ide_dump_atapi_status(drive, msg, stat);
632 }
633
634 EXPORT_SYMBOL(ide_dump_status);