[PATCH] 2.5.7 IDE 27
[opensuse:kernel.git] / drivers / ide / ht6560b.c
1 /*
2  *  Copyright (C) 1995-2000  Linus Torvalds & author (see below)
3  *
4  *  Version 0.01        Initial version hacked out of ide.c
5  *
6  *  Version 0.02        Added support for PIO modes, auto-tune
7  *
8  *  Version 0.03        Some cleanups
9  *
10  *  Version 0.05        PIO mode cycle timings auto-tune using bus-speed
11  *
12  *  Version 0.06        Prefetch mode now defaults no OFF. To set
13  *                      prefetch mode OFF/ON use "hdparm -p8/-p9".
14  *                      Unmask irq is disabled when prefetch mode
15  *                      is enabled.
16  *
17  *  Version 0.07        Trying to fix CD-ROM detection problem.
18  *                      "Prefetch" mode bit OFF for ide disks and
19  *                      ON for anything else.
20  *
21  *
22  *  HT-6560B EIDE-controller support
23  *  To activate controller support use kernel parameter "ide0=ht6560b".
24  *  Use hdparm utility to enable PIO mode support.
25  *
26  *  Author:    Mikko Ala-Fossi            <maf@iki.fi>
27  *             Jan Evert van Grootheest   <janevert@iae.nl>
28  *
29  *  Try:  http://www.maf.iki.fi/~maf/ht6560b/
30  */
31
32 #define HT6560B_VERSION "v0.07"
33
34 #include <linux/types.h>
35 #include <linux/kernel.h>
36 #include <linux/delay.h>
37 #include <linux/timer.h>
38 #include <linux/mm.h>
39 #include <linux/ioport.h>
40 #include <linux/blkdev.h>
41 #include <linux/hdreg.h>
42 #include <linux/ide.h>
43 #include <linux/init.h>
44
45 #include <asm/io.h>
46
47 #include "ata-timing.h"
48
49 /* #define DEBUG */  /* remove comments for DEBUG messages */
50
51 /*
52  * The special i/o-port that HT-6560B uses to configuration:
53  *    bit0 (0x01): "1" selects secondary interface
54  *    bit2 (0x04): "1" enables FIFO function
55  *    bit5 (0x20): "1" enables prefetched data read function  (???)
56  *
57  * The special i/o-port that HT-6560A uses to configuration:
58  *    bit0 (0x01): "1" selects secondary interface
59  *    bit1 (0x02): "1" enables prefetched data read function
60  *    bit2 (0x04): "0" enables multi-master system            (?)
61  *    bit3 (0x08): "1" 3 cycle time, "0" 2 cycle time         (?)
62  */
63 #define HT_CONFIG_PORT    0x3e6
64 #define HT_CONFIG(drivea) (byte)(((drivea)->drive_data & 0xff00) >> 8)
65 /*
66  * FIFO + PREFETCH (both a/b-model)
67  */
68 #define HT_CONFIG_DEFAULT 0x1c /* no prefetch */
69 /* #define HT_CONFIG_DEFAULT 0x3c */ /* with prefetch */
70 #define HT_SECONDARY_IF   0x01
71 #define HT_PREFETCH_MODE  0x20
72
73 /*
74  * ht6560b Timing values:
75  *
76  * I reviewed some assembler source listings of htide drivers and found
77  * out how they setup those cycle time interfacing values, as they at Holtek
78  * call them. IDESETUP.COM that is supplied with the drivers figures out
79  * optimal values and fetches those values to drivers. I found out that
80  * they use IDE_SELECT_REG to fetch timings to the ide board right after
81  * interface switching. After that it was quite easy to add code to
82  * ht6560b.c.
83  *
84  * IDESETUP.COM gave me values 0x24, 0x45, 0xaa, 0xff that worked fine
85  * for hda and hdc. But hdb needed higher values to work, so I guess
86  * that sometimes it is necessary to give higher value than IDESETUP
87  * gives.   [see cmd640.c for an extreme example of this. -ml]
88  *
89  * Perhaps I should explain something about these timing values:
90  * The higher nibble of value is the Recovery Time  (rt) and the lower nibble
91  * of the value is the Active Time  (at). Minimum value 2 is the fastest and
92  * the maximum value 15 is the slowest. Default values should be 15 for both.
93  * So 0x24 means 2 for rt and 4 for at. Each of the drives should have
94  * both values, and IDESETUP gives automatically rt=15 st=15 for CDROMs or
95  * similar. If value is too small there will be all sorts of failures.
96  *
97  * Timing byte consists of
98  *      High nibble:  Recovery Cycle Time  (rt)
99  *           The valid values range from 2 to 15. The default is 15.
100  *
101  *      Low nibble:   Active Cycle Time    (at)
102  *           The valid values range from 2 to 15. The default is 15.
103  *
104  * You can obtain optimized timing values by running Holtek IDESETUP.COM
105  * for DOS. DOS drivers get their timing values from command line, where
106  * the first value is the Recovery Time and the second value is the
107  * Active Time for each drive. Smaller value gives higher speed.
108  * In case of failures you should probably fall back to a higher value.
109  */
110 #define HT_TIMING(drivea) (byte)((drivea)->drive_data & 0x00ff)
111 #define HT_TIMING_DEFAULT 0xff
112
113 /*
114  * This routine handles interface switching for the peculiar hardware design
115  * on the F.G.I./Holtek HT-6560B VLB IDE interface.
116  * The HT-6560B can only enable one IDE port at a time, and requires a
117  * silly sequence (below) whenever we switch between primary and secondary.
118  */
119
120 /*
121  * This routine is invoked from ide.c to prepare for access to a given drive.
122  */
123 static void ht6560b_selectproc (ide_drive_t *drive)
124 {
125         unsigned long flags;
126         static byte current_select = 0;
127         static byte current_timing = 0;
128         byte select, timing;
129         
130         __save_flags (flags);   /* local CPU only */
131         __cli();                /* local CPU only */
132         
133         select = HT_CONFIG(drive);
134         timing = HT_TIMING(drive);
135         
136         if (select != current_select || timing != current_timing) {
137                 current_select = select;
138                 current_timing = timing;
139                 if (drive->type != ATA_DISK || !drive->present)
140                         select |= HT_PREFETCH_MODE;
141                 (void) inb(HT_CONFIG_PORT);
142                 (void) inb(HT_CONFIG_PORT);
143                 (void) inb(HT_CONFIG_PORT);
144                 (void) inb(HT_CONFIG_PORT);
145                 outb(select, HT_CONFIG_PORT);
146                 /*
147                  * Set timing for this drive:
148                  */
149                 outb(timing, IDE_SELECT_REG);
150                 (void) inb(IDE_STATUS_REG);
151 #ifdef DEBUG
152                 printk("ht6560b: %s: select=%#x timing=%#x\n", drive->name, select, timing);
153 #endif
154         }
155         __restore_flags (flags);        /* local CPU only */
156 }
157
158 /*
159  * Autodetection and initialization of ht6560b
160  */
161 static int __init try_to_init_ht6560b(void)
162 {
163         byte orig_value;
164         int i;
165         
166         /* Autodetect ht6560b */
167         if ((orig_value=inb(HT_CONFIG_PORT)) == 0xff)
168                 return 0;
169         
170         for (i=3;i>0;i--) {
171                 outb(0x00, HT_CONFIG_PORT);
172                 if (!( (~inb(HT_CONFIG_PORT)) & 0x3f )) {
173                         outb(orig_value, HT_CONFIG_PORT);
174                         return 0;
175                 }
176         }
177         outb(0x00, HT_CONFIG_PORT);
178         if ((~inb(HT_CONFIG_PORT))& 0x3f) {
179                 outb(orig_value, HT_CONFIG_PORT);
180                 return 0;
181         }
182         /*
183          * Ht6560b autodetected
184          */
185         outb(HT_CONFIG_DEFAULT, HT_CONFIG_PORT);
186         outb(HT_TIMING_DEFAULT, 0x1f6);  /* IDE_SELECT_REG */
187         (void) inb(0x1f7);               /* IDE_STATUS_REG */
188         
189         printk("\nht6560b " HT6560B_VERSION
190                ": chipset detected and initialized"
191 #ifdef DEBUG
192                " with debug enabled"
193 #endif
194                 );
195         return 1;
196 }
197
198 static byte ht_pio2timings(ide_drive_t *drive, byte pio)
199 {
200         int active_time, recovery_time;
201         int active_cycles, recovery_cycles;
202         struct ata_timing *t;
203
204         if (pio) {
205                 if (pio == 255)
206                         pio = ata_timing_mode(drive, XFER_PIO | XFER_EPIO);
207                 else
208                         pio = XFER_PIO_0 + min_t(byte, pio, 4);
209
210                 t = ata_timing_data(pio);
211
212                 /*
213                  *  Just like opti621.c we try to calculate the
214                  *  actual cycle time for recovery and activity
215                  *  according system bus speed.
216                  */
217                 active_time = t->active;
218                 recovery_time = t->cycle - active_time - t->setup;
219                 /*
220                  *  Cycle times should be Vesa bus cycles
221                  */
222                 active_cycles   = (active_time   * system_bus_speed + 999) / 1000;
223                 recovery_cycles = (recovery_time * system_bus_speed + 999) / 1000;
224                 /*
225                  *  Upper and lower limits
226                  */
227                 if (active_cycles   < 2)  active_cycles   = 2;
228                 if (recovery_cycles < 2)  recovery_cycles = 2;
229                 if (active_cycles   > 15) active_cycles   = 15;
230                 if (recovery_cycles > 15) recovery_cycles = 0;  /* 0==16 */
231                 
232 #ifdef DEBUG
233                 printk("ht6560b: drive %s setting pio=%d recovery=%d (%dns) active=%d (%dns)\n",
234                         drive->name, pio - XFER_PIO_0, recovery_cycles, recovery_time, active_cycles, active_time);
235 #endif
236                 
237                 return (byte)((recovery_cycles << 4) | active_cycles);
238         } else {
239                 
240 #ifdef DEBUG
241                 printk("ht6560b: drive %s setting pio=0\n", drive->name);
242 #endif
243                 
244                 return HT_TIMING_DEFAULT;    /* default setting */
245         }
246 }
247
248 /*
249  *  Enable/Disable so called prefetch mode
250  */
251 static void ht_set_prefetch(ide_drive_t *drive, byte state)
252 {
253         unsigned long flags;
254         int t = HT_PREFETCH_MODE << 8;
255         
256         save_flags (flags);     /* all CPUs */
257         cli();                  /* all CPUs */
258         
259         /*
260          *  Prefetch mode and unmask irq seems to conflict
261          */
262         if (state) {
263                 drive->drive_data |= t;   /* enable prefetch mode */
264                 drive->no_unmask = 1;
265                 drive->unmask = 0;
266         } else {
267                 drive->drive_data &= ~t;  /* disable prefetch mode */
268                 drive->no_unmask = 0;
269         }
270         
271         restore_flags (flags);  /* all CPUs */
272         
273 #ifdef DEBUG
274         printk("ht6560b: drive %s prefetch mode %sabled\n", drive->name, (state ? "en" : "dis"));
275 #endif
276 }
277
278 static void tune_ht6560b (ide_drive_t *drive, byte pio)
279 {
280         unsigned long flags;
281         byte timing;
282         
283         switch (pio) {
284         case 8:         /* set prefetch off */
285         case 9:         /* set prefetch on */
286                 ht_set_prefetch(drive, pio & 1);
287                 return;
288         }
289         
290         timing = ht_pio2timings(drive, pio);
291         
292         save_flags (flags);     /* all CPUs */
293         cli();                  /* all CPUs */
294         
295         drive->drive_data &= 0xff00;
296         drive->drive_data |= timing;
297         
298         restore_flags (flags);  /* all CPUs */
299         
300 #ifdef DEBUG
301         printk("ht6560b: drive %s tuned to pio mode %#x timing=%#x\n", drive->name, pio, timing);
302 #endif
303 }
304
305 void __init init_ht6560b (void)
306 {
307         int t;
308         
309         if (check_region(HT_CONFIG_PORT,1)) {
310                 printk(KERN_ERR "ht6560b: PORT %#x ALREADY IN USE\n", HT_CONFIG_PORT);
311         } else {
312                 if (try_to_init_ht6560b()) {
313                         request_region(HT_CONFIG_PORT, 1, ide_hwifs[0].name);
314                         ide_hwifs[0].chipset = ide_ht6560b;
315                         ide_hwifs[1].chipset = ide_ht6560b;
316                         ide_hwifs[0].selectproc = &ht6560b_selectproc;
317                         ide_hwifs[1].selectproc = &ht6560b_selectproc;
318                         ide_hwifs[0].tuneproc = &tune_ht6560b;
319                         ide_hwifs[1].tuneproc = &tune_ht6560b;
320                         ide_hwifs[0].serialized = 1;  /* is this needed? */
321                         ide_hwifs[1].serialized = 1;  /* is this needed? */
322                         ide_hwifs[0].mate = &ide_hwifs[1];
323                         ide_hwifs[1].mate = &ide_hwifs[0];
324                         ide_hwifs[1].unit = 1;
325                         
326                         /*
327                          * Setting default configurations for drives
328                          */
329                         t = (HT_CONFIG_DEFAULT << 8);
330                         t |= HT_TIMING_DEFAULT;
331                         ide_hwifs[0].drives[0].drive_data = t;
332                         ide_hwifs[0].drives[1].drive_data = t;
333                         t |= (HT_SECONDARY_IF << 8);
334                         ide_hwifs[1].drives[0].drive_data = t;
335                         ide_hwifs[1].drives[1].drive_data = t;
336                 } else
337                         printk(KERN_ERR "ht6560b: not found\n");
338         }
339 }