[mirror_ubuntu-hirsute-kernel.git] / drivers / ide / ali14xx.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 *  Copyright (C) 1996  Linus Torvalds & author (see below)
 */

/*
 * ALI M14xx chipset EIDE controller
 *
 * Works for ALI M1439/1443/1445/1487/1489 chipsets.
 *
 * Adapted from code developed by derekn@vw.ece.cmu.edu.  -ml
 * Derek's notes follow:
 *
 * I think the code should be pretty understandable,
 * but I'll be happy to (try to) answer questions.
 *
 * The critical part is in the setupDrive function.  The initRegisters
 * function doesn't seem to be necessary, but the DOS driver does it, so
 * I threw it in.
 *
 * I've only tested this on my system, which only has one disk.  I posted
 * it to comp.sys.linux.hardware, so maybe some other people will try it
 * out.
 *
 * Derek Noonburg  (derekn@ece.cmu.edu)
 * 95-sep-26
 *
 * Update 96-jul-13:
 *
 * I've since upgraded to two disks and a CD-ROM, with no trouble, and
 * I've also heard from several others who have used it successfully.
 * This driver appears to work with both the 1443/1445 and the 1487/1489
 * chipsets.  I've added support for PIO mode 4 for the 1487.  This
 * seems to work just fine on the 1443 also, although I'm not sure it's
 * advertised as supporting mode 4.  (I've been running a WDC AC21200 in
 * mode 4 for a while now with no trouble.)  -Derek
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/timer.h>
#include <linux/mm.h>
#include <linux/ioport.h>
#include <linux/blkdev.h>
#include <linux/ide.h>
#include <linux/init.h>

#include <asm/io.h>

#define DRV_NAME "ali14xx"

/* port addresses for auto-detection */
#define ALI_NUM_PORTS 4
static const int ports[ALI_NUM_PORTS] __initconst =
	{ 0x074, 0x0f4, 0x034, 0x0e4 };

/* register initialization data */
typedef struct { u8 reg, data; } RegInitializer;

static const RegInitializer initData[] __initconst = {
	{0x01, 0x0f}, {0x02, 0x00}, {0x03, 0x00}, {0x04, 0x00},
	{0x05, 0x00}, {0x06, 0x00}, {0x07, 0x2b}, {0x0a, 0x0f},
	{0x25, 0x00}, {0x26, 0x00}, {0x27, 0x00}, {0x28, 0x00},
	{0x29, 0x00}, {0x2a, 0x00}, {0x2f, 0x00}, {0x2b, 0x00},
	{0x2c, 0x00}, {0x2d, 0x00}, {0x2e, 0x00}, {0x30, 0x00},
	{0x31, 0x00}, {0x32, 0x00}, {0x33, 0x00}, {0x34, 0xff},
	{0x35, 0x03}, {0x00, 0x00}
};

/* timing parameter registers for each drive */
static struct { u8 reg1, reg2, reg3, reg4; } regTab[4] = {
	{0x03, 0x26, 0x04, 0x27},     /* drive 0 */
	{0x05, 0x28, 0x06, 0x29},     /* drive 1 */
	{0x2b, 0x30, 0x2c, 0x31},     /* drive 2 */
	{0x2d, 0x32, 0x2e, 0x33},     /* drive 3 */
};

static int basePort;	/* base port address */
static int regPort;	/* port for register number */
static int dataPort;	/* port for register data */
static u8 regOn;	/* output to base port to access registers */
static u8 regOff;	/* output to base port to close registers */

/*------------------------------------------------------------------------*/

/*
 * Read a controller register.
 */
static inline u8 inReg(u8 reg)
{
	outb_p(reg, regPort);
	return inb(dataPort);
}

/*
 * Write a controller register.
 */
static void outReg(u8 data, u8 reg)
{
	outb_p(reg, regPort);
	outb_p(data, dataPort);
}

static DEFINE_SPINLOCK(ali14xx_lock);

