[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / ide / ide-lib.c

#include <linux/module.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/kernel.h>
#include <linux/timer.h>
#include <linux/mm.h>
#include <linux/interrupt.h>
#include <linux/major.h>
#include <linux/errno.h>
#include <linux/genhd.h>
#include <linux/blkpg.h>
#include <linux/slab.h>
#include <linux/pci.h>
#include <linux/delay.h>
#include <linux/hdreg.h>
#include <linux/ide.h>
#include <linux/bitops.h>

#include <asm/byteorder.h>
#include <asm/irq.h>
#include <asm/uaccess.h>
#include <asm/io.h>

/*
 *	IDE library routines. These are plug in code that most 
 *	drivers can use but occasionally may be weird enough
 *	to want to do their own thing with
 *
 *	Add common non I/O op stuff here. Make sure it has proper
 *	kernel-doc function headers or your patch will be rejected
 */

static const char *udma_str[] =
	 { "UDMA/16", "UDMA/25",  "UDMA/33",  "UDMA/44",
	   "UDMA/66", "UDMA/100", "UDMA/133", "UDMA7" };
static const char *mwdma_str[] =
	{ "MWDMA0", "MWDMA1", "MWDMA2" };
static const char *swdma_str[] =
	{ "SWDMA0", "SWDMA1", "SWDMA2" };
static const char *pio_str[] =
	{ "PIO0", "PIO1", "PIO2", "PIO3", "PIO4", "PIO5" };

/**
 *	ide_xfer_verbose	-	return IDE mode names
 *	@mode: transfer mode
 *
 *	Returns a constant string giving the name of the mode
 *	requested.
 */

const char *ide_xfer_verbose(u8 mode)
{
	const char *s;
	u8 i = mode & 0xf;

	if (mode >= XFER_UDMA_0 && mode <= XFER_UDMA_7)
		s = udma_str[i];
	else if (mode >= XFER_MW_DMA_0 && mode <= XFER_MW_DMA_2)
		s = mwdma_str[i];
	else if (mode >= XFER_SW_DMA_0 && mode <= XFER_SW_DMA_2)
		s = swdma_str[i];
	else if (mode >= XFER_PIO_0 && mode <= XFER_PIO_5)
		s = pio_str[i & 0x7];
	else if (mode == XFER_PIO_SLOW)
		s = "PIO SLOW";
	else
		s = "XFER ERROR";

	return s;
}

EXPORT_SYMBOL(ide_xfer_verbose);

/**
 *	ide_rate_filter		-	filter transfer mode
 *	@drive: IDE device
 *	@speed: desired speed
 *
 *	Given the available transfer modes this function returns
 *	the best available speed at or below the speed requested.
 *
 *	TODO: check device PIO capabilities
 */

static u8 ide_rate_filter(ide_drive_t *drive, u8 speed)
{
	ide_hwif_t *hwif = drive->hwif;
	u8 mode = ide_find_dma_mode(drive, speed);

	if (mode == 0) {
		if (hwif->pio_mask)
			mode = fls(hwif->pio_mask) - 1 + XFER_PIO_0;
		else
			mode = XFER_PIO_4;
	}

//	printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);

	return min(speed, mode);
}

/*
 * Standard (generic) timings for PIO modes, from ATA2 specification.
 * These timings are for access to the IDE data port register *only*.
 * Some drives may specify a mode, while also specifying a different
 * value for cycle_time (from drive identification data).
 */
const ide_pio_timings_t ide_pio_timings[6] = {
	{ 70,	165,	600 },	/* PIO Mode 0 */
	{ 50,	125,	383 },	/* PIO Mode 1 */
	{ 30,	100,	240 },	/* PIO Mode 2 */
	{ 30,	80,	180 },	/* PIO Mode 3 with IORDY */
	{ 25,	70,	120 },	/* PIO Mode 4 with IORDY */
	{ 20,	50,	100 }	/* PIO Mode 5 with IORDY (nonstandard) */
};

EXPORT_SYMBOL_GPL(ide_pio_timings);

/*
 * Shared data/functions for determining best PIO mode for an IDE drive.
 * Most of this stuff originally lived in cmd640.c, and changes to the
 * ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
 * breaking the fragile cmd640.c support.
 */

/*
 * Black list. Some drives incorrectly report their maximal PIO mode,
 * at least in respect to CMD640. Here we keep info on some known drives.
 */
static struct ide_pio_info {
	const char	*name;
	int		pio;
} ide_pio_blacklist [] = {
/*	{ "Conner Peripherals 1275MB - CFS1275A", 4 }, */
	{ "Conner Peripherals 540MB - CFS540A", 3 },

	{ "WDC AC2700",  3 },
	{ "WDC AC2540",  3 },
	{ "WDC AC2420",  3 },
	{ "WDC AC2340",  3 },
	{ "WDC AC2250",  0 },
	{ "WDC AC2200",  0 },
	{ "WDC AC21200", 4 },
	{ "WDC AC2120",  0 },
	{ "WDC AC2850",  3 },
	{ "WDC AC1270",  3 },
	{ "WDC AC1170",  1 },
	{ "WDC AC1210",  1 },
	{ "WDC AC280",   0 },
/*	{ "WDC AC21000", 4 }, */
	{ "WDC AC31000", 3 },
	{ "WDC AC31200", 3 },
/*	{ "WDC AC31600", 4 }, */

	{ "Maxtor 7131 AT", 1 },
	{ "Maxtor 7171 AT", 1 },
	{ "Maxtor 7213 AT", 1 },
	{ "Maxtor 7245 AT", 1 },
	{ "Maxtor 7345 AT", 1 },
	{ "Maxtor 7546 AT", 3 },
	{ "Maxtor 7540 AV", 3 },

	{ "SAMSUNG SHD-3121A", 1 },
	{ "SAMSUNG SHD-3122A", 1 },
	{ "SAMSUNG SHD-3172A", 1 },

/*	{ "ST51080A", 4 },
 *	{ "ST51270A", 4 },
 *	{ "ST31220A", 4 },
 *	{ "ST31640A", 4 },
 *	{ "ST32140A", 4 },
 *	{ "ST3780A",  4 },
 */
	{ "ST5660A",  3 },
	{ "ST3660A",  3 },
	{ "ST3630A",  3 },
	{ "ST3655A",  3 },
	{ "ST3391A",  3 },
	{ "ST3390A",  1 },
	{ "ST3600A",  1 },
	{ "ST3290A",  0 },
	{ "ST3144A",  0 },
	{ "ST3491A",  1 },	/* reports 3, should be 1 or 2 (depending on */	
				/* drive) according to Seagates FIND-ATA program */

	{ "QUANTUM ELS127A", 0 },
	{ "QUANTUM ELS170A", 0 },
	{ "QUANTUM LPS240A", 0 },
	{ "QUANTUM LPS210A", 3 },
	{ "QUANTUM LPS270A", 3 },
	{ "QUANTUM LPS365A", 3 },
	{ "QUANTUM LPS540A", 3 },
	{ "QUANTUM LIGHTNING 540A", 3 },
	{ "QUANTUM LIGHTNING 730A", 3 },

        { "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
        { "QUANTUM FIREBALL_640", 3 }, 
        { "QUANTUM FIREBALL_1080", 3 },
        { "QUANTUM FIREBALL_1280", 3 },
	{ NULL,	0 }
};

/**
 *	ide_scan_pio_blacklist 	-	check for a blacklisted drive
 *	@model: Drive model string
 *
 *	This routine searches the ide_pio_blacklist for an entry
 *	matching the start/whole of the supplied model name.
 *
 *	Returns -1 if no match found.
 *	Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
 */

static int ide_scan_pio_blacklist (char *model)
{
	struct ide_pio_info *p;

	for (p = ide_pio_blacklist; p->name != NULL; p++) {
		if (strncmp(p->name, model, strlen(p->name)) == 0)
			return p->pio;
	}
	return -1;
}

unsigned int ide_pio_cycle_time(ide_drive_t *drive, u8 pio)
{
	struct hd_driveid *id = drive->id;
	int cycle_time = 0;

	if (id->field_valid & 2) {
		if (id->capability & 8)
			cycle_time = id->eide_pio_iordy;
		else
			cycle_time = id->eide_pio;
	}

	/* conservative "downgrade" for all pre-ATA2 drives */
	if (pio < 3) {
		if (cycle_time && cycle_time < ide_pio_timings[pio].cycle_time)
			cycle_time = 0; /* use standard timing */
	}

	return cycle_time ? cycle_time : ide_pio_timings[pio].cycle_time;
}

EXPORT_SYMBOL_GPL(ide_pio_cycle_time);

/**
 *	ide_get_best_pio_mode	-	get PIO mode from drive
 *	@drive: drive to consider
 *	@mode_wanted: preferred mode
 *	@max_mode: highest allowed mode
 *
 *	This routine returns the recommended PIO settings for a given drive,
 *	based on the drive->id information and the ide_pio_blacklist[].
 *
 *	Drive PIO mode is auto-selected if 255 is passed as mode_wanted.
 *	This is used by most chipset support modules when "auto-tuning".
 */

u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode)
{
	int pio_mode;
	struct hd_driveid* id = drive->id;
	int overridden  = 0;

	if (mode_wanted != 255)
		return min_t(u8, mode_wanted, max_mode);

	if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_BLACKLIST) == 0 &&
	    (pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
		printk(KERN_INFO "%s: is on PIO blacklist\n", drive->name);
	} else {
		pio_mode = id->tPIO;
		if (pio_mode > 2) {	/* 2 is maximum allowed tPIO value */
			pio_mode = 2;
			overridden = 1;
		}
		if (id->field_valid & 2) {	  /* drive implements ATA2? */
			if (id->capability & 8) { /* IORDY supported? */
				if (id->eide_pio_modes & 7) {
					overridden = 0;
					if (id->eide_pio_modes & 4)
						pio_mode = 5;
					else if (id->eide_pio_modes & 2)
						pio_mode = 4;
					else
						pio_mode = 3;
				}
			}
		}

		if (overridden)
			printk(KERN_INFO "%s: tPIO > 2, assuming tPIO = 2\n",
					 drive->name);

		/*
		 * Conservative "downgrade" for all pre-ATA2 drives
		 */
		if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_DOWNGRADE) == 0 &&
		    pio_mode && pio_mode < 4) {
			pio_mode--;
			printk(KERN_INFO "%s: applying conservative "
					 "PIO \"downgrade\"\n", drive->name);
		}
	}

	if (pio_mode > max_mode)
		pio_mode = max_mode;

	return pio_mode;
}

EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);

/* req_pio == "255" for auto-tune */
void ide_set_pio(ide_drive_t *drive, u8 req_pio)
{
	ide_hwif_t *hwif = drive->hwif;
	u8 host_pio, pio;

	if (hwif->set_pio_mode == NULL)
		return;

	BUG_ON(hwif->pio_mask == 0x00);

	host_pio = fls(hwif->pio_mask) - 1;

	pio = ide_get_best_pio_mode(drive, req_pio, host_pio);

	/*
	 * TODO:
	 * - report device max PIO mode
	 * - check req_pio != 255 against device max PIO mode
	 */
	printk(KERN_DEBUG "%s: host max PIO%d wanted PIO%d%s selected PIO%d\n",
			  drive->name, host_pio, req_pio,
			  req_pio == 255 ? "(auto-tune)" : "", pio);

	(void)ide_set_pio_mode(drive, XFER_PIO_0 + pio);
}

EXPORT_SYMBOL_GPL(ide_set_pio);

/**
 *	ide_toggle_bounce	-	handle bounce buffering
 *	@drive: drive to update
 *	@on: on/off boolean
 *
 *	Enable or disable bounce buffering for the device. Drives move
 *	between PIO and DMA and that changes the rules we need.
 */
 
void ide_toggle_bounce(ide_drive_t *drive, int on)
{
	u64 addr = BLK_BOUNCE_HIGH;	/* dma64_addr_t */

	if (!PCI_DMA_BUS_IS_PHYS) {
		addr = BLK_BOUNCE_ANY;
	} else if (on && drive->media == ide_disk) {
		if (HWIF(drive)->pci_dev)
			addr = HWIF(drive)->pci_dev->dma_mask;
	}

	if (drive->queue)
		blk_queue_bounce_limit(drive->queue, addr);
}

