[deliverable/linux.git] / drivers / ide / ide-xfer-mode.c

#include <linux/types.h>
#include <linux/string.h>
#include <linux/kernel.h>
#include <linux/interrupt.h>
#include <linux/ide.h>
#include <linux/bitops.h>

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", "MWDMA3", "MWDMA4" };
static const char *swdma_str[] =
	{ "SWDMA0", "SWDMA1", "SWDMA2" };
static const char *pio_str[] =
	{ "PIO0", "PIO1", "PIO2", "PIO3", "PIO4", "PIO5", "PIO6" };

/**
 *	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_4)
		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_6)
		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_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)
{
	u16 *id = drive->id;
	int pio_mode = -1, 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((char *)&id[ATA_ID_PROD]);

	if (pio_mode != -1) {
		printk(KERN_INFO "%s: is on PIO blacklist\n", drive->name);
	} else {
		pio_mode = id[ATA_ID_OLD_PIO_MODES] >> 8;
		if (pio_mode > 2) {	/* 2 is maximum allowed tPIO value */
			pio_mode = 2;
			overridden = 1;
		}

		if (id[ATA_ID_FIELD_VALID] & 2) {	      /* ATA2? */
			if (ata_id_is_cfa(id) && (id[ATA_ID_CFA_MODES] & 7))
				pio_mode = 4 + min_t(int, 2,
						     id[ATA_ID_CFA_MODES] & 7);
			else if (ata_id_has_iordy(id)) {
				if (id[ATA_ID_PIO_MODES] & 7) {
					overridden = 0;
					if (id[ATA_ID_PIO_MODES] & 4)
						pio_mode = 5;
					else if (id[ATA_ID_PIO_MODES] & 2)
						pio_mode = 4;
					else
						pio_mode = 3;
				}
			}
		}

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

	if (pio_mode > max_mode)
		pio_mode = max_mode;

	return pio_mode;
}
EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);