/*
 * Set PIO mode for the specified drive.
 * This function computes timing parameters
 * and sets controller registers accordingly.
 */
static void ali14xx_set_pio_mode(ide_hwif_t *hwif, ide_drive_t *drive)
{
	int driveNum;
	int time1, time2;
	u8 param1, param2, param3, param4;
	unsigned long flags;
	int bus_speed = ide_vlb_clk ? ide_vlb_clk : 50;
	const u8 pio = drive->pio_mode - XFER_PIO_0;
	struct ide_timing *t = ide_timing_find_mode(XFER_PIO_0 + pio);

	/* calculate timing, according to PIO mode */
	time1 = ide_pio_cycle_time(drive, pio);
	time2 = t->active;
	param3 = param1 = (time2 * bus_speed + 999) / 1000;
	param4 = param2 = (time1 * bus_speed + 999) / 1000 - param1;
	if (pio < 3) {
		param3 += 8;
		param4 += 8;
	}
	printk(KERN_DEBUG "%s: PIO mode%d, t1=%dns, t2=%dns, cycles = %d+%d, %d+%d\n",
		drive->name, pio, time1, time2, param1, param2, param3, param4);

	/* stuff timing parameters into controller registers */
	driveNum = (drive->hwif->index << 1) + (drive->dn & 1);
	spin_lock_irqsave(&ali14xx_lock, flags);
	outb_p(regOn, basePort);
	outReg(param1, regTab[driveNum].reg1);
	outReg(param2, regTab[driveNum].reg2);
	outReg(param3, regTab[driveNum].reg3);
	outReg(param4, regTab[driveNum].reg4);
	outb_p(regOff, basePort);
	spin_unlock_irqrestore(&ali14xx_lock, flags);
}

/*
 * Auto-detect the IDE controller port.
 */
static int __init findPort(void)
{
	int i;
	u8 t;
	unsigned long flags;

	local_irq_save(flags);
	for (i = 0; i < ALI_NUM_PORTS; ++i) {
		basePort = ports[i];
		regOff = inb(basePort);
		for (regOn = 0x30; regOn <= 0x33; ++regOn) {
			outb_p(regOn, basePort);
			if (inb(basePort) == regOn) {
				regPort = basePort + 4;
				dataPort = basePort + 8;
				t = inReg(0) & 0xf0;
				outb_p(regOff, basePort);
				local_irq_restore(flags);
				if (t != 0x50)
					return 0;
				return 1;  /* success */
			}
		}
		outb_p(regOff, basePort);
	}
	local_irq_restore(flags);
	return 0;
}

/*
 * Initialize controller registers with default values.
 */
static int __init initRegisters(void)
{
	const RegInitializer *p;
	u8 t;
	unsigned long flags;

	local_irq_save(flags);
	outb_p(regOn, basePort);
	for (p = initData; p->reg != 0; ++p)
		outReg(p->data, p->reg);
	outb_p(0x01, regPort);
	t = inb(regPort) & 0x01;
	outb_p(regOff, basePort);
	local_irq_restore(flags);
	return t;
}

static const struct ide_port_ops ali14xx_port_ops = {
	.set_pio_mode		= ali14xx_set_pio_mode,
};

static const struct ide_port_info ali14xx_port_info = {
	.name			= DRV_NAME,
	.chipset		= ide_ali14xx,
	.port_ops		= &ali14xx_port_ops,
	.host_flags		= IDE_HFLAG_NO_DMA,
	.pio_mask		= ATA_PIO4,
};

static int __init ali14xx_probe(void)
{
	printk(KERN_DEBUG "ali14xx: base=0x%03x, regOn=0x%02x.\n",
			  basePort, regOn);

	/* initialize controller registers */
	if (!initRegisters()) {
		printk(KERN_ERR "ali14xx: Chip initialization failed.\n");
		return 1;
	}

	return ide_legacy_device_add(&ali14xx_port_info, 0);
}

static bool probe_ali14xx;

