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