[linux-2.6-block.git] / drivers / ide / pci / tc86c001.c

/*
 * Copyright (C) 2002 Toshiba Corporation
 * Copyright (C) 2005-2006 MontaVista Software, Inc. <source@mvista.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2.  This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#include <linux/types.h>
#include <linux/pci.h>
#include <linux/ide.h>

static void tc86c001_set_mode(ide_drive_t *drive, const u8 speed)
{
	ide_hwif_t *hwif	= HWIF(drive);
	unsigned long scr_port	= hwif->config_data + (drive->dn ? 0x02 : 0x00);
	u16 mode, scr		= inw(scr_port);

	switch (speed) {
	case XFER_UDMA_4:	mode = 0x00c0; break;
	case XFER_UDMA_3:	mode = 0x00b0; break;
	case XFER_UDMA_2:	mode = 0x00a0; break;
	case XFER_UDMA_1:	mode = 0x0090; break;
	case XFER_UDMA_0:	mode = 0x0080; break;
	case XFER_MW_DMA_2:	mode = 0x0070; break;
	case XFER_MW_DMA_1:	mode = 0x0060; break;
	case XFER_MW_DMA_0:	mode = 0x0050; break;
	case XFER_PIO_4:	mode = 0x0400; break;
	case XFER_PIO_3:	mode = 0x0300; break;
	case XFER_PIO_2:	mode = 0x0200; break;
	case XFER_PIO_1:	mode = 0x0100; break;
	case XFER_PIO_0:
	default:		mode = 0x0000; break;
	}

	scr &= (speed < XFER_MW_DMA_0) ? 0xf8ff : 0xff0f;
	scr |= mode;
	outw(scr, scr_port);
}

static void tc86c001_set_pio_mode(ide_drive_t *drive, const u8 pio)
{
	tc86c001_set_mode(drive, XFER_PIO_0 + pio);
}

/*
 * HACKITY HACK
 *
 * This is a workaround for the limitation 5 of the TC86C001 IDE controller:
 * if a DMA transfer terminates prematurely, the controller leaves the device's
 * interrupt request (INTRQ) pending and does not generate a PCI interrupt (or
 * set the interrupt bit in the DMA status register), thus no PCI interrupt
 * will occur until a DMA transfer has been successfully completed.
 *
 * We work around this by initiating dummy, zero-length DMA transfer on
 * a DMA timeout expiration. I found no better way to do this with the current
 * IDE core than to temporarily replace a higher level driver's timer expiry
 * handler with our own backing up to that handler in case our recovery fails.
 */
static int tc86c001_timer_expiry(ide_drive_t *drive)
{
	ide_hwif_t *hwif	= HWIF(drive);
	ide_expiry_t *expiry	= ide_get_hwifdata(hwif);
	ide_hwgroup_t *hwgroup	= HWGROUP(drive);
	u8 dma_stat		= inb(hwif->dma_status);

	/* Restore a higher level driver's expiry handler first. */
	hwgroup->expiry	= expiry;

	if ((dma_stat & 5) == 1) {	/* DMA active and no interrupt */
		unsigned long sc_base	= hwif->config_data;
		unsigned long twcr_port	= sc_base + (drive->dn ? 0x06 : 0x04);
		u8 dma_cmd		= inb(hwif->dma_command);

		printk(KERN_WARNING "%s: DMA interrupt possibly stuck, "
		       "attempting recovery...\n", drive->name);

		/* Stop DMA */
		outb(dma_cmd & ~0x01, hwif->dma_command);

		/* Setup the dummy DMA transfer */
		outw(0, sc_base + 0x0a);	/* Sector Count */
		outw(0, twcr_port);	/* Transfer Word Count 1 or 2 */

		/* Start the dummy DMA transfer */
		outb(0x00, hwif->dma_command); /* clear R_OR_WCTR for write */
		outb(0x01, hwif->dma_command); /* set START_STOPBM */

		/*
		 * If an interrupt was pending, it should come thru shortly.
		 * If not, a higher level driver's expiry handler should
		 * eventually cause some kind of recovery from the DMA stall.
		 */
		return WAIT_MIN_SLEEP;
	}

	/* Chain to the restored expiry handler if DMA wasn't active. */
	if (likely(expiry != NULL))
		return expiry(drive);

	/* If there was no handler, "emulate" that for ide_timer_expiry()... */
	return -1;
}

