xref: /netbsd-src/sys/arch/mips/rmi/rmixl_usbi.c (revision 213144e1de7024d4193d04aa51005ba3a5ad95e7)
1 /*	$NetBSD: rmixl_usbi.c,v 1.2 2011/02/20 07:48:37 matt Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2002, 2003 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Cliff Neighbors
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: rmixl_usbi.c,v 1.2 2011/02/20 07:48:37 matt Exp $");
34 
35 #include "locators.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/device.h>
40 
41 #include <machine/bus.h>
42 
43 #include <mips/rmi/rmixlreg.h>
44 #include <mips/rmi/rmixlvar.h>
45 #include <mips/rmi/rmixl_intr.h>
46 #include <mips/rmi/rmixl_obiovar.h>
47 #include <mips/rmi/rmixl_usbivar.h>
48 
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdivar.h>
52 #include <dev/usb/usb_mem.h>
53 
54 /*
55  * USB I/O register byte order is
56  * LITTLE ENDIAN regardless of code model
57  */
58 #define RMIXL_USBI_GEN_VADDR(o)	\
59 	(volatile uint32_t *)MIPS_PHYS_TO_KSEG1(	\
60 		rmixl_configuration.rc_io_pbase + RMIXL_IO_DEV_USB_B + (o))
61 #define RMIXL_USBI_GEN_READ(o)     le32toh(*RMIXL_USBI_GEN_VADDR(o))
62 #define RMIXL_USBI_GEN_WRITE(o,v)  *RMIXL_USBI_GEN_VADDR(o) = htole32(v)
63 
64 static const char *rmixl_usbi_intrnames[RMIXL_UB_INTERRUPT_MAX+1] = {
65 	"int 0 (ohci0)",
66 	"int 1 (ohci1)",
67 	"int 2 (ehci)",
68 	"int 3 (device)",
69 	"int 4 (phy)",
70 	"int 5 (force)"
71 };
72 
73 typedef struct rmixl_usbi_dispatch {
74 	int (*func)(void *);
75 	void *arg;
76 	struct evcnt count;
77 } rmixl_usbi_dispatch_t;
78 
79 typedef struct rmixl_usbi_softc {
80 	device_t		sc_dev;
81 	bus_space_tag_t		sc_eb_bst;
82 	bus_space_tag_t		sc_el_bst;
83 	bus_addr_t		sc_addr;
84 	bus_size_t		sc_size;
85 	bus_dma_tag_t		sc_dmat;
86 	rmixl_usbi_dispatch_t	sc_dispatch[RMIXL_UB_INTERRUPT_MAX + 1];
87 } rmixl_usbi_softc_t;
88 
89 
90 static int	rmixl_usbi_match(device_t, cfdata_t, void *);
91 static void	rmixl_usbi_attach(device_t, device_t, void *);
92 static int  	rmixl_usbi_print(void *, const char *);
93 static int  	rmixl_usbi_search(device_t, cfdata_t, const int *, void *);
94 static int      rmixl_usbi_intr(void *);
95 
96 #ifdef RMIXL_USBI_DEBUG
97 int	rmixl_usbi_rdump(void);
98 rmixl_usbi_softc_t *rmixl_usbi_sc;
99 #endif
100 
101 
102 CFATTACH_DECL_NEW(rmixl_usbi, sizeof (rmixl_usbi_softc_t),
103     rmixl_usbi_match, rmixl_usbi_attach, NULL, NULL);
104 
105 int
106 rmixl_usbi_match(device_t parent, cfdata_t match, void *aux)
107 {
108 	struct obio_attach_args *obio = aux;
109 
110         if (obio->obio_addr == RMIXL_IO_DEV_USB_B)
111 		return rmixl_probe_4((volatile uint32_t *)RMIXL_IOREG_VADDR(obio->obio_addr));
112 
113         return 0;
114 }
115 
116 void
117 rmixl_usbi_attach(device_t parent, device_t self, void *aux)
118 {
119 	rmixl_usbi_softc_t *sc = device_private(self);
120 	struct obio_attach_args *obio = aux;
121 	uint32_t r;
122 	void *ih;
123 
124 #ifdef RMIXL_USBI_DEBUG
125 	rmixl_usbi_sc = sc;
126 #endif
127 	sc->sc_dev = self;
128 	sc->sc_eb_bst = obio->obio_eb_bst;
129 	sc->sc_el_bst = obio->obio_el_bst;
130 	sc->sc_addr = obio->obio_addr;
131 	sc->sc_size = obio->obio_size;
132 	sc->sc_dmat = obio->obio_32bit_dmat;
133 
134 	aprint_normal("\n%s", device_xname(self));
135 
136 	/*
137 	 * fail attach if USB interface is disabled GPIO LOW_PWR_DIS reg
138 	 */
139 	r = RMIXL_IOREG_READ(RMIXL_IO_DEV_GPIO + RMIXL_GPIO_LOW_PWR_DIS);
140 	if ((r & RMIXL_GPIO_LOW_PWR_DIS_USB) != 0) {
141 		aprint_error(": USB_DIS set in LOW_PWR_DIS, abort attach\n");
142 		return;
143 	}
144 
145 	/*
146 	 * fail attach if USB interface BIST failed
147 	 */
148         r = RMIXL_IOREG_READ(RMIXL_IO_DEV_GPIO + RMIXL_GPIO_BIST_EACH_STS);
149 	aprint_normal(": BIST status=");
150 	if ((r & __BIT(18)) == 0) {			/* XXX USB_BIST */
151 		aprint_normal("FAIL\n");
152 		return;
153 	}
154 	aprint_normal("OK");
155 
156 	/*
157 	 * set BYTESWAP_EN register nonzero when software is little endian
158 	 */
159 #if BYTE_ORDER == BIG_ENDIAN
160 	r = 0;
161 #else
162 	r = 1;
163 #endif
164 	RMIXL_USBI_GEN_WRITE(RMIXL_USB_BYTESWAP_EN, r);
165 	aprint_normal(" byteswap enable=%d", r);
166 	for (int intr=0; intr <= RMIXL_UB_INTERRUPT_MAX; intr++) {
167 		evcnt_attach_dynamic(&sc->sc_dispatch[intr].count,
168 			EVCNT_TYPE_INTR, NULL, "rmixl_usbi",
169 				rmixl_usbi_intrnames[intr]);
170 	}
171 
172 	/* Disable all usb interface interrupts */
173 	RMIXL_USBI_GEN_WRITE(RMIXL_USB_INTERRUPT_ENABLE, 0);
174 
175 	/* establish interrupt */
176 	if (obio->obio_intr != OBIOCF_INTR_DEFAULT) {
177 		ih = rmixl_intr_establish(obio->obio_intr, obio->obio_tmsk,
178 			IPL_USB, RMIXL_TRIG_LEVEL, RMIXL_POLR_HIGH,
179 			rmixl_usbi_intr, sc, false);
180 		if (ih == NULL)
181 			panic("%s: couldn't establish interrupt",
182 				device_xname(self));
183 	}
184 
185 	aprint_normal("\n");
186 
187 	/* attach any children */
188 	config_search_ia(rmixl_usbi_search, self, "rmixl_usbi", NULL);
189 }
190 
191 static int
192 rmixl_usbi_print(void *aux, const char *pnp)
193 {
194 	struct rmixl_usbi_attach_args *usbi = aux;
195 
196 	if (usbi->usbi_addr != RMIXL_USBICF_ADDR_DEFAULT) {
197 		aprint_normal(" addr %#"PRIxBUSADDR, usbi->usbi_addr);
198 		if (usbi->usbi_size != RMIXL_USBICF_SIZE_DEFAULT)
199 			aprint_normal("-%#"PRIxBUSADDR,
200 				usbi->usbi_addr + (usbi->usbi_size - 1));
201 	}
202 	if (usbi->usbi_intr != RMIXL_USBICF_INTR_DEFAULT)
203 		aprint_normal(" intr %d", usbi->usbi_intr);
204 
205 	aprint_normal("\n");
206 
207 	return (UNCONF);
208 }
209 
210 static int
211 rmixl_usbi_search(device_t parent, cfdata_t cf, const int *ldesc, void *aux)
212 {
213 	struct rmixl_usbi_softc *sc = device_private(parent);
214 	struct rmixl_usbi_attach_args usbi;
215 
216 	usbi.usbi_eb_bst = sc->sc_eb_bst;
217 	usbi.usbi_el_bst = sc->sc_el_bst;
218 	usbi.usbi_addr = cf->cf_loc[RMIXL_USBICF_ADDR];
219 	usbi.usbi_size = cf->cf_loc[RMIXL_USBICF_SIZE];
220 	usbi.usbi_intr = cf->cf_loc[RMIXL_USBICF_INTR];
221 	usbi.usbi_dmat = sc->sc_dmat;
222 
223 	if (config_match(parent, cf, &usbi) > 0)
224 		config_attach(parent, cf, &usbi, rmixl_usbi_print);
225 
226 	return 0;
227 }
228 
229 
230 void
231 rmixl_usbi_intr_disestablish(void *uh, void *ih)
232 {
233 	rmixl_usbi_softc_t *sc = uh;
234 	u_int intr;
235 
236 	for (intr=0; intr <= RMIXL_UB_INTERRUPT_MAX; intr++) {
237 		if (ih == &sc->sc_dispatch[intr]) {
238 			uint32_t r;
239 
240 			/* disable this interrupt in the usb interface */
241 			r = RMIXL_USBI_GEN_READ(RMIXL_USB_INTERRUPT_ENABLE);
242 			r &= 1 << intr;
243 			RMIXL_USBI_GEN_WRITE(RMIXL_USB_INTERRUPT_ENABLE, r);
244 
245 			/* free the dispatch slot */
246 			sc->sc_dispatch[intr].func = NULL;
247 			sc->sc_dispatch[intr].arg = NULL;
248 
249 			break;
250 		}
251 	}
252 }
253 
254 void *
255 rmixl_usbi_intr_establish(void *uh, u_int intr, int (func)(void *), void *arg)
256 {
257 	rmixl_usbi_softc_t *sc = uh;
258 	uint32_t r;
259 	void *ih = NULL;
260 	int s;
261 
262 	s = splusb();
263 
264 	if (intr > RMIXL_UB_INTERRUPT_MAX) {
265 		aprint_error_dev(sc->sc_dev, "invalid intr %d\n", intr);
266 		goto out;
267 	}
268 
269 	if (sc->sc_dispatch[intr].func != NULL) {
270 		aprint_error_dev(sc->sc_dev, "intr %dq busy\n", intr);
271 		goto out;
272 	}
273 
274 	sc->sc_dispatch[intr].func = func;
275 	sc->sc_dispatch[intr].arg = arg;
276 	ih = &sc->sc_dispatch[intr];
277 
278 	/* enable this interrupt in the usb interface */
279 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_INTERRUPT_ENABLE);
280 	r |= 1 << intr;
281 	RMIXL_USBI_GEN_WRITE(RMIXL_USB_INTERRUPT_ENABLE, r);
282 
283  out:
284 	splx(s);
285 	return ih;
286 }
287 
288 static int
289 rmixl_usbi_intr(void *arg)
290 {
291 	rmixl_usbi_softc_t *sc = arg;
292 	uint32_t r;
293 	int intr;
294 	int rv = 0;
295 
296 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_INTERRUPT_STATUS);
297 	if (r != 0) {
298 		for (intr=0; intr <= RMIXL_UB_INTERRUPT_MAX; intr++) {
299 			uint32_t bit = 1 << intr;
300 			if ((r & bit) != 0) {
301 				int (*f)(void *) = sc->sc_dispatch[intr].func;
302 				void *a = sc->sc_dispatch[intr].arg;
303 				if (f != NULL) {
304 					(void)(*f)(a);
305 					sc->sc_dispatch[intr].count.ev_count++;
306 					rv = 1;
307 				}
308 			}
309 		}
310 	}
311 
312 	return rv;
313 }
314 
315 #ifdef RMIXL_USBI_DEBUG
316 int
317 rmixl_usbi_rdump(void)
318 {
319 	rmixl_usbi_softc_t *sc = rmixl_usbi_sc;
320 	uint32_t r;
321 
322 	if (sc == NULL)
323 		return -1;
324 
325 	printf("\n%s:\n", __func__);
326 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_GEN_CTRL1);
327 	printf(" USB_GEN_CTRL1 %#x\n", r);
328 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_GEN_CTRL2);
329 	printf(" USB_GEN_CTRL2 %#x\n", r);
330 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_GEN_CTRL3);
331 	printf(" USB_GEN_CTRL3 %#x\n", r);
332 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_IOBM_TIMER);
333 	printf(" USB_IOBM_TIMER %#x\n", r);
334 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_VBUS_TIMER);
335 	printf(" USB_VBUS_TIMER %#x\n", r);
336 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_BYTESWAP_EN);
337 	printf(" USB_BYTESWAP_EN %#x\n", r);
338 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_COHERENT_MEM_BASE);
339 	printf(" USB_COHERENT_MEM_BASE %#x\n", r);
340 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_COHERENT_MEM_LIMIT);
341 	printf(" USB_COHERENT_MEM_LIMIT %#x\n", r);
342 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_L2ALLOC_MEM_BASE);
343 	printf(" USB_L2ALLOC_MEM_BASE %#x\n", r);
344 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_L2ALLOC_MEM_LIMIT);
345 	printf(" USB_L2ALLOC_MEM_LIMIT %#x\n", r);
346 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_READEX_MEM_BASE);
347 	printf(" USB_READEX_MEM_BASE %#x\n", r);
348 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_READEX_MEM_LIMIT);
349 	printf(" USB_READEX_MEM_LIMIT %#x\n", r);
350 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_PHY_STATUS);
351 	printf(" USB_PHY_STATUS %#x\n", r);
352 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_INTERRUPT_STATUS);
353 	printf(" USB_INTERRUPT_STATUS %#x\n", r);
354 	r = RMIXL_USBI_GEN_READ(RMIXL_USB_INTERRUPT_ENABLE);
355 	printf(" USB_INTERRUPT_ENABLE %#x\n", r);
356 
357 	return 0;
358 }
359 #endif
360