Merge git://git.kernel.org/pub/scm/linux/kernel/git/mason/btrfs-unstable
[linux-2.6] / drivers / ata / pata_optidma.c
1 /*
2  * pata_optidma.c       - Opti DMA PATA for new ATA layer
3  *                        (C) 2006 Red Hat Inc
4  *
5  *      The Opti DMA controllers are related to the older PIO PCI controllers
6  *      and indeed the VLB ones. The main differences are that the timing
7  *      numbers are now based off PCI clocks not VLB and differ, and that
8  *      MWDMA is supported.
9  *
10  *      This driver should support Viper-N+, FireStar, FireStar Plus.
11  *
12  *      These devices support virtual DMA for read (aka the CS5520). Later
13  *      chips support UDMA33, but only if the rest of the board logic does,
14  *      so you have to get this right. We don't support the virtual DMA
15  *      but we do handle UDMA.
16  *
17  *      Bits that are worth knowing
18  *              Most control registers are shadowed into I/O registers
19  *              0x1F5 bit 0 tells you if the PCI/VLB clock is 33 or 25Mhz
20  *              Virtual DMA registers *move* between rev 0x02 and rev 0x10
21  *              UDMA requires a 66MHz FSB
22  *
23  */
24
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/pci.h>
28 #include <linux/init.h>
29 #include <linux/blkdev.h>
30 #include <linux/delay.h>
31 #include <scsi/scsi_host.h>
32 #include <linux/libata.h>
33
34 #define DRV_NAME "pata_optidma"
35 #define DRV_VERSION "0.3.2"
36
37 enum {
38         READ_REG        = 0,    /* index of Read cycle timing register */
39         WRITE_REG       = 1,    /* index of Write cycle timing register */
40         CNTRL_REG       = 3,    /* index of Control register */
41         STRAP_REG       = 5,    /* index of Strap register */
42         MISC_REG        = 6     /* index of Miscellaneous register */
43 };
44
45 static int pci_clock;   /* 0 = 33 1 = 25 */
46
47 /**
48  *      optidma_pre_reset               -       probe begin
49  *      @link: ATA link
50  *      @deadline: deadline jiffies for the operation
51  *
52  *      Set up cable type and use generic probe init
53  */
54
55 static int optidma_pre_reset(struct ata_link *link, unsigned long deadline)
56 {
57         struct ata_port *ap = link->ap;
58         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
59         static const struct pci_bits optidma_enable_bits = {
60                 0x40, 1, 0x08, 0x00
61         };
62
63         if (ap->port_no && !pci_test_config_bits(pdev, &optidma_enable_bits))
64                 return -ENOENT;
65
66         return ata_sff_prereset(link, deadline);
67 }
68
69 /**
70  *      optidma_unlock          -       unlock control registers
71  *      @ap: ATA port
72  *
73  *      Unlock the control register block for this adapter. Registers must not
74  *      be unlocked in a situation where libata might look at them.
75  */
76
77 static void optidma_unlock(struct ata_port *ap)
78 {
79         void __iomem *regio = ap->ioaddr.cmd_addr;
80
81         /* These 3 unlock the control register access */
82         ioread16(regio + 1);
83         ioread16(regio + 1);
84         iowrite8(3, regio + 2);
85 }
86
87 /**
88  *      optidma_lock            -       issue temporary relock
89  *      @ap: ATA port
90  *
91  *      Re-lock the configuration register settings.
92  */
93
94 static void optidma_lock(struct ata_port *ap)
95 {
96         void __iomem *regio = ap->ioaddr.cmd_addr;
97
98         /* Relock */
99         iowrite8(0x83, regio + 2);
100 }
101
102 /**
103  *      optidma_mode_setup      -       set mode data
104  *      @ap: ATA interface
105  *      @adev: ATA device
106  *      @mode: Mode to set
107  *
108  *      Called to do the DMA or PIO mode setup. Timing numbers are all
109  *      pre computed to keep the code clean. There are two tables depending
110  *      on the hardware clock speed.
111  *
112  *      WARNING: While we do this the IDE registers vanish. If we take an
113  *      IRQ here we depend on the host set locking to avoid catastrophe.
114  */
115
116 static void optidma_mode_setup(struct ata_port *ap, struct ata_device *adev, u8 mode)
117 {
118         struct ata_device *pair = ata_dev_pair(adev);
119         int pio = adev->pio_mode - XFER_PIO_0;
120         int dma = adev->dma_mode - XFER_MW_DMA_0;
121         void __iomem *regio = ap->ioaddr.cmd_addr;
122         u8 addr;
123
124         /* Address table precomputed with a DCLK of 2 */
125         static const u8 addr_timing[2][5] = {
126                 { 0x30, 0x20, 0x20, 0x10, 0x10 },
127                 { 0x20, 0x20, 0x10, 0x10, 0x10 }
128         };
129         static const u8 data_rec_timing[2][5] = {
130                 { 0x59, 0x46, 0x30, 0x20, 0x20 },
131                 { 0x46, 0x32, 0x20, 0x20, 0x10 }
132         };
133         static const u8 dma_data_rec_timing[2][3] = {
134                 { 0x76, 0x20, 0x20 },
135                 { 0x54, 0x20, 0x10 }
136         };
137
138         /* Switch from IDE to control mode */
139         optidma_unlock(ap);
140
141
142         /*
143          *      As with many controllers the address setup time is shared
144          *      and must suit both devices if present. FIXME: Check if we
145          *      need to look at slowest of PIO/DMA mode of either device
146          */
147
148         if (mode >= XFER_MW_DMA_0)
149                 addr = 0;
150         else
151                 addr = addr_timing[pci_clock][pio];
152
153         if (pair) {
154                 u8 pair_addr;
155                 /* Hardware constraint */
156                 if (pair->dma_mode)
157                         pair_addr = 0;
158                 else
159                         pair_addr = addr_timing[pci_clock][pair->pio_mode - XFER_PIO_0];
160                 if (pair_addr > addr)
161                         addr = pair_addr;
162         }
163
164         /* Commence primary programming sequence */
165         /* First we load the device number into the timing select */
166         iowrite8(adev->devno, regio + MISC_REG);
167         /* Now we load the data timings into read data/write data */
168         if (mode < XFER_MW_DMA_0) {
169                 iowrite8(data_rec_timing[pci_clock][pio], regio + READ_REG);
170                 iowrite8(data_rec_timing[pci_clock][pio], regio + WRITE_REG);
171         } else if (mode < XFER_UDMA_0) {
172                 iowrite8(dma_data_rec_timing[pci_clock][dma], regio + READ_REG);
173                 iowrite8(dma_data_rec_timing[pci_clock][dma], regio + WRITE_REG);
174         }
175         /* Finally we load the address setup into the misc register */
176         iowrite8(addr | adev->devno, regio + MISC_REG);
177
178         /* Programming sequence complete, timing 0 dev 0, timing 1 dev 1 */
179         iowrite8(0x85, regio + CNTRL_REG);
180
181         /* Switch back to IDE mode */
182         optidma_lock(ap);
183
184         /* Note: at this point our programming is incomplete. We are
185            not supposed to program PCI 0x43 "things we hacked onto the chip"
186            until we've done both sets of PIO/DMA timings */
187 }
188
189 /**
190  *      optiplus_mode_setup     -       DMA setup for Firestar Plus
191  *      @ap: ATA port
192  *      @adev: device
193  *      @mode: desired mode
194  *
195  *      The Firestar plus has additional UDMA functionality for UDMA0-2 and
196  *      requires we do some additional work. Because the base work we must do
197  *      is mostly shared we wrap the Firestar setup functionality in this
198  *      one
199  */
200
201 static void optiplus_mode_setup(struct ata_port *ap, struct ata_device *adev, u8 mode)
202 {
203         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
204         u8 udcfg;
205         u8 udslave;
206         int dev2 = 2 * adev->devno;
207         int unit = 2 * ap->port_no + adev->devno;
208         int udma = mode - XFER_UDMA_0;
209
210         pci_read_config_byte(pdev, 0x44, &udcfg);
211         if (mode <= XFER_UDMA_0) {
212                 udcfg &= ~(1 << unit);
213                 optidma_mode_setup(ap, adev, adev->dma_mode);
214         } else {
215                 udcfg |=  (1 << unit);
216                 if (ap->port_no) {
217                         pci_read_config_byte(pdev, 0x45, &udslave);
218                         udslave &= ~(0x03 << dev2);
219                         udslave |= (udma << dev2);
220                         pci_write_config_byte(pdev, 0x45, udslave);
221                 } else {
222                         udcfg &= ~(0x30 << dev2);
223                         udcfg |= (udma << dev2);
224                 }
225         }
226         pci_write_config_byte(pdev, 0x44, udcfg);
227 }
228
229 /**
230  *      optidma_set_pio_mode    -       PIO setup callback
231  *      @ap: ATA port
232  *      @adev: Device
233  *
234  *      The libata core provides separate functions for handling PIO and
235  *      DMA programming. The architecture of the Firestar makes it easier
236  *      for us to have a common function so we provide wrappers
237  */
238
239 static void optidma_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
240 {
241         optidma_mode_setup(ap, adev, adev->pio_mode);
242 }
243
244 /**
245  *      optidma_set_dma_mode    -       DMA setup callback
246  *      @ap: ATA port
247  *      @adev: Device
248  *
249  *      The libata core provides separate functions for handling PIO and
250  *      DMA programming. The architecture of the Firestar makes it easier
251  *      for us to have a common function so we provide wrappers
252  */
253
254 static void optidma_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
255 {
256         optidma_mode_setup(ap, adev, adev->dma_mode);
257 }
258
259 /**
260  *      optiplus_set_pio_mode   -       PIO setup callback
261  *      @ap: ATA port
262  *      @adev: Device
263  *
264  *      The libata core provides separate functions for handling PIO and
265  *      DMA programming. The architecture of the Firestar makes it easier
266  *      for us to have a common function so we provide wrappers
267  */
268
269 static void optiplus_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
270 {
271         optiplus_mode_setup(ap, adev, adev->pio_mode);
272 }
273
274 /**
275  *      optiplus_set_dma_mode   -       DMA setup callback
276  *      @ap: ATA port
277  *      @adev: Device
278  *
279  *      The libata core provides separate functions for handling PIO and
280  *      DMA programming. The architecture of the Firestar makes it easier
281  *      for us to have a common function so we provide wrappers
282  */
283
284 static void optiplus_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
285 {
286         optiplus_mode_setup(ap, adev, adev->dma_mode);
287 }
288
289 /**
290  *      optidma_make_bits       -       PCI setup helper
291  *      @adev: ATA device
292  *
293  *      Turn the ATA device setup into PCI configuration bits
294  *      for register 0x43 and return the two bits needed.
295  */
296
297 static u8 optidma_make_bits43(struct ata_device *adev)
298 {
299         static const u8 bits43[5] = {
300                 0, 0, 0, 1, 2
301         };
302         if (!ata_dev_enabled(adev))
303                 return 0;
304         if (adev->dma_mode)
305                 return adev->dma_mode - XFER_MW_DMA_0;
306         return bits43[adev->pio_mode - XFER_PIO_0];
307 }
308
309 /**
310  *      optidma_set_mode        -       mode setup
311  *      @link: link to set up
312  *
313  *      Use the standard setup to tune the chipset and then finalise the
314  *      configuration by writing the nibble of extra bits of data into
315  *      the chip.
316  */
317
318 static int optidma_set_mode(struct ata_link *link, struct ata_device **r_failed)
319 {
320         struct ata_port *ap = link->ap;
321         u8 r;
322         int nybble = 4 * ap->port_no;
323         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
324         int rc  = ata_do_set_mode(link, r_failed);
325         if (rc == 0) {
326                 pci_read_config_byte(pdev, 0x43, &r);
327
328                 r &= (0x0F << nybble);
329                 r |= (optidma_make_bits43(&link->device[0]) +
330                      (optidma_make_bits43(&link->device[0]) << 2)) << nybble;
331                 pci_write_config_byte(pdev, 0x43, r);
332         }
333         return rc;
334 }
335
336 static struct scsi_host_template optidma_sht = {
337         ATA_BMDMA_SHT(DRV_NAME),
338 };
339
340 static struct ata_port_operations optidma_port_ops = {
341         .inherits       = &ata_bmdma_port_ops,
342         .cable_detect   = ata_cable_40wire,
343         .set_piomode    = optidma_set_pio_mode,
344         .set_dmamode    = optidma_set_dma_mode,
345         .set_mode       = optidma_set_mode,
346         .prereset       = optidma_pre_reset,
347 };
348
349 static struct ata_port_operations optiplus_port_ops = {
350         .inherits       = &optidma_port_ops,
351         .set_piomode    = optiplus_set_pio_mode,
352         .set_dmamode    = optiplus_set_dma_mode,
353 };
354
355 /**
356  *      optiplus_with_udma      -       Look for UDMA capable setup
357  *      @pdev; ATA controller
358  */
359
360 static int optiplus_with_udma(struct pci_dev *pdev)
361 {
362         u8 r;
363         int ret = 0;
364         int ioport = 0x22;
365         struct pci_dev *dev1;
366
367         /* Find function 1 */
368         dev1 = pci_get_device(0x1045, 0xC701, NULL);
369         if (dev1 == NULL)
370                 return 0;
371
372         /* Rev must be >= 0x10 */
373         pci_read_config_byte(dev1, 0x08, &r);
374         if (r < 0x10)
375                 goto done_nomsg;
376         /* Read the chipset system configuration to check our mode */
377         pci_read_config_byte(dev1, 0x5F, &r);
378         ioport |= (r << 8);
379         outb(0x10, ioport);
380         /* Must be 66Mhz sync */
381         if ((inb(ioport + 2) & 1) == 0)
382                 goto done;
383
384         /* Check the ATA arbitration/timing is suitable */
385         pci_read_config_byte(pdev, 0x42, &r);
386         if ((r & 0x36) != 0x36)
387                 goto done;
388         pci_read_config_byte(dev1, 0x52, &r);
389         if (r & 0x80)   /* IDEDIR disabled */
390                 ret = 1;
391 done:
392         printk(KERN_WARNING "UDMA not supported in this configuration.\n");
393 done_nomsg:             /* Wrong chip revision */
394         pci_dev_put(dev1);
395         return ret;
396 }
397
398 static int optidma_init_one(struct pci_dev *dev, const struct pci_device_id *id)
399 {
400         static const struct ata_port_info info_82c700 = {
401                 .flags = ATA_FLAG_SLAVE_POSS,
402                 .pio_mask = 0x1f,
403                 .mwdma_mask = 0x07,
404                 .port_ops = &optidma_port_ops
405         };
406         static const struct ata_port_info info_82c700_udma = {
407                 .flags = ATA_FLAG_SLAVE_POSS,
408                 .pio_mask = 0x1f,
409                 .mwdma_mask = 0x07,
410                 .udma_mask = 0x07,
411                 .port_ops = &optiplus_port_ops
412         };
413         const struct ata_port_info *ppi[] = { &info_82c700, NULL };
414         static int printed_version;
415         int rc;
416
417         if (!printed_version++)
418                 dev_printk(KERN_DEBUG, &dev->dev, "version " DRV_VERSION "\n");
419
420         rc = pcim_enable_device(dev);
421         if (rc)
422                 return rc;
423
424         /* Fixed location chipset magic */
425         inw(0x1F1);
426         inw(0x1F1);
427         pci_clock = inb(0x1F5) & 1;             /* 0 = 33Mhz, 1 = 25Mhz */
428
429         if (optiplus_with_udma(dev))
430                 ppi[0] = &info_82c700_udma;
431
432         return ata_pci_sff_init_one(dev, ppi, &optidma_sht, NULL);
433 }
434
435 static const struct pci_device_id optidma[] = {
436         { PCI_VDEVICE(OPTI, 0xD568), },         /* Opti 82C700 */
437
438         { },
439 };
440
441 static struct pci_driver optidma_pci_driver = {
442         .name           = DRV_NAME,
443         .id_table       = optidma,
444         .probe          = optidma_init_one,
445         .remove         = ata_pci_remove_one,
446 #ifdef CONFIG_PM
447         .suspend        = ata_pci_device_suspend,
448         .resume         = ata_pci_device_resume,
449 #endif
450 };
451
452 static int __init optidma_init(void)
453 {
454         return pci_register_driver(&optidma_pci_driver);
455 }
456
457 static void __exit optidma_exit(void)
458 {
459         pci_unregister_driver(&optidma_pci_driver);
460 }
461
462 MODULE_AUTHOR("Alan Cox");
463 MODULE_DESCRIPTION("low-level driver for Opti Firestar/Firestar Plus");
464 MODULE_LICENSE("GPL");
465 MODULE_DEVICE_TABLE(pci, optidma);
466 MODULE_VERSION(DRV_VERSION);
467
468 module_init(optidma_init);
469 module_exit(optidma_exit);