[mirror_ubuntu-eoan-kernel.git] / drivers / ide / cy82c693.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 *  Copyright (C) 1998-2000 Andreas S. Krebs (akrebs@altavista.net), Maintainer
 *  Copyright (C) 1998-2002 Andre Hedrick <andre@linux-ide.org>, Integrator
 *  Copyright (C) 2007-2011 Bartlomiej Zolnierkiewicz
 *
 * CYPRESS CY82C693 chipset IDE controller
 *
 * The CY82C693 chipset is used on Digital's PC-Alpha 164SX boards.
 */

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

#include <asm/io.h>

#define DRV_NAME "cy82c693"

/*
 *	NOTE: the value for busmaster timeout is tricky and I got it by
 *	trial and error!  By using a to low value will cause DMA timeouts
 *	and drop IDE performance, and by using a to high value will cause
 *	audio playback to scatter.
 *	If you know a better value or how to calc it, please let me know.
 */

/* twice the value written in cy82c693ub datasheet */
#define BUSMASTER_TIMEOUT	0x50
/*
 * the value above was tested on my machine and it seems to work okay
 */

/* here are the offset definitions for the registers */
#define CY82_IDE_CMDREG		0x04
#define CY82_IDE_ADDRSETUP	0x48
#define CY82_IDE_MASTER_IOR	0x4C
#define CY82_IDE_MASTER_IOW	0x4D
#define CY82_IDE_SLAVE_IOR	0x4E
#define CY82_IDE_SLAVE_IOW	0x4F
#define CY82_IDE_MASTER_8BIT	0x50
#define CY82_IDE_SLAVE_8BIT	0x51

#define CY82_INDEX_PORT		0x22
#define CY82_DATA_PORT		0x23

#define CY82_INDEX_CHANNEL0	0x30
#define CY82_INDEX_CHANNEL1	0x31
#define CY82_INDEX_TIMEOUT	0x32

/*
 * set DMA mode a specific channel for CY82C693
 */

static void cy82c693_set_dma_mode(ide_hwif_t *hwif, ide_drive_t *drive)
{
	const u8 mode = drive->dma_mode;
	u8 single = (mode & 0x10) >> 4, index = 0, data = 0;

	index = hwif->channel ? CY82_INDEX_CHANNEL1 : CY82_INDEX_CHANNEL0;

	data = (mode & 3) | (single << 2);

	outb(index, CY82_INDEX_PORT);
	outb(data, CY82_DATA_PORT);

	/*
	 * note: below we set the value for Bus Master IDE TimeOut Register
	 * I'm not absolutely sure what this does, but it solved my problem
	 * with IDE DMA and sound, so I now can play sound and work with
	 * my IDE driver at the same time :-)
	 *
	 * If you know the correct (best) value for this register please
	 * let me know - ASK
	 */

	data = BUSMASTER_TIMEOUT;
	outb(CY82_INDEX_TIMEOUT, CY82_INDEX_PORT);
	outb(data, CY82_DATA_PORT);
}

