1 /* $NetBSD: ugensa.c,v 1.23 2009/09/23 19:07:19 plunky 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@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.23 2009/09/23 19:07:19 plunky 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_DELL, USB_PRODUCT_DELL_HSDPA }, 0 }, 99 100 /* 101 * The following devices are untested, but they are purported to 102 * to work in similar device drivers on other OSes: 103 */ 104 105 {{ USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A }, UNTESTED }, 106 {{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_EXPRESSCARD }, UNTESTED }, 107 {{ USB_VENDOR_QUALCOMM, USB_PRODUCT_QUALCOMM_MSM_HSDPA }, UNTESTED }, 108 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 }, UNTESTED }, 109 {{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD875 }, UNTESTED }, 110 }; 111 #define ugensa_lookup(v, p) \ 112 ((const struct ugensa_type *)usb_lookup(ugensa_devs, v, p)) 113 114 int ugensa_match(device_t, cfdata_t, void *); 115 void ugensa_attach(device_t, device_t, void *); 116 void ugensa_childdet(device_t, device_t); 117 int ugensa_detach(device_t, int); 118 int ugensa_activate(device_t, enum devact); 119 extern struct cfdriver ugensa_cd; 120 CFATTACH_DECL2_NEW(ugensa, sizeof(struct ugensa_softc), ugensa_match, 121 ugensa_attach, ugensa_detach, ugensa_activate, NULL, ugensa_childdet); 122 123 USB_MATCH(ugensa) 124 { 125 USB_MATCH_START(ugensa, uaa); 126 127 DPRINTFN(20,("ugensa: vendor=0x%x, product=0x%x\n", 128 uaa->vendor, uaa->product)); 129 130 return (ugensa_lookup(uaa->vendor, uaa->product) != NULL ? 131 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 132 } 133 134 USB_ATTACH(ugensa) 135 { 136 USB_ATTACH_START(ugensa, sc, uaa); 137 usbd_device_handle dev = uaa->device; 138 usbd_interface_handle iface; 139 usb_interface_descriptor_t *id; 140 usb_endpoint_descriptor_t *ed; 141 char *devinfop; 142 const char *devname = device_xname(self); 143 usbd_status err; 144 struct ucom_attach_args uca; 145 int i; 146 147 DPRINTFN(10,("\nugensa_attach: sc=%p\n", sc)); 148 149 sc->sc_dev = self; 150 151 aprint_naive("\n"); 152 aprint_normal("\n"); 153 154 devinfop = usbd_devinfo_alloc(dev, 0); 155 aprint_normal_dev(self, "%s\n", devinfop); 156 usbd_devinfo_free(devinfop); 157 158 /* Move the device into the configured state. */ 159 err = usbd_set_config_index(dev, UGENSA_CONFIG_INDEX, 1); 160 if (err) { 161 aprint_error("\n%s: failed to set configuration, err=%s\n", 162 devname, usbd_errstr(err)); 163 goto bad; 164 } 165 166 err = usbd_device2interface_handle(dev, UGENSA_IFACE_INDEX, &iface); 167 if (err) { 168 aprint_error("\n%s: failed to get interface, err=%s\n", 169 devname, usbd_errstr(err)); 170 goto bad; 171 } 172 173 if (ugensa_lookup(uaa->vendor, uaa->product)->ugensa_flags & UNTESTED) 174 aprint_normal_dev(self, "WARNING: This device is marked as " 175 "untested. Please submit a report via send-pr(1).\n"); 176 177 id = usbd_get_interface_descriptor(iface); 178 179 sc->sc_udev = dev; 180 sc->sc_iface = iface; 181 182 uca.info = "Generic Serial Device"; 183 uca.ibufsize = UGENSA_BUFSIZE; 184 uca.obufsize = UGENSA_BUFSIZE; 185 uca.ibufsizepad = UGENSA_BUFSIZE; 186 uca.portno = UCOM_UNK_PORTNO; 187 uca.opkthdrlen = 0; 188 uca.device = dev; 189 uca.iface = iface; 190 uca.methods = &ugensa_methods; 191 uca.arg = sc; 192 193 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 194 USBDEV(sc->sc_dev)); 195 196 uca.bulkin = uca.bulkout = -1; 197 for (i = 0; i < id->bNumEndpoints; i++) { 198 int addr, dir, attr; 199 200 ed = usbd_interface2endpoint_descriptor(iface, i); 201 if (ed == NULL) { 202 aprint_error_dev(self, 203 "could not read endpoint descriptor: %s\n", 204 usbd_errstr(err)); 205 goto bad; 206 } 207 208 addr = ed->bEndpointAddress; 209 dir = UE_GET_DIR(ed->bEndpointAddress); 210 attr = ed->bmAttributes & UE_XFERTYPE; 211 if (attr == UE_BULK) { 212 if (uca.bulkin == -1 && dir == UE_DIR_IN) { 213 DPRINTF(("%s: Bulk in %d\n", devname, i)); 214 uca.bulkin = addr; 215 continue; 216 } 217 if (uca.bulkout == -1 && dir == UE_DIR_OUT) { 218 DPRINTF(("%s: Bulk out %d\n", devname, i)); 219 uca.bulkout = addr; 220 continue; 221 } 222 } 223 aprint_error_dev(self, "unexpected endpoint\n"); 224 } 225 if (uca.bulkin == -1) { 226 aprint_error_dev(self, "Could not find data bulk in\n"); 227 goto bad; 228 } 229 if (uca.bulkout == -1) { 230 aprint_error_dev(self, "Could not find data bulk out\n"); 231 goto bad; 232 } 233 234 DPRINTF(("ugensa: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout)); 235 sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca, 236 ucomprint, ucomsubmatch); 237 238 if (!pmf_device_register(self, NULL, NULL)) 239 aprint_error_dev(self, "couldn't establish power handler\n"); 240 USB_ATTACH_SUCCESS_RETURN; 241 242 bad: 243 DPRINTF(("ugensa_attach: ATTACH ERROR\n")); 244 sc->sc_dying = 1; 245 USB_ATTACH_ERROR_RETURN; 246 } 247 248 void 249 ugensa_childdet(device_t self, device_t child) 250 { 251 struct ugensa_softc *sc = device_private(self); 252 253 KASSERT(sc->sc_subdev == child); 254 sc->sc_subdev = NULL; 255 } 256 257 int 258 ugensa_activate(device_t self, enum devact act) 259 { 260 struct ugensa_softc *sc = device_private(self); 261 int rv = 0; 262 263 DPRINTF(("ugensa_activate: sc=%p\n", sc)); 264 265 switch (act) { 266 case DVACT_ACTIVATE: 267 return (EOPNOTSUPP); 268 break; 269 270 case DVACT_DEACTIVATE: 271 sc->sc_dying = 1; 272 if (sc->sc_subdev) 273 rv = config_deactivate(sc->sc_subdev); 274 break; 275 } 276 return (rv); 277 } 278 279 USB_DETACH(ugensa) 280 { 281 USB_DETACH_START(ugensa, sc); 282 int rv = 0; 283 284 DPRINTF(("ugensa_detach: sc=%p flags=%d\n", sc, flags)); 285 286 sc->sc_dying = 1; 287 pmf_device_deregister(self); 288 289 if (sc->sc_subdev != NULL) 290 rv = config_detach(sc->sc_subdev, flags); 291 292 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 293 USBDEV(sc->sc_dev)); 294 295 return (rv); 296 } 297