Pull bugzilla-7570 into release branch
[linux-2.6] / drivers / ide / pci / cs5530.c
1 /*
2  * linux/drivers/ide/pci/cs5530.c               Version 0.7     Sept 10, 2002
3  *
4  * Copyright (C) 2000                   Andre Hedrick <andre@linux-ide.org>
5  * Ditto of GNU General Public License.
6  *
7  * Copyright (C) 2000                   Mark Lord <mlord@pobox.com>
8  * May be copied or modified under the terms of the GNU General Public License
9  *
10  * Development of this chipset driver was funded
11  * by the nice folks at National Semiconductor.
12  *
13  * Documentation:
14  *      CS5530 documentation available from National Semiconductor.
15  */
16
17 #include <linux/module.h>
18 #include <linux/types.h>
19 #include <linux/kernel.h>
20 #include <linux/delay.h>
21 #include <linux/timer.h>
22 #include <linux/mm.h>
23 #include <linux/ioport.h>
24 #include <linux/blkdev.h>
25 #include <linux/hdreg.h>
26 #include <linux/interrupt.h>
27 #include <linux/pci.h>
28 #include <linux/init.h>
29 #include <linux/ide.h>
30 #include <asm/io.h>
31 #include <asm/irq.h>
32
33 /**
34  *      cs5530_xfer_set_mode    -       set a new transfer mode at the drive
35  *      @drive: drive to tune
36  *      @mode: new mode
37  *
38  *      Logging wrapper to the IDE driver speed configuration. This can
39  *      probably go away now.
40  */
41  
42 static int cs5530_set_xfer_mode (ide_drive_t *drive, u8 mode)
43 {
44         printk(KERN_DEBUG "%s: cs5530_set_xfer_mode(%s)\n",
45                 drive->name, ide_xfer_verbose(mode));
46         return (ide_config_drive_speed(drive, mode));
47 }
48
49 /*
50  * Here are the standard PIO mode 0-4 timings for each "format".
51  * Format-0 uses fast data reg timings, with slower command reg timings.
52  * Format-1 uses fast timings for all registers, but won't work with all drives.
53  */
54 static unsigned int cs5530_pio_timings[2][5] = {
55         {0x00009172, 0x00012171, 0x00020080, 0x00032010, 0x00040010},
56         {0xd1329172, 0x71212171, 0x30200080, 0x20102010, 0x00100010}
57 };
58
59 /*
60  * After chip reset, the PIO timings are set to 0x0000e132, which is not valid.
61  */
62 #define CS5530_BAD_PIO(timings) (((timings)&~0x80000000)==0x0000e132)
63 #define CS5530_BASEREG(hwif)    (((hwif)->dma_base & ~0xf) + ((hwif)->channel ? 0x30 : 0x20))
64
65 /**
66  *      cs5530_tuneproc         -       select/set PIO modes
67  *
68  *      cs5530_tuneproc() handles selection/setting of PIO modes
69  *      for both the chipset and drive.
70  *
71  *      The ide_init_cs5530() routine guarantees that all drives
72  *      will have valid default PIO timings set up before we get here.
73  */
74
75 static void cs5530_tuneproc (ide_drive_t *drive, u8 pio)        /* pio=255 means "autotune" */
76 {
77         ide_hwif_t      *hwif = HWIF(drive);
78         unsigned int    format;
79         unsigned long basereg = CS5530_BASEREG(hwif);
80         static u8       modes[5] = { XFER_PIO_0, XFER_PIO_1, XFER_PIO_2, XFER_PIO_3, XFER_PIO_4};
81
82         pio = ide_get_best_pio_mode(drive, pio, 4, NULL);
83         if (!cs5530_set_xfer_mode(drive, modes[pio])) {
84                 format = (inl(basereg + 4) >> 31) & 1;
85                 outl(cs5530_pio_timings[format][pio],
86                         basereg+(drive->select.b.unit<<3));
87         }
88 }
89
90 /**
91  *      cs5530_config_dma       -       select/set DMA and UDMA modes
92  *      @drive: drive to tune
93  *
94  *      cs5530_config_dma() handles selection/setting of DMA/UDMA modes
95  *      for both the chipset and drive. The CS5530 has limitations about
96  *      mixing DMA/UDMA on the same cable.
97  */
98  
99 static int cs5530_config_dma (ide_drive_t *drive)
100 {
101         int                     udma_ok = 1, mode = 0;
102         ide_hwif_t              *hwif = HWIF(drive);
103         int                     unit = drive->select.b.unit;
104         ide_drive_t             *mate = &hwif->drives[unit^1];
105         struct hd_driveid       *id = drive->id;
106         unsigned int            reg, timings = 0;
107         unsigned long           basereg;
108
109         /*
110          * Default to DMA-off in case we run into trouble here.
111          */
112         hwif->dma_off_quietly(drive);
113
114         /*
115          * The CS5530 specifies that two drives sharing a cable cannot
116          * mix UDMA/MDMA.  It has to be one or the other, for the pair,
117          * though different timings can still be chosen for each drive.
118          * We could set the appropriate timing bits on the fly,
119          * but that might be a bit confusing.  So, for now we statically
120          * handle this requirement by looking at our mate drive to see
121          * what it is capable of, before choosing a mode for our own drive.
122          *
123          * Note: This relies on the fact we never fail from UDMA to MWDMA_2
124          * but instead drop to PIO
125          */
126         if (mate->present) {
127                 struct hd_driveid *mateid = mate->id;
128                 if (mateid && (mateid->capability & 1) &&
129                     !__ide_dma_bad_drive(mate)) {
130                         if ((mateid->field_valid & 4) &&
131                             (mateid->dma_ultra & 7))
132                                 udma_ok = 1;
133                         else if ((mateid->field_valid & 2) &&
134                                  (mateid->dma_mword & 7))
135                                 udma_ok = 0;
136                         else
137                                 udma_ok = 1;
138                 }
139         }
140
141         /*
142          * Now see what the current drive is capable of,
143          * selecting UDMA only if the mate said it was ok.
144          */
145         if (id && (id->capability & 1) && drive->autodma &&
146             !__ide_dma_bad_drive(drive)) {
147                 if (udma_ok && (id->field_valid & 4) && (id->dma_ultra & 7)) {
148                         if      (id->dma_ultra & 4)
149                                 mode = XFER_UDMA_2;
150                         else if (id->dma_ultra & 2)
151                                 mode = XFER_UDMA_1;
152                         else if (id->dma_ultra & 1)
153                                 mode = XFER_UDMA_0;
154                 }
155                 if (!mode && (id->field_valid & 2) && (id->dma_mword & 7)) {
156                         if      (id->dma_mword & 4)
157                                 mode = XFER_MW_DMA_2;
158                         else if (id->dma_mword & 2)
159                                 mode = XFER_MW_DMA_1;
160                         else if (id->dma_mword & 1)
161                                 mode = XFER_MW_DMA_0;
162                 }
163         }
164
165         /*
166          * Tell the drive to switch to the new mode; abort on failure.
167          */
168         if (!mode || cs5530_set_xfer_mode(drive, mode))
169                 return 1;       /* failure */
170
171         /*
172          * Now tune the chipset to match the drive:
173          */
174         switch (mode) {
175                 case XFER_UDMA_0:       timings = 0x00921250; break;
176                 case XFER_UDMA_1:       timings = 0x00911140; break;
177                 case XFER_UDMA_2:       timings = 0x00911030; break;
178                 case XFER_MW_DMA_0:     timings = 0x00077771; break;
179                 case XFER_MW_DMA_1:     timings = 0x00012121; break;
180                 case XFER_MW_DMA_2:     timings = 0x00002020; break;
181                 default:
182                         BUG();
183                         break;
184         }
185         basereg = CS5530_BASEREG(hwif);
186         reg = inl(basereg + 4);                 /* get drive0 config register */
187         timings |= reg & 0x80000000;            /* preserve PIO format bit */
188         if (unit == 0) {                        /* are we configuring drive0? */
189                 outl(timings, basereg + 4);     /* write drive0 config register */
190         } else {
191                 if (timings & 0x00100000)
192                         reg |=  0x00100000;     /* enable UDMA timings for both drives */
193                 else
194                         reg &= ~0x00100000;     /* disable UDMA timings for both drives */
195                 outl(reg, basereg + 4);         /* write drive0 config register */
196                 outl(timings, basereg + 12);    /* write drive1 config register */
197         }
198
199         return 0;       /* success */
200 }
201
202 /**
203  *      init_chipset_5530       -       set up 5530 bridge
204  *      @dev: PCI device
205  *      @name: device name
206  *
207  *      Initialize the cs5530 bridge for reliable IDE DMA operation.
208  */
209
210 static unsigned int __devinit init_chipset_cs5530 (struct pci_dev *dev, const char *name)
211 {
212         struct pci_dev *master_0 = NULL, *cs5530_0 = NULL;
213         unsigned long flags;
214
215         dev = NULL;
216         while ((dev = pci_get_device(PCI_VENDOR_ID_CYRIX, PCI_ANY_ID, dev)) != NULL) {
217                 switch (dev->device) {
218                         case PCI_DEVICE_ID_CYRIX_PCI_MASTER:
219                                 master_0 = pci_dev_get(dev);
220                                 break;
221                         case PCI_DEVICE_ID_CYRIX_5530_LEGACY:
222                                 cs5530_0 = pci_dev_get(dev);
223                                 break;
224                 }
225         }
226         if (!master_0) {
227                 printk(KERN_ERR "%s: unable to locate PCI MASTER function\n", name);
228                 goto out;
229         }
230         if (!cs5530_0) {
231                 printk(KERN_ERR "%s: unable to locate CS5530 LEGACY function\n", name);
232                 goto out;
233         }
234
235         spin_lock_irqsave(&ide_lock, flags);
236                 /* all CPUs (there should only be one CPU with this chipset) */
237
238         /*
239          * Enable BusMaster and MemoryWriteAndInvalidate for the cs5530:
240          * -->  OR 0x14 into 16-bit PCI COMMAND reg of function 0 of the cs5530
241          */
242
243         pci_set_master(cs5530_0);
244         pci_set_mwi(cs5530_0);
245
246         /*
247          * Set PCI CacheLineSize to 16-bytes:
248          * --> Write 0x04 into 8-bit PCI CACHELINESIZE reg of function 0 of the cs5530
249          */
250
251         pci_write_config_byte(cs5530_0, PCI_CACHE_LINE_SIZE, 0x04);
252
253         /*
254          * Disable trapping of UDMA register accesses (Win98 hack):
255          * --> Write 0x5006 into 16-bit reg at offset 0xd0 of function 0 of the cs5530
256          */
257
258         pci_write_config_word(cs5530_0, 0xd0, 0x5006);
259
260         /*
261          * Bit-1 at 0x40 enables MemoryWriteAndInvalidate on internal X-bus:
262          * The other settings are what is necessary to get the register
263          * into a sane state for IDE DMA operation.
264          */
265
266         pci_write_config_byte(master_0, 0x40, 0x1e);
267
268         /* 
269          * Set max PCI burst size (16-bytes seems to work best):
270          *         16bytes: set bit-1 at 0x41 (reg value of 0x16)
271          *      all others: clear bit-1 at 0x41, and do:
272          *        128bytes: OR 0x00 at 0x41
273          *        256bytes: OR 0x04 at 0x41
274          *        512bytes: OR 0x08 at 0x41
275          *       1024bytes: OR 0x0c at 0x41
276          */
277
278         pci_write_config_byte(master_0, 0x41, 0x14);
279
280         /*
281          * These settings are necessary to get the chip
282          * into a sane state for IDE DMA operation.
283          */
284
285         pci_write_config_byte(master_0, 0x42, 0x00);
286         pci_write_config_byte(master_0, 0x43, 0xc1);
287
288         spin_unlock_irqrestore(&ide_lock, flags);
289
290 out:
291         pci_dev_put(master_0);
292         pci_dev_put(cs5530_0);
293         return 0;
294 }
295
296 /**
297  *      init_hwif_cs5530        -       initialise an IDE channel
298  *      @hwif: IDE to initialize
299  *
300  *      This gets invoked by the IDE driver once for each channel. It
301  *      performs channel-specific pre-initialization before drive probing.
302  */
303
304 static void __devinit init_hwif_cs5530 (ide_hwif_t *hwif)
305 {
306         unsigned long basereg;
307         u32 d0_timings;
308         hwif->autodma = 0;
309
310         if (hwif->mate)
311                 hwif->serialized = hwif->mate->serialized = 1;
312
313         hwif->tuneproc = &cs5530_tuneproc;
314         basereg = CS5530_BASEREG(hwif);
315         d0_timings = inl(basereg + 0);
316         if (CS5530_BAD_PIO(d0_timings)) {
317                 /* PIO timings not initialized? */
318                 outl(cs5530_pio_timings[(d0_timings >> 31) & 1][0], basereg + 0);
319                 if (!hwif->drives[0].autotune)
320                         hwif->drives[0].autotune = 1;
321                         /* needs autotuning later */
322         }
323         if (CS5530_BAD_PIO(inl(basereg + 8))) {
324                 /* PIO timings not initialized? */
325                 outl(cs5530_pio_timings[(d0_timings >> 31) & 1][0], basereg + 8);
326                 if (!hwif->drives[1].autotune)
327                         hwif->drives[1].autotune = 1;
328                         /* needs autotuning later */
329         }
330
331         hwif->atapi_dma = 1;
332         hwif->ultra_mask = 0x07;
333         hwif->mwdma_mask = 0x07;
334
335         hwif->ide_dma_check = &cs5530_config_dma;
336         if (!noautodma)
337                 hwif->autodma = 1;
338         hwif->drives[0].autodma = hwif->autodma;
339         hwif->drives[1].autodma = hwif->autodma;
340 }
341
342 static ide_pci_device_t cs5530_chipset __devinitdata = {
343         .name           = "CS5530",
344         .init_chipset   = init_chipset_cs5530,
345         .init_hwif      = init_hwif_cs5530,
346         .channels       = 2,
347         .autodma        = AUTODMA,
348         .bootable       = ON_BOARD,
349 };
350
351 static int __devinit cs5530_init_one(struct pci_dev *dev, const struct pci_device_id *id)
352 {
353         return ide_setup_pci_device(dev, &cs5530_chipset);
354 }
355
356 static struct pci_device_id cs5530_pci_tbl[] = {
357         { PCI_VENDOR_ID_CYRIX, PCI_DEVICE_ID_CYRIX_5530_IDE, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
358         { 0, },
359 };
360 MODULE_DEVICE_TABLE(pci, cs5530_pci_tbl);
361
362 static struct pci_driver driver = {
363         .name           = "CS5530 IDE",
364         .id_table       = cs5530_pci_tbl,
365         .probe          = cs5530_init_one,
366 };
367
368 static int __init cs5530_ide_init(void)
369 {
370         return ide_pci_register_driver(&driver);
371 }
372
373 module_init(cs5530_ide_init);
374
375 MODULE_AUTHOR("Mark Lord");
376 MODULE_DESCRIPTION("PCI driver module for Cyrix/NS 5530 IDE");
377 MODULE_LICENSE("GPL");