xref: /netbsd-src/sys/dev/pci/uhci_pci.c (revision 7fa608457b817eca6e0977b37f758ae064f3c99c)
1 /*	$NetBSD: uhci_pci.c,v 1.37 2007/10/19 12:00:56 ad 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  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *        This product includes software developed by the NetBSD
22  *        Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #include <sys/cdefs.h>
41 __KERNEL_RCSID(0, "$NetBSD: uhci_pci.c,v 1.37 2007/10/19 12:00:56 ad Exp $");
42 
43 #include "ehci.h"
44 
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/device.h>
49 #include <sys/proc.h>
50 #include <sys/queue.h>
51 
52 #include <sys/bus.h>
53 
54 #include <dev/pci/pcivar.h>
55 #include <dev/pci/usb_pci.h>
56 
57 #include <dev/usb/usb.h>
58 #include <dev/usb/usbdi.h>
59 #include <dev/usb/usbdivar.h>
60 #include <dev/usb/usb_mem.h>
61 
62 #include <dev/usb/uhcireg.h>
63 #include <dev/usb/uhcivar.h>
64 
65 static void	uhci_pci_powerhook(int, void *);
66 
67 struct uhci_pci_softc {
68 	uhci_softc_t		sc;
69 #if NEHCI > 0
70 	struct usb_pci		sc_pci;
71 #endif
72 	pci_chipset_tag_t	sc_pc;
73 	pcitag_t		sc_tag;
74 	void 			*sc_ih;		/* interrupt vectoring */
75 
76 	void			*sc_powerhook;
77 	struct pci_conf_state	sc_pciconf;
78 };
79 
80 static int
81 uhci_pci_match(struct device *parent, struct cfdata *match,
82     void *aux)
83 {
84 	struct pci_attach_args *pa = (struct pci_attach_args *) aux;
85 
86 	if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS &&
87 	    PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB &&
88 	    PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_UHCI)
89 		return (1);
90 
91 	return (0);
92 }
93 
94 static void
95 uhci_pci_attach(struct device *parent, struct device *self, void *aux)
96 {
97 	struct uhci_pci_softc *sc = (struct uhci_pci_softc *)self;
98 	struct pci_attach_args *pa = (struct pci_attach_args *)aux;
99 	pci_chipset_tag_t pc = pa->pa_pc;
100 	pcitag_t tag = pa->pa_tag;
101 	char const *intrstr;
102 	pci_intr_handle_t ih;
103 	pcireg_t csr;
104 	const char *vendor;
105 	const char *devname = sc->sc.sc_bus.bdev.dv_xname;
106 	char devinfo[256];
107 	usbd_status r;
108 
109 	aprint_naive("\n");
110 
111 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
112 	aprint_normal(": %s (rev. 0x%02x)\n",
113 		      devinfo, PCI_REVISION(pa->pa_class));
114 
115 	/* Map I/O registers */
116 	if (pci_mapreg_map(pa, PCI_CBIO, PCI_MAPREG_TYPE_IO, 0,
117 			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
118 		aprint_error("%s: can't map i/o space\n", devname);
119 		return;
120 	}
121 
122 	/* Disable interrupts, so we don't get any spurious ones. */
123 	bus_space_write_2(sc->sc.iot, sc->sc.ioh, UHCI_INTR, 0);
124 
125 	sc->sc_pc = pc;
126 	sc->sc_tag = tag;
127 	sc->sc.sc_bus.dmatag = pa->pa_dmat;
128 
129 	/* Enable the device. */
130 	csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG);
131 	pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG,
132 		       csr | PCI_COMMAND_MASTER_ENABLE);
133 
134 	/* Map and establish the interrupt. */
135 	if (pci_intr_map(pa, &ih)) {
136 		aprint_error("%s: couldn't map interrupt\n", devname);
137 		return;
138 	}
139 	intrstr = pci_intr_string(pc, ih);
140 	sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, uhci_intr, sc);
141 	if (sc->sc_ih == NULL) {
142 		aprint_error("%s: couldn't establish interrupt", devname);
143 		if (intrstr != NULL)
144 			aprint_normal(" at %s", intrstr);
145 		aprint_normal("\n");
146 		return;
147 	}
148 	aprint_normal("%s: interrupting at %s\n", devname, intrstr);
149 
150 	/* Set LEGSUP register to its default value. */
151 	pci_conf_write(pc, tag, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN);
152 
153 	switch(pci_conf_read(pc, tag, PCI_USBREV) & PCI_USBREV_MASK) {
154 	case PCI_USBREV_PRE_1_0:
155 		sc->sc.sc_bus.usbrev = USBREV_PRE_1_0;
156 		break;
157 	case PCI_USBREV_1_0:
158 		sc->sc.sc_bus.usbrev = USBREV_1_0;
159 		break;
160 	case PCI_USBREV_1_1:
161 		sc->sc.sc_bus.usbrev = USBREV_1_1;
162 		break;
163 	default:
164 		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
165 		break;
166 	}
167 
168 	/* Figure out vendor for root hub descriptor. */
169 	vendor = pci_findvendor(pa->pa_id);
170 	sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id);
171 	if (vendor)
172 		strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor));
173 	else
174 		snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor),
175 		    "vendor 0x%04x", PCI_VENDOR(pa->pa_id));
176 
177 	/*
178 	 * Establish our powerhook before uhci_init() does its powerhook.
179 	 */
180 	sc->sc_powerhook = powerhook_establish(USBDEVNAME(sc->sc.sc_bus.bdev),
181 	    uhci_pci_powerhook, sc);
182 	if (sc->sc_powerhook == NULL)
183 		aprint_error("%s: couldn't establish powerhook\n",
184 		    devname);
185 
186 	r = uhci_init(&sc->sc);
187 	if (r != USBD_NORMAL_COMPLETION) {
188 		aprint_error("%s: init failed, error=%d\n", devname, r);
189 		return;
190 	}
191 
192 #if NEHCI > 0
193 	usb_pci_add(&sc->sc_pci, pa, &sc->sc.sc_bus);
194 #endif
195 
196 	/* Attach usb device. */
197 	sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus,
198 				       usbctlprint);
199 }
200 
201 static int
202 uhci_pci_detach(device_ptr_t self, int flags)
203 {
204 	struct uhci_pci_softc *sc = (struct uhci_pci_softc *)self;
205 	int rv;
206 
207 	if (sc->sc_powerhook != NULL)
208 		powerhook_disestablish(sc->sc_powerhook);
209 
210 	rv = uhci_detach(&sc->sc, flags);
211 	if (rv)
212 		return (rv);
213 	if (sc->sc_ih != NULL) {
214 		pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
215 		sc->sc_ih = NULL;
216 	}
217 	if (sc->sc.sc_size) {
218 		bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size);
219 		sc->sc.sc_size = 0;
220 	}
221 #if NEHCI > 0
222 	usb_pci_rem(&sc->sc_pci);
223 #endif
224 	return (0);
225 }
226 
227 static void
228 uhci_pci_powerhook(int why, void *opaque)
229 {
230 	struct uhci_pci_softc *sc;
231 	pci_chipset_tag_t pc;
232 	pcitag_t tag;
233 	pcireg_t reg;
234 
235 	sc = (struct uhci_pci_softc *)opaque;
236 	pc = sc->sc_pc;
237 	tag = sc->sc_tag;
238 
239 	switch (why) {
240 	case PWR_SUSPEND:
241 	case PWR_STANDBY:
242 		pci_conf_capture(pc, tag, &sc->sc_pciconf);
243 		break;
244 	case PWR_RESUME:
245 		pci_conf_restore(pc, tag, &sc->sc_pciconf);
246 		/* the BIOS might change this on us */
247 		reg = pci_conf_read(pc, tag, PCI_LEGSUP);
248 		reg |= PCI_LEGSUP_USBPIRQDEN;
249 		reg &= ~PCI_LEGSUP_USBSMIEN;
250 		pci_conf_write(pc, tag, PCI_LEGSUP, reg);
251 		break;
252 	}
253 
254 	return;
255 }
256 
257 CFATTACH_DECL(uhci_pci, sizeof(struct uhci_pci_softc),
258     uhci_pci_match, uhci_pci_attach, uhci_pci_detach, uhci_activate);
259