ugensa.c revision 1.20 1 /* $NetBSD: ugensa.c,v 1.20 2008/05/24 16:40:58 cube Exp $ */
2
3 /*
4 * Copyright (c) 2004, 2005 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Roland C. Dowdeswell <elric (at) netbsd.org>.
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 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: ugensa.c,v 1.20 2008/05/24 16:40:58 cube Exp $");
34
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/device.h>
39 #include <sys/conf.h>
40 #include <sys/tty.h>
41
42 #include <dev/usb/usb.h>
43
44 #include <dev/usb/usbdi.h>
45 #include <dev/usb/usbdi_util.h>
46 #include <dev/usb/usbdevs.h>
47
48 #include <dev/usb/ucomvar.h>
49
50 /* XXXrcd: heh */
51 #define UGENSA_DEBUG 1
52
53 #ifdef UGENSA_DEBUG
54 #define DPRINTF(x) if (ugensadebug) printf x
55 #define DPRINTFN(n,x) if (ugensadebug>(n)) printf x
56 int ugensadebug = 0;
57 #else
58 #define DPRINTF(x)
59 #define DPRINTFN(n,x)
60 #endif
61
62 struct ugensa_softc {
63 USBBASEDEVICE sc_dev; /* base device */
64 usbd_device_handle sc_udev; /* device */
65 usbd_interface_handle sc_iface; /* interface */
66
67 device_t sc_subdev;
68 int sc_numcon;
69
70 u_char sc_dying;
71 };
72
73 struct ucom_methods ugensa_methods = {
74 NULL,
75 NULL,
76 NULL,
77 NULL,
78 NULL,
79 NULL,
80 NULL,
81 NULL,
82 };
83
84 #define UGENSA_CONFIG_INDEX 0
85 #define UGENSA_IFACE_INDEX 0
86 #define UGENSA_BUFSIZE 1024
87
88 struct ugensa_type {
89 struct usb_devno ugensa_dev;
90 u_int16_t ugensa_flags;
91 #define UNTESTED 0x0001
92 };
93
94 static const struct ugensa_type ugensa_devs[] = {
95 {{ USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220 }, 0 },
96 {{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_FLEXPACKGPS }, 0 },
97 {{ USB_VENDOR_QUALCOMM_K, USB_PRODUCT_QUALCOMM_K_CDMA_MSM_K }, 0 },
98 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD580 }, 0 },
99 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD595 }, 0 },
100 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MINI5725}, 0 },
101 {{ USB_VENDOR_DELL, USB_PRODUCT_DELL_HSDPA }, 0 },
102
103 /*
104 * The following devices are untested, but they are purported to
105 * to work in similar device drivers on other OSes:
106 */
107
108 {{ USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A }, UNTESTED },
109 {{ USB_VENDOR_DELL, USB_PRODUCT_DELL_W5500 }, UNTESTED },
110 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_EXPRESSCARD }, UNTESTED },
111 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MERLINV620 }, UNTESTED },
112 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_S720 }, UNTESTED },
113 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U720 }, UNTESTED },
114 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_XU870 }, UNTESTED },
115 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_ES620 }, UNTESTED },
116 {{ USB_VENDOR_QUALCOMM, USB_PRODUCT_QUALCOMM_MSM_HSDPA }, UNTESTED },
117 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 }, UNTESTED },
118 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD875 }, UNTESTED },
119 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720 }, UNTESTED },
120 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5725 }, UNTESTED },
121 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755 }, UNTESTED },
122 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_2 }, UNTESTED },
123 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_3 }, UNTESTED },
124 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8765 }, UNTESTED },
125 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8775 }, UNTESTED }
126 };
127 #define ugensa_lookup(v, p) \
128 ((const struct ugensa_type *)usb_lookup(ugensa_devs, v, p))
129
130 int ugensa_match(device_t, cfdata_t, void *);
131 void ugensa_attach(device_t, device_t, void *);
132 void ugensa_childdet(device_t, device_t);
133 int ugensa_detach(device_t, int);
134 int ugensa_activate(device_t, enum devact);
135 extern struct cfdriver ugensa_cd;
136 CFATTACH_DECL2_NEW(ugensa, sizeof(struct ugensa_softc), ugensa_match,
137 ugensa_attach, ugensa_detach, ugensa_activate, NULL, ugensa_childdet);
138
139 USB_MATCH(ugensa)
140 {
141 USB_MATCH_START(ugensa, uaa);
142
143 DPRINTFN(20,("ugensa: vendor=0x%x, product=0x%x\n",
144 uaa->vendor, uaa->product));
145
146 return (ugensa_lookup(uaa->vendor, uaa->product) != NULL ?
147 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
148 }
149
150 USB_ATTACH(ugensa)
151 {
152 USB_ATTACH_START(ugensa, sc, uaa);
153 usbd_device_handle dev = uaa->device;
154 usbd_interface_handle iface;
155 usb_interface_descriptor_t *id;
156 usb_endpoint_descriptor_t *ed;
157 char *devinfop;
158 const char *devname = device_xname(self);
159 usbd_status err;
160 struct ucom_attach_args uca;
161 int i;
162
163 DPRINTFN(10,("\nugensa_attach: sc=%p\n", sc));
164
165 sc->sc_dev = self;
166
167 /* Move the device into the configured state. */
168 err = usbd_set_config_index(dev, UGENSA_CONFIG_INDEX, 1);
169 if (err) {
170 aprint_error("\n%s: failed to set configuration, err=%s\n",
171 devname, usbd_errstr(err));
172 goto bad;
173 }
174
175 err = usbd_device2interface_handle(dev, UGENSA_IFACE_INDEX, &iface);
176 if (err) {
177 aprint_error("\n%s: failed to get interface, err=%s\n",
178 devname, usbd_errstr(err));
179 goto bad;
180 }
181
182 devinfop = usbd_devinfo_alloc(dev, 0);
183 USB_ATTACH_SETUP;
184 aprint_normal_dev(self, "%s\n", devinfop);
185 usbd_devinfo_free(devinfop);
186
187 if (ugensa_lookup(uaa->vendor, uaa->product)->ugensa_flags & UNTESTED)
188 aprint_normal_dev(self, "WARNING: This device is marked as "
189 "untested. Please submit a report via send-pr(1).\n");
190
191 id = usbd_get_interface_descriptor(iface);
192
193 sc->sc_udev = dev;
194 sc->sc_iface = iface;
195
196 uca.info = "Generic Serial Device";
197 uca.ibufsize = UGENSA_BUFSIZE;
198 uca.obufsize = UGENSA_BUFSIZE;
199 uca.ibufsizepad = UGENSA_BUFSIZE;
200 uca.portno = UCOM_UNK_PORTNO;
201 uca.opkthdrlen = 0;
202 uca.device = dev;
203 uca.iface = iface;
204 uca.methods = &ugensa_methods;
205 uca.arg = sc;
206
207 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
208 USBDEV(sc->sc_dev));
209
210 uca.bulkin = uca.bulkout = -1;
211 for (i = 0; i < id->bNumEndpoints; i++) {
212 int addr, dir, attr;
213
214 ed = usbd_interface2endpoint_descriptor(iface, i);
215 if (ed == NULL) {
216 aprint_error_dev(self,
217 "could not read endpoint descriptor: %s\n",
218 usbd_errstr(err));
219 goto bad;
220 }
221
222 addr = ed->bEndpointAddress;
223 dir = UE_GET_DIR(ed->bEndpointAddress);
224 attr = ed->bmAttributes & UE_XFERTYPE;
225 if (attr == UE_BULK) {
226 if (uca.bulkin == -1 && dir == UE_DIR_IN) {
227 DPRINTF(("%s: Bulk in %d\n", devname, i));
228 uca.bulkin = addr;
229 continue;
230 }
231 if (uca.bulkout == -1 && dir == UE_DIR_OUT) {
232 DPRINTF(("%s: Bulk out %d\n", devname, i));
233 uca.bulkout = addr;
234 continue;
235 }
236 }
237 aprint_error_dev(self, "unexpected endpoint\n");
238 }
239 if (uca.bulkin == -1) {
240 aprint_error_dev(self, "Could not find data bulk in\n");
241 goto bad;
242 }
243 if (uca.bulkout == -1) {
244 aprint_error_dev(self, "Could not find data bulk out\n");
245 goto bad;
246 }
247
248 DPRINTF(("ugensa: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout));
249 sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca,
250 ucomprint, ucomsubmatch);
251
252 if (!pmf_device_register(self, NULL, NULL))
253 aprint_error_dev(self, "couldn't establish power handler\n");
254 USB_ATTACH_SUCCESS_RETURN;
255
256 bad:
257 DPRINTF(("ugensa_attach: ATTACH ERROR\n"));
258 sc->sc_dying = 1;
259 USB_ATTACH_ERROR_RETURN;
260 }
261
262 void
263 ugensa_childdet(device_t self, device_t child)
264 {
265 struct ugensa_softc *sc = device_private(self);
266
267 KASSERT(sc->sc_subdev == child);
268 sc->sc_subdev = NULL;
269 }
270
271 int
272 ugensa_activate(device_t self, enum devact act)
273 {
274 struct ugensa_softc *sc = device_private(self);
275 int rv = 0;
276
277 DPRINTF(("ugensa_activate: sc=%p\n", sc));
278
279 switch (act) {
280 case DVACT_ACTIVATE:
281 return (EOPNOTSUPP);
282 break;
283
284 case DVACT_DEACTIVATE:
285 sc->sc_dying = 1;
286 if (sc->sc_subdev)
287 rv = config_deactivate(sc->sc_subdev);
288 break;
289 }
290 return (rv);
291 }
292
293 USB_DETACH(ugensa)
294 {
295 USB_DETACH_START(ugensa, sc);
296 int rv = 0;
297
298 DPRINTF(("ugensa_detach: sc=%p flags=%d\n", sc, flags));
299
300 sc->sc_dying = 1;
301 pmf_device_deregister(self);
302
303 if (sc->sc_subdev != NULL)
304 rv = config_detach(sc->sc_subdev, flags);
305
306 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
307 USBDEV(sc->sc_dev));
308
309 return (rv);
310 }
311