a10_ehci.c revision 266337 
1/*-
2 * Copyright (c) 2012 Ganbold Tsagaankhuu <ganbold@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27/*
28 * Allwinner A10 attachment driver for the USB Enhanced Host Controller.
29 */
30
31#include <sys/cdefs.h>
32__FBSDID("$FreeBSD: stable/10/sys/arm/allwinner/a10_ehci.c 266337 2014-05-17 18:53:36Z ian $");
33
34#include "opt_bus.h"
35
36#include <sys/param.h>
37#include <sys/systm.h>
38#include <sys/bus.h>
39#include <sys/rman.h>
40#include <sys/condvar.h>
41#include <sys/kernel.h>
42#include <sys/module.h>
43#include <sys/gpio.h>
44
45#include <machine/bus.h>
46#include <dev/ofw/ofw_bus.h>
47#include <dev/ofw/ofw_bus_subr.h>
48
49#include <dev/usb/usb.h>
50#include <dev/usb/usbdi.h>
51
52#include <dev/usb/usb_core.h>
53#include <dev/usb/usb_busdma.h>
54#include <dev/usb/usb_process.h>
55#include <dev/usb/usb_util.h>
56
57#include <dev/usb/usb_controller.h>
58#include <dev/usb/usb_bus.h>
59#include <dev/usb/controller/ehci.h>
60#include <dev/usb/controller/ehcireg.h>
61
62#include "gpio_if.h"
63
64#include "a10_clk.h"
65
66#define EHCI_HC_DEVSTR			"Allwinner Integrated USB 2.0 controller"
67
68#define SW_USB_PMU_IRQ_ENABLE		0x800
69
70#define SW_SDRAM_REG_HPCR_USB1		(0x250 + ((1 << 2) * 4))
71#define SW_SDRAM_REG_HPCR_USB2		(0x250 + ((1 << 2) * 5))
72#define SW_SDRAM_BP_HPCR_ACCESS		(1 << 0)
73
74#define SW_ULPI_BYPASS			(1 << 0)
75#define SW_AHB_INCRX_ALIGN		(1 << 8)
76#define SW_AHB_INCR4			(1 << 9)
77#define SW_AHB_INCR8			(1 << 10)
78#define GPIO_USB1_PWR			230
79#define GPIO_USB2_PWR			227
80
81#define A10_READ_4(sc, reg)		\
82	bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg)
83
84#define A10_WRITE_4(sc, reg, data)	\
85	bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg, data)
86
87static device_attach_t a10_ehci_attach;
88static device_detach_t a10_ehci_detach;
89
90bs_r_1_proto(reversed);
91bs_w_1_proto(reversed);
92
93static int
94a10_ehci_probe(device_t self)
95{
96
97	if (!ofw_bus_status_okay(self))
98		return (ENXIO);
99
100	if (!ofw_bus_is_compatible(self, "allwinner,usb-ehci"))
101		return (ENXIO);
102
103	device_set_desc(self, EHCI_HC_DEVSTR);
104
105	return (BUS_PROBE_DEFAULT);
106}
107
108static int
109a10_ehci_attach(device_t self)
110{
111	ehci_softc_t *sc = device_get_softc(self);
112	bus_space_handle_t bsh;
113	device_t sc_gpio_dev;
114	int err;
115	int rid;
116	uint32_t reg_value = 0;
117
118	/* initialise some bus fields */
119	sc->sc_bus.parent = self;
120	sc->sc_bus.devices = sc->sc_devices;
121	sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
122
123	/* get all DMA memory */
124	if (usb_bus_mem_alloc_all(&sc->sc_bus,
125	    USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
126		return (ENOMEM);
127	}
128
129	sc->sc_bus.usbrev = USB_REV_2_0;
130
131	rid = 0;
132	sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE);
133	if (!sc->sc_io_res) {
134		device_printf(self, "Could not map memory\n");
135		goto error;
136	}
137
138	sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
139	sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
140	bsh = rman_get_bushandle(sc->sc_io_res);
141
142	sc->sc_io_size = rman_get_size(sc->sc_io_res);
143
144	if (bus_space_subregion(sc->sc_io_tag, bsh, 0x00,
145	    sc->sc_io_size, &sc->sc_io_hdl) != 0)
146		panic("%s: unable to subregion USB host registers",
147		    device_get_name(self));
148
149	rid = 0;
150	sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
151	    RF_SHAREABLE | RF_ACTIVE);
152	if (sc->sc_irq_res == NULL) {
153		device_printf(self, "Could not allocate irq\n");
154		goto error;
155	}
156	sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
157	if (!sc->sc_bus.bdev) {
158		device_printf(self, "Could not add USB device\n");
159		goto error;
160	}
161	device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
162	device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
163
164	sprintf(sc->sc_vendor, "Allwinner");
165
166        /* Get the GPIO device, we need this to give power to USB */
167	sc_gpio_dev = devclass_get_device(devclass_find("gpio"), 0);
168	if (sc_gpio_dev == NULL) {
169		device_printf(self, "Error: failed to get the GPIO device\n");
170		goto error;
171	}
172
173	err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
174	    NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
175	if (err) {
176		device_printf(self, "Could not setup irq, %d\n", err);
177		sc->sc_intr_hdl = NULL;
178		goto error;
179	}
180
181	sc->sc_flags |= EHCI_SCFLG_DONTRESET;
182
183	/* Enable clock for USB */
184	a10_clk_usb_activate();
185
186	/* Give power to USB */
187	GPIO_PIN_SETFLAGS(sc_gpio_dev, GPIO_USB2_PWR, GPIO_PIN_OUTPUT);
188	GPIO_PIN_SET(sc_gpio_dev, GPIO_USB2_PWR, GPIO_PIN_HIGH);
189
190	/* Give power to USB */
191	GPIO_PIN_SETFLAGS(sc_gpio_dev, GPIO_USB1_PWR, GPIO_PIN_OUTPUT);
192	GPIO_PIN_SET(sc_gpio_dev, GPIO_USB1_PWR, GPIO_PIN_HIGH);
193
194	/* Enable passby */
195	reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE);
196	reg_value |= SW_AHB_INCR8; /* AHB INCR8 enable */
197	reg_value |= SW_AHB_INCR4; /* AHB burst type INCR4 enable */
198	reg_value |= SW_AHB_INCRX_ALIGN; /* AHB INCRX align enable */
199	reg_value |= SW_ULPI_BYPASS; /* ULPI bypass enable */
200	A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value);
201
202	/* Configure port */
203	reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2);
204	reg_value |= SW_SDRAM_BP_HPCR_ACCESS;
205	A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value);
206
207	err = ehci_init(sc);
208	if (!err) {
209		err = device_probe_and_attach(sc->sc_bus.bdev);
210	}
211	if (err) {
212		device_printf(self, "USB init failed err=%d\n", err);
213		goto error;
214	}
215	return (0);
216
217error:
218	a10_ehci_detach(self);
219	return (ENXIO);
220}
221
222static int
223a10_ehci_detach(device_t self)
224{
225	ehci_softc_t *sc = device_get_softc(self);
226	device_t bdev;
227	int err;
228	uint32_t reg_value = 0;
229
230	if (sc->sc_bus.bdev) {
231		bdev = sc->sc_bus.bdev;
232		device_detach(bdev);
233		device_delete_child(self, bdev);
234	}
235	/* during module unload there are lots of children leftover */
236	device_delete_children(self);
237
238	if (sc->sc_irq_res && sc->sc_intr_hdl) {
239		/*
240		 * only call ehci_detach() after ehci_init()
241		 */
242		ehci_detach(sc);
243
244		err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
245
246		if (err)
247			/* XXX or should we panic? */
248			device_printf(self, "Could not tear down irq, %d\n",
249			    err);
250		sc->sc_intr_hdl = NULL;
251	}
252
253	if (sc->sc_irq_res) {
254		bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
255		sc->sc_irq_res = NULL;
256	}
257	if (sc->sc_io_res) {
258		bus_release_resource(self, SYS_RES_MEMORY, 0,
259		    sc->sc_io_res);
260		sc->sc_io_res = NULL;
261	}
262	usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
263
264	/* Disable configure port */
265	reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2);
266	reg_value &= ~SW_SDRAM_BP_HPCR_ACCESS;
267	A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value);
268
269	/* Disable passby */
270	reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE);
271	reg_value &= ~SW_AHB_INCR8; /* AHB INCR8 disable */
272	reg_value &= ~SW_AHB_INCR4; /* AHB burst type INCR4 disable */
273	reg_value &= ~SW_AHB_INCRX_ALIGN; /* AHB INCRX align disable */
274	reg_value &= ~SW_ULPI_BYPASS; /* ULPI bypass disable */
275	A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value);
276
277	/* Disable clock for USB */
278	a10_clk_usb_deactivate();
279
280	return (0);
281}
282
283static device_method_t ehci_methods[] = {
284	/* Device interface */
285	DEVMETHOD(device_probe, a10_ehci_probe),
286	DEVMETHOD(device_attach, a10_ehci_attach),
287	DEVMETHOD(device_detach, a10_ehci_detach),
288	DEVMETHOD(device_suspend, bus_generic_suspend),
289	DEVMETHOD(device_resume, bus_generic_resume),
290	DEVMETHOD(device_shutdown, bus_generic_shutdown),
291
292	DEVMETHOD_END
293};
294
295static driver_t ehci_driver = {
296	.name = "ehci",
297	.methods = ehci_methods,
298	.size = sizeof(ehci_softc_t),
299};
300
301static devclass_t ehci_devclass;
302
303DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0);
304MODULE_DEPEND(ehci, usb, 1, 1, 1);
305