int ide_set_pio_mode(ide_drive_t *drive, const u8 mode)
{
	ide_hwif_t *hwif = drive->hwif;

	if (hwif->set_pio_mode == NULL)
		return -1;

	/*
	 * TODO: temporary hack for some legacy host drivers that didn't
	 * set transfer mode on the device in ->set_pio_mode method...
	 */
	if (hwif->set_dma_mode == NULL) {
		hwif->set_pio_mode(drive, mode - XFER_PIO_0);
		return 0;
	}

	if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
		if (ide_config_drive_speed(drive, mode))
			return -1;
		hwif->set_pio_mode(drive, mode - XFER_PIO_0);
		return 0;
	} else {
		hwif->set_pio_mode(drive, mode - XFER_PIO_0);
		return ide_config_drive_speed(drive, mode);
	}
}

int ide_set_dma_mode(ide_drive_t *drive, const u8 mode)
{
	ide_hwif_t *hwif = drive->hwif;

	if (hwif->set_dma_mode == NULL)
		return -1;

	if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
		if (ide_config_drive_speed(drive, mode))
			return -1;
		hwif->set_dma_mode(drive, mode);
		return 0;
	} else {
		hwif->set_dma_mode(drive, mode);
		return ide_config_drive_speed(drive, mode);
	}
}

EXPORT_SYMBOL_GPL(ide_set_dma_mode);

/**
 *	ide_set_xfer_rate	-	set transfer rate
 *	@drive: drive to set
 *	@rate: speed to attempt to set
 *	
 *	General helper for setting the speed of an IDE device. This
 *	function knows about user enforced limits from the configuration
 *	which ->set_pio_mode/->set_dma_mode does not.
 */

int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
{
	ide_hwif_t *hwif = drive->hwif;

	if (hwif->set_dma_mode == NULL)
		return -1;

	rate = ide_rate_filter(drive, rate);

	if (rate >= XFER_PIO_0 && rate <= XFER_PIO_5)
		return ide_set_pio_mode(drive, rate);

	/*
	 * TODO: transfer modes 0x00-0x07 passed from the user-space are
	 * currently handled here which needs fixing (please note that such
	 * case could happen iff the transfer mode has already been set on
	 * the device by ide-proc.c::set_xfer_rate()).
	 */

	return ide_set_dma_mode(drive, rate);
}

static void ide_dump_opcode(ide_drive_t *drive)
{
	struct request *rq;
	u8 opcode = 0;
	int found = 0;

	spin_lock(&ide_lock);
	rq = NULL;
	if (HWGROUP(drive))
		rq = HWGROUP(drive)->rq;
	spin_unlock(&ide_lock);
	if (!rq)
		return;
	if (rq->cmd_type == REQ_TYPE_ATA_CMD) {
		char *args = rq->buffer;
		if (args) {
			opcode = args[0];
			found = 1;
		}
	} else if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE) {
		ide_task_t *args = rq->special;
		if (args) {
			opcode = args->tf.command;
			found = 1;
		}
	}

	printk("ide: failed opcode was: ");
	if (!found)
		printk("unknown\n");
	else
		printk("0x%02x\n", opcode);
}

static u64 ide_get_lba_addr(struct ide_taskfile *tf, int lba48)
{
	u32 high, low;

	if (lba48)
		high = (tf->hob_lbah << 16) | (tf->hob_lbam << 8) |
			tf->hob_lbal;
	else
		high = tf->device & 0xf;
	low  = (tf->lbah << 16) | (tf->lbam << 8) | tf->lbal;

	return ((u64)high << 24) | low;
}

static void ide_dump_sector(ide_drive_t *drive)
{
	ide_task_t task;
	struct ide_taskfile *tf = &task.tf;
	int lba48 = (drive->addressing == 1) ? 1 : 0;

	memset(&task, 0, sizeof(task));
	if (lba48)
		task.tf_flags = IDE_TFLAG_IN_LBA | IDE_TFLAG_IN_HOB_LBA |
				IDE_TFLAG_LBA48;
	else
		task.tf_flags = IDE_TFLAG_IN_LBA | IDE_TFLAG_IN_DEVICE;

	ide_tf_read(drive, &task);

	if (lba48 || (tf->device & ATA_LBA))
		printk(", LBAsect=%llu", ide_get_lba_addr(tf, lba48));
	else
		printk(", CHS=%d/%d/%d", (tf->lbah << 8) + tf->lbam,
					 tf->device & 0xf, tf->lbal);
}

static u8 ide_dump_ata_status(ide_drive_t *drive, const char *msg, u8 stat)
{
	ide_hwif_t *hwif = HWIF(drive);
	unsigned long flags;
	u8 err = 0;

	local_irq_save(flags);
	printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
	if (stat & BUSY_STAT)
		printk("Busy ");
	else {
		if (stat & READY_STAT)	printk("DriveReady ");
		if (stat & WRERR_STAT)	printk("DeviceFault ");
		if (stat & SEEK_STAT)	printk("SeekComplete ");
		if (stat & DRQ_STAT)	printk("DataRequest ");
		if (stat & ECC_STAT)	printk("CorrectedError ");
		if (stat & INDEX_STAT)	printk("Index ");
		if (stat & ERR_STAT)	printk("Error ");
	}
	printk("}\n");
	if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
		err = hwif->INB(IDE_ERROR_REG);
		printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
		if (err & ABRT_ERR)	printk("DriveStatusError ");
		if (err & ICRC_ERR)
			printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
		if (err & ECC_ERR)	printk("UncorrectableError ");
		if (err & ID_ERR)	printk("SectorIdNotFound ");
		if (err & TRK0_ERR)	printk("TrackZeroNotFound ");
		if (err & MARK_ERR)	printk("AddrMarkNotFound ");
		printk("}");
		if ((err & (BBD_ERR | ABRT_ERR)) == BBD_ERR ||
		    (err & (ECC_ERR|ID_ERR|MARK_ERR))) {
			ide_dump_sector(drive);
			if (HWGROUP(drive) && HWGROUP(drive)->rq)
				printk(", sector=%llu",
					(unsigned long long)HWGROUP(drive)->rq->sector);
		}
		printk("\n");
	}
	ide_dump_opcode(drive);
	local_irq_restore(flags);
	return err;
}