static void tc86c001_dma_start(ide_drive_t *drive)
{
	ide_hwif_t *hwif	= HWIF(drive);
	ide_hwgroup_t *hwgroup	= HWGROUP(drive);
	unsigned long sc_base	= hwif->config_data;
	unsigned long twcr_port	= sc_base + (drive->dn ? 0x06 : 0x04);
	unsigned long nsectors	= hwgroup->rq->nr_sectors;

	/*
	 * We have to manually load the sector count and size into
	 * the appropriate system control registers for DMA to work
	 * with LBA48 and ATAPI devices...
	 */
	outw(nsectors, sc_base + 0x0a);	/* Sector Count */
	outw(SECTOR_SIZE / 2, twcr_port); /* Transfer Word Count 1/2 */

	/* Install our timeout expiry hook, saving the current handler... */
	ide_set_hwifdata(hwif, hwgroup->expiry);
	hwgroup->expiry = &tc86c001_timer_expiry;

	ide_dma_start(drive);
}

static u8 __devinit tc86c001_cable_detect(ide_hwif_t *hwif)
{
	struct pci_dev *dev = to_pci_dev(hwif->dev);
	unsigned long sc_base = pci_resource_start(dev, 5);
	u16 scr1 = inw(sc_base + 0x00);

	/*
	 * System Control  1 Register bit 13 (PDIAGN):
	 * 0=80-pin cable, 1=40-pin cable
	 */
	return (scr1 & 0x2000) ? ATA_CBL_PATA40 : ATA_CBL_PATA80;
}

static void __devinit init_hwif_tc86c001(ide_hwif_t *hwif)
{
	struct pci_dev *dev	= to_pci_dev(hwif->dev);
	unsigned long sc_base	= pci_resource_start(dev, 5);
	u16 scr1		= inw(sc_base + 0x00);

	/* System Control 1 Register bit 15 (Soft Reset) set */
	outw(scr1 |  0x8000, sc_base + 0x00);

	/* System Control 1 Register bit 14 (FIFO Reset) set */
	outw(scr1 |  0x4000, sc_base + 0x00);

	/* System Control 1 Register: reset clear */
	outw(scr1 & ~0xc000, sc_base + 0x00);

	/* Store the system control register base for convenience... */
	hwif->config_data = sc_base;

	hwif->set_pio_mode = &tc86c001_set_pio_mode;
	hwif->set_dma_mode = &tc86c001_set_mode;

	hwif->cable_detect = tc86c001_cable_detect;

	if (!hwif->dma_base)
		return;

	/*
	 * Sector Count Control Register bits 0 and 1 set:
	 * software sets Sector Count Register for master and slave device
	 */
	outw(0x0003, sc_base + 0x0c);

	/* Sector Count Register limit */
	hwif->rqsize	 = 0xffff;

	hwif->dma_start 	= &tc86c001_dma_start;
}

static unsigned int __devinit init_chipset_tc86c001(struct pci_dev *dev,
							const char *name)
{
	int err = pci_request_region(dev, 5, name);

	if (err)
		printk(KERN_ERR "%s: system control regs already in use", name);
	return err;
}

static const struct ide_port_info tc86c001_chipset __devinitdata = {
	.name		= "TC86C001",
	.init_chipset	= init_chipset_tc86c001,
	.init_hwif	= init_hwif_tc86c001,
	.host_flags	= IDE_HFLAG_SINGLE | IDE_HFLAG_OFF_BOARD |
			  IDE_HFLAG_ABUSE_SET_DMA_MODE,
	.pio_mask	= ATA_PIO4,
	.mwdma_mask	= ATA_MWDMA2,
	.udma_mask	= ATA_UDMA4,
};

static int __devinit tc86c001_init_one(struct pci_dev *dev,
				       const struct pci_device_id *id)
{
	return ide_setup_pci_device(dev, &tc86c001_chipset);
}

