xref: /openbmc/linux/drivers/ata/sata_uli.c (revision 643d1f7f)
1 /*
2  *  sata_uli.c - ULi Electronics SATA
3  *
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2, or (at your option)
8  *  any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; see the file COPYING.  If not, write to
17  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
18  *
19  *
20  *  libata documentation is available via 'make {ps|pdf}docs',
21  *  as Documentation/DocBook/libata.*
22  *
23  *  Hardware documentation available under NDA.
24  *
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 <linux/interrupt.h>
34 #include <linux/device.h>
35 #include <scsi/scsi_host.h>
36 #include <linux/libata.h>
37 
38 #define DRV_NAME	"sata_uli"
39 #define DRV_VERSION	"1.3"
40 
41 enum {
42 	uli_5289		= 0,
43 	uli_5287		= 1,
44 	uli_5281		= 2,
45 
46 	uli_max_ports		= 4,
47 
48 	/* PCI configuration registers */
49 	ULI5287_BASE		= 0x90, /* sata0 phy SCR registers */
50 	ULI5287_OFFS		= 0x10, /* offset from sata0->sata1 phy regs */
51 	ULI5281_BASE		= 0x60, /* sata0 phy SCR  registers */
52 	ULI5281_OFFS		= 0x60, /* offset from sata0->sata1 phy regs */
53 };
54 
55 struct uli_priv {
56 	unsigned int		scr_cfg_addr[uli_max_ports];
57 };
58 
59 static int uli_init_one(struct pci_dev *pdev, const struct pci_device_id *ent);
60 static int uli_scr_read(struct ata_port *ap, unsigned int sc_reg, u32 *val);
61 static int uli_scr_write(struct ata_port *ap, unsigned int sc_reg, u32 val);
62 
63 static const struct pci_device_id uli_pci_tbl[] = {
64 	{ PCI_VDEVICE(AL, 0x5289), uli_5289 },
65 	{ PCI_VDEVICE(AL, 0x5287), uli_5287 },
66 	{ PCI_VDEVICE(AL, 0x5281), uli_5281 },
67 
68 	{ }	/* terminate list */
69 };
70 
71 static struct pci_driver uli_pci_driver = {
72 	.name			= DRV_NAME,
73 	.id_table		= uli_pci_tbl,
74 	.probe			= uli_init_one,
75 	.remove			= ata_pci_remove_one,
76 };
77 
78 static struct scsi_host_template uli_sht = {
79 	.module			= THIS_MODULE,
80 	.name			= DRV_NAME,
81 	.ioctl			= ata_scsi_ioctl,
82 	.queuecommand		= ata_scsi_queuecmd,
83 	.can_queue		= ATA_DEF_QUEUE,
84 	.this_id		= ATA_SHT_THIS_ID,
85 	.sg_tablesize		= LIBATA_MAX_PRD,
86 	.cmd_per_lun		= ATA_SHT_CMD_PER_LUN,
87 	.emulated		= ATA_SHT_EMULATED,
88 	.use_clustering		= ATA_SHT_USE_CLUSTERING,
89 	.proc_name		= DRV_NAME,
90 	.dma_boundary		= ATA_DMA_BOUNDARY,
91 	.slave_configure	= ata_scsi_slave_config,
92 	.slave_destroy		= ata_scsi_slave_destroy,
93 	.bios_param		= ata_std_bios_param,
94 };
95 
96 static const struct ata_port_operations uli_ops = {
97 	.tf_load		= ata_tf_load,
98 	.tf_read		= ata_tf_read,
99 	.check_status		= ata_check_status,
100 	.exec_command		= ata_exec_command,
101 	.dev_select		= ata_std_dev_select,
102 
103 	.bmdma_setup            = ata_bmdma_setup,
104 	.bmdma_start            = ata_bmdma_start,
105 	.bmdma_stop		= ata_bmdma_stop,
106 	.bmdma_status		= ata_bmdma_status,
107 	.qc_prep		= ata_qc_prep,
108 	.qc_issue		= ata_qc_issue_prot,
109 	.data_xfer		= ata_data_xfer,
110 
111 	.freeze			= ata_bmdma_freeze,
112 	.thaw			= ata_bmdma_thaw,
113 	.error_handler		= ata_bmdma_error_handler,
114 	.post_internal_cmd	= ata_bmdma_post_internal_cmd,
115 
116 	.irq_clear		= ata_bmdma_irq_clear,
117 	.irq_on			= ata_irq_on,
118 
119 	.scr_read		= uli_scr_read,
120 	.scr_write		= uli_scr_write,
121 
122 	.port_start		= ata_port_start,
123 };
124 
125 static const struct ata_port_info uli_port_info = {
126 	.flags		= ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
127 			  ATA_FLAG_IGN_SIMPLEX,
128 	.pio_mask       = 0x1f,		/* pio0-4 */
129 	.udma_mask      = ATA_UDMA6,
130 	.port_ops       = &uli_ops,
131 };
132 
133 
134 MODULE_AUTHOR("Peer Chen");
135 MODULE_DESCRIPTION("low-level driver for ULi Electronics SATA controller");
136 MODULE_LICENSE("GPL");
137 MODULE_DEVICE_TABLE(pci, uli_pci_tbl);
138 MODULE_VERSION(DRV_VERSION);
139 
140 static unsigned int get_scr_cfg_addr(struct ata_port *ap, unsigned int sc_reg)
141 {
142 	struct uli_priv *hpriv = ap->host->private_data;
143 	return hpriv->scr_cfg_addr[ap->port_no] + (4 * sc_reg);
144 }
145 
146 static u32 uli_scr_cfg_read(struct ata_port *ap, unsigned int sc_reg)
147 {
148 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
149 	unsigned int cfg_addr = get_scr_cfg_addr(ap, sc_reg);
150 	u32 val;
151 
152 	pci_read_config_dword(pdev, cfg_addr, &val);
153 	return val;
154 }
155 
156 static void uli_scr_cfg_write(struct ata_port *ap, unsigned int scr, u32 val)
157 {
158 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
159 	unsigned int cfg_addr = get_scr_cfg_addr(ap, scr);
160 
161 	pci_write_config_dword(pdev, cfg_addr, val);
162 }
163 
164 static int uli_scr_read(struct ata_port *ap, unsigned int sc_reg, u32 *val)
165 {
166 	if (sc_reg > SCR_CONTROL)
167 		return -EINVAL;
168 
169 	*val = uli_scr_cfg_read(ap, sc_reg);
170 	return 0;
171 }
172 
173 static int uli_scr_write(struct ata_port *ap, unsigned int sc_reg, u32 val)
174 {
175 	if (sc_reg > SCR_CONTROL) //SCR_CONTROL=2, SCR_ERROR=1, SCR_STATUS=0
176 		return -EINVAL;
177 
178 	uli_scr_cfg_write(ap, sc_reg, val);
179 	return 0;
180 }
181 
182 static int uli_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
183 {
184 	static int printed_version;
185 	const struct ata_port_info *ppi[] = { &uli_port_info, NULL };
186 	unsigned int board_idx = (unsigned int) ent->driver_data;
187 	struct ata_host *host;
188 	struct uli_priv *hpriv;
189 	void __iomem * const *iomap;
190 	struct ata_ioports *ioaddr;
191 	int n_ports, rc;
192 
193 	if (!printed_version++)
194 		dev_printk(KERN_INFO, &pdev->dev, "version " DRV_VERSION "\n");
195 
196 	rc = pcim_enable_device(pdev);
197 	if (rc)
198 		return rc;
199 
200 	n_ports = 2;
201 	if (board_idx == uli_5287)
202 		n_ports = 4;
203 
204 	/* allocate the host */
205 	host = ata_host_alloc_pinfo(&pdev->dev, ppi, n_ports);
206 	if (!host)
207 		return -ENOMEM;
208 
209 	hpriv = devm_kzalloc(&pdev->dev, sizeof(*hpriv), GFP_KERNEL);
210 	if (!hpriv)
211 		return -ENOMEM;
212 	host->private_data = hpriv;
213 
214 	/* the first two ports are standard SFF */
215 	rc = ata_pci_init_sff_host(host);
216 	if (rc)
217 		return rc;
218 
219 	rc = ata_pci_init_bmdma(host);
220 	if (rc)
221 		return rc;
222 
223 	iomap = host->iomap;
224 
225 	switch (board_idx) {
226 	case uli_5287:
227 		/* If there are four, the last two live right after
228 		 * the standard SFF ports.
229 		 */
230 		hpriv->scr_cfg_addr[0] = ULI5287_BASE;
231 		hpriv->scr_cfg_addr[1] = ULI5287_BASE + ULI5287_OFFS;
232 
233 		ioaddr = &host->ports[2]->ioaddr;
234 		ioaddr->cmd_addr = iomap[0] + 8;
235 		ioaddr->altstatus_addr =
236 		ioaddr->ctl_addr = (void __iomem *)
237 			((unsigned long)iomap[1] | ATA_PCI_CTL_OFS) + 4;
238 		ioaddr->bmdma_addr = iomap[4] + 16;
239 		hpriv->scr_cfg_addr[2] = ULI5287_BASE + ULI5287_OFFS*4;
240 		ata_std_ports(ioaddr);
241 
242 		ata_port_desc(host->ports[2],
243 			"cmd 0x%llx ctl 0x%llx bmdma 0x%llx",
244 			(unsigned long long)pci_resource_start(pdev, 0) + 8,
245 			((unsigned long long)pci_resource_start(pdev, 1) | ATA_PCI_CTL_OFS) + 4,
246 			(unsigned long long)pci_resource_start(pdev, 4) + 16);
247 
248 		ioaddr = &host->ports[3]->ioaddr;
249 		ioaddr->cmd_addr = iomap[2] + 8;
250 		ioaddr->altstatus_addr =
251 		ioaddr->ctl_addr = (void __iomem *)
252 			((unsigned long)iomap[3] | ATA_PCI_CTL_OFS) + 4;
253 		ioaddr->bmdma_addr = iomap[4] + 24;
254 		hpriv->scr_cfg_addr[3] = ULI5287_BASE + ULI5287_OFFS*5;
255 		ata_std_ports(ioaddr);
256 
257 		ata_port_desc(host->ports[2],
258 			"cmd 0x%llx ctl 0x%llx bmdma 0x%llx",
259 			(unsigned long long)pci_resource_start(pdev, 2) + 9,
260 			((unsigned long long)pci_resource_start(pdev, 3) | ATA_PCI_CTL_OFS) + 4,
261 			(unsigned long long)pci_resource_start(pdev, 4) + 24);
262 
263 		break;
264 
265 	case uli_5289:
266 		hpriv->scr_cfg_addr[0] = ULI5287_BASE;
267 		hpriv->scr_cfg_addr[1] = ULI5287_BASE + ULI5287_OFFS;
268 		break;
269 
270 	case uli_5281:
271 		hpriv->scr_cfg_addr[0] = ULI5281_BASE;
272 		hpriv->scr_cfg_addr[1] = ULI5281_BASE + ULI5281_OFFS;
273 		break;
274 
275 	default:
276 		BUG();
277 		break;
278 	}
279 
280 	pci_set_master(pdev);
281 	pci_intx(pdev, 1);
282 	return ata_host_activate(host, pdev->irq, ata_interrupt, IRQF_SHARED,
283 				 &uli_sht);
284 }
285 
286 static int __init uli_init(void)
287 {
288 	return pci_register_driver(&uli_pci_driver);
289 }
290 
291 static void __exit uli_exit(void)
292 {
293 	pci_unregister_driver(&uli_pci_driver);
294 }
295 
296 
297 module_init(uli_init);
298 module_exit(uli_exit);
299