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