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

/*
 *    pata_it8213.c - iTE Tech. Inc.  IT8213 PATA driver
 *
 *    The IT8213 is a very Intel ICH like device for timing purposes, having
 *    a similar register layout and the same split clock arrangement. Cable
 *    detection is different, and it does not have slave channels or all the
 *    clutter of later ICH/SATA setups.
 */

#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 <linux/device.h>
#include <scsi/scsi_host.h>
#include <linux/libata.h>
#include <linux/ata.h>

#define DRV_NAME	"pata_it8213"
#define DRV_VERSION	"0.0.3"

/**
 *	it8213_pre_reset	-	probe begin
 *	@link: link
 *	@deadline: deadline jiffies for the operation
 *
 *	Filter out ports by the enable bits before doing the normal reset
 *	and probe.
 */

static int it8213_pre_reset(struct ata_link *link, unsigned long deadline)
{
	static const struct pci_bits it8213_enable_bits[] = {
		{ 0x41U, 1U, 0x80UL, 0x80UL },	/* port 0 */
	};
	struct ata_port *ap = link->ap;
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	if (!pci_test_config_bits(pdev, &it8213_enable_bits[ap->port_no]))
		return -ENOENT;

	return ata_sff_prereset(link, deadline);
}

/**
 *	it8213_cable_detect	-	check for 40/80 pin
 *	@ap: Port
 *
 *	Perform cable detection for the 8213 ATA interface. This is
 *	different to the PIIX arrangement
 */

static int it8213_cable_detect(struct ata_port *ap)
{
	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	u8 tmp;
	pci_read_config_byte(pdev, 0x42, &tmp);
	if (tmp & 2)	/* The initial docs are incorrect */
		return ATA_CBL_PATA40;
	return ATA_CBL_PATA80;
}

/**
 *	it8213_set_piomode - Initialize host controller PATA PIO timings
 *	@ap: Port whose timings we are configuring
 *	@adev: Device whose timings we are configuring
 *
 *	Set PIO mode for device, in host controller PCI config space.
 *
 *	LOCKING:
 *	None (inherited from caller).
 */

static void it8213_set_piomode (struct ata_port *ap, struct ata_device *adev)
{
	unsigned int pio	= adev->pio_mode - XFER_PIO_0;
	struct pci_dev *dev	= to_pci_dev(ap->host->dev);
	unsigned int master_port = ap->port_no ? 0x42 : 0x40;
	u16 master_data;
	int control = 0;

	/*
	 *	See Intel Document 298600-004 for the timing programing rules
	 *	for PIIX/ICH. The 8213 is a clone so very similar
	 */

	static const	 /* ISP  RTC */
	u8 timings[][2]	= { { 0, 0 },
			    { 0, 0 },
			    { 1, 0 },
			    { 2, 1 },
			    { 2, 3 }, };

	if (pio > 1)
		control |= 1;	/* TIME */
	if (ata_pio_need_iordy(adev))	/* PIO 3/4 require IORDY */
		control |= 2;	/* IE */
	/* Bit 2 is set for ATAPI on the IT8213 - reverse of ICH/PIIX */
	if (adev->class != ATA_DEV_ATA)
		control |= 4;	/* PPE */

	pci_read_config_word(dev, master_port, &master_data);

	/* Set PPE, IE, and TIME as appropriate */
	if (adev->devno == 0) {
		master_data &= 0xCCF0;
		master_data |= control;
		master_data |= (timings[pio][0] << 12) |
			(timings[pio][1] << 8);
	} else {
		u8 slave_data;

		master_data &= 0xFF0F;
		master_data |= (control << 4);

		/* Slave timing in separate register */
		pci_read_config_byte(dev, 0x44, &slave_data);
		slave_data &= 0xF0;
		slave_data |= (timings[pio][0] << 2) | timings[pio][1];
		pci_write_config_byte(dev, 0x44, slave_data);
	}

	master_data |= 0x4000;	/* Ensure SITRE is set */
	pci_write_config_word(dev, master_port, master_data);
}