static const struct pci_device_id tc86c001_pci_tbl[] = {
	{ PCI_VDEVICE(TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_TC86C001_IDE), 0 },
	{ 0, }
};
MODULE_DEVICE_TABLE(pci, tc86c001_pci_tbl);

static struct pci_driver driver = {
	.name		= "TC86C001",
	.id_table	= tc86c001_pci_tbl,
	.probe		= tc86c001_init_one
};

static int __init tc86c001_ide_init(void)
{
	return ide_pci_register_driver(&driver);
}
module_init(tc86c001_ide_init);

MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
MODULE_DESCRIPTION("PCI driver module for TC86C001 IDE");
MODULE_LICENSE("GPL");
Commit	Line	Data
33dced2e	1	/*
33dced2e SS	2	* Copyright (C) 2002 Toshiba Corporation
	3	* Copyright (C) 2005-2006 MontaVista Software, Inc. <source@mvista.com>
	4	*
	5	* This file is licensed under the terms of the GNU General Public
	6	* License version 2. This program is licensed "as is" without any
	7	* warranty of any kind, whether express or implied.
	8	*/
	9
	10	#include <linux/types.h>
	11	#include <linux/pci.h>
	12	#include <linux/ide.h>
	13
88b2b32b	14	static void tc86c001_set_mode(ide_drive_t *drive, const u8 speed)
33dced2e SS	15	{
	16	ide_hwif_t *hwif = HWIF(drive);
	17	unsigned long scr_port = hwif->config_data + (drive->dn ? 0x02 : 0x00);
31e8a465	18	u16 mode, scr = inw(scr_port);
33dced2e	19
33dced2e	20	switch (speed) {
5c634bb9 PC	21	case XFER_UDMA_4: mode = 0x00c0; break;
	22	case XFER_UDMA_3: mode = 0x00b0; break;
	23	case XFER_UDMA_2: mode = 0x00a0; break;
	24	case XFER_UDMA_1: mode = 0x0090; break;
	25	case XFER_UDMA_0: mode = 0x0080; break;
	26	case XFER_MW_DMA_2: mode = 0x0070; break;
	27	case XFER_MW_DMA_1: mode = 0x0060; break;
	28	case XFER_MW_DMA_0: mode = 0x0050; break;
	29	case XFER_PIO_4: mode = 0x0400; break;
	30	case XFER_PIO_3: mode = 0x0300; break;
	31	case XFER_PIO_2: mode = 0x0200; break;
	32	case XFER_PIO_1: mode = 0x0100; break;
	33	case XFER_PIO_0:
	34	default: mode = 0x0000; break;
33dced2e SS	35	}
	36
	37	scr &= (speed < XFER_MW_DMA_0) ? 0xf8ff : 0xff0f;
	38	scr \|= mode;
0ecdca26	39	outw(scr, scr_port);
33dced2e SS	40	}
33dced2e SS	41
26bcb879	42	static void tc86c001_set_pio_mode(ide_drive_t *drive, const u8 pio)
33dced2e	43	{
88b2b32b	44	tc86c001_set_mode(drive, XFER_PIO_0 + pio);
33dced2e SS	45	}
	46
	47	/*
	48	* HACKITY HACK
	49	*
	50	* This is a workaround for the limitation 5 of the TC86C001 IDE controller:
	51	* if a DMA transfer terminates prematurely, the controller leaves the device's
	52	* interrupt request (INTRQ) pending and does not generate a PCI interrupt (or
	53	* set the interrupt bit in the DMA status register), thus no PCI interrupt
	54	* will occur until a DMA transfer has been successfully completed.
	55	*
	56	* We work around this by initiating dummy, zero-length DMA transfer on
	57	* a DMA timeout expiration. I found no better way to do this with the current
	58	* IDE core than to temporarily replace a higher level driver's timer expiry
	59	* handler with our own backing up to that handler in case our recovery fails.
	60	*/
	61	static int tc86c001_timer_expiry(ide_drive_t *drive)
	62	{
	63	ide_hwif_t *hwif = HWIF(drive);
	64	ide_expiry_t *expiry = ide_get_hwifdata(hwif);
	65	ide_hwgroup_t *hwgroup = HWGROUP(drive);
31e8a465	66	u8 dma_stat = inb(hwif->dma_status);
33dced2e SS	67
	68	/* Restore a higher level driver's expiry handler first. */
	69	hwgroup->expiry = expiry;
	70
	71	if ((dma_stat & 5) == 1) { /* DMA active and no interrupt */
	72	unsigned long sc_base = hwif->config_data;
	73	unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
31e8a465	74	u8 dma_cmd = inb(hwif->dma_command);
33dced2e SS	75
	76	printk(KERN_WARNING "%s: DMA interrupt possibly stuck, "
	77	"attempting recovery...\n", drive->name);
	78
	79	/* Stop DMA */
0ecdca26	80	outb(dma_cmd & ~0x01, hwif->dma_command);
33dced2e SS	81
33dced2e SS	82	/* Setup the dummy DMA transfer */
0ecdca26 BZ	83	outw(0, sc_base + 0x0a); /* Sector Count */
0ecdca26 BZ	84	outw(0, twcr_port); /* Transfer Word Count 1 or 2 */
33dced2e SS	85
33dced2e SS	86	/* Start the dummy DMA transfer */
0ecdca26 BZ	87	outb(0x00, hwif->dma_command); /* clear R_OR_WCTR for write */
0ecdca26 BZ	88	outb(0x01, hwif->dma_command); /* set START_STOPBM */
33dced2e SS	89
	90	/*
	91	* If an interrupt was pending, it should come thru shortly.
	92	* If not, a higher level driver's expiry handler should
	93	* eventually cause some kind of recovery from the DMA stall.
	94	*/
	95	return WAIT_MIN_SLEEP;
	96	}
	97
	98	/* Chain to the restored expiry handler if DMA wasn't active. */
	99	if (likely(expiry != NULL))
	100	return expiry(drive);
	101
	102	/* If there was no handler, "emulate" that for ide_timer_expiry()... */
	103	return -1;
	104	}
	105
	106	static void tc86c001_dma_start(ide_drive_t *drive)
	107	{
	108	ide_hwif_t *hwif = HWIF(drive);
	109	ide_hwgroup_t *hwgroup = HWGROUP(drive);
	110	unsigned long sc_base = hwif->config_data;
	111	unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
	112	unsigned long nsectors = hwgroup->rq->nr_sectors;
	113
	114	/*
	115	* We have to manually load the sector count and size into
	116	* the appropriate system control registers for DMA to work
	117	* with LBA48 and ATAPI devices...
	118	*/
0ecdca26 BZ	119	outw(nsectors, sc_base + 0x0a); /* Sector Count */
0ecdca26 BZ	120	outw(SECTOR_SIZE / 2, twcr_port); /* Transfer Word Count 1/2 */
33dced2e SS	121
	122	/* Install our timeout expiry hook, saving the current handler... */
	123	ide_set_hwifdata(hwif, hwgroup->expiry);
	124	hwgroup->expiry = &tc86c001_timer_expiry;
	125
	126	ide_dma_start(drive);
	127	}
	128
