ACPI: add support for Smart Battery
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / ide / ide-lib.c
blob1feff23487d44f515574809e153744a615c7ad26
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>
19 #include <asm/byteorder.h>
20 #include <asm/irq.h>
21 #include <asm/uaccess.h>
22 #include <asm/io.h>
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
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
34 /**
35 * ide_xfer_verbose - return IDE mode names
36 * @xfer_rate: rate to name
38 * Returns a constant string giving the name of the mode
39 * requested.
42 char *ide_xfer_verbose (u8 xfer_rate)
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");
69 EXPORT_SYMBOL(ide_xfer_verbose);
71 /**
72 * ide_dma_speed - compute DMA speed
73 * @drive: drive
74 * @mode; intended mode
76 * Checks the drive capabilities and returns the speed to use
77 * for the transfer. Returns -1 if the requested mode is unknown
78 * (eg PIO)
81 u8 ide_dma_speed(ide_drive_t *drive, u8 mode)
83 struct hd_driveid *id = drive->id;
84 ide_hwif_t *hwif = HWIF(drive);
85 u8 speed = 0;
87 if (drive->media != ide_disk && hwif->atapi_dma == 0)
88 return 0;
90 switch(mode) {
91 case 0x04:
92 if ((id->dma_ultra & 0x0040) &&
93 (id->dma_ultra & hwif->ultra_mask))
94 { speed = XFER_UDMA_6; break; }
95 case 0x03:
96 if ((id->dma_ultra & 0x0020) &&
97 (id->dma_ultra & hwif->ultra_mask))
98 { speed = XFER_UDMA_5; break; }
99 case 0x02:
100 if ((id->dma_ultra & 0x0010) &&
101 (id->dma_ultra & hwif->ultra_mask))
102 { speed = XFER_UDMA_4; break; }
103 if ((id->dma_ultra & 0x0008) &&
104 (id->dma_ultra & hwif->ultra_mask))
105 { speed = XFER_UDMA_3; break; }
106 case 0x01:
107 if ((id->dma_ultra & 0x0004) &&
108 (id->dma_ultra & hwif->ultra_mask))
109 { speed = XFER_UDMA_2; break; }
110 if ((id->dma_ultra & 0x0002) &&
111 (id->dma_ultra & hwif->ultra_mask))
112 { speed = XFER_UDMA_1; break; }
113 if ((id->dma_ultra & 0x0001) &&
114 (id->dma_ultra & hwif->ultra_mask))
115 { speed = XFER_UDMA_0; break; }
116 case 0x00:
117 if ((id->dma_mword & 0x0004) &&
118 (id->dma_mword & hwif->mwdma_mask))
119 { speed = XFER_MW_DMA_2; break; }
120 if ((id->dma_mword & 0x0002) &&
121 (id->dma_mword & hwif->mwdma_mask))
122 { speed = XFER_MW_DMA_1; break; }
123 if ((id->dma_mword & 0x0001) &&
124 (id->dma_mword & hwif->mwdma_mask))
125 { speed = XFER_MW_DMA_0; break; }
126 if ((id->dma_1word & 0x0004) &&
127 (id->dma_1word & hwif->swdma_mask))
128 { speed = XFER_SW_DMA_2; break; }
129 if ((id->dma_1word & 0x0002) &&
130 (id->dma_1word & hwif->swdma_mask))
131 { speed = XFER_SW_DMA_1; break; }
132 if ((id->dma_1word & 0x0001) &&
133 (id->dma_1word & hwif->swdma_mask))
134 { speed = XFER_SW_DMA_0; break; }
137 // printk("%s: %s: mode 0x%02x, speed 0x%02x\n",
138 // __FUNCTION__, drive->name, mode, speed);
140 return speed;
143 EXPORT_SYMBOL(ide_dma_speed);
147 * ide_rate_filter - return best speed for mode
148 * @mode: modes available
149 * @speed: desired speed
151 * Given the available DMA/UDMA mode this function returns
152 * the best available speed at or below the speed requested.
155 u8 ide_rate_filter (u8 mode, u8 speed)
157 #ifdef CONFIG_BLK_DEV_IDEDMA
158 static u8 speed_max[] = {
159 XFER_MW_DMA_2, XFER_UDMA_2, XFER_UDMA_4,
160 XFER_UDMA_5, XFER_UDMA_6
163 // printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);
165 /* So that we remember to update this if new modes appear */
166 BUG_ON(mode > 4);
167 return min(speed, speed_max[mode]);
168 #else /* !CONFIG_BLK_DEV_IDEDMA */
169 return min(speed, (u8)XFER_PIO_4);
170 #endif /* CONFIG_BLK_DEV_IDEDMA */
173 EXPORT_SYMBOL(ide_rate_filter);
175 int ide_dma_enable (ide_drive_t *drive)
177 ide_hwif_t *hwif = HWIF(drive);
178 struct hd_driveid *id = drive->id;
180 return ((int) ((((id->dma_ultra >> 8) & hwif->ultra_mask) ||
181 ((id->dma_mword >> 8) & hwif->mwdma_mask) ||
182 ((id->dma_1word >> 8) & hwif->swdma_mask)) ? 1 : 0));
185 EXPORT_SYMBOL(ide_dma_enable);
188 * Standard (generic) timings for PIO modes, from ATA2 specification.
189 * These timings are for access to the IDE data port register *only*.
190 * Some drives may specify a mode, while also specifying a different
191 * value for cycle_time (from drive identification data).
193 const ide_pio_timings_t ide_pio_timings[6] = {
194 { 70, 165, 600 }, /* PIO Mode 0 */
195 { 50, 125, 383 }, /* PIO Mode 1 */
196 { 30, 100, 240 }, /* PIO Mode 2 */
197 { 30, 80, 180 }, /* PIO Mode 3 with IORDY */
198 { 25, 70, 120 }, /* PIO Mode 4 with IORDY */
199 { 20, 50, 100 } /* PIO Mode 5 with IORDY (nonstandard) */
202 EXPORT_SYMBOL_GPL(ide_pio_timings);
205 * Shared data/functions for determining best PIO mode for an IDE drive.
206 * Most of this stuff originally lived in cmd640.c, and changes to the
207 * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
208 * breaking the fragile cmd640.c support.
212 * Black list. Some drives incorrectly report their maximal PIO mode,
213 * at least in respect to CMD640. Here we keep info on some known drives.
215 static struct ide_pio_info {
216 const char *name;
217 int pio;
218 } ide_pio_blacklist [] = {
219 /* { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
220 { "Conner Peripherals 540MB - CFS540A", 3 },
222 { "WDC AC2700", 3 },
223 { "WDC AC2540", 3 },
224 { "WDC AC2420", 3 },
225 { "WDC AC2340", 3 },
226 { "WDC AC2250", 0 },
227 { "WDC AC2200", 0 },
228 { "WDC AC21200", 4 },
229 { "WDC AC2120", 0 },
230 { "WDC AC2850", 3 },
231 { "WDC AC1270", 3 },
232 { "WDC AC1170", 1 },
233 { "WDC AC1210", 1 },
234 { "WDC AC280", 0 },
235 /* { "WDC AC21000", 4 }, */
236 { "WDC AC31000", 3 },
237 { "WDC AC31200", 3 },
238 /* { "WDC AC31600", 4 }, */
240 { "Maxtor 7131 AT", 1 },
241 { "Maxtor 7171 AT", 1 },
242 { "Maxtor 7213 AT", 1 },
243 { "Maxtor 7245 AT", 1 },
244 { "Maxtor 7345 AT", 1 },
245 { "Maxtor 7546 AT", 3 },
246 { "Maxtor 7540 AV", 3 },
248 { "SAMSUNG SHD-3121A", 1 },
249 { "SAMSUNG SHD-3122A", 1 },
250 { "SAMSUNG SHD-3172A", 1 },
252 /* { "ST51080A", 4 },
253 * { "ST51270A", 4 },
254 * { "ST31220A", 4 },
255 * { "ST31640A", 4 },
256 * { "ST32140A", 4 },
257 * { "ST3780A", 4 },
259 { "ST5660A", 3 },
260 { "ST3660A", 3 },
261 { "ST3630A", 3 },
262 { "ST3655A", 3 },
263 { "ST3391A", 3 },
264 { "ST3390A", 1 },
265 { "ST3600A", 1 },
266 { "ST3290A", 0 },
267 { "ST3144A", 0 },
268 { "ST3491A", 1 }, /* reports 3, should be 1 or 2 (depending on */
269 /* drive) according to Seagates FIND-ATA program */
271 { "QUANTUM ELS127A", 0 },
272 { "QUANTUM ELS170A", 0 },
273 { "QUANTUM LPS240A", 0 },
274 { "QUANTUM LPS210A", 3 },
275 { "QUANTUM LPS270A", 3 },
276 { "QUANTUM LPS365A", 3 },
277 { "QUANTUM LPS540A", 3 },
278 { "QUANTUM LIGHTNING 540A", 3 },
279 { "QUANTUM LIGHTNING 730A", 3 },
281 { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
282 { "QUANTUM FIREBALL_640", 3 },
283 { "QUANTUM FIREBALL_1080", 3 },
284 { "QUANTUM FIREBALL_1280", 3 },
285 { NULL, 0 }
289 * ide_scan_pio_blacklist - check for a blacklisted drive
290 * @model: Drive model string
292 * This routine searches the ide_pio_blacklist for an entry
293 * matching the start/whole of the supplied model name.
295 * Returns -1 if no match found.
296 * Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
299 static int ide_scan_pio_blacklist (char *model)
301 struct ide_pio_info *p;
303 for (p = ide_pio_blacklist; p->name != NULL; p++) {
304 if (strncmp(p->name, model, strlen(p->name)) == 0)
305 return p->pio;
307 return -1;
311 * ide_get_best_pio_mode - get PIO mode from drive
312 * @driver: drive to consider
313 * @mode_wanted: preferred mode
314 * @max_mode: highest allowed
315 * @d: pio data
317 * This routine returns the recommended PIO settings for a given drive,
318 * based on the drive->id information and the ide_pio_blacklist[].
319 * This is used by most chipset support modules when "auto-tuning".
321 * Drive PIO mode auto selection
324 u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d)
326 int pio_mode;
327 int cycle_time = 0;
328 int use_iordy = 0;
329 struct hd_driveid* id = drive->id;
330 int overridden = 0;
331 int blacklisted = 0;
333 if (mode_wanted != 255) {
334 pio_mode = mode_wanted;
335 } else if (!drive->id) {
336 pio_mode = 0;
337 } else if ((pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
338 overridden = 1;
339 blacklisted = 1;
340 use_iordy = (pio_mode > 2);
341 } else {
342 pio_mode = id->tPIO;
343 if (pio_mode > 2) { /* 2 is maximum allowed tPIO value */
344 pio_mode = 2;
345 overridden = 1;
347 if (id->field_valid & 2) { /* drive implements ATA2? */
348 if (id->capability & 8) { /* drive supports use_iordy? */
349 use_iordy = 1;
350 cycle_time = id->eide_pio_iordy;
351 if (id->eide_pio_modes & 7) {
352 overridden = 0;
353 if (id->eide_pio_modes & 4)
354 pio_mode = 5;
355 else if (id->eide_pio_modes & 2)
356 pio_mode = 4;
357 else
358 pio_mode = 3;
360 } else {
361 cycle_time = id->eide_pio;
365 #if 0
366 if (drive->id->major_rev_num & 0x0004) printk("ATA-2 ");
367 #endif
370 * Conservative "downgrade" for all pre-ATA2 drives
372 if (pio_mode && pio_mode < 4) {
373 pio_mode--;
374 overridden = 1;
375 #if 0
376 use_iordy = (pio_mode > 2);
377 #endif
378 if (cycle_time && cycle_time < ide_pio_timings[pio_mode].cycle_time)
379 cycle_time = 0; /* use standard timing */
382 if (pio_mode > max_mode) {
383 pio_mode = max_mode;
384 cycle_time = 0;
386 if (d) {
387 d->pio_mode = pio_mode;
388 d->cycle_time = cycle_time ? cycle_time : ide_pio_timings[pio_mode].cycle_time;
389 d->use_iordy = use_iordy;
390 d->overridden = overridden;
391 d->blacklisted = blacklisted;
393 return pio_mode;
396 EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
399 * ide_toggle_bounce - handle bounce buffering
400 * @drive: drive to update
401 * @on: on/off boolean
403 * Enable or disable bounce buffering for the device. Drives move
404 * between PIO and DMA and that changes the rules we need.
407 void ide_toggle_bounce(ide_drive_t *drive, int on)
409 u64 addr = BLK_BOUNCE_HIGH; /* dma64_addr_t */
411 if (!PCI_DMA_BUS_IS_PHYS) {
412 addr = BLK_BOUNCE_ANY;
413 } else if (on && drive->media == ide_disk) {
414 if (HWIF(drive)->pci_dev)
415 addr = HWIF(drive)->pci_dev->dma_mask;
418 if (drive->queue)
419 blk_queue_bounce_limit(drive->queue, addr);
423 * ide_set_xfer_rate - set transfer rate
424 * @drive: drive to set
425 * @speed: speed to attempt to set
427 * General helper for setting the speed of an IDE device. This
428 * function knows about user enforced limits from the configuration
429 * which speedproc() does not. High level drivers should never
430 * invoke speedproc() directly.
433 int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
435 #ifndef CONFIG_BLK_DEV_IDEDMA
436 rate = min(rate, (u8) XFER_PIO_4);
437 #endif
438 if(HWIF(drive)->speedproc)
439 return HWIF(drive)->speedproc(drive, rate);
440 else
441 return -1;
444 EXPORT_SYMBOL_GPL(ide_set_xfer_rate);
446 static void ide_dump_opcode(ide_drive_t *drive)
448 struct request *rq;
449 u8 opcode = 0;
450 int found = 0;
452 spin_lock(&ide_lock);
453 rq = NULL;
454 if (HWGROUP(drive))
455 rq = HWGROUP(drive)->rq;
456 spin_unlock(&ide_lock);
457 if (!rq)
458 return;
459 if (rq->flags & (REQ_DRIVE_CMD | REQ_DRIVE_TASK)) {
460 char *args = rq->buffer;
461 if (args) {
462 opcode = args[0];
463 found = 1;
465 } else if (rq->flags & REQ_DRIVE_TASKFILE) {
466 ide_task_t *args = rq->special;
467 if (args) {
468 task_struct_t *tf = (task_struct_t *) args->tfRegister;
469 opcode = tf->command;
470 found = 1;
474 printk("ide: failed opcode was: ");
475 if (!found)
476 printk("unknown\n");
477 else
478 printk("0x%02x\n", opcode);
481 static u8 ide_dump_ata_status(ide_drive_t *drive, const char *msg, u8 stat)
483 ide_hwif_t *hwif = HWIF(drive);
484 unsigned long flags;
485 u8 err = 0;
487 local_irq_save(flags);
488 printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
489 if (stat & BUSY_STAT)
490 printk("Busy ");
491 else {
492 if (stat & READY_STAT) printk("DriveReady ");
493 if (stat & WRERR_STAT) printk("DeviceFault ");
494 if (stat & SEEK_STAT) printk("SeekComplete ");
495 if (stat & DRQ_STAT) printk("DataRequest ");
496 if (stat & ECC_STAT) printk("CorrectedError ");
497 if (stat & INDEX_STAT) printk("Index ");
498 if (stat & ERR_STAT) printk("Error ");
500 printk("}\n");
501 if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
502 err = hwif->INB(IDE_ERROR_REG);
503 printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
504 if (err & ABRT_ERR) printk("DriveStatusError ");
505 if (err & ICRC_ERR)
506 printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
507 if (err & ECC_ERR) printk("UncorrectableError ");
508 if (err & ID_ERR) printk("SectorIdNotFound ");
509 if (err & TRK0_ERR) printk("TrackZeroNotFound ");
510 if (err & MARK_ERR) printk("AddrMarkNotFound ");
511 printk("}");
512 if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
513 (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
514 if (drive->addressing == 1) {
515 __u64 sectors = 0;
516 u32 low = 0, high = 0;
517 low = ide_read_24(drive);
518 hwif->OUTB(drive->ctl|0x80, IDE_CONTROL_REG);
519 high = ide_read_24(drive);
520 sectors = ((__u64)high << 24) | low;
521 printk(", LBAsect=%llu, high=%d, low=%d",
522 (unsigned long long) sectors,
523 high, low);
524 } else {
525 u8 cur = hwif->INB(IDE_SELECT_REG);
526 if (cur & 0x40) { /* using LBA? */
527 printk(", LBAsect=%ld", (unsigned long)
528 ((cur&0xf)<<24)
529 |(hwif->INB(IDE_HCYL_REG)<<16)
530 |(hwif->INB(IDE_LCYL_REG)<<8)
531 | hwif->INB(IDE_SECTOR_REG));
532 } else {
533 printk(", CHS=%d/%d/%d",
534 (hwif->INB(IDE_HCYL_REG)<<8) +
535 hwif->INB(IDE_LCYL_REG),
536 cur & 0xf,
537 hwif->INB(IDE_SECTOR_REG));
540 if (HWGROUP(drive) && HWGROUP(drive)->rq)
541 printk(", sector=%llu",
542 (unsigned long long)HWGROUP(drive)->rq->sector);
544 printk("\n");
546 ide_dump_opcode(drive);
547 local_irq_restore(flags);
548 return err;
552 * ide_dump_atapi_status - print human readable atapi status
553 * @drive: drive that status applies to
554 * @msg: text message to print
555 * @stat: status byte to decode
557 * Error reporting, in human readable form (luxurious, but a memory hog).
560 static u8 ide_dump_atapi_status(ide_drive_t *drive, const char *msg, u8 stat)
562 unsigned long flags;
564 atapi_status_t status;
565 atapi_error_t error;
567 status.all = stat;
568 error.all = 0;
569 local_irq_save(flags);
570 printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
571 if (status.b.bsy)
572 printk("Busy ");
573 else {
574 if (status.b.drdy) printk("DriveReady ");
575 if (status.b.df) printk("DeviceFault ");
576 if (status.b.dsc) printk("SeekComplete ");
577 if (status.b.drq) printk("DataRequest ");
578 if (status.b.corr) printk("CorrectedError ");
579 if (status.b.idx) printk("Index ");
580 if (status.b.check) printk("Error ");
582 printk("}\n");
583 if (status.b.check && !status.b.bsy) {
584 error.all = HWIF(drive)->INB(IDE_ERROR_REG);
585 printk("%s: %s: error=0x%02x { ", drive->name, msg, error.all);
586 if (error.b.ili) printk("IllegalLengthIndication ");
587 if (error.b.eom) printk("EndOfMedia ");
588 if (error.b.abrt) printk("AbortedCommand ");
589 if (error.b.mcr) printk("MediaChangeRequested ");
590 if (error.b.sense_key) printk("LastFailedSense=0x%02x ",
591 error.b.sense_key);
592 printk("}\n");
594 ide_dump_opcode(drive);
595 local_irq_restore(flags);
596 return error.all;
600 * ide_dump_status - translate ATA/ATAPI error
601 * @drive: drive the error occured on
602 * @msg: information string
603 * @stat: status byte
605 * Error reporting, in human readable form (luxurious, but a memory hog).
606 * Combines the drive name, message and status byte to provide a
607 * user understandable explanation of the device error.
610 u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
612 if (drive->media == ide_disk)
613 return ide_dump_ata_status(drive, msg, stat);
614 return ide_dump_atapi_status(drive, msg, stat);
617 EXPORT_SYMBOL(ide_dump_status);