xref: /netbsd-src/sys/dev/pci/ohci_pci.c (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1 /*	$NetBSD: ohci_pci.c,v 1.16 2000/04/27 15:26:46 augustss 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 /*
41  * USB Open Host Controller driver.
42  *
43  * OHCI spec: http://www.intel.com/design/usb/ohci11d.pdf
44  * USB spec: http://www.teleport.com/cgi-bin/mailmerge.cgi/~usb/cgiform.tpl
45  */
46 
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/device.h>
51 #include <sys/proc.h>
52 #include <sys/queue.h>
53 
54 #include <machine/bus.h>
55 
56 #include <dev/pci/pcivar.h>
57 
58 #include <dev/usb/usb.h>
59 #include <dev/usb/usbdi.h>
60 #include <dev/usb/usbdivar.h>
61 #include <dev/usb/usb_mem.h>
62 
63 #include <dev/usb/ohcireg.h>
64 #include <dev/usb/ohcivar.h>
65 
66 int	ohci_pci_match __P((struct device *, struct cfdata *, void *));
67 void	ohci_pci_attach __P((struct device *, struct device *, void *));
68 int	ohci_pci_detach __P((device_ptr_t, int));
69 
70 struct ohci_pci_softc {
71 	ohci_softc_t		sc;
72 	pci_chipset_tag_t	sc_pc;
73 	void 			*sc_ih;		/* interrupt vectoring */
74 };
75 
76 struct cfattach ohci_pci_ca = {
77 	sizeof(struct ohci_pci_softc), ohci_pci_match, ohci_pci_attach,
78 	ohci_pci_detach, ohci_activate
79 };
80 
81 int
82 ohci_pci_match(parent, match, aux)
83 	struct device *parent;
84 	struct cfdata *match;
85 	void *aux;
86 {
87 	struct pci_attach_args *pa = (struct pci_attach_args *) aux;
88 
89 	if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS &&
90 	    PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB &&
91 	    PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_OHCI)
92 		return (1);
93 
94 	return (0);
95 }
96 
97 void
98 ohci_pci_attach(parent, self, aux)
99 	struct device *parent;
100 	struct device *self;
101 	void *aux;
102 {
103 	struct ohci_pci_softc *sc = (struct ohci_pci_softc *)self;
104 	struct pci_attach_args *pa = (struct pci_attach_args *)aux;
105 	pci_chipset_tag_t pc = pa->pa_pc;
106 	char const *intrstr;
107 	pci_intr_handle_t ih;
108 	pcireg_t csr;
109 	char devinfo[256];
110 	usbd_status r;
111 	char *vendor;
112 	char *devname = sc->sc.sc_bus.bdev.dv_xname;
113 
114 	pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo);
115 	printf(": %s (rev. 0x%02x)\n", devinfo, PCI_REVISION(pa->pa_class));
116 
117 	/* Map I/O registers */
118 	if (pci_mapreg_map(pa, PCI_CBMEM, PCI_MAPREG_TYPE_MEM, 0,
119 			   &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
120 		printf("%s: can't map mem space\n", devname);
121 		return;
122 	}
123 
124 	/* Disable interrupts, so we don't get any spurious ones. */
125 	bus_space_write_4(sc->sc.iot, sc->sc.ioh, OHCI_INTERRUPT_DISABLE,
126 			  OHCI_ALL_INTRS);
127 
128 	sc->sc_pc = pc;
129 	sc->sc.sc_bus.dmatag = pa->pa_dmat;
130 
131 	/* Enable the device. */
132 	csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
133 	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
134 		       csr | PCI_COMMAND_MASTER_ENABLE);
135 
136 	/* Map and establish the interrupt. */
137 	if (pci_intr_map(pc, pa->pa_intrtag, pa->pa_intrpin,
138 	    pa->pa_intrline, &ih)) {
139 		printf("%s: couldn't map interrupt\n", devname);
140 		return;
141 	}
142 	intrstr = pci_intr_string(pc, ih);
143 	sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, ohci_intr, sc);
144 	if (sc->sc_ih == NULL) {
145 		printf("%s: couldn't establish interrupt", devname);
146 		if (intrstr != NULL)
147 			printf(" at %s", intrstr);
148 		printf("\n");
149 		return;
150 	}
151 	printf("%s: interrupting at %s\n", devname, intrstr);
152 
153 	/* Figure out vendor for root hub descriptor. */
154 	vendor = pci_findvendor(pa->pa_id);
155 	sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id);
156 	if (vendor)
157 		strncpy(sc->sc.sc_vendor, vendor,
158 			sizeof(sc->sc.sc_vendor) - 1);
159 	else
160 		sprintf(sc->sc.sc_vendor, "vendor 0x%04x",
161 			PCI_VENDOR(pa->pa_id));
162 
163 	r = ohci_init(&sc->sc);
164 	if (r != USBD_NORMAL_COMPLETION) {
165 		printf("%s: init failed, error=%d\n", devname, r);
166 		return;
167 	}
168 
169 	/* Attach usb device. */
170 	sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus,
171 				       usbctlprint);
172 }
173 
174 int
175 ohci_pci_detach(self, flags)
176 	device_ptr_t self;
177 	int flags;
178 {
179 	struct ohci_pci_softc *sc = (struct ohci_pci_softc *)self;
180 	int rv;
181 
182 	rv = ohci_detach(&sc->sc, flags);
183 	if (rv)
184 		return (rv);
185 	if (sc->sc_ih != NULL) {
186 		pci_intr_disestablish(sc->sc_pc, sc->sc_ih);
187 		sc->sc_ih = NULL;
188 	}
189 	if (sc->sc.sc_size) {
190 		bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size);
191 		sc->sc.sc_size = 0;
192 	}
193 	return (0);
194 }
195