[mirror_ubuntu-bionic-kernel.git] / drivers / ata / pata_optidma.c

/*
 * pata_optidma.c 	- Opti DMA PATA for new ATA layer
 *			  (C) 2006 Red Hat Inc
 *			  Alan Cox <alan@redhat.com>
 *
 *	The Opti DMA controllers are related to the older PIO PCI controllers
 *	and indeed the VLB ones. The main differences are that the timing
 *	numbers are now based off PCI clocks not VLB and differ, and that
 *	MWDMA is supported.
 *
 *	This driver should support Viper-N+, FireStar, FireStar Plus.
 *
 *	These devices support virtual DMA for read (aka the CS5520). Later
 *	chips support UDMA33, but only if the rest of the board logic does,
 *	so you have to get this right. We don't support the virtual DMA
 *	but we do handle UDMA.
 *
 *	Bits that are worth knowing
 *		Most control registers are shadowed into I/O registers
 *		0x1F5 bit 0 tells you if the PCI/VLB clock is 33 or 25Mhz
 *		Virtual DMA registers *move* between rev 0x02 and rev 0x10
 *		UDMA requires a 66MHz FSB
 *
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/init.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
#include <scsi/scsi_host.h>
#include <linux/libata.h>

#define DRV_NAME "pata_optidma"
#define DRV_VERSION "0.2.3"

enum {
	READ_REG	= 0,	/* index of Read cycle timing register */
	WRITE_REG 	= 1,	/* index of Write cycle timing register */
	CNTRL_REG 	= 3,	/* index of Control register */
	STRAP_REG 	= 5,	/* index of Strap register */
	MISC_REG 	= 6	/* index of Miscellaneous register */
};

static int pci_clock;	/* 0 = 33 1 = 25 */

/**
 *	optidma_pre_reset		-	probe begin
 *	@ap: ATA port
 *
 *	Set up cable type and use generic probe init
 */

static int optidma_pre_reset(struct ata_port *ap)
{
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	static const struct pci_bits optidma_enable_bits = {
		0x40, 1, 0x08, 0x00
	};

	if (ap->port_no && !pci_test_config_bits(pdev, &optidma_enable_bits))
		return -ENOENT;

	ap->cbl = ATA_CBL_PATA40;
	return ata_std_prereset(ap);
}

/**
 *	optidma_probe_reset		-	probe reset
 *	@ap: ATA port
 *
 *	Perform the ATA probe and bus reset sequence plus specific handling
 *	for this hardware. The Opti needs little handling - we have no UDMA66
 *	capability that needs cable detection. All we must do is check the port
 *	is enabled.
 */

