libata: cable logic
[linux-2.6] / drivers / ata / pata_cs5530.c
1 /*
2  * pata-cs5530.c        - CS5530 PATA for new ATA layer
3  *                        (C) 2005 Red Hat Inc
4  *                        Alan Cox <alan@redhat.com>
5  *
6  * based upon cs5530.c by Mark Lord.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  * Loosely based on the piix & svwks drivers.
22  *
23  * Documentation:
24  *      Available from AMD web site.
25  */
26
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <linux/init.h>
31 #include <linux/blkdev.h>
32 #include <linux/delay.h>
33 #include <scsi/scsi_host.h>
34 #include <linux/libata.h>
35 #include <linux/dmi.h>
36
37 #define DRV_NAME        "pata_cs5530"
38 #define DRV_VERSION     "0.7.4"
39
40 static void __iomem *cs5530_port_base(struct ata_port *ap)
41 {
42         unsigned long bmdma = (unsigned long)ap->ioaddr.bmdma_addr;
43
44         return (void __iomem *)((bmdma & ~0x0F) + 0x20 + 0x10 * ap->port_no);
45 }
46
47 /**
48  *      cs5530_set_piomode              -       PIO setup
49  *      @ap: ATA interface
50  *      @adev: device on the interface
51  *
52  *      Set our PIO requirements. This is fairly simple on the CS5530
53  *      chips.
54  */
55
56 static void cs5530_set_piomode(struct ata_port *ap, struct ata_device *adev)
57 {
58         static const unsigned int cs5530_pio_timings[2][5] = {
59                 {0x00009172, 0x00012171, 0x00020080, 0x00032010, 0x00040010},
60                 {0xd1329172, 0x71212171, 0x30200080, 0x20102010, 0x00100010}
61         };
62         void __iomem *base = cs5530_port_base(ap);
63         u32 tuning;
64         int format;
65
66         /* Find out which table to use */
67         tuning = ioread32(base + 0x04);
68         format = (tuning & 0x80000000UL) ? 1 : 0;
69
70         /* Now load the right timing register */
71         if (adev->devno)
72                 base += 0x08;
73
74         iowrite32(cs5530_pio_timings[format][adev->pio_mode - XFER_PIO_0], base);
75 }
76
77 /**
78  *      cs5530_set_dmamode              -       DMA timing setup
79  *      @ap: ATA interface
80  *      @adev: Device being configured
81  *
82  *      We cannot mix MWDMA and UDMA without reloading timings each switch
83  *      master to slave. We track the last DMA setup in order to minimise
84  *      reloads.
85  */
86
87 static void cs5530_set_dmamode(struct ata_port *ap, struct ata_device *adev)
88 {
89         void __iomem *base = cs5530_port_base(ap);
90         u32 tuning, timing = 0;
91         u8 reg;
92
93         /* Find out which table to use */
94         tuning = ioread32(base + 0x04);
95
96         switch(adev->dma_mode) {
97                 case XFER_UDMA_0:
98                         timing  = 0x00921250;break;
99                 case XFER_UDMA_1:
100                         timing  = 0x00911140;break;
101                 case XFER_UDMA_2:
102                         timing  = 0x00911030;break;
103                 case XFER_MW_DMA_0:
104                         timing  = 0x00077771;break;
105                 case XFER_MW_DMA_1:
106                         timing  = 0x00012121;break;
107                 case XFER_MW_DMA_2:
108                         timing  = 0x00002020;break;
109                 default:
110                         BUG();
111         }
112         /* Merge in the PIO format bit */
113         timing |= (tuning & 0x80000000UL);
114         if (adev->devno == 0) /* Master */
115                 iowrite32(timing, base + 0x04);
116         else {
117                 if (timing & 0x00100000)
118                         tuning |= 0x00100000;   /* UDMA for both */
119                 else
120                         tuning &= ~0x00100000;  /* MWDMA for both */
121                 iowrite32(tuning, base + 0x04);
122                 iowrite32(timing, base + 0x0C);
123         }
124
125         /* Set the DMA capable bit in the BMDMA area */
126         reg = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
127         reg |= (1 << (5 + adev->devno));
128         iowrite8(reg, ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
129
130         /* Remember the last DMA setup we did */
131
132         ap->private_data = adev;
133 }
134
135 /**
136  *      cs5530_qc_issue         -       command issue
137  *      @qc: command pending
138  *
139  *      Called when the libata layer is about to issue a command. We wrap
140  *      this interface so that we can load the correct ATA timings if
141  *      necessary.  Specifically we have a problem that there is only
142  *      one MWDMA/UDMA bit.
143  */
144
145 static unsigned int cs5530_qc_issue(struct ata_queued_cmd *qc)
146 {
147         struct ata_port *ap = qc->ap;
148         struct ata_device *adev = qc->dev;
149         struct ata_device *prev = ap->private_data;
150
151         /* See if the DMA settings could be wrong */
152         if (adev->dma_mode != 0 && adev != prev && prev != NULL) {
153                 /* Maybe, but do the channels match MWDMA/UDMA ? */
154                 if ((adev->dma_mode >= XFER_UDMA_0 && prev->dma_mode < XFER_UDMA_0) ||
155                     (adev->dma_mode < XFER_UDMA_0 && prev->dma_mode >= XFER_UDMA_0))
156                         /* Switch the mode bits */
157                         cs5530_set_dmamode(ap, adev);
158         }
159
160         return ata_sff_qc_issue(qc);
161 }
162
163 static struct scsi_host_template cs5530_sht = {
164         ATA_BMDMA_SHT(DRV_NAME),
165         .sg_tablesize   = LIBATA_DUMB_MAX_PRD,
166 };
167
168 static struct ata_port_operations cs5530_port_ops = {
169         .inherits       = &ata_bmdma_port_ops,
170
171         .qc_prep        = ata_sff_dumb_qc_prep,
172         .qc_issue       = cs5530_qc_issue,
173
174         .cable_detect   = ata_cable_40wire,
175         .set_piomode    = cs5530_set_piomode,
176         .set_dmamode    = cs5530_set_dmamode,
177 };
178
179 static const struct dmi_system_id palmax_dmi_table[] = {
180         {
181                 .ident = "Palmax PD1100",
182                 .matches = {
183                         DMI_MATCH(DMI_SYS_VENDOR, "Cyrix"),
184                         DMI_MATCH(DMI_PRODUCT_NAME, "Caddis"),
185                 },
186         },
187         { }
188 };
189
190 static int cs5530_is_palmax(void)
191 {
192         if (dmi_check_system(palmax_dmi_table)) {
193                 printk(KERN_INFO "Palmax PD1100: Disabling DMA on docking port.\n");
194                 return 1;
195         }
196         return 0;
197 }
198
199
200 /**
201  *      cs5530_init_chip        -       Chipset init
202  *
203  *      Perform the chip initialisation work that is shared between both
204  *      setup and resume paths
205  */
206
207 static int cs5530_init_chip(void)
208 {
209         struct pci_dev *master_0 = NULL, *cs5530_0 = NULL, *dev = NULL;
210
211         while ((dev = pci_get_device(PCI_VENDOR_ID_CYRIX, PCI_ANY_ID, dev)) != NULL) {
212                 switch (dev->device) {
213                         case PCI_DEVICE_ID_CYRIX_PCI_MASTER:
214                                 master_0 = pci_dev_get(dev);
215                                 break;
216                         case PCI_DEVICE_ID_CYRIX_5530_LEGACY:
217                                 cs5530_0 = pci_dev_get(dev);
218                                 break;
219                 }
220         }
221         if (!master_0) {
222                 printk(KERN_ERR DRV_NAME ": unable to locate PCI MASTER function\n");
223                 goto fail_put;
224         }
225         if (!cs5530_0) {
226                 printk(KERN_ERR DRV_NAME ": unable to locate CS5530 LEGACY function\n");
227                 goto fail_put;
228         }
229
230         pci_set_master(cs5530_0);
231         pci_try_set_mwi(cs5530_0);
232
233         /*
234          * Set PCI CacheLineSize to 16-bytes:
235          * --> Write 0x04 into 8-bit PCI CACHELINESIZE reg of function 0 of the cs5530
236          *
237          * Note: This value is constant because the 5530 is only a Geode companion
238          */
239
240         pci_write_config_byte(cs5530_0, PCI_CACHE_LINE_SIZE, 0x04);
241
242         /*
243          * Disable trapping of UDMA register accesses (Win98 hack):
244          * --> Write 0x5006 into 16-bit reg at offset 0xd0 of function 0 of the cs5530
245          */
246
247         pci_write_config_word(cs5530_0, 0xd0, 0x5006);
248
249         /*
250          * Bit-1 at 0x40 enables MemoryWriteAndInvalidate on internal X-bus:
251          * The other settings are what is necessary to get the register
252          * into a sane state for IDE DMA operation.
253          */
254
255         pci_write_config_byte(master_0, 0x40, 0x1e);
256
257         /*
258          * Set max PCI burst size (16-bytes seems to work best):
259          *         16bytes: set bit-1 at 0x41 (reg value of 0x16)
260          *      all others: clear bit-1 at 0x41, and do:
261          *        128bytes: OR 0x00 at 0x41
262          *        256bytes: OR 0x04 at 0x41
263          *        512bytes: OR 0x08 at 0x41
264          *       1024bytes: OR 0x0c at 0x41
265          */
266
267         pci_write_config_byte(master_0, 0x41, 0x14);
268
269         /*
270          * These settings are necessary to get the chip
271          * into a sane state for IDE DMA operation.
272          */
273
274         pci_write_config_byte(master_0, 0x42, 0x00);
275         pci_write_config_byte(master_0, 0x43, 0xc1);
276
277         pci_dev_put(master_0);
278         pci_dev_put(cs5530_0);
279         return 0;
280 fail_put:
281         if (master_0)
282                 pci_dev_put(master_0);
283         if (cs5530_0)
284                 pci_dev_put(cs5530_0);
285         return -ENODEV;
286 }
287
288 /**
289  *      cs5530_init_one         -       Initialise a CS5530
290  *      @dev: PCI device
291  *      @id: Entry in match table
292  *
293  *      Install a driver for the newly found CS5530 companion chip. Most of
294  *      this is just housekeeping. We have to set the chip up correctly and
295  *      turn off various bits of emulation magic.
296  */
297
298 static int cs5530_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
299 {
300         static const struct ata_port_info info = {
301                 .flags = ATA_FLAG_SLAVE_POSS,
302                 .pio_mask = 0x1f,
303                 .mwdma_mask = 0x07,
304                 .udma_mask = 0x07,
305                 .port_ops = &cs5530_port_ops
306         };
307         /* The docking connector doesn't do UDMA, and it seems not MWDMA */
308         static const struct ata_port_info info_palmax_secondary = {
309                 .flags = ATA_FLAG_SLAVE_POSS,
310                 .pio_mask = 0x1f,
311                 .port_ops = &cs5530_port_ops
312         };
313         const struct ata_port_info *ppi[] = { &info, NULL };
314         int rc;
315
316         rc = pcim_enable_device(pdev);
317         if (rc)
318                 return rc;
319
320         /* Chip initialisation */
321         if (cs5530_init_chip())
322                 return -ENODEV;
323
324         if (cs5530_is_palmax())
325                 ppi[1] = &info_palmax_secondary;
326
327         /* Now kick off ATA set up */
328         return ata_pci_sff_init_one(pdev, ppi, &cs5530_sht, NULL);
329 }
330
331 #ifdef CONFIG_PM
332 static int cs5530_reinit_one(struct pci_dev *pdev)
333 {
334         struct ata_host *host = dev_get_drvdata(&pdev->dev);
335         int rc;
336
337         rc = ata_pci_device_do_resume(pdev);
338         if (rc)
339                 return rc;
340
341         /* If we fail on resume we are doomed */
342         if (cs5530_init_chip())
343                 return -EIO;
344
345         ata_host_resume(host);
346         return 0;
347 }
348 #endif /* CONFIG_PM */
349
350 static const struct pci_device_id cs5530[] = {
351         { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5530_IDE), },
352
353         { },
354 };
355
356 static struct pci_driver cs5530_pci_driver = {
357         .name           = DRV_NAME,
358         .id_table       = cs5530,
359         .probe          = cs5530_init_one,
360         .remove         = ata_pci_remove_one,
361 #ifdef CONFIG_PM
362         .suspend        = ata_pci_device_suspend,
363         .resume         = cs5530_reinit_one,
364 #endif
365 };
366
367 static int __init cs5530_init(void)
368 {
369         return pci_register_driver(&cs5530_pci_driver);
370 }
371
372 static void __exit cs5530_exit(void)
373 {
374         pci_unregister_driver(&cs5530_pci_driver);
375 }
376
377 MODULE_AUTHOR("Alan Cox");
378 MODULE_DESCRIPTION("low-level driver for the Cyrix/NS/AMD 5530");
379 MODULE_LICENSE("GPL");
380 MODULE_DEVICE_TABLE(pci, cs5530);
381 MODULE_VERSION(DRV_VERSION);
382
383 module_init(cs5530_init);
384 module_exit(cs5530_exit);