ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / ide / pci / sc1200.c
1 /*
2  * linux/drivers/ide/pci/sc1200.c               Version 0.91    28-Jan-2003
3  *
4  * Copyright (C) 2000-2002              Mark Lord <mlord@pobox.com>
5  * May be copied or modified under the terms of the GNU General Public License
6  *
7  * Development of this chipset driver was funded
8  * by the nice folks at National Semiconductor.
9  *
10  * Documentation:
11  *      Available from National Semiconductor
12  */
13
14 #include <linux/config.h>
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <linux/kernel.h>
18 #include <linux/delay.h>
19 #include <linux/timer.h>
20 #include <linux/mm.h>
21 #include <linux/ioport.h>
22 #include <linux/blkdev.h>
23 #include <linux/hdreg.h>
24 #include <linux/interrupt.h>
25 #include <linux/pci.h>
26 #include <linux/init.h>
27 #include <linux/ide.h>
28 #include <linux/pm.h>
29 #include <asm/io.h>
30 #include <asm/irq.h>
31
32 #include "sc1200.h"
33
34 #define SC1200_REV_A    0x00
35 #define SC1200_REV_B1   0x01
36 #define SC1200_REV_B3   0x02
37 #define SC1200_REV_C1   0x03
38 #define SC1200_REV_D1   0x04
39
40 #define PCI_CLK_33      0x00
41 #define PCI_CLK_48      0x01
42 #define PCI_CLK_66      0x02
43 #define PCI_CLK_33A     0x03
44
45 static unsigned short sc1200_get_pci_clock (void)
46 {
47         unsigned char chip_id, silicon_revision;
48         unsigned int pci_clock;
49         /*
50          * Check the silicon revision, as not all versions of the chip
51          * have the register with the fast PCI bus timings.
52          */
53         chip_id = inb (0x903c);
54         silicon_revision = inb (0x903d);
55
56         // Read the fast pci clock frequency
57         if (chip_id == 0x04 && silicon_revision < SC1200_REV_B1) {
58                 pci_clock = PCI_CLK_33;
59         } else {
60                 // check clock generator configuration (cfcc)
61                 // the clock is in bits 8 and 9 of this word
62
63                 pci_clock = inw (0x901e);
64                 pci_clock >>= 8;
65                 pci_clock &= 0x03;
66                 if (pci_clock == PCI_CLK_33A)
67                         pci_clock = PCI_CLK_33;
68         }
69         return pci_clock;
70 }
71
72 #define DISPLAY_SC1200_TIMINGS
73
74 #if defined(DISPLAY_SC1200_TIMINGS) && defined(CONFIG_PROC_FS)
75 #include <linux/stat.h>
76 #include <linux/proc_fs.h>
77
78 static int sc1200_get_info(char *, char **, off_t, int);
79 extern int (*sc1200_display_info)(char *, char **, off_t, int); /* ide-proc.c */
80 extern char *ide_media_verbose(ide_drive_t *);
81 static u8 sc1200_proc = 0;
82
83 static struct pci_dev *bmide_dev;
84
85 static int sc1200_get_info (char *buffer, char **addr, off_t offset, int count)
86 {
87         char *p = buffer;
88         unsigned long bibma = pci_resource_start(bmide_dev, 4);
89         int len;
90         u8  c0 = 0, c1 = 0;
91
92         /*
93          * at that point bibma+0x2 et bibma+0xa are byte registers
94          * to investigate:
95          */
96
97         c0 = inb_p(bibma + 0x02);
98         c1 = inb_p(bibma + 0x0a);
99
100         p += sprintf(p, "\n                               National SCx200 Chipset.\n");
101         p += sprintf(p, "--------------- Primary Channel ---------------- Secondary Channel -------------\n");
102         p += sprintf(p, "                %sabled                         %sabled\n",
103                         (c0&0x80) ? "dis" : " en",
104                         (c1&0x80) ? "dis" : " en");
105         p += sprintf(p, "--------------- drive0 --------- drive1 -------- drive0 ---------- drive1 ------\n");
106         p += sprintf(p, "DMA enabled:    %s              %s             %s               %s\n",
107                         (c0&0x20) ? "yes" : "no ", (c0&0x40) ? "yes" : "no ",
108                         (c1&0x20) ? "yes" : "no ", (c1&0x40) ? "yes" : "no " );
109
110         p += sprintf(p, "UDMA\n");
111         p += sprintf(p, "DMA\n");
112         p += sprintf(p, "PIO\n");
113
114         len = (p - buffer) - offset;
115         *addr = buffer + offset;
116         
117         return len > count ? count : len;
118 }
119 #endif /* DISPLAY_SC1200_TIMINGS && CONFIG_PROC_FS */
120
121 extern char *ide_xfer_verbose (byte xfer_rate);
122
123 /*
124  * Set a new transfer mode at the drive
125  */
126 int sc1200_set_xfer_mode (ide_drive_t *drive, byte mode)
127 {
128         printk("%s: sc1200_set_xfer_mode(%s)\n", drive->name, ide_xfer_verbose(mode));
129         return ide_config_drive_speed(drive, mode);
130 }
131
132 /*
133  * Here are the standard PIO mode 0-4 timings for each "format".
134  * Format-0 uses fast data reg timings, with slower command reg timings.
135  * Format-1 uses fast timings for all registers, but won't work with all drives.
136  */
137 static const unsigned int sc1200_pio_timings[4][5] =
138         {{0x00009172, 0x00012171, 0x00020080, 0x00032010, 0x00040010},  // format0  33Mhz
139          {0xd1329172, 0x71212171, 0x30200080, 0x20102010, 0x00100010},  // format1, 33Mhz
140          {0xfaa3f4f3, 0xc23232b2, 0x513101c1, 0x31213121, 0x10211021},  // format1, 48Mhz
141          {0xfff4fff4, 0xf35353d3, 0x814102f1, 0x42314231, 0x11311131}}; // format1, 66Mhz
142
143 /*
144  * After chip reset, the PIO timings are set to 0x00009172, which is not valid.
145  */
146 //#define SC1200_BAD_PIO(timings) (((timings)&~0x80000000)==0x00009172)
147
148 static int sc1200_autoselect_dma_mode (ide_drive_t *drive)
149 {
150         int                     udma_ok = 1, mode = 0;
151         ide_hwif_t              *hwif = HWIF(drive);
152         int                     unit = drive->select.b.unit;
153         ide_drive_t             *mate = &hwif->drives[unit^1];
154         struct hd_driveid       *id = drive->id;
155
156         /*
157          * The SC1200 specifies that two drives sharing a cable cannot
158          * mix UDMA/MDMA.  It has to be one or the other, for the pair,
159          * though different timings can still be chosen for each drive.
160          * We could set the appropriate timing bits on the fly,
161          * but that might be a bit confusing.  So, for now we statically
162          * handle this requirement by looking at our mate drive to see
163          * what it is capable of, before choosing a mode for our own drive.
164          */
165         if (mate->present) {
166                 struct hd_driveid *mateid = mate->id;
167                 if (mateid && (mateid->capability & 1) && !__ide_dma_bad_drive(mate)) {
168                         if ((mateid->field_valid & 4) && (mateid->dma_ultra & 7))
169                                 udma_ok = 1;
170                         else if ((mateid->field_valid & 2) && (mateid->dma_mword & 7))
171                                 udma_ok = 0;
172                         else
173                                 udma_ok = 1;
174                 }
175         }
176         /*
177          * Now see what the current drive is capable of,
178          * selecting UDMA only if the mate said it was ok.
179          */
180         if (id && (id->capability & 1) && hwif->autodma && !__ide_dma_bad_drive(drive)) {
181                 if (udma_ok && (id->field_valid & 4) && (id->dma_ultra & 7)) {
182                         if      (id->dma_ultra & 4)
183                                 mode = XFER_UDMA_2;
184                         else if (id->dma_ultra & 2)
185                                 mode = XFER_UDMA_1;
186                         else if (id->dma_ultra & 1)
187                                 mode = XFER_UDMA_0;
188                 }
189                 if (!mode && (id->field_valid & 2) && (id->dma_mword & 7)) {
190                         if      (id->dma_mword & 4)
191                                 mode = XFER_MW_DMA_2;
192                         else if (id->dma_mword & 2)
193                                 mode = XFER_MW_DMA_1;
194                         else if (id->dma_mword & 1)
195                                 mode = XFER_MW_DMA_0;
196                 }
197         }
198         return mode;
199 }
200
201 /*
202  * sc1200_config_dma2() handles selection/setting of DMA/UDMA modes
203  * for both the chipset and drive.
204  */
205 static int sc1200_config_dma2 (ide_drive_t *drive, int mode)
206 {
207         ide_hwif_t              *hwif = HWIF(drive);
208         int                     unit = drive->select.b.unit;
209         unsigned int            reg, timings;
210         unsigned short          pci_clock;
211         unsigned int            basereg = hwif->channel ? 0x50 : 0x40;
212
213         /*
214          * Default to DMA-off in case we run into trouble here.
215          */
216         hwif->ide_dma_off_quietly(drive);                       /* turn off DMA while we fiddle */
217         outb(inb(hwif->dma_base+2)&~(unit?0x40:0x20), hwif->dma_base+2); /* clear DMA_capable bit */
218
219         /*
220          * Tell the drive to switch to the new mode; abort on failure.
221          */
222         if (!mode || sc1200_set_xfer_mode(drive, mode)) {
223                 printk("SC1200: set xfer mode failure\n");
224                 return 1;       /* failure */
225         }
226
227         pci_clock = sc1200_get_pci_clock();
228
229         /*
230          * Now tune the chipset to match the drive:
231          *
232          * Note that each DMA mode has several timings associated with it.
233          * The correct timing depends on the fast PCI clock freq.
234          */
235         timings = 0;
236         switch (mode) {
237                 case XFER_UDMA_0:
238                         switch (pci_clock) {
239                                 case PCI_CLK_33:        timings = 0x00921250;   break;
240                                 case PCI_CLK_48:        timings = 0x00932470;   break;
241                                 case PCI_CLK_66:        timings = 0x009436a1;   break;
242                         }
243                         break;
244                 case XFER_UDMA_1:
245                         switch (pci_clock) {
246                                 case PCI_CLK_33:        timings = 0x00911140;   break;
247                                 case PCI_CLK_48:        timings = 0x00922260;   break;
248                                 case PCI_CLK_66:        timings = 0x00933481;   break;
249                         }
250                         break;
251                 case XFER_UDMA_2:
252                         switch (pci_clock) {
253                                 case PCI_CLK_33:        timings = 0x00911030;   break;
254                                 case PCI_CLK_48:        timings = 0x00922140;   break;
255                                 case PCI_CLK_66:        timings = 0x00923261;   break;
256                         }
257                         break;
258                 case XFER_MW_DMA_0:
259                         switch (pci_clock) {
260                                 case PCI_CLK_33:        timings = 0x00077771;   break;
261                                 case PCI_CLK_48:        timings = 0x000bbbb2;   break;
262                                 case PCI_CLK_66:        timings = 0x000ffff3;   break;
263                         }
264                         break;
265                 case XFER_MW_DMA_1:
266                         switch (pci_clock) {
267                                 case PCI_CLK_33:        timings = 0x00012121;   break;
268                                 case PCI_CLK_48:        timings = 0x00024241;   break;
269                                 case PCI_CLK_66:        timings = 0x00035352;   break;
270                         }
271                         break;
272                 case XFER_MW_DMA_2:
273                         switch (pci_clock) {
274                                 case PCI_CLK_33:        timings = 0x00002020;   break;
275                                 case PCI_CLK_48:        timings = 0x00013131;   break;
276                                 case PCI_CLK_66:        timings = 0x00015151;   break;
277                         }
278                         break;
279         }
280
281         if (timings == 0) {
282                 printk("%s: sc1200_config_dma: huh? mode=%02x clk=%x \n", drive->name, mode, pci_clock);
283                 return 1;       /* failure */
284         }
285
286         if (unit == 0) {                        /* are we configuring drive0? */
287                 pci_read_config_dword(hwif->pci_dev, basereg+4, &reg);
288                 timings |= reg & 0x80000000;    /* preserve PIO format bit */
289                 pci_write_config_dword(hwif->pci_dev, basereg+4, timings);
290         } else {
291                 pci_write_config_dword(hwif->pci_dev, basereg+12, timings);
292         }
293
294         outb(inb(hwif->dma_base+2)|(unit?0x40:0x20), hwif->dma_base+2); /* set DMA_capable bit */
295
296         /*
297          * Finally, turn DMA on in software, and exit.
298          */
299         return hwif->ide_dma_on(drive); /* success */
300 }
301
302 /*
303  * sc1200_config_dma() handles selection/setting of DMA/UDMA modes
304  * for both the chipset and drive.
305  */
306 static int sc1200_config_dma (ide_drive_t *drive)
307 {
308         return sc1200_config_dma2(drive, sc1200_autoselect_dma_mode(drive));
309 }
310
311
312 /*  Replacement for the standard ide_dma_end action in
313  *  dma_proc.
314  *
315  *  returns 1 on error, 0 otherwise
316  */
317 int sc1200_ide_dma_end (ide_drive_t *drive)
318 {
319         ide_hwif_t *hwif = HWIF(drive);
320         unsigned long dma_base = hwif->dma_base;
321         byte dma_stat;
322
323         dma_stat = inb(dma_base+2);             /* get DMA status */
324
325         if (!(dma_stat & 4))
326                 printk(" ide_dma_end dma_stat=%0x err=%x newerr=%x\n",
327                   dma_stat, ((dma_stat&7)!=4), ((dma_stat&2)==2));
328
329         outb(dma_stat|0x1b, dma_base+2);        /* clear the INTR & ERROR bits */
330         outb(inb(dma_base)&~1, dma_base);       /* !! DO THIS HERE !! stop DMA */
331
332         drive->waiting_for_dma = 0;
333         ide_destroy_dmatable(drive);            /* purge DMA mappings */
334
335         return (dma_stat & 7) != 4;             /* verify good DMA status */
336 }
337
338 /*
339  * sc1200_tuneproc() handles selection/setting of PIO modes
340  * for both the chipset and drive.
341  *
342  * All existing BIOSs for this chipset guarantee that all drives
343  * will have valid default PIO timings set up before we get here.
344  */
345 static void sc1200_tuneproc (ide_drive_t *drive, byte pio)      /* mode=255 means "autotune" */
346 {
347         ide_hwif_t      *hwif = HWIF(drive);
348         unsigned int    format;
349         static byte     modes[5] = {XFER_PIO_0, XFER_PIO_1, XFER_PIO_2, XFER_PIO_3, XFER_PIO_4};
350         int             mode = -1;
351
352         switch (pio) {
353                 case 200: mode = XFER_UDMA_0;   break;
354                 case 201: mode = XFER_UDMA_1;   break;
355                 case 202: mode = XFER_UDMA_2;   break;
356                 case 100: mode = XFER_MW_DMA_0; break;
357                 case 101: mode = XFER_MW_DMA_1; break;
358                 case 102: mode = XFER_MW_DMA_2; break;
359         }
360         if (mode != -1) {
361                 printk("SC1200: %s: changing (U)DMA mode\n", drive->name);
362                 (void)sc1200_config_dma2(drive, mode);
363                 return;
364         }
365
366         pio = ide_get_best_pio_mode(drive, pio, 4, NULL);
367         printk("SC1200: %s: setting PIO mode%d\n", drive->name, pio);
368         if (!sc1200_set_xfer_mode(drive, modes[pio])) {
369                 unsigned int basereg = hwif->channel ? 0x50 : 0x40;
370                 pci_read_config_dword (hwif->pci_dev, basereg+4, &format);
371                 format = (format >> 31) & 1;
372                 if (format)
373                         format += sc1200_get_pci_clock();
374                 pci_write_config_dword(hwif->pci_dev, basereg + (drive->select.b.unit << 3), sc1200_pio_timings[format][pio]);
375         }
376 }
377
378 static ide_hwif_t *lookup_pci_dev (ide_hwif_t *prev, struct pci_dev *dev)
379 {
380         int     h;
381
382         for (h = 0; h < MAX_HWIFS; h++) {
383                 ide_hwif_t *hwif = &ide_hwifs[h];
384                 if (prev) {
385                         if (hwif == prev)
386                                 prev = NULL;    // found previous, now look for next match
387                 } else {
388                         if (hwif && hwif->pci_dev == dev)
389                                 return hwif;    // found next match
390                 }
391         }
392         return NULL;    // not found
393 }
394
395 typedef struct sc1200_saved_state_s {
396         __u32           regs[4];
397 } sc1200_saved_state_t;
398
399
400 static int sc1200_suspend (struct pci_dev *dev, u32 state)
401 {
402         ide_hwif_t              *hwif = NULL;
403
404         printk("SC1200: suspend(%u)\n", state);
405
406         if (state == 0) {
407                 // we only save state when going from full power to less
408
409                 //
410                 // Loop over all interfaces that are part of this PCI device:
411                 //
412                 while ((hwif = lookup_pci_dev(hwif, dev)) != NULL) {
413                         sc1200_saved_state_t    *ss;
414                         unsigned int            basereg, r;
415                         //
416                         // allocate a permanent save area, if not already allocated
417                         //
418                         ss = (sc1200_saved_state_t *)hwif->config_data;
419                         if (ss == NULL) {
420                                 ss = kmalloc(sizeof(sc1200_saved_state_t), GFP_KERNEL);
421                                 if (ss == NULL)
422                                         return -ENOMEM;
423                                 hwif->config_data = (unsigned long)ss;
424                         }
425                         ss = (sc1200_saved_state_t *)hwif->config_data;
426                         //
427                         // Save timing registers:  this may be unnecessary if 
428                         // BIOS also does it
429                         //
430                         basereg = hwif->channel ? 0x50 : 0x40;
431                         for (r = 0; r < 4; ++r) {
432                                 pci_read_config_dword (hwif->pci_dev, basereg + (r<<2), &ss->regs[r]);
433                         }
434                 }
435         }
436
437         /* You don't need to iterate over disks -- sysfs should have done that for you already */ 
438
439         pci_disable_device(dev);
440         pci_set_power_state(dev,state);
441         dev->current_state = state;
442         return 0;
443 }
444
445 static int sc1200_resume (struct pci_dev *dev)
446 {
447         ide_hwif_t      *hwif = NULL;
448
449 printk("SC1200: resume\n");
450         pci_set_power_state(dev,0);     // bring chip back from sleep state
451         dev->current_state = 0;
452         pci_enable_device(dev);
453         //
454         // loop over all interfaces that are part of this pci device:
455         //
456         while ((hwif = lookup_pci_dev(hwif, dev)) != NULL) {
457                 unsigned int            basereg, r, d, format;
458                 sc1200_saved_state_t    *ss = (sc1200_saved_state_t *)hwif->config_data;
459 printk("%s: SC1200: resume\n", hwif->name);
460
461                 //
462                 // Restore timing registers:  this may be unnecessary if BIOS also does it
463                 //
464                 basereg = hwif->channel ? 0x50 : 0x40;
465                 if (ss != NULL) {
466                         for (r = 0; r < 4; ++r) {
467                                 pci_write_config_dword(hwif->pci_dev, basereg + (r<<2), ss->regs[r]);
468                         }
469                 }
470                 //
471                 // Re-program drive PIO modes
472                 //
473                 pci_read_config_dword(hwif->pci_dev, basereg+4, &format);
474                 format = (format >> 31) & 1;
475                 if (format)
476                         format += sc1200_get_pci_clock();
477                 for (d = 0; d < 2; ++d) {
478                         ide_drive_t *drive = &(hwif->drives[d]);
479                         if (drive->present) {
480                                 unsigned int pio, timings;
481                                 pci_read_config_dword(hwif->pci_dev, basereg+(drive->select.b.unit << 3), &timings);
482                                 for (pio = 0; pio <= 4; ++pio) {
483                                         if (sc1200_pio_timings[format][pio] == timings)
484                                                 break;
485                                 }
486                                 if (pio > 4)
487                                         pio = 255; /* autotune */
488                                 (void)sc1200_tuneproc(drive, pio);
489                         }
490                 }
491                 //
492                 // Re-program drive DMA modes
493                 //
494                 for (d = 0; d < MAX_DRIVES; ++d) {
495                         ide_drive_t *drive = &(hwif->drives[d]);
496                         if (drive->present && !__ide_dma_bad_drive(drive)) {
497                                 int was_using_dma = drive->using_dma;
498                                 hwif->ide_dma_off_quietly(drive);
499                                 sc1200_config_dma(drive);
500                                 if (!was_using_dma && drive->using_dma) {
501                                         hwif->ide_dma_off_quietly(drive);
502                                 }
503                         }
504                 }
505         }
506         return 0;
507 }
508
509 /*
510  * Initialize the sc1200 bridge for reliable IDE DMA operation.
511  */
512 static unsigned int __init init_chipset_sc1200 (struct pci_dev *dev, const char *name)
513 {
514 #if defined(DISPLAY_SC1200_TIMINGS) && defined(CONFIG_PROC_FS)
515         if (!bmide_dev) {
516                 sc1200_proc = 1;
517                 bmide_dev = dev;
518                 ide_pci_create_host_proc("sc1200", sc1200_get_info);
519         }
520 #endif /* DISPLAY_SC1200_TIMINGS && CONFIG_PROC_FS */
521         return 0;
522 }
523
524 /*
525  * This gets invoked by the IDE driver once for each channel,
526  * and performs channel-specific pre-initialization before drive probing.
527  */
528 static void __init init_hwif_sc1200 (ide_hwif_t *hwif)
529 {
530         if (hwif->mate)
531                 hwif->serialized = hwif->mate->serialized = 1;
532         hwif->autodma = 0;
533         if (hwif->dma_base) {
534                 hwif->ide_dma_check = &sc1200_config_dma;
535                 hwif->ide_dma_end   = &sc1200_ide_dma_end;
536                 if (!noautodma)
537                         hwif->autodma = 1;
538                 hwif->tuneproc = &sc1200_tuneproc;
539         }
540         hwif->atapi_dma = 1;
541         hwif->ultra_mask = 0x07;
542         hwif->mwdma_mask = 0x07;
543
544         hwif->drives[0].autodma = hwif->autodma;
545         hwif->drives[1].autodma = hwif->autodma;
546 }
547
548 static int __devinit sc1200_init_one(struct pci_dev *dev, const struct pci_device_id *id)
549 {
550         ide_pci_device_t *d = &sc1200_chipsets[id->driver_data];
551         if (dev->device != d->device)
552                 BUG();
553         ide_setup_pci_device(dev, d);
554         return 0;
555 }
556
557 static struct pci_device_id sc1200_pci_tbl[] = {
558         { PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_SCx200_IDE, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
559         { 0, },
560 };
561 MODULE_DEVICE_TABLE(pci, sc1200_pci_tbl);
562
563 static struct pci_driver driver = {
564         .name           = "SC1200 IDE",
565         .id_table       = sc1200_pci_tbl,
566         .probe          = sc1200_init_one,
567         .suspend        = sc1200_suspend,
568         .resume         = sc1200_resume,
569 };
570
571 static int sc1200_ide_init(void)
572 {
573         return ide_pci_register_driver(&driver);
574 }
575
576 module_init(sc1200_ide_init);
577
578 MODULE_AUTHOR("Mark Lord");
579 MODULE_DESCRIPTION("PCI driver module for NS SC1200 IDE");
580 MODULE_LICENSE("GPL");