int ide_pio_need_iordy(ide_drive_t *drive, const u8 pio)
{
	/*
	 * IORDY may lead to controller lock up on certain controllers
	 * if the port is not occupied.
	 */
	if (pio == 0 && (drive->hwif->port_flags & IDE_PFLAG_PROBING))
		return 0;
	return ata_id_pio_need_iordy(drive->id, pio);
}
EXPORT_SYMBOL_GPL(ide_pio_need_iordy);

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

	if (hwif->host_flags & IDE_HFLAG_NO_SET_MODE)
		return 0;

	if (port_ops == NULL || port_ops->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 (port_ops->set_dma_mode == NULL) {
		drive->pio_mode = mode;
		port_ops->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;
		drive->pio_mode = mode;
		port_ops->set_pio_mode(drive, mode - XFER_PIO_0);
		return 0;
	} else {
		drive->pio_mode = mode;
		port_ops->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;
	const struct ide_port_ops *port_ops = hwif->port_ops;

	if (hwif->host_flags & IDE_HFLAG_NO_SET_MODE)
		return 0;

	if (port_ops == NULL || port_ops->set_dma_mode == NULL)
		return -1;

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

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

	if (port_ops == NULL || port_ops->set_pio_mode == NULL ||
	    (hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
		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_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", __func__, mode, speed); */

	return min(speed, 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;
	const struct ide_port_ops *port_ops = hwif->port_ops;

	if (port_ops == NULL || port_ops->set_dma_mode == NULL ||
	    (hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
		return -1;

	rate = ide_rate_filter(drive, rate);

	BUG_ON(rate < XFER_PIO_0);

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

	return ide_set_dma_mode(drive, rate);
}
Commit	Line	Data
7eeaaaa5 BZ	1	#include <linux/types.h>
	2	#include <linux/string.h>
	3	#include <linux/kernel.h>
	4	#include <linux/interrupt.h>
	5	#include <linux/ide.h>
	6	#include <linux/bitops.h>
	7
	8	static const char *udma_str[] =
	9	{ "UDMA/16", "UDMA/25", "UDMA/33", "UDMA/44",
	10	"UDMA/66", "UDMA/100", "UDMA/133", "UDMA7" };
	11	static const char *mwdma_str[] =
74638c84	12	{ "MWDMA0", "MWDMA1", "MWDMA2", "MWDMA3", "MWDMA4" };
7eeaaaa5 BZ	13	static const char *swdma_str[] =
	14	{ "SWDMA0", "SWDMA1", "SWDMA2" };
	15	static const char *pio_str[] =
74638c84	16	{ "PIO0", "PIO1", "PIO2", "PIO3", "PIO4", "PIO5", "PIO6" };
7eeaaaa5 BZ	17
	18	/**
	19	* ide_xfer_verbose - return IDE mode names
	20	* @mode: transfer mode
	21	*
	22	* Returns a constant string giving the name of the mode
	23	* requested.
	24	*/
	25
	26	const char *ide_xfer_verbose(u8 mode)
	27	{
	28	const char *s;
	29	u8 i = mode & 0xf;
	30
	31	if (mode >= XFER_UDMA_0 && mode <= XFER_UDMA_7)
	32	s = udma_str[i];
74638c84	33	else if (mode >= XFER_MW_DMA_0 && mode <= XFER_MW_DMA_4)
7eeaaaa5 BZ	34	s = mwdma_str[i];
	35	else if (mode >= XFER_SW_DMA_0 && mode <= XFER_SW_DMA_2)
	36	s = swdma_str[i];
74638c84	37	else if (mode >= XFER_PIO_0 && mode <= XFER_PIO_6)
7eeaaaa5 BZ	38	s = pio_str[i & 0x7];
	39	else if (mode == XFER_PIO_SLOW)
	40	s = "PIO SLOW";
	41	else
	42	s = "XFER ERROR";
	43
	44	return s;
	45	}
	46	EXPORT_SYMBOL(ide_xfer_verbose);
	47
	48	/**
	49	* ide_get_best_pio_mode - get PIO mode from drive
	50	* @drive: drive to consider
	51	* @mode_wanted: preferred mode
	52	* @max_mode: highest allowed mode
	53	*
	54	* This routine returns the recommended PIO settings for a given drive,
	55	* based on the drive->id information and the ide_pio_blacklist[].
	56	*
	57	* Drive PIO mode is auto-selected if 255 is passed as mode_wanted.
	58	* This is used by most chipset support modules when "auto-tuning".
	59	*/
	60
	61	u8 ide_get_best_pio_mode(ide_drive_t *drive, u8 mode_wanted, u8 max_mode)
	62	{
	63	u16 *id = drive->id;
	64	int pio_mode = -1, overridden = 0;
	65
	66	if (mode_wanted != 255)
	67	return min_t(u8, mode_wanted, max_mode);
	68
	69	if ((drive->hwif->host_flags & IDE_HFLAG_PIO_NO_BLACKLIST) == 0)
	70	pio_mode = ide_scan_pio_blacklist((char *)&id[ATA_ID_PROD]);
	71
	72	if (pio_mode != -1) {
	73	printk(KERN_INFO "%s: is on PIO blacklist\n", drive->name);
	74	} else {
	75	pio_mode = id[ATA_ID_OLD_PIO_MODES] >> 8;
	76	if (pio_mode > 2) { /* 2 is maximum allowed tPIO value */
	77	pio_mode = 2;
	78	overridden = 1;
	79	}
	80
	81	if (id[ATA_ID_FIELD_VALID] & 2) { /* ATA2? */
74638c84 SS	82	if (ata_id_is_cfa(id) && (id[ATA_ID_CFA_MODES] & 7))
	83	pio_mode = 4 + min_t(int, 2,
	84	id[ATA_ID_CFA_MODES] & 7);
	85	else if (ata_id_has_iordy(id)) {
7eeaaaa5 BZ	86	if (id[ATA_ID_PIO_MODES] & 7) {
	87	overridden = 0;
	88	if (id[ATA_ID_PIO_MODES] & 4)
	89	pio_mode = 5;
	90	else if (id[ATA_ID_PIO_MODES] & 2)
	91	pio_mode = 4;
	92	else
	93	pio_mode = 3;
	94	}
	95	}
	96	}
	97
	98	if (overridden)
	99	printk(KERN_INFO "%s: tPIO > 2, assuming tPIO = 2\n",
	100	drive->name);
	101	}
	102
	103	if (pio_mode > max_mode)
	104	pio_mode = max_mode;
	105
	106	return pio_mode;
	107	}
	108	EXPORT_SYMBOL_GPL(ide_get_best_pio_mode);
	109
c9ef59ff BZ	110	int ide_pio_need_iordy(ide_drive_t *drive, const u8 pio)
c9ef59ff BZ	111	{
5880b5de BZ	112	/*
	113	* IORDY may lead to controller lock up on certain controllers
	114	* if the port is not occupied.
	115	*/
	116	if (pio == 0 && (drive->hwif->port_flags & IDE_PFLAG_PROBING))
	117	return 0;
c9ef59ff BZ	118	return ata_id_pio_need_iordy(drive->id, pio);
	119	}
	120	EXPORT_SYMBOL_GPL(ide_pio_need_iordy);
	121
7eeaaaa5 BZ	122	int ide_set_pio_mode(ide_drive_t *drive, const u8 mode)
	123	{
	124	ide_hwif_t *hwif = drive->hwif;
	125	const struct ide_port_ops *port_ops = hwif->port_ops;
	126
	127	if (hwif->host_flags & IDE_HFLAG_NO_SET_MODE)
	128	return 0;
	129
	130	if (port_ops == NULL \|\| port_ops->set_pio_mode == NULL)
	131	return -1;
	132
	133	/*
	134	* TODO: temporary hack for some legacy host drivers that didn't
	135	* set transfer mode on the device in ->set_pio_mode method...
	136	*/
	137	if (port_ops->set_dma_mode == NULL) {
d2d4e780	138	drive->pio_mode = mode;
7eeaaaa5 BZ	139	port_ops->set_pio_mode(drive, mode - XFER_PIO_0);
	140	return 0;
	141	}
	142
	143	if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
	144	if (ide_config_drive_speed(drive, mode))
	145	return -1;
d2d4e780	146	drive->pio_mode = mode;
7eeaaaa5 BZ	147	port_ops->set_pio_mode(drive, mode - XFER_PIO_0);
	148	return 0;
	149	} else {
d2d4e780	150	drive->pio_mode = mode;
7eeaaaa5 BZ	151	port_ops->set_pio_mode(drive, mode - XFER_PIO_0);
	152	return ide_config_drive_speed(drive, mode);
	153	}
	154	}
	155
	156	int ide_set_dma_mode(ide_drive_t *drive, const u8 mode)
	157	{
	158	ide_hwif_t *hwif = drive->hwif;
	159	const struct ide_port_ops *port_ops = hwif->port_ops;
	160
	161	if (hwif->host_flags & IDE_HFLAG_NO_SET_MODE)
	162	return 0;
	163
	164	if (port_ops == NULL \|\| port_ops->set_dma_mode == NULL)
	165	return -1;
	166
	167	if (hwif->host_flags & IDE_HFLAG_POST_SET_MODE) {
	168	if (ide_config_drive_speed(drive, mode))
	169	return -1;
	170	port_ops->set_dma_mode(drive, mode);
	171	return 0;
	172	} else {
	173	port_ops->set_dma_mode(drive, mode);
	174	return ide_config_drive_speed(drive, mode);
	175	}
	176	}
	177	EXPORT_SYMBOL_GPL(ide_set_dma_mode);
	178
	179	/* req_pio == "255" for auto-tune */
	180	void ide_set_pio(ide_drive_t *drive, u8 req_pio)
	181	{
	182	ide_hwif_t *hwif = drive->hwif;
	183	const struct ide_port_ops *port_ops = hwif->port_ops;
	184	u8 host_pio, pio;
	185
	186	if (port_ops == NULL \|\| port_ops->set_pio_mode == NULL \|\|
	187	(hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
	188	return;
	189
	190	BUG_ON(hwif->pio_mask == 0x00);
	191
	192	host_pio = fls(hwif->pio_mask) - 1;
	193
	194	pio = ide_get_best_pio_mode(drive, req_pio, host_pio);
	195
	196	/*
	197	* TODO:
	198	* - report device max PIO mode
	199	* - check req_pio != 255 against device max PIO mode
	200	*/
	201	printk(KERN_DEBUG "%s: host max PIO%d wanted PIO%d%s selected PIO%d\n",
	202	drive->name, host_pio, req_pio,
	203	req_pio == 255 ? "(auto-tune)" : "", pio);
	204
	205	(void)ide_set_pio_mode(drive, XFER_PIO_0 + pio);
	206	}
	207	EXPORT_SYMBOL_GPL(ide_set_pio);
	208
	209	/**
	210	* ide_rate_filter - filter transfer mode
	211	* @drive: IDE device
	212	* @speed: desired speed
	213	*
	214	* Given the available transfer modes this function returns
215	* the best available speed at or below the speed requested.
216	*
217	* TODO: check device PIO capabilities
218	*/
219
220	static u8 ide_rate_filter(ide_drive_t *drive, u8 speed)
221	{
222	ide_hwif_t *hwif = drive->hwif;
223	u8 mode = ide_find_dma_mode(drive, speed);
224
225	if (mode == 0) {
226	if (hwif->pio_mask)
227	mode = fls(hwif->pio_mask) - 1 + XFER_PIO_0;
228	else
229	mode = XFER_PIO_4;
230	}
231
232	/* printk("%s: mode 0x%02x, speed 0x%02x\n", __func__, mode, speed); */
233
234	return min(speed, mode);
235	}
236
237	/**
238	* ide_set_xfer_rate - set transfer rate
239	* @drive: drive to set
240	* @rate: speed to attempt to set
241	*
242	* General helper for setting the speed of an IDE device. This
243	* function knows about user enforced limits from the configuration
244	* which ->set_pio_mode/->set_dma_mode does not.
245	*/
246
247	int ide_set_xfer_rate(ide_drive_t *drive, u8 rate)
248	{
249	ide_hwif_t *hwif = drive->hwif;
250	const struct ide_port_ops *port_ops = hwif->port_ops;
251
252	if (port_ops == NULL \|\| port_ops->set_dma_mode == NULL \|\|
253	(hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
254	return -1;
255
256	rate = ide_rate_filter(drive, rate);
257
258	BUG_ON(rate < XFER_PIO_0);
259
74638c84	260	if (rate >= XFER_PIO_0 && rate <= XFER_PIO_6)
7eeaaaa5 BZ	261	return ide_set_pio_mode(drive, rate);
	262
	263	return ide_set_dma_mode(drive, rate);
	264	}