pata_hpt37x: unify ->pre_reset methods
[linux-2.6.git] / 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         /* Cable register now active */
320         pci_read_config_byte(pdev, 0x5A, &ata66);
321         /* Restore state */
322         pci_write_config_byte(pdev, 0x5B, scr2);
323
324         if (ata66 & (2 >> ap->port_no))
325                 return ATA_CBL_PATA40;
326         else
327                 return ATA_CBL_PATA80;
328 }
329
330 /**
331  *      hpt374_fn1_cable_detect -       Detect the cable type
332  *      @ap: ATA port to detect on
333  *
334  *      Return the cable type attached to this port
335  */
336
337 static int hpt374_fn1_cable_detect(struct ata_port *ap)
338 {
339         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
340         unsigned int mcrbase = 0x50 + 4 * ap->port_no;
341         u16 mcr3;
342         u8 ata66;
343
344         /* Do the extra channel work */
345         pci_read_config_word(pdev, mcrbase + 2, &mcr3);
346         /* Set bit 15 of 0x52 to enable TCBLID as input */
347         pci_write_config_word(pdev, mcrbase + 2, mcr3 | 0x8000);
348         pci_read_config_byte(pdev, 0x5A, &ata66);
349         /* Reset TCBLID/FCBLID to output */
350         pci_write_config_word(pdev, mcrbase + 2, mcr3);
351
352         if (ata66 & (2 >> ap->port_no))
353                 return ATA_CBL_PATA40;
354         else
355                 return ATA_CBL_PATA80;
356 }
357
358 /**
359  *      hpt37x_pre_reset        -       reset the hpt37x bus
360  *      @link: ATA link to reset
361  *      @deadline: deadline jiffies for the operation
362  *
363  *      Perform the initial reset handling for the HPT37x.
364  */
365
366 static int hpt37x_pre_reset(struct ata_link *link, unsigned long deadline)
367 {
368         struct ata_port *ap = link->ap;
369         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
370         static const struct pci_bits hpt37x_enable_bits[] = {
371                 { 0x50, 1, 0x04, 0x04 },
372                 { 0x54, 1, 0x04, 0x04 }
373         };
374         if (!pci_test_config_bits(pdev, &hpt37x_enable_bits[ap->port_no]))
375                 return -ENOENT;
376
377         /* Reset the state machine */
378         pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
379         udelay(100);
380
381         return ata_sff_prereset(link, deadline);
382 }
383
384 /**
385  *      hpt370_set_piomode              -       PIO setup
386  *      @ap: ATA interface
387  *      @adev: device on the interface
388  *
389  *      Perform PIO mode setup.
390  */
391
392 static void hpt370_set_piomode(struct ata_port *ap, struct ata_device *adev)
393 {
394         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
395         u32 addr1, addr2;
396         u32 reg;
397         u32 mode;
398         u8 fast;
399
400         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
401         addr2 = 0x51 + 4 * ap->port_no;
402
403         /* Fast interrupt prediction disable, hold off interrupt disable */
404         pci_read_config_byte(pdev, addr2, &fast);
405         fast &= ~0x02;
406         fast |= 0x01;
407         pci_write_config_byte(pdev, addr2, fast);
408
409         pci_read_config_dword(pdev, addr1, &reg);
410         mode = hpt37x_find_mode(ap, adev->pio_mode);
411         mode &= ~0x8000000;     /* No FIFO in PIO */
412         mode &= ~0x30070000;    /* Leave config bits alone */
413         reg &= 0x30070000;      /* Strip timing bits */
414         pci_write_config_dword(pdev, addr1, reg | mode);
415 }
416
417 /**
418  *      hpt370_set_dmamode              -       DMA timing setup
419  *      @ap: ATA interface
420  *      @adev: Device being configured
421  *
422  *      Set up the channel for MWDMA or UDMA modes. Much the same as with
423  *      PIO, load the mode number and then set MWDMA or UDMA flag.
424  */
425
426 static void hpt370_set_dmamode(struct ata_port *ap, struct ata_device *adev)
427 {
428         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
429         u32 addr1, addr2;
430         u32 reg;
431         u32 mode;
432         u8 fast;
433
434         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
435         addr2 = 0x51 + 4 * ap->port_no;
436
437         /* Fast interrupt prediction disable, hold off interrupt disable */
438         pci_read_config_byte(pdev, addr2, &fast);
439         fast &= ~0x02;
440         fast |= 0x01;
441         pci_write_config_byte(pdev, addr2, fast);
442
443         pci_read_config_dword(pdev, addr1, &reg);
444         mode = hpt37x_find_mode(ap, adev->dma_mode);
445         mode |= 0x8000000;      /* FIFO in MWDMA or UDMA */
446         mode &= ~0xC0000000;    /* Leave config bits alone */
447         reg &= 0xC0000000;      /* Strip timing bits */
448         pci_write_config_dword(pdev, addr1, reg | mode);
449 }
450
451 /**
452  *      hpt370_bmdma_end                -       DMA engine stop
453  *      @qc: ATA command
454  *
455  *      Work around the HPT370 DMA engine.
456  */
457
458 static void hpt370_bmdma_stop(struct ata_queued_cmd *qc)
459 {
460         struct ata_port *ap = qc->ap;
461         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
462         u8 dma_stat = ioread8(ap->ioaddr.bmdma_addr + 2);
463         u8 dma_cmd;
464         void __iomem *bmdma = ap->ioaddr.bmdma_addr;
465
466         if (dma_stat & 0x01) {
467                 udelay(20);
468                 dma_stat = ioread8(bmdma + 2);
469         }
470         if (dma_stat & 0x01) {
471                 /* Clear the engine */
472                 pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
473                 udelay(10);
474                 /* Stop DMA */
475                 dma_cmd = ioread8(bmdma );
476                 iowrite8(dma_cmd & 0xFE, bmdma);
477                 /* Clear Error */
478                 dma_stat = ioread8(bmdma + 2);
479                 iowrite8(dma_stat | 0x06 , bmdma + 2);
480                 /* Clear the engine */
481                 pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
482                 udelay(10);
483         }
484         ata_bmdma_stop(qc);
485 }
486
487 /**
488  *      hpt372_set_piomode              -       PIO setup
489  *      @ap: ATA interface
490  *      @adev: device on the interface
491  *
492  *      Perform PIO mode setup.
493  */
494
495 static void hpt372_set_piomode(struct ata_port *ap, struct ata_device *adev)
496 {
497         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
498         u32 addr1, addr2;
499         u32 reg;
500         u32 mode;
501         u8 fast;
502
503         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
504         addr2 = 0x51 + 4 * ap->port_no;
505
506         /* Fast interrupt prediction disable, hold off interrupt disable */
507         pci_read_config_byte(pdev, addr2, &fast);
508         fast &= ~0x07;
509         pci_write_config_byte(pdev, addr2, fast);
510
511         pci_read_config_dword(pdev, addr1, &reg);
512         mode = hpt37x_find_mode(ap, adev->pio_mode);
513
514         printk("Find mode for %d reports %X\n", adev->pio_mode, mode);
515         mode &= ~0x80000000;    /* No FIFO in PIO */
516         mode &= ~0x30070000;    /* Leave config bits alone */
517         reg &= 0x30070000;      /* Strip timing bits */
518         pci_write_config_dword(pdev, addr1, reg | mode);
519 }
520
521 /**
522  *      hpt372_set_dmamode              -       DMA timing setup
523  *      @ap: ATA interface
524  *      @adev: Device being configured
525  *
526  *      Set up the channel for MWDMA or UDMA modes. Much the same as with
527  *      PIO, load the mode number and then set MWDMA or UDMA flag.
528  */
529
530 static void hpt372_set_dmamode(struct ata_port *ap, struct ata_device *adev)
531 {
532         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
533         u32 addr1, addr2;
534         u32 reg;
535         u32 mode;
536         u8 fast;
537
538         addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
539         addr2 = 0x51 + 4 * ap->port_no;
540
541         /* Fast interrupt prediction disable, hold off interrupt disable */
542         pci_read_config_byte(pdev, addr2, &fast);
543         fast &= ~0x07;
544         pci_write_config_byte(pdev, addr2, fast);
545
546         pci_read_config_dword(pdev, addr1, &reg);
547         mode = hpt37x_find_mode(ap, adev->dma_mode);
548         printk("Find mode for DMA %d reports %X\n", adev->dma_mode, mode);
549         mode &= ~0xC0000000;    /* Leave config bits alone */
550         mode |= 0x80000000;     /* FIFO in MWDMA or UDMA */
551         reg &= 0xC0000000;      /* Strip timing bits */
552         pci_write_config_dword(pdev, addr1, reg | mode);
553 }
554
555 /**
556  *      hpt37x_bmdma_end                -       DMA engine stop
557  *      @qc: ATA command
558  *
559  *      Clean up after the HPT372 and later DMA engine
560  */
561
562 static void hpt37x_bmdma_stop(struct ata_queued_cmd *qc)
563 {
564         struct ata_port *ap = qc->ap;
565         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
566         int mscreg = 0x50 + 4 * ap->port_no;
567         u8 bwsr_stat, msc_stat;
568
569         pci_read_config_byte(pdev, 0x6A, &bwsr_stat);
570         pci_read_config_byte(pdev, mscreg, &msc_stat);
571         if (bwsr_stat & (1 << ap->port_no))
572                 pci_write_config_byte(pdev, mscreg, msc_stat | 0x30);
573         ata_bmdma_stop(qc);
574 }
575
576
577 static struct scsi_host_template hpt37x_sht = {
578         ATA_BMDMA_SHT(DRV_NAME),
579 };
580
581 /*
582  *      Configuration for HPT370
583  */
584
585 static struct ata_port_operations hpt370_port_ops = {
586         .inherits       = &ata_bmdma_port_ops,
587
588         .bmdma_stop     = hpt370_bmdma_stop,
589
590         .mode_filter    = hpt370_filter,
591         .cable_detect   = hpt37x_cable_detect,
592         .set_piomode    = hpt370_set_piomode,
593         .set_dmamode    = hpt370_set_dmamode,
594         .prereset       = hpt37x_pre_reset,
595 };
596
597 /*
598  *      Configuration for HPT370A. Close to 370 but less filters
599  */
600
601 static struct ata_port_operations hpt370a_port_ops = {
602         .inherits       = &hpt370_port_ops,
603         .mode_filter    = hpt370a_filter,
604 };
605
606 /*
607  *      Configuration for HPT372, HPT371, HPT302. Slightly different PIO
608  *      and DMA mode setting functionality.
609  */
610
611 static struct ata_port_operations hpt372_port_ops = {
612         .inherits       = &ata_bmdma_port_ops,
613
614         .bmdma_stop     = hpt37x_bmdma_stop,
615
616         .cable_detect   = hpt37x_cable_detect,
617         .set_piomode    = hpt372_set_piomode,
618         .set_dmamode    = hpt372_set_dmamode,
619         .prereset       = hpt37x_pre_reset,
620 };
621
622 /*
623  *      Configuration for HPT374. Mode setting works like 372 and friends
624  *      but we have a different cable detection procedure for function 1.
625  */
626
627 static struct ata_port_operations hpt374_fn1_port_ops = {
628         .inherits       = &hpt372_port_ops,
629         .cable_detect   = hpt374_fn1_cable_detect,
630         .prereset       = hpt37x_pre_reset,
631 };
632
633 /**
634  *      hpt37x_clock_slot       -       Turn timing to PC clock entry
635  *      @freq: Reported frequency timing
636  *      @base: Base timing
637  *
638  *      Turn the timing data intoa clock slot (0 for 33, 1 for 40, 2 for 50
639  *      and 3 for 66Mhz)
640  */
641
642 static int hpt37x_clock_slot(unsigned int freq, unsigned int base)
643 {
644         unsigned int f = (base * freq) / 192;   /* Mhz */
645         if (f < 40)
646                 return 0;       /* 33Mhz slot */
647         if (f < 45)
648                 return 1;       /* 40Mhz slot */
649         if (f < 55)
650                 return 2;       /* 50Mhz slot */
651         return 3;               /* 60Mhz slot */
652 }
653
654 /**
655  *      hpt37x_calibrate_dpll           -       Calibrate the DPLL loop
656  *      @dev: PCI device
657  *
658  *      Perform a calibration cycle on the HPT37x DPLL. Returns 1 if this
659  *      succeeds
660  */
661
662 static int hpt37x_calibrate_dpll(struct pci_dev *dev)
663 {
664         u8 reg5b;
665         u32 reg5c;
666         int tries;
667
668         for(tries = 0; tries < 0x5000; tries++) {
669                 udelay(50);
670                 pci_read_config_byte(dev, 0x5b, &reg5b);
671                 if (reg5b & 0x80) {
672                         /* See if it stays set */
673                         for(tries = 0; tries < 0x1000; tries ++) {
674                                 pci_read_config_byte(dev, 0x5b, &reg5b);
675                                 /* Failed ? */
676                                 if ((reg5b & 0x80) == 0)
677                                         return 0;
678                         }
679                         /* Turn off tuning, we have the DPLL set */
680                         pci_read_config_dword(dev, 0x5c, &reg5c);
681                         pci_write_config_dword(dev, 0x5c, reg5c & ~ 0x100);
682                         return 1;
683                 }
684         }
685         /* Never went stable */
686         return 0;
687 }
688
689 static u32 hpt374_read_freq(struct pci_dev *pdev)
690 {
691         u32 freq;
692         unsigned long io_base = pci_resource_start(pdev, 4);
693         if (PCI_FUNC(pdev->devfn) & 1) {
694                 struct pci_dev *pdev_0;
695
696                 pdev_0 = pci_get_slot(pdev->bus, pdev->devfn - 1);
697                 /* Someone hot plugged the controller on us ? */
698                 if (pdev_0 == NULL)
699                         return 0;
700                 io_base = pci_resource_start(pdev_0, 4);
701                 freq = inl(io_base + 0x90);
702                 pci_dev_put(pdev_0);
703         } else
704                 freq = inl(io_base + 0x90);
705         return freq;
706 }
707
708 /**
709  *      hpt37x_init_one         -       Initialise an HPT37X/302
710  *      @dev: PCI device
711  *      @id: Entry in match table
712  *
713  *      Initialise an HPT37x device. There are some interesting complications
714  *      here. Firstly the chip may report 366 and be one of several variants.
715  *      Secondly all the timings depend on the clock for the chip which we must
716  *      detect and look up
717  *
718  *      This is the known chip mappings. It may be missing a couple of later
719  *      releases.
720  *
721  *      Chip version            PCI             Rev     Notes
722  *      HPT366                  4 (HPT366)      0       Other driver
723  *      HPT366                  4 (HPT366)      1       Other driver
724  *      HPT368                  4 (HPT366)      2       Other driver
725  *      HPT370                  4 (HPT366)      3       UDMA100
726  *      HPT370A                 4 (HPT366)      4       UDMA100
727  *      HPT372                  4 (HPT366)      5       UDMA133 (1)
728  *      HPT372N                 4 (HPT366)      6       Other driver
729  *      HPT372A                 5 (HPT372)      1       UDMA133 (1)
730  *      HPT372N                 5 (HPT372)      2       Other driver
731  *      HPT302                  6 (HPT302)      1       UDMA133
732  *      HPT302N                 6 (HPT302)      2       Other driver
733  *      HPT371                  7 (HPT371)      *       UDMA133
734  *      HPT374                  8 (HPT374)      *       UDMA133 4 channel
735  *      HPT372N                 9 (HPT372N)     *       Other driver
736  *
737  *      (1) UDMA133 support depends on the bus clock
738  */
739
740 static int hpt37x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
741 {
742         /* HPT370 - UDMA100 */
743         static const struct ata_port_info info_hpt370 = {
744                 .flags = ATA_FLAG_SLAVE_POSS,
745                 .pio_mask = ATA_PIO4,
746                 .mwdma_mask = ATA_MWDMA2,
747                 .udma_mask = ATA_UDMA5,
748                 .port_ops = &hpt370_port_ops
749         };
750         /* HPT370A - UDMA100 */
751         static const struct ata_port_info info_hpt370a = {
752                 .flags = ATA_FLAG_SLAVE_POSS,
753                 .pio_mask = ATA_PIO4,
754                 .mwdma_mask = ATA_MWDMA2,
755                 .udma_mask = ATA_UDMA5,
756                 .port_ops = &hpt370a_port_ops
757         };
758         /* HPT370 - UDMA100 */
759         static const struct ata_port_info info_hpt370_33 = {
760                 .flags = ATA_FLAG_SLAVE_POSS,
761                 .pio_mask = ATA_PIO4,
762                 .mwdma_mask = ATA_MWDMA2,
763                 .udma_mask = ATA_UDMA5,
764                 .port_ops = &hpt370_port_ops
765         };
766         /* HPT370A - UDMA100 */
767         static const struct ata_port_info info_hpt370a_33 = {
768                 .flags = ATA_FLAG_SLAVE_POSS,
769                 .pio_mask = ATA_PIO4,
770                 .mwdma_mask = ATA_MWDMA2,
771                 .udma_mask = ATA_UDMA5,
772                 .port_ops = &hpt370a_port_ops
773         };
774         /* HPT371, 372 and friends - UDMA133 */
775         static const struct ata_port_info info_hpt372 = {
776                 .flags = ATA_FLAG_SLAVE_POSS,
777                 .pio_mask = ATA_PIO4,
778                 .mwdma_mask = ATA_MWDMA2,
779                 .udma_mask = ATA_UDMA6,
780                 .port_ops = &hpt372_port_ops
781         };
782         /* HPT374 - UDMA100, function 1 uses different prereset method */
783         static const struct ata_port_info info_hpt374_fn0 = {
784                 .flags = ATA_FLAG_SLAVE_POSS,
785                 .pio_mask = ATA_PIO4,
786                 .mwdma_mask = ATA_MWDMA2,
787                 .udma_mask = ATA_UDMA5,
788                 .port_ops = &hpt372_port_ops
789         };
790         static const struct ata_port_info info_hpt374_fn1 = {
791                 .flags = ATA_FLAG_SLAVE_POSS,
792                 .pio_mask = ATA_PIO4,
793                 .mwdma_mask = ATA_MWDMA2,
794                 .udma_mask = ATA_UDMA5,
795                 .port_ops = &hpt374_fn1_port_ops
796         };
797
798         static const int MHz[4] = { 33, 40, 50, 66 };
799         void *private_data = NULL;
800         const struct ata_port_info *ppi[] = { NULL, NULL };
801
802         u8 irqmask;
803         u32 class_rev;
804         u8 mcr1;
805         u32 freq;
806         int prefer_dpll = 1;
807
808         unsigned long iobase = pci_resource_start(dev, 4);
809
810         const struct hpt_chip *chip_table;
811         int clock_slot;
812         int rc;
813
814         rc = pcim_enable_device(dev);
815         if (rc)
816                 return rc;
817
818         pci_read_config_dword(dev, PCI_CLASS_REVISION, &class_rev);
819         class_rev &= 0xFF;
820
821         if (dev->device == PCI_DEVICE_ID_TTI_HPT366) {
822                 /* May be a later chip in disguise. Check */
823                 /* Older chips are in the HPT366 driver. Ignore them */
824                 if (class_rev < 3)
825                         return -ENODEV;
826                 /* N series chips have their own driver. Ignore */
827                 if (class_rev == 6)
828                         return -ENODEV;
829
830                 switch(class_rev) {
831                         case 3:
832                                 ppi[0] = &info_hpt370;
833                                 chip_table = &hpt370;
834                                 prefer_dpll = 0;
835                                 break;
836                         case 4:
837                                 ppi[0] = &info_hpt370a;
838                                 chip_table = &hpt370a;
839                                 prefer_dpll = 0;
840                                 break;
841                         case 5:
842                                 ppi[0] = &info_hpt372;
843                                 chip_table = &hpt372;
844                                 break;
845                         default:
846                                 printk(KERN_ERR "pata_hpt37x: Unknown HPT366 subtype please report (%d).\n", class_rev);
847                                 return -ENODEV;
848                 }
849         } else {
850                 switch(dev->device) {
851                         case PCI_DEVICE_ID_TTI_HPT372:
852                                 /* 372N if rev >= 2*/
853                                 if (class_rev >= 2)
854                                         return -ENODEV;
855                                 ppi[0] = &info_hpt372;
856                                 chip_table = &hpt372a;
857                                 break;
858                         case PCI_DEVICE_ID_TTI_HPT302:
859                                 /* 302N if rev > 1 */
860                                 if (class_rev > 1)
861                                         return -ENODEV;
862                                 ppi[0] = &info_hpt372;
863                                 /* Check this */
864                                 chip_table = &hpt302;
865                                 break;
866                         case PCI_DEVICE_ID_TTI_HPT371:
867                                 if (class_rev > 1)
868                                         return -ENODEV;
869                                 ppi[0] = &info_hpt372;
870                                 chip_table = &hpt371;
871                                 /* Single channel device, master is not present
872                                    but the BIOS (or us for non x86) must mark it
873                                    absent */
874                                 pci_read_config_byte(dev, 0x50, &mcr1);
875                                 mcr1 &= ~0x04;
876                                 pci_write_config_byte(dev, 0x50, mcr1);
877                                 break;
878                         case PCI_DEVICE_ID_TTI_HPT374:
879                                 chip_table = &hpt374;
880                                 if (!(PCI_FUNC(dev->devfn) & 1))
881                                         *ppi = &info_hpt374_fn0;
882                                 else
883                                         *ppi = &info_hpt374_fn1;
884                                 break;
885                         default:
886                                 printk(KERN_ERR "pata_hpt37x: PCI table is bogus please report (%d).\n", dev->device);
887                                 return -ENODEV;
888                 }
889         }
890         /* Ok so this is a chip we support */
891
892         pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, (L1_CACHE_BYTES / 4));
893         pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x78);
894         pci_write_config_byte(dev, PCI_MIN_GNT, 0x08);
895         pci_write_config_byte(dev, PCI_MAX_LAT, 0x08);
896
897         pci_read_config_byte(dev, 0x5A, &irqmask);
898         irqmask &= ~0x10;
899         pci_write_config_byte(dev, 0x5a, irqmask);
900
901         /*
902          * default to pci clock. make sure MA15/16 are set to output
903          * to prevent drives having problems with 40-pin cables. Needed
904          * for some drives such as IBM-DTLA which will not enter ready
905          * state on reset when PDIAG is a input.
906          */
907
908         pci_write_config_byte(dev, 0x5b, 0x23);
909
910         /*
911          * HighPoint does this for HPT372A.
912          * NOTE: This register is only writeable via I/O space.
913          */
914         if (chip_table == &hpt372a)
915                 outb(0x0e, iobase + 0x9c);
916
917         /* Some devices do not let this value be accessed via PCI space
918            according to the old driver. In addition we must use the value
919            from FN 0 on the HPT374 */
920
921         if (chip_table == &hpt374) {
922                 freq = hpt374_read_freq(dev);
923                 if (freq == 0)
924                         return -ENODEV;
925         } else
926                 freq = inl(iobase + 0x90);
927
928         if ((freq >> 12) != 0xABCDE) {
929                 int i;
930                 u8 sr;
931                 u32 total = 0;
932
933                 printk(KERN_WARNING "pata_hpt37x: BIOS has not set timing clocks.\n");
934
935                 /* This is the process the HPT371 BIOS is reported to use */
936                 for(i = 0; i < 128; i++) {
937                         pci_read_config_byte(dev, 0x78, &sr);
938                         total += sr & 0x1FF;
939                         udelay(15);
940                 }
941                 freq = total / 128;
942         }
943         freq &= 0x1FF;
944
945         /*
946          *      Turn the frequency check into a band and then find a timing
947          *      table to match it.
948          */
949
950         clock_slot = hpt37x_clock_slot(freq, chip_table->base);
951         if (chip_table->clocks[clock_slot] == NULL || prefer_dpll) {
952                 /*
953                  *      We need to try PLL mode instead
954                  *
955                  *      For non UDMA133 capable devices we should
956                  *      use a 50MHz DPLL by choice
957                  */
958                 unsigned int f_low, f_high;
959                 int dpll, adjust;
960
961                 /* Compute DPLL */
962                 dpll = (ppi[0]->udma_mask & 0xC0) ? 3 : 2;
963
964                 f_low = (MHz[clock_slot] * 48) / MHz[dpll];
965                 f_high = f_low + 2;
966                 if (clock_slot > 1)
967                         f_high += 2;
968
969                 /* Select the DPLL clock. */
970                 pci_write_config_byte(dev, 0x5b, 0x21);
971                 pci_write_config_dword(dev, 0x5C, (f_high << 16) | f_low | 0x100);
972
973                 for(adjust = 0; adjust < 8; adjust++) {
974                         if (hpt37x_calibrate_dpll(dev))
975                                 break;
976                         /* See if it'll settle at a fractionally different clock */
977                         if (adjust & 1)
978                                 f_low -= adjust >> 1;
979                         else
980                                 f_high += adjust >> 1;
981                         pci_write_config_dword(dev, 0x5C, (f_high << 16) | f_low | 0x100);
982                 }
983                 if (adjust == 8) {
984                         printk(KERN_ERR "pata_hpt37x: DPLL did not stabilize!\n");
985                         return -ENODEV;
986                 }
987                 if (dpll == 3)
988                         private_data = (void *)hpt37x_timings_66;
989                 else
990                         private_data = (void *)hpt37x_timings_50;
991
992                 printk(KERN_INFO "pata_hpt37x: bus clock %dMHz, using %dMHz DPLL.\n",
993                        MHz[clock_slot], MHz[dpll]);
994         } else {
995                 private_data = (void *)chip_table->clocks[clock_slot];
996                 /*
997                  *      Perform a final fixup. Note that we will have used the
998                  *      DPLL on the HPT372 which means we don't have to worry
999                  *      about lack of UDMA133 support on lower clocks
1000                  */
1001
1002                 if (clock_slot < 2 && ppi[0] == &info_hpt370)
1003                         ppi[0] = &info_hpt370_33;
1004                 if (clock_slot < 2 && ppi[0] == &info_hpt370a)
1005                         ppi[0] = &info_hpt370a_33;
1006                 printk(KERN_INFO "pata_hpt37x: %s using %dMHz bus clock.\n",
1007                        chip_table->name, MHz[clock_slot]);
1008         }
1009
1010         /* Now kick off ATA set up */
1011         return ata_pci_sff_init_one(dev, ppi, &hpt37x_sht, private_data);
1012 }
1013
1014 static const struct pci_device_id hpt37x[] = {
1015         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT366), },
1016         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT371), },
1017         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT372), },
1018         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT374), },
1019         { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT302), },
1020
1021         { },
1022 };
1023
1024 static struct pci_driver hpt37x_pci_driver = {
1025         .name           = DRV_NAME,
1026         .id_table       = hpt37x,
1027         .probe          = hpt37x_init_one,
1028         .remove         = ata_pci_remove_one
1029 };
1030
1031 static int __init hpt37x_init(void)
1032 {
1033         return pci_register_driver(&hpt37x_pci_driver);
1034 }
1035
1036 static void __exit hpt37x_exit(void)
1037 {
1038         pci_unregister_driver(&hpt37x_pci_driver);
1039 }
1040
1041 MODULE_AUTHOR("Alan Cox");
1042 MODULE_DESCRIPTION("low-level driver for the Highpoint HPT37x/30x");
1043 MODULE_LICENSE("GPL");
1044 MODULE_DEVICE_TABLE(pci, hpt37x);
1045 MODULE_VERSION(DRV_VERSION);
1046
1047 module_init(hpt37x_init);
1048 module_exit(hpt37x_exit);