static void cy82c693_set_pio_mode(ide_hwif_t *hwif, ide_drive_t *drive)
{
	struct pci_dev *dev = to_pci_dev(hwif->dev);
	int bus_speed = ide_pci_clk ? ide_pci_clk : 33;
	const unsigned long T = 1000000 / bus_speed;
	unsigned int addrCtrl;
	struct ide_timing t;
	u8 time_16, time_8;

	/* select primary or secondary channel */
	if (drive->dn > 1) {  /* drive is on the secondary channel */
		dev = pci_get_slot(dev->bus, dev->devfn+1);
		if (!dev) {
			printk(KERN_ERR "%s: tune_drive: "
				"Cannot find secondary interface!\n",
				drive->name);
			return;
		}
	}

	ide_timing_compute(drive, drive->pio_mode, &t, T, 1);

	time_16 = clamp_val(t.recover - 1, 0, 15) |
		  (clamp_val(t.active - 1, 0, 15) << 4);
	time_8 = clamp_val(t.act8b - 1, 0, 15) |
		 (clamp_val(t.rec8b - 1, 0, 15) << 4);

	/* now let's write  the clocks registers */
	if ((drive->dn & 1) == 0) {
		/*
		 * set master drive
		 * address setup control register
		 * is 32 bit !!!
		 */
		pci_read_config_dword(dev, CY82_IDE_ADDRSETUP, &addrCtrl);

		addrCtrl &= (~0xF);
		addrCtrl |= clamp_val(t.setup - 1, 0, 15);
		pci_write_config_dword(dev, CY82_IDE_ADDRSETUP, addrCtrl);

		/* now let's set the remaining registers */
		pci_write_config_byte(dev, CY82_IDE_MASTER_IOR, time_16);
		pci_write_config_byte(dev, CY82_IDE_MASTER_IOW, time_16);
		pci_write_config_byte(dev, CY82_IDE_MASTER_8BIT, time_8);
	} else {
		/*
		 * set slave drive
		 * address setup control register
		 * is 32 bit !!!
		 */
		pci_read_config_dword(dev, CY82_IDE_ADDRSETUP, &addrCtrl);

		addrCtrl &= (~0xF0);
		addrCtrl |= (clamp_val(t.setup - 1, 0, 15) << 4);
		pci_write_config_dword(dev, CY82_IDE_ADDRSETUP, addrCtrl);

		/* now let's set the remaining registers */
		pci_write_config_byte(dev, CY82_IDE_SLAVE_IOR, time_16);
		pci_write_config_byte(dev, CY82_IDE_SLAVE_IOW, time_16);
		pci_write_config_byte(dev, CY82_IDE_SLAVE_8BIT, time_8);
	}
	if (drive->dn > 1)
		pci_dev_put(dev);
}

static void init_iops_cy82c693(ide_hwif_t *hwif)
{
	static ide_hwif_t *primary;
	struct pci_dev *dev = to_pci_dev(hwif->dev);

	if (PCI_FUNC(dev->devfn) == 1)
		primary = hwif;
	else {
		hwif->mate = primary;
		hwif->channel = 1;
	}
}

static const struct ide_port_ops cy82c693_port_ops = {
	.set_pio_mode		= cy82c693_set_pio_mode,
	.set_dma_mode		= cy82c693_set_dma_mode,
};

static const struct ide_port_info cy82c693_chipset = {
	.name		= DRV_NAME,
	.init_iops	= init_iops_cy82c693,
	.port_ops	= &cy82c693_port_ops,
	.host_flags	= IDE_HFLAG_SINGLE,
	.pio_mask	= ATA_PIO4,
	.swdma_mask	= ATA_SWDMA2,
	.mwdma_mask	= ATA_MWDMA2,
};

static int cy82c693_init_one(struct pci_dev *dev,
			     const struct pci_device_id *id)
{
	struct pci_dev *dev2;
	int ret = -ENODEV;

	/* CY82C693 is more than only a IDE controller.
	   Function 1 is primary IDE channel, function 2 - secondary. */
	if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE &&
	    PCI_FUNC(dev->devfn) == 1) {
		dev2 = pci_get_slot(dev->bus, dev->devfn + 1);
		ret = ide_pci_init_two(dev, dev2, &cy82c693_chipset, NULL);
		if (ret)
			pci_dev_put(dev2);
	}
	return ret;
}

static void cy82c693_remove(struct pci_dev *dev)
{
	struct ide_host *host = pci_get_drvdata(dev);
	struct pci_dev *dev2 = host->dev[1] ? to_pci_dev(host->dev[1]) : NULL;

	ide_pci_remove(dev);
	pci_dev_put(dev2);
}

static const struct pci_device_id cy82c693_pci_tbl[] = {
	{ PCI_VDEVICE(CONTAQ, PCI_DEVICE_ID_CONTAQ_82C693), 0 },
	{ 0, },
};
MODULE_DEVICE_TABLE(pci, cy82c693_pci_tbl);

static struct pci_driver cy82c693_pci_driver = {
	.name		= "Cypress_IDE",
	.id_table	= cy82c693_pci_tbl,
	.probe		= cy82c693_init_one,
	.remove		= cy82c693_remove,
	.suspend	= ide_pci_suspend,
	.resume		= ide_pci_resume,
};

static int __init cy82c693_ide_init(void)
{
	return ide_pci_register_driver(&cy82c693_pci_driver);
}

static void __exit cy82c693_ide_exit(void)
{
	pci_unregister_driver(&cy82c693_pci_driver);
}

