blob: d4590f546c497c7aa2ae2a365bc1d2a0232b4bff [file] [log] [blame]
Jeff Garzik669a5db2006-08-29 18:12:40 -04001/*
2 * IDE tuning and bus mastering support for the CS5510/CS5520
3 * chipsets
4 *
5 * The CS5510/CS5520 are slightly unusual devices. Unlike the
6 * typical IDE controllers they do bus mastering with the drive in
7 * PIO mode and smarter silicon.
8 *
9 * The practical upshot of this is that we must always tune the
10 * drive for the right PIO mode. We must also ignore all the blacklists
11 * and the drive bus mastering DMA information. Also to confuse matters
12 * further we can do DMA on PIO only drives.
13 *
14 * DMA on the 5510 also requires we disable_hlt() during DMA on early
15 * revisions.
16 *
17 * *** This driver is strictly experimental ***
18 *
19 * (c) Copyright Red Hat Inc 2002
20 *
21 * This program is free software; you can redistribute it and/or modify it
22 * under the terms of the GNU General Public License as published by the
23 * Free Software Foundation; either version 2, or (at your option) any
24 * later version.
25 *
26 * This program is distributed in the hope that it will be useful, but
27 * WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
29 * General Public License for more details.
30 *
31 * Documentation:
32 * Not publically available.
33 */
34#include <linux/kernel.h>
35#include <linux/module.h>
36#include <linux/pci.h>
37#include <linux/init.h>
38#include <linux/blkdev.h>
39#include <linux/delay.h>
40#include <scsi/scsi_host.h>
41#include <linux/libata.h>
42
43#define DRV_NAME "pata_cs5520"
Jeff Garzik2a3103c2007-08-31 04:54:06 -040044#define DRV_VERSION "0.6.6"
Jeff Garzik669a5db2006-08-29 18:12:40 -040045
46struct pio_clocks
47{
48 int address;
49 int assert;
50 int recovery;
51};
52
53static const struct pio_clocks cs5520_pio_clocks[]={
54 {3, 6, 11},
55 {2, 5, 6},
56 {1, 4, 3},
57 {1, 3, 2},
58 {1, 2, 1}
59};
60
61/**
62 * cs5520_set_timings - program PIO timings
63 * @ap: ATA port
64 * @adev: ATA device
65 *
66 * Program the PIO mode timings for the controller according to the pio
67 * clocking table.
68 */
69
70static void cs5520_set_timings(struct ata_port *ap, struct ata_device *adev, int pio)
71{
72 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
73 int slave = adev->devno;
74
75 pio -= XFER_PIO_0;
76
77 /* Channel command timing */
78 pci_write_config_byte(pdev, 0x62 + ap->port_no,
79 (cs5520_pio_clocks[pio].recovery << 4) |
80 (cs5520_pio_clocks[pio].assert));
81 /* FIXME: should these use address ? */
82 /* Read command timing */
83 pci_write_config_byte(pdev, 0x64 + 4*ap->port_no + slave,
84 (cs5520_pio_clocks[pio].recovery << 4) |
85 (cs5520_pio_clocks[pio].assert));
86 /* Write command timing */
87 pci_write_config_byte(pdev, 0x66 + 4*ap->port_no + slave,
88 (cs5520_pio_clocks[pio].recovery << 4) |
89 (cs5520_pio_clocks[pio].assert));
90}
91
92/**
93 * cs5520_enable_dma - turn on DMA bits
94 *
95 * Turn on the DMA bits for this disk. Needed because the BIOS probably
96 * has not done the work for us. Belongs in the core SATA code.
97 */
98
99static void cs5520_enable_dma(struct ata_port *ap, struct ata_device *adev)
100{
101 /* Set the DMA enable/disable flag */
Tejun Heo0d5ff562007-02-01 15:06:36 +0900102 u8 reg = ioread8(ap->ioaddr.bmdma_addr + 0x02);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400103 reg |= 1<<(adev->devno + 5);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900104 iowrite8(reg, ap->ioaddr.bmdma_addr + 0x02);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400105}
106
107/**
108 * cs5520_set_dmamode - program DMA timings
109 * @ap: ATA port
110 * @adev: ATA device
111 *
112 * Program the DMA mode timings for the controller according to the pio
113 * clocking table. Note that this device sets the DMA timings to PIO
114 * mode values. This may seem bizarre but the 5520 architecture talks
115 * PIO mode to the disk and DMA mode to the controller so the underlying
116 * transfers are PIO timed.
117 */
118
119static void cs5520_set_dmamode(struct ata_port *ap, struct ata_device *adev)
120{
121 static const int dma_xlate[3] = { XFER_PIO_0, XFER_PIO_3, XFER_PIO_4 };
122 cs5520_set_timings(ap, adev, dma_xlate[adev->dma_mode]);
123 cs5520_enable_dma(ap, adev);
124}
125
126/**
127 * cs5520_set_piomode - program PIO timings
128 * @ap: ATA port
129 * @adev: ATA device
130 *
131 * Program the PIO mode timings for the controller according to the pio
132 * clocking table. We know pio_mode will equal dma_mode because of the
133 * CS5520 architecture. At least once we turned DMA on and wrote a
134 * mode setter.
135 */
136
137static void cs5520_set_piomode(struct ata_port *ap, struct ata_device *adev)
138{
139 cs5520_set_timings(ap, adev, adev->pio_mode);
140}
141
Jeff Garzik669a5db2006-08-29 18:12:40 -0400142static struct scsi_host_template cs5520_sht = {
143 .module = THIS_MODULE,
144 .name = DRV_NAME,
145 .ioctl = ata_scsi_ioctl,
146 .queuecommand = ata_scsi_queuecmd,
147 .can_queue = ATA_DEF_QUEUE,
148 .this_id = ATA_SHT_THIS_ID,
Alan Coxd26fc952007-07-06 19:13:52 -0400149 .sg_tablesize = LIBATA_DUMB_MAX_PRD,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400150 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
151 .emulated = ATA_SHT_EMULATED,
152 .use_clustering = ATA_SHT_USE_CLUSTERING,
153 .proc_name = DRV_NAME,
154 .dma_boundary = ATA_DMA_BOUNDARY,
155 .slave_configure = ata_scsi_slave_config,
Tejun Heoafdfe892006-11-29 11:26:47 +0900156 .slave_destroy = ata_scsi_slave_destroy,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400157 .bios_param = ata_std_bios_param,
158};
159
160static struct ata_port_operations cs5520_port_ops = {
Jeff Garzik669a5db2006-08-29 18:12:40 -0400161 .set_piomode = cs5520_set_piomode,
162 .set_dmamode = cs5520_set_dmamode,
163
164 .tf_load = ata_tf_load,
165 .tf_read = ata_tf_read,
166 .check_status = ata_check_status,
167 .exec_command = ata_exec_command,
168 .dev_select = ata_std_dev_select,
169
170 .freeze = ata_bmdma_freeze,
171 .thaw = ata_bmdma_thaw,
Jeff Garzika73984a2007-03-09 08:37:46 -0500172 .error_handler = ata_bmdma_error_handler,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400173 .post_internal_cmd = ata_bmdma_post_internal_cmd,
Jeff Garzika73984a2007-03-09 08:37:46 -0500174 .cable_detect = ata_cable_40wire,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400175
176 .bmdma_setup = ata_bmdma_setup,
177 .bmdma_start = ata_bmdma_start,
178 .bmdma_stop = ata_bmdma_stop,
179 .bmdma_status = ata_bmdma_status,
Alan Coxd26fc952007-07-06 19:13:52 -0400180 .qc_prep = ata_dumb_qc_prep,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400181 .qc_issue = ata_qc_issue_prot,
Tejun Heo0d5ff562007-02-01 15:06:36 +0900182 .data_xfer = ata_data_xfer,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400183
Jeff Garzik669a5db2006-08-29 18:12:40 -0400184 .irq_clear = ata_bmdma_irq_clear,
Akira Iguchi246ce3b2007-01-26 16:27:58 +0900185 .irq_on = ata_irq_on,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400186
Alan Cox81ad1832007-08-22 22:55:41 +0100187 .port_start = ata_sff_port_start,
Jeff Garzik669a5db2006-08-29 18:12:40 -0400188};
189
Tejun Heo5d728822007-04-17 23:44:08 +0900190static int __devinit cs5520_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
Jeff Garzik669a5db2006-08-29 18:12:40 -0400191{
Tejun Heocbcdd872007-08-18 13:14:55 +0900192 static const unsigned int cmd_port[] = { 0x1F0, 0x170 };
193 static const unsigned int ctl_port[] = { 0x3F6, 0x376 };
Tejun Heo5d728822007-04-17 23:44:08 +0900194 struct ata_port_info pi = {
195 .flags = ATA_FLAG_SLAVE_POSS,
196 .pio_mask = 0x1f,
197 .port_ops = &cs5520_port_ops,
198 };
199 const struct ata_port_info *ppi[2];
Jeff Garzik669a5db2006-08-29 18:12:40 -0400200 u8 pcicfg;
Al Viro4ca4e432007-12-30 09:32:22 +0000201 void __iomem *iomap[5];
Tejun Heo5d728822007-04-17 23:44:08 +0900202 struct ata_host *host;
203 struct ata_ioports *ioaddr;
204 int i, rc;
Jeff Garzik669a5db2006-08-29 18:12:40 -0400205
206 /* IDE port enable bits */
Tejun Heo5d728822007-04-17 23:44:08 +0900207 pci_read_config_byte(pdev, 0x60, &pcicfg);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400208
209 /* Check if the ATA ports are enabled */
210 if ((pcicfg & 3) == 0)
211 return -ENODEV;
212
Tejun Heo5d728822007-04-17 23:44:08 +0900213 ppi[0] = ppi[1] = &ata_dummy_port_info;
214 if (pcicfg & 1)
215 ppi[0] = &pi;
216 if (pcicfg & 2)
217 ppi[1] = &pi;
218
Jeff Garzik669a5db2006-08-29 18:12:40 -0400219 if ((pcicfg & 0x40) == 0) {
Tejun Heo5d728822007-04-17 23:44:08 +0900220 dev_printk(KERN_WARNING, &pdev->dev,
221 "DMA mode disabled. Enabling.\n");
222 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400223 }
224
Tejun Heo5d728822007-04-17 23:44:08 +0900225 pi.mwdma_mask = id->driver_data;
226
227 host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2);
228 if (!host)
229 return -ENOMEM;
230
Jeff Garzik669a5db2006-08-29 18:12:40 -0400231 /* Perform set up for DMA */
Tejun Heo5d728822007-04-17 23:44:08 +0900232 if (pci_enable_device_bars(pdev, 1<<2)) {
Jeff Garzik669a5db2006-08-29 18:12:40 -0400233 printk(KERN_ERR DRV_NAME ": unable to configure BAR2.\n");
234 return -ENODEV;
235 }
Tejun Heo5d728822007-04-17 23:44:08 +0900236
237 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
Jeff Garzik669a5db2006-08-29 18:12:40 -0400238 printk(KERN_ERR DRV_NAME ": unable to configure DMA mask.\n");
239 return -ENODEV;
240 }
Tejun Heo5d728822007-04-17 23:44:08 +0900241 if (pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK)) {
Jeff Garzik669a5db2006-08-29 18:12:40 -0400242 printk(KERN_ERR DRV_NAME ": unable to configure consistent DMA mask.\n");
243 return -ENODEV;
244 }
245
Tejun Heo5d728822007-04-17 23:44:08 +0900246 /* Map IO ports and initialize host accordingly */
Tejun Heocbcdd872007-08-18 13:14:55 +0900247 iomap[0] = devm_ioport_map(&pdev->dev, cmd_port[0], 8);
248 iomap[1] = devm_ioport_map(&pdev->dev, ctl_port[0], 1);
249 iomap[2] = devm_ioport_map(&pdev->dev, cmd_port[1], 8);
250 iomap[3] = devm_ioport_map(&pdev->dev, ctl_port[1], 1);
Tejun Heo5d728822007-04-17 23:44:08 +0900251 iomap[4] = pcim_iomap(pdev, 2, 0);
Tejun Heo0d5ff562007-02-01 15:06:36 +0900252
253 if (!iomap[0] || !iomap[1] || !iomap[2] || !iomap[3] || !iomap[4])
254 return -ENOMEM;
255
Tejun Heo5d728822007-04-17 23:44:08 +0900256 ioaddr = &host->ports[0]->ioaddr;
257 ioaddr->cmd_addr = iomap[0];
258 ioaddr->ctl_addr = iomap[1];
259 ioaddr->altstatus_addr = iomap[1];
260 ioaddr->bmdma_addr = iomap[4];
261 ata_std_ports(ioaddr);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400262
Tejun Heocbcdd872007-08-18 13:14:55 +0900263 ata_port_desc(host->ports[0],
264 "cmd 0x%x ctl 0x%x", cmd_port[0], ctl_port[0]);
265 ata_port_pbar_desc(host->ports[0], 4, 0, "bmdma");
266
Tejun Heo5d728822007-04-17 23:44:08 +0900267 ioaddr = &host->ports[1]->ioaddr;
268 ioaddr->cmd_addr = iomap[2];
269 ioaddr->ctl_addr = iomap[3];
270 ioaddr->altstatus_addr = iomap[3];
271 ioaddr->bmdma_addr = iomap[4] + 8;
272 ata_std_ports(ioaddr);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400273
Tejun Heocbcdd872007-08-18 13:14:55 +0900274 ata_port_desc(host->ports[1],
275 "cmd 0x%x ctl 0x%x", cmd_port[1], ctl_port[1]);
276 ata_port_pbar_desc(host->ports[1], 4, 8, "bmdma");
277
Tejun Heo5d728822007-04-17 23:44:08 +0900278 /* activate the host */
279 pci_set_master(pdev);
280 rc = ata_host_start(host);
281 if (rc)
282 return rc;
Jeff Garzik669a5db2006-08-29 18:12:40 -0400283
Tejun Heo5d728822007-04-17 23:44:08 +0900284 for (i = 0; i < 2; i++) {
285 static const int irq[] = { 14, 15 };
Alan Cox8c6b0652007-07-20 15:36:31 +0100286 struct ata_port *ap = host->ports[i];
Jeff Garzik669a5db2006-08-29 18:12:40 -0400287
Tejun Heo5d728822007-04-17 23:44:08 +0900288 if (ata_port_is_dummy(ap))
289 continue;
Jeff Garzik669a5db2006-08-29 18:12:40 -0400290
Tejun Heo5d728822007-04-17 23:44:08 +0900291 rc = devm_request_irq(&pdev->dev, irq[ap->port_no],
292 ata_interrupt, 0, DRV_NAME, host);
293 if (rc)
294 return rc;
Tejun Heo40318262007-07-03 01:38:47 +0900295
Tejun Heocbcdd872007-08-18 13:14:55 +0900296 ata_port_desc(ap, "irq %d", irq[i]);
Tejun Heo5d728822007-04-17 23:44:08 +0900297 }
298
299 return ata_host_register(host, &cs5520_sht);
Jeff Garzik669a5db2006-08-29 18:12:40 -0400300}
301
Tejun Heo438ac6d2007-03-02 17:31:26 +0900302#ifdef CONFIG_PM
Alan85011202006-11-22 17:01:06 +0000303/**
304 * cs5520_reinit_one - device resume
305 * @pdev: PCI device
306 *
307 * Do any reconfiguration work needed by a resume from RAM. We need
308 * to restore DMA mode support on BIOSen which disabled it
309 */
Jeff Garzikf20b16f2006-12-11 11:14:06 -0500310
Alan85011202006-11-22 17:01:06 +0000311static int cs5520_reinit_one(struct pci_dev *pdev)
312{
313 u8 pcicfg;
314 pci_read_config_byte(pdev, 0x60, &pcicfg);
315 if ((pcicfg & 0x40) == 0)
316 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40);
317 return ata_pci_device_resume(pdev);
318}
Alanaa6de492007-02-20 17:44:25 +0000319
320/**
321 * cs5520_pci_device_suspend - device suspend
322 * @pdev: PCI device
323 *
324 * We have to cut and waste bits from the standard method because
325 * the 5520 is a bit odd and not just a pure ATA device. As a result
326 * we must not disable it. The needed code is short and this avoids
327 * chip specific mess in the core code.
328 */
329
330static int cs5520_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
331{
332 struct ata_host *host = dev_get_drvdata(&pdev->dev);
333 int rc = 0;
334
335 rc = ata_host_suspend(host, mesg);
336 if (rc)
337 return rc;
338
339 pci_save_state(pdev);
340 return 0;
341}
Tejun Heo438ac6d2007-03-02 17:31:26 +0900342#endif /* CONFIG_PM */
Jeff Garzika84471f2007-02-26 05:51:33 -0500343
Jeff Garzik669a5db2006-08-29 18:12:40 -0400344/* For now keep DMA off. We can set it for all but A rev CS5510 once the
345 core ATA code can handle it */
346
Jeff Garzik2d2744f2006-09-28 20:21:59 -0400347static const struct pci_device_id pata_cs5520[] = {
348 { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5510), },
349 { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5520), },
350
351 { },
Jeff Garzik669a5db2006-08-29 18:12:40 -0400352};
353
354static struct pci_driver cs5520_pci_driver = {
355 .name = DRV_NAME,
356 .id_table = pata_cs5520,
357 .probe = cs5520_init_one,
Jeff Garzik28555682007-10-11 17:12:35 -0400358 .remove = ata_pci_remove_one,
Tejun Heo438ac6d2007-03-02 17:31:26 +0900359#ifdef CONFIG_PM
Alanaa6de492007-02-20 17:44:25 +0000360 .suspend = cs5520_pci_device_suspend,
Alan85011202006-11-22 17:01:06 +0000361 .resume = cs5520_reinit_one,
Tejun Heo438ac6d2007-03-02 17:31:26 +0900362#endif
Jeff Garzik669a5db2006-08-29 18:12:40 -0400363};
364
Jeff Garzik669a5db2006-08-29 18:12:40 -0400365static int __init cs5520_init(void)
366{
367 return pci_register_driver(&cs5520_pci_driver);
368}
369
370static void __exit cs5520_exit(void)
371{
372 pci_unregister_driver(&cs5520_pci_driver);
373}
374
375MODULE_AUTHOR("Alan Cox");
376MODULE_DESCRIPTION("low-level driver for Cyrix CS5510/5520");
377MODULE_LICENSE("GPL");
378MODULE_DEVICE_TABLE(pci, pata_cs5520);
379MODULE_VERSION(DRV_VERSION);
380
381module_init(cs5520_init);
382module_exit(cs5520_exit);
383