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