module_param_named(probe, probe_ali14xx, bool, 0);
MODULE_PARM_DESC(probe, "probe for ALI M14xx chipsets");

static int __init ali14xx_init(void)
{
	if (probe_ali14xx == 0)
		goto out;

	/* auto-detect IDE controller port */
	if (findPort()) {
		if (ali14xx_probe())
			return -ENODEV;
		return 0;
	}
	printk(KERN_ERR "ali14xx: not found.\n");
out:
	return -ENODEV;
}

module_init(ali14xx_init);

MODULE_AUTHOR("see local file");
MODULE_DESCRIPTION("support of ALI 14XX IDE chipsets");
MODULE_LICENSE("GPL");
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
1da177e4	2	/*
1da177e4 LT	3	* Copyright (C) 1996 Linus Torvalds & author (see below)
	4	*/
	5
	6	/*
	7	* ALI M14xx chipset EIDE controller
	8	*
	9	* Works for ALI M1439/1443/1445/1487/1489 chipsets.
	10	*
	11	* Adapted from code developed by derekn@vw.ece.cmu.edu. -ml
	12	* Derek's notes follow:
	13	*
	14	* I think the code should be pretty understandable,
	15	* but I'll be happy to (try to) answer questions.
	16	*
	17	* The critical part is in the setupDrive function. The initRegisters
	18	* function doesn't seem to be necessary, but the DOS driver does it, so
	19	* I threw it in.
	20	*
	21	* I've only tested this on my system, which only has one disk. I posted
	22	* it to comp.sys.linux.hardware, so maybe some other people will try it
	23	* out.
	24	*
	25	* Derek Noonburg (derekn@ece.cmu.edu)
	26	* 95-sep-26
	27	*
	28	* Update 96-jul-13:
	29	*
	30	* I've since upgraded to two disks and a CD-ROM, with no trouble, and
	31	* I've also heard from several others who have used it successfully.
	32	* This driver appears to work with both the 1443/1445 and the 1487/1489
	33	* chipsets. I've added support for PIO mode 4 for the 1487. This
	34	* seems to work just fine on the 1443 also, although I'm not sure it's
	35	* advertised as supporting mode 4. (I've been running a WDC AC21200 in
	36	* mode 4 for a while now with no trouble.) -Derek
	37	*/
	38
1da177e4	39	#include <linux/module.h>
1da177e4 LT	40	#include <linux/types.h>
	41	#include <linux/kernel.h>
	42	#include <linux/delay.h>
	43	#include <linux/timer.h>
	44	#include <linux/mm.h>
	45	#include <linux/ioport.h>
	46	#include <linux/blkdev.h>
1da177e4 LT	47	#include <linux/ide.h>
	48	#include <linux/init.h>
	49
	50	#include <asm/io.h>
	51
d92f1a28 BZ	52	#define DRV_NAME "ali14xx"
d92f1a28 BZ	53
1da177e4 LT	54	/* port addresses for auto-detection */
1da177e4 LT	55	#define ALI_NUM_PORTS 4
e6b53703	56	static const int ports[ALI_NUM_PORTS] __initconst =
498f26b4	57	{ 0x074, 0x0f4, 0x034, 0x0e4 };
1da177e4 LT	58
	59	/* register initialization data */
	60	typedef struct { u8 reg, data; } RegInitializer;
	61
e6b53703	62	static const RegInitializer initData[] __initconst = {
1da177e4 LT	63	{0x01, 0x0f}, {0x02, 0x00}, {0x03, 0x00}, {0x04, 0x00},
	64	{0x05, 0x00}, {0x06, 0x00}, {0x07, 0x2b}, {0x0a, 0x0f},
	65	{0x25, 0x00}, {0x26, 0x00}, {0x27, 0x00}, {0x28, 0x00},
	66	{0x29, 0x00}, {0x2a, 0x00}, {0x2f, 0x00}, {0x2b, 0x00},
	67	{0x2c, 0x00}, {0x2d, 0x00}, {0x2e, 0x00}, {0x30, 0x00},
	68	{0x31, 0x00}, {0x32, 0x00}, {0x33, 0x00}, {0x34, 0xff},
	69	{0x35, 0x03}, {0x00, 0x00}
	70	};
	71
