xref: /netbsd-src/sys/dev/pci/uhci_pci.c (revision b7ae68fde0d8ef1c03714e8bbb1ee7c6118ea93b)
1 /*	$NetBSD: uhci_pci.c,v 1.32 2006/09/24 03:53:09 jmcneill 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.32 2006/09/24 03:53:09 jmcneill 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 <machine/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, void *aux)
82 {
83 	struct pci_attach_args *pa = (struct pci_attach_args *) aux;
84 
85 	if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS &&
86 	    PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB &&
87 	    PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_UHCI)
88 		return (1);
89 
90 	return (0);
91 }
92 
93 static void
94 uhci_pci_attach(struct device *parent, struct device *self, void *aux)
95 {
96 	struct uhci_pci_softc *sc = (struct uhci_pci_softc *)self;
97 	struct pci_attach_args *pa = (struct pci_attach_args *)aux;
98 	pci_chipset_tag_t pc = pa->pa_pc;
99 	pcitag_t tag = pa->pa_tag;
100 	char const *intrstr;
101 	pci_intr_handle_t ih;
102 	pcireg_t csr;
103 	const char *vendor;
104 	const char *devname = sc->sc.sc_bus.bdev.dv_xname;
105 	char devinfo[256];
106 	usbd_status r;
107 
108 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
109 	printf(": %s (rev. 0x%02x)\n", devinfo, PCI_REVISION(pa->pa_class));
110 
111 	/* Map I/O registers */
112 	if (pci_mapreg_map(pa, PCI_CBIO, PCI_MAPREG_TYPE_IO, 0,
113 			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
114 		printf("%s: can't map i/o space\n", devname);
115 		return;
116 	}
117 
118 	/* Disable interrupts, so we don't get any spurious ones. */
119 	bus_space_write_2(sc->sc.iot, sc->sc.ioh, UHCI_INTR, 0);
120 
121 	sc->sc_pc = pc;
122 	sc->sc_tag = tag;
123 	sc->sc.sc_bus.dmatag = pa->pa_dmat;
124 
125 	/* Enable the device. */
126 	csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG);
127 	pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG,
128 		       csr | PCI_COMMAND_MASTER_ENABLE);
129 
130 	/* Map and establish the interrupt. */
131 	if (pci_intr_map(pa, &ih)) {
132 		printf("%s: couldn't map interrupt\n", devname);
133 		return;
134 	}
135 	intrstr = pci_intr_string(pc, ih);
136 	sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, uhci_intr, sc);
137 	if (sc->sc_ih == NULL) {
138 		printf("%s: couldn't establish interrupt", devname);
139 		if (intrstr != NULL)
140 			printf(" at %s", intrstr);
141 		printf("\n");
142 		return;
143 	}
144 	printf("%s: interrupting at %s\n", devname, intrstr);
145 
146 	/* Set LEGSUP register to its default value. */
147 	pci_conf_write(pc, tag, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN);
148 
149 	switch(pci_conf_read(pc, tag, PCI_USBREV) & PCI_USBREV_MASK) {
150 	case PCI_USBREV_PRE_1_0:
151 		sc->sc.sc_bus.usbrev = USBREV_PRE_1_0;
152 		break;
153 	case PCI_USBREV_1_0:
154 		sc->sc.sc_bus.usbrev = USBREV_1_0;
155 		break;
156 	case PCI_USBREV_1_1:
157 		sc->sc.sc_bus.usbrev = USBREV_1_1;
158 		break;
159 	default:
160 		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
161 		break;
162 	}
163 
164 	/* Figure out vendor for root hub descriptor. */
165 	vendor = pci_findvendor(pa->pa_id);
166 	sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id);
167 	if (vendor)
168 		strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor));
169 	else
170 		snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor),
171 		    "vendor 0x%04x", PCI_VENDOR(pa->pa_id));
172 
173 	r = uhci_init(&sc->sc);
174 	if (r != USBD_NORMAL_COMPLETION) {
175 		printf("%s: init failed, error=%d\n", devname, r);
176 		return;
177 	}
178 
179 #if NEHCI > 0
180 	usb_pci_add(&sc->sc_pci, pa, &sc->sc.sc_bus);
181 #endif
182 
183 	sc->sc_powerhook = powerhook_establish(USBDEVNAME(sc->sc.sc_bus.bdev),
184 	    uhci_pci_powerhook, sc);
185 	if (sc->sc_powerhook == NULL)
186 		aprint_error("%s: couldn't establish powerhook\n",
187 		    devname);
188 
189 	/* Attach usb device. */
190 	sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus,
191 				       usbctlprint);
192 }
193 
194 static int
195 uhci_pci_detach(device_ptr_t self, int flags)
196 {
197 	struct uhci_pci_softc *sc = (struct uhci_pci_softc *)self;
198 	int rv;
199 
200 	if (sc->sc_powerhook != NULL)
201 		powerhook_disestablish(sc->sc_powerhook);
202 
203 	rv = uhci_detach(&sc->sc, flags);
204 	if (rv)
205 		return (rv);
206 	if (sc->sc_ih != NULL) {
207 		pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
208 		sc->sc_ih = NULL;
209 	}
210 	if (sc->sc.sc_size) {
211 		bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size);
212 		sc->sc.sc_size = 0;
213 	}
214 #if NEHCI > 0
215 	usb_pci_rem(&sc->sc_pci);
216 #endif
217 	return (0);
218 }
219 
220 static void
221 uhci_pci_powerhook(int why, void *opaque)
222 {
223 	struct uhci_pci_softc *sc;
224 	pci_chipset_tag_t pc;
225 	pcitag_t tag;
226 	pcireg_t reg;
227 
228 	sc = (struct uhci_pci_softc *)opaque;
229 	pc = sc->sc_pc;
230 	tag = sc->sc_tag;
231 
232 	switch (why) {
233 	case PWR_SUSPEND:
234 	case PWR_STANDBY:
235 		pci_conf_capture(pc, tag, &sc->sc_pciconf);
236 		break;
237 	case PWR_RESUME:
238 		pci_conf_restore(pc, tag, &sc->sc_pciconf);
239 		/* the BIOS might change this on us */
240 		reg = pci_conf_read(pc, tag, PCI_LEGSUP);
241 		reg |= PCI_LEGSUP_USBPIRQDEN;
242 		reg &= ~PCI_LEGSUP_USBSMIEN;
243 		pci_conf_write(pc, tag, PCI_LEGSUP, reg);
244 		break;
245 	}
246 
247 	return;
248 }
249 
250 CFATTACH_DECL(uhci_pci, sizeof(struct uhci_pci_softc),
251     uhci_pci_match, uhci_pci_attach, uhci_pci_detach, uhci_activate);
252