/**
 *	it8213_set_dmamode - Initialize host controller PATA DMA timings
 *	@ap: Port whose timings we are configuring
 *	@adev: Device to program
 *
 *	Set UDMA/MWDMA mode for device, in host controller PCI config space.
 *	This device is basically an ICH alike.
 *
 *	LOCKING:
 *	None (inherited from caller).
 */

static void it8213_set_dmamode (struct ata_port *ap, struct ata_device *adev)
{
	struct pci_dev *dev	= to_pci_dev(ap->host->dev);
	u16 master_data;
	u8 speed		= adev->dma_mode;
	int devid		= adev->devno;
	u8 udma_enable;

	static const	 /* ISP  RTC */
	u8 timings[][2]	= { { 0, 0 },
			    { 0, 0 },
			    { 1, 0 },
			    { 2, 1 },
			    { 2, 3 }, };

	pci_read_config_word(dev, 0x40, &master_data);
	pci_read_config_byte(dev, 0x48, &udma_enable);

	if (speed >= XFER_UDMA_0) {
		unsigned int udma = adev->dma_mode - XFER_UDMA_0;
		u16 udma_timing;
		u16 ideconf;
		int u_clock, u_speed;

		/* Clocks follow the PIIX style */
		u_speed = min(2 - (udma & 1), udma);
		if (udma > 4)
			u_clock = 0x1000;	/* 100Mhz */
		else if (udma > 2)
			u_clock = 1;		/* 66Mhz */
		else
			u_clock = 0;		/* 33Mhz */

		udma_enable |= (1 << devid);

		/* Load the UDMA cycle time */
		pci_read_config_word(dev, 0x4A, &udma_timing);
		udma_timing &= ~(3 << (4 * devid));
		udma_timing |= u_speed << (4 * devid);
		pci_write_config_word(dev, 0x4A, udma_timing);

		/* Load the clock selection */
		pci_read_config_word(dev, 0x54, &ideconf);
		ideconf &= ~(0x1001 << devid);
		ideconf |= u_clock << devid;
		pci_write_config_word(dev, 0x54, ideconf);
	} else {
		/*
		 * MWDMA is driven by the PIO timings. We must also enable
		 * IORDY unconditionally along with TIME1. PPE has already
		 * been set when the PIO timing was set.
		 */
		unsigned int mwdma	= adev->dma_mode - XFER_MW_DMA_0;
		unsigned int control;
		u8 slave_data;
		static const unsigned int needed_pio[3] = {
			XFER_PIO_0, XFER_PIO_3, XFER_PIO_4
		};
		int pio = needed_pio[mwdma] - XFER_PIO_0;

		control = 3;	/* IORDY|TIME1 */

		/* If the drive MWDMA is faster than it can do PIO then
		   we must force PIO into PIO0 */

		if (adev->pio_mode < needed_pio[mwdma])
			/* Enable DMA timing only */
			control |= 8;	/* PIO cycles in PIO0 */

		if (devid) {	/* Slave */
			master_data &= 0xFF4F;  /* Mask out IORDY|TIME1|DMAONLY */
			master_data |= control << 4;
			pci_read_config_byte(dev, 0x44, &slave_data);
			slave_data &= 0xF0;
			/* Load the matching timing */
			slave_data |= ((timings[pio][0] << 2) | timings[pio][1]) << (ap->port_no ? 4 : 0);
			pci_write_config_byte(dev, 0x44, slave_data);
		} else { 	/* Master */
			master_data &= 0xCCF4;	/* Mask out IORDY|TIME1|DMAONLY
						   and master timing bits */
			master_data |= control;
			master_data |=
				(timings[pio][0] << 12) |
				(timings[pio][1] << 8);
		}
		udma_enable &= ~(1 << devid);
		pci_write_config_word(dev, 0x40, master_data);
	}
	pci_write_config_byte(dev, 0x48, udma_enable);
}

static struct scsi_host_template it8213_sht = {
	ATA_BMDMA_SHT(DRV_NAME),
};


