1 /* $NetBSD: ugensa.c,v 1.22 2008/10/19 11:40:02 joerg 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.22 2008/10/19 11:40:02 joerg 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 /* Move the device into the configured state. */ 152 err = usbd_set_config_index(dev, UGENSA_CONFIG_INDEX, 1); 153 if (err) { 154 aprint_error("\n%s: failed to set configuration, err=%s\n", 155 devname, usbd_errstr(err)); 156 goto bad; 157 } 158 159 err = usbd_device2interface_handle(dev, UGENSA_IFACE_INDEX, &iface); 160 if (err) { 161 aprint_error("\n%s: failed to get interface, err=%s\n", 162 devname, usbd_errstr(err)); 163 goto bad; 164 } 165 166 devinfop = usbd_devinfo_alloc(dev, 0); 167 USB_ATTACH_SETUP; 168 aprint_normal_dev(self, "%s\n", devinfop); 169 usbd_devinfo_free(devinfop); 170 171 if (ugensa_lookup(uaa->vendor, uaa->product)->ugensa_flags & UNTESTED) 172 aprint_normal_dev(self, "WARNING: This device is marked as " 173 "untested. Please submit a report via send-pr(1).\n"); 174 175 id = usbd_get_interface_descriptor(iface); 176 177 sc->sc_udev = dev; 178 sc->sc_iface = iface; 179 180 uca.info = "Generic Serial Device"; 181 uca.ibufsize = UGENSA_BUFSIZE; 182 uca.obufsize = UGENSA_BUFSIZE; 183 uca.ibufsizepad = UGENSA_BUFSIZE; 184 uca.portno = UCOM_UNK_PORTNO; 185 uca.opkthdrlen = 0; 186 uca.device = dev; 187 uca.iface = iface; 188 uca.methods = &ugensa_methods; 189 uca.arg = sc; 190 191 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 192 USBDEV(sc->sc_dev)); 193 194 uca.bulkin = uca.bulkout = -1; 195 for (i = 0; i < id->bNumEndpoints; i++) { 196 int addr, dir, attr; 197 198 ed = usbd_interface2endpoint_descriptor(iface, i); 199 if (ed == NULL) { 200 aprint_error_dev(self, 201 "could not read endpoint descriptor: %s\n", 202 usbd_errstr(err)); 203 goto bad; 204 } 205 206 addr = ed->bEndpointAddress; 207 dir = UE_GET_DIR(ed->bEndpointAddress); 208 attr = ed->bmAttributes & UE_XFERTYPE; 209 if (attr == UE_BULK) { 210 if (uca.bulkin == -1 && dir == UE_DIR_IN) { 211 DPRINTF(("%s: Bulk in %d\n", devname, i)); 212 uca.bulkin = addr; 213 continue; 214 } 215 if (uca.bulkout == -1 && dir == UE_DIR_OUT) { 216 DPRINTF(("%s: Bulk out %d\n", devname, i)); 217 uca.bulkout = addr; 218 continue; 219 } 220 } 221 aprint_error_dev(self, "unexpected endpoint\n"); 222 } 223 if (uca.bulkin == -1) { 224 aprint_error_dev(self, "Could not find data bulk in\n"); 225 goto bad; 226 } 227 if (uca.bulkout == -1) { 228 aprint_error_dev(self, "Could not find data bulk out\n"); 229 goto bad; 230 } 231 232 DPRINTF(("ugensa: in=0x%x out=0x%x\n", uca.bulkin, uca.bulkout)); 233 sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca, 234 ucomprint, ucomsubmatch); 235 236 if (!pmf_device_register(self, NULL, NULL)) 237 aprint_error_dev(self, "couldn't establish power handler\n"); 238 USB_ATTACH_SUCCESS_RETURN; 239 240 bad: 241 DPRINTF(("ugensa_attach: ATTACH ERROR\n")); 242 sc->sc_dying = 1; 243 USB_ATTACH_ERROR_RETURN; 244 } 245 246 void 247 ugensa_childdet(device_t self, device_t child) 248 { 249 struct ugensa_softc *sc = device_private(self); 250 251 KASSERT(sc->sc_subdev == child); 252 sc->sc_subdev = NULL; 253 } 254 255 int 256 ugensa_activate(device_t self, enum devact act) 257 { 258 struct ugensa_softc *sc = device_private(self); 259 int rv = 0; 260 261 DPRINTF(("ugensa_activate: sc=%p\n", sc)); 262 263 switch (act) { 264 case DVACT_ACTIVATE: 265 return (EOPNOTSUPP); 266 break; 267 268 case DVACT_DEACTIVATE: 269 sc->sc_dying = 1; 270 if (sc->sc_subdev) 271 rv = config_deactivate(sc->sc_subdev); 272 break; 273 } 274 return (rv); 275 } 276 277 USB_DETACH(ugensa) 278 { 279 USB_DETACH_START(ugensa, sc); 280 int rv = 0; 281 282 DPRINTF(("ugensa_detach: sc=%p flags=%d\n", sc, flags)); 283 284 sc->sc_dying = 1; 285 pmf_device_deregister(self); 286 287 if (sc->sc_subdev != NULL) 288 rv = config_detach(sc->sc_subdev, flags); 289 290 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 291 USBDEV(sc->sc_dev)); 292 293 return (rv); 294 } 295