xref: /openbmc/linux/drivers/usb/host/ehci-ps3.c (revision addee42a)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  PS3 EHCI Host Controller driver
4  *
5  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
6  *  Copyright 2006 Sony Corp.
7  */
8 
9 #include <asm/firmware.h>
10 #include <asm/ps3.h>
11 
12 static void ps3_ehci_setup_insnreg(struct ehci_hcd *ehci)
13 {
14 	/* PS3 HC internal setup register offsets. */
15 
16 	enum ps3_ehci_hc_insnreg {
17 		ps3_ehci_hc_insnreg01 = 0x084,
18 		ps3_ehci_hc_insnreg02 = 0x088,
19 		ps3_ehci_hc_insnreg03 = 0x08c,
20 	};
21 
22 	/* PS3 EHCI HC errata fix 316 - The PS3 EHCI HC will reset its
23 	 * internal INSNREGXX setup regs back to the chip default values
24 	 * on Host Controller Reset (CMD_RESET) or Light Host Controller
25 	 * Reset (CMD_LRESET).  The work-around for this is for the HC
26 	 * driver to re-initialise these regs when ever the HC is reset.
27 	 */
28 
29 	/* Set burst transfer counts to 256 out, 32 in. */
30 
31 	writel_be(0x01000020, (void __iomem *)ehci->regs +
32 		ps3_ehci_hc_insnreg01);
33 
34 	/* Enable burst transfer counts. */
35 
36 	writel_be(0x00000001, (void __iomem *)ehci->regs +
37 		ps3_ehci_hc_insnreg03);
38 }
39 
40 static int ps3_ehci_hc_reset(struct usb_hcd *hcd)
41 {
42 	int result;
43 	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
44 
45 	ehci->big_endian_mmio = 1;
46 	ehci->caps = hcd->regs;
47 
48 	result = ehci_setup(hcd);
49 	if (result)
50 		return result;
51 
52 	ps3_ehci_setup_insnreg(ehci);
53 
54 	return result;
55 }
56 
57 static const struct hc_driver ps3_ehci_hc_driver = {
58 	.description		= hcd_name,
59 	.product_desc		= "PS3 EHCI Host Controller",
60 	.hcd_priv_size		= sizeof(struct ehci_hcd),
61 	.irq			= ehci_irq,
62 	.flags			= HCD_MEMORY | HCD_USB2 | HCD_BH,
63 	.reset			= ps3_ehci_hc_reset,
64 	.start			= ehci_run,
65 	.stop			= ehci_stop,
66 	.shutdown		= ehci_shutdown,
67 	.urb_enqueue		= ehci_urb_enqueue,
68 	.urb_dequeue		= ehci_urb_dequeue,
69 	.endpoint_disable	= ehci_endpoint_disable,
70 	.endpoint_reset		= ehci_endpoint_reset,
71 	.get_frame_number	= ehci_get_frame,
72 	.hub_status_data	= ehci_hub_status_data,
73 	.hub_control		= ehci_hub_control,
74 #if defined(CONFIG_PM)
75 	.bus_suspend		= ehci_bus_suspend,
76 	.bus_resume		= ehci_bus_resume,
77 #endif
78 	.relinquish_port	= ehci_relinquish_port,
79 	.port_handed_over	= ehci_port_handed_over,
80 
81 	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
82 };
83 
84 static int ps3_ehci_probe(struct ps3_system_bus_device *dev)
85 {
86 	int result;
87 	struct usb_hcd *hcd;
88 	unsigned int virq;
89 	static u64 dummy_mask = DMA_BIT_MASK(32);
90 
91 	if (usb_disabled()) {
92 		result = -ENODEV;
93 		goto fail_start;
94 	}
95 
96 	result = ps3_open_hv_device(dev);
97 
98 	if (result) {
99 		dev_dbg(&dev->core, "%s:%d: ps3_open_hv_device failed\n",
100 			__func__, __LINE__);
101 		goto fail_open;
102 	}
103 
104 	result = ps3_dma_region_create(dev->d_region);
105 
106 	if (result) {
107 		dev_dbg(&dev->core, "%s:%d: ps3_dma_region_create failed: "
108 			"(%d)\n", __func__, __LINE__, result);
109 		BUG_ON("check region type");
110 		goto fail_dma_region;
111 	}
112 
113 	result = ps3_mmio_region_create(dev->m_region);
114 
115 	if (result) {
116 		dev_dbg(&dev->core, "%s:%d: ps3_map_mmio_region failed\n",
117 			__func__, __LINE__);
118 		result = -EPERM;
119 		goto fail_mmio_region;
120 	}
121 
122 	dev_dbg(&dev->core, "%s:%d: mmio mapped_addr %lxh\n", __func__,
123 		__LINE__, dev->m_region->lpar_addr);
124 
125 	result = ps3_io_irq_setup(PS3_BINDING_CPU_ANY, dev->interrupt_id, &virq);
126 
127 	if (result) {
128 		dev_dbg(&dev->core, "%s:%d: ps3_construct_io_irq(%d) failed.\n",
129 			__func__, __LINE__, virq);
130 		result = -EPERM;
131 		goto fail_irq;
132 	}
133 
134 	dev->core.dma_mask = &dummy_mask; /* FIXME: for improper usb code */
135 
136 	hcd = usb_create_hcd(&ps3_ehci_hc_driver, &dev->core, dev_name(&dev->core));
137 
138 	if (!hcd) {
139 		dev_dbg(&dev->core, "%s:%d: usb_create_hcd failed\n", __func__,
140 			__LINE__);
141 		result = -ENOMEM;
142 		goto fail_create_hcd;
143 	}
144 
145 	hcd->rsrc_start = dev->m_region->lpar_addr;
146 	hcd->rsrc_len = dev->m_region->len;
147 
148 	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name))
149 		dev_dbg(&dev->core, "%s:%d: request_mem_region failed\n",
150 			__func__, __LINE__);
151 
152 	hcd->regs = ioremap(dev->m_region->lpar_addr, dev->m_region->len);
153 
154 	if (!hcd->regs) {
155 		dev_dbg(&dev->core, "%s:%d: ioremap failed\n", __func__,
156 			__LINE__);
157 		result = -EPERM;
158 		goto fail_ioremap;
159 	}
160 
161 	dev_dbg(&dev->core, "%s:%d: hcd->rsrc_start %lxh\n", __func__, __LINE__,
162 		(unsigned long)hcd->rsrc_start);
163 	dev_dbg(&dev->core, "%s:%d: hcd->rsrc_len   %lxh\n", __func__, __LINE__,
164 		(unsigned long)hcd->rsrc_len);
165 	dev_dbg(&dev->core, "%s:%d: hcd->regs       %lxh\n", __func__, __LINE__,
166 		(unsigned long)hcd->regs);
167 	dev_dbg(&dev->core, "%s:%d: virq            %lu\n", __func__, __LINE__,
168 		(unsigned long)virq);
169 
170 	ps3_system_bus_set_drvdata(dev, hcd);
171 
172 	result = usb_add_hcd(hcd, virq, 0);
173 
174 	if (result) {
175 		dev_dbg(&dev->core, "%s:%d: usb_add_hcd failed (%d)\n",
176 			__func__, __LINE__, result);
177 		goto fail_add_hcd;
178 	}
179 
180 	device_wakeup_enable(hcd->self.controller);
181 	return result;
182 
183 fail_add_hcd:
184 	iounmap(hcd->regs);
185 fail_ioremap:
186 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
187 	usb_put_hcd(hcd);
188 fail_create_hcd:
189 	ps3_io_irq_destroy(virq);
190 fail_irq:
191 	ps3_free_mmio_region(dev->m_region);
192 fail_mmio_region:
193 	ps3_dma_region_free(dev->d_region);
194 fail_dma_region:
195 	ps3_close_hv_device(dev);
196 fail_open:
197 fail_start:
198 	return result;
199 }
200 
201 static int ps3_ehci_remove(struct ps3_system_bus_device *dev)
202 {
203 	unsigned int tmp;
204 	struct usb_hcd *hcd = ps3_system_bus_get_drvdata(dev);
205 
206 	BUG_ON(!hcd);
207 
208 	dev_dbg(&dev->core, "%s:%d: regs %p\n", __func__, __LINE__, hcd->regs);
209 	dev_dbg(&dev->core, "%s:%d: irq %u\n", __func__, __LINE__, hcd->irq);
210 
211 	tmp = hcd->irq;
212 
213 	usb_remove_hcd(hcd);
214 
215 	ps3_system_bus_set_drvdata(dev, NULL);
216 
217 	BUG_ON(!hcd->regs);
218 	iounmap(hcd->regs);
219 
220 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
221 	usb_put_hcd(hcd);
222 
223 	ps3_io_irq_destroy(tmp);
224 	ps3_free_mmio_region(dev->m_region);
225 
226 	ps3_dma_region_free(dev->d_region);
227 	ps3_close_hv_device(dev);
228 
229 	return 0;
230 }
231 
232 static int __init ps3_ehci_driver_register(struct ps3_system_bus_driver *drv)
233 {
234 	return firmware_has_feature(FW_FEATURE_PS3_LV1)
235 		? ps3_system_bus_driver_register(drv)
236 		: 0;
237 }
238 
239 static void ps3_ehci_driver_unregister(struct ps3_system_bus_driver *drv)
240 {
241 	if (firmware_has_feature(FW_FEATURE_PS3_LV1))
242 		ps3_system_bus_driver_unregister(drv);
243 }
244 
245 MODULE_ALIAS(PS3_MODULE_ALIAS_EHCI);
246 
247 static struct ps3_system_bus_driver ps3_ehci_driver = {
248 	.core.name = "ps3-ehci-driver",
249 	.core.owner = THIS_MODULE,
250 	.match_id = PS3_MATCH_ID_EHCI,
251 	.probe = ps3_ehci_probe,
252 	.remove = ps3_ehci_remove,
253 	.shutdown = ps3_ehci_remove,
254 };
255