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

/*
 *  linux/drivers/ide/legacy/ali14xx.c		Version 0.03	Feb 09, 1996
 *
 *  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/hdreg.h>
#include <linux/ide.h>
#include <linux/init.h>

#include <asm/io.h>

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

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

static const RegInitializer initData[] __initdata = {
	{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_drive_t *drive, const u8 pio)
{
	int driveNum;
	int time1, time2;
	u8 param1, param2, param3, param4;
	unsigned long flags;
	int bus_speed = system_bus_clock();

	/* calculate timing, according to PIO mode */
	time1 = ide_pio_cycle_time(drive, pio);
	time2 = ide_pio_timings[pio].active_time;
	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 = (HWIF(drive)->index << 1) + drive->select.b.unit;
	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 int __init ali14xx_probe(void)
{
	ide_hwif_t *hwif, *mate;
	static u8 idx[4] = { 0, 1, 0xff, 0xff };

	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;
	}

	hwif = &ide_hwifs[0];
	mate = &ide_hwifs[1];

	hwif->chipset = ide_ali14xx;
	hwif->pio_mask = ATA_PIO4;
	hwif->set_pio_mode = &ali14xx_set_pio_mode;
	hwif->mate = mate;

	mate->chipset = ide_ali14xx;
	mate->pio_mask = ATA_PIO4;
	mate->set_pio_mode = &ali14xx_set_pio_mode;
	mate->mate = hwif;
	mate->channel = 1;

	ide_device_add(idx);

	return 0;
}

int probe_ali14xx = 0;

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

/* Can be called directly from ide.c. */
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;
}

#ifdef MODULE
module_init(ali14xx_init);
#endif

MODULE_AUTHOR("see local file");
MODULE_DESCRIPTION("support of ALI 14XX IDE chipsets");
MODULE_LICENSE("GPL");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/drivers/ide/legacy/ali14xx.c Version 0.03 Feb 09, 1996
	3	*
	4	* Copyright (C) 1996 Linus Torvalds & author (see below)
	5	*/
	6
	7	/*
	8	* ALI M14xx chipset EIDE controller
	9	*
	10	* Works for ALI M1439/1443/1445/1487/1489 chipsets.
	11	*
	12	* Adapted from code developed by derekn@vw.ece.cmu.edu. -ml
	13	* Derek's notes follow:
	14	*
	15	* I think the code should be pretty understandable,
	16	* but I'll be happy to (try to) answer questions.
	17	*
	18	* The critical part is in the setupDrive function. The initRegisters
	19	* function doesn't seem to be necessary, but the DOS driver does it, so
	20	* I threw it in.
	21	*
	22	* I've only tested this on my system, which only has one disk. I posted
	23	* it to comp.sys.linux.hardware, so maybe some other people will try it
	24	* out.
	25	*
	26	* Derek Noonburg (derekn@ece.cmu.edu)
	27	* 95-sep-26
	28	*
	29	* Update 96-jul-13:
	30	*
	31	* I've since upgraded to two disks and a CD-ROM, with no trouble, and
	32	* I've also heard from several others who have used it successfully.
	33	* This driver appears to work with both the 1443/1445 and the 1487/1489
	34	* chipsets. I've added support for PIO mode 4 for the 1487. This
	35	* seems to work just fine on the 1443 also, although I'm not sure it's
	36	* advertised as supporting mode 4. (I've been running a WDC AC21200 in
	37	* mode 4 for a while now with no trouble.) -Derek
	38	*/
	39
1da177e4	40	#include <linux/module.h>
1da177e4 LT	41	#include <linux/types.h>
	42	#include <linux/kernel.h>
	43	#include <linux/delay.h>
	44	#include <linux/timer.h>
	45	#include <linux/mm.h>
	46	#include <linux/ioport.h>
	47	#include <linux/blkdev.h>
	48	#include <linux/hdreg.h>
	49	#include <linux/ide.h>
	50	#include <linux/init.h>
	51
	52	#include <asm/io.h>
	53
	54	/* port addresses for auto-detection */
	55	#define ALI_NUM_PORTS 4
498f26b4 BZ	56	static const int ports[ALI_NUM_PORTS] __initdata =
498f26b4 BZ	57	{ 0x074, 0x0f4, 0x034, 0x0e4 };
1da177e4 LT	58
	59	/* register initialization data */
	60	typedef struct { u8 reg, data; } RegInitializer;
	61