module_init(cy82c693_ide_init);
module_exit(cy82c693_ide_exit);

MODULE_AUTHOR("Andreas Krebs, Andre Hedrick, Bartlomiej Zolnierkiewicz");
MODULE_DESCRIPTION("PCI driver module for the Cypress CY82C693 IDE");
MODULE_LICENSE("GPL");
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
1da177e4	2	/*
1da177e4 LT	3	* Copyright (C) 1998-2000 Andreas S. Krebs (akrebs@altavista.net), Maintainer
1da177e4 LT	4	* Copyright (C) 1998-2002 Andre Hedrick <andre@linux-ide.org>, Integrator
0ab3d8b3	5	* Copyright (C) 2007-2011 Bartlomiej Zolnierkiewicz
1da177e4 LT	6	*
	7	* CYPRESS CY82C693 chipset IDE controller
	8	*
	9	* The CY82C693 chipset is used on Digital's PC-Alpha 164SX boards.
1da177e4 LT	10	*/
1da177e4 LT	11
1da177e4 LT	12	#include <linux/module.h>
	13	#include <linux/types.h>
	14	#include <linux/pci.h>
1da177e4 LT	15	#include <linux/ide.h>
	16	#include <linux/init.h>
	17
	18	#include <asm/io.h>
	19
ced3ec8a BZ	20	#define DRV_NAME "cy82c693"
ced3ec8a BZ	21
1da177e4 LT	22	/*
	23	* NOTE: the value for busmaster timeout is tricky and I got it by
	24	* trial and error! By using a to low value will cause DMA timeouts
	25	* and drop IDE performance, and by using a to high value will cause
	26	* audio playback to scatter.
	27	* If you know a better value or how to calc it, please let me know.
	28	*/
	29
	30	/* twice the value written in cy82c693ub datasheet */
	31	#define BUSMASTER_TIMEOUT 0x50
	32	/*
	33	* the value above was tested on my machine and it seems to work okay
	34	*/
	35
	36	/* here are the offset definitions for the registers */
	37	#define CY82_IDE_CMDREG 0x04
	38	#define CY82_IDE_ADDRSETUP 0x48
	39	#define CY82_IDE_MASTER_IOR 0x4C
	40	#define CY82_IDE_MASTER_IOW 0x4D
	41	#define CY82_IDE_SLAVE_IOR 0x4E
	42	#define CY82_IDE_SLAVE_IOW 0x4F
	43	#define CY82_IDE_MASTER_8BIT 0x50
	44	#define CY82_IDE_SLAVE_8BIT 0x51
	45
	46	#define CY82_INDEX_PORT 0x22
	47	#define CY82_DATA_PORT 0x23
	48
1da177e4 LT	49	#define CY82_INDEX_CHANNEL0 0x30
	50	#define CY82_INDEX_CHANNEL1 0x31
	51	#define CY82_INDEX_TIMEOUT 0x32
	52
1da177e4 LT	53	/*
	54	* set DMA mode a specific channel for CY82C693
	55	*/
	56