static struct ata_port_operations it8213_ops = {
	.inherits		= &ata_bmdma_port_ops,
	.cable_detect		= it8213_cable_detect,
	.set_piomode		= it8213_set_piomode,
	.set_dmamode		= it8213_set_dmamode,
	.prereset		= it8213_pre_reset,
};


/**
 *	it8213_init_one - Register 8213 ATA PCI device with kernel services
 *	@pdev: PCI device to register
 *	@ent: Entry in it8213_pci_tbl matching with @pdev
 *
 *	Called from kernel PCI layer.
 *
 *	LOCKING:
 *	Inherited from PCI layer (may sleep).
 *
 *	RETURNS:
 *	Zero on success, or -ERRNO value.
 */

static int it8213_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
{
	static const struct ata_port_info info = {
		.flags		= ATA_FLAG_SLAVE_POSS,
		.pio_mask	= ATA_PIO4,
		.mwdma_mask	= ATA_MWDMA12_ONLY,
		.udma_mask	= ATA_UDMA6,
		.port_ops	= &it8213_ops,
	};
	/* Current IT8213 stuff is single port */
	const struct ata_port_info *ppi[] = { &info, &ata_dummy_port_info };

	ata_print_version_once(&pdev->dev, DRV_VERSION);

	return ata_pci_bmdma_init_one(pdev, ppi, &it8213_sht, NULL, 0);
}

static const struct pci_device_id it8213_pci_tbl[] = {
	{ PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8213), },

	{ }	/* terminate list */
};

static struct pci_driver it8213_pci_driver = {
	.name			= DRV_NAME,
	.id_table		= it8213_pci_tbl,
	.probe			= it8213_init_one,
	.remove			= ata_pci_remove_one,
#ifdef CONFIG_PM
	.suspend		= ata_pci_device_suspend,
	.resume			= ata_pci_device_resume,
#endif
};

module_pci_driver(it8213_pci_driver);

MODULE_AUTHOR("Alan Cox");
MODULE_DESCRIPTION("SCSI low-level driver for the ITE 8213");
MODULE_LICENSE("GPL");
MODULE_DEVICE_TABLE(pci, it8213_pci_tbl);
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
9b13b682 AC	1	/*
	2	* pata_it8213.c - iTE Tech. Inc. IT8213 PATA driver
	3	*
	4	* The IT8213 is a very Intel ICH like device for timing purposes, having
	5	* a similar register layout and the same split clock arrangement. Cable
	6	* detection is different, and it does not have slave channels or all the
	7	* clutter of later ICH/SATA setups.
	8	*/
	9
	10	#include <linux/kernel.h>
	11	#include <linux/module.h>
	12	#include <linux/pci.h>
	13	#include <linux/init.h>
	14	#include <linux/blkdev.h>
	15	#include <linux/delay.h>
	16	#include <linux/device.h>
	17	#include <scsi/scsi_host.h>
	18	#include <linux/libata.h>
	19	#include <linux/ata.h>
	20
	21	#define DRV_NAME "pata_it8213"
8bc3fc47	22	#define DRV_VERSION "0.0.3"
9b13b682 AC	23
9b13b682 AC	24	/**
13a28c15	25	* it8213_pre_reset - probe begin
cc0680a5	26	* @link: link
d4b2bab4	27	* @deadline: deadline jiffies for the operation
9b13b682	28	*
5816fbbf AC	29	* Filter out ports by the enable bits before doing the normal reset
5816fbbf AC	30	* and probe.
9b13b682 AC	31	*/
9b13b682 AC	32
cc0680a5	33	static int it8213_pre_reset(struct ata_link *link, unsigned long deadline)
9b13b682 AC	34	{
	35	static const struct pci_bits it8213_enable_bits[] = {
	36	{ 0x41U, 1U, 0x80UL, 0x80UL }, /* port 0 */
	37	};
cc0680a5	38	struct ata_port *ap = link->ap;
9b13b682	39	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
9b13b682 AC	40	if (!pci_test_config_bits(pdev, &it8213_enable_bits[ap->port_no]))
9b13b682 AC	41	return -ENOENT;
d4b2bab4	42
9363c382	43	return ata_sff_prereset(link, deadline);
9b13b682 AC	44	}
9b13b682 AC	45
5816fbbf AC	46	/**
	47	* it8213_cable_detect - check for 40/80 pin
	48	* @ap: Port
	49	*
	50	* Perform cable detection for the 8213 ATA interface. This is
	51	* different to the PIIX arrangement
	52	*/
	53
	54	static int it8213_cable_detect(struct ata_port *ap)
	55	{
	56	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
	57	u8 tmp;
	58	pci_read_config_byte(pdev, 0x42, &tmp);
	59	if (tmp & 2) /* The initial docs are incorrect */
	60	return ATA_CBL_PATA40;
	61	return ATA_CBL_PATA80;
	62	}
	63