498f26b4	62	static const RegInitializer initData[] __initdata = {
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	*/
	91	static inline u8 inReg (u8 reg)
	92	{
	93	outb_p(reg, regPort);
	94	return inb(dataPort);
	95	}
	96
	97	/*
	98	* Write a controller register.
	99	*/
	100	static void outReg (u8 data, u8 reg)
	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	*/
26bcb879	113	static void ali14xx_set_pio_mode(ide_drive_t *drive, const u8 pio)
1da177e4 LT	114	{
	115	int driveNum;
	116	int time1, time2;
	117	u8 param1, param2, param3, param4;
	118	unsigned long flags;
1da177e4 LT	119	int bus_speed = system_bus_clock();
1da177e4 LT	120
1da177e4	121	/* calculate timing, according to PIO mode */
7dd00083	122	time1 = ide_pio_cycle_time(drive, pio);
1da177e4 LT	123	time2 = ide_pio_timings[pio].active_time;
	124	param3 = param1 = (time2 * bus_speed + 999) / 1000;
	125	param4 = param2 = (time1 * bus_speed + 999) / 1000 - param1;
	126	if (pio < 3) {
	127	param3 += 8;
	128	param4 += 8;
	129	}
	130	printk(KERN_DEBUG "%s: PIO mode%d, t1=%dns, t2=%dns, cycles = %d+%d, %d+%d\n",
	131	drive->name, pio, time1, time2, param1, param2, param3, param4);
	132
	133	/* stuff timing parameters into controller registers */
	134	driveNum = (HWIF(drive)->index << 1) + drive->select.b.unit;
2047e15b	135	spin_lock_irqsave(&ali14xx_lock, flags);
1da177e4 LT	136	outb_p(regOn, basePort);
	137	outReg(param1, regTab[driveNum].reg1);
	138	outReg(param2, regTab[driveNum].reg2);
	139	outReg(param3, regTab[driveNum].reg3);
	140	outReg(param4, regTab[driveNum].reg4);
	141	outb_p(regOff, basePort);
2047e15b	142	spin_unlock_irqrestore(&ali14xx_lock, flags);
1da177e4 LT	143	}
	144
	145	/*
	146	* Auto-detect the IDE controller port.
	147	*/
	148	static int __init findPort (void)
	149	{
	150	int i;
	151	u8 t;
	152	unsigned long flags;
	153
	154	local_irq_save(flags);
	155	for (i = 0; i < ALI_NUM_PORTS; ++i) {
	156	basePort = ports[i];
	157	regOff = inb(basePort);
	158	for (regOn = 0x30; regOn <= 0x33; ++regOn) {
	159	outb_p(regOn, basePort);
	160	if (inb(basePort) == regOn) {
	161	regPort = basePort + 4;
	162	dataPort = basePort + 8;
	163	t = inReg(0) & 0xf0;
	164	outb_p(regOff, basePort);
	165	local_irq_restore(flags);
	166	if (t != 0x50)
	167	return 0;
	168	return 1; /* success */
	169	}
	170	}
	171	outb_p(regOff, basePort);
	172	}
	173	local_irq_restore(flags);
	174	return 0;
	175	}
	176
	177	/*
	178	* Initialize controller registers with default values.
	179	*/
	180	static int __init initRegisters (void) {
498f26b4	181	const RegInitializer *p;
1da177e4 LT	182	u8 t;
	183	unsigned long flags;
	184
	185	local_irq_save(flags);
	186	outb_p(regOn, basePort);
	187	for (p = initData; p->reg != 0; ++p)
	188	outReg(p->data, p->reg);
	189	outb_p(0x01, regPort);
	190	t = inb(regPort) & 0x01;
	191	outb_p(regOff, basePort);
	192	local_irq_restore(flags);
	193	return t;
	194	}
	195
	196	static int __init ali14xx_probe(void)
	197	{
	198	ide_hwif_t hwif, mate;
8447d9d5	199	static u8 idx[4] = { 0, 1, 0xff, 0xff };
1da177e4 LT	200
	201	printk(KERN_DEBUG "ali14xx: base=0x%03x, regOn=0x%02x.\n",
	202	basePort, regOn);
	203
	204	/* initialize controller registers */
	205	if (!initRegisters()) {
	206	printk(KERN_ERR "ali14xx: Chip initialization failed.\n");
	207	return 1;
	208	}
	209
	210	hwif = &ide_hwifs[0];
	211	mate = &ide_hwifs[1];
	212
	213	hwif->chipset = ide_ali14xx;
4099d143	214	hwif->pio_mask = ATA_PIO4;
26bcb879	215	hwif->set_pio_mode = &ali14xx_set_pio_mode;
1da177e4 LT	216	hwif->mate = mate;
	217
	218	mate->chipset = ide_ali14xx;
4099d143	219	mate->pio_mask = ATA_PIO4;
26bcb879	220	mate->set_pio_mode = &ali14xx_set_pio_mode;
1da177e4 LT	221	mate->mate = hwif;
	222	mate->channel = 1;
	223
8447d9d5	224	ide_device_add(idx);
1da177e4 LT	225
	226	return 0;
	227	}
	228
84913882 BZ	229	int probe_ali14xx = 0;
	230
	231	module_param_named(probe, probe_ali14xx, bool, 0);
	232	MODULE_PARM_DESC(probe, "probe for ALI M14xx chipsets");
	233
1da177e4 LT	234	/* Can be called directly from ide.c. */
	235	int __init ali14xx_init(void)
	236	{
84913882 BZ	237	if (probe_ali14xx == 0)
	238	goto out;
	239
1da177e4 LT	240	/* auto-detect IDE controller port */
	241	if (findPort()) {
	242	if (ali14xx_probe())
	243	return -ENODEV;
	244	return 0;
	245	}
	246	printk(KERN_ERR "ali14xx: not found.\n");
84913882	247	out:
1da177e4 LT	248	return -ENODEV;
	249	}
	250
	251	#ifdef MODULE
	252	module_init(ali14xx_init);
	253	#endif
	254
	255	MODULE_AUTHOR("see local file");
	256	MODULE_DESCRIPTION("support of ALI 14XX IDE chipsets");
	257	MODULE_LICENSE("GPL");