1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * IDE tuning and bus mastering support for the CS5510/CS5520 4 * chipsets 5 * 6 * The CS5510/CS5520 are slightly unusual devices. Unlike the 7 * typical IDE controllers they do bus mastering with the drive in 8 * PIO mode and smarter silicon. 9 * 10 * The practical upshot of this is that we must always tune the 11 * drive for the right PIO mode. We must also ignore all the blacklists 12 * and the drive bus mastering DMA information. Also to confuse matters 13 * further we can do DMA on PIO only drives. 14 * 15 * DMA on the 5510 also requires we disable_hlt() during DMA on early 16 * revisions. 17 * 18 * *** This driver is strictly experimental *** 19 * 20 * (c) Copyright Red Hat Inc 2002 21 * 22 * Documentation: 23 * Not publicly available. 24 */ 25 #include <linux/kernel.h> 26 #include <linux/module.h> 27 #include <linux/pci.h> 28 #include <linux/blkdev.h> 29 #include <linux/delay.h> 30 #include <scsi/scsi_host.h> 31 #include <linux/libata.h> 32 33 #define DRV_NAME "pata_cs5520" 34 #define DRV_VERSION "0.6.6" 35 36 struct pio_clocks 37 { 38 int address; 39 int assert; 40 int recovery; 41 }; 42 43 static const struct pio_clocks cs5520_pio_clocks[]={ 44 {3, 6, 11}, 45 {2, 5, 6}, 46 {1, 4, 3}, 47 {1, 3, 2}, 48 {1, 2, 1} 49 }; 50 51 /** 52 * cs5520_set_timings - program PIO timings 53 * @ap: ATA port 54 * @adev: ATA device 55 * 56 * Program the PIO mode timings for the controller according to the pio 57 * clocking table. 58 */ 59 60 static void cs5520_set_timings(struct ata_port *ap, struct ata_device *adev, int pio) 61 { 62 struct pci_dev *pdev = to_pci_dev(ap->host->dev); 63 int slave = adev->devno; 64 65 pio -= XFER_PIO_0; 66 67 /* Channel command timing */ 68 pci_write_config_byte(pdev, 0x62 + ap->port_no, 69 (cs5520_pio_clocks[pio].recovery << 4) | 70 (cs5520_pio_clocks[pio].assert)); 71 /* FIXME: should these use address ? */ 72 /* Read command timing */ 73 pci_write_config_byte(pdev, 0x64 + 4*ap->port_no + slave, 74 (cs5520_pio_clocks[pio].recovery << 4) | 75 (cs5520_pio_clocks[pio].assert)); 76 /* Write command timing */ 77 pci_write_config_byte(pdev, 0x66 + 4*ap->port_no + slave, 78 (cs5520_pio_clocks[pio].recovery << 4) | 79 (cs5520_pio_clocks[pio].assert)); 80 } 81 82 /** 83 * cs5520_set_piomode - program PIO timings 84 * @ap: ATA port 85 * @adev: ATA device 86 * 87 * Program the PIO mode timings for the controller according to the pio 88 * clocking table. 89 */ 90 91 static void cs5520_set_piomode(struct ata_port *ap, struct ata_device *adev) 92 { 93 cs5520_set_timings(ap, adev, adev->pio_mode); 94 } 95 96 static struct scsi_host_template cs5520_sht = { 97 ATA_BMDMA_SHT(DRV_NAME), 98 .sg_tablesize = LIBATA_DUMB_MAX_PRD, 99 }; 100 101 static struct ata_port_operations cs5520_port_ops = { 102 .inherits = &ata_bmdma_port_ops, 103 .qc_prep = ata_bmdma_dumb_qc_prep, 104 .cable_detect = ata_cable_40wire, 105 .set_piomode = cs5520_set_piomode, 106 }; 107 108 static int cs5520_init_one(struct pci_dev *pdev, const struct pci_device_id *id) 109 { 110 static const unsigned int cmd_port[] = { 0x1F0, 0x170 }; 111 static const unsigned int ctl_port[] = { 0x3F6, 0x376 }; 112 struct ata_port_info pi = { 113 .flags = ATA_FLAG_SLAVE_POSS, 114 .pio_mask = ATA_PIO4, 115 .port_ops = &cs5520_port_ops, 116 }; 117 const struct ata_port_info *ppi[2]; 118 u8 pcicfg; 119 void __iomem *iomap[5]; 120 struct ata_host *host; 121 struct ata_ioports *ioaddr; 122 int i, rc; 123 124 rc = pcim_enable_device(pdev); 125 if (rc) 126 return rc; 127 128 /* IDE port enable bits */ 129 pci_read_config_byte(pdev, 0x60, &pcicfg); 130 131 /* Check if the ATA ports are enabled */ 132 if ((pcicfg & 3) == 0) 133 return -ENODEV; 134 135 ppi[0] = ppi[1] = &ata_dummy_port_info; 136 if (pcicfg & 1) 137 ppi[0] = π 138 if (pcicfg & 2) 139 ppi[1] = π 140 141 if ((pcicfg & 0x40) == 0) { 142 dev_warn(&pdev->dev, "DMA mode disabled. Enabling.\n"); 143 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40); 144 } 145 146 pi.mwdma_mask = id->driver_data; 147 148 host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2); 149 if (!host) 150 return -ENOMEM; 151 152 /* Perform set up for DMA */ 153 if (pci_enable_device_io(pdev)) { 154 printk(KERN_ERR DRV_NAME ": unable to configure BAR2.\n"); 155 return -ENODEV; 156 } 157 158 if (dma_set_mask(&pdev->dev, DMA_BIT_MASK(32))) { 159 printk(KERN_ERR DRV_NAME ": unable to configure DMA mask.\n"); 160 return -ENODEV; 161 } 162 if (dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32))) { 163 printk(KERN_ERR DRV_NAME ": unable to configure consistent DMA mask.\n"); 164 return -ENODEV; 165 } 166 167 /* Map IO ports and initialize host accordingly */ 168 iomap[0] = devm_ioport_map(&pdev->dev, cmd_port[0], 8); 169 iomap[1] = devm_ioport_map(&pdev->dev, ctl_port[0], 1); 170 iomap[2] = devm_ioport_map(&pdev->dev, cmd_port[1], 8); 171 iomap[3] = devm_ioport_map(&pdev->dev, ctl_port[1], 1); 172 iomap[4] = pcim_iomap(pdev, 2, 0); 173 174 if (!iomap[0] || !iomap[1] || !iomap[2] || !iomap[3] || !iomap[4]) 175 return -ENOMEM; 176 177 ioaddr = &host->ports[0]->ioaddr; 178 ioaddr->cmd_addr = iomap[0]; 179 ioaddr->ctl_addr = iomap[1]; 180 ioaddr->altstatus_addr = iomap[1]; 181 ioaddr->bmdma_addr = iomap[4]; 182 ata_sff_std_ports(ioaddr); 183 184 ata_port_desc(host->ports[0], 185 "cmd 0x%x ctl 0x%x", cmd_port[0], ctl_port[0]); 186 ata_port_pbar_desc(host->ports[0], 4, 0, "bmdma"); 187 188 ioaddr = &host->ports[1]->ioaddr; 189 ioaddr->cmd_addr = iomap[2]; 190 ioaddr->ctl_addr = iomap[3]; 191 ioaddr->altstatus_addr = iomap[3]; 192 ioaddr->bmdma_addr = iomap[4] + 8; 193 ata_sff_std_ports(ioaddr); 194 195 ata_port_desc(host->ports[1], 196 "cmd 0x%x ctl 0x%x", cmd_port[1], ctl_port[1]); 197 ata_port_pbar_desc(host->ports[1], 4, 8, "bmdma"); 198 199 /* activate the host */ 200 pci_set_master(pdev); 201 rc = ata_host_start(host); 202 if (rc) 203 return rc; 204 205 for (i = 0; i < 2; i++) { 206 static const int irq[] = { 14, 15 }; 207 struct ata_port *ap = host->ports[i]; 208 209 if (ata_port_is_dummy(ap)) 210 continue; 211 212 rc = devm_request_irq(&pdev->dev, irq[ap->port_no], 213 ata_bmdma_interrupt, 0, DRV_NAME, host); 214 if (rc) 215 return rc; 216 217 ata_port_desc(ap, "irq %d", irq[i]); 218 } 219 220 return ata_host_register(host, &cs5520_sht); 221 } 222 223 #ifdef CONFIG_PM_SLEEP 224 /** 225 * cs5520_reinit_one - device resume 226 * @pdev: PCI device 227 * 228 * Do any reconfiguration work needed by a resume from RAM. We need 229 * to restore DMA mode support on BIOSen which disabled it 230 */ 231 232 static int cs5520_reinit_one(struct pci_dev *pdev) 233 { 234 struct ata_host *host = pci_get_drvdata(pdev); 235 u8 pcicfg; 236 int rc; 237 238 rc = ata_pci_device_do_resume(pdev); 239 if (rc) 240 return rc; 241 242 pci_read_config_byte(pdev, 0x60, &pcicfg); 243 if ((pcicfg & 0x40) == 0) 244 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40); 245 246 ata_host_resume(host); 247 return 0; 248 } 249 250 /** 251 * cs5520_pci_device_suspend - device suspend 252 * @pdev: PCI device 253 * 254 * We have to cut and waste bits from the standard method because 255 * the 5520 is a bit odd and not just a pure ATA device. As a result 256 * we must not disable it. The needed code is short and this avoids 257 * chip specific mess in the core code. 258 */ 259 260 static int cs5520_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg) 261 { 262 struct ata_host *host = pci_get_drvdata(pdev); 263 int rc = 0; 264 265 rc = ata_host_suspend(host, mesg); 266 if (rc) 267 return rc; 268 269 pci_save_state(pdev); 270 return 0; 271 } 272 #endif /* CONFIG_PM_SLEEP */ 273 274 /* For now keep DMA off. We can set it for all but A rev CS5510 once the 275 core ATA code can handle it */ 276 277 static const struct pci_device_id pata_cs5520[] = { 278 { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5510), }, 279 { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5520), }, 280 281 { }, 282 }; 283 284 static struct pci_driver cs5520_pci_driver = { 285 .name = DRV_NAME, 286 .id_table = pata_cs5520, 287 .probe = cs5520_init_one, 288 .remove = ata_pci_remove_one, 289 #ifdef CONFIG_PM_SLEEP 290 .suspend = cs5520_pci_device_suspend, 291 .resume = cs5520_reinit_one, 292 #endif 293 }; 294 295 module_pci_driver(cs5520_pci_driver); 296 297 MODULE_AUTHOR("Alan Cox"); 298 MODULE_DESCRIPTION("low-level driver for Cyrix CS5510/5520"); 299 MODULE_LICENSE("GPL"); 300 MODULE_DEVICE_TABLE(pci, pata_cs5520); 301 MODULE_VERSION(DRV_VERSION); 302