xref: /netbsd-src/sys/dev/usb/ehci.c (revision 06be8101a16cc95f40783b3cb7afd12112103a9a)
1 /*	$NetBSD: ehci.c,v 1.4 2001/11/13 06:24:53 lukem Exp $	*/
2 
3 /*
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net).
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
41  *
42  * EHCI 0.96 spec can be found at
43  * http://developer.intel.com/technology/usb/download/ehci-r096.pdf
44  *
45  */
46 
47 #include <sys/cdefs.h>
48 __KERNEL_RCSID(0, "$NetBSD: ehci.c,v 1.4 2001/11/13 06:24:53 lukem Exp $");
49 
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/kernel.h>
53 #include <sys/malloc.h>
54 #include <sys/device.h>
55 #include <sys/select.h>
56 #include <sys/proc.h>
57 #include <sys/queue.h>
58 
59 #include <machine/bus.h>
60 #include <machine/endian.h>
61 
62 #include <dev/usb/usb.h>
63 #include <dev/usb/usbdi.h>
64 #include <dev/usb/usbdivar.h>
65 #include <dev/usb/usb_mem.h>
66 #include <dev/usb/usb_quirks.h>
67 
68 #include <dev/usb/ehcireg.h>
69 #include <dev/usb/ehcivar.h>
70 
71 #ifdef EHCI_DEBUG
72 #define DPRINTF(x)	if (ehcidebug) printf x
73 #define DPRINTFN(n,x)	if (ehcidebug>(n)) printf x
74 int ehcidebug = 1;
75 #define bitmask_snprintf(q,f,b,l) snprintf((b), (l), "%b", (q), (f))
76 #else
77 #define DPRINTF(x)
78 #define DPRINTFN(n,x)
79 #endif
80 
81 usbd_status
82 ehci_init(ehci_softc_t *sc)
83 {
84 	u_int32_t version, sparams, cparams, hcr;
85 	u_int i;
86 	usbd_status err;
87 
88 	DPRINTF(("ehci_init: start\n"));
89 
90 	sc->sc_offs = EREAD1(sc, EHCI_CAPLENGTH);
91 
92 	version = EREAD2(sc, EHCI_HCIVERSION);
93 	printf("%s: EHCI version %x.%x\n", USBDEVNAME(sc->sc_bus.bdev),
94 	       version >> 8, version & 0xff);
95 
96 	sparams = EREAD4(sc, EHCI_HCSPARAMS);
97 	DPRINTF(("ehci_init: sparams=0x%x\n", sparams));
98 	if (EHCI_HCS_N_CC(sparams) != sc->sc_ncomp) {
99 		printf("%s: wrong number of companions (%d != %d)\n",
100 		       USBDEVNAME(sc->sc_bus.bdev),
101 		       EHCI_HCS_N_CC(sparams), sc->sc_ncomp);
102 		return (USBD_IOERROR);
103 	}
104 	if (sc->sc_ncomp > 0) {
105 		printf("%s: companion controller%s, %d port%s each:",
106 		    USBDEVNAME(sc->sc_bus.bdev), sc->sc_ncomp!=1 ? "s" : "",
107 		    EHCI_HCS_N_PCC(sparams),
108 		    EHCI_HCS_N_PCC(sparams)!=1 ? "s" : "");
109 		for (i = 0; i < sc->sc_ncomp; i++)
110 			printf(" %s", USBDEVNAME(sc->sc_comps[i]->bdev));
111 		printf("\n");
112 	}
113 	cparams = EREAD4(sc, EHCI_HCCPARAMS);
114 	DPRINTF(("ehci_init: cparams=0x%x\n", cparams));
115 
116 	sc->sc_bus.usbrev = USBREV_2_0;
117 
118 	/* Reset the controller */
119 	DPRINTF(("%s: resetting\n", USBDEVNAME(sc->sc_bus.bdev)));
120 	EOWRITE4(sc, EHCI_USBCMD, 0);	/* Halt controller */
121 	usb_delay_ms(&sc->sc_bus, 1);
122 	EOWRITE4(sc, EHCI_USBCMD, EHCI_CMD_HCRESET);
123 	for (i = 0; i < 100; i++) {
124 		delay(10);
125 		hcr = EOREAD4(sc, EHCI_USBCMD) & EHCI_CMD_HCRESET;
126 		if (!hcr)
127 			break;
128 	}
129 	if (hcr) {
130 		printf("%s: reset timeout\n", USBDEVNAME(sc->sc_bus.bdev));
131 		return (USBD_IOERROR);
132 	}
133 
134 	/* frame list size at default, read back what we got and use that */
135 	switch (EHCI_CMD_FLS(EOREAD4(sc, EHCI_USBCMD))) {
136 	case 0: sc->sc_flsize = 1024*4; break;
137 	case 1: sc->sc_flsize = 512*4; break;
138 	case 2: sc->sc_flsize = 256*4; break;
139 	case 3: return (USBD_IOERROR);
140 	}
141 	err = usb_allocmem(&sc->sc_bus, sc->sc_flsize,
142 			   EHCI_FLALIGN_ALIGN, &sc->sc_fldma);
143 	if (err)
144 		return (err);
145 	//sc->sc_fl = (struct ohci_hcca *)KERNADDR(&sc->sc_hccadma);
146 	DPRINTF(("%s: flsize=%d\n", USBDEVNAME(sc->sc_bus.bdev),sc->sc_flsize));
147 
148 	printf("%s: EHCI not supported yet.\n", USBDEVNAME(sc->sc_bus.bdev));
149 	return (USBD_IOERROR);
150 }
151 
152 int
153 ehci_intr(void *v)
154 {
155 	return (0);
156 }
157 
158 int
159 ehci_detach(struct ehci_softc *sc, int flags)
160 {
161 	int rv = 0;
162 
163 	if (sc->sc_child != NULL)
164 		rv = config_detach(sc->sc_child, flags);
165 
166 	if (rv != 0)
167 		return (rv);
168 
169 	if (sc->sc_powerhook != NULL)
170 		powerhook_disestablish(sc->sc_powerhook);
171 	if (sc->sc_shutdownhook != NULL)
172 		shutdownhook_disestablish(sc->sc_shutdownhook);
173 
174 	/* XXX free other data structures XXX */
175 
176 	return (rv);
177 }
178 
179 
180 int
181 ehci_activate(device_ptr_t self, enum devact act)
182 {
183 	struct ehci_softc *sc = (struct ehci_softc *)self;
184 	int rv = 0;
185 
186 	switch (act) {
187 	case DVACT_ACTIVATE:
188 		return (EOPNOTSUPP);
189 		break;
190 
191 	case DVACT_DEACTIVATE:
192 		if (sc->sc_child != NULL)
193 			rv = config_deactivate(sc->sc_child);
194 		break;
195 	}
196 	return (rv);
197 }
198 
199