static void optidma_error_handler(struct ata_port *ap)
{
	ata_bmdma_drive_eh(ap, optidma_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
}

/**
 *	optidma_unlock		-	unlock control registers
 *	@ap: ATA port
 *
 *	Unlock the control register block for this adapter. Registers must not
 *	be unlocked in a situation where libata might look at them.
 */

static void optidma_unlock(struct ata_port *ap)
{
	unsigned long regio = ap->ioaddr.cmd_addr;

	/* These 3 unlock the control register access */
	inw(regio + 1);
	inw(regio + 1);
	outb(3, regio + 2);
}

/**
 *	optidma_lock		-	issue temporary relock
 *	@ap: ATA port
 *
 *	Re-lock the configuration register settings.
 */

static void optidma_lock(struct ata_port *ap)
{
	unsigned long regio = ap->ioaddr.cmd_addr;

	/* Relock */
	outb(0x83, regio + 2);
}

/**
 *	optidma_set_mode	-	set mode data
 *	@ap: ATA interface
 *	@adev: ATA device
 *	@mode: Mode to set
 *
 *	Called to do the DMA or PIO mode setup. Timing numbers are all
 *	pre computed to keep the code clean. There are two tables depending
 *	on the hardware clock speed.
 *
 *	WARNING: While we do this the IDE registers vanish. If we take an
 *	IRQ here we depend on the host set locking to avoid catastrophe.
 */

static void optidma_set_mode(struct ata_port *ap, struct ata_device *adev, u8 mode)
{
	struct ata_device *pair = ata_dev_pair(adev);
	int pio = adev->pio_mode - XFER_PIO_0;
	int dma = adev->dma_mode - XFER_MW_DMA_0;
	unsigned long regio = ap->ioaddr.cmd_addr;
	u8 addr;

	/* Address table precomputed with a DCLK of 2 */
	static const u8 addr_timing[2][5] = {
		{ 0x30, 0x20, 0x20, 0x10, 0x10 },
		{ 0x20, 0x20, 0x10, 0x10, 0x10 }
	};
	static const u8 data_rec_timing[2][5] = {
		{ 0x59, 0x46, 0x30, 0x20, 0x20 },
		{ 0x46, 0x32, 0x20, 0x20, 0x10 }
	};
	static const u8 dma_data_rec_timing[2][3] = {
		{ 0x76, 0x20, 0x20 },
		{ 0x54, 0x20, 0x10 }
	};

	/* Switch from IDE to control mode */
	optidma_unlock(ap);


	/*
 	 *	As with many controllers the address setup time is shared
 	 *	and must suit both devices if present. FIXME: Check if we
 	 *	need to look at slowest of PIO/DMA mode of either device
	 */

	if (mode >= XFER_MW_DMA_0)
		addr = 0;
	else
		addr = addr_timing[pci_clock][pio];

	if (pair) {
		u8 pair_addr;
		/* Hardware constraint */
		if (pair->dma_mode)
			pair_addr = 0;
		else
			pair_addr = addr_timing[pci_clock][pair->pio_mode - XFER_PIO_0];
		if (pair_addr > addr)
			addr = pair_addr;
	}

	/* Commence primary programming sequence */
	/* First we load the device number into the timing select */
	outb(adev->devno, regio + MISC_REG);
	/* Now we load the data timings into read data/write data */
	if (mode < XFER_MW_DMA_0) {
		outb(data_rec_timing[pci_clock][pio], regio + READ_REG);
		outb(data_rec_timing[pci_clock][pio], regio + WRITE_REG);
	} else if (mode < XFER_UDMA_0) {
		outb(dma_data_rec_timing[pci_clock][dma], regio + READ_REG);
		outb(dma_data_rec_timing[pci_clock][dma], regio + WRITE_REG);
	}
	/* Finally we load the address setup into the misc register */
	outb(addr | adev->devno, regio + MISC_REG);

	/* Programming sequence complete, timing 0 dev 0, timing 1 dev 1 */
	outb(0x85, regio + CNTRL_REG);

	/* Switch back to IDE mode */
	optidma_lock(ap);

	/* Note: at this point our programming is incomplete. We are
	   not supposed to program PCI 0x43 "things we hacked onto the chip"
	   until we've done both sets of PIO/DMA timings */
}

/**
 *	optiplus_set_mode	-	DMA setup for Firestar Plus
 *	@ap: ATA port
 *	@adev: device
 *	@mode: desired mode
 *
 *	The Firestar plus has additional UDMA functionality for UDMA0-2 and
 *	requires we do some additional work. Because the base work we must do
 *	is mostly shared we wrap the Firestar setup functionality in this
 *	one
 */

static void optiplus_set_mode(struct ata_port *ap, struct ata_device *adev, u8 mode)
{
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	u8 udcfg;
	u8 udslave;
	int dev2 = 2 * adev->devno;
	int unit = 2 * ap->port_no + adev->devno;
	int udma = mode - XFER_UDMA_0;

	pci_read_config_byte(pdev, 0x44, &udcfg);
	if (mode <= XFER_UDMA_0) {
		udcfg &= ~(1 << unit);
		optidma_set_mode(ap, adev, adev->dma_mode);
	} else {
		udcfg |=  (1 << unit);
		if (ap->port_no) {
			pci_read_config_byte(pdev, 0x45, &udslave);
			udslave &= ~(0x03 << dev2);
			udslave |= (udma << dev2);
			pci_write_config_byte(pdev, 0x45, udslave);
		} else {
			udcfg &= ~(0x30 << dev2);
			udcfg |= (udma << dev2);
		}
	}
	pci_write_config_byte(pdev, 0x44, udcfg);
}

/**
 *	optidma_set_pio_mode	-	PIO setup callback
 *	@ap: ATA port
 *	@adev: Device
 *
 *	The libata core provides separate functions for handling PIO and
 *	DMA programming. The architecture of the Firestar makes it easier
 *	for us to have a common function so we provide wrappers
 */

static void optidma_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
{
	optidma_set_mode(ap, adev, adev->pio_mode);
}

/**
 *	optidma_set_dma_mode	-	DMA setup callback
 *	@ap: ATA port
 *	@adev: Device
 *
 *	The libata core provides separate functions for handling PIO and
 *	DMA programming. The architecture of the Firestar makes it easier
 *	for us to have a common function so we provide wrappers
 */

static void optidma_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
{
	optidma_set_mode(ap, adev, adev->dma_mode);
}

/**
 *	optiplus_set_pio_mode	-	PIO setup callback
 *	@ap: ATA port
 *	@adev: Device
 *
 *	The libata core provides separate functions for handling PIO and
 *	DMA programming. The architecture of the Firestar makes it easier
 *	for us to have a common function so we provide wrappers
 */

static void optiplus_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
{
	optiplus_set_mode(ap, adev, adev->pio_mode);
}

/**
 *	optiplus_set_dma_mode	-	DMA setup callback
 *	@ap: ATA port
 *	@adev: Device
 *
 *	The libata core provides separate functions for handling PIO and
 *	DMA programming. The architecture of the Firestar makes it easier
 *	for us to have a common function so we provide wrappers
 */

static void optiplus_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
{
	optiplus_set_mode(ap, adev, adev->dma_mode);
}

/**
 *	optidma_make_bits	-	PCI setup helper
 *	@adev: ATA device
 *
 *	Turn the ATA device setup into PCI configuration bits
 *	for register 0x43 and return the two bits needed.
 */

static u8 optidma_make_bits43(struct ata_device *adev)
{
	static const u8 bits43[5] = {
		0, 0, 0, 1, 2
	};
	if (!ata_dev_enabled(adev))
		return 0;
	if (adev->dma_mode)
		return adev->dma_mode - XFER_MW_DMA_0;
	return bits43[adev->pio_mode - XFER_PIO_0];
}

/**
 *	optidma_post_set_mode	-	finalize PCI setup
 *	@ap: port to set up
 *
 *	Finalise the configuration by writing the nibble of extra bits
 *	of data into the chip.
 */

static void optidma_post_set_mode(struct ata_port *ap)
{
	u8 r;
	int nybble = 4 * ap->port_no;
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);

	pci_read_config_byte(pdev, 0x43, &r);

	r &= (0x0F << nybble);
	r |= (optidma_make_bits43(&ap->device[0]) +
	     (optidma_make_bits43(&ap->device[0]) << 2)) << nybble;

	pci_write_config_byte(pdev, 0x43, r);
}

