a10_ehci.c revision 246375 
1/*-
2 * Copyright (c) 2012 Ganbold Tsagaankhuu <ganbold@gmail.com>
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: head/sys/arm/allwinner/a10_ehci.c 246375 2013-02-06 01:03:13Z ganbold $");
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_USB2_PWR			227
79
80#define A10_READ_4(sc, reg)		\
81	bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg)
82
83#define A10_WRITE_4(sc, reg, data)	\
84	bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg, data)
85
86static device_attach_t a10_ehci_attach;
87static device_detach_t a10_ehci_detach;
88
89bs_r_1_proto(reversed);
90bs_w_1_proto(reversed);
91
92static int
93a10_ehci_probe(device_t self)
94{
95	if (!ofw_bus_is_compatible(self, "allwinner,usb-ehci"))
96		return (ENXIO);
97
98	device_set_desc(self, EHCI_HC_DEVSTR);
99
100	return (BUS_PROBE_DEFAULT);
101}
102
103static int
104a10_ehci_attach(device_t self)
105{
106	ehci_softc_t *sc = device_get_softc(self);
107	bus_space_handle_t bsh;
108	device_t sc_gpio_dev;
109	int err;
110	int rid;
111	uint32_t reg_value = 0;
112
113	/* initialise some bus fields */
114	sc->sc_bus.parent = self;
115	sc->sc_bus.devices = sc->sc_devices;
116	sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
117
118	/* get all DMA memory */
119	if (usb_bus_mem_alloc_all(&sc->sc_bus,
120	    USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
121		return (ENOMEM);
122	}
123
124	sc->sc_bus.usbrev = USB_REV_2_0;
125
126	rid = 0;
127	sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE);
128	if (!sc->sc_io_res) {
129		device_printf(self, "Could not map memory\n");
130		goto error;
131	}
132
133	sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
134	sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
135	bsh = rman_get_bushandle(sc->sc_io_res);
136
137	sc->sc_io_size = rman_get_size(sc->sc_io_res);
138
139	if (bus_space_subregion(sc->sc_io_tag, bsh, 0x00,
140	    sc->sc_io_size, &sc->sc_io_hdl) != 0)
141		panic("%s: unable to subregion USB host registers",
142		    device_get_name(self));
143
144	rid = 0;
145	sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
146	    RF_SHAREABLE | RF_ACTIVE);
147	if (sc->sc_irq_res == NULL) {
148		device_printf(self, "Could not allocate irq\n");
149		goto error;
150	}
151	sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
152	if (!sc->sc_bus.bdev) {
153		device_printf(self, "Could not add USB device\n");
154		goto error;
155	}
156	device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
157	device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
158
159	sprintf(sc->sc_vendor, "Allwinner");
160
161        /* Get the GPIO device, we need this to give power to USB */
162	sc_gpio_dev = devclass_get_device(devclass_find("gpio"), 0);
163	if (sc_gpio_dev == NULL) {
164		device_printf(self, "Error: failed to get the GPIO device\n");
165		goto error;
166	}
167
168	err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
169	    NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
170	if (err) {
171		device_printf(self, "Could not setup irq, %d\n", err);
172		sc->sc_intr_hdl = NULL;
173		goto error;
174	}
175
176	sc->sc_flags |= EHCI_SCFLG_DONTRESET;
177
178	/* Enable clock for USB */
179	a10_clk_usb_activate();
180
181	/* Give power to USB */
182	GPIO_PIN_SETFLAGS(sc_gpio_dev, GPIO_USB2_PWR, GPIO_PIN_OUTPUT);
183	GPIO_PIN_SET(sc_gpio_dev, GPIO_USB2_PWR, GPIO_PIN_HIGH);
184
185	/* Enable passby */
186	reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE);
187	reg_value |= SW_AHB_INCR8; /* AHB INCR8 enable */
188	reg_value |= SW_AHB_INCR4; /* AHB burst type INCR4 enable */
189	reg_value |= SW_AHB_INCRX_ALIGN; /* AHB INCRX align enable */
190	reg_value |= SW_ULPI_BYPASS; /* ULPI bypass enable */
191	A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value);
192
193	/* Configure port */
194	reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2);
195	reg_value |= SW_SDRAM_BP_HPCR_ACCESS;
196	A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value);
197
198	err = ehci_init(sc);
199	if (!err) {
200		err = device_probe_and_attach(sc->sc_bus.bdev);
201	}
202	if (err) {
203		device_printf(self, "USB init failed err=%d\n", err);
204		goto error;
205	}
206	return (0);
207
208error:
209	a10_ehci_detach(self);
210	return (ENXIO);
211}
212
213static int
214a10_ehci_detach(device_t self)
215{
216	ehci_softc_t *sc = device_get_softc(self);
217	device_t bdev;
218	int err;
219	uint32_t reg_value = 0;
220
221	if (sc->sc_bus.bdev) {
222		bdev = sc->sc_bus.bdev;
223		device_detach(bdev);
224		device_delete_child(self, bdev);
225	}
226	/* during module unload there are lots of children leftover */
227	device_delete_children(self);
228
229	if (sc->sc_irq_res && sc->sc_intr_hdl) {
230		/*
231		 * only call ehci_detach() after ehci_init()
232		 */
233		ehci_detach(sc);
234
235		err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
236
237		if (err)
238			/* XXX or should we panic? */
239			device_printf(self, "Could not tear down irq, %d\n",
240			    err);
241		sc->sc_intr_hdl = NULL;
242	}
243
244	if (sc->sc_irq_res) {
245		bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
246		sc->sc_irq_res = NULL;
247	}
248	if (sc->sc_io_res) {
249		bus_release_resource(self, SYS_RES_MEMORY, 0,
250		    sc->sc_io_res);
251		sc->sc_io_res = NULL;
252	}
253	usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
254
255	/* Disable configure port */
256	reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2);
257	reg_value &= ~SW_SDRAM_BP_HPCR_ACCESS;
258	A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value);
259
260	/* Disable passby */
261	reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE);
262	reg_value &= ~SW_AHB_INCR8; /* AHB INCR8 disable */
263	reg_value &= ~SW_AHB_INCR4; /* AHB burst type INCR4 disable */
264	reg_value &= ~SW_AHB_INCRX_ALIGN; /* AHB INCRX align disable */
265	reg_value &= ~SW_ULPI_BYPASS; /* ULPI bypass disable */
266	A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value);
267
268	/* Disable clock for USB */
269	a10_clk_usb_deactivate();
270
271	return (0);
272}
273
274static device_method_t ehci_methods[] = {
275	/* Device interface */
276	DEVMETHOD(device_probe, a10_ehci_probe),
277	DEVMETHOD(device_attach, a10_ehci_attach),
278	DEVMETHOD(device_detach, a10_ehci_detach),
279	DEVMETHOD(device_suspend, bus_generic_suspend),
280	DEVMETHOD(device_resume, bus_generic_resume),
281	DEVMETHOD(device_shutdown, bus_generic_shutdown),
282
283	DEVMETHOD_END
284};
285
286static driver_t ehci_driver = {
287	.name = "ehci",
288	.methods = ehci_methods,
289	.size = sizeof(ehci_softc_t),
290};
291
292static devclass_t ehci_devclass;
293
294DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0);
295MODULE_DEPEND(ehci, usb, 1, 1, 1);
296