ide: add struct ide_port_ops (take 2)
[linux-2.6.git] / drivers / ide / legacy / qd65xx.c
1 /*
2  *  Copyright (C) 1996-2001  Linus Torvalds & author (see below)
3  */
4
5 /*
6  *  Version 0.03        Cleaned auto-tune, added probe
7  *  Version 0.04        Added second channel tuning
8  *  Version 0.05        Enhanced tuning ; added qd6500 support
9  *  Version 0.06        Added dos driver's list
10  *  Version 0.07        Second channel bug fix 
11  *
12  * QDI QD6500/QD6580 EIDE controller fast support
13  *
14  * Please set local bus speed using kernel parameter idebus
15  *      for example, "idebus=33" stands for 33Mhz VLbus
16  * To activate controller support, use "ide0=qd65xx"
17  * To enable tuning, use "hda=autotune hdb=autotune"
18  * To enable 2nd channel tuning (qd6580 only), use "hdc=autotune hdd=autotune"
19  */
20
21 /*
22  * Rewritten from the work of Colten Edwards <pje120@cs.usask.ca> by
23  * Samuel Thibault <samuel.thibault@fnac.net>
24  */
25
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/kernel.h>
29 #include <linux/delay.h>
30 #include <linux/timer.h>
31 #include <linux/mm.h>
32 #include <linux/ioport.h>
33 #include <linux/blkdev.h>
34 #include <linux/hdreg.h>
35 #include <linux/ide.h>
36 #include <linux/init.h>
37 #include <asm/system.h>
38 #include <asm/io.h>
39
40 #include "qd65xx.h"
41
42 /*
43  * I/O ports are 0x30-0x31 (and 0x32-0x33 for qd6580)
44  *            or 0xb0-0xb1 (and 0xb2-0xb3 for qd6580)
45  *      -- qd6500 is a single IDE interface
46  *      -- qd6580 is a dual IDE interface
47  *
48  * More research on qd6580 being done by willmore@cig.mot.com (David)
49  * More Information given by Petr Soucek (petr@ryston.cz)
50  * http://www.ryston.cz/petr/vlb
51  */
52
53 /*
54  * base: Timer1
55  *
56  *
57  * base+0x01: Config (R/O)
58  *
59  * bit 0: ide baseport: 1 = 0x1f0 ; 0 = 0x170 (only useful for qd6500)
60  * bit 1: qd65xx baseport: 1 = 0xb0 ; 0 = 0x30
61  * bit 2: ID3: bus speed: 1 = <=33MHz ; 0 = >33MHz
62  * bit 3: qd6500: 1 = disabled, 0 = enabled
63  *        qd6580: 1
64  * upper nibble:
65  *        qd6500: 1100
66  *        qd6580: either 1010 or 0101
67  *
68  *
69  * base+0x02: Timer2 (qd6580 only)
70  *
71  *
72  * base+0x03: Control (qd6580 only)
73  *
74  * bits 0-3 must always be set 1
75  * bit 4 must be set 1, but is set 0 by dos driver while measuring vlb clock
76  * bit 0 : 1 = Only primary port enabled : channel 0 for hda, channel 1 for hdb
77  *         0 = Primary and Secondary ports enabled : channel 0 for hda & hdb
78  *                                                   channel 1 for hdc & hdd
79  * bit 1 : 1 = only disks on primary port
80  *         0 = disks & ATAPI devices on primary port
81  * bit 2-4 : always 0
82  * bit 5 : status, but of what ?
83  * bit 6 : always set 1 by dos driver
84  * bit 7 : set 1 for non-ATAPI devices on primary port
85  *      (maybe read-ahead and post-write buffer ?)
86  */
87
88 static int timings[4]={-1,-1,-1,-1}; /* stores current timing for each timer */
89
90 /*
91  * qd65xx_select:
92  *
93  * This routine is invoked to prepare for access to a given drive.
94  */
95
96 static void qd65xx_select(ide_drive_t *drive)
97 {
98         u8 index = ((   (QD_TIMREG(drive)) & 0x80 ) >> 7) |
99                         (QD_TIMREG(drive) & 0x02);
100
101         if (timings[index] != QD_TIMING(drive))
102                 outb(timings[index] = QD_TIMING(drive), QD_TIMREG(drive));
103 }
104
105 /*
106  * qd6500_compute_timing
107  *
108  * computes the timing value where
109  *      lower nibble represents active time,   in count of VLB clocks
110  *      upper nibble represents recovery time, in count of VLB clocks
111  */
112
113 static u8 qd6500_compute_timing (ide_hwif_t *hwif, int active_time, int recovery_time)
114 {
115         u8 active_cycle,recovery_cycle;
116
117         if (system_bus_clock()<=33) {
118                 active_cycle =   9  - IDE_IN(active_time   * system_bus_clock() / 1000 + 1, 2, 9);
119                 recovery_cycle = 15 - IDE_IN(recovery_time * system_bus_clock() / 1000 + 1, 0, 15);
120         } else {
121                 active_cycle =   8  - IDE_IN(active_time   * system_bus_clock() / 1000 + 1, 1, 8);
122                 recovery_cycle = 18 - IDE_IN(recovery_time * system_bus_clock() / 1000 + 1, 3, 18);
123         }
124
125         return((recovery_cycle<<4) | 0x08 | active_cycle);
126 }
127
128 /*
129  * qd6580_compute_timing
130  *
131  * idem for qd6580
132  */
133
134 static u8 qd6580_compute_timing (int active_time, int recovery_time)
135 {
136         u8 active_cycle   = 17 - IDE_IN(active_time   * system_bus_clock() / 1000 + 1, 2, 17);
137         u8 recovery_cycle = 15 - IDE_IN(recovery_time * system_bus_clock() / 1000 + 1, 2, 15);
138
139         return((recovery_cycle<<4) | active_cycle);
140 }
141
142 /*
143  * qd_find_disk_type
144  *
145  * tries to find timing from dos driver's table
146  */
147
148 static int qd_find_disk_type (ide_drive_t *drive,
149                 int *active_time, int *recovery_time)
150 {
151         struct qd65xx_timing_s *p;
152         char model[40];
153
154         if (!*drive->id->model) return 0;
155
156         strncpy(model,drive->id->model,40);
157         ide_fixstring(model,40,1); /* byte-swap */
158
159         for (p = qd65xx_timing ; p->offset != -1 ; p++) {
160                 if (!strncmp(p->model, model+p->offset, 4)) {
161                         printk(KERN_DEBUG "%s: listed !\n", drive->name);
162                         *active_time = p->active;
163                         *recovery_time = p->recovery;
164                         return 1;
165                 }
166         }
167         return 0;
168 }
169
170 /*
171  * qd_set_timing:
172  *
173  * records the timing
174  */
175
176 static void qd_set_timing (ide_drive_t *drive, u8 timing)
177 {
178         drive->drive_data &= 0xff00;
179         drive->drive_data |= timing;
180
181         printk(KERN_DEBUG "%s: %#x\n", drive->name, timing);
182 }
183
184 static void qd6500_set_pio_mode(ide_drive_t *drive, const u8 pio)
185 {
186         int active_time   = 175;
187         int recovery_time = 415; /* worst case values from the dos driver */
188
189         /*
190          * FIXME: use "pio" value
191          */
192         if (drive->id && !qd_find_disk_type(drive, &active_time, &recovery_time)
193                 && drive->id->tPIO && (drive->id->field_valid & 0x02)
194                 && drive->id->eide_pio >= 240) {
195
196                 printk(KERN_INFO "%s: PIO mode%d\n", drive->name,
197                                 drive->id->tPIO);
198                 active_time = 110;
199                 recovery_time = drive->id->eide_pio - 120;
200         }
201
202         qd_set_timing(drive, qd6500_compute_timing(HWIF(drive), active_time, recovery_time));
203 }
204
205 static void qd6580_set_pio_mode(ide_drive_t *drive, const u8 pio)
206 {
207         ide_hwif_t *hwif = drive->hwif;
208         unsigned int cycle_time;
209         int active_time   = 175;
210         int recovery_time = 415; /* worst case values from the dos driver */
211         u8 base = (hwif->config_data & 0xff00) >> 8;
212
213         if (drive->id && !qd_find_disk_type(drive, &active_time, &recovery_time)) {
214                 cycle_time = ide_pio_cycle_time(drive, pio);
215
216                 switch (pio) {
217                         case 0: break;
218                         case 3:
219                                 if (cycle_time >= 110) {
220                                         active_time = 86;
221                                         recovery_time = cycle_time - 102;
222                                 } else
223                                         printk(KERN_WARNING "%s: Strange recovery time !\n",drive->name);
224                                 break;
225                         case 4:
226                                 if (cycle_time >= 69) {
227                                         active_time = 70;
228                                         recovery_time = cycle_time - 61;
229                                 } else
230                                         printk(KERN_WARNING "%s: Strange recovery time !\n",drive->name);
231                                 break;
232                         default:
233                                 if (cycle_time >= 180) {
234                                         active_time = 110;
235                                         recovery_time = cycle_time - 120;
236                                 } else {
237                                         active_time = ide_pio_timings[pio].active_time;
238                                         recovery_time = cycle_time - active_time;
239                                 }
240                 }
241                 printk(KERN_INFO "%s: PIO mode%d\n", drive->name,pio);
242         }
243
244         if (!HWIF(drive)->channel && drive->media != ide_disk) {
245                 outb(0x5f, QD_CONTROL_PORT);
246                 printk(KERN_WARNING "%s: ATAPI: disabled read-ahead FIFO "
247                         "and post-write buffer on %s.\n",
248                         drive->name, HWIF(drive)->name);
249         }
250
251         qd_set_timing(drive, qd6580_compute_timing(active_time, recovery_time));
252 }
253
254 /*
255  * qd_testreg
256  *
257  * tests if the given port is a register
258  */
259
260 static int __init qd_testreg(int port)
261 {
262         unsigned long flags;
263         u8 savereg, readreg;
264
265         local_irq_save(flags);
266         savereg = inb_p(port);
267         outb_p(QD_TESTVAL, port);       /* safe value */
268         readreg = inb_p(port);
269         outb(savereg, port);
270         local_irq_restore(flags);
271
272         if (savereg == QD_TESTVAL) {
273                 printk(KERN_ERR "Outch ! the probe for qd65xx isn't reliable !\n");
274                 printk(KERN_ERR "Please contact maintainers to tell about your hardware\n");
275                 printk(KERN_ERR "Assuming qd65xx is not present.\n");
276                 return 1;
277         }
278
279         return (readreg != QD_TESTVAL);
280 }
281
282 static void __init qd6500_port_init_devs(ide_hwif_t *hwif)
283 {
284         u8 base = (hwif->config_data & 0xff00) >> 8;
285         u8 config = QD_CONFIG(hwif);
286
287         hwif->drives[0].drive_data = QD6500_DEF_DATA;
288         hwif->drives[1].drive_data = QD6500_DEF_DATA;
289 }
290
291 static void __init qd6580_port_init_devs(ide_hwif_t *hwif)
292 {
293         u16 t1, t2;
294         u8 base = (hwif->config_data & 0xff00) >> 8;
295         u8 config = QD_CONFIG(hwif);
296
297         if (hwif->host_flags & IDE_HFLAG_SINGLE) {
298                 t1 = QD6580_DEF_DATA;
299                 t2 = QD6580_DEF_DATA2;
300         } else
301                 t2 = t1 = hwif->channel ? QD6580_DEF_DATA2 : QD6580_DEF_DATA;
302
303         hwif->drives[0].drive_data = t1;
304         hwif->drives[1].drive_data = t2;
305 }
306
307 static const struct ide_port_ops qd6500_port_ops = {
308         .port_init_devs         = qd6500_port_init_devs,
309         .set_pio_mode           = qd6500_set_pio_mode,
310         .selectproc             = qd65xx_select,
311 };
312
313 static const struct ide_port_ops qd6580_port_ops = {
314         .port_init_devs         = qd6580_port_init_devs,
315         .set_pio_mode           = qd6580_set_pio_mode,
316         .selectproc             = qd65xx_select,
317 };
318
319 static const struct ide_port_info qd65xx_port_info __initdata = {
320         .chipset                = ide_qd65xx,
321         .host_flags             = IDE_HFLAG_IO_32BIT |
322                                   IDE_HFLAG_NO_DMA |
323                                   IDE_HFLAG_NO_AUTOTUNE,
324         .pio_mask               = ATA_PIO4,
325 };
326
327 /*
328  * qd_probe:
329  *
330  * looks at the specified baseport, and if qd found, registers & initialises it
331  * return 1 if another qd may be probed
332  */
333
334 static int __init qd_probe(int base)
335 {
336         ide_hwif_t *hwif;
337         u8 config, unit;
338         u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
339         hw_regs_t hw[2];
340         struct ide_port_info d = qd65xx_port_info;
341
342         config = inb(QD_CONFIG_PORT);
343
344         if (! ((config & QD_CONFIG_BASEPORT) >> 1 == (base == 0xb0)) )
345                 return -ENODEV;
346
347         unit = ! (config & QD_CONFIG_IDE_BASEPORT);
348
349         if (unit)
350                 d.host_flags |= IDE_HFLAG_QD_2ND_PORT;
351
352         memset(&hw, 0, sizeof(hw));
353
354         ide_std_init_ports(&hw[0], 0x1f0, 0x3f6);
355         hw[0].irq = 14;
356
357         ide_std_init_ports(&hw[1], 0x170, 0x376);
358         hw[1].irq = 15;
359
360         if ((config & 0xf0) == QD_CONFIG_QD6500) {
361
362                 if (qd_testreg(base))
363                          return -ENODEV;        /* bad register */
364
365                 /* qd6500 found */
366
367                 if (config & QD_CONFIG_DISABLED) {
368                         printk(KERN_WARNING "qd6500 is disabled !\n");
369                         return -ENODEV;
370                 }
371
372                 printk(KERN_NOTICE "qd6500 at %#x\n", base);
373                 printk(KERN_DEBUG "qd6500: config=%#x, ID3=%u\n",
374                         config, QD_ID3);
375
376                 d.port_ops = &qd6500_port_ops;
377                 d.host_flags |= IDE_HFLAG_SINGLE;
378
379                 hwif = ide_find_port_slot(&d);
380                 if (hwif == NULL)
381                         return -ENOENT;
382
383                 ide_init_port_hw(hwif, &hw[unit]);
384
385                 hwif->config_data = (base << 8) | config;
386
387                 idx[unit] = hwif->index;
388
389                 ide_device_add(idx, &d);
390
391                 return 1;
392         }
393
394         if (((config & 0xf0) == QD_CONFIG_QD6580_A) ||
395             ((config & 0xf0) == QD_CONFIG_QD6580_B)) {
396
397                 u8 control;
398
399                 if (qd_testreg(base) || qd_testreg(base + 0x02))
400                         return -ENODEV; /* bad registers */
401
402                 /* qd6580 found */
403
404                 control = inb(QD_CONTROL_PORT);
405
406                 printk(KERN_NOTICE "qd6580 at %#x\n", base);
407                 printk(KERN_DEBUG "qd6580: config=%#x, control=%#x, ID3=%u\n",
408                         config, control, QD_ID3);
409
410                 outb(QD_DEF_CONTR, QD_CONTROL_PORT);
411
412                 d.port_ops = &qd6580_port_ops;
413
414                 if (control & QD_CONTR_SEC_DISABLED) {
415                         /* secondary disabled */
416
417                         printk(KERN_INFO "qd6580: single IDE board\n");
418
419                         d.host_flags |= IDE_HFLAG_SINGLE;
420
421                         hwif = ide_find_port_slot(&d);
422                         if (hwif == NULL)
423                                 return -ENOENT;
424
425                         ide_init_port_hw(hwif, &hw[unit]);
426
427                         hwif->config_data = (base << 8) | config;
428
429                         idx[unit] = hwif->index;
430
431                         ide_device_add(idx, &d);
432
433                         return 1;
434                 } else {
435                         ide_hwif_t *mate;
436
437                         /* secondary enabled */
438                         printk(KERN_INFO "qd6580: dual IDE board\n");
439
440                         hwif = ide_find_port();
441                         if (hwif) {
442                                 ide_init_port_hw(hwif, &hw[0]);
443                                 idx[0] = hwif->index;
444                         }
445
446                         mate = ide_find_port();
447                         if (mate) {
448                                 ide_init_port_hw(mate, &hw[1]);
449                                 idx[1] = mate->index;
450                         }
451
452                         ide_device_add(idx, &d);
453
454                         return 0; /* no other qd65xx possible */
455                 }
456         }
457         /* no qd65xx found */
458         return -ENODEV;
459 }
460
461 int probe_qd65xx = 0;
462
463 module_param_named(probe, probe_qd65xx, bool, 0);
464 MODULE_PARM_DESC(probe, "probe for QD65xx chipsets");
465
466 static int __init qd65xx_init(void)
467 {
468         int rc1, rc2 = -ENODEV;
469
470         if (probe_qd65xx == 0)
471                 return -ENODEV;
472
473         rc1 = qd_probe(0x30);
474         if (rc1)
475                 rc2 = qd_probe(0xb0);
476
477         if (rc1 < 0 && rc2 < 0)
478                 return -ENODEV;
479
480         return 0;
481 }
482
483 module_init(qd65xx_init);
484
485 MODULE_AUTHOR("Samuel Thibault");
486 MODULE_DESCRIPTION("support of qd65xx vlb ide chipset");
487 MODULE_LICENSE("GPL");