pata_hpt{37x,3x2n}: add debounce delay to cable detection methods
[safe/jmp/linux-2.6] / drivers / ata / pata_hpt37x.c
1 /*
2  * Libata driver for the highpoint 37x and 30x UDMA66 ATA controllers.
3  *
4  * This driver is heavily based upon:
5  *
6  * linux/drivers/ide/pci/hpt366.c               Version 0.36    April 25, 2003
7  *
8  * Copyright (C) 1999-2003              Andre Hedrick <andre@linux-ide.org>
9  * Portions Copyright (C) 2001          Sun Microsystems, Inc.
10  * Portions Copyright (C) 2003          Red Hat Inc
11  * Portions Copyright (C) 2005-2009     MontaVista Software, Inc.
12  *
13  * TODO
14  *      Look into engine reset on timeout errors. Should not be required.
15  */
16
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/pci.h>
20 #include <linux/init.h>
21 #include <linux/blkdev.h>
22 #include <linux/delay.h>
23 #include <scsi/scsi_host.h>
24 #include <linux/libata.h>
25
26 #define DRV_NAME        "pata_hpt37x"
27 #define DRV_VERSION     "0.6.12"
28
29 struct hpt_clock {
30         u8      xfer_speed;
31         u32     timing;
32 };
33
34 struct hpt_chip {
35         const char *name;
36         unsigned int base;
37         struct hpt_clock const *clocks[4];
38 };
39
40 /* key for bus clock timings
41  * bit
42  * 0:3    data_high_time. inactive time of DIOW_/DIOR_ for PIO and MW
43  *        DMA. cycles = value + 1
44  * 4:8    data_low_time. active time of DIOW_/DIOR_ for PIO and MW
45  *        DMA. cycles = value + 1
46  * 9:12   cmd_high_time. inactive time of DIOW_/DIOR_ during task file
47  *        register access.
48  * 13:17  cmd_low_time. active time of DIOW_/DIOR_ during task file
49  *        register access.
50  * 18:21  udma_cycle_time. clock freq and clock cycles for UDMA xfer.
51  *        during task file register access.
52  * 22:24  pre_high_time. time to initialize 1st cycle for PIO and MW DMA
53  *        xfer.
54  * 25:27  cmd_pre_high_time. time to initialize 1st PIO cycle for task
55  *        register access.
56  * 28     UDMA enable
57  * 29     DMA enable
58  * 30     PIO_MST enable. if set, the chip is in bus master mode during
59  *        PIO.
60  * 31     FIFO enable.
61  */
62
63 static struct hpt_clock hpt37x_timings_33[] = {
64         { XFER_UDMA_6,          0x12446231 },   /* 0x12646231 ?? */
65         { XFER_UDMA_5,          0x12446231 },
66         { XFER_UDMA_4,          0x12446231 },
67         { XFER_UDMA_3,          0x126c6231 },
68         { XFER_UDMA_2,          0x12486231 },
69         { XFER_UDMA_1,          0x124c6233 },
70         { XFER_UDMA_0,          0x12506297 },
71
72         { XFER_MW_DMA_2,        0x22406c31 },
73         { XFER_MW_DMA_1,        0x22406c33 },
74         { XFER_MW_DMA_0,        0x22406c97 },
75
76         { XFER_PIO_4,           0x06414e31 },
77         { XFER_PIO_3,           0x06414e42 },
78         { XFER_PIO_2,           0x06414e53 },
79         { XFER_PIO_1,           0x06814e93 },
80         { XFER_PIO_0,           0x06814ea7 }
81 };
82
83 static struct hpt_clock hpt37x_timings_50[] = {
84         { XFER_UDMA_6,          0x12848242 },
85         { XFER_UDMA_5,          0x12848242 },
86         { XFER_UDMA_4,          0x12ac8242 },
87         { XFER_UDMA_3,          0x128c8242 },
88         { XFER_UDMA_2,          0x120c8242 },
89         { XFER_UDMA_1,          0x12148254 },
90         { XFER_UDMA_0,          0x121882ea },
91
92         { XFER_MW_DMA_2,        0x22808242 },
93         { XFER_MW_DMA_1,        0x22808254 },
94         { XFER_MW_DMA_0,        0x228082ea },
95
96         { XFER_PIO_4,           0x0a81f442 },
97         { XFER_PIO_3,           0x0a81f443 },
98         { XFER_PIO_2,           0x0a81f454 },
99         { XFER_PIO_1,           0x0ac1f465 },
100         { XFER_PIO_0,           0x0ac1f48a }
101 };
102
103 static struct hpt_clock hpt37x_timings_66[] = {
104         { XFER_UDMA_6,          0x1c869c62 },
105         { XFER_UDMA_5,          0x1cae9c62 },   /* 0x1c8a9c62 */
106         { XFER_UDMA_4,          0x1c8a9c62 },
107         { XFER_UDMA_3,          0x1c8e9c62 },
108         { XFER_UDMA_2,          0x1c929c62 },
109         { XFER_UDMA_1,          0x1c9a9c62 },
110         { XFER_UDMA_0,          0x1c829c62 },
111
112         { XFER_MW_DMA_2,        0x2c829c62 },
113         { XFER_MW_DMA_1,        0x2c829c66 },
114         { XFER_MW_DMA_0,        0x2c829d2e },
115
116         { XFER_PIO_4,           0x0c829c62 },
117         { XFER_PIO_3,           0x0c829c84 },
118         { XFER_PIO_2,           0x0c829ca6 },
119         { XFER_PIO_1,           0x0d029d26 },
120         { XFER_PIO_0,           0x0d029d5e }
121 };
122
123
124 static const struct hpt_chip hpt370 = {
125         "HPT370",
126         48,
127         {
128                 hpt37x_timings_33,
129                 NULL,
130                 NULL,
131                 NULL
132         }
133 };
134
135 static const struct hpt_chip hpt370a = {
136         "HPT370A",
137         48,
138         {
139                 hpt37x_timings_33,
140                 NULL,
141                 hpt37x_timings_50,
142                 NULL
143         }
144 };
145
146 static const struct hpt_chip hpt372 = {
147         "HPT372",
148         55,
149         {
150                 hpt37x_timings_33,
151                 NULL,
152                 hpt37x_timings_50,
153                 hpt37x_timings_66
154         }
155 };
156
157 static const struct hpt_chip hpt302 = {
158         "HPT302",
159         66,
160         {
161                 hpt37x_timings_33,
162                 NULL,
163                 hpt37x_timings_50,
164                 hpt37x_timings_66
165         }
166 };
167
168 static const struct hpt_chip hpt371 = {
169         "HPT371",
170         66,
171         {
172                 hpt37x_timings_33,
173                 NULL,
174                 hpt37x_timings_50,
175                 hpt37x_timings_66
176         }
177 };
178
179 static const struct hpt_chip hpt372a = {
180         "HPT372A",
181         66,
182         {
183                 hpt37x_timings_33,
184                 NULL,
185                 hpt37x_timings_50,
186                 hpt37x_timings_66
187         }
188 };
189
190 static const struct hpt_chip hpt374 = {
191         "HPT374",
192         48,
193         {
194                 hpt37x_timings_33,
195                 NULL,
196                 NULL,
197                 NULL
198         }
199 };
200
201 /**
202  *      hpt37x_find_mode        -       reset the hpt37x bus
203  *      @ap: ATA port
204  *      @speed: transfer mode
205  *
206  *      Return the 32bit register programming information for this channel
207  *      that matches the speed provided.
208  */
209
210 static u32 hpt37x_find_mode(struct ata_port *ap, int speed)
211 {
212         struct hpt_clock *clocks = ap->host->private_data;
213
214         while(clocks->xfer_speed) {
215                 if (clocks->xfer_speed == speed)
216                         return clocks->timing;
217                 clocks++;
218         }
219         BUG();
220         return 0xffffffffU;     /* silence compiler warning */
221 }
222
223 static int hpt_dma_blacklisted(const struct ata_device *dev, char *modestr, const char *list[])
224 {
225         unsigned char model_num[ATA_ID_PROD_LEN + 1];
226         int i = 0;
227
228         ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
229
230         while (list[i] != NULL) {
231                 if (!strcmp(list[i], model_num)) {
232                         printk(KERN_WARNING DRV_NAME ": %s is not supported for %s.\n",
233                                 modestr, list[i]);
234                         return 1;
235                 }
236                 i++;
237         }
238         return 0;
239 }
240
241 static const char *bad_ata33[] = {
242         "Maxtor 92720U8", "Maxtor 92040U6", "Maxtor 91360U4", "Maxtor 91020U3", "Maxtor 90845U3", "Maxtor 90650U2",
243         "Maxtor 91360D8", "Maxtor 91190D7", "Maxtor 91020D6", "Maxtor 90845D5", "Maxtor 90680D4", "Maxtor 90510D3", "Maxtor 90340D2",
244         "Maxtor 91152D8", "Maxtor 91008D7", "Maxtor 90845D6", "Maxtor 90840D6", "Maxtor 90720D5", "Maxtor 90648D5", "Maxtor 90576D4",
245         "Maxtor 90510D4",
246         "Maxtor 90432D3", "Maxtor 90288D2", "Maxtor 90256D2",
247         "Maxtor 91000D8", "Maxtor 90910D8", "Maxtor 90875D7", "Maxtor 90840D7", "Maxtor 90750D6", "Maxtor 90625D5", "Maxtor 90500D4",
248         "Maxtor 91728D8", "Maxtor 91512D7", "Maxtor 91303D6", "Maxtor 91080D5", "Maxtor 90845D4", "Maxtor 90680D4", "Maxtor 90648D3", "Maxtor 90432D2",
249         NULL
250 };
251
252 static const char *bad_ata100_5[] = {
253         "IBM-DTLA-307075",
254         "IBM-DTLA-307060",
255         "IBM-DTLA-307045",
256         "IBM-DTLA-307030",
257         "IBM-DTLA-307020",
258         "IBM-DTLA-307015",
259         "IBM-DTLA-305040",
260         "IBM-DTLA-305030",
261         "IBM-DTLA-305020",
262         "IC35L010AVER07-0",
263         "IC35L020AVER07-0",
264         "IC35L030AVER07-0",
265         "IC35L040AVER07-0",
266         "IC35L060AVER07-0",
267         "WDC AC310200R",
268         NULL
269 };
270
271 /**
272  *      hpt370_filter   -       mode selection filter
273  *      @adev: ATA device
274  *
275  *      Block UDMA on devices that cause trouble with this controller.
276  */
277
278 static unsigned long hpt370_filter(struct ata_device *adev, unsigned long mask)
279 {
280         if (adev->class == ATA_DEV_ATA) {
281                 if (hpt_dma_blacklisted(adev, "UDMA", bad_ata33))
282                         mask &= ~ATA_MASK_UDMA;
283                 if (hpt_dma_blacklisted(adev, "UDMA100", bad_ata100_5))
284                         mask &= ~(0xE0 << ATA_SHIFT_UDMA);
285         }
286         return ata_bmdma_mode_filter(adev, mask);
287 }
288
289 /**
290  *      hpt370a_filter  -       mode selection filter
291  *      @adev: ATA device
292  *
293  *      Block UDMA on devices that cause trouble with this controller.
294  */
295
296 static unsigned long hpt370a_filter(struct ata_device *adev, unsigned long mask)
297 {
298         if (adev->class == ATA_DEV_ATA) {
299                 if (hpt_dma_blacklisted(adev, "UDMA100", bad_ata100_5))
300                         mask &= ~(0xE0 << ATA_SHIFT_UDMA);
301         }
302         return ata_bmdma_mode_filter(adev, mask);
303 }
304
305 /**
306  *      hpt37x_cable_detect     -       Detect the cable type
307  *      @ap: ATA port to detect on
308  *
309  *      Return the cable type attached to this port
310  */
311
312 static int hpt37x_cable_detect(struct ata_port *ap)
313 {
314         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
315         u8 scr2, ata66;
316
317         pci_read_config_byte(pdev, 0x5B, &scr2);
318         pci_write_config_byte(pdev, 0x5B, scr2 & ~0x01);
319
320         udelay(10); /* debounce */
321
322         /* Cable register now active */
323         pci_read_config_byte(pdev, 0x5A, &ata66);
324         /* Restore state */
325         pci_write_config_byte(pdev, 0x5B, scr2);
326
327         if (ata66 & (2 >> ap->port_no))
328                 return ATA_CBL_PATA40;
329         else
330                 return ATA_CBL_PATA80;
331 }
332
333 /**
334  *      hpt374_fn1_cable_detect -       Detect the cable type
335  *      @ap: ATA port to detect on
336  *
337  *      Return the cable type attached to this port
338  */
339
340 static int hpt374_fn1_cable_detect(struct ata_port *ap)
341 {
342         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
343         unsigned int mcrbase = 0x50 + 4 * ap->port_no;
344         u16 mcr3;
345         u8 ata66;
346
347         /* Do the extra channel work */
348         pci_read_config_word(pdev, mcrbase + 2, &mcr3);
349         /* Set bit 15 of 0x52 to enable TCBLID as input */
350         pci_write_config_word(pdev, mcrbase + 2, mcr3 | 0x8000);
351         pci_read_config_byte(pdev, 0x5A, &ata66);
352         /* Reset TCBLID/FCBLID to output */
353         pci_write_config_word(pdev, mcrbase + 2, mcr3);
354
355         if (ata66 & (2 >> ap->port_no))
356                 return ATA_CBL_PATA40;
357         else
358                 return ATA_CBL_PATA80;
359 }
360
361 /**
362  *      hpt37x_pre_reset        -       reset the hpt37x bus
363  *      @link: ATA link to reset
364  *      @deadline: deadline jiffies for the operation
365  *
366  *      Perform the initial reset handling for the HPT37x.
367  */
368
369 static int hpt37x_pre_reset(struct ata_link *link, unsigned long deadline)
370 {
371         struct ata_port *ap = link->ap;
372         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
373         static const struct pci_bits hpt37x_enable_bits[] = {
374                 { 0x50, 1, 0x04, 0x04 },
375                 { 0x54, 1, 0x04, 0x04 }
376         };
377         if (!pci_test_config_bits(pdev, &hpt37x_enable_bits[ap->port_no]))
378                 return -ENOENT;
379
380         /* Reset the state machine */
381         pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
382         udelay(100);
383
384         return ata_sff_prereset(link, deadline);
385 }
386
387 /**
388  *      hpt370_set_piomode              -       PIO setup
389  *      @ap: ATA interface
390  *      @adev: device on the interface
391  *
392  *      Perform PIO mode setup.
393  */
394
395 static void hpt370_set_piomode(struct ata_port *ap, struct ata_device *adev)
396 {
397         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
398         u32 addr1, addr2;
399         u32 reg;
400         u32 mode;
401         u8 fast;
402
403         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
404         addr2 = 0x51 + 4 * ap->port_no;
405
406         /* Fast interrupt prediction disable, hold off interrupt disable */
407         pci_read_config_byte(pdev, addr2, &fast);
408         fast &= ~0x02;
409         fast |= 0x01;
410         pci_write_config_byte(pdev, addr2, fast);
411
412         pci_read_config_dword(pdev, addr1, &reg);
413         mode = hpt37x_find_mode(ap, adev->pio_mode);
414         mode &= ~0x8000000;     /* No FIFO in PIO */
415         mode &= ~0x30070000;    /* Leave config bits alone */
416         reg &= 0x30070000;      /* Strip timing bits */
417         pci_write_config_dword(pdev, addr1, reg | mode);
418 }
419
420 /**
421  *      hpt370_set_dmamode              -       DMA timing setup
422  *      @ap: ATA interface
423  *      @adev: Device being configured
424  *
425  *      Set up the channel for MWDMA or UDMA modes. Much the same as with
426  *      PIO, load the mode number and then set MWDMA or UDMA flag.
427  */
428
429 static void hpt370_set_dmamode(struct ata_port *ap, struct ata_device *adev)
430 {
431         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
432         u32 addr1, addr2;
433         u32 reg;
434         u32 mode;
435         u8 fast;
436
437         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
438         addr2 = 0x51 + 4 * ap->port_no;
439
440         /* Fast interrupt prediction disable, hold off interrupt disable */
441         pci_read_config_byte(pdev, addr2, &fast);
442         fast &= ~0x02;
443         fast |= 0x01;
444         pci_write_config_byte(pdev, addr2, fast);
445
446         pci_read_config_dword(pdev, addr1, &reg);
447         mode = hpt37x_find_mode(ap, adev->dma_mode);
448         mode |= 0x8000000;      /* FIFO in MWDMA or UDMA */
449         mode &= ~0xC0000000;    /* Leave config bits alone */
450         reg &= 0xC0000000;      /* Strip timing bits */
451         pci_write_config_dword(pdev, addr1, reg | mode);
452 }
453
454 /**
455  *      hpt370_bmdma_end                -       DMA engine stop
456  *      @qc: ATA command
457  *
458  *      Work around the HPT370 DMA engine.
459  */
460
461 static void hpt370_bmdma_stop(struct ata_queued_cmd *qc)
462 {
463         struct ata_port *ap = qc->ap;
464         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
465         u8 dma_stat = ioread8(ap->ioaddr.bmdma_addr + 2);
466         u8 dma_cmd;
467         void __iomem *bmdma = ap->ioaddr.bmdma_addr;
468
469         if (dma_stat & 0x01) {
470                 udelay(20);
471                 dma_stat = ioread8(bmdma + 2);
472         }
473         if (dma_stat & 0x01) {
474                 /* Clear the engine */
475                 pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
476                 udelay(10);
477                 /* Stop DMA */
478                 dma_cmd = ioread8(bmdma );
479                 iowrite8(dma_cmd & 0xFE, bmdma);
480                 /* Clear Error */
481                 dma_stat = ioread8(bmdma + 2);
482                 iowrite8(dma_stat | 0x06 , bmdma + 2);
483                 /* Clear the engine */
484                 pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
485                 udelay(10);
486         }
487         ata_bmdma_stop(qc);
488 }
489
490 /**
491  *      hpt372_set_piomode              -       PIO setup
492  *      @ap: ATA interface
493  *      @adev: device on the interface
494  *
495  *      Perform PIO mode setup.
496  */
497
498 static void hpt372_set_piomode(struct ata_port *ap, struct ata_device *adev)
499 {
500         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
501         u32 addr1, addr2;
502         u32 reg;
503         u32 mode;
504         u8 fast;
505
506         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
507         addr2 = 0x51 + 4 * ap->port_no;
508
509         /* Fast interrupt prediction disable, hold off interrupt disable */
510         pci_read_config_byte(pdev, addr2, &fast);
511         fast &= ~0x07;
512         pci_write_config_byte(pdev, addr2, fast);
513
514         pci_read_config_dword(pdev, addr1, &reg);
515         mode = hpt37x_find_mode(ap, adev->pio_mode);
516
517         printk("Find mode for %d reports %X\n", adev->pio_mode, mode);
518         mode &= ~0x80000000;    /* No FIFO in PIO */
519         mode &= ~0x30070000;    /* Leave config bits alone */
520         reg &= 0x30070000;      /* Strip timing bits */
521         pci_write_config_dword(pdev, addr1, reg | mode);
522 }
523
524 /**
525  *      hpt372_set_dmamode              -       DMA timing setup
526  *      @ap: ATA interface
527  *      @adev: Device being configured
528  *
529  *      Set up the channel for MWDMA or UDMA modes. Much the same as with
530  *      PIO, load the mode number and then set MWDMA or UDMA flag.
531  */
532
533 static void hpt372_set_dmamode(struct ata_port *ap, struct ata_device *adev)
534 {
535         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
536         u32 addr1, addr2;
537         u32 reg;
538         u32 mode;
539         u8 fast;
540
541         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
542         addr2 = 0x51 + 4 * ap->port_no;
543
544         /* Fast interrupt prediction disable, hold off interrupt disable */
545         pci_read_config_byte(pdev, addr2, &fast);
546         fast &= ~0x07;
547         pci_write_config_byte(pdev, addr2, fast);
548
549         pci_read_config_dword(pdev, addr1, &reg);
550         mode = hpt37x_find_mode(ap, adev->dma_mode);
551         printk("Find mode for DMA %d reports %X\n", adev->dma_mode, mode);
552         mode &= ~0xC0000000;    /* Leave config bits alone */
553         mode |= 0x80000000;     /* FIFO in MWDMA or UDMA */
554         reg &= 0xC0000000;      /* Strip timing bits */
555         pci_write_config_dword(pdev, addr1, reg | mode);
556 }
557
558 /**
559  *      hpt37x_bmdma_end                -       DMA engine stop
560  *      @qc: ATA command
561  *
562  *      Clean up after the HPT372 and later DMA engine
563  */
564
565 static void hpt37x_bmdma_stop(struct ata_queued_cmd *qc)
566 {
567         struct ata_port *ap = qc->ap;
568         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
569         int mscreg = 0x50 + 4 * ap->port_no;
570         u8 bwsr_stat, msc_stat;
571
572         pci_read_config_byte(pdev, 0x6A, &bwsr_stat);
573         pci_read_config_byte(pdev, mscreg, &msc_stat);
574         if (bwsr_stat & (1 << ap->port_no))
575                 pci_write_config_byte(pdev, mscreg, msc_stat | 0x30);
576         ata_bmdma_stop(qc);
577 }
578
579
580 static struct scsi_host_template hpt37x_sht = {
581         ATA_BMDMA_SHT(DRV_NAME),
582 };
583
584 /*
585  *      Configuration for HPT370
586  */
587
588 static struct ata_port_operations hpt370_port_ops = {
589         .inherits       = &ata_bmdma_port_ops,
590
591         .bmdma_stop     = hpt370_bmdma_stop,
592
593         .mode_filter    = hpt370_filter,
594         .cable_detect   = hpt37x_cable_detect,
595         .set_piomode    = hpt370_set_piomode,
596         .set_dmamode    = hpt370_set_dmamode,
597         .prereset       = hpt37x_pre_reset,
598 };
599
600 /*
601  *      Configuration for HPT370A. Close to 370 but less filters
602  */
603
604 static struct ata_port_operations hpt370a_port_ops = {
605         .inherits       = &hpt370_port_ops,
606         .mode_filter    = hpt370a_filter,
607 };
608
609 /*
610  *      Configuration for HPT372, HPT371, HPT302. Slightly different PIO
611  *      and DMA mode setting functionality.
612  */
613
614 static struct ata_port_operations hpt372_port_ops = {
615         .inherits       = &ata_bmdma_port_ops,
616
617         .bmdma_stop     = hpt37x_bmdma_stop,
618
619         .cable_detect   = hpt37x_cable_detect,
620         .set_piomode    = hpt372_set_piomode,
621         .set_dmamode    = hpt372_set_dmamode,
622         .prereset       = hpt37x_pre_reset,
623 };
624
625 /*
626  *      Configuration for HPT374. Mode setting works like 372 and friends
627  *      but we have a different cable detection procedure for function 1.
628  */
629
630 static struct ata_port_operations hpt374_fn1_port_ops = {
631         .inherits       = &hpt372_port_ops,
632         .cable_detect   = hpt374_fn1_cable_detect,
633         .prereset       = hpt37x_pre_reset,
634 };
635
636 /**
637  *      hpt37x_clock_slot       -       Turn timing to PC clock entry
638  *      @freq: Reported frequency timing
639  *      @base: Base timing
640  *
641  *      Turn the timing data intoa clock slot (0 for 33, 1 for 40, 2 for 50
642  *      and 3 for 66Mhz)
643  */
644
645 static int hpt37x_clock_slot(unsigned int freq, unsigned int base)
646 {
647         unsigned int f = (base * freq) / 192;   /* Mhz */
648         if (f < 40)
649                 return 0;       /* 33Mhz slot */
650         if (f < 45)
651                 return 1;       /* 40Mhz slot */
652         if (f < 55)
653                 return 2;       /* 50Mhz slot */
654         return 3;               /* 60Mhz slot */
655 }
656
657 /**
658  *      hpt37x_calibrate_dpll           -       Calibrate the DPLL loop
659  *      @dev: PCI device
660  *
661  *      Perform a calibration cycle on the HPT37x DPLL. Returns 1 if this
662  *      succeeds
663  */
664
665 static int hpt37x_calibrate_dpll(struct pci_dev *dev)
666 {
667         u8 reg5b;
668         u32 reg5c;
669         int tries;
670
671         for(tries = 0; tries < 0x5000; tries++) {
672                 udelay(50);
673                 pci_read_config_byte(dev, 0x5b, &reg5b);
674                 if (reg5b & 0x80) {
675                         /* See if it stays set */
676                         for(tries = 0; tries < 0x1000; tries ++) {
677                                 pci_read_config_byte(dev, 0x5b, &reg5b);
678                                 /* Failed ? */
679                                 if ((reg5b & 0x80) == 0)
680                                         return 0;
681                         }
682                         /* Turn off tuning, we have the DPLL set */
683                         pci_read_config_dword(dev, 0x5c, &reg5c);
684                         pci_write_config_dword(dev, 0x5c, reg5c & ~ 0x100);
685                         return 1;
686                 }
687         }
688         /* Never went stable */
689         return 0;
690 }
691
692 static u32 hpt374_read_freq(struct pci_dev *pdev)
693 {
694         u32 freq;
695         unsigned long io_base = pci_resource_start(pdev, 4);
696         if (PCI_FUNC(pdev->devfn) & 1) {
697                 struct pci_dev *pdev_0;
698
699                 pdev_0 = pci_get_slot(pdev->bus, pdev->devfn - 1);
700                 /* Someone hot plugged the controller on us ? */
701                 if (pdev_0 == NULL)
702                         return 0;
703                 io_base = pci_resource_start(pdev_0, 4);
704                 freq = inl(io_base + 0x90);
705                 pci_dev_put(pdev_0);
706         } else
707                 freq = inl(io_base + 0x90);
708         return freq;
709 }
710
711 /**
712  *      hpt37x_init_one         -       Initialise an HPT37X/302
713  *      @dev: PCI device
714  *      @id: Entry in match table
715  *
716  *      Initialise an HPT37x device. There are some interesting complications
717  *      here. Firstly the chip may report 366 and be one of several variants.
718  *      Secondly all the timings depend on the clock for the chip which we must
719  *      detect and look up
720  *
721  *      This is the known chip mappings. It may be missing a couple of later
722  *      releases.
723  *
724  *      Chip version            PCI             Rev     Notes
725  *      HPT366                  4 (HPT366)      0       Other driver
726  *      HPT366                  4 (HPT366)      1       Other driver
727  *      HPT368                  4 (HPT366)      2       Other driver
728  *      HPT370                  4 (HPT366)      3       UDMA100
729  *      HPT370A                 4 (HPT366)      4       UDMA100
730  *      HPT372                  4 (HPT366)      5       UDMA133 (1)
731  *      HPT372N                 4 (HPT366)      6       Other driver
732  *      HPT372A                 5 (HPT372)      1       UDMA133 (1)
733  *      HPT372N                 5 (HPT372)      2       Other driver
734  *      HPT302                  6 (HPT302)      1       UDMA133
735  *      HPT302N                 6 (HPT302)      2       Other driver
736  *      HPT371                  7 (HPT371)      *       UDMA133
737  *      HPT374                  8 (HPT374)      *       UDMA133 4 channel
738  *      HPT372N                 9 (HPT372N)     *       Other driver
739  *
740  *      (1) UDMA133 support depends on the bus clock
741  */
742
743 static int hpt37x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
744 {
745         /* HPT370 - UDMA100 */
746         static const struct ata_port_info info_hpt370 = {
747                 .flags = ATA_FLAG_SLAVE_POSS,
748                 .pio_mask = ATA_PIO4,
749                 .mwdma_mask = ATA_MWDMA2,
750                 .udma_mask = ATA_UDMA5,
751                 .port_ops = &hpt370_port_ops
752         };
753         /* HPT370A - UDMA100 */
754         static const struct ata_port_info info_hpt370a = {
755                 .flags = ATA_FLAG_SLAVE_POSS,
756                 .pio_mask = ATA_PIO4,
757                 .mwdma_mask = ATA_MWDMA2,
758                 .udma_mask = ATA_UDMA5,
759                 .port_ops = &hpt370a_port_ops
760         };
761         /* HPT370 - UDMA100 */
762         static const struct ata_port_info info_hpt370_33 = {
763                 .flags = ATA_FLAG_SLAVE_POSS,
764                 .pio_mask = ATA_PIO4,
765                 .mwdma_mask = ATA_MWDMA2,
766                 .udma_mask = ATA_UDMA5,
767                 .port_ops = &hpt370_port_ops
768         };
769         /* HPT370A - UDMA100 */
770         static const struct ata_port_info info_hpt370a_33 = {
771                 .flags = ATA_FLAG_SLAVE_POSS,
772                 .pio_mask = ATA_PIO4,
773                 .mwdma_mask = ATA_MWDMA2,
774                 .udma_mask = ATA_UDMA5,
775                 .port_ops = &hpt370a_port_ops
776         };
777         /* HPT371, 372 and friends - UDMA133 */
778         static const struct ata_port_info info_hpt372 = {
779                 .flags = ATA_FLAG_SLAVE_POSS,
780                 .pio_mask = ATA_PIO4,
781                 .mwdma_mask = ATA_MWDMA2,
782                 .udma_mask = ATA_UDMA6,
783                 .port_ops = &hpt372_port_ops
784         };
785         /* HPT374 - UDMA100, function 1 uses different prereset method */
786         static const struct ata_port_info info_hpt374_fn0 = {
787                 .flags = ATA_FLAG_SLAVE_POSS,
788                 .pio_mask = ATA_PIO4,
789                 .mwdma_mask = ATA_MWDMA2,
790                 .udma_mask = ATA_UDMA5,
791                 .port_ops = &hpt372_port_ops
792         };
793         static const struct ata_port_info info_hpt374_fn1 = {
794                 .flags = ATA_FLAG_SLAVE_POSS,
795                 .pio_mask = ATA_PIO4,
796                 .mwdma_mask = ATA_MWDMA2,
797                 .udma_mask = ATA_UDMA5,
798                 .port_ops = &hpt374_fn1_port_ops
799         };
800
801         static const int MHz[4] = { 33, 40, 50, 66 };
802         void *private_data = NULL;
803         const struct ata_port_info *ppi[] = { NULL, NULL };
804
805         u8 irqmask;
806         u32 class_rev;
807         u8 mcr1;
808         u32 freq;
809         int prefer_dpll = 1;
810
811         unsigned long iobase = pci_resource_start(dev, 4);
812
813         const struct hpt_chip *chip_table;
814         int clock_slot;
815         int rc;
816
817         rc = pcim_enable_device(dev);
818         if (rc)
819                 return rc;
820
821         pci_read_config_dword(dev, PCI_CLASS_REVISION, &class_rev);
822         class_rev &= 0xFF;
823
824         if (dev->device == PCI_DEVICE_ID_TTI_HPT366) {
825                 /* May be a later chip in disguise. Check */
826                 /* Older chips are in the HPT366 driver. Ignore them */
827                 if (class_rev < 3)
828                         return -ENODEV;
829                 /* N series chips have their own driver. Ignore */
830                 if (class_rev == 6)
831                         return -ENODEV;
832
833                 switch(class_rev) {
834                         case 3:
835                                 ppi[0] = &info_hpt370;
836                                 chip_table = &hpt370;
837                                 prefer_dpll = 0;
838                                 break;
839                         case 4:
840                                 ppi[0] = &info_hpt370a;
841                                 chip_table = &hpt370a;
842                                 prefer_dpll = 0;
843                                 break;
844                         case 5:
845                                 ppi[0] = &info_hpt372;
846                                 chip_table = &hpt372;
847                                 break;
848                         default:
849                                 printk(KERN_ERR "pata_hpt37x: Unknown HPT366 subtype please report (%d).\n", class_rev);
850                                 return -ENODEV;
851                 }
852         } else {
853                 switch(dev->device) {
854                         case PCI_DEVICE_ID_TTI_HPT372:
855                                 /* 372N if rev >= 2*/
856                                 if (class_rev >= 2)
857                                         return -ENODEV;
858                                 ppi[0] = &info_hpt372;
859                                 chip_table = &hpt372a;
860                                 break;
861                         case PCI_DEVICE_ID_TTI_HPT302:
862                                 /* 302N if rev > 1 */
863                                 if (class_rev > 1)
864                                         return -ENODEV;
865                                 ppi[0] = &info_hpt372;
866                                 /* Check this */
867                                 chip_table = &hpt302;
868                                 break;
869                         case PCI_DEVICE_ID_TTI_HPT371:
870                                 if (class_rev > 1)
871                                         return -ENODEV;
872                                 ppi[0] = &info_hpt372;
873                                 chip_table = &hpt371;
874                                 /* Single channel device, master is not present
875                                    but the BIOS (or us for non x86) must mark it
876                                    absent */
877                                 pci_read_config_byte(dev, 0x50, &mcr1);
878                                 mcr1 &= ~0x04;
879                                 pci_write_config_byte(dev, 0x50, mcr1);
880                                 break;
881                         case PCI_DEVICE_ID_TTI_HPT374:
882                                 chip_table = &hpt374;
883                                 if (!(PCI_FUNC(dev->devfn) & 1))
884                                         *ppi = &info_hpt374_fn0;
885                                 else
886                                         *ppi = &info_hpt374_fn1;
887                                 break;
888                         default:
889                                 printk(KERN_ERR "pata_hpt37x: PCI table is bogus please report (%d).\n", dev->device);
890                                 return -ENODEV;
891                 }
892         }
893         /* Ok so this is a chip we support */
894
895         pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, (L1_CACHE_BYTES / 4));
896         pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x78);
897         pci_write_config_byte(dev, PCI_MIN_GNT, 0x08);
898         pci_write_config_byte(dev, PCI_MAX_LAT, 0x08);
899
900         pci_read_config_byte(dev, 0x5A, &irqmask);
901         irqmask &= ~0x10;
902         pci_write_config_byte(dev, 0x5a, irqmask);
903
904         /*
905          * default to pci clock. make sure MA15/16 are set to output
906          * to prevent drives having problems with 40-pin cables. Needed
907          * for some drives such as IBM-DTLA which will not enter ready
908          * state on reset when PDIAG is a input.
909          */
910
911         pci_write_config_byte(dev, 0x5b, 0x23);
912
913         /*
914          * HighPoint does this for HPT372A.
915          * NOTE: This register is only writeable via I/O space.
916          */
917         if (chip_table == &hpt372a)
918                 outb(0x0e, iobase + 0x9c);
919
920         /* Some devices do not let this value be accessed via PCI space
921            according to the old driver. In addition we must use the value
922            from FN 0 on the HPT374 */
923
924         if (chip_table == &hpt374) {
925                 freq = hpt374_read_freq(dev);
926                 if (freq == 0)
927                         return -ENODEV;
928         } else
929                 freq = inl(iobase + 0x90);
930
931         if ((freq >> 12) != 0xABCDE) {
932                 int i;
933                 u8 sr;
934                 u32 total = 0;
935
936                 printk(KERN_WARNING "pata_hpt37x: BIOS has not set timing clocks.\n");
937
938                 /* This is the process the HPT371 BIOS is reported to use */
939                 for(i = 0; i < 128; i++) {
940                         pci_read_config_byte(dev, 0x78, &sr);
941                         total += sr & 0x1FF;
942                         udelay(15);
943                 }
944                 freq = total / 128;
945         }
946         freq &= 0x1FF;
947
948         /*
949          *      Turn the frequency check into a band and then find a timing
950          *      table to match it.
951          */
952
953         clock_slot = hpt37x_clock_slot(freq, chip_table->base);
954         if (chip_table->clocks[clock_slot] == NULL || prefer_dpll) {
955                 /*
956                  *      We need to try PLL mode instead
957                  *
958                  *      For non UDMA133 capable devices we should
959                  *      use a 50MHz DPLL by choice
960                  */
961                 unsigned int f_low, f_high;
962                 int dpll, adjust;
963
964                 /* Compute DPLL */
965                 dpll = (ppi[0]->udma_mask & 0xC0) ? 3 : 2;
966
967                 f_low = (MHz[clock_slot] * 48) / MHz[dpll];
968                 f_high = f_low + 2;
969                 if (clock_slot > 1)
970                         f_high += 2;
971
972                 /* Select the DPLL clock. */
973                 pci_write_config_byte(dev, 0x5b, 0x21);
974                 pci_write_config_dword(dev, 0x5C, (f_high << 16) | f_low | 0x100);
975
976                 for(adjust = 0; adjust < 8; adjust++) {
977                         if (hpt37x_calibrate_dpll(dev))
978                                 break;
979                         /* See if it'll settle at a fractionally different clock */
980                         if (adjust & 1)
981                                 f_low -= adjust >> 1;
982                         else
983                                 f_high += adjust >> 1;
984                         pci_write_config_dword(dev, 0x5C, (f_high << 16) | f_low | 0x100);
985                 }
986                 if (adjust == 8) {
987                         printk(KERN_ERR "pata_hpt37x: DPLL did not stabilize!\n");
988                         return -ENODEV;
989                 }
990                 if (dpll == 3)
991                         private_data = (void *)hpt37x_timings_66;
992                 else
993                         private_data = (void *)hpt37x_timings_50;
994
995                 printk(KERN_INFO "pata_hpt37x: bus clock %dMHz, using %dMHz DPLL.\n",
996                        MHz[clock_slot], MHz[dpll]);
997         } else {
998                 private_data = (void *)chip_table->clocks[clock_slot];
999                 /*
1000                  *      Perform a final fixup. Note that we will have used the
1001                  *      DPLL on the HPT372 which means we don't have to worry
1002                  *      about lack of UDMA133 support on lower clocks
1003                  */
1004
1005                 if (clock_slot < 2 && ppi[0] == &info_hpt370)
1006                         ppi[0] = &info_hpt370_33;
1007                 if (clock_slot < 2 && ppi[0] == &info_hpt370a)
1008                         ppi[0] = &info_hpt370a_33;
1009                 printk(KERN_INFO "pata_hpt37x: %s using %dMHz bus clock.\n",
1010                        chip_table->name, MHz[clock_slot]);
1011         }
1012
1013         /* Now kick off ATA set up */
1014         return ata_pci_sff_init_one(dev, ppi, &hpt37x_sht, private_data);
1015 }
1016
1017 static const struct pci_device_id hpt37x[] = {
1018         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT366), },
1019         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT371), },
1020         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT372), },
1021         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT374), },
1022         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT302), },
1023
1024         { },
1025 };
1026
1027 static struct pci_driver hpt37x_pci_driver = {
1028         .name           = DRV_NAME,
1029         .id_table       = hpt37x,
1030         .probe          = hpt37x_init_one,
1031         .remove         = ata_pci_remove_one
1032 };
1033
1034 static int __init hpt37x_init(void)
1035 {
1036         return pci_register_driver(&hpt37x_pci_driver);
1037 }
1038
1039 static void __exit hpt37x_exit(void)
1040 {
1041         pci_unregister_driver(&hpt37x_pci_driver);
1042 }
1043
1044 MODULE_AUTHOR("Alan Cox");
1045 MODULE_DESCRIPTION("low-level driver for the Highpoint HPT37x/30x");
1046 MODULE_LICENSE("GPL");
1047 MODULE_DEVICE_TABLE(pci, hpt37x);
1048 MODULE_VERSION(DRV_VERSION);
1049
1050 module_init(hpt37x_init);
1051 module_exit(hpt37x_exit);