9b13b682 AC	64	/**
	65	* it8213_set_piomode - Initialize host controller PATA PIO timings
	66	* @ap: Port whose timings we are configuring
5816fbbf	67	* @adev: Device whose timings we are configuring
9b13b682 AC	68	*
	69	* Set PIO mode for device, in host controller PCI config space.
	70	*
	71	* LOCKING:
	72	* None (inherited from caller).
	73	*/
	74
	75	static void it8213_set_piomode (struct ata_port ap, struct ata_device adev)
	76	{
	77	unsigned int pio = adev->pio_mode - XFER_PIO_0;
	78	struct pci_dev *dev = to_pci_dev(ap->host->dev);
4780c0b2 BZ	79	unsigned int master_port = ap->port_no ? 0x42 : 0x40;
4780c0b2 BZ	80	u16 master_data;
9b13b682 AC	81	int control = 0;
	82
	83	/*
	84	* See Intel Document 298600-004 for the timing programing rules
	85	* for PIIX/ICH. The 8213 is a clone so very similar
	86	*/
	87
	88	static const /* ISP RTC */
	89	u8 timings[][2] = { { 0, 0 },
	90	{ 0, 0 },
	91	{ 1, 0 },
	92	{ 2, 1 },
	93	{ 2, 3 }, };
	94
ed869ff0 BZ	95	if (pio > 1)
ed869ff0 BZ	96	control \|= 1; /* TIME */
9b13b682	97	if (ata_pio_need_iordy(adev)) /* PIO 3/4 require IORDY */
ed869ff0	98	control \|= 2; /* IE */
9b13b682 AC	99	/* Bit 2 is set for ATAPI on the IT8213 - reverse of ICH/PIIX */
9b13b682 AC	100	if (adev->class != ATA_DEV_ATA)
ed869ff0	101	control \|= 4; /* PPE */
9b13b682	102
4780c0b2	103	pci_read_config_word(dev, master_port, &master_data);
9b13b682	104
ed869ff0	105	/* Set PPE, IE, and TIME as appropriate */
9b13b682	106	if (adev->devno == 0) {
4780c0b2 BZ	107	master_data &= 0xCCF0;
	108	master_data \|= control;
	109	master_data \|= (timings[pio][0] << 12) \|
9b13b682 AC	110	(timings[pio][1] << 8);
	111	} else {
	112	u8 slave_data;
	113
4780c0b2 BZ	114	master_data &= 0xFF0F;
4780c0b2 BZ	115	master_data \|= (control << 4);
9b13b682	116
1967b7ff	117	/* Slave timing in separate register */
9b13b682 AC	118	pci_read_config_byte(dev, 0x44, &slave_data);
9b13b682 AC	119	slave_data &= 0xF0;
088ccb53	120	slave_data \|= (timings[pio][0] << 2) \| timings[pio][1];
9b13b682 AC	121	pci_write_config_byte(dev, 0x44, slave_data);
	122	}
	123
4780c0b2 BZ	124	master_data \|= 0x4000; /* Ensure SITRE is set */
4780c0b2 BZ	125	pci_write_config_word(dev, master_port, master_data);
9b13b682 AC	126	}
	127
	128	/**
	129	* it8213_set_dmamode - Initialize host controller PATA DMA timings
	130	* @ap: Port whose timings we are configuring
	131	* @adev: Device to program
	132	*
	133	* Set UDMA/MWDMA mode for device, in host controller PCI config space.
	134	* This device is basically an ICH alike.
	135	*
	136	* LOCKING:
	137	* None (inherited from caller).
	138	*/
	139
	140	static void it8213_set_dmamode (struct ata_port ap, struct ata_device adev)
	141	{
	142	struct pci_dev *dev = to_pci_dev(ap->host->dev);
	143	u16 master_data;
	144	u8 speed = adev->dma_mode;
	145	int devid = adev->devno;
	146	u8 udma_enable;
	147
	148	static const /* ISP RTC */
	149	u8 timings[][2] = { { 0, 0 },
	150	{ 0, 0 },
	151	{ 1, 0 },
	152	{ 2, 1 },
	153	{ 2, 3 }, };
	154
	155	pci_read_config_word(dev, 0x40, &master_data);
	156	pci_read_config_byte(dev, 0x48, &udma_enable);
	157
	158	if (speed >= XFER_UDMA_0) {
	159	unsigned int udma = adev->dma_mode - XFER_UDMA_0;
	160	u16 udma_timing;
	161	u16 ideconf;
	162	int u_clock, u_speed;
	163
	164	/* Clocks follow the PIIX style */
	165	u_speed = min(2 - (udma & 1), udma);
11e872a3	166	if (udma > 4)
9b13b682 AC	167	u_clock = 0x1000; /* 100Mhz */
	168	else if (udma > 2)
	169	u_clock = 1; /* 66Mhz */
	170	else
	171	u_clock = 0; /* 33Mhz */
	172
	173	udma_enable \|= (1 << devid);
	174
e0ee792b	175	/* Load the UDMA cycle time */
9b13b682 AC	176	pci_read_config_word(dev, 0x4A, &udma_timing);
9b13b682 AC	177	udma_timing &= ~(3 << (4 * devid));
e0ee792b	178	udma_timing \|= u_speed << (4 * devid);
9b13b682 AC	179	pci_write_config_word(dev, 0x4A, udma_timing);
	180
	181	/* Load the clock selection */
	182	pci_read_config_word(dev, 0x54, &ideconf);
	183	ideconf &= ~(0x1001 << devid);
	184	ideconf \|= u_clock << devid;
	185	pci_write_config_word(dev, 0x54, ideconf);
	186	} else {
	187	/*
	188	* MWDMA is driven by the PIO timings. We must also enable
	189	* IORDY unconditionally along with TIME1. PPE has already
	190	* been set when the PIO timing was set.
	191	*/
	192	unsigned int mwdma = adev->dma_mode - XFER_MW_DMA_0;
	193	unsigned int control;
	194	u8 slave_data;
	195	static const unsigned int needed_pio[3] = {
	196	XFER_PIO_0, XFER_PIO_3, XFER_PIO_4
	197	};
	198	int pio = needed_pio[mwdma] - XFER_PIO_0;
	199
	200	control = 3; /* IORDY\|TIME1 */
	201
	202	/* If the drive MWDMA is faster than it can do PIO then
	203	we must force PIO into PIO0 */
	204
	205	if (adev->pio_mode < needed_pio[mwdma])
	206	/* Enable DMA timing only */
	207	control \|= 8; /* PIO cycles in PIO0 */
	208
	209	if (devid) { /* Slave */
	210	master_data &= 0xFF4F; /* Mask out IORDY\|TIME1\|DMAONLY */
	211	master_data \|= control << 4;
	212	pci_read_config_byte(dev, 0x44, &slave_data);
e3f1d5cd	213	slave_data &= 0xF0;
9b13b682 AC	214	/* Load the matching timing */
	215	slave_data \|= ((timings[pio][0] << 2) \| timings[pio][1]) << (ap->port_no ? 4 : 0);
	216	pci_write_config_byte(dev, 0x44, slave_data);
	217	} else { /* Master */
	218	master_data &= 0xCCF4; /* Mask out IORDY\|TIME1\|DMAONLY
	219	and master timing bits */
	220	master_data \|= control;
	221	master_data \|=
	222	(timings[pio][0] << 12) \|
	223	(timings[pio][1] << 8);
	224	}
	225	udma_enable &= ~(1 << devid);
	226	pci_write_config_word(dev, 0x40, master_data);
	227	}
	228	pci_write_config_byte(dev, 0x48, udma_enable);
	229	}
	230
	231	static struct scsi_host_template it8213_sht = {
68d1d07b	232	ATA_BMDMA_SHT(DRV_NAME),
9b13b682 AC	233	};
9b13b682 AC	234
029cfd6b TH	235
	236	static struct ata_port_operations it8213_ops = {
	237	.inherits = &ata_bmdma_port_ops,
	238	.cable_detect = it8213_cable_detect,
9b13b682 AC	239	.set_piomode = it8213_set_piomode,
9b13b682 AC	240	.set_dmamode = it8213_set_dmamode,
a1efdaba	241	.prereset = it8213_pre_reset,
9b13b682 AC	242	};
	243
	244
	245	/**
	246	* it8213_init_one - Register 8213 ATA PCI device with kernel services
	247	* @pdev: PCI device to register
	248	* @ent: Entry in it8213_pci_tbl matching with @pdev
	249	*
	250	* Called from kernel PCI layer.
	251	*
	252	* LOCKING:
	253	* Inherited from PCI layer (may sleep).
	254	*
	255	* RETURNS:
	256	* Zero on success, or -ERRNO value.
	257	*/
	258
	259	static int it8213_init_one (struct pci_dev pdev, const struct pci_device_id ent)
	260	{
1626aeb8	261	static const struct ata_port_info info = {
1d2808fd	262	.flags = ATA_FLAG_SLAVE_POSS,
14bdef98	263	.pio_mask = ATA_PIO4,
fd87e792	264	.mwdma_mask = ATA_MWDMA12_ONLY,
11e872a3	265	.udma_mask = ATA_UDMA6,
9b13b682 AC	266	.port_ops = &it8213_ops,
9b13b682 AC	267	};
1626aeb8 TH	268	/* Current IT8213 stuff is single port */
1626aeb8 TH	269	const struct ata_port_info *ppi[] = { &info, &ata_dummy_port_info };
9b13b682	270
06296a1e	271	ata_print_version_once(&pdev->dev, DRV_VERSION);
9b13b682	272
1c5afdf7	273	return ata_pci_bmdma_init_one(pdev, ppi, &it8213_sht, NULL, 0);
9b13b682 AC	274	}
	275
	276	static const struct pci_device_id it8213_pci_tbl[] = {
	277	{ PCI_VDEVICE(ITE, PCI_DEVICE_ID_ITE_8213), },
	278
	279	{ } /* terminate list */
	280	};
	281
	282	static struct pci_driver it8213_pci_driver = {
	283	.name = DRV_NAME,
	284	.id_table = it8213_pci_tbl,
	285	.probe = it8213_init_one,
	286	.remove = ata_pci_remove_one,
438ac6d5	287	#ifdef CONFIG_PM
9b13b682 AC	288	.suspend = ata_pci_device_suspend,
9b13b682 AC	289	.resume = ata_pci_device_resume,
438ac6d5	290	#endif
9b13b682 AC	291	};
9b13b682 AC	292
2fc75da0	293	module_pci_driver(it8213_pci_driver);
9b13b682 AC	294
	295	MODULE_AUTHOR("Alan Cox");
	296	MODULE_DESCRIPTION("SCSI low-level driver for the ITE 8213");
	297	MODULE_LICENSE("GPL");
	298	MODULE_DEVICE_TABLE(pci, it8213_pci_tbl);
	299	MODULE_VERSION(DRV_VERSION);