/**
 *	ide_dump_atapi_status       -       print human readable atapi status
 *	@drive: drive that status applies to
 *	@msg: text message to print
 *	@stat: status byte to decode
 *
 *	Error reporting, in human readable form (luxurious, but a memory hog).
 */

static u8 ide_dump_atapi_status(ide_drive_t *drive, const char *msg, u8 stat)
{
	unsigned long flags;
	u8 err = 0;

	local_irq_save(flags);
	printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
	if (stat & BUSY_STAT)
		printk("Busy ");
	else {
		if (stat & READY_STAT)	printk("DriveReady ");
		if (stat & WRERR_STAT)	printk("DeviceFault ");
		if (stat & SEEK_STAT)	printk("SeekComplete ");
		if (stat & DRQ_STAT)	printk("DataRequest ");
		if (stat & ECC_STAT)	printk("CorrectedError ");
		if (stat & INDEX_STAT)	printk("Index ");
		if (stat & ERR_STAT)	printk("Error ");
	}
	printk("}\n");
	if ((stat & (BUSY_STAT|ERR_STAT)) == ERR_STAT) {
		err = drive->hwif->INB(IDE_ERROR_REG);
		printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
		if (err & ILI_ERR)	printk("IllegalLengthIndication ");
		if (err & EOM_ERR)	printk("EndOfMedia ");
		if (err & ABRT_ERR)	printk("AbortedCommand ");
		if (err & MCR_ERR)	printk("MediaChangeRequested ");
		if (err & LFS_ERR)	printk("LastFailedSense=0x%02x ",
						(err & LFS_ERR) >> 4);
		printk("}\n");
	}
	ide_dump_opcode(drive);
	local_irq_restore(flags);
	return err;
}

/**
 *	ide_dump_status		-	translate ATA/ATAPI error
 *	@drive: drive the error occured on
 *	@msg: information string
 *	@stat: status byte
 *
 *	Error reporting, in human readable form (luxurious, but a memory hog).
 *	Combines the drive name, message and status byte to provide a
 *	user understandable explanation of the device error.
 */

u8 ide_dump_status(ide_drive_t *drive, const char *msg, u8 stat)
{
	if (drive->media == ide_disk)
		return ide_dump_ata_status(drive, msg, stat);
	return ide_dump_atapi_status(drive, msg, stat);
}

EXPORT_SYMBOL(ide_dump_status);
Commit	Line	Data
1da177e4 LT	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	*/
3ab7efe8 BZ	32
	33	static const char *udma_str[] =
	34	{ "UDMA/16", "UDMA/25", "UDMA/33", "UDMA/44",
	35	"UDMA/66", "UDMA/100", "UDMA/133", "UDMA7" };
	36	static const char *mwdma_str[] =
	37	{ "MWDMA0", "MWDMA1", "MWDMA2" };
	38	static const char *swdma_str[] =
	39	{ "SWDMA0", "SWDMA1", "SWDMA2" };
	40	static const char *pio_str[] =
	41	{ "PIO0", "PIO1", "PIO2", "PIO3", "PIO4", "PIO5" };
1da177e4 LT	42
	43	/**
	44	* ide_xfer_verbose - return IDE mode names
3ab7efe8	45	* @mode: transfer mode
1da177e4 LT	46	*
	47	* Returns a constant string giving the name of the mode
	48	* requested.
	49	*/
	50