bfa14b42 BZ	129	static u8 __devinit tc86c001_cable_detect(ide_hwif_t *hwif)
	130	{
	131	struct pci_dev *dev = to_pci_dev(hwif->dev);
	132	unsigned long sc_base = pci_resource_start(dev, 5);
	133	u16 scr1 = inw(sc_base + 0x00);
	134
	135	/*
	136	* System Control 1 Register bit 13 (PDIAGN):
	137	* 0=80-pin cable, 1=40-pin cable
	138	*/
	139	return (scr1 & 0x2000) ? ATA_CBL_PATA40 : ATA_CBL_PATA80;
	140	}
	141
e8ab7f53	142	static void __devinit init_hwif_tc86c001(ide_hwif_t *hwif)
33dced2e	143	{
36501650 BZ	144	struct pci_dev *dev = to_pci_dev(hwif->dev);
36501650 BZ	145	unsigned long sc_base = pci_resource_start(dev, 5);
31e8a465	146	u16 scr1 = inw(sc_base + 0x00);
33dced2e SS	147
33dced2e SS	148	/* System Control 1 Register bit 15 (Soft Reset) set */
0ecdca26	149	outw(scr1 \| 0x8000, sc_base + 0x00);
33dced2e SS	150
33dced2e SS	151	/* System Control 1 Register bit 14 (FIFO Reset) set */
0ecdca26	152	outw(scr1 \| 0x4000, sc_base + 0x00);
33dced2e SS	153
33dced2e SS	154	/* System Control 1 Register: reset clear */
0ecdca26	155	outw(scr1 & ~0xc000, sc_base + 0x00);
33dced2e SS	156
	157	/* Store the system control register base for convenience... */
	158	hwif->config_data = sc_base;
	159
26bcb879	160	hwif->set_pio_mode = &tc86c001_set_pio_mode;
88b2b32b BZ	161	hwif->set_dma_mode = &tc86c001_set_mode;
88b2b32b BZ	162
bfa14b42 BZ	163	hwif->cable_detect = tc86c001_cable_detect;
bfa14b42 BZ	164
33dced2e SS	165	if (!hwif->dma_base)
	166	return;
	167
	168	/*
	169	* Sector Count Control Register bits 0 and 1 set:
	170	* software sets Sector Count Register for master and slave device
	171	*/
0ecdca26	172	outw(0x0003, sc_base + 0x0c);
33dced2e SS	173
	174	/* Sector Count Register limit */
	175	hwif->rqsize = 0xffff;
	176
33dced2e	177	hwif->dma_start = &tc86c001_dma_start;
33dced2e SS	178	}
33dced2e SS	179
ba59c4b8 AM	180	static unsigned int __devinit init_chipset_tc86c001(struct pci_dev *dev,
ba59c4b8 AM	181	const char *name)
33dced2e SS	182	{
	183	int err = pci_request_region(dev, 5, name);
	184
	185	if (err)
	186	printk(KERN_ERR "%s: system control regs already in use", name);
	187	return err;
	188	}
	189
