sys/dev/usbmisc/ugensa/ugensa.c

   1 /* $DragonFly: src/sys/dev/usbmisc/ugensa/ugensa.c,v 1.3 2008/02/21 09:00:19 hasso Exp $ */
   2 /* $OpenBSD: umsm.c,v 1.15 2007/06/14 10:11:16 mbalmer Exp $ */
   3
   4 /*
   5  * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
   6  *
   7  * Permission to use, copy, modify, and distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19
  20 /*
  21  * Generic USB serial driver used for devices where hardware specific
  22  * don't apply or doesn't make sense (for example Qualcomm MSM EVDO, UMTS
  23  * and other similar communication devices).
  24  */
  25
  26 #include <sys/param.h>
  27 #include <sys/systm.h>
  28 #include <sys/kernel.h>
  29 #include <sys/device.h>
  30 #include <sys/conf.h>
  31 #include <sys/tty.h>
  32 #include <sys/types.h>
  33 #include <sys/bus.h>
  34 #include <sys/module.h>
  35
  36 #include <bus/usb/usb.h>
  37 #include <bus/usb/usbdi.h>
  38 #include <bus/usb/usbdi_util.h>
  39 #include <dev/usbmisc/ucom/ucomvar.h>
  40
  41 #ifdef UGENSA_DEBUG
  42 static int      ugensadebug = 1;
  43 #define DPRINTFN(n, x)  do { if (ugensadebug > (n)) kprintf x; } while (0)
  44 #else
  45 #define DPRINTFN(n, x)
  46 #endif
  47 #define DPRINTF(x) DPRINTFN(0, x)
  48
  49 #define UGENSABUFSZ     4096
  50
  51 struct ugensa_softc {
  52         struct ucom_softc        sc_ucom;
  53 };
  54
  55 struct ucom_callback ugensa_callback = {
  56         NULL,
  57         NULL,
  58         NULL,
  59         NULL,
  60         NULL,
  61         NULL,
  62         NULL,
  63         NULL
  64 };
  65
  66 static const struct usb_devno ugensa_devs[] = {
  67         { USB_DEVICE(0x05c6, 0x6613) }, /* Qualcomm HSDPA MSM */
  68         { USB_DEVICE(0x0c88, 0x17da) }, /* Kyocera KPC650 */
  69         { USB_DEVICE(0x0f3d, 0x0112) }, /* AirPrime PC5220 */
  70         { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
  71         { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
  72         { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
  73         { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
  74         { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
  75         { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
  76         { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless AirCard 595U */
  77         { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
  78         { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
  79         { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
  80         { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
  81         { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
  82         { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
  83         { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8755 */
  84         { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
  85         { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
  86         { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
  87         { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
  88         { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
  89         { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880E */
  90         { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881E */
  91         { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880U */
  92         { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881U */
  93         { USB_DEVICE(0x12d1, 0x1001) }, /* Huawei Mobile Connect */
  94         { USB_DEVICE(0x12d1, 0x1003) }, /* Huawei Mobile E220 */
  95         { USB_DEVICE(0x12d1, 0x1004) }, /* Huawei Mobile E220 */
  96         { USB_DEVICE(0x1410, 0x1100) }, /* Novatel Wireless Merlin XS620/S640 */
  97         { USB_DEVICE(0x1410, 0x1110) }, /* Novatel Wireless Merlin S620/V620 */
  98         { USB_DEVICE(0x1410, 0x1120) }, /* Novatel Wireless Merlin EX720 */
  99         { USB_DEVICE(0x1410, 0x1130) }, /* Novatel Wireless Merlin S720 */
 100         { USB_DEVICE(0x1410, 0x1400) }, /* Novatel Wireless Merlin U730 */
 101         { USB_DEVICE(0x1410, 0x1410) }, /* Novatel Wireless Merlin U740 */
 102         { USB_DEVICE(0x1410, 0x1420) }, /* Novatel Wireless Expedite EU870D */
 103         { USB_DEVICE(0x1410, 0x1430) }, /* Novatel Wireless Merlin XU870 */
 104         { USB_DEVICE(0x1410, 0x2100) }, /* Novatel Wireless Expedite EV620 */
 105         { USB_DEVICE(0x1410, 0x2110) }, /* Novatel Wireless Merlin ES620,
 106                                            Merlin ES720, Ovation U720 */
 107         { USB_DEVICE(0x1410, 0x2130) }, /* Novatel Wireless Merlin ES620 */
 108         { USB_DEVICE(0x1410, 0x2410) }, /* Novatel Wireless Expedite EU740 */
 109         { USB_DEVICE(0x1410, 0x4100) }, /* Novatel Wireless Ovation MC727 */
 110         { USB_DEVICE(0x1410, 0x4400) }, /* Novatel Wireless Ovation MC950D */
 111         { USB_DEVICE(0x16d5, 0x6501) }, /* AnyDATA ADU-E100A/D/H */
 112         { USB_DEVICE(0x413c, 0x8114) }, /* Dell Wireless 5700 */
 113         { USB_DEVICE(0x413c, 0x8115) }, /* Dell Wireless 5500 */
 114         { USB_DEVICE(0x413c, 0x8116) }, /* Dell Wireless 5505 */
 115         { USB_DEVICE(0x413c, 0x8117) }, /* Dell Wireless 5700 */
 116         { USB_DEVICE(0x413c, 0x8118) }, /* Dell Wireless 5510 */
 117         { USB_DEVICE(0x413c, 0x8128) }, /* Dell Wireless 5700 */
 118         { USB_DEVICE(0x413c, 0x8136) }, /* Dell Wireless 5520 */
 119         { USB_DEVICE(0x413c, 0x8137) }, /* Dell Wireless 5520 */
 120 };
 121
 122 static device_probe_t ugensa_match;
 123 static device_attach_t ugensa_attach;
 124 static device_detach_t ugensa_detach;
 125
 126 static device_method_t ugensa_methods[] = {
 127         /* Device interface */
 128         DEVMETHOD(device_probe, ugensa_match),
 129         DEVMETHOD(device_attach, ugensa_attach),
 130         DEVMETHOD(device_detach, ugensa_detach),
 131         { 0, 0 }
 132 };
 133
 134 static driver_t ugensa_driver = {
 135         "ucom",
 136         ugensa_methods,
 137         sizeof (struct ugensa_softc)
 138 };
 139
 140 DRIVER_MODULE(ugensa, uhub, ugensa_driver, ucom_devclass, usbd_driver_load, 0);
 141 MODULE_DEPEND(ugensa, usb, 1, 1, 1);
 142 MODULE_DEPEND(ugensa, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
 143 MODULE_VERSION(ugensa, 1);
 144
 145 static int
 146 ugensa_match(device_t self)
 147 {
 148         struct usb_attach_arg *uaa = device_get_ivars(self);
 149
 150         if (uaa->iface == NULL)
 151                 return UMATCH_NONE;
 152
 153         return (usb_lookup(ugensa_devs, uaa->vendor, uaa->product) != NULL) ?
 154             UMATCH_VENDOR_IFACESUBCLASS : UMATCH_NONE;
 155 }
 156
 157 static int
 158 ugensa_attach(device_t self)
 159 {
 160         struct ugensa_softc *sc = device_get_softc(self);
 161         struct usb_attach_arg *uaa = device_get_ivars(self);
 162         struct ucom_softc *ucom;
 163         usb_interface_descriptor_t *id;
 164         usb_endpoint_descriptor_t *ed;
 165         int i;
 166
 167         ucom = &sc->sc_ucom;
 168         bzero(sc, sizeof (struct ugensa_softc));
 169
 170         ucom->sc_dev = self;
 171         ucom->sc_udev = uaa->device;
 172         ucom->sc_iface = uaa->iface;
 173
 174         id = usbd_get_interface_descriptor(ucom->sc_iface);
 175
 176         ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
 177         for (i = 0; i < id->bNumEndpoints; i++) {
 178                 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
 179                 if (ed == NULL) {
 180                         device_printf(ucom->sc_dev, "no endpoint descriptor "
 181                                       "found for %d\n", i);
 182                         goto error;
 183                 }
 184
 185                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
 186                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
 187                         ucom->sc_bulkin_no = ed->bEndpointAddress;
 188                 else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
 189                     UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
 190                         ucom->sc_bulkout_no = ed->bEndpointAddress;
 191         }
 192         if (ucom->sc_bulkin_no == -1 || ucom->sc_bulkout_no == -1) {
 193                 device_printf(ucom->sc_dev, "missing endpoint\n");
 194                 goto error;
 195         }
 196
 197         ucom->sc_parent = sc;
 198         ucom->sc_portno = UCOM_UNK_PORTNO;
 199         ucom->sc_ibufsize = UGENSABUFSZ;
 200         ucom->sc_obufsize = UGENSABUFSZ;
 201         ucom->sc_ibufsizepad = UGENSABUFSZ;
 202         ucom->sc_opkthdrlen = 0;
 203         ucom->sc_callback = &ugensa_callback;
 204
 205         usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, ucom->sc_udev,
 206                            ucom->sc_dev);
 207
 208         DPRINTF(("%s: in = 0x%x, out = 0x%x\n",
 209                  device_get_nameunit(ucom->sc_dev), ucom->sc_bulkin_no,
 210                  ucom->sc_bulkout_no));
 211
 212         ucom_attach(&sc->sc_ucom);
 213
 214         return 0;
 215
 216 error:
 217         ucom->sc_dying = 1;
 218         return ENXIO;
 219 }
 220
 221 static int
 222 ugensa_detach(device_t self)
 223 {
 224         struct ugensa_softc *sc = device_get_softc(self);
 225         int rv = 0;
 226
 227         DPRINTF(("ugensa_detach: sc=%p\n", sc));
 228         sc->sc_ucom.sc_dying = 1;
 229         rv = ucom_detach(&sc->sc_ucom);
 230         usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_ucom.sc_udev,
 231                            sc->sc_ucom.sc_dev);
 232
 233         return (rv);
 234 }
 235
 236 #if 0 /* not yet */
 237 int
 238 ugensa_activate(struct device *self, enum devact act)
 239 {
 240         struct ugensa_softc *sc = (struct ugensa_softc *)self;
 241         int rv = 0;
 242
 243         switch (act) {
 244         case DVACT_ACTIVATE:
 245                 break;
 246
 247         case DVACT_DEACTIVATE:
 248                 if (sc->sc_subdev != NULL)
 249                         rv = config_deactivate(sc->sc_subdev);
 250                 sc->sc_dying = 1;
 251                 break;
 252         }
 253         return (rv);
 254 }
 255 #endif