uhci_pci.c revision 1.38
1/*	$NetBSD: uhci_pci.c,v 1.38 2007/11/24 02:13:49 gavan 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.38 2007/11/24 02:13:49 gavan 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
65static void	uhci_pci_powerhook(int, void *);
66
67struct 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
80static int
81uhci_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
94static void
95uhci_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	int s;
109
110	aprint_naive("\n");
111
112	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
113	aprint_normal(": %s (rev. 0x%02x)\n",
114		      devinfo, PCI_REVISION(pa->pa_class));
115
116	/* Map I/O registers */
117	if (pci_mapreg_map(pa, PCI_CBIO, PCI_MAPREG_TYPE_IO, 0,
118			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
119		aprint_error("%s: can't map i/o space\n", devname);
120		return;
121	}
122
123	/*
124	 * Disable interrupts, so we don't get any spurious ones.
125	 * Acknolewdge all pending interrupts.
126	 */
127	bus_space_write_2(sc->sc.iot, sc->sc.ioh, UHCI_INTR, 0);
128	bus_space_write_2(sc->sc.iot, sc->sc.ioh, UHCI_STS,
129	    bus_space_read_2(sc->sc.iot, sc->sc.ioh, UHCI_STS));
130
131	sc->sc_pc = pc;
132	sc->sc_tag = tag;
133	sc->sc.sc_bus.dmatag = pa->pa_dmat;
134
135	/* Enable the device. */
136	csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG);
137	pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG,
138		       csr | PCI_COMMAND_MASTER_ENABLE);
139
140	/* Map and establish the interrupt. */
141	if (pci_intr_map(pa, &ih)) {
142		aprint_error("%s: couldn't map interrupt\n", devname);
143		return;
144	}
145	intrstr = pci_intr_string(pc, ih);
146	sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, uhci_intr, sc);
147	if (sc->sc_ih == NULL) {
148		aprint_error("%s: couldn't establish interrupt", devname);
149		if (intrstr != NULL)
150			aprint_normal(" at %s", intrstr);
151		aprint_normal("\n");
152		return;
153	}
154	aprint_normal("%s: interrupting at %s\n", devname, intrstr);
155
156	/*
157	 * Set LEGSUP register to its default value.
158	 * This can reenable or trigger interrupts, so protect against them
159	 * and explicitly disable and ACK them afterwards.
160	 */
161	s = splhardusb();
162	pci_conf_write(pc, tag, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN);
163	bus_space_write_2(sc->sc.iot, sc->sc.ioh, UHCI_INTR, 0);
164	bus_space_write_2(sc->sc.iot, sc->sc.ioh, UHCI_STS,
165	    bus_space_read_2(sc->sc.iot, sc->sc.ioh, UHCI_STS));
166	splx(s);
167
168	switch(pci_conf_read(pc, tag, PCI_USBREV) & PCI_USBREV_MASK) {
169	case PCI_USBREV_PRE_1_0:
170		sc->sc.sc_bus.usbrev = USBREV_PRE_1_0;
171		break;
172	case PCI_USBREV_1_0:
173		sc->sc.sc_bus.usbrev = USBREV_1_0;
174		break;
175	case PCI_USBREV_1_1:
176		sc->sc.sc_bus.usbrev = USBREV_1_1;
177		break;
178	default:
179		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
180		break;
181	}
182
183	/* Figure out vendor for root hub descriptor. */
184	vendor = pci_findvendor(pa->pa_id);
185	sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id);
186	if (vendor)
187		strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor));
188	else
189		snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor),
190		    "vendor 0x%04x", PCI_VENDOR(pa->pa_id));
191
192	/*
193	 * Establish our powerhook before uhci_init() does its powerhook.
194	 */
195	sc->sc_powerhook = powerhook_establish(USBDEVNAME(sc->sc.sc_bus.bdev),
196	    uhci_pci_powerhook, sc);
197	if (sc->sc_powerhook == NULL)
198		aprint_error("%s: couldn't establish powerhook\n",
199		    devname);
200
201	r = uhci_init(&sc->sc);
202	if (r != USBD_NORMAL_COMPLETION) {
203		aprint_error("%s: init failed, error=%d\n", devname, r);
204		return;
205	}
206
207#if NEHCI > 0
208	usb_pci_add(&sc->sc_pci, pa, &sc->sc.sc_bus);
209#endif
210
211	/* Attach usb device. */
212	sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus,
213				       usbctlprint);
214}
215
216static int
217uhci_pci_detach(device_ptr_t self, int flags)
218{
219	struct uhci_pci_softc *sc = (struct uhci_pci_softc *)self;
220	int rv;
221
222	if (sc->sc_powerhook != NULL)
223		powerhook_disestablish(sc->sc_powerhook);
224
225	rv = uhci_detach(&sc->sc, flags);
226	if (rv)
227		return (rv);
228	if (sc->sc_ih != NULL) {
229		pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
230		sc->sc_ih = NULL;
231	}
232	if (sc->sc.sc_size) {
233		bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size);
234		sc->sc.sc_size = 0;
235	}
236#if NEHCI > 0
237	usb_pci_rem(&sc->sc_pci);
238#endif
239	return (0);
240}
241
242static void
243uhci_pci_powerhook(int why, void *opaque)
244{
245	struct uhci_pci_softc *sc;
246	pci_chipset_tag_t pc;
247	pcitag_t tag;
248	pcireg_t reg;
249
250	sc = (struct uhci_pci_softc *)opaque;
251	pc = sc->sc_pc;
252	tag = sc->sc_tag;
253
254	switch (why) {
255	case PWR_SUSPEND:
256	case PWR_STANDBY:
257		pci_conf_capture(pc, tag, &sc->sc_pciconf);
258		break;
259	case PWR_RESUME:
260		pci_conf_restore(pc, tag, &sc->sc_pciconf);
261		/* the BIOS might change this on us */
262		reg = pci_conf_read(pc, tag, PCI_LEGSUP);
263		reg |= PCI_LEGSUP_USBPIRQDEN;
264		reg &= ~PCI_LEGSUP_USBSMIEN;
265		pci_conf_write(pc, tag, PCI_LEGSUP, reg);
266		break;
267	}
268
269	return;
270}
271
272CFATTACH_DECL(uhci_pci, sizeof(struct uhci_pci_softc),
273    uhci_pci_match, uhci_pci_attach, uhci_pci_detach, uhci_activate);
274