8776168c	57	static void cy82c693_set_dma_mode(ide_hwif_t hwif, ide_drive_t drive)
1da177e4	58	{
8776168c	59	const u8 mode = drive->dma_mode;
8704de8f	60	u8 single = (mode & 0x10) >> 4, index = 0, data = 0;
1da177e4	61
8704de8f	62	index = hwif->channel ? CY82_INDEX_CHANNEL1 : CY82_INDEX_CHANNEL0;
1da177e4	63
8704de8f	64	data = (mode & 3) \| (single << 2);
1da177e4	65
0ecdca26 BZ	66	outb(index, CY82_INDEX_PORT);
0ecdca26 BZ	67	outb(data, CY82_DATA_PORT);
1da177e4	68
175f354b	69	/*
1da177e4	70	* note: below we set the value for Bus Master IDE TimeOut Register
25985edc	71	* I'm not absolutely sure what this does, but it solved my problem
1da177e4 LT	72	* with IDE DMA and sound, so I now can play sound and work with
	73	* my IDE driver at the same time :-)
	74	*
	75	* If you know the correct (best) value for this register please
	76	* let me know - ASK
	77	*/
	78
	79	data = BUSMASTER_TIMEOUT;
0ecdca26 BZ	80	outb(CY82_INDEX_TIMEOUT, CY82_INDEX_PORT);
0ecdca26 BZ	81	outb(data, CY82_DATA_PORT);
1da177e4 LT	82	}
1da177e4 LT	83
e085b3ca	84	static void cy82c693_set_pio_mode(ide_hwif_t hwif, ide_drive_t drive)
1da177e4	85	{
36501650	86	struct pci_dev *dev = to_pci_dev(hwif->dev);
4d6b3289 BZ	87	int bus_speed = ide_pci_clk ? ide_pci_clk : 33;
4d6b3289 BZ	88	const unsigned long T = 1000000 / bus_speed;
1da177e4	89	unsigned int addrCtrl;
4d6b3289 BZ	90	struct ide_timing t;
4d6b3289 BZ	91	u8 time_16, time_8;
1da177e4 LT	92
1da177e4 LT	93	/* select primary or secondary channel */
0ab3d8b3	94	if (drive->dn > 1) { /* drive is on the secondary channel */
652aa162	95	dev = pci_get_slot(dev->bus, dev->devfn+1);
1da177e4 LT	96	if (!dev) {
	97	printk(KERN_ERR "%s: tune_drive: "
	98	"Cannot find secondary interface!\n",
	99	drive->name);
	100	return;
	101	}
	102	}
	103
e085b3ca	104	ide_timing_compute(drive, drive->pio_mode, &t, T, 1);
4d6b3289 BZ	105
	106	time_16 = clamp_val(t.recover - 1, 0, 15) \|
	107	(clamp_val(t.active - 1, 0, 15) << 4);
	108	time_8 = clamp_val(t.act8b - 1, 0, 15) \|
	109	(clamp_val(t.rec8b - 1, 0, 15) << 4);
1da177e4 LT	110
1da177e4 LT	111	/* now let's write the clocks registers */
123995b9	112	if ((drive->dn & 1) == 0) {
1da177e4 LT	113	/*
	114	* set master drive
	115	* address setup control register
	116	* is 32 bit !!!
175f354b	117	*/
1da177e4	118	pci_read_config_dword(dev, CY82_IDE_ADDRSETUP, &addrCtrl);
175f354b	119
1da177e4	120	addrCtrl &= (~0xF);
4d6b3289	121	addrCtrl \|= clamp_val(t.setup - 1, 0, 15);
1da177e4 LT	122	pci_write_config_dword(dev, CY82_IDE_ADDRSETUP, addrCtrl);
	123
	124	/* now let's set the remaining registers */
4d6b3289 BZ	125	pci_write_config_byte(dev, CY82_IDE_MASTER_IOR, time_16);
	126	pci_write_config_byte(dev, CY82_IDE_MASTER_IOW, time_16);
	127	pci_write_config_byte(dev, CY82_IDE_MASTER_8BIT, time_8);
1da177e4 LT	128	} else {
	129	/*
	130	* set slave drive
	131	* address setup control register
	132	* is 32 bit !!!
175f354b	133	*/
1da177e4 LT	134	pci_read_config_dword(dev, CY82_IDE_ADDRSETUP, &addrCtrl);
	135
	136	addrCtrl &= (~0xF0);
4d6b3289	137	addrCtrl \|= (clamp_val(t.setup - 1, 0, 15) << 4);
1da177e4 LT	138	pci_write_config_dword(dev, CY82_IDE_ADDRSETUP, addrCtrl);
	139
	140	/* now let's set the remaining registers */
4d6b3289 BZ	141	pci_write_config_byte(dev, CY82_IDE_SLAVE_IOR, time_16);
	142	pci_write_config_byte(dev, CY82_IDE_SLAVE_IOW, time_16);
	143	pci_write_config_byte(dev, CY82_IDE_SLAVE_8BIT, time_8);
175f354b	144	}
0ab3d8b3	145	if (drive->dn > 1)
0302899e	146	pci_dev_put(dev);
1da177e4 LT	147	}
1da177e4 LT	148
fe31edc8	149	static void init_iops_cy82c693(ide_hwif_t *hwif)
1da177e4	150	{
f32d26ae	151	static ide_hwif_t *primary;
36501650	152	struct pci_dev *dev = to_pci_dev(hwif->dev);
f32d26ae	153
36501650	154	if (PCI_FUNC(dev->devfn) == 1)
1da177e4 LT	155	primary = hwif;
	156	else {
	157	hwif->mate = primary;
	158	hwif->channel = 1;
	159	}
	160	}
	161