3ab7efe8	51	const char *ide_xfer_verbose(u8 mode)
1da177e4	52	{
3ab7efe8 BZ	53	const char *s;
	54	u8 i = mode & 0xf;
	55
	56	if (mode >= XFER_UDMA_0 && mode <= XFER_UDMA_7)
	57	s = udma_str[i];
	58	else if (mode >= XFER_MW_DMA_0 && mode <= XFER_MW_DMA_2)
	59	s = mwdma_str[i];
	60	else if (mode >= XFER_SW_DMA_0 && mode <= XFER_SW_DMA_2)
	61	s = swdma_str[i];
	62	else if (mode >= XFER_PIO_0 && mode <= XFER_PIO_5)
	63	s = pio_str[i & 0x7];
	64	else if (mode == XFER_PIO_SLOW)
	65	s = "PIO SLOW";
	66	else
	67	s = "XFER ERROR";
	68
	69	return s;
1da177e4 LT	70	}
	71
	72	EXPORT_SYMBOL(ide_xfer_verbose);
	73
	74	/**
2d5eaa6d BZ	75	* ide_rate_filter - filter transfer mode
2d5eaa6d BZ	76	* @drive: IDE device
1da177e4 LT	77	* @speed: desired speed
1da177e4 LT	78	*
2d5eaa6d	79	* Given the available transfer modes this function returns
1da177e4	80	* the best available speed at or below the speed requested.
2d5eaa6d	81	*
7670df73	82	* TODO: check device PIO capabilities
1da177e4 LT	83	*/
1da177e4 LT	84
f212ff28	85	static u8 ide_rate_filter(ide_drive_t *drive, u8 speed)
1da177e4	86	{
2d5eaa6d	87	ide_hwif_t *hwif = drive->hwif;
7670df73	88	u8 mode = ide_find_dma_mode(drive, speed);
2d5eaa6d	89
7670df73 BZ	90	if (mode == 0) {
	91	if (hwif->pio_mask)
	92	mode = fls(hwif->pio_mask) - 1 + XFER_PIO_0;
	93	else
	94	mode = XFER_PIO_4;
	95	}
1da177e4 LT	96
	97	// printk("%s: mode 0x%02x, speed 0x%02x\n", __FUNCTION__, mode, speed);
	98
2d5eaa6d	99	return min(speed, mode);
1da177e4 LT	100	}
1da177e4 LT	101
1da177e4 LT	102	/*
	103	* Standard (generic) timings for PIO modes, from ATA2 specification.
	104	* These timings are for access to the IDE data port register only.
	105	* Some drives may specify a mode, while also specifying a different
	106	* value for cycle_time (from drive identification data).
	107	*/
	108	const ide_pio_timings_t ide_pio_timings[6] = {
	109	{ 70, 165, 600 }, /* PIO Mode 0 */
	110	{ 50, 125, 383 }, /* PIO Mode 1 */
	111	{ 30, 100, 240 }, /* PIO Mode 2 */
	112	{ 30, 80, 180 }, /* PIO Mode 3 with IORDY */
	113	{ 25, 70, 120 }, /* PIO Mode 4 with IORDY */
	114	{ 20, 50, 100 } /* PIO Mode 5 with IORDY (nonstandard) */
	115	};
	116
	117	EXPORT_SYMBOL_GPL(ide_pio_timings);
	118
	119	/*
	120	* Shared data/functions for determining best PIO mode for an IDE drive.
	121	* Most of this stuff originally lived in cmd640.c, and changes to the
	122	* ide_pio_blacklist[] table should be made with EXTREME CAUTION to avoid
	123	* breaking the fragile cmd640.c support.
	124	*/
	125
	126	/*
	127	* Black list. Some drives incorrectly report their maximal PIO mode,
	128	* at least in respect to CMD640. Here we keep info on some known drives.
	129	*/
	130	static struct ide_pio_info {
	131	const char *name;
	132	int pio;
	133	} ide_pio_blacklist [] = {
	134	/* { "Conner Peripherals 1275MB - CFS1275A", 4 }, */
	135	{ "Conner Peripherals 540MB - CFS540A", 3 },
	136
	137	{ "WDC AC2700", 3 },
	138	{ "WDC AC2540", 3 },
	139	{ "WDC AC2420", 3 },
	140	{ "WDC AC2340", 3 },
	141	{ "WDC AC2250", 0 },
	142	{ "WDC AC2200", 0 },
	143	{ "WDC AC21200", 4 },
	144	{ "WDC AC2120", 0 },
	145	{ "WDC AC2850", 3 },
	146	{ "WDC AC1270", 3 },
	147	{ "WDC AC1170", 1 },
	148	{ "WDC AC1210", 1 },
	149	{ "WDC AC280", 0 },
	150	/* { "WDC AC21000", 4 }, */
	151	{ "WDC AC31000", 3 },
	152	{ "WDC AC31200", 3 },
	153	/* { "WDC AC31600", 4 }, */
	154
	155	{ "Maxtor 7131 AT", 1 },
	156	{ "Maxtor 7171 AT", 1 },
	157	{ "Maxtor 7213 AT", 1 },
	158	{ "Maxtor 7245 AT", 1 },
	159	{ "Maxtor 7345 AT", 1 },
	160	{ "Maxtor 7546 AT", 3 },
	161	{ "Maxtor 7540 AV", 3 },
	162
	163	{ "SAMSUNG SHD-3121A", 1 },
	164	{ "SAMSUNG SHD-3122A", 1 },
	165	{ "SAMSUNG SHD-3172A", 1 },
166
167	/* { "ST51080A", 4 },
168	* { "ST51270A", 4 },
169	* { "ST31220A", 4 },
170	* { "ST31640A", 4 },
171	* { "ST32140A", 4 },
172	* { "ST3780A", 4 },
173	*/
174	{ "ST5660A", 3 },
175	{ "ST3660A", 3 },
176	{ "ST3630A", 3 },
177	{ "ST3655A", 3 },
178	{ "ST3391A", 3 },
179	{ "ST3390A", 1 },
180	{ "ST3600A", 1 },
181	{ "ST3290A", 0 },
182	{ "ST3144A", 0 },
183	{ "ST3491A", 1 }, /* reports 3, should be 1 or 2 (depending on */
184	/* drive) according to Seagates FIND-ATA program */
185
186	{ "QUANTUM ELS127A", 0 },
187	{ "QUANTUM ELS170A", 0 },
188	{ "QUANTUM LPS240A", 0 },
189	{ "QUANTUM LPS210A", 3 },
190	{ "QUANTUM LPS270A", 3 },
191	{ "QUANTUM LPS365A", 3 },
192	{ "QUANTUM LPS540A", 3 },
193	{ "QUANTUM LIGHTNING 540A", 3 },
194	{ "QUANTUM LIGHTNING 730A", 3 },
195
196	{ "QUANTUM FIREBALL_540", 3 }, /* Older Quantum Fireballs don't work */
197	{ "QUANTUM FIREBALL_640", 3 },
198	{ "QUANTUM FIREBALL_1080", 3 },
199	{ "QUANTUM FIREBALL_1280", 3 },
200	{ NULL, 0 }
201	};
202
203	/**
204	* ide_scan_pio_blacklist - check for a blacklisted drive
205	* @model: Drive model string
206	*
207	* This routine searches the ide_pio_blacklist for an entry
208	* matching the start/whole of the supplied model name.
209	*
210	* Returns -1 if no match found.
211	* Otherwise returns the recommended PIO mode from ide_pio_blacklist[].
212	*/
213
214	static int ide_scan_pio_blacklist (char *model)
215	{
216	struct ide_pio_info *p;
217
218	for (p = ide_pio_blacklist; p->name != NULL; p++) {
219	if (strncmp(p->name, model, strlen(p->name)) == 0)
220	return p->pio;
221	}
222	return -1;
223	}
224
7dd00083 BZ	225	unsigned int ide_pio_cycle_time(ide_drive_t *drive, u8 pio)
	226	{
	227	struct hd_driveid *id = drive->id;
	228	int cycle_time = 0;
	229
	230	if (id->field_valid & 2) {
	231	if (id->capability & 8)
	232	cycle_time = id->eide_pio_iordy;
	233	else
	234	cycle_time = id->eide_pio;
	235	}
	236
	237	/* conservative "downgrade" for all pre-ATA2 drives */
	238	if (pio < 3) {
	239	if (cycle_time && cycle_time < ide_pio_timings[pio].cycle_time)
	240	cycle_time = 0; /* use standard timing */
	241	}
	242
	243	return cycle_time ? cycle_time : ide_pio_timings[pio].cycle_time;
	244	}
	245
	246	EXPORT_SYMBOL_GPL(ide_pio_cycle_time);
	247