1da177e4 LT	72	/* timing parameter registers for each drive */
	73	static struct { u8 reg1, reg2, reg3, reg4; } regTab[4] = {
	74	{0x03, 0x26, 0x04, 0x27}, /* drive 0 */
	75	{0x05, 0x28, 0x06, 0x29}, /* drive 1 */
	76	{0x2b, 0x30, 0x2c, 0x31}, /* drive 2 */
	77	{0x2d, 0x32, 0x2e, 0x33}, /* drive 3 */
	78	};
	79
	80	static int basePort; /* base port address */
	81	static int regPort; /* port for register number */
	82	static int dataPort; /* port for register data */
	83	static u8 regOn; /* output to base port to access registers */
	84	static u8 regOff; /* output to base port to close registers */
	85
	86	/------------------------------------------------------------------------/
	87
	88	/*
	89	* Read a controller register.
	90	*/
38bdb410	91	static inline u8 inReg(u8 reg)
1da177e4 LT	92	{
	93	outb_p(reg, regPort);
	94	return inb(dataPort);
	95	}
	96
	97	/*
	98	* Write a controller register.
	99	*/
38bdb410	100	static void outReg(u8 data, u8 reg)
1da177e4 LT	101	{
	102	outb_p(reg, regPort);
	103	outb_p(data, dataPort);
	104	}
	105
2047e15b BZ	106	static DEFINE_SPINLOCK(ali14xx_lock);
2047e15b BZ	107
1da177e4 LT	108	/*
	109	* Set PIO mode for the specified drive.
	110	* This function computes timing parameters
	111	* and sets controller registers accordingly.
	112	*/
e085b3ca	113	static void ali14xx_set_pio_mode(ide_hwif_t hwif, ide_drive_t drive)
1da177e4 LT	114	{
	115	int driveNum;
	116	int time1, time2;
	117	u8 param1, param2, param3, param4;
	118	unsigned long flags;
30e5ee4d	119	int bus_speed = ide_vlb_clk ? ide_vlb_clk : 50;
e085b3ca	120	const u8 pio = drive->pio_mode - XFER_PIO_0;
cc57ccc0	121	struct ide_timing *t = ide_timing_find_mode(XFER_PIO_0 + pio);
1da177e4	122
1da177e4	123	/* calculate timing, according to PIO mode */
7dd00083	124	time1 = ide_pio_cycle_time(drive, pio);
cc57ccc0	125	time2 = t->active;
1da177e4 LT	126	param3 = param1 = (time2 * bus_speed + 999) / 1000;
	127	param4 = param2 = (time1 * bus_speed + 999) / 1000 - param1;
	128	if (pio < 3) {
	129	param3 += 8;
	130	param4 += 8;
	131	}
	132	printk(KERN_DEBUG "%s: PIO mode%d, t1=%dns, t2=%dns, cycles = %d+%d, %d+%d\n",
	133	drive->name, pio, time1, time2, param1, param2, param3, param4);
	134
	135	/* stuff timing parameters into controller registers */
123995b9	136	driveNum = (drive->hwif->index << 1) + (drive->dn & 1);
2047e15b	137	spin_lock_irqsave(&ali14xx_lock, flags);
1da177e4 LT	138	outb_p(regOn, basePort);
	139	outReg(param1, regTab[driveNum].reg1);
	140	outReg(param2, regTab[driveNum].reg2);
	141	outReg(param3, regTab[driveNum].reg3);
	142	outReg(param4, regTab[driveNum].reg4);
	143	outb_p(regOff, basePort);
2047e15b	144	spin_unlock_irqrestore(&ali14xx_lock, flags);
1da177e4 LT	145	}
	146
	147	/*
	148	* Auto-detect the IDE controller port.
	149	*/
