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
40#include <linux/module.h>
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
56static int ports[ALI_NUM_PORTS] __initdata = {0x074, 0x0f4, 0x034, 0x0e4};
57
58/* register initialization data */
59typedef struct { u8 reg, data; } RegInitializer;
60
61static RegInitializer initData[] __initdata = {
62	{0x01, 0x0f}, {0x02, 0x00}, {0x03, 0x00}, {0x04, 0x00},
63	{0x05, 0x00}, {0x06, 0x00}, {0x07, 0x2b}, {0x0a, 0x0f},
64	{0x25, 0x00}, {0x26, 0x00}, {0x27, 0x00}, {0x28, 0x00},
65	{0x29, 0x00}, {0x2a, 0x00}, {0x2f, 0x00}, {0x2b, 0x00},
66	{0x2c, 0x00}, {0x2d, 0x00}, {0x2e, 0x00}, {0x30, 0x00},
67	{0x31, 0x00}, {0x32, 0x00}, {0x33, 0x00}, {0x34, 0xff},
68	{0x35, 0x03}, {0x00, 0x00}
69};
70
71#define ALI_MAX_PIO 4
72
73/* timing parameter registers for each drive */
74static struct { u8 reg1, reg2, reg3, reg4; } regTab[4] = {
75	{0x03, 0x26, 0x04, 0x27},     /* drive 0 */
76	{0x05, 0x28, 0x06, 0x29},     /* drive 1 */
77	{0x2b, 0x30, 0x2c, 0x31},     /* drive 2 */
78	{0x2d, 0x32, 0x2e, 0x33},     /* drive 3 */
79};
80
81static int basePort;	/* base port address */
82static int regPort;	/* port for register number */
83static int dataPort;	/* port for register data */
84static u8 regOn;	/* output to base port to access registers */
85static u8 regOff;	/* output to base port to close registers */
86
87/*------------------------------------------------------------------------*/
88
89/*
90 * Read a controller register.
91 */
92static inline u8 inReg (u8 reg)
93{
94	outb_p(reg, regPort);
95	return inb(dataPort);
96}
97
98/*
99 * Write a controller register.
100 */
101static void outReg (u8 data, u8 reg)
102{
103	outb_p(reg, regPort);
104	outb_p(data, dataPort);
105}
106
107/*
108 * Set PIO mode for the specified drive.
109 * This function computes timing parameters
110 * and sets controller registers accordingly.
111 */
112static void ali14xx_tune_drive (ide_drive_t *drive, u8 pio)
113{
114	int driveNum;
115	int time1, time2;
116	u8 param1, param2, param3, param4;
117	unsigned long flags;
118	ide_pio_data_t d;
119	int bus_speed = system_bus_clock();
120
121	pio = ide_get_best_pio_mode(drive, pio, ALI_MAX_PIO, &d);
122
123	/* calculate timing, according to PIO mode */
124	time1 = d.cycle_time;
125	time2 = ide_pio_timings[pio].active_time;
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 */
136	driveNum = (HWIF(drive)->index << 1) + drive->select.b.unit;
137	spin_lock_irqsave(&ide_lock, flags);
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);
144	spin_unlock_irqrestore(&ide_lock, flags);
145}
146
147/*
148 * Auto-detect the IDE controller port.
149 */
150static int __init findPort (void)
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 */
182static int __init initRegisters (void) {
183	RegInitializer *p;
184	u8 t;
185	unsigned long flags;
186
187	local_irq_save(flags);
188	outb_p(regOn, basePort);
189	for (p = initData; p->reg != 0; ++p)
190		outReg(p->data, p->reg);
191	outb_p(0x01, regPort);
192	t = inb(regPort) & 0x01;
193	outb_p(regOff, basePort);
194	local_irq_restore(flags);
195	return t;
196}
197
198static int __init ali14xx_probe(void)
199{
200	ide_hwif_t *hwif, *mate;
201
202	printk(KERN_DEBUG "ali14xx: base=0x%03x, regOn=0x%02x.\n",
203			  basePort, regOn);
204
205	/* initialize controller registers */
206	if (!initRegisters()) {
207		printk(KERN_ERR "ali14xx: Chip initialization failed.\n");
208		return 1;
209	}
210
211	hwif = &ide_hwifs[0];
212	mate = &ide_hwifs[1];
213
214	hwif->chipset = ide_ali14xx;
215	hwif->tuneproc = &ali14xx_tune_drive;
216	hwif->mate = mate;
217
218	mate->chipset = ide_ali14xx;
219	mate->tuneproc = &ali14xx_tune_drive;
220	mate->mate = hwif;
221	mate->channel = 1;
222
223	probe_hwif_init(hwif);
224	probe_hwif_init(mate);
225
226	ide_proc_register_port(hwif);
227	ide_proc_register_port(mate);
228
229	return 0;
230}
231
232int probe_ali14xx = 0;
233
234module_param_named(probe, probe_ali14xx, bool, 0);
235MODULE_PARM_DESC(probe, "probe for ALI M14xx chipsets");
236
237/* Can be called directly from ide.c. */
238int __init ali14xx_init(void)
239{
240	if (probe_ali14xx == 0)
241		goto out;
242
243	/* auto-detect IDE controller port */
244	if (findPort()) {
245		if (ali14xx_probe())
246			return -ENODEV;
247		return 0;
248	}
249	printk(KERN_ERR "ali14xx: not found.\n");
250out:
251	return -ENODEV;
252}
253
254#ifdef MODULE
255module_init(ali14xx_init);
256#endif
257
258MODULE_AUTHOR("see local file");
259MODULE_DESCRIPTION("support of ALI 14XX IDE chipsets");
260MODULE_LICENSE("GPL");
261