1da177e4 LT	248	/**
1da177e4 LT	249	* ide_get_best_pio_mode - get PIO mode from drive
81d368e0	250	* @drive: drive to consider
1da177e4	251	* @mode_wanted: preferred mode
81d368e0	252	* @max_mode: highest allowed mode
1da177e4 LT	253	*
	254	* This routine returns the recommended PIO settings for a given drive,
	255	* based on the drive->id information and the ide_pio_blacklist[].
1da177e4	256	*
81d368e0 SS	257	* Drive PIO mode is auto-selected if 255 is passed as mode_wanted.
81d368e0 SS	258	* This is used by most chipset support modules when "auto-tuning".
1da177e4 LT	259	*/
1da177e4 LT	260
2134758d	261	u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode)
1da177e4 LT	262	{
1da177e4 LT	263	int pio_mode;
1da177e4 LT	264	struct hd_driveid* id = drive->id;
1da177e4 LT	265	int overridden = 0;
1da177e4	266
6a824c92 BZ	267	if (mode_wanted != 255)
	268	return min_t(u8, mode_wanted, max_mode);
	269
	270	if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_BLACKLIST) == 0 &&
	271	(pio_mode = ide_scan_pio_blacklist(id->model)) != -1) {
342cdb6d	272	printk(KERN_INFO "%s: is on PIO blacklist\n", drive->name);
1da177e4 LT	273	} else {
	274	pio_mode = id->tPIO;
	275	if (pio_mode > 2) { /* 2 is maximum allowed tPIO value */
	276	pio_mode = 2;
	277	overridden = 1;
	278	}
	279	if (id->field_valid & 2) { /* drive implements ATA2? */
2229833c	280	if (id->capability & 8) { /* IORDY supported? */
1da177e4 LT	281	if (id->eide_pio_modes & 7) {
	282	overridden = 0;
	283	if (id->eide_pio_modes & 4)
	284	pio_mode = 5;
	285	else if (id->eide_pio_modes & 2)
	286	pio_mode = 4;
	287	else
	288	pio_mode = 3;
	289	}
1da177e4 LT	290	}
	291	}
	292
342cdb6d BZ	293	if (overridden)
	294	printk(KERN_INFO "%s: tPIO > 2, assuming tPIO = 2\n",
	295	drive->name);
	296
1da177e4 LT	297	/*
	298	* Conservative "downgrade" for all pre-ATA2 drives
	299	*/
6a824c92 BZ	300	if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_DOWNGRADE) == 0 &&
6a824c92 BZ	301	pio_mode && pio_mode < 4) {
1da177e4	302	pio_mode--;
342cdb6d BZ	303	printk(KERN_INFO "%s: applying conservative "
342cdb6d BZ	304	"PIO \"downgrade\"\n", drive->name);
1da177e4 LT	305	}
1da177e4 LT	306	}
7dd00083 BZ	307
7dd00083 BZ	308	if (pio_mode > max_mode)
1da177e4	309	pio_mode = max_mode;
7dd00083	310
1da177e4 LT	311	return pio_mode;
	312	}
	313
	314	EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
	315
26bcb879 BZ	316	/* req_pio == "255" for auto-tune */
	317	void ide_set_pio(ide_drive_t *drive, u8 req_pio)
	318	{
	319	ide_hwif_t *hwif = drive->hwif;
	320	u8 host_pio, pio;
	321
	322	if (hwif->set_pio_mode == NULL)
	323	return;
	324
	325	BUG_ON(hwif->pio_mask == 0x00);
	326
	327	host_pio = fls(hwif->pio_mask) - 1;
	328
	329	pio = ide_get_best_pio_mode(drive, req_pio, host_pio);
	330
	331	/*
	332	* TODO:
	333	* - report device max PIO mode
	334	* - check req_pio != 255 against device max PIO mode
	335	*/
	336	printk(KERN_DEBUG "%s: host max PIO%d wanted PIO%d%s selected PIO%d\n",
	337	drive->name, host_pio, req_pio,
	338	req_pio == 255 ? "(auto-tune)" : "", pio);
	339
88b2b32b	340	(void)ide_set_pio_mode(drive, XFER_PIO_0 + pio);
26bcb879 BZ	341	}
	342
	343	EXPORT_SYMBOL_GPL(ide_set_pio);
	344
1da177e4 LT	345	/**
	346	* ide_toggle_bounce - handle bounce buffering
	347	* @drive: drive to update
	348	* @on: on/off boolean
	349	*
	350	* Enable or disable bounce buffering for the device. Drives move
	351	* between PIO and DMA and that changes the rules we need.
	352	*/
	353
	354	void ide_toggle_bounce(ide_drive_t *drive, int on)
	355	{
	356	u64 addr = BLK_BOUNCE_HIGH; /* dma64_addr_t */
	357
6593178d JB	358	if (!PCI_DMA_BUS_IS_PHYS) {
	359	addr = BLK_BOUNCE_ANY;
	360	} else if (on && drive->media == ide_disk) {
	361	if (HWIF(drive)->pci_dev)
1da177e4 LT	362	addr = HWIF(drive)->pci_dev->dma_mask;
	363	}
	364
	365	if (drive->queue)
	366	blk_queue_bounce_limit(drive->queue, addr);
	367	}
	368
