alim15x3: add ali_fifo_control() helper
[safe/jmp/linux-2.6] / drivers / ide / alim15x3.c
1 /*
2  *  Copyright (C) 1998-2000 Michel Aubry, Maintainer
3  *  Copyright (C) 1998-2000 Andrzej Krzysztofowicz, Maintainer
4  *  Copyright (C) 1999-2000 CJ, cjtsai@ali.com.tw, Maintainer
5  *
6  *  Copyright (C) 1998-2000 Andre Hedrick (andre@linux-ide.org)
7  *  May be copied or modified under the terms of the GNU General Public License
8  *  Copyright (C) 2002 Alan Cox
9  *  ALi (now ULi M5228) support by Clear Zhang <Clear.Zhang@ali.com.tw>
10  *  Copyright (C) 2007 MontaVista Software, Inc. <source@mvista.com>
11  *  Copyright (C) 2007-2010 Bartlomiej Zolnierkiewicz
12  *
13  *  (U)DMA capable version of ali 1533/1543(C), 1535(D)
14  *
15  **********************************************************************
16  *  9/7/99 --Parts from the above author are included and need to be
17  *  converted into standard interface, once I finish the thought.
18  *
19  *  Recent changes
20  *      Don't use LBA48 mode on ALi <= 0xC4
21  *      Don't poke 0x79 with a non ALi northbridge
22  *      Don't flip undefined bits on newer chipsets (fix Fujitsu laptop hang)
23  *      Allow UDMA6 on revisions > 0xC4
24  *
25  *  Documentation
26  *      Chipset documentation available under NDA only
27  *
28  */
29
30 #include <linux/module.h>
31 #include <linux/types.h>
32 #include <linux/kernel.h>
33 #include <linux/pci.h>
34 #include <linux/ide.h>
35 #include <linux/init.h>
36 #include <linux/dmi.h>
37
38 #include <asm/io.h>
39
40 #define DRV_NAME "alim15x3"
41
42 /*
43  *      ALi devices are not plug in. Otherwise these static values would
44  *      need to go. They ought to go away anyway
45  */
46  
47 static u8 m5229_revision;
48 static u8 chip_is_1543c_e;
49 static struct pci_dev *isa_dev;
50
51 static void ali_fifo_control(ide_hwif_t *hwif, ide_drive_t *drive, int on)
52 {
53         struct pci_dev *pdev = to_pci_dev(hwif->dev);
54         int pio_fifo = 0x54 + hwif->channel;
55         u8 fifo;
56         int shift = 4 * (drive->dn & 1);
57
58         pci_read_config_byte(pdev, pio_fifo, &fifo);
59         fifo &= ~(0x0F << shift);
60         fifo |= (on << shift);
61         pci_write_config_byte(pdev, pio_fifo, fifo);
62 }
63
64 /**
65  *      ali_set_pio_mode        -       set host controller for PIO mode
66  *      @drive: drive
67  *      @pio: PIO mode number
68  *
69  *      Program the controller for the given PIO mode.
70  */
71
72 static void ali_set_pio_mode(ide_drive_t *drive, const u8 pio)
73 {
74         ide_hwif_t *hwif = drive->hwif;
75         struct pci_dev *dev = to_pci_dev(hwif->dev);
76         unsigned long flags;
77         int bus_speed = ide_pci_clk ? ide_pci_clk : 33;
78         unsigned long T =  1000000 / bus_speed; /* PCI clock based */
79         int port = hwif->channel ? 0x5c : 0x58;
80         u8 unit = drive->dn & 1;
81         struct ide_timing t;
82
83         ide_timing_compute(drive, XFER_PIO_0 + pio, &t, T, 1);
84
85         t.setup = clamp_val(t.setup, 1, 8) & 7;
86         t.active = clamp_val(t.active, 1, 8) & 7;
87         t.recover = clamp_val(t.recover, 1, 16) & 15;
88
89         local_irq_save(flags);
90
91         /* 
92          * PIO mode => ATA FIFO on, ATAPI FIFO off
93          */
94         ali_fifo_control(hwif, drive, (drive->media == ide_disk) ? 0x05 : 0x00);
95
96         pci_write_config_byte(dev, port, t.setup);
97         pci_write_config_byte(dev, port + unit + 2,
98                               (t.active << 4) | t.recover);
99
100         local_irq_restore(flags);
101 }
102
103 /**
104  *      ali_udma_filter         -       compute UDMA mask
105  *      @drive: IDE device
106  *
107  *      Return available UDMA modes.
108  *
109  *      The actual rules for the ALi are:
110  *              No UDMA on revisions <= 0x20
111  *              Disk only for revisions < 0xC2
112  *              Not WDC drives on M1543C-E (?)
113  */
114
115 static u8 ali_udma_filter(ide_drive_t *drive)
116 {
117         if (m5229_revision > 0x20 && m5229_revision < 0xC2) {
118                 if (drive->media != ide_disk)
119                         return 0;
120                 if (chip_is_1543c_e &&
121                     strstr((char *)&drive->id[ATA_ID_PROD], "WDC "))
122                         return 0;
123         }
124
125         return drive->hwif->ultra_mask;
126 }
127
128 /**
129  *      ali_set_dma_mode        -       set host controller for DMA mode
130  *      @drive: drive
131  *      @speed: DMA mode
132  *
133  *      Configure the hardware for the desired IDE transfer mode.
134  */
135
136 static void ali_set_dma_mode(ide_drive_t *drive, const u8 speed)
137 {
138         ide_hwif_t *hwif        = drive->hwif;
139         struct pci_dev *dev     = to_pci_dev(hwif->dev);
140         u8 speed1               = speed;
141         u8 unit                 = drive->dn & 1;
142         u8 tmpbyte              = 0x00;
143         int m5229_udma          = (hwif->channel) ? 0x57 : 0x56;
144
145         if (speed == XFER_UDMA_6)
146                 speed1 = 0x47;
147
148         if (speed < XFER_UDMA_0) {
149                 u8 ultra_enable = (unit) ? 0x7f : 0xf7;
150                 /*
151                  * clear "ultra enable" bit
152                  */
153                 pci_read_config_byte(dev, m5229_udma, &tmpbyte);
154                 tmpbyte &= ultra_enable;
155                 pci_write_config_byte(dev, m5229_udma, tmpbyte);
156
157                 /*
158                  * FIXME: Oh, my... DMA timings are never set.
159                  */
160         } else {
161                 pci_read_config_byte(dev, m5229_udma, &tmpbyte);
162                 tmpbyte &= (0x0f << ((1-unit) << 2));
163                 /*
164                  * enable ultra dma and set timing
165                  */
166                 tmpbyte |= ((0x08 | ((4-speed1)&0x07)) << (unit << 2));
167                 pci_write_config_byte(dev, m5229_udma, tmpbyte);
168                 if (speed >= XFER_UDMA_3) {
169                         pci_read_config_byte(dev, 0x4b, &tmpbyte);
170                         tmpbyte |= 1;
171                         pci_write_config_byte(dev, 0x4b, tmpbyte);
172                 }
173         }
174 }
175
176 /**
177  *      ali_dma_check   -       DMA check
178  *      @drive: target device
179  *      @cmd: command
180  *
181  *      Returns 1 if the DMA cannot be performed, zero on success.
182  */
183
184 static int ali_dma_check(ide_drive_t *drive, struct ide_cmd *cmd)
185 {
186         if (m5229_revision < 0xC2 && drive->media != ide_disk) {
187                 if (cmd->tf_flags & IDE_TFLAG_WRITE)
188                         return 1;       /* try PIO instead of DMA */
189         }
190         return 0;
191 }
192
193 /**
194  *      init_chipset_ali15x3    -       Initialise an ALi IDE controller
195  *      @dev: PCI device
196  *
197  *      This function initializes the ALI IDE controller and where 
198  *      appropriate also sets up the 1533 southbridge.
199  */
200
201 static int init_chipset_ali15x3(struct pci_dev *dev)
202 {
203         unsigned long flags;
204         u8 tmpbyte;
205         struct pci_dev *north = pci_get_slot(dev->bus, PCI_DEVFN(0,0));
206
207         m5229_revision = dev->revision;
208
209         isa_dev = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
210
211         local_irq_save(flags);
212
213         if (m5229_revision < 0xC2) {
214                 /*
215                  * revision 0x20 (1543-E, 1543-F)
216                  * revision 0xC0, 0xC1 (1543C-C, 1543C-D, 1543C-E)
217                  * clear CD-ROM DMA write bit, m5229, 0x4b, bit 7
218                  */
219                 pci_read_config_byte(dev, 0x4b, &tmpbyte);
220                 /*
221                  * clear bit 7
222                  */
223                 pci_write_config_byte(dev, 0x4b, tmpbyte & 0x7F);
224                 /*
225                  * check m1533, 0x5e, bit 1~4 == 1001 => & 00011110 = 00010010
226                  */
227                 if (m5229_revision >= 0x20 && isa_dev) {
228                         pci_read_config_byte(isa_dev, 0x5e, &tmpbyte);
229                         chip_is_1543c_e = ((tmpbyte & 0x1e) == 0x12) ? 1: 0;
230                 }
231                 goto out;
232         }
233
234         /*
235          * 1543C-B?, 1535, 1535D, 1553
236          * Note 1: not all "motherboard" support this detection
237          * Note 2: if no udma 66 device, the detection may "error".
238          *         but in this case, we will not set the device to
239          *         ultra 66, the detection result is not important
240          */
241
242         /*
243          * enable "Cable Detection", m5229, 0x4b, bit3
244          */
245         pci_read_config_byte(dev, 0x4b, &tmpbyte);
246         pci_write_config_byte(dev, 0x4b, tmpbyte | 0x08);
247
248         /*
249          * We should only tune the 1533 enable if we are using an ALi
250          * North bridge. We might have no north found on some zany
251          * box without a device at 0:0.0. The ALi bridge will be at
252          * 0:0.0 so if we didn't find one we know what is cooking.
253          */
254         if (north && north->vendor != PCI_VENDOR_ID_AL)
255                 goto out;
256
257         if (m5229_revision < 0xC5 && isa_dev)
258         {       
259                 /*
260                  * set south-bridge's enable bit, m1533, 0x79
261                  */
262
263                 pci_read_config_byte(isa_dev, 0x79, &tmpbyte);
264                 if (m5229_revision == 0xC2) {
265                         /*
266                          * 1543C-B0 (m1533, 0x79, bit 2)
267                          */
268                         pci_write_config_byte(isa_dev, 0x79, tmpbyte | 0x04);
269                 } else if (m5229_revision >= 0xC3) {
270                         /*
271                          * 1553/1535 (m1533, 0x79, bit 1)
272                          */
273                         pci_write_config_byte(isa_dev, 0x79, tmpbyte | 0x02);
274                 }
275         }
276
277 out:
278         /*
279          * CD_ROM DMA on (m5229, 0x53, bit0)
280          *      Enable this bit even if we want to use PIO.
281          * PIO FIFO off (m5229, 0x53, bit1)
282          *      The hardware will use 0x54h and 0x55h to control PIO FIFO.
283          *      (Not on later devices it seems)
284          *
285          *      0x53 changes meaning on later revs - we must no touch
286          *      bit 1 on them.  Need to check if 0x20 is the right break.
287          */
288         if (m5229_revision >= 0x20) {
289                 pci_read_config_byte(dev, 0x53, &tmpbyte);
290
291                 if (m5229_revision <= 0x20)
292                         tmpbyte = (tmpbyte & (~0x02)) | 0x01;
293                 else if (m5229_revision == 0xc7 || m5229_revision == 0xc8)
294                         tmpbyte |= 0x03;
295                 else
296                         tmpbyte |= 0x01;
297
298                 pci_write_config_byte(dev, 0x53, tmpbyte);
299         }
300         pci_dev_put(north);
301         pci_dev_put(isa_dev);
302         local_irq_restore(flags);
303         return 0;
304 }
305
306 /*
307  *      Cable special cases
308  */
309
310 static const struct dmi_system_id cable_dmi_table[] = {
311         {
312                 .ident = "HP Pavilion N5430",
313                 .matches = {
314                         DMI_MATCH(DMI_BOARD_VENDOR, "Hewlett-Packard"),
315                         DMI_MATCH(DMI_BOARD_VERSION, "OmniBook N32N-736"),
316                 },
317         },
318         {
319                 .ident = "Toshiba Satellite S1800-814",
320                 .matches = {
321                         DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
322                         DMI_MATCH(DMI_PRODUCT_NAME, "S1800-814"),
323                 },
324         },
325         { }
326 };
327
328 static int ali_cable_override(struct pci_dev *pdev)
329 {
330         /* Fujitsu P2000 */
331         if (pdev->subsystem_vendor == 0x10CF &&
332             pdev->subsystem_device == 0x10AF)
333                 return 1;
334
335         /* Mitac 8317 (Winbook-A) and relatives */
336         if (pdev->subsystem_vendor == 0x1071 &&
337             pdev->subsystem_device == 0x8317)
338                 return 1;
339
340         /* Systems by DMI */
341         if (dmi_check_system(cable_dmi_table))
342                 return 1;
343
344         return 0;
345 }
346
347 /**
348  *      ali_cable_detect        -       cable detection
349  *      @hwif: IDE interface
350  *
351  *      This checks if the controller and the cable are capable
352  *      of UDMA66 transfers. It doesn't check the drives.
353  *      But see note 2 below!
354  *
355  *      FIXME: frobs bits that are not defined on newer ALi devicea
356  */
357
358 static u8 ali_cable_detect(ide_hwif_t *hwif)
359 {
360         struct pci_dev *dev = to_pci_dev(hwif->dev);
361         unsigned long flags;
362         u8 cbl = ATA_CBL_PATA40, tmpbyte;
363
364         local_irq_save(flags);
365
366         if (m5229_revision >= 0xC2) {
367                 /*
368                  * m5229 80-pin cable detection (from Host View)
369                  *
370                  * 0x4a bit0 is 0 => primary channel has 80-pin
371                  * 0x4a bit1 is 0 => secondary channel has 80-pin
372                  *
373                  * Certain laptops use short but suitable cables
374                  * and don't implement the detect logic.
375                  */
376                 if (ali_cable_override(dev))
377                         cbl = ATA_CBL_PATA40_SHORT;
378                 else {
379                         pci_read_config_byte(dev, 0x4a, &tmpbyte);
380                         if ((tmpbyte & (1 << hwif->channel)) == 0)
381                                 cbl = ATA_CBL_PATA80;
382                 }
383         }
384
385         local_irq_restore(flags);
386
387         return cbl;
388 }
389
390 #ifndef CONFIG_SPARC64
391 /**
392  *      init_hwif_ali15x3       -       Initialize the ALI IDE x86 stuff
393  *      @hwif: interface to configure
394  *
395  *      Obtain the IRQ tables for an ALi based IDE solution on the PC
396  *      class platforms. This part of the code isn't applicable to the
397  *      Sparc systems.
398  */
399
400 static void __devinit init_hwif_ali15x3 (ide_hwif_t *hwif)
401 {
402         u8 ideic, inmir;
403         s8 irq_routing_table[] = { -1,  9, 3, 10, 4,  5, 7,  6,
404                                       1, 11, 0, 12, 0, 14, 0, 15 };
405         int irq = -1;
406
407         if (isa_dev) {
408                 /*
409                  * read IDE interface control
410                  */
411                 pci_read_config_byte(isa_dev, 0x58, &ideic);
412
413                 /* bit0, bit1 */
414                 ideic = ideic & 0x03;
415
416                 /* get IRQ for IDE Controller */
417                 if ((hwif->channel && ideic == 0x03) ||
418                     (!hwif->channel && !ideic)) {
419                         /*
420                          * get SIRQ1 routing table
421                          */
422                         pci_read_config_byte(isa_dev, 0x44, &inmir);
423                         inmir = inmir & 0x0f;
424                         irq = irq_routing_table[inmir];
425                 } else if (hwif->channel && !(ideic & 0x01)) {
426                         /*
427                          * get SIRQ2 routing table
428                          */
429                         pci_read_config_byte(isa_dev, 0x75, &inmir);
430                         inmir = inmir & 0x0f;
431                         irq = irq_routing_table[inmir];
432                 }
433                 if(irq >= 0)
434                         hwif->irq = irq;
435         }
436 }
437 #else
438 #define init_hwif_ali15x3 NULL
439 #endif /* CONFIG_SPARC64 */
440
441 /**
442  *      init_dma_ali15x3        -       set up DMA on ALi15x3
443  *      @hwif: IDE interface
444  *      @d: IDE port info
445  *
446  *      Set up the DMA functionality on the ALi 15x3.
447  */
448
449 static int __devinit init_dma_ali15x3(ide_hwif_t *hwif,
450                                       const struct ide_port_info *d)
451 {
452         struct pci_dev *dev = to_pci_dev(hwif->dev);
453         unsigned long base = ide_pci_dma_base(hwif, d);
454
455         if (base == 0)
456                 return -1;
457
458         hwif->dma_base = base;
459
460         if (ide_pci_check_simplex(hwif, d) < 0)
461                 return -1;
462
463         if (ide_pci_set_master(dev, d->name) < 0)
464                 return -1;
465
466         if (!hwif->channel)
467                 outb(inb(base + 2) & 0x60, base + 2);
468
469         printk(KERN_INFO "    %s: BM-DMA at 0x%04lx-0x%04lx\n",
470                          hwif->name, base, base + 7);
471
472         if (ide_allocate_dma_engine(hwif))
473                 return -1;
474
475         return 0;
476 }
477
478 static const struct ide_port_ops ali_port_ops = {
479         .set_pio_mode           = ali_set_pio_mode,
480         .set_dma_mode           = ali_set_dma_mode,
481         .udma_filter            = ali_udma_filter,
482         .cable_detect           = ali_cable_detect,
483 };
484
485 static const struct ide_dma_ops ali_dma_ops = {
486         .dma_host_set           = ide_dma_host_set,
487         .dma_setup              = ide_dma_setup,
488         .dma_start              = ide_dma_start,
489         .dma_end                = ide_dma_end,
490         .dma_test_irq           = ide_dma_test_irq,
491         .dma_lost_irq           = ide_dma_lost_irq,
492         .dma_check              = ali_dma_check,
493         .dma_timer_expiry       = ide_dma_sff_timer_expiry,
494         .dma_sff_read_status    = ide_dma_sff_read_status,
495 };
496
497 static const struct ide_port_info ali15x3_chipset __devinitdata = {
498         .name           = DRV_NAME,
499         .init_chipset   = init_chipset_ali15x3,
500         .init_hwif      = init_hwif_ali15x3,
501         .init_dma       = init_dma_ali15x3,
502         .port_ops       = &ali_port_ops,
503         .dma_ops        = &sff_dma_ops,
504         .pio_mask       = ATA_PIO5,
505         .swdma_mask     = ATA_SWDMA2,
506         .mwdma_mask     = ATA_MWDMA2,
507 };
508
509 /**
510  *      alim15x3_init_one       -       set up an ALi15x3 IDE controller
511  *      @dev: PCI device to set up
512  *
513  *      Perform the actual set up for an ALi15x3 that has been found by the
514  *      hot plug layer.
515  */
516  
517 static int __devinit alim15x3_init_one(struct pci_dev *dev, const struct pci_device_id *id)
518 {
519         struct ide_port_info d = ali15x3_chipset;
520         u8 rev = dev->revision, idx = id->driver_data;
521
522         /* don't use LBA48 DMA on ALi devices before rev 0xC5 */
523         if (rev <= 0xC4)
524                 d.host_flags |= IDE_HFLAG_NO_LBA48_DMA;
525
526         if (rev >= 0x20) {
527                 if (rev == 0x20)
528                         d.host_flags |= IDE_HFLAG_NO_ATAPI_DMA;
529
530                 if (rev < 0xC2)
531                         d.udma_mask = ATA_UDMA2;
532                 else if (rev == 0xC2 || rev == 0xC3)
533                         d.udma_mask = ATA_UDMA4;
534                 else if (rev == 0xC4)
535                         d.udma_mask = ATA_UDMA5;
536                 else
537                         d.udma_mask = ATA_UDMA6;
538
539                 d.dma_ops = &ali_dma_ops;
540         } else {
541                 d.host_flags |= IDE_HFLAG_NO_DMA;
542
543                 d.mwdma_mask = d.swdma_mask = 0;
544         }
545
546         if (idx == 0)
547                 d.host_flags |= IDE_HFLAG_CLEAR_SIMPLEX;
548
549         return ide_pci_init_one(dev, &d, NULL);
550 }
551
552
553 static const struct pci_device_id alim15x3_pci_tbl[] = {
554         { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), 0 },
555         { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), 1 },
556         { 0, },
557 };
558 MODULE_DEVICE_TABLE(pci, alim15x3_pci_tbl);
559
560 static struct pci_driver alim15x3_pci_driver = {
561         .name           = "ALI15x3_IDE",
562         .id_table       = alim15x3_pci_tbl,
563         .probe          = alim15x3_init_one,
564         .remove         = ide_pci_remove,
565         .suspend        = ide_pci_suspend,
566         .resume         = ide_pci_resume,
567 };
568
569 static int __init ali15x3_ide_init(void)
570 {
571         return ide_pci_register_driver(&alim15x3_pci_driver);
572 }
573
574 static void __exit ali15x3_ide_exit(void)
575 {
576         pci_unregister_driver(&alim15x3_pci_driver);
577 }
578
579 module_init(ali15x3_ide_init);
580 module_exit(ali15x3_ide_exit);
581
582 MODULE_AUTHOR("Michael Aubry, Andrzej Krzysztofowicz, CJ, Andre Hedrick, Alan Cox, Bartlomiej Zolnierkiewicz");
583 MODULE_DESCRIPTION("PCI driver module for ALi 15x3 IDE");
584 MODULE_LICENSE("GPL");