umc8672: don't use ide_hwifs[] in umc_set_pio_mode()
[linux-2.6-block.git] / drivers / ide / legacy / ht6560b.c
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * Copyright (C) 1995-2000 Linus Torvalds & author (see below)
3 */
4
5/*
6 *
7 * Version 0.01 Initial version hacked out of ide.c
8 *
9 * Version 0.02 Added support for PIO modes, auto-tune
10 *
11 * Version 0.03 Some cleanups
12 *
13 * Version 0.05 PIO mode cycle timings auto-tune using bus-speed
14 *
15 * Version 0.06 Prefetch mode now defaults no OFF. To set
16 * prefetch mode OFF/ON use "hdparm -p8/-p9".
17 * Unmask irq is disabled when prefetch mode
18 * is enabled.
19 *
20 * Version 0.07 Trying to fix CD-ROM detection problem.
21 * "Prefetch" mode bit OFF for ide disks and
22 * ON for anything else.
23 *
0e7d8d48
JEG
24 * Version 0.08 Need to force prefetch for CDs and other non-disk
25 * devices. (not sure which devices exactly need
26 * prefetch)
1da177e4
LT
27 *
28 * HT-6560B EIDE-controller support
29 * To activate controller support use kernel parameter "ide0=ht6560b".
30 * Use hdparm utility to enable PIO mode support.
31 *
32 * Author: Mikko Ala-Fossi <maf@iki.fi>
0e7d8d48 33 * Jan Evert van Grootheest <janevert@caiway.nl>
1da177e4
LT
34 *
35 * Try: http://www.maf.iki.fi/~maf/ht6560b/
36 */
37
0e7d8d48 38#define HT6560B_VERSION "v0.08"
1da177e4 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/* #define DEBUG */ /* remove comments for DEBUG messages */
55
56/*
57 * The special i/o-port that HT-6560B uses to configuration:
58 * bit0 (0x01): "1" selects secondary interface
59 * bit2 (0x04): "1" enables FIFO function
60 * bit5 (0x20): "1" enables prefetched data read function (???)
61 *
62 * The special i/o-port that HT-6560A uses to configuration:
63 * bit0 (0x01): "1" selects secondary interface
64 * bit1 (0x02): "1" enables prefetched data read function
65 * bit2 (0x04): "0" enables multi-master system (?)
66 * bit3 (0x08): "1" 3 cycle time, "0" 2 cycle time (?)
67 */
68#define HT_CONFIG_PORT 0x3e6
69#define HT_CONFIG(drivea) (u8)(((drivea)->drive_data & 0xff00) >> 8)
70/*
71 * FIFO + PREFETCH (both a/b-model)
72 */
73#define HT_CONFIG_DEFAULT 0x1c /* no prefetch */
74/* #define HT_CONFIG_DEFAULT 0x3c */ /* with prefetch */
75#define HT_SECONDARY_IF 0x01
76#define HT_PREFETCH_MODE 0x20
77
78/*
79 * ht6560b Timing values:
80 *
81 * I reviewed some assembler source listings of htide drivers and found
82 * out how they setup those cycle time interfacing values, as they at Holtek
83 * call them. IDESETUP.COM that is supplied with the drivers figures out
84 * optimal values and fetches those values to drivers. I found out that
23579a2a 85 * they use Select register to fetch timings to the ide board right after
1da177e4
LT
86 * interface switching. After that it was quite easy to add code to
87 * ht6560b.c.
88 *
89 * IDESETUP.COM gave me values 0x24, 0x45, 0xaa, 0xff that worked fine
90 * for hda and hdc. But hdb needed higher values to work, so I guess
91 * that sometimes it is necessary to give higher value than IDESETUP
92 * gives. [see cmd640.c for an extreme example of this. -ml]
93 *
94 * Perhaps I should explain something about these timing values:
95 * The higher nibble of value is the Recovery Time (rt) and the lower nibble
96 * of the value is the Active Time (at). Minimum value 2 is the fastest and
97 * the maximum value 15 is the slowest. Default values should be 15 for both.
98 * So 0x24 means 2 for rt and 4 for at. Each of the drives should have
99 * both values, and IDESETUP gives automatically rt=15 st=15 for CDROMs or
100 * similar. If value is too small there will be all sorts of failures.
101 *
102 * Timing byte consists of
103 * High nibble: Recovery Cycle Time (rt)
104 * The valid values range from 2 to 15. The default is 15.
105 *
106 * Low nibble: Active Cycle Time (at)
107 * The valid values range from 2 to 15. The default is 15.
108 *
109 * You can obtain optimized timing values by running Holtek IDESETUP.COM
110 * for DOS. DOS drivers get their timing values from command line, where
111 * the first value is the Recovery Time and the second value is the
112 * Active Time for each drive. Smaller value gives higher speed.
113 * In case of failures you should probably fall back to a higher value.
114 */
115#define HT_TIMING(drivea) (u8)((drivea)->drive_data & 0x00ff)
116#define HT_TIMING_DEFAULT 0xff
117
118/*
119 * This routine handles interface switching for the peculiar hardware design
120 * on the F.G.I./Holtek HT-6560B VLB IDE interface.
121 * The HT-6560B can only enable one IDE port at a time, and requires a
122 * silly sequence (below) whenever we switch between primary and secondary.
123 */
124
125/*
126 * This routine is invoked from ide.c to prepare for access to a given drive.
127 */
128static void ht6560b_selectproc (ide_drive_t *drive)
129{
23579a2a 130 ide_hwif_t *hwif = drive->hwif;
1da177e4
LT
131 unsigned long flags;
132 static u8 current_select = 0;
133 static u8 current_timing = 0;
134 u8 select, timing;
135
136 local_irq_save(flags);
0e7d8d48 137
1da177e4
LT
138 select = HT_CONFIG(drive);
139 timing = HT_TIMING(drive);
0e7d8d48
JEG
140
141 /*
142 * Need to enforce prefetch sometimes because otherwise
143 * it'll hang (hard).
144 */
145 if (drive->media != ide_disk || !drive->present)
146 select |= HT_PREFETCH_MODE;
147
1da177e4
LT
148 if (select != current_select || timing != current_timing) {
149 current_select = select;
150 current_timing = timing;
0ecdca26
BZ
151 (void)inb(HT_CONFIG_PORT);
152 (void)inb(HT_CONFIG_PORT);
153 (void)inb(HT_CONFIG_PORT);
154 (void)inb(HT_CONFIG_PORT);
155 outb(select, HT_CONFIG_PORT);
1da177e4
LT
156 /*
157 * Set timing for this drive:
158 */
23579a2a
BZ
159 outb(timing, hwif->io_ports[IDE_SELECT_OFFSET]);
160 (void)inb(hwif->io_ports[IDE_STATUS_OFFSET]);
1da177e4
LT
161#ifdef DEBUG
162 printk("ht6560b: %s: select=%#x timing=%#x\n",
163 drive->name, select, timing);
164#endif
165 }
166 local_irq_restore(flags);
167}
168
169/*
170 * Autodetection and initialization of ht6560b
171 */
172static int __init try_to_init_ht6560b(void)
173{
174 u8 orig_value;
175 int i;
176
177 /* Autodetect ht6560b */
178 if ((orig_value = inb(HT_CONFIG_PORT)) == 0xff)
179 return 0;
180
181 for (i=3;i>0;i--) {
182 outb(0x00, HT_CONFIG_PORT);
183 if (!( (~inb(HT_CONFIG_PORT)) & 0x3f )) {
184 outb(orig_value, HT_CONFIG_PORT);
185 return 0;
186 }
187 }
188 outb(0x00, HT_CONFIG_PORT);
189 if ((~inb(HT_CONFIG_PORT))& 0x3f) {
190 outb(orig_value, HT_CONFIG_PORT);
191 return 0;
192 }
193 /*
194 * Ht6560b autodetected
195 */
196 outb(HT_CONFIG_DEFAULT, HT_CONFIG_PORT);
23579a2a
BZ
197 outb(HT_TIMING_DEFAULT, 0x1f6); /* Select register */
198 (void)inb(0x1f7); /* Status register */
199
0e7d8d48 200 printk("ht6560b " HT6560B_VERSION
1da177e4
LT
201 ": chipset detected and initialized"
202#ifdef DEBUG
203 " with debug enabled"
204#endif
0e7d8d48 205 "\n"
1da177e4
LT
206 );
207 return 1;
208}
209
26bcb879 210static u8 ht_pio2timings(ide_drive_t *drive, const u8 pio)
1da177e4
LT
211{
212 int active_time, recovery_time;
213 int active_cycles, recovery_cycles;
1da177e4
LT
214 int bus_speed = system_bus_clock();
215
216 if (pio) {
7dd00083
BZ
217 unsigned int cycle_time;
218
7dd00083
BZ
219 cycle_time = ide_pio_cycle_time(drive, pio);
220
1da177e4
LT
221 /*
222 * Just like opti621.c we try to calculate the
223 * actual cycle time for recovery and activity
224 * according system bus speed.
225 */
226 active_time = ide_pio_timings[pio].active_time;
7dd00083 227 recovery_time = cycle_time
1da177e4
LT
228 - active_time
229 - ide_pio_timings[pio].setup_time;
230 /*
231 * Cycle times should be Vesa bus cycles
232 */
233 active_cycles = (active_time * bus_speed + 999) / 1000;
234 recovery_cycles = (recovery_time * bus_speed + 999) / 1000;
235 /*
236 * Upper and lower limits
237 */
238 if (active_cycles < 2) active_cycles = 2;
239 if (recovery_cycles < 2) recovery_cycles = 2;
240 if (active_cycles > 15) active_cycles = 15;
241 if (recovery_cycles > 15) recovery_cycles = 0; /* 0==16 */
242
243#ifdef DEBUG
244 printk("ht6560b: drive %s setting pio=%d recovery=%d (%dns) active=%d (%dns)\n", drive->name, pio, recovery_cycles, recovery_time, active_cycles, active_time);
245#endif
246
247 return (u8)((recovery_cycles << 4) | active_cycles);
248 } else {
249
250#ifdef DEBUG
251 printk("ht6560b: drive %s setting pio=0\n", drive->name);
252#endif
253
254 return HT_TIMING_DEFAULT; /* default setting */
255 }
256}
257
69e88d2a
BZ
258static DEFINE_SPINLOCK(ht6560b_lock);
259
1da177e4
LT
260/*
261 * Enable/Disable so called prefetch mode
262 */
263static void ht_set_prefetch(ide_drive_t *drive, u8 state)
264{
265 unsigned long flags;
266 int t = HT_PREFETCH_MODE << 8;
69e88d2a
BZ
267
268 spin_lock_irqsave(&ht6560b_lock, flags);
269
1da177e4
LT
270 /*
271 * Prefetch mode and unmask irq seems to conflict
272 */
273 if (state) {
274 drive->drive_data |= t; /* enable prefetch mode */
275 drive->no_unmask = 1;
276 drive->unmask = 0;
277 } else {
278 drive->drive_data &= ~t; /* disable prefetch mode */
279 drive->no_unmask = 0;
280 }
69e88d2a
BZ
281
282 spin_unlock_irqrestore(&ht6560b_lock, flags);
283
1da177e4
LT
284#ifdef DEBUG
285 printk("ht6560b: drive %s prefetch mode %sabled\n", drive->name, (state ? "en" : "dis"));
286#endif
287}
288
26bcb879 289static void ht6560b_set_pio_mode(ide_drive_t *drive, const u8 pio)
1da177e4
LT
290{
291 unsigned long flags;
292 u8 timing;
293
294 switch (pio) {
295 case 8: /* set prefetch off */
296 case 9: /* set prefetch on */
297 ht_set_prefetch(drive, pio & 1);
298 return;
299 }
69e88d2a 300
1da177e4 301 timing = ht_pio2timings(drive, pio);
69e88d2a
BZ
302
303 spin_lock_irqsave(&ht6560b_lock, flags);
1da177e4
LT
304 drive->drive_data &= 0xff00;
305 drive->drive_data |= timing;
69e88d2a
BZ
306 spin_unlock_irqrestore(&ht6560b_lock, flags);
307
1da177e4
LT
308#ifdef DEBUG
309 printk("ht6560b: drive %s tuned to pio mode %#x timing=%#x\n", drive->name, pio, timing);
310#endif
311}
312
1f2cf8b0
BZ
313static void __init ht6560b_port_init_devs(ide_hwif_t *hwif)
314{
315 /* Setting default configurations for drives. */
316 int t = (HT_CONFIG_DEFAULT << 8) | HT_TIMING_DEFAULT;
317
318 if (hwif->channel)
319 t |= (HT_SECONDARY_IF << 8);
320
321 hwif->drives[0].drive_data = t;
322 hwif->drives[1].drive_data = t;
323}
324
84913882
BZ
325int probe_ht6560b = 0;
326
327module_param_named(probe, probe_ht6560b, bool, 0);
328MODULE_PARM_DESC(probe, "probe for HT6560B chipset");
329
c413b9b9
BZ
330static const struct ide_port_info ht6560b_port_info __initdata = {
331 .chipset = ide_ht6560b,
332 .host_flags = IDE_HFLAG_SERIALIZE | /* is this needed? */
333 IDE_HFLAG_NO_DMA |
334 IDE_HFLAG_NO_AUTOTUNE |
335 IDE_HFLAG_ABUSE_PREFETCH,
1a1990f5 336 .pio_mask = ATA_PIO4,
c413b9b9
BZ
337};
338
ade2daf9 339static int __init ht6560b_init(void)
1da177e4
LT
340{
341 ide_hwif_t *hwif, *mate;
8447d9d5 342 static u8 idx[4] = { 0, 1, 0xff, 0xff };
dfd87842 343 hw_regs_t hw[2];
1da177e4 344
84913882
BZ
345 if (probe_ht6560b == 0)
346 return -ENODEV;
347
1da177e4
LT
348 hwif = &ide_hwifs[0];
349 mate = &ide_hwifs[1];
350
351 if (!request_region(HT_CONFIG_PORT, 1, hwif->name)) {
352 printk(KERN_NOTICE "%s: HT_CONFIG_PORT not found\n",
353 __FUNCTION__);
354 return -ENODEV;
355 }
356
357 if (!try_to_init_ht6560b()) {
358 printk(KERN_NOTICE "%s: HBA not found\n", __FUNCTION__);
359 goto release_region;
360 }
361
dfd87842
BZ
362 memset(&hw, 0, sizeof(hw));
363
364 ide_std_init_ports(&hw[0], 0x1f0, 0x3f6);
365 hw[0].irq = 14;
366
367 ide_std_init_ports(&hw[1], 0x170, 0x376);
368 hw[1].irq = 15;
369
370 ide_init_port_hw(hwif, &hw[0]);
371 ide_init_port_hw(mate, &hw[1]);
372
1da177e4 373 hwif->selectproc = &ht6560b_selectproc;
26bcb879 374 hwif->set_pio_mode = &ht6560b_set_pio_mode;
1da177e4 375
1da177e4 376 mate->selectproc = &ht6560b_selectproc;
26bcb879 377 mate->set_pio_mode = &ht6560b_set_pio_mode;
1da177e4 378
1f2cf8b0
BZ
379 hwif->port_init_devs = ht6560b_port_init_devs;
380 mate->port_init_devs = ht6560b_port_init_devs;
1da177e4 381
c413b9b9 382 ide_device_add(idx, &ht6560b_port_info);
1da177e4
LT
383
384 return 0;
385
386release_region:
387 release_region(HT_CONFIG_PORT, 1);
388 return -ENODEV;
389}
390
1da177e4 391module_init(ht6560b_init);
1da177e4
LT
392
393MODULE_AUTHOR("See Local File");
394MODULE_DESCRIPTION("HT-6560B EIDE-controller support");
395MODULE_LICENSE("GPL");