88b2b32b BZ	369	int ide_set_pio_mode(ide_drive_t *drive, const u8 mode)
	370	{
	371	ide_hwif_t *hwif = drive->hwif;
	372
	373	if (hwif->set_pio_mode == NULL)
	374	return -1;
	375
	376	/*
	377	* TODO: temporary hack for some legacy host drivers that didn't
	378	* set transfer mode on the device in ->set_pio_mode method...
	379	*/
	380	if (hwif->set_dma_mode == NULL) {
	381	hwif->set_pio_mode(drive, mode - XFER_PIO_0);
	382	return 0;
	383	}
	384
	385	if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
	386	if (ide_config_drive_speed(drive, mode))
	387	return -1;
	388	hwif->set_pio_mode(drive, mode - XFER_PIO_0);
	389	return 0;
	390	} else {
	391	hwif->set_pio_mode(drive, mode - XFER_PIO_0);
	392	return ide_config_drive_speed(drive, mode);
	393	}
	394	}
	395
	396	int ide_set_dma_mode(ide_drive_t *drive, const u8 mode)
	397	{
	398	ide_hwif_t *hwif = drive->hwif;
	399
	400	if (hwif->set_dma_mode == NULL)
	401	return -1;
	402
	403	if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
	404	if (ide_config_drive_speed(drive, mode))
	405	return -1;
	406	hwif->set_dma_mode(drive, mode);
	407	return 0;
	408	} else {
	409	hwif->set_dma_mode(drive, mode);
	410	return ide_config_drive_speed(drive, mode);
	411	}
	412	}
	413
	414	EXPORT_SYMBOL_GPL(ide_set_dma_mode);
	415
1da177e4 LT	416	/**
	417	* ide_set_xfer_rate - set transfer rate
	418	* @drive: drive to set
88b2b32b	419	* @rate: speed to attempt to set
1da177e4 LT	420	*
	421	* General helper for setting the speed of an IDE device. This
	422	* function knows about user enforced limits from the configuration
88b2b32b	423	* which ->set_pio_mode/->set_dma_mode does not.
1da177e4	424	*/
88b2b32b	425
1da177e4 LT	426	int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
1da177e4 LT	427	{
f212ff28 BZ	428	ide_hwif_t *hwif = drive->hwif;
f212ff28 BZ	429
88b2b32b	430	if (hwif->set_dma_mode == NULL)
1da177e4	431	return -1;
f212ff28 BZ	432
	433	rate = ide_rate_filter(drive, rate);
	434
88b2b32b BZ	435	if (rate >= XFER_PIO_0 && rate <= XFER_PIO_5)
88b2b32b BZ	436	return ide_set_pio_mode(drive, rate);
8f4dd2e4	437
88b2b32b BZ	438	/*
	439	* TODO: transfer modes 0x00-0x07 passed from the user-space are
	440	* currently handled here which needs fixing (please note that such
	441	* case could happen iff the transfer mode has already been set on
	442	* the device by ide-proc.c::set_xfer_rate()).
	443	*/
8f4dd2e4	444
88b2b32b	445	return ide_set_dma_mode(drive, rate);
1da177e4 LT	446	}
1da177e4 LT	447
1da177e4 LT	448	static void ide_dump_opcode(ide_drive_t *drive)
	449	{
	450	struct request *rq;
	451	u8 opcode = 0;
	452	int found = 0;
	453
	454	spin_lock(&ide_lock);
	455	rq = NULL;
	456	if (HWGROUP(drive))
	457	rq = HWGROUP(drive)->rq;
	458	spin_unlock(&ide_lock);
	459	if (!rq)
	460	return;
29ed2a5f	461	if (rq->cmd_type == REQ_TYPE_ATA_CMD) {
1da177e4 LT	462	char *args = rq->buffer;
	463	if (args) {
	464	opcode = args[0];
	465	found = 1;
	466	}
4aff5e23	467	} else if (rq->cmd_type == REQ_TYPE_ATA_TASKFILE) {
1da177e4 LT	468	ide_task_t *args = rq->special;
1da177e4 LT	469	if (args) {
650d841d	470	opcode = args->tf.command;
1da177e4 LT	471	found = 1;
	472	}
	473	}
	474
	475	printk("ide: failed opcode was: ");
	476	if (!found)
	477	printk("unknown\n");
	478	else
	479	printk("0x%02x\n", opcode);
	480	}
	481
c2b57cdc BZ	482	static u64 ide_get_lba_addr(struct ide_taskfile *tf, int lba48)
	483	{
	484	u32 high, low;
	485
	486	if (lba48)
	487	high = (tf->hob_lbah << 16) \| (tf->hob_lbam << 8) \|
	488	tf->hob_lbal;
	489	else
	490	high = tf->device & 0xf;
	491	low = (tf->lbah << 16) \| (tf->lbam << 8) \| tf->lbal;
	492
	493	return ((u64)high << 24) \| low;
	494	}
	495
	496	static void ide_dump_sector(ide_drive_t *drive)
	497	{
	498	ide_task_t task;
	499	struct ide_taskfile *tf = &task.tf;
	500	int lba48 = (drive->addressing == 1) ? 1 : 0;
	501
	502	memset(&task, 0, sizeof(task));
	503	if (lba48)
	504	task.tf_flags = IDE_TFLAG_IN_LBA \| IDE_TFLAG_IN_HOB_LBA \|
	505	IDE_TFLAG_LBA48;
	506	else
	507	task.tf_flags = IDE_TFLAG_IN_LBA \| IDE_TFLAG_IN_DEVICE;
	508
	509	ide_tf_read(drive, &task);
	510
	511	if (lba48 \|\| (tf->device & ATA_LBA))
	512	printk(", LBAsect=%llu", ide_get_lba_addr(tf, lba48));
	513	else
	514	printk(", CHS=%d/%d/%d", (tf->lbah << 8) + tf->lbam,
	515	tf->device & 0xf, tf->lbal);
	516	}
	517
