ide: make drive->id an union (take 2)
[linux-2.6] / drivers / ide / pci / serverworks.c
1 /*
2  * Copyright (C) 1998-2000 Michel Aubry
3  * Copyright (C) 1998-2000 Andrzej Krzysztofowicz
4  * Copyright (C) 1998-2000 Andre Hedrick <andre@linux-ide.org>
5  * Copyright (C)      2007 Bartlomiej Zolnierkiewicz
6  * Portions copyright (c) 2001 Sun Microsystems
7  *
8  *
9  * RCC/ServerWorks IDE driver for Linux
10  *
11  *   OSB4: `Open South Bridge' IDE Interface (fn 1)
12  *         supports UDMA mode 2 (33 MB/s)
13  *
14  *   CSB5: `Champion South Bridge' IDE Interface (fn 1)
15  *         all revisions support UDMA mode 4 (66 MB/s)
16  *         revision A2.0 and up support UDMA mode 5 (100 MB/s)
17  *
18  *         *** The CSB5 does not provide ANY register ***
19  *         *** to detect 80-conductor cable presence. ***
20  *
21  *   CSB6: `Champion South Bridge' IDE Interface (optional: third channel)
22  *
23  *   HT1000: AKA BCM5785 - Hypertransport Southbridge for Opteron systems. IDE
24  *   controller same as the CSB6. Single channel ATA100 only.
25  *
26  * Documentation:
27  *      Available under NDA only. Errata info very hard to get.
28  *
29  */
30
31 #include <linux/types.h>
32 #include <linux/module.h>
33 #include <linux/kernel.h>
34 #include <linux/pci.h>
35 #include <linux/hdreg.h>
36 #include <linux/ide.h>
37 #include <linux/init.h>
38
39 #include <asm/io.h>
40
41 #define DRV_NAME "serverworks"
42
43 #define SVWKS_CSB5_REVISION_NEW 0x92 /* min PCI_REVISION_ID for UDMA5 (A2.0) */
44 #define SVWKS_CSB6_REVISION     0xa0 /* min PCI_REVISION_ID for UDMA4 (A1.0) */
45
46 /* Seagate Barracuda ATA IV Family drives in UDMA mode 5
47  * can overrun their FIFOs when used with the CSB5 */
48 static const char *svwks_bad_ata100[] = {
49         "ST320011A",
50         "ST340016A",
51         "ST360021A",
52         "ST380021A",
53         NULL
54 };
55
56 static struct pci_dev *isa_dev;
57
58 static int check_in_drive_lists (ide_drive_t *drive, const char **list)
59 {
60         char *m = (char *)&drive->id[ATA_ID_PROD];
61
62         while (*list)
63                 if (!strcmp(*list++, m))
64                         return 1;
65         return 0;
66 }
67
68 static u8 svwks_udma_filter(ide_drive_t *drive)
69 {
70         struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
71         u8 mask = 0;
72
73         if (dev->device == PCI_DEVICE_ID_SERVERWORKS_HT1000IDE)
74                 return 0x1f;
75         if (dev->device == PCI_DEVICE_ID_SERVERWORKS_OSB4IDE) {
76                 u32 reg = 0;
77                 if (isa_dev)
78                         pci_read_config_dword(isa_dev, 0x64, &reg);
79                         
80                 /*
81                  *      Don't enable UDMA on disk devices for the moment
82                  */
83                 if(drive->media == ide_disk)
84                         return 0;
85                 /* Check the OSB4 DMA33 enable bit */
86                 return ((reg & 0x00004000) == 0x00004000) ? 0x07 : 0;
87         } else if (dev->revision < SVWKS_CSB5_REVISION_NEW) {
88                 return 0x07;
89         } else if (dev->revision >= SVWKS_CSB5_REVISION_NEW) {
90                 u8 btr = 0, mode;
91                 pci_read_config_byte(dev, 0x5A, &btr);
92                 mode = btr & 0x3;
93
94                 /* If someone decides to do UDMA133 on CSB5 the same
95                    issue will bite so be inclusive */
96                 if (mode > 2 && check_in_drive_lists(drive, svwks_bad_ata100))
97                         mode = 2;
98
99                 switch(mode) {
100                 case 3:  mask = 0x3f; break;
101                 case 2:  mask = 0x1f; break;
102                 case 1:  mask = 0x07; break;
103                 default: mask = 0x00; break;
104                 }
105         }
106         if (((dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE) ||
107              (dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)) &&
108             (!(PCI_FUNC(dev->devfn) & 1)))
109                 mask = 0x1f;
110
111         return mask;
112 }
113
114 static u8 svwks_csb_check (struct pci_dev *dev)
115 {
116         switch (dev->device) {
117                 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
118                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
119                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
120                 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
121                         return 1;
122                 default:
123                         break;
124         }
125         return 0;
126 }
127
128 static void svwks_set_pio_mode(ide_drive_t *drive, const u8 pio)
129 {
130         static const u8 pio_modes[] = { 0x5d, 0x47, 0x34, 0x22, 0x20 };
131         static const u8 drive_pci[] = { 0x41, 0x40, 0x43, 0x42 };
132
133         struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
134
135         pci_write_config_byte(dev, drive_pci[drive->dn], pio_modes[pio]);
136
137         if (svwks_csb_check(dev)) {
138                 u16 csb_pio = 0;
139
140                 pci_read_config_word(dev, 0x4a, &csb_pio);
141
142                 csb_pio &= ~(0x0f << (4 * drive->dn));
143                 csb_pio |= (pio << (4 * drive->dn));
144
145                 pci_write_config_word(dev, 0x4a, csb_pio);
146         }
147 }
148
149 static void svwks_set_dma_mode(ide_drive_t *drive, const u8 speed)
150 {
151         static const u8 udma_modes[]            = { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05 };
152         static const u8 dma_modes[]             = { 0x77, 0x21, 0x20 };
153         static const u8 drive_pci2[]            = { 0x45, 0x44, 0x47, 0x46 };
154
155         ide_hwif_t *hwif        = HWIF(drive);
156         struct pci_dev *dev     = to_pci_dev(hwif->dev);
157         u8 unit                 = (drive->select.b.unit & 0x01);
158
159         u8 ultra_enable  = 0, ultra_timing = 0, dma_timing = 0;
160
161         pci_read_config_byte(dev, (0x56|hwif->channel), &ultra_timing);
162         pci_read_config_byte(dev, 0x54, &ultra_enable);
163
164         ultra_timing    &= ~(0x0F << (4*unit));
165         ultra_enable    &= ~(0x01 << drive->dn);
166
167         if (speed >= XFER_UDMA_0) {
168                 dma_timing   |= dma_modes[2];
169                 ultra_timing |= (udma_modes[speed - XFER_UDMA_0] << (4 * unit));
170                 ultra_enable |= (0x01 << drive->dn);
171         } else if (speed >= XFER_MW_DMA_0)
172                 dma_timing   |= dma_modes[speed - XFER_MW_DMA_0];
173
174         pci_write_config_byte(dev, drive_pci2[drive->dn], dma_timing);
175         pci_write_config_byte(dev, (0x56|hwif->channel), ultra_timing);
176         pci_write_config_byte(dev, 0x54, ultra_enable);
177 }
178
179 static unsigned int __devinit init_chipset_svwks(struct pci_dev *dev)
180 {
181         unsigned int reg;
182         u8 btr;
183
184         /* force Master Latency Timer value to 64 PCICLKs */
185         pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x40);
186
187         /* OSB4 : South Bridge and IDE */
188         if (dev->device == PCI_DEVICE_ID_SERVERWORKS_OSB4IDE) {
189                 isa_dev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
190                           PCI_DEVICE_ID_SERVERWORKS_OSB4, NULL);
191                 if (isa_dev) {
192                         pci_read_config_dword(isa_dev, 0x64, &reg);
193                         reg &= ~0x00002000; /* disable 600ns interrupt mask */
194                         if(!(reg & 0x00004000))
195                                 printk(KERN_DEBUG DRV_NAME " %s: UDMA not BIOS "
196                                         "enabled.\n", pci_name(dev));
197                         reg |=  0x00004000; /* enable UDMA/33 support */
198                         pci_write_config_dword(isa_dev, 0x64, reg);
199                 }
200         }
201
202         /* setup CSB5/CSB6 : South Bridge and IDE option RAID */
203         else if ((dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE) ||
204                  (dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE) ||
205                  (dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)) {
206
207                 /* Third Channel Test */
208                 if (!(PCI_FUNC(dev->devfn) & 1)) {
209                         struct pci_dev * findev = NULL;
210                         u32 reg4c = 0;
211                         findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
212                                 PCI_DEVICE_ID_SERVERWORKS_CSB5, NULL);
213                         if (findev) {
214                                 pci_read_config_dword(findev, 0x4C, &reg4c);
215                                 reg4c &= ~0x000007FF;
216                                 reg4c |=  0x00000040;
217                                 reg4c |=  0x00000020;
218                                 pci_write_config_dword(findev, 0x4C, reg4c);
219                                 pci_dev_put(findev);
220                         }
221                         outb_p(0x06, 0x0c00);
222                         dev->irq = inb_p(0x0c01);
223                 } else {
224                         struct pci_dev * findev = NULL;
225                         u8 reg41 = 0;
226
227                         findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
228                                         PCI_DEVICE_ID_SERVERWORKS_CSB6, NULL);
229                         if (findev) {
230                                 pci_read_config_byte(findev, 0x41, &reg41);
231                                 reg41 &= ~0x40;
232                                 pci_write_config_byte(findev, 0x41, reg41);
233                                 pci_dev_put(findev);
234                         }
235                         /*
236                          * This is a device pin issue on CSB6.
237                          * Since there will be a future raid mode,
238                          * early versions of the chipset require the
239                          * interrupt pin to be set, and it is a compatibility
240                          * mode issue.
241                          */
242                         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE)
243                                 dev->irq = 0;
244                 }
245 //              pci_read_config_dword(dev, 0x40, &pioreg)
246 //              pci_write_config_dword(dev, 0x40, 0x99999999);
247 //              pci_read_config_dword(dev, 0x44, &dmareg);
248 //              pci_write_config_dword(dev, 0x44, 0xFFFFFFFF);
249                 /* setup the UDMA Control register
250                  *
251                  * 1. clear bit 6 to enable DMA
252                  * 2. enable DMA modes with bits 0-1
253                  *      00 : legacy
254                  *      01 : udma2
255                  *      10 : udma2/udma4
256                  *      11 : udma2/udma4/udma5
257                  */
258                 pci_read_config_byte(dev, 0x5A, &btr);
259                 btr &= ~0x40;
260                 if (!(PCI_FUNC(dev->devfn) & 1))
261                         btr |= 0x2;
262                 else
263                         btr |= (dev->revision >= SVWKS_CSB5_REVISION_NEW) ? 0x3 : 0x2;
264                 pci_write_config_byte(dev, 0x5A, btr);
265         }
266         /* Setup HT1000 SouthBridge Controller - Single Channel Only */
267         else if (dev->device == PCI_DEVICE_ID_SERVERWORKS_HT1000IDE) {
268                 pci_read_config_byte(dev, 0x5A, &btr);
269                 btr &= ~0x40;
270                 btr |= 0x3;
271                 pci_write_config_byte(dev, 0x5A, btr);
272         }
273
274         return dev->irq;
275 }
276
277 static u8 ata66_svwks_svwks(ide_hwif_t *hwif)
278 {
279         return ATA_CBL_PATA80;
280 }
281
282 /* On Dell PowerEdge servers with a CSB5/CSB6, the top two bits
283  * of the subsystem device ID indicate presence of an 80-pin cable.
284  * Bit 15 clear = secondary IDE channel does not have 80-pin cable.
285  * Bit 15 set   = secondary IDE channel has 80-pin cable.
286  * Bit 14 clear = primary IDE channel does not have 80-pin cable.
287  * Bit 14 set   = primary IDE channel has 80-pin cable.
288  */
289 static u8 ata66_svwks_dell(ide_hwif_t *hwif)
290 {
291         struct pci_dev *dev = to_pci_dev(hwif->dev);
292
293         if (dev->subsystem_vendor == PCI_VENDOR_ID_DELL &&
294             dev->vendor == PCI_VENDOR_ID_SERVERWORKS &&
295             (dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE ||
296              dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE))
297                 return ((1 << (hwif->channel + 14)) &
298                         dev->subsystem_device) ? ATA_CBL_PATA80 : ATA_CBL_PATA40;
299         return ATA_CBL_PATA40;
300 }
301
302 /* Sun Cobalt Alpine hardware avoids the 80-pin cable
303  * detect issue by attaching the drives directly to the board.
304  * This check follows the Dell precedent (how scary is that?!)
305  *
306  * WARNING: this only works on Alpine hardware!
307  */
308 static u8 ata66_svwks_cobalt(ide_hwif_t *hwif)
309 {
310         struct pci_dev *dev = to_pci_dev(hwif->dev);
311
312         if (dev->subsystem_vendor == PCI_VENDOR_ID_SUN &&
313             dev->vendor == PCI_VENDOR_ID_SERVERWORKS &&
314             dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE)
315                 return ((1 << (hwif->channel + 14)) &
316                         dev->subsystem_device) ? ATA_CBL_PATA80 : ATA_CBL_PATA40;
317         return ATA_CBL_PATA40;
318 }
319
320 static u8 svwks_cable_detect(ide_hwif_t *hwif)
321 {
322         struct pci_dev *dev = to_pci_dev(hwif->dev);
323
324         /* Server Works */
325         if (dev->subsystem_vendor == PCI_VENDOR_ID_SERVERWORKS)
326                 return ata66_svwks_svwks (hwif);
327         
328         /* Dell PowerEdge */
329         if (dev->subsystem_vendor == PCI_VENDOR_ID_DELL)
330                 return ata66_svwks_dell (hwif);
331
332         /* Cobalt Alpine */
333         if (dev->subsystem_vendor == PCI_VENDOR_ID_SUN)
334                 return ata66_svwks_cobalt (hwif);
335
336         /* Per Specified Design by OEM, and ASIC Architect */
337         if ((dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE) ||
338             (dev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2))
339                 return ATA_CBL_PATA80;
340
341         return ATA_CBL_PATA40;
342 }
343
344 static const struct ide_port_ops osb4_port_ops = {
345         .set_pio_mode           = svwks_set_pio_mode,
346         .set_dma_mode           = svwks_set_dma_mode,
347         .udma_filter            = svwks_udma_filter,
348 };
349
350 static const struct ide_port_ops svwks_port_ops = {
351         .set_pio_mode           = svwks_set_pio_mode,
352         .set_dma_mode           = svwks_set_dma_mode,
353         .udma_filter            = svwks_udma_filter,
354         .cable_detect           = svwks_cable_detect,
355 };
356
357 #define IDE_HFLAGS_SVWKS IDE_HFLAG_LEGACY_IRQS
358
359 static const struct ide_port_info serverworks_chipsets[] __devinitdata = {
360         {       /* 0: OSB4 */
361                 .name           = DRV_NAME,
362                 .init_chipset   = init_chipset_svwks,
363                 .port_ops       = &osb4_port_ops,
364                 .host_flags     = IDE_HFLAGS_SVWKS,
365                 .pio_mask       = ATA_PIO4,
366                 .mwdma_mask     = ATA_MWDMA2,
367                 .udma_mask      = 0x00, /* UDMA is problematic on OSB4 */
368         },
369         {       /* 1: CSB5 */
370                 .name           = DRV_NAME,
371                 .init_chipset   = init_chipset_svwks,
372                 .port_ops       = &svwks_port_ops,
373                 .host_flags     = IDE_HFLAGS_SVWKS,
374                 .pio_mask       = ATA_PIO4,
375                 .mwdma_mask     = ATA_MWDMA2,
376                 .udma_mask      = ATA_UDMA5,
377         },
378         {       /* 2: CSB6 */
379                 .name           = DRV_NAME,
380                 .init_chipset   = init_chipset_svwks,
381                 .port_ops       = &svwks_port_ops,
382                 .host_flags     = IDE_HFLAGS_SVWKS,
383                 .pio_mask       = ATA_PIO4,
384                 .mwdma_mask     = ATA_MWDMA2,
385                 .udma_mask      = ATA_UDMA5,
386         },
387         {       /* 3: CSB6-2 */
388                 .name           = DRV_NAME,
389                 .init_chipset   = init_chipset_svwks,
390                 .port_ops       = &svwks_port_ops,
391                 .host_flags     = IDE_HFLAGS_SVWKS | IDE_HFLAG_SINGLE,
392                 .pio_mask       = ATA_PIO4,
393                 .mwdma_mask     = ATA_MWDMA2,
394                 .udma_mask      = ATA_UDMA5,
395         },
396         {       /* 4: HT1000 */
397                 .name           = DRV_NAME,
398                 .init_chipset   = init_chipset_svwks,
399                 .port_ops       = &svwks_port_ops,
400                 .host_flags     = IDE_HFLAGS_SVWKS | IDE_HFLAG_SINGLE,
401                 .pio_mask       = ATA_PIO4,
402                 .mwdma_mask     = ATA_MWDMA2,
403                 .udma_mask      = ATA_UDMA5,
404         }
405 };
406
407 /**
408  *      svwks_init_one  -       called when a OSB/CSB is found
409  *      @dev: the svwks device
410  *      @id: the matching pci id
411  *
412  *      Called when the PCI registration layer (or the IDE initialization)
413  *      finds a device matching our IDE device tables.
414  */
415  
416 static int __devinit svwks_init_one(struct pci_dev *dev, const struct pci_device_id *id)
417 {
418         struct ide_port_info d;
419         u8 idx = id->driver_data;
420
421         d = serverworks_chipsets[idx];
422
423         if (idx == 1)
424                 d.host_flags |= IDE_HFLAG_CLEAR_SIMPLEX;
425         else if (idx == 2 || idx == 3) {
426                 if ((PCI_FUNC(dev->devfn) & 1) == 0) {
427                         if (pci_resource_start(dev, 0) != 0x01f1)
428                                 d.host_flags |= IDE_HFLAG_NON_BOOTABLE;
429                         d.host_flags |= IDE_HFLAG_SINGLE;
430                 } else
431                         d.host_flags &= ~IDE_HFLAG_SINGLE;
432         }
433
434         return ide_pci_init_one(dev, &d, NULL);
435 }
436
437 static const struct pci_device_id svwks_pci_tbl[] = {
438         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_OSB4IDE),   0 },
439         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB5IDE),   1 },
440         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE),   2 },
441         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2),  3 },
442         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_HT1000IDE), 4 },
443         { 0, },
444 };
445 MODULE_DEVICE_TABLE(pci, svwks_pci_tbl);
446
447 static struct pci_driver driver = {
448         .name           = "Serverworks_IDE",
449         .id_table       = svwks_pci_tbl,
450         .probe          = svwks_init_one,
451         .remove         = ide_pci_remove,
452 };
453
454 static int __init svwks_ide_init(void)
455 {
456         return ide_pci_register_driver(&driver);
457 }
458
459 static void __exit svwks_ide_exit(void)
460 {
461         pci_unregister_driver(&driver);
462 }
463
464 module_init(svwks_ide_init);
465 module_exit(svwks_ide_exit);
466
467 MODULE_AUTHOR("Michael Aubry. Andrzej Krzysztofowicz, Andre Hedrick");
468 MODULE_DESCRIPTION("PCI driver module for Serverworks OSB4/CSB5/CSB6 IDE");
469 MODULE_LICENSE("GPL");