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