xref: /netbsd-src/sys/dev/cardbus/ehci_cardbus.c (revision 8585484ef87f5a04d32332313cdb799625f4faf8)
1 /*	$NetBSD: ehci_cardbus.c,v 1.31 2011/08/01 11:20:27 drochner Exp $	*/
2 
3 /*
4  * Copyright (c) 1998 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) at
9  * Carlstedt Research & Technology.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: ehci_cardbus.c,v 1.31 2011/08/01 11:20:27 drochner Exp $");
35 
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/device.h>
40 #include <sys/proc.h>
41 
42 #include <sys/bus.h>
43 
44 #if defined pciinc
45 #include <dev/pci/pcidevs.h>
46 #endif
47 
48 #include <dev/cardbus/cardbusvar.h>
49 #include <dev/pci/pcidevs.h>
50 
51 #include <dev/cardbus/usb_cardbus.h>
52 
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
55 #include <dev/usb/usbdivar.h>
56 #include <dev/usb/usb_mem.h>
57 
58 #include <dev/usb/ehcireg.h>
59 #include <dev/usb/ehcivar.h>
60 
61 #ifdef EHCI_DEBUG
62 #define DPRINTF(x)	if (ehcidebug) printf x
63 extern int ehcidebug;
64 #else
65 #define DPRINTF(x)
66 #endif
67 
68 int	ehci_cardbus_match(device_t, cfdata_t, void *);
69 void	ehci_cardbus_attach(device_t, device_t, void *);
70 int	ehci_cardbus_detach(device_t, int);
71 
72 struct ehci_cardbus_softc {
73 	ehci_softc_t		sc;
74 	cardbus_chipset_tag_t	sc_cc;
75 	cardbus_function_tag_t	sc_cf;
76 	cardbus_devfunc_t	sc_ct;
77 	void 			*sc_ih;		/* interrupt vectoring */
78 };
79 
80 CFATTACH_DECL_NEW(ehci_cardbus, sizeof(struct ehci_cardbus_softc),
81     ehci_cardbus_match, ehci_cardbus_attach, ehci_cardbus_detach, ehci_activate);
82 
83 static TAILQ_HEAD(, usb_cardbus) ehci_cardbus_alldevs =
84 	TAILQ_HEAD_INITIALIZER(ehci_cardbus_alldevs);
85 
86 int
87 ehci_cardbus_match(device_t parent, cfdata_t match, void *aux)
88 {
89 	struct cardbus_attach_args *ca = (struct cardbus_attach_args *)aux;
90 
91 	if (PCI_CLASS(ca->ca_class) == PCI_CLASS_SERIALBUS &&
92 	    PCI_SUBCLASS(ca->ca_class) == PCI_SUBCLASS_SERIALBUS_USB &&
93 	    PCI_INTERFACE(ca->ca_class) == PCI_INTERFACE_EHCI)
94 		return (1);
95 
96 	return (0);
97 }
98 
99 static bool
100 ehci_cardbus_suspend(device_t dv, const pmf_qual_t *qual)
101 {
102 	ehci_suspend(dv, qual);
103 #if 0
104 	struct ehci_cardbus_softc *sc = device_private(dv);
105 	ehci_release_ownership(&sc->sc, sc->sc_pc, sc->sc_tag);
106 #endif
107 
108 	return true;
109 }
110 
111 static bool
112 ehci_cardbus_resume(device_t dv, const pmf_qual_t *qual)
113 {
114 #if 0
115 	struct ehci_cardbus_softc *sc = device_private(dv);
116 	ehci_get_ownership(&sc->sc, sc->sc_pc, sc->sc_tag);
117 #endif
118 	return ehci_resume(dv, qual);
119 }
120 
121 void
122 ehci_cardbus_attach(device_t parent, device_t self, void *aux)
123 {
124 	struct ehci_cardbus_softc *sc = device_private(self);
125 	struct cardbus_attach_args *ca = aux;
126 	cardbus_devfunc_t ct = ca->ca_ct;
127 	cardbus_chipset_tag_t cc = ct->ct_cc;
128 	cardbus_function_tag_t cf = ct->ct_cf;
129 	pcireg_t csr;
130 	char devinfo[256];
131 	usbd_status r;
132 	const char *vendor;
133 	u_int ncomp;
134 	const char *devname = device_xname(self);
135 	struct usb_cardbus *up;
136 
137 	sc->sc.sc_dev = self;
138 	sc->sc.sc_bus.hci_private = sc;
139 
140 	pci_devinfo(ca->ca_id, ca->ca_class, 0, devinfo, sizeof(devinfo));
141 	printf(": %s (rev. 0x%02x)\n", devinfo,
142 	       PCI_REVISION(ca->ca_class));
143 
144 	/* Map I/O registers */
145 	if (Cardbus_mapreg_map(ct, PCI_CBMEM, PCI_MAPREG_TYPE_MEM, 0,
146 			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
147 		printf("%s: can't map mem space\n", devname);
148 		return;
149 	}
150 
151 	sc->sc_cc = cc;
152 	sc->sc_cf = cf;
153 	sc->sc_ct = ct;
154 	sc->sc.sc_bus.dmatag = ca->ca_dmat;
155 
156 	/* Enable the device. */
157 	csr = Cardbus_conf_read(ct, ca->ca_tag, PCI_COMMAND_STATUS_REG);
158 	Cardbus_conf_write(ct, ca->ca_tag, PCI_COMMAND_STATUS_REG,
159 		       csr | PCI_COMMAND_MASTER_ENABLE
160 			   | PCI_COMMAND_MEM_ENABLE);
161 
162 	/* Disable interrupts, so we don't get any spurious ones. */
163 	sc->sc.sc_offs = EREAD1(&sc->sc, EHCI_CAPLENGTH);
164 	DPRINTF(("%s: offs=%d\n", devname, sc->sc.sc_offs));
165 	EOWRITE2(&sc->sc, EHCI_USBINTR, 0);
166 
167 	sc->sc_ih = Cardbus_intr_establish(ct, IPL_USB, ehci_intr, sc);
168 	if (sc->sc_ih == NULL) {
169 		printf("%s: couldn't establish interrupt\n", devname);
170 		return;
171 	}
172 
173 	/* Figure out vendor for root hub descriptor. */
174 	vendor = pci_findvendor(ca->ca_id);
175 	sc->sc.sc_id_vendor = PCI_VENDOR(ca->ca_id);
176 	if (vendor)
177 		strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor));
178 	else
179 		snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor),
180 		    "vendor 0x%04x", PCI_VENDOR(ca->ca_id));
181 
182 	/*
183 	 * Find companion controllers.  According to the spec they always
184 	 * have lower function numbers so they should be enumerated already.
185 	 */
186 	ncomp = 0;
187 	TAILQ_FOREACH(up, &ehci_cardbus_alldevs, next) {
188 		if (up->bus == ca->ca_bus) {
189 			DPRINTF(("ehci_cardbus_attach: companion %s\n",
190 				 device_xname(up->usb)));
191 			sc->sc.sc_comps[ncomp++] = up->usb;
192 			if (ncomp >= EHCI_COMPANION_MAX)
193 				break;
194 		}
195 	}
196 	sc->sc.sc_ncomp = ncomp;
197 
198 	r = ehci_init(&sc->sc);
199 	if (r != USBD_NORMAL_COMPLETION) {
200 		printf("%s: init failed, error=%d\n", devname, r);
201 
202 		/* Avoid spurious interrupts. */
203 		Cardbus_intr_disestablish(ct, sc->sc_ih);
204 		sc->sc_ih = NULL;
205 
206 		return;
207 	}
208 
209 	if (!pmf_device_register1(self, ehci_cardbus_suspend,
210 	                          ehci_cardbus_resume, ehci_shutdown))
211 		aprint_error_dev(self, "couldn't establish power handler\n");
212 
213 	/* Attach usb device. */
214 	sc->sc.sc_child = config_found(self, &sc->sc.sc_bus, usbctlprint);
215 }
216 
217 int
218 ehci_cardbus_detach(device_t self, int flags)
219 {
220 	struct ehci_cardbus_softc *sc = device_private(self);
221 	struct cardbus_devfunc *ct = sc->sc_ct;
222 	int rv;
223 
224 	rv = ehci_detach(&sc->sc, flags);
225 	if (rv)
226 		return (rv);
227 	if (sc->sc_ih != NULL) {
228 		Cardbus_intr_disestablish(ct, sc->sc_ih);
229 		sc->sc_ih = NULL;
230 	}
231 	if (sc->sc.sc_size) {
232 		Cardbus_mapreg_unmap(ct, PCI_CBMEM, sc->sc.iot,
233 		    sc->sc.ioh, sc->sc.sc_size);
234 		sc->sc.sc_size = 0;
235 	}
236 	return (0);
237 }
238 
239 void
240 usb_cardbus_add(struct usb_cardbus *up, struct cardbus_attach_args *ca, device_t bu)
241 {
242 	TAILQ_INSERT_TAIL(&ehci_cardbus_alldevs, up, next);
243 	up->bus = ca->ca_bus;
244 	up->function = ca->ca_function;
245 	up->usb = bu;
246 }
247 
248 void
249 usb_cardbus_rem(struct usb_cardbus *up)
250 {
251 	TAILQ_REMOVE(&ehci_cardbus_alldevs, up, next);
252 }
253