static struct scsi_host_template optidma_sht = {
	.module			= THIS_MODULE,
	.name			= DRV_NAME,
	.ioctl			= ata_scsi_ioctl,
	.queuecommand		= ata_scsi_queuecmd,
	.can_queue		= ATA_DEF_QUEUE,
	.this_id		= ATA_SHT_THIS_ID,
	.sg_tablesize		= LIBATA_MAX_PRD,
	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
	.emulated		= ATA_SHT_EMULATED,
	.use_clustering		= ATA_SHT_USE_CLUSTERING,
	.proc_name		= DRV_NAME,
	.dma_boundary		= ATA_DMA_BOUNDARY,
	.slave_configure	= ata_scsi_slave_config,
	.slave_destroy		= ata_scsi_slave_destroy,
	.bios_param		= ata_std_bios_param,
	.resume			= ata_scsi_device_resume,
	.suspend		= ata_scsi_device_suspend,
};

static struct ata_port_operations optidma_port_ops = {
	.port_disable	= ata_port_disable,
	.set_piomode	= optidma_set_pio_mode,
	.set_dmamode	= optidma_set_dma_mode,

	.tf_load	= ata_tf_load,
	.tf_read	= ata_tf_read,
	.check_status 	= ata_check_status,
	.exec_command	= ata_exec_command,
	.dev_select 	= ata_std_dev_select,

	.freeze		= ata_bmdma_freeze,
	.thaw		= ata_bmdma_thaw,
	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	.error_handler	= optidma_error_handler,
	.post_set_mode	= optidma_post_set_mode,

	.bmdma_setup 	= ata_bmdma_setup,
	.bmdma_start 	= ata_bmdma_start,
	.bmdma_stop	= ata_bmdma_stop,
	.bmdma_status 	= ata_bmdma_status,

	.qc_prep 	= ata_qc_prep,
	.qc_issue	= ata_qc_issue_prot,

	.data_xfer	= ata_pio_data_xfer,

	.irq_handler	= ata_interrupt,
	.irq_clear	= ata_bmdma_irq_clear,

	.port_start	= ata_port_start,
	.port_stop	= ata_port_stop,
	.host_stop	= ata_host_stop
};

static struct ata_port_operations optiplus_port_ops = {
	.port_disable	= ata_port_disable,
	.set_piomode	= optiplus_set_pio_mode,
	.set_dmamode	= optiplus_set_dma_mode,

	.tf_load	= ata_tf_load,
	.tf_read	= ata_tf_read,
	.check_status 	= ata_check_status,
	.exec_command	= ata_exec_command,
	.dev_select 	= ata_std_dev_select,

	.freeze		= ata_bmdma_freeze,
	.thaw		= ata_bmdma_thaw,
	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	.error_handler	= optidma_error_handler,
	.post_set_mode	= optidma_post_set_mode,

	.bmdma_setup 	= ata_bmdma_setup,
	.bmdma_start 	= ata_bmdma_start,
	.bmdma_stop	= ata_bmdma_stop,
	.bmdma_status 	= ata_bmdma_status,

	.qc_prep 	= ata_qc_prep,
	.qc_issue	= ata_qc_issue_prot,

	.data_xfer	= ata_pio_data_xfer,

	.irq_handler	= ata_interrupt,
	.irq_clear	= ata_bmdma_irq_clear,

	.port_start	= ata_port_start,
	.port_stop	= ata_port_stop,
	.host_stop	= ata_host_stop
};

/**
 *	optiplus_with_udma	-	Look for UDMA capable setup
 *	@pdev; ATA controller
 */

static int optiplus_with_udma(struct pci_dev *pdev)
{
	u8 r;
	int ret = 0;
	int ioport = 0x22;
	struct pci_dev *dev1;

	/* Find function 1 */
	dev1 = pci_get_device(0x1045, 0xC701, NULL);
	if(dev1 == NULL)
		return 0;

	/* Rev must be >= 0x10 */
	pci_read_config_byte(dev1, 0x08, &r);
	if (r < 0x10)
		goto done_nomsg;
	/* Read the chipset system configuration to check our mode */
	pci_read_config_byte(dev1, 0x5F, &r);
	ioport |= (r << 8);
	outb(0x10, ioport);
	/* Must be 66Mhz sync */
	if ((inb(ioport + 2) & 1) == 0)
		goto done;

	/* Check the ATA arbitration/timing is suitable */
	pci_read_config_byte(pdev, 0x42, &r);
	if ((r & 0x36) != 0x36)
		goto done;
	pci_read_config_byte(dev1, 0x52, &r);
	if (r & 0x80)	/* IDEDIR disabled */
		ret = 1;
done:
	printk(KERN_WARNING "UDMA not supported in this configuration.\n");
done_nomsg:		/* Wrong chip revision */
	pci_dev_put(dev1);
	return ret;
}

