sys/dev/usb/serial/u3g.c

   1 /*
   2  * Copyright (c) 2008 AnyWi Technologies
   3  * Author: Andrea Guzzo <aguzzo@anywi.com>
   4  * * based on uark.c 1.1 2006/08/14 08:30:22 jsg *
   5  * * parts from ubsa.c 183348 2008-09-25 12:00:56Z phk *
   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  * $FreeBSD$
  20  */
  21
  22 /*
  23  * NOTE:
  24  *
  25  * - The detour through the tty layer is ridiculously expensive wrt
  26  *   buffering due to the high speeds.
  27  *
  28  *   We should consider adding a simple r/w device which allows
  29  *   attaching of PPP in a more efficient way.
  30  *
  31  */
  32
  33
  34 #include <sys/param.h>
  35 #include <sys/eventhandler.h>
  36 #include <sys/stdint.h>
  37 #include <sys/stddef.h>
  38 #include <sys/queue.h>
  39 #include <sys/systm.h>
  40 #include <sys/kernel.h>
  41 #include <sys/bus.h>
  42 #include <sys/module.h>
  43 #include <sys/lock.h>
  44 #include <sys/mutex.h>
  45 #include <sys/condvar.h>
  46 #include <sys/sysctl.h>
  47 #include <sys/sx.h>
  48 #include <sys/unistd.h>
  49 #include <sys/callout.h>
  50 #include <sys/malloc.h>
  51 #include <sys/priv.h>
  52
  53 #include <dev/usb/usb.h>
  54 #include <dev/usb/usbdi.h>
  55 #include <dev/usb/usbdi_util.h>
  56 #include <dev/usb/usb_cdc.h>
  57 #include "usbdevs.h"
  58
  59 #define USB_DEBUG_VAR u3g_debug
  60 #include <dev/usb/usb_debug.h>
  61 #include <dev/usb/usb_process.h>
  62 #include <dev/usb/usb_msctest.h>
  63
  64 #include <dev/usb/serial/usb_serial.h>
  65 #include <dev/usb/quirk/usb_quirk.h>
  66
  67 #ifdef USB_DEBUG
  68 static int u3g_debug = 0;
  69
  70 static SYSCTL_NODE(_hw_usb, OID_AUTO, u3g, CTLFLAG_RW, 0, "USB 3g");
  71 SYSCTL_INT(_hw_usb_u3g, OID_AUTO, debug, CTLFLAG_RWTUN,
  72     &u3g_debug, 0, "Debug level");
  73 #endif
  74
  75 #define U3G_MAXPORTS            12
  76 #define U3G_CONFIG_INDEX        0
  77 #define U3G_BSIZE               2048
  78 #define U3G_TXSIZE              (U3G_BSIZE / U3G_TXFRAMES)
  79 #define U3G_TXFRAMES            4
  80
  81 /* Eject methods; See also usb_quirks.h:UQ_MSC_EJECT_* */
  82 #define U3GINIT_HUAWEI          1       /* Requires Huawei init command */
  83 #define U3GINIT_SIERRA          2       /* Requires Sierra init command */
  84 #define U3GINIT_SCSIEJECT       3       /* Requires SCSI eject command */
  85 #define U3GINIT_REZERO          4       /* Requires SCSI rezero command */
  86 #define U3GINIT_ZTESTOR         5       /* Requires ZTE SCSI command */
  87 #define U3GINIT_CMOTECH         6       /* Requires CMOTECH SCSI command */
  88 #define U3GINIT_WAIT            7       /* Device reappears after a delay */
  89 #define U3GINIT_SAEL_M460       8       /* Requires vendor init */
  90 #define U3GINIT_HUAWEISCSI      9       /* Requires Huawei SCSI init command */
  91 #define U3GINIT_HUAWEISCSI2     10      /* Requires Huawei SCSI init command (2) */
  92 #define U3GINIT_TCT             11      /* Requires TCT Mobile init command */
  93
  94 enum {
  95         U3G_BULK_WR,
  96         U3G_BULK_RD,
  97         U3G_INTR,
  98         U3G_N_TRANSFER,
  99 };
 100
 101 struct u3g_softc {
 102         struct ucom_super_softc sc_super_ucom;
 103         struct ucom_softc sc_ucom[U3G_MAXPORTS];
 104
 105         struct usb_xfer *sc_xfer[U3G_MAXPORTS][U3G_N_TRANSFER];
 106         uint8_t sc_iface[U3G_MAXPORTS];                 /* local status register */
 107         uint8_t sc_lsr[U3G_MAXPORTS];                   /* local status register */
 108         uint8_t sc_msr[U3G_MAXPORTS];                   /* u3g status register */
 109         uint16_t sc_line[U3G_MAXPORTS];                 /* line status */
 110
 111         struct usb_device *sc_udev;
 112         struct mtx sc_mtx;
 113
 114         uint8_t sc_numports;
 115 };
 116
 117 static device_probe_t u3g_probe;
 118 static device_attach_t u3g_attach;
 119 static device_detach_t u3g_detach;
 120 static void u3g_free_softc(struct u3g_softc *);
 121
 122 static usb_callback_t u3g_write_callback;
 123 static usb_callback_t u3g_read_callback;
 124 static usb_callback_t u3g_intr_callback;
 125
 126 static void u3g_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
 127 static void u3g_cfg_set_dtr(struct ucom_softc *, uint8_t);
 128 static void u3g_cfg_set_rts(struct ucom_softc *, uint8_t);
 129 static void u3g_start_read(struct ucom_softc *ucom);
 130 static void u3g_stop_read(struct ucom_softc *ucom);
 131 static void u3g_start_write(struct ucom_softc *ucom);
 132 static void u3g_stop_write(struct ucom_softc *ucom);
 133 static void u3g_poll(struct ucom_softc *ucom);
 134 static void u3g_free(struct ucom_softc *ucom);
 135
 136
 137 static void u3g_test_autoinst(void *, struct usb_device *,
 138                 struct usb_attach_arg *);
 139 static int u3g_driver_loaded(struct module *mod, int what, void *arg);
 140
 141 static eventhandler_tag u3g_etag;
 142
 143 static const struct usb_config u3g_config[U3G_N_TRANSFER] = {
 144
 145         [U3G_BULK_WR] = {
 146                 .type = UE_BULK,
 147                 .endpoint = UE_ADDR_ANY,
 148                 .direction = UE_DIR_OUT,
 149                 .bufsize = U3G_BSIZE,/* bytes */
 150                 .frames = U3G_TXFRAMES,
 151                 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
 152                 .callback = &u3g_write_callback,
 153         },
 154
 155         [U3G_BULK_RD] = {
 156                 .type = UE_BULK,
 157                 .endpoint = UE_ADDR_ANY,
 158                 .direction = UE_DIR_IN,
 159                 .bufsize = U3G_BSIZE,/* bytes */
 160                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 161                 .callback = &u3g_read_callback,
 162         },
 163
 164         [U3G_INTR] = {
 165                 .type = UE_INTERRUPT,
 166                 .endpoint = UE_ADDR_ANY,
 167                 .direction = UE_DIR_IN,
 168                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,.no_pipe_ok = 1,},
 169                 .bufsize = 0,   /* use wMaxPacketSize */
 170                 .callback = &u3g_intr_callback,
 171         },
 172 };
 173
 174 static const struct ucom_callback u3g_callback = {
 175         .ucom_cfg_get_status = &u3g_cfg_get_status,
 176         .ucom_cfg_set_dtr = &u3g_cfg_set_dtr,
 177         .ucom_cfg_set_rts = &u3g_cfg_set_rts,
 178         .ucom_start_read = &u3g_start_read,
 179         .ucom_stop_read = &u3g_stop_read,
 180         .ucom_start_write = &u3g_start_write,
 181         .ucom_stop_write = &u3g_stop_write,
 182         .ucom_poll = &u3g_poll,
 183         .ucom_free = &u3g_free,
 184 };
 185
 186 static device_method_t u3g_methods[] = {
 187         DEVMETHOD(device_probe, u3g_probe),
 188         DEVMETHOD(device_attach, u3g_attach),
 189         DEVMETHOD(device_detach, u3g_detach),
 190         DEVMETHOD_END
 191 };
 192
 193 static devclass_t u3g_devclass;
 194
 195 static driver_t u3g_driver = {
 196         .name = "u3g",
 197         .methods = u3g_methods,
 198         .size = sizeof(struct u3g_softc),
 199 };
 200
 201 static const STRUCT_USB_HOST_ID u3g_devs[] = {
 202 #define U3G_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
 203         U3G_DEV(ABIT, AK_020, 0),
 204         U3G_DEV(ACERP, H10, 0),
 205         U3G_DEV(AIRPLUS, MCD650, 0),
 206         U3G_DEV(AIRPRIME, PC5220, 0),
 207         U3G_DEV(AIRPRIME, AC313U, 0),
 208         U3G_DEV(ALINK, 3G, 0),
 209         U3G_DEV(ALINK, 3GU, 0),
 210         U3G_DEV(ALINK, DWM652U5, 0),
 211         U3G_DEV(ALINK, SIM7600E, 0),
 212         U3G_DEV(AMOI, H01, 0),
 213         U3G_DEV(AMOI, H01A, 0),
 214         U3G_DEV(AMOI, H02, 0),
 215         U3G_DEV(ANYDATA, ADU_500A, 0),
 216         U3G_DEV(ANYDATA, ADU_620UW, 0),
 217         U3G_DEV(ANYDATA, ADU_E100X, 0),
 218         U3G_DEV(AXESSTEL, DATAMODEM, 0),
 219         U3G_DEV(CMOTECH, CDMA_MODEM1, 0),
 220         U3G_DEV(CMOTECH, CGU628, U3GINIT_CMOTECH),
 221         U3G_DEV(DELL, U5500, 0),
 222         U3G_DEV(DELL, U5505, 0),
 223         U3G_DEV(DELL, U5510, 0),
 224         U3G_DEV(DELL, U5520, 0),
 225         U3G_DEV(DELL, U5520_2, 0),
 226         U3G_DEV(DELL, U5520_3, 0),
 227         U3G_DEV(DELL, U5700, 0),
 228         U3G_DEV(DELL, U5700_2, 0),
 229         U3G_DEV(DELL, U5700_3, 0),
 230         U3G_DEV(DELL, U5700_4, 0),
 231         U3G_DEV(DELL, U5720, 0),
 232         U3G_DEV(DELL, U5720_2, 0),
 233         U3G_DEV(DELL, U5730, 0),
 234         U3G_DEV(DELL, U5730_2, 0),
 235         U3G_DEV(DELL, U5730_3, 0),
 236         U3G_DEV(DELL, U740, 0),
 237         U3G_DEV(DLINK, DWR510_CD, U3GINIT_SCSIEJECT),
 238         U3G_DEV(DLINK, DWR510, 0),
 239         U3G_DEV(DLINK, DWM157_CD, U3GINIT_SCSIEJECT),
 240         U3G_DEV(DLINK, DWM157, 0),
 241         U3G_DEV(DLINK, DWM222_CD, U3GINIT_SCSIEJECT),
 242         U3G_DEV(DLINK, DWM222, 0),
 243         U3G_DEV(DLINK3, DWM652, 0),
 244         U3G_DEV(HP, EV2200, 0),
 245         U3G_DEV(HP, HS2300, 0),
 246         U3G_DEV(HP, UN2420_QDL, 0),
 247         U3G_DEV(HP, UN2420, 0),
 248         U3G_DEV(HUAWEI, E1401, U3GINIT_HUAWEI),
 249         U3G_DEV(HUAWEI, E1402, U3GINIT_HUAWEI),
 250         U3G_DEV(HUAWEI, E1403, U3GINIT_HUAWEI),
 251         U3G_DEV(HUAWEI, E1404, U3GINIT_HUAWEI),
 252         U3G_DEV(HUAWEI, E1405, U3GINIT_HUAWEI),
 253         U3G_DEV(HUAWEI, E1406, U3GINIT_HUAWEI),
 254         U3G_DEV(HUAWEI, E1407, U3GINIT_HUAWEI),
 255         U3G_DEV(HUAWEI, E1408, U3GINIT_HUAWEI),
 256         U3G_DEV(HUAWEI, E1409, U3GINIT_HUAWEI),
 257         U3G_DEV(HUAWEI, E140A, U3GINIT_HUAWEI),
 258         U3G_DEV(HUAWEI, E140B, U3GINIT_HUAWEI),
 259         U3G_DEV(HUAWEI, E140D, U3GINIT_HUAWEI),
 260         U3G_DEV(HUAWEI, E140E, U3GINIT_HUAWEI),
 261         U3G_DEV(HUAWEI, E140F, U3GINIT_HUAWEI),
 262         U3G_DEV(HUAWEI, E1410, U3GINIT_HUAWEI),
 263         U3G_DEV(HUAWEI, E1411, U3GINIT_HUAWEI),
 264         U3G_DEV(HUAWEI, E1412, U3GINIT_HUAWEI),
 265         U3G_DEV(HUAWEI, E1413, U3GINIT_HUAWEI),
 266         U3G_DEV(HUAWEI, E1414, U3GINIT_HUAWEI),
 267         U3G_DEV(HUAWEI, E1415, U3GINIT_HUAWEI),
 268         U3G_DEV(HUAWEI, E1416, U3GINIT_HUAWEI),
 269         U3G_DEV(HUAWEI, E1417, U3GINIT_HUAWEI),
 270         U3G_DEV(HUAWEI, E1418, U3GINIT_HUAWEI),
 271         U3G_DEV(HUAWEI, E1419, U3GINIT_HUAWEI),
 272         U3G_DEV(HUAWEI, E141A, U3GINIT_HUAWEI),
 273         U3G_DEV(HUAWEI, E141B, U3GINIT_HUAWEI),
 274         U3G_DEV(HUAWEI, E141C, U3GINIT_HUAWEI),
 275         U3G_DEV(HUAWEI, E141D, U3GINIT_HUAWEI),
 276         U3G_DEV(HUAWEI, E141E, U3GINIT_HUAWEI),
 277         U3G_DEV(HUAWEI, E141F, U3GINIT_HUAWEI),
 278         U3G_DEV(HUAWEI, E1420, U3GINIT_HUAWEI),
 279         U3G_DEV(HUAWEI, E1421, U3GINIT_HUAWEI),
 280         U3G_DEV(HUAWEI, E1422, U3GINIT_HUAWEI),
 281         U3G_DEV(HUAWEI, E1423, U3GINIT_HUAWEI),
 282         U3G_DEV(HUAWEI, E1424, U3GINIT_HUAWEI),
 283         U3G_DEV(HUAWEI, E1425, U3GINIT_HUAWEI),
 284         U3G_DEV(HUAWEI, E1426, U3GINIT_HUAWEI),
 285         U3G_DEV(HUAWEI, E1427, U3GINIT_HUAWEI),
 286         U3G_DEV(HUAWEI, E1428, U3GINIT_HUAWEI),
 287         U3G_DEV(HUAWEI, E1429, U3GINIT_HUAWEI),
 288         U3G_DEV(HUAWEI, E142A, U3GINIT_HUAWEI),
 289         U3G_DEV(HUAWEI, E142B, U3GINIT_HUAWEI),
 290         U3G_DEV(HUAWEI, E142C, U3GINIT_HUAWEI),
 291         U3G_DEV(HUAWEI, E142D, U3GINIT_HUAWEI),
 292         U3G_DEV(HUAWEI, E142E, U3GINIT_HUAWEI),
 293         U3G_DEV(HUAWEI, E142F, U3GINIT_HUAWEI),
 294         U3G_DEV(HUAWEI, E1430, U3GINIT_HUAWEI),
 295         U3G_DEV(HUAWEI, E1431, U3GINIT_HUAWEI),
 296         U3G_DEV(HUAWEI, E1432, U3GINIT_HUAWEI),
 297         U3G_DEV(HUAWEI, E1433, U3GINIT_HUAWEI),
 298         U3G_DEV(HUAWEI, E1434, U3GINIT_HUAWEI),
 299         U3G_DEV(HUAWEI, E1435, U3GINIT_HUAWEI),
 300         U3G_DEV(HUAWEI, E1436, U3GINIT_HUAWEI),
 301         U3G_DEV(HUAWEI, E1437, U3GINIT_HUAWEI),
 302         U3G_DEV(HUAWEI, E1438, U3GINIT_HUAWEI),
 303         U3G_DEV(HUAWEI, E1439, U3GINIT_HUAWEI),
 304         U3G_DEV(HUAWEI, E143A, U3GINIT_HUAWEI),
 305         U3G_DEV(HUAWEI, E143B, U3GINIT_HUAWEI),
 306         U3G_DEV(HUAWEI, E143C, U3GINIT_HUAWEI),
 307         U3G_DEV(HUAWEI, E143D, U3GINIT_HUAWEI),
 308         U3G_DEV(HUAWEI, E143E, U3GINIT_HUAWEI),
 309         U3G_DEV(HUAWEI, E143F, U3GINIT_HUAWEI),
 310         U3G_DEV(HUAWEI, E173, 0),
 311         U3G_DEV(HUAWEI, E173_INIT, U3GINIT_HUAWEISCSI),
 312         U3G_DEV(HUAWEI, E3131, 0),
 313         U3G_DEV(HUAWEI, E3131_INIT, U3GINIT_HUAWEISCSI2),
 314         U3G_DEV(HUAWEI, E180V, U3GINIT_HUAWEI),
 315         U3G_DEV(HUAWEI, E220, U3GINIT_HUAWEI),
 316         U3G_DEV(HUAWEI, E220BIS, U3GINIT_HUAWEI),
 317         U3G_DEV(HUAWEI, E392, U3GINIT_HUAWEISCSI),
 318         U3G_DEV(HUAWEI, ME909U, U3GINIT_HUAWEISCSI2),
 319         U3G_DEV(HUAWEI, ME909S, U3GINIT_HUAWEISCSI2),
 320         U3G_DEV(HUAWEI, MOBILE, U3GINIT_HUAWEI),
 321         U3G_DEV(HUAWEI, E1752, U3GINIT_HUAWEISCSI),
 322         U3G_DEV(HUAWEI, E1820, U3GINIT_HUAWEISCSI),
 323         U3G_DEV(HUAWEI, K3771, U3GINIT_HUAWEI),
 324         U3G_DEV(HUAWEI, K3771_INIT, U3GINIT_HUAWEISCSI2),
 325         U3G_DEV(HUAWEI, K3772, U3GINIT_HUAWEI),
 326         U3G_DEV(HUAWEI, K3772_INIT, U3GINIT_HUAWEISCSI2),
 327         U3G_DEV(HUAWEI, K3765, U3GINIT_HUAWEI),
 328         U3G_DEV(HUAWEI, K3765_INIT, U3GINIT_HUAWEISCSI),
 329         U3G_DEV(HUAWEI, K3770, U3GINIT_HUAWEI),
 330         U3G_DEV(HUAWEI, K3770_INIT, U3GINIT_HUAWEISCSI),
 331         U3G_DEV(HUAWEI, K4505, U3GINIT_HUAWEI),
 332         U3G_DEV(HUAWEI, K4505_INIT, U3GINIT_HUAWEISCSI),
 333         U3G_DEV(HUAWEI, ETS2055, U3GINIT_HUAWEI),
 334         U3G_DEV(HUAWEI, E3272_INIT, U3GINIT_HUAWEISCSI2),
 335         U3G_DEV(HUAWEI, E3272, 0),
 336         U3G_DEV(KYOCERA2, CDMA_MSM_K, 0),
 337         U3G_DEV(KYOCERA2, KPC680, 0),
 338         U3G_DEV(LONGCHEER, WM66, U3GINIT_HUAWEI),
 339         U3G_DEV(LONGCHEER, DISK, U3GINIT_TCT),
 340         U3G_DEV(LONGCHEER, W14, 0),
 341         U3G_DEV(LONGCHEER, XSSTICK, 0),
 342         U3G_DEV(MERLIN, V620, 0),
 343         U3G_DEV(NEOTEL, PRIME, 0),
 344         U3G_DEV(NOVATEL, E725, 0),
 345         U3G_DEV(NOVATEL, ES620, 0),
 346         U3G_DEV(NOVATEL, ES620_2, 0),
 347         U3G_DEV(NOVATEL, EU730, 0),
 348         U3G_DEV(NOVATEL, EU740, 0),
 349         U3G_DEV(NOVATEL, EU870D, 0),
 350         U3G_DEV(NOVATEL, MC760, 0),
 351         U3G_DEV(NOVATEL, MC547, 0),
 352         U3G_DEV(NOVATEL, MC679, 0),
 353         U3G_DEV(NOVATEL, MC950D, 0),
 354         U3G_DEV(NOVATEL, MC990D, 0),
 355         U3G_DEV(NOVATEL, MIFI2200, U3GINIT_SCSIEJECT),
 356         U3G_DEV(NOVATEL, MIFI2200V, U3GINIT_SCSIEJECT),
 357         U3G_DEV(NOVATEL, U720, 0),
 358         U3G_DEV(NOVATEL, U727, 0),
 359         U3G_DEV(NOVATEL, U727_2, 0),
 360         U3G_DEV(NOVATEL, U740, 0),
 361         U3G_DEV(NOVATEL, U740_2, 0),
 362         U3G_DEV(NOVATEL, U760, U3GINIT_SCSIEJECT),
 363         U3G_DEV(NOVATEL, U870, 0),
 364         U3G_DEV(NOVATEL, V620, 0),
 365         U3G_DEV(NOVATEL, V640, 0),
 366         U3G_DEV(NOVATEL, V720, 0),
 367         U3G_DEV(NOVATEL, V740, 0),
 368         U3G_DEV(NOVATEL, X950D, 0),
 369         U3G_DEV(NOVATEL, XU870, 0),
 370         U3G_DEV(MOTOROLA2, MB886, U3GINIT_SCSIEJECT),
 371         U3G_DEV(OPTION, E6500, 0),
 372         U3G_DEV(OPTION, E6501, 0),
 373         U3G_DEV(OPTION, E6601, 0),
 374         U3G_DEV(OPTION, E6721, 0),
 375         U3G_DEV(OPTION, E6741, 0),
 376         U3G_DEV(OPTION, E6761, 0),
 377         U3G_DEV(OPTION, E6800, 0),
 378         U3G_DEV(OPTION, E7021, 0),
 379         U3G_DEV(OPTION, E7041, 0),
 380         U3G_DEV(OPTION, E7061, 0),
 381         U3G_DEV(OPTION, E7100, 0),
 382         U3G_DEV(OPTION, GE40X, 0),
 383         U3G_DEV(OPTION, GT3G, 0),
 384         U3G_DEV(OPTION, GT3GPLUS, 0),
 385         U3G_DEV(OPTION, GT3GQUAD, 0),
 386         U3G_DEV(OPTION, GT3G_1, 0),
 387         U3G_DEV(OPTION, GT3G_2, 0),
 388         U3G_DEV(OPTION, GT3G_3, 0),
 389         U3G_DEV(OPTION, GT3G_4, 0),
 390         U3G_DEV(OPTION, GT3G_5, 0),
 391         U3G_DEV(OPTION, GT3G_6, 0),
 392         U3G_DEV(OPTION, GTHSDPA, 0),
 393         U3G_DEV(OPTION, GTM380, 0),
 394         U3G_DEV(OPTION, GTMAX36, 0),
 395         U3G_DEV(OPTION, GTMAX380HSUPAE, 0),
 396         U3G_DEV(OPTION, GTMAXHSUPA, 0),
 397         U3G_DEV(OPTION, GTMAXHSUPAE, 0),
 398         U3G_DEV(OPTION, VODAFONEMC3G, 0),
 399         U3G_DEV(QISDA, H20_1, 0),
 400         U3G_DEV(QISDA, H20_2, 0),
 401         U3G_DEV(QISDA, H21_1, 0),
 402         U3G_DEV(QISDA, H21_2, 0),
 403         U3G_DEV(QUALCOMM, NTT_L02C_MODEM, U3GINIT_SCSIEJECT),
 404         U3G_DEV(QUALCOMM2, AC8700, 0),
 405         U3G_DEV(QUALCOMM2, MF330, 0),
 406         U3G_DEV(QUALCOMM2, SIM5218, 0),
 407         U3G_DEV(QUALCOMM2, WM620, 0),
 408         U3G_DEV(QUALCOMM2, VW110L, U3GINIT_SCSIEJECT),
 409         U3G_DEV(QUALCOMM2, GOBI2000_QDL, 0),
 410         U3G_DEV(QUALCOMM2, GOBI2000, 0),
 411         U3G_DEV(QUALCOMM2, VT80N, 0),
 412         U3G_DEV(QUALCOMM3, VFAST2, 0),
 413         U3G_DEV(QUALCOMMINC, AC2726, 0),
 414         U3G_DEV(QUALCOMMINC, AC682_INIT, U3GINIT_SCSIEJECT),
 415         U3G_DEV(QUALCOMMINC, AC682, 0),
 416         U3G_DEV(QUALCOMMINC, AC8700, 0),
 417         U3G_DEV(QUALCOMMINC, AC8710, 0),
 418         U3G_DEV(QUALCOMMINC, CDMA_MSM, U3GINIT_SCSIEJECT),
 419         U3G_DEV(QUALCOMMINC, E0002, 0),
 420         U3G_DEV(QUALCOMMINC, E0003, 0),
 421         U3G_DEV(QUALCOMMINC, E0004, 0),
 422         U3G_DEV(QUALCOMMINC, E0005, 0),
 423         U3G_DEV(QUALCOMMINC, E0006, 0),
 424         U3G_DEV(QUALCOMMINC, E0007, 0),
 425         U3G_DEV(QUALCOMMINC, E0008, 0),
 426         U3G_DEV(QUALCOMMINC, E0009, 0),
 427         U3G_DEV(QUALCOMMINC, E000A, 0),
 428         U3G_DEV(QUALCOMMINC, E000B, 0),
 429         U3G_DEV(QUALCOMMINC, E000C, 0),
 430         U3G_DEV(QUALCOMMINC, E000D, 0),
 431         U3G_DEV(QUALCOMMINC, E000E, 0),
 432         U3G_DEV(QUALCOMMINC, E000F, 0),
 433         U3G_DEV(QUALCOMMINC, E0010, 0),
 434         U3G_DEV(QUALCOMMINC, E0011, 0),
 435         U3G_DEV(QUALCOMMINC, E0012, 0),
 436         U3G_DEV(QUALCOMMINC, E0013, 0),
 437         U3G_DEV(QUALCOMMINC, E0014, 0),
 438         U3G_DEV(QUALCOMMINC, E0017, 0),
 439         U3G_DEV(QUALCOMMINC, E0018, 0),
 440         U3G_DEV(QUALCOMMINC, E0019, 0),
 441         U3G_DEV(QUALCOMMINC, E0020, 0),
 442         U3G_DEV(QUALCOMMINC, E0021, 0),
 443         U3G_DEV(QUALCOMMINC, E0022, 0),
 444         U3G_DEV(QUALCOMMINC, E0023, 0),
 445         U3G_DEV(QUALCOMMINC, E0024, 0),
 446         U3G_DEV(QUALCOMMINC, E0025, 0),
 447         U3G_DEV(QUALCOMMINC, E0026, 0),
 448         U3G_DEV(QUALCOMMINC, E0027, 0),
 449         U3G_DEV(QUALCOMMINC, E0028, 0),
 450         U3G_DEV(QUALCOMMINC, E0029, 0),
 451         U3G_DEV(QUALCOMMINC, E0030, 0),
 452         U3G_DEV(QUALCOMMINC, E0032, 0),
 453         U3G_DEV(QUALCOMMINC, E0033, 0),
 454         U3G_DEV(QUALCOMMINC, E0037, 0),
 455         U3G_DEV(QUALCOMMINC, E0039, 0),
 456         U3G_DEV(QUALCOMMINC, E0042, 0),
 457         U3G_DEV(QUALCOMMINC, E0043, 0),
 458         U3G_DEV(QUALCOMMINC, E0048, 0),
 459         U3G_DEV(QUALCOMMINC, E0049, 0),
 460         U3G_DEV(QUALCOMMINC, E0051, 0),
 461         U3G_DEV(QUALCOMMINC, E0052, 0),
 462         U3G_DEV(QUALCOMMINC, E0054, 0),
 463         U3G_DEV(QUALCOMMINC, E0055, 0),
 464         U3G_DEV(QUALCOMMINC, E0057, 0),
 465         U3G_DEV(QUALCOMMINC, E0058, 0),
 466         U3G_DEV(QUALCOMMINC, E0059, 0),
 467         U3G_DEV(QUALCOMMINC, E0060, 0),
 468         U3G_DEV(QUALCOMMINC, E0061, 0),
 469         U3G_DEV(QUALCOMMINC, E0062, 0),
 470         U3G_DEV(QUALCOMMINC, E0063, 0),
 471         U3G_DEV(QUALCOMMINC, E0064, 0),
 472         U3G_DEV(QUALCOMMINC, E0066, 0),
 473         U3G_DEV(QUALCOMMINC, E0069, 0),
 474         U3G_DEV(QUALCOMMINC, E0070, 0),
 475         U3G_DEV(QUALCOMMINC, E0073, 0),
 476         U3G_DEV(QUALCOMMINC, E0076, 0),
 477         U3G_DEV(QUALCOMMINC, E0078, 0),
 478         U3G_DEV(QUALCOMMINC, E0082, 0),
 479         U3G_DEV(QUALCOMMINC, E0086, 0),
 480         U3G_DEV(QUALCOMMINC, SURFSTICK, 0),
 481         U3G_DEV(QUALCOMMINC, E2002, 0),
 482         U3G_DEV(QUALCOMMINC, E2003, 0),
 483         U3G_DEV(QUALCOMMINC, K3772_Z, 0),
 484         U3G_DEV(QUALCOMMINC, K3772_Z_INIT, U3GINIT_SCSIEJECT),
 485         U3G_DEV(QUALCOMMINC, MF112, U3GINIT_ZTESTOR),
 486         U3G_DEV(QUALCOMMINC, MF195E, 0),
 487         U3G_DEV(QUALCOMMINC, MF195E_INIT, U3GINIT_SCSIEJECT),
 488         U3G_DEV(QUALCOMMINC, MF626, 0),
 489         U3G_DEV(QUALCOMMINC, MF628, 0),
 490         U3G_DEV(QUALCOMMINC, MF633R, 0),
 491         /* the following is a RNDIS device, no modem features */
 492         U3G_DEV(QUALCOMMINC, ZTE_MF730M, U3GINIT_SCSIEJECT),
 493         U3G_DEV(QUANTA, GKE, 0),
 494         U3G_DEV(QUANTA, GLE, 0),
 495         U3G_DEV(QUANTA, GLX, 0),
 496         U3G_DEV(QUANTA, Q101, 0),
 497         U3G_DEV(QUANTA, Q111, 0),
 498         U3G_DEV(QUECTEL, EC25, 0),
 499         U3G_DEV(SIERRA, AC402, 0),
 500         U3G_DEV(SIERRA, AC595U, 0),
 501         U3G_DEV(SIERRA, AC313U, 0),
 502         U3G_DEV(SIERRA, AC597E, 0),
 503         U3G_DEV(SIERRA, AC875, 0),
 504         U3G_DEV(SIERRA, AC875E, 0),
 505         U3G_DEV(SIERRA, AC875U, 0),
 506         U3G_DEV(SIERRA, AC875U_2, 0),
 507         U3G_DEV(SIERRA, AC880, 0),
 508         U3G_DEV(SIERRA, AC880E, 0),
 509         U3G_DEV(SIERRA, AC880U, 0),
 510         U3G_DEV(SIERRA, AC881, 0),
 511         U3G_DEV(SIERRA, AC881E, 0),
 512         U3G_DEV(SIERRA, AC881U, 0),
 513         U3G_DEV(SIERRA, AC885E, 0),
 514         U3G_DEV(SIERRA, AC885E_2, 0),
 515         U3G_DEV(SIERRA, AC885U, 0),
 516         U3G_DEV(SIERRA, AIRCARD580, 0),
 517         U3G_DEV(SIERRA, AIRCARD595, 0),
 518         U3G_DEV(SIERRA, C22, 0),
 519         U3G_DEV(SIERRA, C597, 0),
 520         U3G_DEV(SIERRA, C888, 0),
 521         U3G_DEV(SIERRA, E0029, 0),
 522         U3G_DEV(SIERRA, E6892, 0),
 523         U3G_DEV(SIERRA, E6893, 0),
 524         U3G_DEV(SIERRA, EM5625, 0),
 525         U3G_DEV(SIERRA, EM5725, 0),
 526         U3G_DEV(SIERRA, MC5720, 0),
 527         U3G_DEV(SIERRA, MC5720_2, 0),
 528         U3G_DEV(SIERRA, MC5725, 0),
 529         U3G_DEV(SIERRA, MC5727, 0),
 530         U3G_DEV(SIERRA, MC5727_2, 0),
 531         U3G_DEV(SIERRA, MC5728, 0),
 532         U3G_DEV(SIERRA, MC7354, 0),
 533         U3G_DEV(SIERRA, MC7355, 0),
 534         U3G_DEV(SIERRA, MC7430, 0),
 535         U3G_DEV(SIERRA, MC8700, 0),
 536         U3G_DEV(SIERRA, MC8755, 0),
 537         U3G_DEV(SIERRA, MC8755_2, 0),
 538         U3G_DEV(SIERRA, MC8755_3, 0),
 539         U3G_DEV(SIERRA, MC8755_4, 0),
 540         U3G_DEV(SIERRA, MC8765, 0),
 541         U3G_DEV(SIERRA, MC8765_2, 0),
 542         U3G_DEV(SIERRA, MC8765_3, 0),
 543         U3G_DEV(SIERRA, MC8775, 0),
 544         U3G_DEV(SIERRA, MC8775_2, 0),
 545         U3G_DEV(SIERRA, MC8780, 0),
 546         U3G_DEV(SIERRA, MC8780_2, 0),
 547         U3G_DEV(SIERRA, MC8780_3, 0),
 548         U3G_DEV(SIERRA, MC8781, 0),
 549         U3G_DEV(SIERRA, MC8781_2, 0),
 550         U3G_DEV(SIERRA, MC8781_3, 0),
 551         U3G_DEV(SIERRA, MC8785, 0),
 552         U3G_DEV(SIERRA, MC8785_2, 0),
 553         U3G_DEV(SIERRA, MC8790, 0),
 554         U3G_DEV(SIERRA, MC8791, 0),
 555         U3G_DEV(SIERRA, MC8792, 0),
 556         U3G_DEV(SIERRA, MINI5725, 0),
 557         U3G_DEV(SIERRA, T11, 0),
 558         U3G_DEV(SIERRA, T598, 0),
 559         U3G_DEV(SILABS, SAEL, U3GINIT_SAEL_M460),
 560         U3G_DEV(STELERA, C105, 0),
 561         U3G_DEV(STELERA, E1003, 0),
 562         U3G_DEV(STELERA, E1004, 0),
 563         U3G_DEV(STELERA, E1005, 0),
 564         U3G_DEV(STELERA, E1006, 0),
 565         U3G_DEV(STELERA, E1007, 0),
 566         U3G_DEV(STELERA, E1008, 0),
 567         U3G_DEV(STELERA, E1009, 0),
 568         U3G_DEV(STELERA, E100A, 0),
 569         U3G_DEV(STELERA, E100B, 0),
 570         U3G_DEV(STELERA, E100C, 0),
 571         U3G_DEV(STELERA, E100D, 0),
 572         U3G_DEV(STELERA, E100E, 0),
 573         U3G_DEV(STELERA, E100F, 0),
 574         U3G_DEV(STELERA, E1010, 0),
 575         U3G_DEV(STELERA, E1011, 0),
 576         U3G_DEV(STELERA, E1012, 0),
 577         U3G_DEV(TCTMOBILE, X060S, 0),
 578         U3G_DEV(TCTMOBILE, X080S, U3GINIT_TCT),
 579         U3G_DEV(TELIT, UC864E, 0),
 580         U3G_DEV(TELIT, UC864G, 0),
 581         U3G_DEV(TLAYTECH, TEU800, 0),
 582         U3G_DEV(TOSHIBA, G450, 0),
 583         U3G_DEV(TOSHIBA, HSDPA, 0),
 584         U3G_DEV(YISO, C893, 0),
 585         U3G_DEV(WETELECOM, WM_D200, 0),
 586         /* Autoinstallers */
 587         U3G_DEV(NOVATEL, ZEROCD, U3GINIT_SCSIEJECT),
 588         U3G_DEV(OPTION, GTICON322, U3GINIT_REZERO),
 589         U3G_DEV(QUALCOMMINC, ZTE_STOR, U3GINIT_ZTESTOR),
 590         U3G_DEV(QUALCOMMINC, ZTE_STOR2, U3GINIT_SCSIEJECT),
 591         U3G_DEV(QUANTA, Q101_STOR, U3GINIT_SCSIEJECT),
 592         U3G_DEV(SIERRA, TRUINSTALL, U3GINIT_SIERRA),
 593 #undef  U3G_DEV
 594 };
 595
 596 DRIVER_MODULE(u3g, uhub, u3g_driver, u3g_devclass, u3g_driver_loaded, 0);
 597 MODULE_DEPEND(u3g, ucom, 1, 1, 1);
 598 MODULE_DEPEND(u3g, usb, 1, 1, 1);
 599 MODULE_VERSION(u3g, 1);
 600 USB_PNP_HOST_INFO(u3g_devs);
 601
 602 static int
 603 u3g_sierra_init(struct usb_device *udev)
 604 {
 605         struct usb_device_request req;
 606
 607         req.bmRequestType = UT_VENDOR;
 608         req.bRequest = UR_SET_INTERFACE;
 609         USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
 610         USETW(req.wIndex, UHF_PORT_CONNECTION);
 611         USETW(req.wLength, 0);
 612
 613         if (usbd_do_request_flags(udev, NULL, &req,
 614             NULL, 0, NULL, USB_MS_HZ)) {
 615                 /* ignore any errors */
 616         }
 617         return (0);
 618 }
 619
 620 static int
 621 u3g_huawei_init(struct usb_device *udev)
 622 {
 623         struct usb_device_request req;
 624
 625         req.bmRequestType = UT_WRITE_DEVICE;
 626         req.bRequest = UR_SET_FEATURE;
 627         USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
 628         USETW(req.wIndex, UHF_PORT_SUSPEND);
 629         USETW(req.wLength, 0);
 630
 631         if (usbd_do_request_flags(udev, NULL, &req,
 632             NULL, 0, NULL, USB_MS_HZ)) {
 633                 /* ignore any errors */
 634         }
 635         return (0);
 636 }
 637
 638 static int
 639 u3g_huawei_is_cdce(uint16_t idVendor, uint8_t bInterfaceSubClass,
 640     uint8_t bInterfaceProtocol)
 641 {
 642         /*
 643          * This function returns non-zero if the interface being
 644          * probed is of type CDC ethernet, which the U3G driver should
 645          * not attach to. See sys/dev/usb/net/if_cdce.c for matching
 646          * entries.
 647          */
 648         if (idVendor != USB_VENDOR_HUAWEI)
 649                 goto done;
 650
 651         switch (bInterfaceSubClass) {
 652         case 0x02:
 653                 switch (bInterfaceProtocol) {
 654                 case 0x16:
 655                 case 0x46:
 656                 case 0x76:
 657                         return (1);
 658                 default:
 659                         break;
 660                 }
 661                 break;
 662         case 0x03:
 663                 switch (bInterfaceProtocol) {
 664                 case 0x16:
 665                         return (1);
 666                 default:
 667                         break;
 668                 }
 669                 break;
 670         default:
 671                 break;
 672         }
 673 done:
 674         return (0);
 675 }
 676
 677 static void
 678 u3g_sael_m460_init(struct usb_device *udev)
 679 {
 680         static const uint8_t setup[][24] = {
 681              { 0x41, 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
 682              { 0x41, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 },
 683              { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
 684                0x01, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00,
 685                0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
 686              { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x40, 0x02 },
 687              { 0xc1, 0x08, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00 },
 688              { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
 689              { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 },
 690              { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
 691              { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
 692              { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
 693              { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
 694                0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
 695              { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
 696                0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
 697                0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
 698              { 0x41, 0x12, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00 },
 699              { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 },
 700              { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
 701              { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 },
 702              { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00,
 703                0x00, 0x00, 0x00, 0x00, 0x11, 0x13 },
 704              { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00,
 705                0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00,
 706                0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 },
 707              { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 },
 708         };
 709
 710         struct usb_device_request req;
 711         usb_error_t err;
 712         uint16_t len;
 713         uint8_t buf[0x300];
 714         uint8_t n;
 715
 716         DPRINTFN(1, "\n");
 717
 718         if (usbd_req_set_alt_interface_no(udev, NULL, 0, 0)) {
 719                 DPRINTFN(0, "Alt setting 0 failed\n");
 720                 return;
 721         }
 722
 723         for (n = 0; n != nitems(setup); n++) {
 724
 725                 memcpy(&req, setup[n], sizeof(req));
 726
 727                 len = UGETW(req.wLength);
 728                 if (req.bmRequestType & UE_DIR_IN) {
 729                         if (len > sizeof(buf)) {
 730                                 DPRINTFN(0, "too small buffer\n");
 731                                 continue;
 732                         }
 733                         err = usbd_do_request(udev, NULL, &req, buf);
 734                 } else {
 735                         if (len > (sizeof(setup[0]) - 8)) {
 736                                 DPRINTFN(0, "too small buffer\n");
 737                                 continue;
 738                         }
 739                         err = usbd_do_request(udev, NULL, &req,
 740                             __DECONST(uint8_t *, &setup[n][8]));
 741                 }
 742                 if (err) {
 743                         DPRINTFN(1, "request %u failed\n",
 744                             (unsigned int)n);
 745                         /*
 746                          * Some of the requests will fail. Stop doing
 747                          * requests when we are getting timeouts so
 748                          * that we don't block the explore/attach
 749                          * thread forever.
 750                          */
 751                         if (err == USB_ERR_TIMEOUT)
 752                                 break;
 753                 }
 754         }
 755 }
 756
 757 /*
 758  * The following function handles 3G modem devices (E220, Mobile,
 759  * etc.) with auto-install flash disks for Windows/MacOSX on the first
 760  * interface.  After some command or some delay they change appearance
 761  * to a modem.
 762  */
 763 static void
 764 u3g_test_autoinst(void *arg, struct usb_device *udev,
 765     struct usb_attach_arg *uaa)
 766 {
 767         struct usb_interface *iface;
 768         struct usb_interface_descriptor *id;
 769         int error;
 770         unsigned long method;
 771
 772         if (uaa->dev_state != UAA_DEV_READY)
 773                 return;
 774
 775         iface = usbd_get_iface(udev, 0);
 776         if (iface == NULL)
 777                 return;
 778         id = iface->idesc;
 779         if (id == NULL || id->bInterfaceClass != UICLASS_MASS)
 780                 return;
 781
 782         if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEI))
 783                 method = U3GINIT_HUAWEI;
 784         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_SIERRA))
 785                 method = U3GINIT_SIERRA;
 786         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_SCSIEJECT))
 787                 method = U3GINIT_SCSIEJECT;
 788         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_REZERO))
 789                 method = U3GINIT_REZERO;
 790         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_ZTESTOR))
 791                 method = U3GINIT_ZTESTOR;
 792         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_CMOTECH))
 793                 method = U3GINIT_CMOTECH;
 794         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_WAIT))
 795                 method = U3GINIT_WAIT;
 796         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEISCSI))
 797                 method = U3GINIT_HUAWEISCSI;
 798         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEISCSI2))
 799                 method = U3GINIT_HUAWEISCSI2;
 800         else if (usb_test_quirk(uaa, UQ_MSC_EJECT_TCT))
 801                 method = U3GINIT_TCT;
 802         else if (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa) == 0)
 803                 method = USB_GET_DRIVER_INFO(uaa);
 804         else
 805                 return;         /* no device match */
 806
 807         if (bootverbose) {
 808                 printf("Ejecting %s %s using method %ld\n",
 809                        usb_get_manufacturer(udev),
 810                        usb_get_product(udev), method);
 811         }
 812
 813         switch (method) {
 814                 case U3GINIT_HUAWEI:
 815                         error = u3g_huawei_init(udev);
 816                         break;
 817                 case U3GINIT_HUAWEISCSI:
 818                         error = usb_msc_eject(udev, 0, MSC_EJECT_HUAWEI);
 819                         break;
 820                 case U3GINIT_HUAWEISCSI2:
 821                         error = usb_msc_eject(udev, 0, MSC_EJECT_HUAWEI2);
 822                         break;
 823                 case U3GINIT_SCSIEJECT:
 824                         error = usb_msc_eject(udev, 0, MSC_EJECT_STOPUNIT);
 825                         break;
 826                 case U3GINIT_REZERO:
 827                         error = usb_msc_eject(udev, 0, MSC_EJECT_REZERO);
 828                         break;
 829                 case U3GINIT_ZTESTOR:
 830                         error = usb_msc_eject(udev, 0, MSC_EJECT_STOPUNIT);
 831                         if (error == 0)
 832                             error = usb_msc_eject(udev, 0, MSC_EJECT_ZTESTOR);
 833                         break;
 834                 case U3GINIT_CMOTECH:
 835                         error = usb_msc_eject(udev, 0, MSC_EJECT_CMOTECH);
 836                         break;
 837                 case U3GINIT_TCT:
 838                         error = usb_msc_eject(udev, 0, MSC_EJECT_TCT);
 839                         break;
 840                 case U3GINIT_SIERRA:
 841                         error = u3g_sierra_init(udev);
 842                         break;
 843                 case U3GINIT_WAIT:
 844                         /* Just pretend we ejected, the card will timeout */
 845                         error = 0;
 846                         break;
 847                 default:
 848                         /* no 3G eject quirks */
 849                         error = EOPNOTSUPP;
 850                         break;
 851         }
 852         if (error == 0) {
 853                 /* success, mark the udev as disappearing */
 854                 uaa->dev_state = UAA_DEV_EJECTING;
 855         }
 856 }
 857
 858 static int
 859 u3g_driver_loaded(struct module *mod, int what, void *arg)
 860 {
 861         switch (what) {
 862         case MOD_LOAD:
 863                 /* register our autoinstall handler */
 864                 u3g_etag = EVENTHANDLER_REGISTER(usb_dev_configured,
 865                     u3g_test_autoinst, NULL, EVENTHANDLER_PRI_ANY);
 866                 break;
 867         case MOD_UNLOAD:
 868                 EVENTHANDLER_DEREGISTER(usb_dev_configured, u3g_etag);
 869                 break;
 870         default:
 871                 return (EOPNOTSUPP);
 872         }
 873         return (0);
 874 }
 875
 876 static int
 877 u3g_probe(device_t self)
 878 {
 879         struct usb_attach_arg *uaa = device_get_ivars(self);
 880
 881         if (uaa->usb_mode != USB_MODE_HOST) {
 882                 return (ENXIO);
 883         }
 884         if (uaa->info.bConfigIndex != U3G_CONFIG_INDEX) {
 885                 return (ENXIO);
 886         }
 887         if (uaa->info.bInterfaceClass != UICLASS_VENDOR) {
 888                 return (ENXIO);
 889         }
 890         if (u3g_huawei_is_cdce(uaa->info.idVendor, uaa->info.bInterfaceSubClass,
 891             uaa->info.bInterfaceProtocol)) {
 892                 return (ENXIO);
 893         }
 894         return (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa));
 895 }
 896
 897 static int
 898 u3g_attach(device_t dev)
 899 {
 900         struct usb_config u3g_config_tmp[U3G_N_TRANSFER];
 901         struct usb_attach_arg *uaa = device_get_ivars(dev);
 902         struct u3g_softc *sc = device_get_softc(dev);
 903         struct usb_interface *iface;
 904         struct usb_interface_descriptor *id;
 905         uint32_t iface_valid;
 906         int error, type, nports;
 907         int ep, n;
 908         uint8_t i;
 909
 910         DPRINTF("sc=%p\n", sc);
 911
 912         type = USB_GET_DRIVER_INFO(uaa);
 913         if (type == U3GINIT_SAEL_M460
 914             || usb_test_quirk(uaa, UQ_MSC_EJECT_SAEL_M460)) {
 915                 u3g_sael_m460_init(uaa->device);
 916         }
 917
 918         /* copy in USB config */
 919         for (n = 0; n != U3G_N_TRANSFER; n++)
 920                 u3g_config_tmp[n] = u3g_config[n];
 921
 922         device_set_usb_desc(dev);
 923         mtx_init(&sc->sc_mtx, "u3g", NULL, MTX_DEF);
 924         ucom_ref(&sc->sc_super_ucom);
 925
 926         sc->sc_udev = uaa->device;
 927
 928         /* Claim all interfaces on the device */
 929         iface_valid = 0;
 930         for (i = uaa->info.bIfaceIndex; i < USB_IFACE_MAX; i++) {
 931                 iface = usbd_get_iface(uaa->device, i);
 932                 if (iface == NULL)
 933                         break;
 934                 id = usbd_get_interface_descriptor(iface);
 935                 if (id == NULL || id->bInterfaceClass != UICLASS_VENDOR)
 936                         continue;
 937                 if (u3g_huawei_is_cdce(uaa->info.idVendor,
 938                     id->bInterfaceSubClass, id->bInterfaceProtocol))
 939                         continue;
 940                 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
 941                 iface_valid |= (1<<i);
 942         }
 943
 944         i = 0;          /* interface index */
 945         ep = 0;         /* endpoint index */
 946         nports = 0;     /* number of ports */
 947         while (i < USB_IFACE_MAX) {
 948                 if ((iface_valid & (1<<i)) == 0) {
 949                         i++;
 950                         continue;
 951                 }
 952
 953                 /* update BULK endpoint index */
 954                 for (n = 0; n < U3G_N_TRANSFER; n++)
 955                         u3g_config_tmp[n].ep_index = ep;
 956
 957                 /* try to allocate a set of BULK endpoints */
 958                 error = usbd_transfer_setup(uaa->device, &i,
 959                     sc->sc_xfer[nports], u3g_config_tmp, U3G_N_TRANSFER,
 960                     &sc->sc_ucom[nports], &sc->sc_mtx);
 961                 if (error) {
 962                         /* next interface */
 963                         i++;
 964                         ep = 0;
 965                         continue;
 966                 }
 967
 968                 iface = usbd_get_iface(uaa->device, i);
 969                 id = usbd_get_interface_descriptor(iface);
 970                 sc->sc_iface[nports] = id->bInterfaceNumber;
 971
 972                 if (bootverbose && sc->sc_xfer[nports][U3G_INTR]) {
 973                         device_printf(dev, "port %d supports modem control\n",
 974                                       nports);
 975                 }
 976
 977                 /* set stall by default */
 978                 mtx_lock(&sc->sc_mtx);
 979                 usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_WR]);
 980                 usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_RD]);
 981                 mtx_unlock(&sc->sc_mtx);
 982
 983                 nports++;       /* found one port */
 984                 ep++;
 985                 if (nports == U3G_MAXPORTS)
 986                         break;
 987         }
 988         if (nports == 0) {
 989                 device_printf(dev, "no ports found\n");
 990                 goto detach;
 991         }
 992         sc->sc_numports = nports;
 993
 994         error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom,
 995             sc->sc_numports, sc, &u3g_callback, &sc->sc_mtx);
 996         if (error) {
 997                 DPRINTF("ucom_attach failed\n");
 998                 goto detach;
 999         }