1da177e4 LT	518	static u8 ide_dump_ata_status(ide_drive_t drive, const char msg, u8 stat)
	519	{
	520	ide_hwif_t *hwif = HWIF(drive);
	521	unsigned long flags;
	522	u8 err = 0;
	523
3d1c1cc9	524	local_irq_save(flags);
13bbbf28	525	printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
1da177e4 LT	526	if (stat & BUSY_STAT)
	527	printk("Busy ");
	528	else {
	529	if (stat & READY_STAT) printk("DriveReady ");
	530	if (stat & WRERR_STAT) printk("DeviceFault ");
	531	if (stat & SEEK_STAT) printk("SeekComplete ");
	532	if (stat & DRQ_STAT) printk("DataRequest ");
	533	if (stat & ECC_STAT) printk("CorrectedError ");
	534	if (stat & INDEX_STAT) printk("Index ");
	535	if (stat & ERR_STAT) printk("Error ");
	536	}
13bbbf28	537	printk("}\n");
1da177e4 LT	538	if ((stat & (BUSY_STAT\|ERR_STAT)) == ERR_STAT) {
1da177e4 LT	539	err = hwif->INB(IDE_ERROR_REG);
13bbbf28	540	printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
1da177e4 LT	541	if (err & ABRT_ERR) printk("DriveStatusError ");
1da177e4 LT	542	if (err & ICRC_ERR)
13bbbf28	543	printk((err & ABRT_ERR) ? "BadCRC " : "BadSector ");
1da177e4 LT	544	if (err & ECC_ERR) printk("UncorrectableError ");
	545	if (err & ID_ERR) printk("SectorIdNotFound ");
	546	if (err & TRK0_ERR) printk("TrackZeroNotFound ");
	547	if (err & MARK_ERR) printk("AddrMarkNotFound ");
	548	printk("}");
	549	if ((err & (BBD_ERR \| ABRT_ERR)) == BBD_ERR \|\|
	550	(err & (ECC_ERR\|ID_ERR\|MARK_ERR))) {
c2b57cdc	551	ide_dump_sector(drive);
1da177e4 LT	552	if (HWGROUP(drive) && HWGROUP(drive)->rq)
	553	printk(", sector=%llu",
	554	(unsigned long long)HWGROUP(drive)->rq->sector);
	555	}
13bbbf28	556	printk("\n");
1da177e4	557	}
1da177e4 LT	558	ide_dump_opcode(drive);
	559	local_irq_restore(flags);
	560	return err;
	561	}
	562
	563	/**
	564	* ide_dump_atapi_status - print human readable atapi status
	565	* @drive: drive that status applies to
	566	* @msg: text message to print
	567	* @stat: status byte to decode
	568	*
	569	* Error reporting, in human readable form (luxurious, but a memory hog).
	570	*/
	571
	572	static u8 ide_dump_atapi_status(ide_drive_t drive, const char msg, u8 stat)
	573	{
	574	unsigned long flags;
0e38a66a	575	u8 err = 0;
1da177e4	576
3d1c1cc9	577	local_irq_save(flags);
1da177e4	578	printk("%s: %s: status=0x%02x { ", drive->name, msg, stat);
22c525b9	579	if (stat & BUSY_STAT)
1da177e4 LT	580	printk("Busy ");
1da177e4 LT	581	else {
22c525b9 BZ	582	if (stat & READY_STAT) printk("DriveReady ");
	583	if (stat & WRERR_STAT) printk("DeviceFault ");
	584	if (stat & SEEK_STAT) printk("SeekComplete ");
	585	if (stat & DRQ_STAT) printk("DataRequest ");
	586	if (stat & ECC_STAT) printk("CorrectedError ");
	587	if (stat & INDEX_STAT) printk("Index ");
	588	if (stat & ERR_STAT) printk("Error ");
1da177e4 LT	589	}
1da177e4 LT	590	printk("}\n");
22c525b9	591	if ((stat & (BUSY_STAT\|ERR_STAT)) == ERR_STAT) {
0e38a66a BZ	592	err = drive->hwif->INB(IDE_ERROR_REG);
	593	printk("%s: %s: error=0x%02x { ", drive->name, msg, err);
	594	if (err & ILI_ERR) printk("IllegalLengthIndication ");
	595	if (err & EOM_ERR) printk("EndOfMedia ");
	596	if (err & ABRT_ERR) printk("AbortedCommand ");
	597	if (err & MCR_ERR) printk("MediaChangeRequested ");
	598	if (err & LFS_ERR) printk("LastFailedSense=0x%02x ",
	599	(err & LFS_ERR) >> 4);
1da177e4 LT	600	printk("}\n");
	601	}
	602	ide_dump_opcode(drive);
	603	local_irq_restore(flags);
0e38a66a	604	return err;
1da177e4 LT	605	}
	606
	607	/**
	608	* ide_dump_status - translate ATA/ATAPI error
	609	* @drive: drive the error occured on
	610	* @msg: information string
	611	* @stat: status byte
	612	*
	613	* Error reporting, in human readable form (luxurious, but a memory hog).
	614	* Combines the drive name, message and status byte to provide a
	615	* user understandable explanation of the device error.
	616	*/
	617
	618	u8 ide_dump_status(ide_drive_t drive, const char msg, u8 stat)
	619	{
	620	if (drive->media == ide_disk)
	621	return ide_dump_ata_status(drive, msg, stat);
	622	return ide_dump_atapi_status(drive, msg, stat);
	623	}
	624
	625	EXPORT_SYMBOL(ide_dump_status);