static int optidma_init_one(struct pci_dev *dev, const struct pci_device_id *id)
{
	static struct ata_port_info info_82c700 = {
		.sht = &optidma_sht,
		.flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
		.pio_mask = 0x1f,
		.mwdma_mask = 0x07,
		.port_ops = &optidma_port_ops
	};
	static struct ata_port_info info_82c700_udma = {
		.sht = &optidma_sht,
		.flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
		.pio_mask = 0x1f,
		.mwdma_mask = 0x07,
		.udma_mask = 0x07,
		.port_ops = &optiplus_port_ops
	};
	static struct ata_port_info *port_info[2];
	struct ata_port_info *info = &info_82c700;
	static int printed_version;

	if (!printed_version++)
		dev_printk(KERN_DEBUG, &dev->dev, "version " DRV_VERSION "\n");

	/* Fixed location chipset magic */
	inw(0x1F1);
	inw(0x1F1);
	pci_clock = inb(0x1F5) & 1;		/* 0 = 33Mhz, 1 = 25Mhz */

	if (optiplus_with_udma(dev))
		info = &info_82c700_udma;

	port_info[0] = port_info[1] = info;
	return ata_pci_init_one(dev, port_info, 2);
}

static const struct pci_device_id optidma[] = {
	{ PCI_VDEVICE(OPTI, 0xD568), },		/* Opti 82C700 */

	{ },
};

static struct pci_driver optidma_pci_driver = {
	.name 		= DRV_NAME,
	.id_table	= optidma,
	.probe 		= optidma_init_one,
	.remove		= ata_pci_remove_one,
	.suspend	= ata_pci_device_suspend,
	.resume		= ata_pci_device_resume,
};

static int __init optidma_init(void)
{
	return pci_register_driver(&optidma_pci_driver);
}

static void __exit optidma_exit(void)
{
	pci_unregister_driver(&optidma_pci_driver);
}

MODULE_AUTHOR("Alan Cox");
MODULE_DESCRIPTION("low-level driver for Opti Firestar/Firestar Plus");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, optidma);
MODULE_VERSION(DRV_VERSION);

module_init(optidma_init);
module_exit(optidma_exit);
Commit	Line	Data
669a5db4 JG	1	/*
	2	* pata_optidma.c - Opti DMA PATA for new ATA layer
	3	* (C) 2006 Red Hat Inc
	4	* Alan Cox <alan@redhat.com>
	5	*
	6	* The Opti DMA controllers are related to the older PIO PCI controllers
	7	* and indeed the VLB ones. The main differences are that the timing
	8	* numbers are now based off PCI clocks not VLB and differ, and that
	9	* MWDMA is supported.
	10	*
	11	* This driver should support Viper-N+, FireStar, FireStar Plus.
	12	*
	13	* These devices support virtual DMA for read (aka the CS5520). Later
	14	* chips support UDMA33, but only if the rest of the board logic does,
	15	* so you have to get this right. We don't support the virtual DMA
	16	* but we do handle UDMA.
	17	*
	18	* Bits that are worth knowing
	19	* Most control registers are shadowed into I/O registers
	20	* 0x1F5 bit 0 tells you if the PCI/VLB clock is 33 or 25Mhz
	21	* Virtual DMA registers move between rev 0x02 and rev 0x10
	22	* UDMA requires a 66MHz FSB
	23	*
	24	*/
	25
	26	#include <linux/kernel.h>
	27	#include <linux/module.h>
	28	#include <linux/pci.h>
	29	#include <linux/init.h>
	30	#include <linux/blkdev.h>
	31	#include <linux/delay.h>
	32	#include <scsi/scsi_host.h>
	33	#include <linux/libata.h>
	34
	35	#define DRV_NAME "pata_optidma"
30ced0f0	36	#define DRV_VERSION "0.2.3"
669a5db4 JG	37
	38	enum {
	39	READ_REG = 0, /* index of Read cycle timing register */
	40	WRITE_REG = 1, /* index of Write cycle timing register */
	41	CNTRL_REG = 3, /* index of Control register */
	42	STRAP_REG = 5, /* index of Strap register */
	43	MISC_REG = 6 /* index of Miscellaneous register */
	44	};
	45
	46	static int pci_clock; /* 0 = 33 1 = 25 */
	47
	48	/**
	49	* optidma_pre_reset - probe begin
	50	* @ap: ATA port
	51	*
	52	* Set up cable type and use generic probe init
	53	*/
