ehci_ixp4xx.c revision 305615 
1/*-
2 * Copyright (c) 2008 Sam Leffler.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25/*
26 * IXP435 attachment driver for the USB Enhanced Host Controller.
27 */
28
29#include <sys/cdefs.h>
30__FBSDID("$FreeBSD: stable/10/sys/dev/usb/controller/ehci_ixp4xx.c 305615 2016-09-08 15:06:28Z pfg $");
31
32#include "opt_bus.h"
33
34#include <sys/stdint.h>
35#include <sys/stddef.h>
36#include <sys/param.h>
37#include <sys/queue.h>
38#include <sys/types.h>
39#include <sys/systm.h>
40#include <sys/kernel.h>
41#include <sys/bus.h>
42#include <sys/module.h>
43#include <sys/lock.h>
44#include <sys/mutex.h>
45#include <sys/condvar.h>
46#include <sys/sysctl.h>
47#include <sys/sx.h>
48#include <sys/unistd.h>
49#include <sys/callout.h>
50#include <sys/malloc.h>
51#include <sys/priv.h>
52
53#include <dev/usb/usb.h>
54#include <dev/usb/usbdi.h>
55
56#include <dev/usb/usb_core.h>
57#include <dev/usb/usb_busdma.h>
58#include <dev/usb/usb_process.h>
59#include <dev/usb/usb_util.h>
60
61#include <dev/usb/usb_controller.h>
62#include <dev/usb/usb_bus.h>
63#include <dev/usb/controller/ehci.h>
64#include <dev/usb/controller/ehcireg.h>
65
66#include <arm/xscale/ixp425/ixp425reg.h>
67#include <arm/xscale/ixp425/ixp425var.h>
68
69#define EHCI_VENDORID_IXP4XX	0x42fa05
70#define EHCI_HC_DEVSTR		"IXP4XX Integrated USB 2.0 controller"
71
72struct ixp_ehci_softc {
73	ehci_softc_t		base;	/* storage for EHCI code */
74	bus_space_tag_t		iot;
75	bus_space_handle_t	ioh;
76	struct bus_space	tag;	/* tag for private bus space ops */
77};
78
79static device_attach_t ehci_ixp_attach;
80static device_detach_t ehci_ixp_detach;
81
82static uint8_t ehci_bs_r_1(bus_space_tag_t tag, bus_space_handle_t, bus_size_t);
83static void ehci_bs_w_1(bus_space_tag_t tag, bus_space_handle_t, bus_size_t, u_int8_t);
84static uint16_t ehci_bs_r_2(bus_space_tag_t tag, bus_space_handle_t, bus_size_t);
85static void ehci_bs_w_2(bus_space_tag_t tag, bus_space_handle_t, bus_size_t, uint16_t);
86static uint32_t ehci_bs_r_4(bus_space_tag_t tag, bus_space_handle_t, bus_size_t);
87static void ehci_bs_w_4(bus_space_tag_t tag, bus_space_handle_t, bus_size_t, uint32_t);
88
89static int
90ehci_ixp_probe(device_t self)
91{
92
93	device_set_desc(self, EHCI_HC_DEVSTR);
94
95	return (BUS_PROBE_DEFAULT);
96}
97
98static int
99ehci_ixp_attach(device_t self)
100{
101	struct ixp_ehci_softc *isc = device_get_softc(self);
102	ehci_softc_t *sc = &isc->base;
103	int err;
104	int rid;
105
106	/* initialise some bus fields */
107	sc->sc_bus.parent = self;
108	sc->sc_bus.devices = sc->sc_devices;
109	sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
110	sc->sc_bus.dma_bits = 32;
111
112	/* get all DMA memory */
113	if (usb_bus_mem_alloc_all(&sc->sc_bus,
114	    USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
115		return (ENOMEM);
116	}
117
118	/* NB: hints fix the memory location and irq */
119
120	rid = 0;
121	sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE);
122	if (!sc->sc_io_res) {
123		device_printf(self, "Could not map memory\n");
124		goto error;
125	}
126
127	/*
128	 * Craft special resource for bus space ops that handle
129	 * byte-alignment of non-word addresses.  Also, since
130	 * we're already intercepting bus space ops we handle
131	 * the register window offset that could otherwise be
132	 * done with bus_space_subregion.
133	 */
134	isc->iot = rman_get_bustag(sc->sc_io_res);
135	isc->tag.bs_privdata = isc->iot;
136	/* read single */
137	isc->tag.bs_r_1	= ehci_bs_r_1;
138	isc->tag.bs_r_2	= ehci_bs_r_2;
139	isc->tag.bs_r_4	= ehci_bs_r_4;
140	/* write (single) */
141	isc->tag.bs_w_1	= ehci_bs_w_1;
142	isc->tag.bs_w_2	= ehci_bs_w_2;
143	isc->tag.bs_w_4	= ehci_bs_w_4;
144
145	sc->sc_io_tag = &isc->tag;
146	sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
147	sc->sc_io_size = IXP435_USB1_SIZE - 0x100;
148
149	rid = 0;
150	sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
151	    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, "Intel");
165
166
167	err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
168	    NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
169	if (err) {
170		device_printf(self, "Could not setup irq, %d\n", err);
171		sc->sc_intr_hdl = NULL;
172		goto error;
173	}
174
175	/*
176	 * Arrange to force Host mode, select big-endian byte alignment,
177	 * and arrange to not terminate reset operations (the adapter
178	 * will ignore it if we do but might as well save a reg write).
179	 * Also, the controller has an embedded Transaction Translator
180	 * which means port speed must be read from the Port Status
181	 * register following a port enable.
182	 */
183	sc->sc_flags |= EHCI_SCFLG_TT
184		     | EHCI_SCFLG_SETMODE
185		     | EHCI_SCFLG_BIGEDESC
186		     | EHCI_SCFLG_BIGEMMIO
187		     | EHCI_SCFLG_NORESTERM
188		     ;
189
190	err = ehci_init(sc);
191	if (!err) {
192		err = device_probe_and_attach(sc->sc_bus.bdev);
193	}
194	if (err) {
195		device_printf(self, "USB init failed err=%d\n", err);
196		goto error;
197	}
198	return (0);
199
200error:
201	ehci_ixp_detach(self);
202	return (ENXIO);
203}
204
205static int
206ehci_ixp_detach(device_t self)
207{
208	struct ixp_ehci_softc *isc = device_get_softc(self);
209	ehci_softc_t *sc = &isc->base;
210	device_t bdev;
211	int err;
212
213 	if (sc->sc_bus.bdev) {
214		bdev = sc->sc_bus.bdev;
215		device_detach(bdev);
216		device_delete_child(self, bdev);
217	}
218	/* during module unload there are lots of children leftover */
219	device_delete_children(self);
220
221 	if (sc->sc_irq_res && sc->sc_intr_hdl) {
222		/*
223		 * only call ehci_detach() after ehci_init()
224		 */
225		ehci_detach(sc);
226
227		err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
228
229		if (err)
230			/* XXX or should we panic? */
231			device_printf(self, "Could not tear down irq, %d\n",
232			    err);
233		sc->sc_intr_hdl = NULL;
234	}
235
236 	if (sc->sc_irq_res) {
237		bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
238		sc->sc_irq_res = NULL;
239	}
240	if (sc->sc_io_res) {
241		bus_release_resource(self, SYS_RES_MEMORY, 0,
242		    sc->sc_io_res);
243		sc->sc_io_res = NULL;
244	}
245	usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
246
247	return (0);
248}
249
250/*
251 * Bus space accessors for PIO operations.
252 */
253
254static uint8_t
255ehci_bs_r_1(bus_space_tag_t tag, bus_space_handle_t h, bus_size_t o)
256{
257	return bus_space_read_1((bus_space_tag_t)tag->bs_privdata, h,
258	    0x100 + (o &~ 3) + (3 - (o & 3)));
259}
260
261static void
262ehci_bs_w_1(bus_space_tag_t tag, bus_space_handle_t h, bus_size_t o, u_int8_t v)
263{
264	panic("%s", __func__);
265}
266
267static uint16_t
268ehci_bs_r_2(bus_space_tag_t tag, bus_space_handle_t h, bus_size_t o)
269{
270	return bus_space_read_2((bus_space_tag_t)tag->bs_privdata, h,
271	    0x100 + (o &~ 3) + (2 - (o & 3)));
272}
273
274static void
275ehci_bs_w_2(bus_space_tag_t tag, bus_space_handle_t h, bus_size_t o, uint16_t v)
276{
277	panic("%s", __func__);
278}
279
280static uint32_t
281ehci_bs_r_4(bus_space_tag_t tag, bus_space_handle_t h, bus_size_t o)
282{
283	return bus_space_read_4((bus_space_tag_t) tag->bs_privdata, h, 0x100 + o);
284}
285
286static void
287ehci_bs_w_4(bus_space_tag_t tag, bus_space_handle_t h, bus_size_t o, uint32_t v)
288{
289	bus_space_write_4((bus_space_tag_t) tag->bs_privdata, h, 0x100 + o, v);
290}
291
292static device_method_t ehci_methods[] = {
293	/* Device interface */
294	DEVMETHOD(device_probe, ehci_ixp_probe),
295	DEVMETHOD(device_attach, ehci_ixp_attach),
296	DEVMETHOD(device_detach, ehci_ixp_detach),
297	DEVMETHOD(device_suspend, bus_generic_suspend),
298	DEVMETHOD(device_resume, bus_generic_resume),
299	DEVMETHOD(device_shutdown, bus_generic_shutdown),
300
301	DEVMETHOD_END
302};
303
304static driver_t ehci_driver = {
305	"ehci",
306	ehci_methods,
307	sizeof(struct ixp_ehci_softc),
308};
309
310static devclass_t ehci_devclass;
311
312DRIVER_MODULE(ehci, ixp, ehci_driver, ehci_devclass, 0, 0);
313MODULE_DEPEND(ehci, usb, 1, 1, 1);
314