1000         ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
1001         device_printf(dev, "Found %u port%s.\n", sc->sc_numports,
1002             sc->sc_numports > 1 ? "s":"");
1003
1004         return (0);
1005
1006 detach:
1007         u3g_detach(dev);
1008         return (ENXIO);
1009 }
1010
1011 static int
1012 u3g_detach(device_t dev)
1013 {
1014         struct u3g_softc *sc = device_get_softc(dev);
1015         uint8_t subunit;
1016
1017         DPRINTF("sc=%p\n", sc);
1018
1019         /* NOTE: It is not dangerous to detach more ports than attached! */
1020         ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
1021
1022         for (subunit = 0; subunit != U3G_MAXPORTS; subunit++)
1023                 usbd_transfer_unsetup(sc->sc_xfer[subunit], U3G_N_TRANSFER);
1024
1025         device_claim_softc(dev);
1026
1027         u3g_free_softc(sc);
1028
1029         return (0);
1030 }
1031
1032 UCOM_UNLOAD_DRAIN(u3g);
1033
1034 static void
1035 u3g_free_softc(struct u3g_softc *sc)
1036 {
1037         if (ucom_unref(&sc->sc_super_ucom)) {
1038                 mtx_destroy(&sc->sc_mtx);
1039                 device_free_softc(sc);
1040         }
1041 }
1042
1043 static void
1044 u3g_free(struct ucom_softc *ucom)
1045 {
1046         u3g_free_softc(ucom->sc_parent);
1047 }
1048
1049 static void
1050 u3g_start_read(struct ucom_softc *ucom)
1051 {
1052         struct u3g_softc *sc = ucom->sc_parent;
1053
1054         /* start interrupt endpoint (if configured) */
1055         usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_INTR]);
1056
1057         /* start read endpoint */
1058         usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_RD]);
1059 }
1060
1061 static void
1062 u3g_stop_read(struct ucom_softc *ucom)
1063 {
1064         struct u3g_softc *sc = ucom->sc_parent;
1065
1066         /* stop interrupt endpoint (if configured) */
1067         usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_INTR]);
1068
1069         /* stop read endpoint */
1070         usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_RD]);
1071 }
1072
1073 static void
1074 u3g_start_write(struct ucom_softc *ucom)
1075 {
1076         struct u3g_softc *sc = ucom->sc_parent;
1077
1078         usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_WR]);
1079 }
1080
1081 static void
1082 u3g_stop_write(struct ucom_softc *ucom)
1083 {
1084         struct u3g_softc *sc = ucom->sc_parent;
1085
1086         usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_WR]);
1087 }
1088
1089 static void
1090 u3g_write_callback(struct usb_xfer *xfer, usb_error_t error)
1091 {
1092         struct ucom_softc *ucom = usbd_xfer_softc(xfer);
1093         struct usb_page_cache *pc;
1094         uint32_t actlen;
1095         uint32_t frame;
1096
1097         switch (USB_GET_STATE(xfer)) {
1098         case USB_ST_TRANSFERRED:
1099         case USB_ST_SETUP:
1100 tr_setup:
1101                 for (frame = 0; frame != U3G_TXFRAMES; frame++) {
1102                         usbd_xfer_set_frame_offset(xfer, frame * U3G_TXSIZE, frame);
1103
1104                         pc = usbd_xfer_get_frame(xfer, frame);
1105                         if (ucom_get_data(ucom, pc, 0, U3G_TXSIZE, &actlen) == 0)
1106                                 break;
1107                         usbd_xfer_set_frame_len(xfer, frame, actlen);
1108                 }
1109                 if (frame != 0) {
1110                         usbd_xfer_set_frames(xfer, frame);
1111                         usbd_transfer_submit(xfer);
1112                 }
1113                 break;
1114
1115         default:                        /* Error */
1116                 if (error != USB_ERR_CANCELLED) {
1117                         /* do a builtin clear-stall */
1118                         usbd_xfer_set_stall(xfer);
1119                         goto tr_setup;
1120                 }
1121                 break;
1122         }
1123 }
1124
1125 static void
1126 u3g_read_callback(struct usb_xfer *xfer, usb_error_t error)
1127 {
1128         struct ucom_softc *ucom = usbd_xfer_softc(xfer);
1129         struct usb_page_cache *pc;
1130         int actlen;
1131
1132         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1133
1134         switch (USB_GET_STATE(xfer)) {
1135         case USB_ST_TRANSFERRED:
1136                 pc = usbd_xfer_get_frame(xfer, 0);
1137                 ucom_put_data(ucom, pc, 0, actlen);
1138
1139         case USB_ST_SETUP:
1140 tr_setup:
1141                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1142                 usbd_transfer_submit(xfer);
1143                 break;
1144
1145         default:                        /* Error */
1146                 if (error != USB_ERR_CANCELLED) {
1147                         /* do a builtin clear-stall */
1148                         usbd_xfer_set_stall(xfer);
1149                         goto tr_setup;
1150                 }
1151                 break;
1152         }
1153 }
1154
1155 static void
1156 u3g_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
1157 {
1158         struct u3g_softc *sc = ucom->sc_parent;
1159
1160         /* XXX Note: sc_lsr is always zero */
1161         *lsr = sc->sc_lsr[ucom->sc_subunit];
1162         *msr = sc->sc_msr[ucom->sc_subunit];
1163 }
1164
1165 static void
1166 u3g_cfg_set_line(struct ucom_softc *ucom)
1167 {
1168         struct u3g_softc *sc = ucom->sc_parent;
1169         struct usb_device_request req;
1170
1171         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1172         req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
1173         USETW(req.wValue, sc->sc_line[ucom->sc_subunit]);
1174         req.wIndex[0] = sc->sc_iface[ucom->sc_subunit];
1175         req.wIndex[1] = 0;
1176         USETW(req.wLength, 0);
1177
1178         ucom_cfg_do_request(sc->sc_udev, ucom,
1179             &req, NULL, 0, 1000);
1180 }
1181
1182 static void
1183 u3g_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
1184 {
1185         struct u3g_softc *sc = ucom->sc_parent;
1186
1187         DPRINTF("onoff = %d\n", onoff);
1188
1189         if (onoff)
1190                 sc->sc_line[ucom->sc_subunit] |= UCDC_LINE_DTR;
1191         else
1192                 sc->sc_line[ucom->sc_subunit] &= ~UCDC_LINE_DTR;
1193
1194         u3g_cfg_set_line(ucom);
1195 }
1196
1197 static void
1198 u3g_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
1199 {
1200         struct u3g_softc *sc = ucom->sc_parent;
1201
1202         DPRINTF("onoff = %d\n", onoff);
1203
1204         if (onoff)
1205                 sc->sc_line[ucom->sc_subunit] |= UCDC_LINE_RTS;
1206         else
1207                 sc->sc_line[ucom->sc_subunit] &= ~UCDC_LINE_RTS;
1208
1209         u3g_cfg_set_line(ucom);
1210 }
1211
1212 static void
1213 u3g_intr_callback(struct usb_xfer *xfer, usb_error_t error)
1214 {
1215         struct ucom_softc *ucom = usbd_xfer_softc(xfer);
1216         struct u3g_softc *sc = ucom->sc_parent;
1217         struct usb_page_cache *pc;
1218         struct usb_cdc_notification pkt;
1219         int actlen;
1220         uint16_t wLen;
1221         uint8_t mstatus;
1222
1223         usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1224
1225         switch (USB_GET_STATE(xfer)) {
1226         case USB_ST_TRANSFERRED:
1227                 if (actlen < 8) {       /* usb_cdc_notification with 2 data bytes */
1228                         DPRINTF("message too short (expected 8, received %d)\n", actlen);
1229                         goto tr_setup;
1230                 }
1231                 pc = usbd_xfer_get_frame(xfer, 0);
1232                 usbd_copy_out(pc, 0, &pkt, actlen);
1233
1234                 wLen = UGETW(pkt.wLength);
1235                 if (wLen < 2) {
1236                         DPRINTF("message too short (expected 2 data bytes, received %d)\n", wLen);
1237                         goto tr_setup;
1238                 }
1239
1240                 if (pkt.bmRequestType == UCDC_NOTIFICATION
1241                     && pkt.bNotification == UCDC_N_SERIAL_STATE) {
1242                         /*
1243                          * Set the serial state in ucom driver based on
1244                          * the bits from the notify message
1245                          */
1246                         DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
1247                             pkt.data[0], pkt.data[1]);
1248
1249                         /* currently, lsr is always zero. */
1250                         sc->sc_lsr[ucom->sc_subunit] = 0;
1251                         sc->sc_msr[ucom->sc_subunit] = 0;
1252
1253                         mstatus = pkt.data[0];
1254
1255                         if (mstatus & UCDC_N_SERIAL_RI)
1256                                 sc->sc_msr[ucom->sc_subunit] |= SER_RI;
1257                         if (mstatus & UCDC_N_SERIAL_DSR)
1258                                 sc->sc_msr[ucom->sc_subunit] |= SER_DSR;
1259                         if (mstatus & UCDC_N_SERIAL_DCD)
1260                                 sc->sc_msr[ucom->sc_subunit] |= SER_DCD;
1261                         ucom_status_change(ucom);
1262                 }
1263
1264         case USB_ST_SETUP:
1265 tr_setup:
1266                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
1267                 usbd_transfer_submit(xfer);
1268                 return;
1269
1270         default:                        /* Error */
1271                 if (error != USB_ERR_CANCELLED) {
1272                         /* try to clear stall first */
1273                         usbd_xfer_set_stall(xfer);
1274                         goto tr_setup;
1275                 }
1276                 return;
1277         }
1278 }
1279
1280 static void
1281 u3g_poll(struct ucom_softc *ucom)
1282 {
1283         struct u3g_softc *sc = ucom->sc_parent;
1284         usbd_transfer_poll(sc->sc_xfer[ucom->sc_subunit], U3G_N_TRANSFER);
1285 }