38bdb410	150	static int __init findPort(void)
1da177e4 LT	151	{
	152	int i;
	153	u8 t;
	154	unsigned long flags;
	155
	156	local_irq_save(flags);
	157	for (i = 0; i < ALI_NUM_PORTS; ++i) {
	158	basePort = ports[i];
	159	regOff = inb(basePort);
	160	for (regOn = 0x30; regOn <= 0x33; ++regOn) {
	161	outb_p(regOn, basePort);
	162	if (inb(basePort) == regOn) {
	163	regPort = basePort + 4;
	164	dataPort = basePort + 8;
	165	t = inReg(0) & 0xf0;
	166	outb_p(regOff, basePort);
	167	local_irq_restore(flags);
	168	if (t != 0x50)
	169	return 0;
	170	return 1; /* success */
	171	}
	172	}
	173	outb_p(regOff, basePort);
	174	}
	175	local_irq_restore(flags);
	176	return 0;
	177	}
	178
	179	/*
	180	* Initialize controller registers with default values.
	181	*/
38bdb410 PC	182	static int __init initRegisters(void)
38bdb410 PC	183	{
498f26b4	184	const RegInitializer *p;
1da177e4 LT	185	u8 t;
	186	unsigned long flags;
	187
	188	local_irq_save(flags);
	189	outb_p(regOn, basePort);
	190	for (p = initData; p->reg != 0; ++p)
	191	outReg(p->data, p->reg);
	192	outb_p(0x01, regPort);
	193	t = inb(regPort) & 0x01;
	194	outb_p(regOff, basePort);
	195	local_irq_restore(flags);
	196	return t;
	197	}
	198
ac95beed BZ	199	static const struct ide_port_ops ali14xx_port_ops = {
	200	.set_pio_mode = ali14xx_set_pio_mode,
	201	};
	202
c413b9b9	203	static const struct ide_port_info ali14xx_port_info = {
d92f1a28	204	.name = DRV_NAME,
c413b9b9	205	.chipset = ide_ali14xx,
ac95beed	206	.port_ops = &ali14xx_port_ops,
0d28ec7f	207	.host_flags = IDE_HFLAG_NO_DMA,
c413b9b9 BZ	208	.pio_mask = ATA_PIO4,
	209	};
	210
1da177e4 LT	211	static int __init ali14xx_probe(void)
1da177e4 LT	212	{
1da177e4 LT	213	printk(KERN_DEBUG "ali14xx: base=0x%03x, regOn=0x%02x.\n",
	214	basePort, regOn);
	215
	216	/* initialize controller registers */
	217	if (!initRegisters()) {
	218	printk(KERN_ERR "ali14xx: Chip initialization failed.\n");
	219	return 1;
	220	}
	221
0bfeee7d	222	return ide_legacy_device_add(&ali14xx_port_info, 0);
1da177e4 LT	223	}
1da177e4 LT	224
90ab5ee9	225	static bool probe_ali14xx;
84913882 BZ	226
	227	module_param_named(probe, probe_ali14xx, bool, 0);
	228	MODULE_PARM_DESC(probe, "probe for ALI M14xx chipsets");
	229
ade2daf9	230	static int __init ali14xx_init(void)
1da177e4	231	{
84913882 BZ	232	if (probe_ali14xx == 0)
	233	goto out;
	234
1da177e4 LT	235	/* auto-detect IDE controller port */
	236	if (findPort()) {
	237	if (ali14xx_probe())
	238	return -ENODEV;
	239	return 0;
	240	}
	241	printk(KERN_ERR "ali14xx: not found.\n");
84913882	242	out:
1da177e4 LT	243	return -ENODEV;
	244	}
	245
1da177e4	246	module_init(ali14xx_init);
1da177e4 LT	247
	248	MODULE_AUTHOR("see local file");
	249	MODULE_DESCRIPTION("support of ALI 14XX IDE chipsets");
	250	MODULE_LICENSE("GPL");