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 * @pio: PIO ID 56 * 57 * Program the PIO mode timings for the controller according to the pio 58 * clocking table. 59 */ 60 61 static void cs5520_set_timings(struct ata_port *ap, struct ata_device *adev, int pio) 62 { 63 struct pci_dev *pdev = to_pci_dev(ap->host->dev); 64 int slave = adev->devno; 65 66 pio -= XFER_PIO_0; 67 68 /* Channel command timing */ 69 pci_write_config_byte(pdev, 0x62 + ap->port_no, 70 (cs5520_pio_clocks[pio].recovery << 4) | 71 (cs5520_pio_clocks[pio].assert)); 72 /* FIXME: should these use address ? */ 73 /* Read command timing */ 74 pci_write_config_byte(pdev, 0x64 + 4*ap->port_no + slave, 75 (cs5520_pio_clocks[pio].recovery << 4) | 76 (cs5520_pio_clocks[pio].assert)); 77 /* Write command timing */ 78 pci_write_config_byte(pdev, 0x66 + 4*ap->port_no + slave, 79 (cs5520_pio_clocks[pio].recovery << 4) | 80 (cs5520_pio_clocks[pio].assert)); 81 } 82 83 /** 84 * cs5520_set_piomode - program PIO timings 85 * @ap: ATA port 86 * @adev: ATA device 87 * 88 * Program the PIO mode timings for the controller according to the pio 89 * clocking table. 90 */ 91 92 static void cs5520_set_piomode(struct ata_port *ap, struct ata_device *adev) 93 { 94 cs5520_set_timings(ap, adev, adev->pio_mode); 95 } 96 97 static const struct scsi_host_template cs5520_sht = { 98 ATA_BASE_SHT(DRV_NAME), 99 .sg_tablesize = LIBATA_DUMB_MAX_PRD, 100 .dma_boundary = ATA_DMA_BOUNDARY, 101 }; 102 103 static struct ata_port_operations cs5520_port_ops = { 104 .inherits = &ata_bmdma_port_ops, 105 .qc_prep = ata_bmdma_dumb_qc_prep, 106 .cable_detect = ata_cable_40wire, 107 .set_piomode = cs5520_set_piomode, 108 }; 109 110 static int cs5520_init_one(struct pci_dev *pdev, const struct pci_device_id *id) 111 { 112 static const unsigned int cmd_port[] = { 0x1F0, 0x170 }; 113 static const unsigned int ctl_port[] = { 0x3F6, 0x376 }; 114 struct ata_port_info pi = { 115 .flags = ATA_FLAG_SLAVE_POSS, 116 .pio_mask = ATA_PIO4, 117 .port_ops = &cs5520_port_ops, 118 }; 119 const struct ata_port_info *ppi[2]; 120 u8 pcicfg; 121 void __iomem *iomap[5]; 122 struct ata_host *host; 123 struct ata_ioports *ioaddr; 124 int i, rc; 125 126 rc = pcim_enable_device(pdev); 127 if (rc) 128 return rc; 129 130 /* IDE port enable bits */ 131 pci_read_config_byte(pdev, 0x60, &pcicfg); 132 133 /* Check if the ATA ports are enabled */ 134 if ((pcicfg & 3) == 0) 135 return -ENODEV; 136 137 ppi[0] = ppi[1] = &ata_dummy_port_info; 138 if (pcicfg & 1) 139 ppi[0] = π 140 if (pcicfg & 2) 141 ppi[1] = π 142 143 if ((pcicfg & 0x40) == 0) { 144 dev_warn(&pdev->dev, "DMA mode disabled. Enabling.\n"); 145 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40); 146 } 147 148 pi.mwdma_mask = id->driver_data; 149 150 host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2); 151 if (!host) 152 return -ENOMEM; 153 154 /* Perform set up for DMA */ 155 if (pci_enable_device_io(pdev)) { 156 dev_err(&pdev->dev, "unable to configure BAR2.\n"); 157 return -ENODEV; 158 } 159 160 if (dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32))) { 161 dev_err(&pdev->dev, "unable to configure DMA mask.\n"); 162 return -ENODEV; 163 } 164 165 /* Map IO ports and initialize host accordingly */ 166 iomap[0] = devm_ioport_map(&pdev->dev, cmd_port[0], 8); 167 iomap[1] = devm_ioport_map(&pdev->dev, ctl_port[0], 1); 168 iomap[2] = devm_ioport_map(&pdev->dev, cmd_port[1], 8); 169 iomap[3] = devm_ioport_map(&pdev->dev, ctl_port[1], 1); 170 iomap[4] = pcim_iomap(pdev, 2, 0); 171 172 if (!iomap[0] || !iomap[1] || !iomap[2] || !iomap[3] || !iomap[4]) 173 return -ENOMEM; 174 175 ioaddr = &host->ports[0]->ioaddr; 176 ioaddr->cmd_addr = iomap[0]; 177 ioaddr->ctl_addr = iomap[1]; 178 ioaddr->altstatus_addr = iomap[1]; 179 ioaddr->bmdma_addr = iomap[4]; 180 ata_sff_std_ports(ioaddr); 181 182 ata_port_desc(host->ports[0], 183 "cmd 0x%x ctl 0x%x", cmd_port[0], ctl_port[0]); 184 ata_port_pbar_desc(host->ports[0], 4, 0, "bmdma"); 185 186 ioaddr = &host->ports[1]->ioaddr; 187 ioaddr->cmd_addr = iomap[2]; 188 ioaddr->ctl_addr = iomap[3]; 189 ioaddr->altstatus_addr = iomap[3]; 190 ioaddr->bmdma_addr = iomap[4] + 8; 191 ata_sff_std_ports(ioaddr); 192 193 ata_port_desc(host->ports[1], 194 "cmd 0x%x ctl 0x%x", cmd_port[1], ctl_port[1]); 195 ata_port_pbar_desc(host->ports[1], 4, 8, "bmdma"); 196 197 /* activate the host */ 198 pci_set_master(pdev); 199 rc = ata_host_start(host); 200 if (rc) 201 return rc; 202 203 for (i = 0; i < 2; i++) { 204 static const int irq[] = { 14, 15 }; 205 struct ata_port *ap = host->ports[i]; 206 207 if (ata_port_is_dummy(ap)) 208 continue; 209 210 rc = devm_request_irq(&pdev->dev, irq[ap->port_no], 211 ata_bmdma_interrupt, 0, DRV_NAME, host); 212 if (rc) 213 return rc; 214 215 ata_port_desc(ap, "irq %d", irq[i]); 216 } 217 218 return ata_host_register(host, &cs5520_sht); 219 } 220 221 #ifdef CONFIG_PM_SLEEP 222 /** 223 * cs5520_reinit_one - device resume 224 * @pdev: PCI device 225 * 226 * Do any reconfiguration work needed by a resume from RAM. We need 227 * to restore DMA mode support on BIOSen which disabled it 228 */ 229 230 static int cs5520_reinit_one(struct pci_dev *pdev) 231 { 232 struct ata_host *host = pci_get_drvdata(pdev); 233 u8 pcicfg; 234 int rc; 235 236 rc = ata_pci_device_do_resume(pdev); 237 if (rc) 238 return rc; 239 240 pci_read_config_byte(pdev, 0x60, &pcicfg); 241 if ((pcicfg & 0x40) == 0) 242 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40); 243 244 ata_host_resume(host); 245 return 0; 246 } 247 248 /** 249 * cs5520_pci_device_suspend - device suspend 250 * @pdev: PCI device 251 * @mesg: PM event message 252 * 253 * We have to cut and waste bits from the standard method because 254 * the 5520 is a bit odd and not just a pure ATA device. As a result 255 * we must not disable it. The needed code is short and this avoids 256 * chip specific mess in the core code. 257 */ 258 259 static int cs5520_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg) 260 { 261 struct ata_host *host = pci_get_drvdata(pdev); 262 263 ata_host_suspend(host, mesg); 264 265 pci_save_state(pdev); 266 return 0; 267 } 268 #endif /* CONFIG_PM_SLEEP */ 269 270 /* For now keep DMA off. We can set it for all but A rev CS5510 once the 271 core ATA code can handle it */ 272 273 static const struct pci_device_id pata_cs5520[] = { 274 { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5510), }, 275 { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5520), }, 276 277 { }, 278 }; 279 280 static struct pci_driver cs5520_pci_driver = { 281 .name = DRV_NAME, 282 .id_table = pata_cs5520, 283 .probe = cs5520_init_one, 284 .remove = ata_pci_remove_one, 285 #ifdef CONFIG_PM_SLEEP 286 .suspend = cs5520_pci_device_suspend, 287 .resume = cs5520_reinit_one, 288 #endif 289 }; 290 291 module_pci_driver(cs5520_pci_driver); 292 293 MODULE_AUTHOR("Alan Cox"); 294 MODULE_DESCRIPTION("low-level driver for Cyrix CS5510/5520"); 295 MODULE_LICENSE("GPL"); 296 MODULE_DEVICE_TABLE(pci, pata_cs5520); 297 MODULE_VERSION(DRV_VERSION); 298