ehci_pci.c revision 1.36 
1/*	$NetBSD: ehci_pci.c,v 1.36 2008/03/07 22:32:52 dyoung Exp $	*/
2
3/*
4 * Copyright (c) 2001, 2002 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.36 2008/03/07 22:32:52 dyoung 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 <sys/bus.h>
50
51#include <dev/pci/pcidevs.h>
52#include <dev/pci/pcivar.h>
53#include <dev/pci/usb_pci.h>
54
55#include <dev/usb/usb.h>
56#include <dev/usb/usbdi.h>
57#include <dev/usb/usbdivar.h>
58#include <dev/usb/usb_mem.h>
59
60#include <dev/usb/ehcireg.h>
61#include <dev/usb/ehcivar.h>
62
63#ifdef EHCI_DEBUG
64#define DPRINTF(x)	if (ehcidebug) printf x
65extern int ehcidebug;
66#else
67#define DPRINTF(x)
68#endif
69
70static void ehci_release_ownership(ehci_softc_t *sc, pci_chipset_tag_t pc,
71				   pcitag_t tag);
72static void ehci_get_ownership(ehci_softc_t *sc, pci_chipset_tag_t pc,
73			       pcitag_t tag);
74static bool ehci_pci_suspend(device_t PMF_FN_PROTO);
75static bool ehci_pci_resume(device_t PMF_FN_PROTO);
76
77struct ehci_pci_softc {
78	ehci_softc_t		sc;
79	pci_chipset_tag_t	sc_pc;
80	pcitag_t		sc_tag;
81	void 			*sc_ih;		/* interrupt vectoring */
82};
83
84#define EHCI_MAX_BIOS_WAIT		1000 /* ms */
85
86static int
87ehci_pci_match(struct device *parent, struct cfdata *match,
88    void *aux)
89{
90	struct pci_attach_args *pa = (struct pci_attach_args *) aux;
91
92	if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS &&
93	    PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB &&
94	    PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_EHCI)
95		return (1);
96
97	return (0);
98}
99
100static void
101ehci_pci_attach(struct device *parent, struct device *self, void *aux)
102{
103	struct ehci_pci_softc *sc = (struct ehci_pci_softc *)self;
104	struct pci_attach_args *pa = (struct pci_attach_args *)aux;
105	pci_chipset_tag_t pc = pa->pa_pc;
106	pcitag_t tag = pa->pa_tag;
107	char const *intrstr;
108	pci_intr_handle_t ih;
109	pcireg_t csr;
110	const char *vendor;
111	const char *devname = sc->sc.sc_bus.bdev.dv_xname;
112	char devinfo[256];
113	usbd_status r;
114	int ncomp;
115	struct usb_pci *up;
116
117	aprint_naive(": USB controller\n");
118
119	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
120	aprint_normal(": %s (rev. 0x%02x)\n", devinfo,
121	    PCI_REVISION(pa->pa_class));
122
123	/* Map I/O registers */
124	if (pci_mapreg_map(pa, PCI_CBMEM, PCI_MAPREG_TYPE_MEM, 0,
125			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
126		aprint_error("%s: can't map memory space\n", devname);
127		return;
128	}
129
130	sc->sc_pc = pc;
131	sc->sc_tag = tag;
132	sc->sc.sc_bus.dmatag = pa->pa_dmat;
133
134	/* Enable the device. */
135	csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG);
136	pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG,
137		       csr | PCI_COMMAND_MASTER_ENABLE);
138
139	/* Disable interrupts, so we don't get any spurious ones. */
140	sc->sc.sc_offs = EREAD1(&sc->sc, EHCI_CAPLENGTH);
141	DPRINTF(("%s: offs=%d\n", devname, sc->sc.sc_offs));
142	EOWRITE2(&sc->sc, EHCI_USBINTR, 0);
143
144	/* Map and establish the interrupt. */
145	if (pci_intr_map(pa, &ih)) {
146		aprint_error("%s: couldn't map interrupt\n", devname);
147		return;
148	}
149	intrstr = pci_intr_string(pc, ih);
150	sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, ehci_intr, sc);
151	if (sc->sc_ih == NULL) {
152		aprint_error("%s: couldn't establish interrupt", devname);
153		if (intrstr != NULL)
154			aprint_normal(" at %s", intrstr);
155		aprint_normal("\n");
156		return;
157	}
158	aprint_normal("%s: interrupting at %s\n", devname, intrstr);
159
160	switch(pci_conf_read(pc, tag, PCI_USBREV) & PCI_USBREV_MASK) {
161	case PCI_USBREV_PRE_1_0:
162	case PCI_USBREV_1_0:
163	case PCI_USBREV_1_1:
164		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
165		aprint_verbose("%s: pre-2.0 USB rev\n", devname);
166		return;
167	case PCI_USBREV_2_0:
168		sc->sc.sc_bus.usbrev = USBREV_2_0;
169		break;
170	default:
171		sc->sc.sc_bus.usbrev = USBREV_UNKNOWN;
172		break;
173	}
174
175	/* Figure out vendor for root hub descriptor. */
176	vendor = pci_findvendor(pa->pa_id);
177	sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id);
178	if (vendor)
179		strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor));
180	else
181		snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor),
182		    "vendor 0x%04x", PCI_VENDOR(pa->pa_id));
183
184	/* Enable workaround for dropped interrupts as required */
185	switch (sc->sc.sc_id_vendor) {
186	case PCI_VENDOR_ATI:
187	case PCI_VENDOR_VIATECH:
188		sc->sc.sc_flags |= EHCIF_DROPPED_INTR_WORKAROUND;
189		aprint_normal("%s: dropped intr workaround enabled\n", devname);
190		break;
191	default:
192		break;
193	}
194
195	/*
196	 * Find companion controllers.  According to the spec they always
197	 * have lower function numbers so they should be enumerated already.
198	 */
199	ncomp = 0;
200	TAILQ_FOREACH(up, &ehci_pci_alldevs, next) {
201		if (up->bus == pa->pa_bus && up->device == pa->pa_device) {
202			DPRINTF(("ehci_pci_attach: companion %s\n",
203				 USBDEVNAME(up->usb->bdev)));
204			sc->sc.sc_comps[ncomp++] = up->usb;
205			if (ncomp >= EHCI_COMPANION_MAX)
206				break;
207		}
208	}
209	sc->sc.sc_ncomp = ncomp;
210
211	ehci_get_ownership(&sc->sc, pc, tag);
212
213	r = ehci_init(&sc->sc);
214	if (r != USBD_NORMAL_COMPLETION) {
215		aprint_error("%s: init failed, error=%d\n", devname, r);
216		return;
217	}
218
219	if (!pmf_device_register1(self, ehci_pci_suspend, ehci_pci_resume,
220	                          ehci_shutdown))
221		aprint_error_dev(self, "couldn't establish power handler\n");
222
223	/* Attach usb device. */
224	sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus,
225				       usbctlprint);
226}
227
228static int
229ehci_pci_detach(device_ptr_t self, int flags)
230{
231	struct ehci_pci_softc *sc = (struct ehci_pci_softc *)self;
232	int rv;
233
234	pmf_device_deregister(self);
235	rv = ehci_detach(&sc->sc, flags);
236	if (rv)
237		return (rv);
238	if (sc->sc_ih != NULL) {
239		pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
240		sc->sc_ih = NULL;
241	}
242	if (sc->sc.sc_size) {
243		ehci_release_ownership(&sc->sc, sc->sc_pc, sc->sc_tag);
244		bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size);
245		sc->sc.sc_size = 0;
246	}
247
248	return (0);
249}
250
251CFATTACH_DECL2(ehci_pci, sizeof(struct ehci_pci_softc),
252    ehci_pci_match, ehci_pci_attach, ehci_pci_detach, ehci_activate, NULL,
253    ehci_childdet);
254
255#ifdef EHCI_DEBUG
256static void
257ehci_dump_caps(ehci_softc_t *sc, pci_chipset_tag_t pc, pcitag_t tag)
258{
259	u_int32_t cparams, legctlsts, addr, cap, id;
260	int maxdump = 10;
261
262	cparams = EREAD4(sc, EHCI_HCCPARAMS);
263	addr = EHCI_HCC_EECP(cparams);
264	while (addr != 0) {
265		cap = pci_conf_read(pc, tag, addr);
266		id = EHCI_CAP_GET_ID(cap);
267		switch (id) {
268		case EHCI_CAP_ID_LEGACY:
269			legctlsts = pci_conf_read(pc, tag,
270						  addr + PCI_EHCI_USBLEGCTLSTS);
271			printf("ehci_dump_caps: legsup=0x%08x "
272			       "legctlsts=0x%08x\n", cap, legctlsts);
273			break;
274		default:
275			printf("ehci_dump_caps: cap=0x%08x\n", cap);
276			break;
277		}
278		if (--maxdump < 0)
279			break;
280		addr = EHCI_CAP_GET_NEXT(cap);
281	}
282}
283#endif
284
285static void
286ehci_release_ownership(ehci_softc_t *sc, pci_chipset_tag_t pc, pcitag_t tag)
287{
288	const char *devname = sc->sc_bus.bdev.dv_xname;
289	u_int32_t cparams, addr, cap;
290	pcireg_t legsup;
291	int maxcap = 10;
292
293	cparams = EREAD4(sc, EHCI_HCCPARAMS);
294	addr = EHCI_HCC_EECP(cparams);
295	while (addr != 0) {
296		cap = pci_conf_read(pc, tag, addr);
297		if (EHCI_CAP_GET_ID(cap) != EHCI_CAP_ID_LEGACY)
298			goto next;
299		legsup = pci_conf_read(pc, tag, addr + PCI_EHCI_USBLEGSUP);
300		pci_conf_write(pc, tag, addr + PCI_EHCI_USBLEGSUP,
301		    legsup & ~EHCI_LEG_HC_OS_OWNED);
302
303next:
304		if (--maxcap < 0) {
305			aprint_normal("%s: broken extended capabilities "
306				      "ignored\n", devname);
307			return;
308		}
309		addr = EHCI_CAP_GET_NEXT(cap);
310	}
311}
312
313static void
314ehci_get_ownership(ehci_softc_t *sc, pci_chipset_tag_t pc, pcitag_t tag)
315{
316	const char *devname = sc->sc_bus.bdev.dv_xname;
317	u_int32_t cparams, addr, cap;
318	pcireg_t legsup;
319	int maxcap = 10;
320	int ms;
321
322#ifdef EHCI_DEBUG
323	if (ehcidebug)
324		ehci_dump_caps(sc, pc, tag);
325#endif
326	cparams = EREAD4(sc, EHCI_HCCPARAMS);
327	addr = EHCI_HCC_EECP(cparams);
328	while (addr != 0) {
329		cap = pci_conf_read(pc, tag, addr);
330		if (EHCI_CAP_GET_ID(cap) != EHCI_CAP_ID_LEGACY)
331			goto next;
332		legsup = pci_conf_read(pc, tag, addr + PCI_EHCI_USBLEGSUP);
333		/* Ask BIOS to give up ownership */
334		pci_conf_write(pc, tag, addr + PCI_EHCI_USBLEGSUP,
335		    legsup | EHCI_LEG_HC_OS_OWNED);
336		if (legsup & EHCI_LEG_HC_BIOS_OWNED) {
337			for (ms = 0; ms < EHCI_MAX_BIOS_WAIT; ms++) {
338				legsup = pci_conf_read(pc, tag,
339				    addr + PCI_EHCI_USBLEGSUP);
340				if (!(legsup & EHCI_LEG_HC_BIOS_OWNED))
341					break;
342				delay(1000);
343			}
344			if (ms == EHCI_MAX_BIOS_WAIT) {
345				aprint_normal("%s: BIOS refuses to give up "
346				    "ownership, using force\n", devname);
347				pci_conf_write(pc, tag,
348				    addr + PCI_EHCI_USBLEGSUP, 0);
349			} else
350				aprint_verbose("%s: BIOS has given up "
351				    "ownership\n", devname);
352		}
353
354		/* Disable SMIs */
355		pci_conf_write(pc, tag, addr + PCI_EHCI_USBLEGCTLSTS,
356		    EHCI_LEG_EXT_SMI_BAR | EHCI_LEG_EXT_SMI_PCICMD |
357		    EHCI_LEG_EXT_SMI_OS_CHANGE);
358
359next:
360		if (--maxcap < 0) {
361			aprint_normal("%s: broken extended capabilities "
362				      "ignored\n", devname);
363			return;
364		}
365		addr = EHCI_CAP_GET_NEXT(cap);
366	}
367
368}
369
370static bool
371ehci_pci_suspend(device_t dv PMF_FN_ARGS)
372{
373	struct ehci_pci_softc *sc = device_private(dv);
374
375	ehci_suspend(dv PMF_FN_CALL);
376	ehci_release_ownership(&sc->sc, sc->sc_pc, sc->sc_tag);
377
378	return true;
379}
380
381static bool
382ehci_pci_resume(device_t dv PMF_FN_ARGS)
383{
384	struct ehci_pci_softc *sc = device_private(dv);
385
386	ehci_get_ownership(&sc->sc, sc->sc_pc, sc->sc_tag);
387	return ehci_resume(dv PMF_FN_CALL);
388}
389