85620436	190	static const struct ide_port_info tc86c001_chipset __devinitdata = {
33dced2e SS	191	.name = "TC86C001",
	192	.init_chipset = init_chipset_tc86c001,
	193	.init_hwif = init_hwif_tc86c001,
4db90a14 BZ	194	.host_flags = IDE_HFLAG_SINGLE \| IDE_HFLAG_OFF_BOARD \|
4db90a14 BZ	195	IDE_HFLAG_ABUSE_SET_DMA_MODE,
4099d143	196	.pio_mask = ATA_PIO4,
5f8b6c34 BZ	197	.mwdma_mask = ATA_MWDMA2,
5f8b6c34 BZ	198	.udma_mask = ATA_UDMA4,
33dced2e SS	199	};
	200
	201	static int __devinit tc86c001_init_one(struct pci_dev *dev,
	202	const struct pci_device_id *id)
	203	{
	204	return ide_setup_pci_device(dev, &tc86c001_chipset);
	205	}
	206
9cbcc5e3 BZ	207	static const struct pci_device_id tc86c001_pci_tbl[] = {
9cbcc5e3 BZ	208	{ PCI_VDEVICE(TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_TC86C001_IDE), 0 },
33dced2e SS	209	{ 0, }
	210	};
	211	MODULE_DEVICE_TABLE(pci, tc86c001_pci_tbl);
	212
	213	static struct pci_driver driver = {
	214	.name = "TC86C001",
	215	.id_table = tc86c001_pci_tbl,
	216	.probe = tc86c001_init_one
	217	};
	218
a534b68d	219	static int __init tc86c001_ide_init(void)
33dced2e SS	220	{
	221	return ide_pci_register_driver(&driver);
	222	}
	223	module_init(tc86c001_ide_init);
	224
	225	MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
	226	MODULE_DESCRIPTION("PCI driver module for TC86C001 IDE");
	227	MODULE_LICENSE("GPL");