85cd7251	54
669a5db4 JG	55	static int optidma_pre_reset(struct ata_port *ap)
	56	{
	57	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
85cd7251	58	static const struct pci_bits optidma_enable_bits = {
669a5db4 JG	59	0x40, 1, 0x08, 0x00
	60	};
	61
c961922b AC	62	if (ap->port_no && !pci_test_config_bits(pdev, &optidma_enable_bits))
	63	return -ENOENT;
	64
669a5db4 JG	65	ap->cbl = ATA_CBL_PATA40;
	66	return ata_std_prereset(ap);
	67	}
	68
	69	/**
	70	* optidma_probe_reset - probe reset
	71	* @ap: ATA port
	72	*
	73	* Perform the ATA probe and bus reset sequence plus specific handling
	74	* for this hardware. The Opti needs little handling - we have no UDMA66
	75	* capability that needs cable detection. All we must do is check the port
	76	* is enabled.
	77	*/
	78
	79	static void optidma_error_handler(struct ata_port *ap)
	80	{
	81	ata_bmdma_drive_eh(ap, optidma_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
	82	}
	83
	84	/**
	85	* optidma_unlock - unlock control registers
	86	* @ap: ATA port
	87	*
	88	* Unlock the control register block for this adapter. Registers must not
	89	* be unlocked in a situation where libata might look at them.
	90	*/
85cd7251	91
669a5db4 JG	92	static void optidma_unlock(struct ata_port *ap)
	93	{
	94	unsigned long regio = ap->ioaddr.cmd_addr;
85cd7251	95
669a5db4 JG	96	/* These 3 unlock the control register access */
	97	inw(regio + 1);
	98	inw(regio + 1);
	99	outb(3, regio + 2);
	100	}
	101
	102	/**
	103	* optidma_lock - issue temporary relock
	104	* @ap: ATA port
	105	*
	106	* Re-lock the configuration register settings.
	107	*/
85cd7251	108
669a5db4 JG	109	static void optidma_lock(struct ata_port *ap)
	110	{
	111	unsigned long regio = ap->ioaddr.cmd_addr;
85cd7251	112
669a5db4 JG	113	/* Relock */
	114	outb(0x83, regio + 2);
	115	}
	116
	117	/**
	118	* optidma_set_mode - set mode data
	119	* @ap: ATA interface
	120	* @adev: ATA device
	121	* @mode: Mode to set
	122	*
	123	* Called to do the DMA or PIO mode setup. Timing numbers are all
	124	* pre computed to keep the code clean. There are two tables depending
	125	* on the hardware clock speed.
	126	*
	127	* WARNING: While we do this the IDE registers vanish. If we take an
	128	* IRQ here we depend on the host set locking to avoid catastrophe.
	129	*/
	130
	131	static void optidma_set_mode(struct ata_port ap, struct ata_device adev, u8 mode)
	132	{
	133	struct ata_device *pair = ata_dev_pair(adev);
	134	int pio = adev->pio_mode - XFER_PIO_0;
	135	int dma = adev->dma_mode - XFER_MW_DMA_0;
	136	unsigned long regio = ap->ioaddr.cmd_addr;
	137	u8 addr;
	138
	139	/* Address table precomputed with a DCLK of 2 */
	140	static const u8 addr_timing[2][5] = {
	141	{ 0x30, 0x20, 0x20, 0x10, 0x10 },
	142	{ 0x20, 0x20, 0x10, 0x10, 0x10 }
	143	};
	144	static const u8 data_rec_timing[2][5] = {
	145	{ 0x59, 0x46, 0x30, 0x20, 0x20 },
	146	{ 0x46, 0x32, 0x20, 0x20, 0x10 }
	147	};
	148	static const u8 dma_data_rec_timing[2][3] = {
	149	{ 0x76, 0x20, 0x20 },
	150	{ 0x54, 0x20, 0x10 }
	151	};
	152
	153	/* Switch from IDE to control mode */
	154	optidma_unlock(ap);
85cd7251	155
669a5db4 JG	156
	157	/*
	158	* As with many controllers the address setup time is shared
	159	* and must suit both devices if present. FIXME: Check if we
	160	* need to look at slowest of PIO/DMA mode of either device
	161	*/
	162
	163	if (mode >= XFER_MW_DMA_0)
	164	addr = 0;
	165	else
	166	addr = addr_timing[pci_clock][pio];
85cd7251	167
669a5db4 JG	168	if (pair) {
	169	u8 pair_addr;
	170	/* Hardware constraint */
	171	if (pair->dma_mode)
	172	pair_addr = 0;
	173	else
	174	pair_addr = addr_timing[pci_clock][pair->pio_mode - XFER_PIO_0];
	175	if (pair_addr > addr)
	176	addr = pair_addr;
	177	}
85cd7251	178
669a5db4 JG	179	/* Commence primary programming sequence */
	180	/* First we load the device number into the timing select */
	181	outb(adev->devno, regio + MISC_REG);
	182	/* Now we load the data timings into read data/write data */
	183	if (mode < XFER_MW_DMA_0) {
	184	outb(data_rec_timing[pci_clock][pio], regio + READ_REG);
	185	outb(data_rec_timing[pci_clock][pio], regio + WRITE_REG);
	186	} else if (mode < XFER_UDMA_0) {
	187	outb(dma_data_rec_timing[pci_clock][dma], regio + READ_REG);
	188	outb(dma_data_rec_timing[pci_clock][dma], regio + WRITE_REG);
	189	}
	190	/* Finally we load the address setup into the misc register */
	191	outb(addr \| adev->devno, regio + MISC_REG);
	192
	193	/* Programming sequence complete, timing 0 dev 0, timing 1 dev 1 */
	194	outb(0x85, regio + CNTRL_REG);
85cd7251	195
669a5db4 JG	196	/* Switch back to IDE mode */
669a5db4 JG	197	optidma_lock(ap);
85cd7251	198
669a5db4 JG	199	/* Note: at this point our programming is incomplete. We are
	200	not supposed to program PCI 0x43 "things we hacked onto the chip"
	201	until we've done both sets of PIO/DMA timings */
	202	}
	203
	204	/**
	205	* optiplus_set_mode - DMA setup for Firestar Plus
	206	* @ap: ATA port
	207	* @adev: device
	208	* @mode: desired mode
	209	*
	210	* The Firestar plus has additional UDMA functionality for UDMA0-2 and
	211	* requires we do some additional work. Because the base work we must do
	212	* is mostly shared we wrap the Firestar setup functionality in this
	213	* one
	214	*/
	215
	216	static void optiplus_set_mode(struct ata_port ap, struct ata_device adev, u8 mode)
	217	{
	218	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	219	u8 udcfg;
	220	u8 udslave;
	221	int dev2 = 2 * adev->devno;
	222	int unit = 2 * ap->port_no + adev->devno;
	223	int udma = mode - XFER_UDMA_0;
85cd7251	224
669a5db4 JG	225	pci_read_config_byte(pdev, 0x44, &udcfg);
	226	if (mode <= XFER_UDMA_0) {
	227	udcfg &= ~(1 << unit);
	228	optidma_set_mode(ap, adev, adev->dma_mode);
	229	} else {
	230	udcfg \|= (1 << unit);
	231	if (ap->port_no) {
	232	pci_read_config_byte(pdev, 0x45, &udslave);
	233	udslave &= ~(0x03 << dev2);
	234	udslave \|= (udma << dev2);
	235	pci_write_config_byte(pdev, 0x45, udslave);
	236	} else {
	237	udcfg &= ~(0x30 << dev2);
	238	udcfg \|= (udma << dev2);
	239	}
	240	}
	241	pci_write_config_byte(pdev, 0x44, udcfg);
	242	}
	243
	244	/**
	245	* optidma_set_pio_mode - PIO setup callback
	246	* @ap: ATA port
	247	* @adev: Device
	248	*
	249	* The libata core provides separate functions for handling PIO and
	250	* DMA programming. The architecture of the Firestar makes it easier
	251	* for us to have a common function so we provide wrappers
	252	*/
85cd7251	253
669a5db4 JG	254	static void optidma_set_pio_mode(struct ata_port ap, struct ata_device adev)
	255	{
	256	optidma_set_mode(ap, adev, adev->pio_mode);
	257	}
	258
	259	/**
	260	* optidma_set_dma_mode - DMA setup callback
	261	* @ap: ATA port
	262	* @adev: Device
	263	*
	264	* The libata core provides separate functions for handling PIO and
	265	* DMA programming. The architecture of the Firestar makes it easier
	266	* for us to have a common function so we provide wrappers
	267	*/
85cd7251	268
669a5db4 JG	269	static void optidma_set_dma_mode(struct ata_port ap, struct ata_device adev)
	270	{
	271	optidma_set_mode(ap, adev, adev->dma_mode);
	272	}
	273
	274	/**
	275	* optiplus_set_pio_mode - PIO setup callback
	276	* @ap: ATA port
	277	* @adev: Device
	278	*
	279	* The libata core provides separate functions for handling PIO and
	280	* DMA programming. The architecture of the Firestar makes it easier
	281	* for us to have a common function so we provide wrappers
	282	*/
85cd7251	283
669a5db4 JG	284	static void optiplus_set_pio_mode(struct ata_port ap, struct ata_device adev)
	285	{
	286	optiplus_set_mode(ap, adev, adev->pio_mode);
	287	}
	288
	289	/**
	290	* optiplus_set_dma_mode - DMA setup callback
	291	* @ap: ATA port
	292	* @adev: Device
	293	*
	294	* The libata core provides separate functions for handling PIO and
	295	* DMA programming. The architecture of the Firestar makes it easier
	296	* for us to have a common function so we provide wrappers
	297	*/
85cd7251	298
669a5db4 JG	299	static void optiplus_set_dma_mode(struct ata_port ap, struct ata_device adev)
	300	{
	301	optiplus_set_mode(ap, adev, adev->dma_mode);
	302	}
	303
	304	/**
	305	* optidma_make_bits - PCI setup helper
	306	* @adev: ATA device
	307	*
	308	* Turn the ATA device setup into PCI configuration bits
	309	* for register 0x43 and return the two bits needed.
	310	*/
85cd7251	311
669a5db4 JG	312	static u8 optidma_make_bits43(struct ata_device *adev)
	313	{
	314	static const u8 bits43[5] = {
	315	0, 0, 0, 1, 2
	316	};
	317	if (!ata_dev_enabled(adev))
	318	return 0;
	319	if (adev->dma_mode)
	320	return adev->dma_mode - XFER_MW_DMA_0;
	321	return bits43[adev->pio_mode - XFER_PIO_0];
	322	}
	323
	324	/**
	325	* optidma_post_set_mode - finalize PCI setup
	326	* @ap: port to set up
	327	*
	328	* Finalise the configuration by writing the nibble of extra bits
	329	* of data into the chip.
	330	*/
85cd7251	331
669a5db4 JG	332	static void optidma_post_set_mode(struct ata_port *ap)
	333	{
	334	u8 r;
	335	int nybble = 4 * ap->port_no;
	336	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
85cd7251	337
669a5db4	338	pci_read_config_byte(pdev, 0x43, &r);
85cd7251	339
669a5db4	340	r &= (0x0F << nybble);
85cd7251	341	r \|= (optidma_make_bits43(&ap->device[0]) +
669a5db4 JG	342	(optidma_make_bits43(&ap->device[0]) << 2)) << nybble;
	343
	344	pci_write_config_byte(pdev, 0x43, r);
	345	}
	346
	347	static struct scsi_host_template optidma_sht = {
	348	.module = THIS_MODULE,
	349	.name = DRV_NAME,
	350	.ioctl = ata_scsi_ioctl,
	351	.queuecommand = ata_scsi_queuecmd,
	352	.can_queue = ATA_DEF_QUEUE,
	353	.this_id = ATA_SHT_THIS_ID,
	354	.sg_tablesize = LIBATA_MAX_PRD,
669a5db4 JG	355	.cmd_per_lun = ATA_SHT_CMD_PER_LUN,
	356	.emulated = ATA_SHT_EMULATED,
	357	.use_clustering = ATA_SHT_USE_CLUSTERING,
	358	.proc_name = DRV_NAME,
	359	.dma_boundary = ATA_DMA_BOUNDARY,
	360	.slave_configure = ata_scsi_slave_config,
afdfe899	361	.slave_destroy = ata_scsi_slave_destroy,
669a5db4	362	.bios_param = ata_std_bios_param,
30ced0f0 AC	363	.resume = ata_scsi_device_resume,
30ced0f0 AC	364	.suspend = ata_scsi_device_suspend,
669a5db4 JG	365	};
	366
	367	static struct ata_port_operations optidma_port_ops = {
	368	.port_disable = ata_port_disable,
	369	.set_piomode = optidma_set_pio_mode,
	370	.set_dmamode = optidma_set_dma_mode,
	371
	372	.tf_load = ata_tf_load,
	373	.tf_read = ata_tf_read,
	374	.check_status = ata_check_status,
	375	.exec_command = ata_exec_command,
	376	.dev_select = ata_std_dev_select,
	377
	378	.freeze = ata_bmdma_freeze,
	379	.thaw = ata_bmdma_thaw,
	380	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	381	.error_handler = optidma_error_handler,
	382	.post_set_mode = optidma_post_set_mode,
	383
	384	.bmdma_setup = ata_bmdma_setup,
	385	.bmdma_start = ata_bmdma_start,
	386	.bmdma_stop = ata_bmdma_stop,
	387	.bmdma_status = ata_bmdma_status,
	388
	389	.qc_prep = ata_qc_prep,
	390	.qc_issue = ata_qc_issue_prot,
bda30288	391
669a5db4 JG	392	.data_xfer = ata_pio_data_xfer,
	393
	394	.irq_handler = ata_interrupt,
	395	.irq_clear = ata_bmdma_irq_clear,
	396
	397	.port_start = ata_port_start,
	398	.port_stop = ata_port_stop,
	399	.host_stop = ata_host_stop
	400	};
	401
	402	static struct ata_port_operations optiplus_port_ops = {
	403	.port_disable = ata_port_disable,
	404	.set_piomode = optiplus_set_pio_mode,
	405	.set_dmamode = optiplus_set_dma_mode,
	406
	407	.tf_load = ata_tf_load,
	408	.tf_read = ata_tf_read,
	409	.check_status = ata_check_status,
	410	.exec_command = ata_exec_command,
	411	.dev_select = ata_std_dev_select,
	412
	413	.freeze = ata_bmdma_freeze,
	414	.thaw = ata_bmdma_thaw,
	415	.post_internal_cmd = ata_bmdma_post_internal_cmd,
	416	.error_handler = optidma_error_handler,
	417	.post_set_mode = optidma_post_set_mode,
	418
	419	.bmdma_setup = ata_bmdma_setup,
	420	.bmdma_start = ata_bmdma_start,
	421	.bmdma_stop = ata_bmdma_stop,
	422	.bmdma_status = ata_bmdma_status,
	423
	424	.qc_prep = ata_qc_prep,
	425	.qc_issue = ata_qc_issue_prot,
bda30288	426
669a5db4 JG	427	.data_xfer = ata_pio_data_xfer,
	428
	429	.irq_handler = ata_interrupt,
	430	.irq_clear = ata_bmdma_irq_clear,
	431
	432	.port_start = ata_port_start,
	433	.port_stop = ata_port_stop,
	434	.host_stop = ata_host_stop
	435	};
	436
	437	/**
	438	* optiplus_with_udma - Look for UDMA capable setup
	439	* @pdev; ATA controller
	440	*/
85cd7251	441
669a5db4 JG	442	static int optiplus_with_udma(struct pci_dev *pdev)
	443	{
	444	u8 r;
	445	int ret = 0;
	446	int ioport = 0x22;
	447	struct pci_dev *dev1;
85cd7251	448
669a5db4 JG	449	/* Find function 1 */
	450	dev1 = pci_get_device(0x1045, 0xC701, NULL);
	451	if(dev1 == NULL)
	452	return 0;
85cd7251	453
669a5db4 JG	454	/* Rev must be >= 0x10 */
	455	pci_read_config_byte(dev1, 0x08, &r);
	456	if (r < 0x10)
	457	goto done_nomsg;
	458	/* Read the chipset system configuration to check our mode */
	459	pci_read_config_byte(dev1, 0x5F, &r);
	460	ioport \|= (r << 8);
	461	outb(0x10, ioport);
	462	/* Must be 66Mhz sync */
	463	if ((inb(ioport + 2) & 1) == 0)
	464	goto done;
	465
	466	/* Check the ATA arbitration/timing is suitable */
	467	pci_read_config_byte(pdev, 0x42, &r);
	468	if ((r & 0x36) != 0x36)
	469	goto done;
	470	pci_read_config_byte(dev1, 0x52, &r);
	471	if (r & 0x80) /* IDEDIR disabled */
	472	ret = 1;
85cd7251	473	done:
669a5db4 JG	474	printk(KERN_WARNING "UDMA not supported in this configuration.\n");
	475	done_nomsg: /* Wrong chip revision */
	476	pci_dev_put(dev1);
	477	return ret;
	478	}
	479
	480	static int optidma_init_one(struct pci_dev dev, const struct pci_device_id id)
	481	{
	482	static struct ata_port_info info_82c700 = {
	483	.sht = &optidma_sht,
	484	.flags = ATA_FLAG_SLAVE_POSS \| ATA_FLAG_SRST,
	485	.pio_mask = 0x1f,
	486	.mwdma_mask = 0x07,
	487	.port_ops = &optidma_port_ops
	488	};
	489	static struct ata_port_info info_82c700_udma = {
	490	.sht = &optidma_sht,
	491	.flags = ATA_FLAG_SLAVE_POSS \| ATA_FLAG_SRST,
	492	.pio_mask = 0x1f,
	493	.mwdma_mask = 0x07,
	494	.udma_mask = 0x07,
	495	.port_ops = &optiplus_port_ops
	496	};
	497	static struct ata_port_info *port_info[2];
	498	struct ata_port_info *info = &info_82c700;
	499	static int printed_version;
	500
	501	if (!printed_version++)
	502	dev_printk(KERN_DEBUG, &dev->dev, "version " DRV_VERSION "\n");
	503
	504	/* Fixed location chipset magic */
	505	inw(0x1F1);
	506	inw(0x1F1);
	507	pci_clock = inb(0x1F5) & 1; /* 0 = 33Mhz, 1 = 25Mhz */
85cd7251	508
669a5db4 JG	509	if (optiplus_with_udma(dev))
	510	info = &info_82c700_udma;
	511
	512	port_info[0] = port_info[1] = info;
	513	return ata_pci_init_one(dev, port_info, 2);
	514	}
	515
	516	static const struct pci_device_id optidma[] = {
2d2744fc JG	517	{ PCI_VDEVICE(OPTI, 0xD568), }, /* Opti 82C700 */
	518
	519	{ },
669a5db4 JG	520	};
	521
	522	static struct pci_driver optidma_pci_driver = {
2d2744fc	523	.name = DRV_NAME,
669a5db4 JG	524	.id_table = optidma,
669a5db4 JG	525	.probe = optidma_init_one,
30ced0f0 AC	526	.remove = ata_pci_remove_one,
	527	.suspend = ata_pci_device_suspend,
	528	.resume = ata_pci_device_resume,
669a5db4 JG	529	};
	530
	531	static int __init optidma_init(void)
	532	{
	533	return pci_register_driver(&optidma_pci_driver);
	534	}
	535
669a5db4 JG	536	static void __exit optidma_exit(void)
	537	{
	538	pci_unregister_driver(&optidma_pci_driver);
	539	}
	540
669a5db4 JG	541	MODULE_AUTHOR("Alan Cox");
	542	MODULE_DESCRIPTION("low-level driver for Opti Firestar/Firestar Plus");
	543	MODULE_LICENSE("GPL");
	544	MODULE_DEVICE_TABLE(pci, optidma);
	545	MODULE_VERSION(DRV_VERSION);
	546
	547	module_init(optidma_init);
	548	module_exit(optidma_exit);