xref: /netbsd-src/sys/dev/pci/ehci_pci.c (revision 06be8101a16cc95f40783b3cb7afd12112103a9a)
1 /*	$NetBSD: ehci_pci.c,v 1.6 2001/11/13 07:48:42 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 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: ehci_pci.c,v 1.6 2001/11/13 07:48:42 lukem Exp $");
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/device.h>
46 #include <sys/proc.h>
47 #include <sys/queue.h>
48 
49 #include <machine/bus.h>
50 
51 #include <dev/pci/pcivar.h>
52 #include <dev/pci/usb_pci.h>
53 
54 #include <dev/usb/usb.h>
55 #include <dev/usb/usbdi.h>
56 #include <dev/usb/usbdivar.h>
57 #include <dev/usb/usb_mem.h>
58 
59 #include <dev/usb/ehcireg.h>
60 #include <dev/usb/ehcivar.h>
61 
62 #ifdef EHCI_DEBUG
63 #define DPRINTF(x)	if (ehcidebug) printf x
64 extern int ehcidebug;
65 #else
66 #define DPRINTF(x)
67 #endif
68 
69 int	ehci_pci_match(struct device *, struct cfdata *, void *);
70 void	ehci_pci_attach(struct device *, struct device *, void *);
71 int	ehci_pci_detach(device_ptr_t, int);
72 
73 struct ehci_pci_softc {
74 	ehci_softc_t		sc;
75 	pci_chipset_tag_t	sc_pc;
76 	pcitag_t		sc_tag;
77 	void 			*sc_ih;		/* interrupt vectoring */
78 };
79 
80 struct cfattach ehci_pci_ca = {
81 	sizeof(struct ehci_pci_softc), ehci_pci_match, ehci_pci_attach,
82 	ehci_pci_detach, ehci_activate
83 };
84 
85 static TAILQ_HEAD(, usb_pci) ehci_pci_alldevs =
86 	TAILQ_HEAD_INITIALIZER(ehci_pci_alldevs);
87 
88 int
89 ehci_pci_match(struct device *parent, struct cfdata *match, void *aux)
90 {
91 	struct pci_attach_args *pa = (struct pci_attach_args *) aux;
92 
93 	if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS &&
94 	    PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB &&
95 	    PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_EHCI)
96 		return (1);
97 
98 	return (0);
99 }
100 
101 void
102 ehci_pci_attach(struct device *parent, struct device *self, void *aux)
103 {
104 	struct ehci_pci_softc *sc = (struct ehci_pci_softc *)self;
105 	struct pci_attach_args *pa = (struct pci_attach_args *)aux;
106 	pci_chipset_tag_t pc = pa->pa_pc;
107 	pcitag_t tag = pa->pa_tag;
108 	char const *intrstr;
109 	pci_intr_handle_t ih;
110 	pcireg_t csr;
111 	char *vendor;
112 	char *devname = sc->sc.sc_bus.bdev.dv_xname;
113 	char devinfo[256];
114 	usbd_status r;
115 	int ncomp;
116 	struct usb_pci *up;
117 
118 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo);
119 	printf(": %s (rev. 0x%02x)\n", devinfo, PCI_REVISION(pa->pa_class));
120 
121 	/* Map I/O registers */
122 	if (pci_mapreg_map(pa, PCI_CBMEM, PCI_MAPREG_TYPE_MEM, 0,
123 			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
124 		printf("%s: can't map i/o space\n", devname);
125 		return;
126 	}
127 
128 	sc->sc_pc = pc;
129 	sc->sc_tag = tag;
130 	sc->sc.sc_bus.dmatag = pa->pa_dmat;
131 
132 	/* Enable the device. */
133 	csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG);
134 	pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG,
135 		       csr | PCI_COMMAND_MASTER_ENABLE);
136 
137 	/* Disable interrupts, so we don't get any spurious ones. */
138 	sc->sc.sc_offs = EREAD1(&sc->sc, EHCI_CAPLENGTH);
139 	DPRINTF(("%s: offs=%d\n", devname, sc->sc.sc_offs));
140 	EOWRITE2(&sc->sc, EHCI_USBINTR, 0);
141 
142 	/* Map and establish the interrupt. */
143 	if (pci_intr_map(pa, &ih)) {
144 		printf("%s: couldn't map interrupt\n", devname);
145 		return;
146 	}
147 	intrstr = pci_intr_string(pc, ih);
148 	sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, ehci_intr, sc);
149 	if (sc->sc_ih == NULL) {
150 		printf("%s: couldn't establish interrupt", devname);
151 		if (intrstr != NULL)
152 			printf(" at %s", intrstr);
153 		printf("\n");
154 		return;
155 	}
156 	printf("%s: interrupting at %s\n", devname, intrstr);
157 
158 	switch(pci_conf_read(pc, tag, PCI_USBREV) & PCI_USBREV_MASK) {
159 	case PCI_USBREV_PRE_1_0:
160 	case PCI_USBREV_1_0:
161 	case PCI_USBREV_1_1:
162 		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
163 		printf("%s: pre-2.0 USB rev\n", devname);
164 		return;
165 	case PCI_USBREV_2_0:
166 		sc->sc.sc_bus.usbrev = USBREV_2_0;
167 		break;
168 	default:
169 		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
170 		break;
171 	}
172 
173 	/* Figure out vendor for root hub descriptor. */
174 	vendor = pci_findvendor(pa->pa_id);
175 	sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id);
176 	if (vendor)
177 		strncpy(sc->sc.sc_vendor, vendor,
178 			sizeof(sc->sc.sc_vendor) - 1);
179 	else
180 		sprintf(sc->sc.sc_vendor, "vendor 0x%04x",
181 			PCI_VENDOR(pa->pa_id));
182 
183 	/*
184 	 * Find companion controllers.  According to the spec they always
185 	 * have lower function numbers so they should be enumerated already.
186 	 */
187 	ncomp = 0;
188 	TAILQ_FOREACH(up, &ehci_pci_alldevs, next) {
189 		if (up->bus == pa->pa_bus && up->device == pa->pa_device) {
190 			DPRINTF(("ehci_pci_attach: companion %s\n",
191 				 USBDEVNAME(up->usb->bdev)));
192 			sc->sc.sc_comps[ncomp++] = up->usb;
193 			if (ncomp >= EHCI_COMPANION_MAX)
194 				break;
195 		}
196 	}
197 	sc->sc.sc_ncomp = ncomp;
198 
199 	r = ehci_init(&sc->sc);
200 	if (r != USBD_NORMAL_COMPLETION) {
201 		printf("%s: init failed, error=%d\n", devname, r);
202 		return;
203 	}
204 
205 	/* Attach usb device. */
206 	sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus,
207 				       usbctlprint);
208 }
209 
210 int
211 ehci_pci_detach(device_ptr_t self, int flags)
212 {
213 	struct ehci_pci_softc *sc = (struct ehci_pci_softc *)self;
214 	int rv;
215 
216 	rv = ehci_detach(&sc->sc, flags);
217 	if (rv)
218 		return (rv);
219 	if (sc->sc_ih != NULL) {
220 		pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
221 		sc->sc_ih = NULL;
222 	}
223 	if (sc->sc.sc_size) {
224 		bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size);
225 		sc->sc.sc_size = 0;
226 	}
227 	return (0);
228 }
229 
230 void
231 usb_pci_add(struct usb_pci *up, struct pci_attach_args *pa, struct usbd_bus *bu)
232 {
233 	TAILQ_INSERT_TAIL(&ehci_pci_alldevs, up, next);
234 	up->bus = pa->pa_bus;
235 	up->device = pa->pa_device;
236 	up->function = pa->pa_function;
237 	up->usb = bu;
238 }
239 
240 void
241 usb_pci_rem(struct usb_pci *up)
242 {
243 	TAILQ_REMOVE(&ehci_pci_alldevs, up, next);
244 }
245