ac95beed BZ	162	static const struct ide_port_ops cy82c693_port_ops = {
	163	.set_pio_mode = cy82c693_set_pio_mode,
	164	.set_dma_mode = cy82c693_set_dma_mode,
	165	};
	166
fe31edc8	167	static const struct ide_port_info cy82c693_chipset = {
ced3ec8a	168	.name = DRV_NAME,
7b77d864	169	.init_iops = init_iops_cy82c693,
ac95beed	170	.port_ops = &cy82c693_port_ops,
951784b6	171	.host_flags = IDE_HFLAG_SINGLE,
4099d143	172	.pio_mask = ATA_PIO4,
8704de8f BZ	173	.swdma_mask = ATA_SWDMA2,
8704de8f BZ	174	.mwdma_mask = ATA_MWDMA2,
1da177e4 LT	175	};
1da177e4 LT	176
fe31edc8 GKH	177	static int cy82c693_init_one(struct pci_dev *dev,
fe31edc8 GKH	178	const struct pci_device_id *id)
1da177e4	179	{
1da177e4 LT	180	struct pci_dev *dev2;
	181	int ret = -ENODEV;
	182
	183	/* CY82C693 is more than only a IDE controller.
	184	Function 1 is primary IDE channel, function 2 - secondary. */
175f354b	185	if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE &&
1da177e4	186	PCI_FUNC(dev->devfn) == 1) {
652aa162	187	dev2 = pci_get_slot(dev->bus, dev->devfn + 1);
6cdf6eb3	188	ret = ide_pci_init_two(dev, dev2, &cy82c693_chipset, NULL);
cd68841b BZ	189	if (ret)
cd68841b BZ	190	pci_dev_put(dev2);
1da177e4 LT	191	}
	192	return ret;
	193	}
	194
fe31edc8	195	static void cy82c693_remove(struct pci_dev *dev)
cd68841b BZ	196	{
	197	struct ide_host *host = pci_get_drvdata(dev);
	198	struct pci_dev *dev2 = host->dev[1] ? to_pci_dev(host->dev[1]) : NULL;
	199
	200	ide_pci_remove(dev);
	201	pci_dev_put(dev2);
	202	}
	203
9cbcc5e3 BZ	204	static const struct pci_device_id cy82c693_pci_tbl[] = {
9cbcc5e3 BZ	205	{ PCI_VDEVICE(CONTAQ, PCI_DEVICE_ID_CONTAQ_82C693), 0 },
1da177e4 LT	206	{ 0, },
	207	};
	208	MODULE_DEVICE_TABLE(pci, cy82c693_pci_tbl);
	209
a9ab09e2	210	static struct pci_driver cy82c693_pci_driver = {
1da177e4 LT	211	.name = "Cypress_IDE",
	212	.id_table = cy82c693_pci_tbl,
	213	.probe = cy82c693_init_one,
fe31edc8	214	.remove = cy82c693_remove,
feb22b7f BZ	215	.suspend = ide_pci_suspend,
feb22b7f BZ	216	.resume = ide_pci_resume,
1da177e4 LT	217	};
1da177e4 LT	218
82ab1eec	219	static int __init cy82c693_ide_init(void)
1da177e4	220	{
a9ab09e2	221	return ide_pci_register_driver(&cy82c693_pci_driver);
1da177e4 LT	222	}
1da177e4 LT	223
cd68841b BZ	224	static void __exit cy82c693_ide_exit(void)
cd68841b BZ	225	{
a9ab09e2	226	pci_unregister_driver(&cy82c693_pci_driver);
cd68841b BZ	227	}
cd68841b BZ	228
1da177e4	229	module_init(cy82c693_ide_init);
cd68841b	230	module_exit(cy82c693_ide_exit);
1da177e4	231
4d6b3289	232	MODULE_AUTHOR("Andreas Krebs, Andre Hedrick, Bartlomiej Zolnierkiewicz");
1da177e4 LT	233	MODULE_DESCRIPTION("PCI driver module for the Cypress CY82C693 IDE");
1da177e4 LT	234	MODULE_LICENSE("GPL");