1 /* $OpenBSD: ohci_cardbus.c,v 1.24 2024/05/24 06:26:47 jsg Exp $ */
2 /* $NetBSD: ohci_cardbus.c,v 1.19 2004/08/02 19:14:28 mycroft Exp $ */
3
4 /*
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 /*
35 * USB Open Host Controller driver.
36 *
37 * OHCI spec: http://www.intel.com/design/usb/ohci11d.pdf
38 * USB spec: http://www.teleport.com/cgi-bin/mailmerge.cgi/~usb/cgiform.tpl
39 */
40
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/device.h>
45
46 #include <machine/bus.h>
47
48 #include <dev/cardbus/cardbusvar.h>
49
50 #include <dev/usb/usb.h>
51 #include <dev/usb/usbdi.h>
52 #include <dev/usb/usbdivar.h>
53
54 #include <dev/usb/ohcireg.h>
55 #include <dev/usb/ohcivar.h>
56
57 int ohci_cardbus_match(struct device *, void *, void *);
58 void ohci_cardbus_attach(struct device *, struct device *, void *);
59 int ohci_cardbus_detach(struct device *, int);
60
61 struct ohci_cardbus_softc {
62 struct ohci_softc sc;
63 cardbus_chipset_tag_t sc_cc;
64 cardbus_function_tag_t sc_cf;
65 cardbus_devfunc_t sc_ct;
66 void *sc_ih; /* interrupt vectoring */
67 };
68
69 const struct cfattach ohci_cardbus_ca = {
70 sizeof(struct ohci_cardbus_softc), ohci_cardbus_match,
71 ohci_cardbus_attach, ohci_cardbus_detach, ohci_activate
72 };
73
74 #define CARDBUS_CBMEM PCI_CBMEM
75 #define cardbus_findvendor pci_findvendor
76
77 int
ohci_cardbus_match(struct device * parent,void * match,void * aux)78 ohci_cardbus_match(struct device *parent, void *match, void *aux)
79 {
80 struct cardbus_attach_args *ca = (struct cardbus_attach_args *)aux;
81
82 if (PCI_CLASS(ca->ca_class) == PCI_CLASS_SERIALBUS &&
83 PCI_SUBCLASS(ca->ca_class) == PCI_SUBCLASS_SERIALBUS_USB &&
84 PCI_INTERFACE(ca->ca_class) == PCI_INTERFACE_OHCI)
85 return (1);
86
87 return (0);
88 }
89
90 void
ohci_cardbus_attach(struct device * parent,struct device * self,void * aux)91 ohci_cardbus_attach(struct device *parent, struct device *self, void *aux)
92 {
93 struct ohci_cardbus_softc *sc = (struct ohci_cardbus_softc *)self;
94 struct cardbus_attach_args *ca = aux;
95 cardbus_devfunc_t ct = ca->ca_ct;
96 cardbus_chipset_tag_t cc = ct->ct_cc;
97 pci_chipset_tag_t pc = ca->ca_pc;
98 cardbus_function_tag_t cf = ct->ct_cf;
99 pcireg_t csr;
100 usbd_status r;
101 const char *vendor;
102 const char *devname = sc->sc.sc_bus.bdev.dv_xname;
103
104 /* Map I/O registers */
105 if (Cardbus_mapreg_map(ct, CARDBUS_CBMEM, PCI_MAPREG_TYPE_MEM, 0,
106 &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) {
107 printf(": can't map mem space\n");
108 return;
109 }
110
111 /* Disable interrupts, so we don't get any spurious ones. */
112 bus_space_write_4(sc->sc.iot, sc->sc.ioh, OHCI_INTERRUPT_DISABLE,
113 OHCI_MIE);
114
115 sc->sc_cc = cc;
116 sc->sc_cf = cf;
117 sc->sc_ct = ct;
118 sc->sc.sc_bus.dmatag = ca->ca_dmat;
119
120 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_MEM_ENABLE);
121 (ct->ct_cf->cardbus_ctrl)(cc, CARDBUS_BM_ENABLE);
122
123 /* Enable the device. */
124 csr = pci_conf_read(pc, ca->ca_tag,
125 PCI_COMMAND_STATUS_REG);
126 pci_conf_write(pc, ca->ca_tag, PCI_COMMAND_STATUS_REG,
127 csr | PCI_COMMAND_MASTER_ENABLE
128 | PCI_COMMAND_MEM_ENABLE);
129
130 sc->sc_ih = cardbus_intr_establish(cc, cf, ca->ca_intrline,
131 IPL_USB, ohci_intr, sc, devname);
132 if (sc->sc_ih == NULL) {
133 printf(": couldn't establish interrupt\n");
134 return;
135 }
136 printf(": irq %d, ", ca->ca_intrline);
137
138 /* Figure out vendor for root hub descriptor. */
139 vendor = cardbus_findvendor(ca->ca_id);
140 sc->sc.sc_id_vendor = PCI_VENDOR(ca->ca_id);
141 if (vendor)
142 strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor));
143 else
144 snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor),
145 "vendor 0x%04x", PCI_VENDOR(ca->ca_id));
146
147 /* Display revision and perform legacy emulation handover. */
148 if (ohci_checkrev(&sc->sc) != USBD_NORMAL_COMPLETION ||
149 ohci_handover(&sc->sc) != USBD_NORMAL_COMPLETION) {
150 cardbus_intr_disestablish(sc->sc_cc, sc->sc_cf, sc->sc_ih);
151 sc->sc_ih = 0;
152 return;
153 }
154
155 r = ohci_init(&sc->sc);
156 if (r != USBD_NORMAL_COMPLETION) {
157 printf("%s: init failed, error=%d\n", devname, r);
158
159 /* Avoid spurious interrupts. */
160 cardbus_intr_disestablish(sc->sc_cc, sc->sc_cf, sc->sc_ih);
161 sc->sc_ih = 0;
162
163 return;
164 }
165
166 /* Attach usb device. */
167 config_found(self, &sc->sc.sc_bus, usbctlprint);
168 }
169
170 int
ohci_cardbus_detach(struct device * self,int flags)171 ohci_cardbus_detach(struct device *self, int flags)
172 {
173 struct ohci_cardbus_softc *sc = (struct ohci_cardbus_softc *)self;
174 struct cardbus_devfunc *ct = sc->sc_ct;
175 int rv;
176
177 rv = ohci_detach(self, flags);
178 if (rv)
179 return (rv);
180
181 if (sc->sc_ih != NULL) {
182 cardbus_intr_disestablish(sc->sc_cc, sc->sc_cf, sc->sc_ih);
183 sc->sc_ih = NULL;
184 }
185 if (sc->sc.sc_size) {
186 Cardbus_mapreg_unmap(ct, CARDBUS_CBMEM, sc->sc.iot,
187 sc->sc.ioh, sc->sc.sc_size);
188 sc->sc.sc_size = 0;
189 }
190
191 return (0);
192 }
193