u3g.c revision 225041
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: head/sys/dev/usb/serial/u3g.c 225041 2011-08-20 16:21:40Z hselasky $ 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/stdint.h> 35#include <sys/stddef.h> 36#include <sys/param.h> 37#include <sys/queue.h> 38#include <sys/types.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 "usbdevs.h" 57 58#define USB_DEBUG_VAR u3g_debug 59#include <dev/usb/usb_debug.h> 60#include <dev/usb/usb_process.h> 61#include <dev/usb/usb_msctest.h> 62 63#include <dev/usb/serial/usb_serial.h> 64#include <dev/usb/quirk/usb_quirk.h> 65 66#ifdef USB_DEBUG 67static int u3g_debug = 0; 68 69SYSCTL_NODE(_hw_usb, OID_AUTO, u3g, CTLFLAG_RW, 0, "USB 3g"); 70SYSCTL_INT(_hw_usb_u3g, OID_AUTO, debug, CTLFLAG_RW, 71 &u3g_debug, 0, "Debug level"); 72#endif 73 74#define U3G_MAXPORTS 12 75#define U3G_CONFIG_INDEX 0 76#define U3G_BSIZE 2048 77 78#define U3GSP_GPRS 0 79#define U3GSP_EDGE 1 80#define U3GSP_CDMA 2 81#define U3GSP_UMTS 3 82#define U3GSP_HSDPA 4 83#define U3GSP_HSUPA 5 84#define U3GSP_HSPA 6 85#define U3GSP_MAX 7 86 87/* Eject methods; See also usb_quirks.h:UQ_MSC_EJECT_* */ 88#define U3GINIT_HUAWEI 1 /* Requires Huawei init command */ 89#define U3GINIT_SIERRA 2 /* Requires Sierra init command */ 90#define U3GINIT_SCSIEJECT 3 /* Requires SCSI eject command */ 91#define U3GINIT_REZERO 4 /* Requires SCSI rezero command */ 92#define U3GINIT_ZTESTOR 5 /* Requires ZTE SCSI command */ 93#define U3GINIT_CMOTECH 6 /* Requires CMOTECH SCSI command */ 94#define U3GINIT_WAIT 7 /* Device reappears after a delay */ 95#define U3GINIT_SAEL_M460 8 /* Requires vendor init */ 96#define U3GINIT_HUAWEISCSI 9 /* Requires Huawei SCSI init command */ 97#define U3GINIT_TCT 10 /* Requires TCT Mobile init command */ 98 99enum { 100 U3G_BULK_WR, 101 U3G_BULK_RD, 102 U3G_N_TRANSFER, 103}; 104 105struct u3g_softc { 106 struct ucom_super_softc sc_super_ucom; 107 struct ucom_softc sc_ucom[U3G_MAXPORTS]; 108 109 struct usb_xfer *sc_xfer[U3G_MAXPORTS][U3G_N_TRANSFER]; 110 struct usb_device *sc_udev; 111 struct mtx sc_mtx; 112 113 uint8_t sc_lsr; /* local status register */ 114 uint8_t sc_msr; /* U3G status register */ 115 uint8_t sc_numports; 116}; 117 118static device_probe_t u3g_probe; 119static device_attach_t u3g_attach; 120static device_detach_t u3g_detach; 121 122static usb_callback_t u3g_write_callback; 123static usb_callback_t u3g_read_callback; 124 125static void u3g_start_read(struct ucom_softc *ucom); 126static void u3g_stop_read(struct ucom_softc *ucom); 127static void u3g_start_write(struct ucom_softc *ucom); 128static void u3g_stop_write(struct ucom_softc *ucom); 129 130 131static void u3g_test_autoinst(void *, struct usb_device *, 132 struct usb_attach_arg *); 133static int u3g_driver_loaded(struct module *mod, int what, void *arg); 134 135static eventhandler_tag u3g_etag; 136 137static const struct usb_config u3g_config[U3G_N_TRANSFER] = { 138 139 [U3G_BULK_WR] = { 140 .type = UE_BULK, 141 .endpoint = UE_ADDR_ANY, 142 .direction = UE_DIR_OUT, 143 .bufsize = U3G_BSIZE,/* bytes */ 144 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 145 .callback = &u3g_write_callback, 146 }, 147 148 [U3G_BULK_RD] = { 149 .type = UE_BULK, 150 .endpoint = UE_ADDR_ANY, 151 .direction = UE_DIR_IN, 152 .bufsize = U3G_BSIZE,/* bytes */ 153 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 154 .callback = &u3g_read_callback, 155 }, 156}; 157 158static const struct ucom_callback u3g_callback = { 159 .ucom_start_read = &u3g_start_read, 160 .ucom_stop_read = &u3g_stop_read, 161 .ucom_start_write = &u3g_start_write, 162 .ucom_stop_write = &u3g_stop_write, 163}; 164 165static device_method_t u3g_methods[] = { 166 DEVMETHOD(device_probe, u3g_probe), 167 DEVMETHOD(device_attach, u3g_attach), 168 DEVMETHOD(device_detach, u3g_detach), 169 {0, 0} 170}; 171 172static devclass_t u3g_devclass; 173 174static driver_t u3g_driver = { 175 .name = "u3g", 176 .methods = u3g_methods, 177 .size = sizeof(struct u3g_softc), 178}; 179 180DRIVER_MODULE(u3g, uhub, u3g_driver, u3g_devclass, u3g_driver_loaded, 0); 181MODULE_DEPEND(u3g, ucom, 1, 1, 1); 182MODULE_DEPEND(u3g, usb, 1, 1, 1); 183MODULE_VERSION(u3g, 1); 184 185static const STRUCT_USB_HOST_ID u3g_devs[] = { 186#define U3G_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) } 187 U3G_DEV(ACERP, H10, 0), 188 U3G_DEV(AIRPLUS, MCD650, 0), 189 U3G_DEV(AIRPRIME, PC5220, 0), 190 U3G_DEV(ALINK, 3G, 0), 191 U3G_DEV(ALINK, 3GU, 0), 192 U3G_DEV(ALINK, DWM652U5, 0), 193 U3G_DEV(AMOI, H01, 0), 194 U3G_DEV(AMOI, H01A, 0), 195 U3G_DEV(AMOI, H02, 0), 196 U3G_DEV(ANYDATA, ADU_500A, 0), 197 U3G_DEV(ANYDATA, ADU_620UW, 0), 198 U3G_DEV(ANYDATA, ADU_E100X, 0), 199 U3G_DEV(AXESSTEL, DATAMODEM, 0), 200 U3G_DEV(CMOTECH, CDMA_MODEM1, 0), 201 U3G_DEV(CMOTECH, CGU628, U3GINIT_CMOTECH), 202 U3G_DEV(DELL, U5500, 0), 203 U3G_DEV(DELL, U5505, 0), 204 U3G_DEV(DELL, U5510, 0), 205 U3G_DEV(DELL, U5520, 0), 206 U3G_DEV(DELL, U5520_2, 0), 207 U3G_DEV(DELL, U5520_3, 0), 208 U3G_DEV(DELL, U5700, 0), 209 U3G_DEV(DELL, U5700_2, 0), 210 U3G_DEV(DELL, U5700_3, 0), 211 U3G_DEV(DELL, U5700_4, 0), 212 U3G_DEV(DELL, U5720, 0), 213 U3G_DEV(DELL, U5720_2, 0), 214 U3G_DEV(DELL, U5730, 0), 215 U3G_DEV(DELL, U5730_2, 0), 216 U3G_DEV(DELL, U5730_3, 0), 217 U3G_DEV(DELL, U740, 0), 218 U3G_DEV(DLINK3, DWM652, 0), 219 U3G_DEV(HP, EV2200, 0), 220 U3G_DEV(HP, HS2300, 0), 221 U3G_DEV(HUAWEI, E1401, U3GINIT_HUAWEI), 222 U3G_DEV(HUAWEI, E1402, U3GINIT_HUAWEI), 223 U3G_DEV(HUAWEI, E1403, U3GINIT_HUAWEI), 224 U3G_DEV(HUAWEI, E1404, U3GINIT_HUAWEI), 225 U3G_DEV(HUAWEI, E1405, U3GINIT_HUAWEI), 226 U3G_DEV(HUAWEI, E1406, U3GINIT_HUAWEI), 227 U3G_DEV(HUAWEI, E1407, U3GINIT_HUAWEI), 228 U3G_DEV(HUAWEI, E1408, U3GINIT_HUAWEI), 229 U3G_DEV(HUAWEI, E1409, U3GINIT_HUAWEI), 230 U3G_DEV(HUAWEI, E140A, U3GINIT_HUAWEI), 231 U3G_DEV(HUAWEI, E140B, U3GINIT_HUAWEI), 232 U3G_DEV(HUAWEI, E140D, U3GINIT_HUAWEI), 233 U3G_DEV(HUAWEI, E140E, U3GINIT_HUAWEI), 234 U3G_DEV(HUAWEI, E140F, U3GINIT_HUAWEI), 235 U3G_DEV(HUAWEI, E1410, U3GINIT_HUAWEI), 236 U3G_DEV(HUAWEI, E1411, U3GINIT_HUAWEI), 237 U3G_DEV(HUAWEI, E1412, U3GINIT_HUAWEI), 238 U3G_DEV(HUAWEI, E1413, U3GINIT_HUAWEI), 239 U3G_DEV(HUAWEI, E1414, U3GINIT_HUAWEI), 240 U3G_DEV(HUAWEI, E1415, U3GINIT_HUAWEI), 241 U3G_DEV(HUAWEI, E1416, U3GINIT_HUAWEI), 242 U3G_DEV(HUAWEI, E1417, U3GINIT_HUAWEI), 243 U3G_DEV(HUAWEI, E1418, U3GINIT_HUAWEI), 244 U3G_DEV(HUAWEI, E1419, U3GINIT_HUAWEI), 245 U3G_DEV(HUAWEI, E141A, U3GINIT_HUAWEI), 246 U3G_DEV(HUAWEI, E141B, U3GINIT_HUAWEI), 247 U3G_DEV(HUAWEI, E141C, U3GINIT_HUAWEI), 248 U3G_DEV(HUAWEI, E141D, U3GINIT_HUAWEI), 249 U3G_DEV(HUAWEI, E141E, U3GINIT_HUAWEI), 250 U3G_DEV(HUAWEI, E141F, U3GINIT_HUAWEI), 251 U3G_DEV(HUAWEI, E1420, U3GINIT_HUAWEI), 252 U3G_DEV(HUAWEI, E1421, U3GINIT_HUAWEI), 253 U3G_DEV(HUAWEI, E1422, U3GINIT_HUAWEI), 254 U3G_DEV(HUAWEI, E1423, U3GINIT_HUAWEI), 255 U3G_DEV(HUAWEI, E1424, U3GINIT_HUAWEI), 256 U3G_DEV(HUAWEI, E1425, U3GINIT_HUAWEI), 257 U3G_DEV(HUAWEI, E1426, U3GINIT_HUAWEI), 258 U3G_DEV(HUAWEI, E1427, U3GINIT_HUAWEI), 259 U3G_DEV(HUAWEI, E1428, U3GINIT_HUAWEI), 260 U3G_DEV(HUAWEI, E1429, U3GINIT_HUAWEI), 261 U3G_DEV(HUAWEI, E142A, U3GINIT_HUAWEI), 262 U3G_DEV(HUAWEI, E142B, U3GINIT_HUAWEI), 263 U3G_DEV(HUAWEI, E142C, U3GINIT_HUAWEI), 264 U3G_DEV(HUAWEI, E142D, U3GINIT_HUAWEI), 265 U3G_DEV(HUAWEI, E142E, U3GINIT_HUAWEI), 266 U3G_DEV(HUAWEI, E142F, U3GINIT_HUAWEI), 267 U3G_DEV(HUAWEI, E1430, U3GINIT_HUAWEI), 268 U3G_DEV(HUAWEI, E1431, U3GINIT_HUAWEI), 269 U3G_DEV(HUAWEI, E1432, U3GINIT_HUAWEI), 270 U3G_DEV(HUAWEI, E1433, U3GINIT_HUAWEI), 271 U3G_DEV(HUAWEI, E1434, U3GINIT_HUAWEI), 272 U3G_DEV(HUAWEI, E1435, U3GINIT_HUAWEI), 273 U3G_DEV(HUAWEI, E1436, U3GINIT_HUAWEI), 274 U3G_DEV(HUAWEI, E1437, U3GINIT_HUAWEI), 275 U3G_DEV(HUAWEI, E1438, U3GINIT_HUAWEI), 276 U3G_DEV(HUAWEI, E1439, U3GINIT_HUAWEI), 277 U3G_DEV(HUAWEI, E143A, U3GINIT_HUAWEI), 278 U3G_DEV(HUAWEI, E143B, U3GINIT_HUAWEI), 279 U3G_DEV(HUAWEI, E143C, U3GINIT_HUAWEI), 280 U3G_DEV(HUAWEI, E143D, U3GINIT_HUAWEI), 281 U3G_DEV(HUAWEI, E143E, U3GINIT_HUAWEI), 282 U3G_DEV(HUAWEI, E143F, U3GINIT_HUAWEI), 283 U3G_DEV(HUAWEI, E173, 0), 284 U3G_DEV(HUAWEI, E173_INIT, U3GINIT_HUAWEISCSI), 285 U3G_DEV(HUAWEI, E180V, U3GINIT_HUAWEI), 286 U3G_DEV(HUAWEI, E220, U3GINIT_HUAWEI), 287 U3G_DEV(HUAWEI, E220BIS, U3GINIT_HUAWEI), 288 U3G_DEV(HUAWEI, MOBILE, U3GINIT_HUAWEI), 289 U3G_DEV(HUAWEI, E1752, U3GINIT_HUAWEISCSI), 290 U3G_DEV(HUAWEI, E1820, U3GINIT_HUAWEISCSI), 291 U3G_DEV(HUAWEI, K3765, U3GINIT_HUAWEI), 292 U3G_DEV(HUAWEI, K3765_INIT, U3GINIT_HUAWEISCSI), 293 U3G_DEV(KYOCERA2, CDMA_MSM_K, 0), 294 U3G_DEV(KYOCERA2, KPC680, 0), 295 U3G_DEV(LONGCHEER, WM66, U3GINIT_HUAWEI), 296 U3G_DEV(LONGCHEER, DISK, U3GINIT_TCT), 297 U3G_DEV(LONGCHEER, W14, 0), 298 U3G_DEV(LONGCHEER, XSSTICK, 0), 299 U3G_DEV(MERLIN, V620, 0), 300 U3G_DEV(NEOTEL, PRIME, 0), 301 U3G_DEV(NOVATEL, E725, 0), 302 U3G_DEV(NOVATEL, ES620, 0), 303 U3G_DEV(NOVATEL, ES620_2, 0), 304 U3G_DEV(NOVATEL, EU730, 0), 305 U3G_DEV(NOVATEL, EU740, 0), 306 U3G_DEV(NOVATEL, EU870D, 0), 307 U3G_DEV(NOVATEL, MC760, 0), 308 U3G_DEV(NOVATEL, MC547, 0), 309 U3G_DEV(NOVATEL, MC950D, 0), 310 U3G_DEV(NOVATEL, U720, 0), 311 U3G_DEV(NOVATEL, U727, 0), 312 U3G_DEV(NOVATEL, U727_2, 0), 313 U3G_DEV(NOVATEL, U740, 0), 314 U3G_DEV(NOVATEL, U740_2, 0), 315 U3G_DEV(NOVATEL, U760, U3GINIT_SCSIEJECT), 316 U3G_DEV(NOVATEL, U870, 0), 317 U3G_DEV(NOVATEL, V620, 0), 318 U3G_DEV(NOVATEL, V640, 0), 319 U3G_DEV(NOVATEL, V720, 0), 320 U3G_DEV(NOVATEL, V740, 0), 321 U3G_DEV(NOVATEL, X950D, 0), 322 U3G_DEV(NOVATEL, XU870, 0), 323 U3G_DEV(OPTION, E6500, 0), 324 U3G_DEV(OPTION, E6501, 0), 325 U3G_DEV(OPTION, E6601, 0), 326 U3G_DEV(OPTION, E6721, 0), 327 U3G_DEV(OPTION, E6741, 0), 328 U3G_DEV(OPTION, E6761, 0), 329 U3G_DEV(OPTION, E6800, 0), 330 U3G_DEV(OPTION, E7021, 0), 331 U3G_DEV(OPTION, E7041, 0), 332 U3G_DEV(OPTION, E7061, 0), 333 U3G_DEV(OPTION, E7100, 0), 334 U3G_DEV(OPTION, GE40X, 0), 335 U3G_DEV(OPTION, GT3G, 0), 336 U3G_DEV(OPTION, GT3GPLUS, 0), 337 U3G_DEV(OPTION, GT3GQUAD, 0), 338 U3G_DEV(OPTION, GT3G_1, 0), 339 U3G_DEV(OPTION, GT3G_2, 0), 340 U3G_DEV(OPTION, GT3G_3, 0), 341 U3G_DEV(OPTION, GT3G_4, 0), 342 U3G_DEV(OPTION, GT3G_5, 0), 343 U3G_DEV(OPTION, GT3G_6, 0), 344 U3G_DEV(OPTION, GTHSDPA, 0), 345 U3G_DEV(OPTION, GTM380, 0), 346 U3G_DEV(OPTION, GTMAX36, 0), 347 U3G_DEV(OPTION, GTMAX380HSUPAE, 0), 348 U3G_DEV(OPTION, GTMAXHSUPA, 0), 349 U3G_DEV(OPTION, GTMAXHSUPAE, 0), 350 U3G_DEV(OPTION, VODAFONEMC3G, 0), 351 U3G_DEV(QISDA, H20_1, 0), 352 U3G_DEV(QISDA, H20_2, 0), 353 U3G_DEV(QISDA, H21_1, 0), 354 U3G_DEV(QISDA, H21_2, 0), 355 U3G_DEV(QUALCOMM2, AC8700, 0), 356 U3G_DEV(QUALCOMM2, MF330, 0), 357 U3G_DEV(QUALCOMMINC, AC2726, 0), 358 U3G_DEV(QUALCOMMINC, AC8700, 0), 359 U3G_DEV(QUALCOMMINC, AC8710, 0), 360 U3G_DEV(QUALCOMMINC, CDMA_MSM, U3GINIT_SCSIEJECT), 361 U3G_DEV(QUALCOMMINC, E0002, 0), 362 U3G_DEV(QUALCOMMINC, E0003, 0), 363 U3G_DEV(QUALCOMMINC, E0004, 0), 364 U3G_DEV(QUALCOMMINC, E0005, 0), 365 U3G_DEV(QUALCOMMINC, E0006, 0), 366 U3G_DEV(QUALCOMMINC, E0007, 0), 367 U3G_DEV(QUALCOMMINC, E0008, 0), 368 U3G_DEV(QUALCOMMINC, E0009, 0), 369 U3G_DEV(QUALCOMMINC, E000A, 0), 370 U3G_DEV(QUALCOMMINC, E000B, 0), 371 U3G_DEV(QUALCOMMINC, E000C, 0), 372 U3G_DEV(QUALCOMMINC, E000D, 0), 373 U3G_DEV(QUALCOMMINC, E000E, 0), 374 U3G_DEV(QUALCOMMINC, E000F, 0), 375 U3G_DEV(QUALCOMMINC, E0010, 0), 376 U3G_DEV(QUALCOMMINC, E0011, 0), 377 U3G_DEV(QUALCOMMINC, E0012, 0), 378 U3G_DEV(QUALCOMMINC, E0013, 0), 379 U3G_DEV(QUALCOMMINC, E0014, 0), 380 U3G_DEV(QUALCOMMINC, E0017, 0), 381 U3G_DEV(QUALCOMMINC, E0018, 0), 382 U3G_DEV(QUALCOMMINC, E0019, 0), 383 U3G_DEV(QUALCOMMINC, E0020, 0), 384 U3G_DEV(QUALCOMMINC, E0021, 0), 385 U3G_DEV(QUALCOMMINC, E0022, 0), 386 U3G_DEV(QUALCOMMINC, E0023, 0), 387 U3G_DEV(QUALCOMMINC, E0024, 0), 388 U3G_DEV(QUALCOMMINC, E0025, 0), 389 U3G_DEV(QUALCOMMINC, E0026, 0), 390 U3G_DEV(QUALCOMMINC, E0027, 0), 391 U3G_DEV(QUALCOMMINC, E0028, 0), 392 U3G_DEV(QUALCOMMINC, E0029, 0), 393 U3G_DEV(QUALCOMMINC, E0030, 0), 394 U3G_DEV(QUALCOMMINC, E0032, 0), 395 U3G_DEV(QUALCOMMINC, E0033, 0), 396 U3G_DEV(QUALCOMMINC, E0037, 0), 397 U3G_DEV(QUALCOMMINC, E0039, 0), 398 U3G_DEV(QUALCOMMINC, E0042, 0), 399 U3G_DEV(QUALCOMMINC, E0043, 0), 400 U3G_DEV(QUALCOMMINC, E0048, 0), 401 U3G_DEV(QUALCOMMINC, E0049, 0), 402 U3G_DEV(QUALCOMMINC, E0051, 0), 403 U3G_DEV(QUALCOMMINC, E0052, 0), 404 U3G_DEV(QUALCOMMINC, E0054, 0), 405 U3G_DEV(QUALCOMMINC, E0055, 0), 406 U3G_DEV(QUALCOMMINC, E0057, 0), 407 U3G_DEV(QUALCOMMINC, E0058, 0), 408 U3G_DEV(QUALCOMMINC, E0059, 0), 409 U3G_DEV(QUALCOMMINC, E0060, 0), 410 U3G_DEV(QUALCOMMINC, E0061, 0), 411 U3G_DEV(QUALCOMMINC, E0062, 0), 412 U3G_DEV(QUALCOMMINC, E0063, 0), 413 U3G_DEV(QUALCOMMINC, E0064, 0), 414 U3G_DEV(QUALCOMMINC, E0066, 0), 415 U3G_DEV(QUALCOMMINC, E0069, 0), 416 U3G_DEV(QUALCOMMINC, E0070, 0), 417 U3G_DEV(QUALCOMMINC, E0073, 0), 418 U3G_DEV(QUALCOMMINC, E0076, 0), 419 U3G_DEV(QUALCOMMINC, E0078, 0), 420 U3G_DEV(QUALCOMMINC, E0082, 0), 421 U3G_DEV(QUALCOMMINC, E0086, 0), 422 U3G_DEV(QUALCOMMINC, SURFSTICK, 0), 423 U3G_DEV(QUALCOMMINC, E2002, 0), 424 U3G_DEV(QUALCOMMINC, E2003, 0), 425 U3G_DEV(QUALCOMMINC, MF626, 0), 426 U3G_DEV(QUALCOMMINC, MF628, 0), 427 U3G_DEV(QUALCOMMINC, MF633R, 0), 428 U3G_DEV(QUANTA, GKE, 0), 429 U3G_DEV(QUANTA, GLE, 0), 430 U3G_DEV(QUANTA, GLX, 0), 431 U3G_DEV(QUANTA, Q101, 0), 432 U3G_DEV(QUANTA, Q111, 0), 433 U3G_DEV(SIERRA, AC402, 0), 434 U3G_DEV(SIERRA, AC595U, 0), 435 U3G_DEV(SIERRA, AC597E, 0), 436 U3G_DEV(SIERRA, AC875E, 0), 437 U3G_DEV(SIERRA, AC875U, 0), 438 U3G_DEV(SIERRA, AC875U_2, 0), 439 U3G_DEV(SIERRA, AC880, 0), 440 U3G_DEV(SIERRA, AC880E, 0), 441 U3G_DEV(SIERRA, AC880U, 0), 442 U3G_DEV(SIERRA, AC881, 0), 443 U3G_DEV(SIERRA, AC881E, 0), 444 U3G_DEV(SIERRA, AC881U, 0), 445 U3G_DEV(SIERRA, AC885E, 0), 446 U3G_DEV(SIERRA, AC885E_2, 0), 447 U3G_DEV(SIERRA, AC885U, 0), 448 U3G_DEV(SIERRA, AIRCARD580, 0), 449 U3G_DEV(SIERRA, AIRCARD595, 0), 450 U3G_DEV(SIERRA, AIRCARD875, 0), 451 U3G_DEV(SIERRA, C22, 0), 452 U3G_DEV(SIERRA, C597, 0), 453 U3G_DEV(SIERRA, C888, 0), 454 U3G_DEV(SIERRA, E0029, 0), 455 U3G_DEV(SIERRA, E6892, 0), 456 U3G_DEV(SIERRA, E6893, 0), 457 U3G_DEV(SIERRA, EM5625, 0), 458 U3G_DEV(SIERRA, EM5725, 0), 459 U3G_DEV(SIERRA, MC5720, 0), 460 U3G_DEV(SIERRA, MC5720_2, 0), 461 U3G_DEV(SIERRA, MC5725, 0), 462 U3G_DEV(SIERRA, MC5727, 0), 463 U3G_DEV(SIERRA, MC5727_2, 0), 464 U3G_DEV(SIERRA, MC5728, 0), 465 U3G_DEV(SIERRA, MC8700, 0), 466 U3G_DEV(SIERRA, MC8755, 0), 467 U3G_DEV(SIERRA, MC8755_2, 0), 468 U3G_DEV(SIERRA, MC8755_3, 0), 469 U3G_DEV(SIERRA, MC8755_4, 0), 470 U3G_DEV(SIERRA, MC8765, 0), 471 U3G_DEV(SIERRA, MC8765_2, 0), 472 U3G_DEV(SIERRA, MC8765_3, 0), 473 U3G_DEV(SIERRA, MC8775, 0), 474 U3G_DEV(SIERRA, MC8775_2, 0), 475 U3G_DEV(SIERRA, MC8780, 0), 476 U3G_DEV(SIERRA, MC8780_2, 0), 477 U3G_DEV(SIERRA, MC8780_3, 0), 478 U3G_DEV(SIERRA, MC8781, 0), 479 U3G_DEV(SIERRA, MC8781_2, 0), 480 U3G_DEV(SIERRA, MC8781_3, 0), 481 U3G_DEV(SIERRA, MC8785, 0), 482 U3G_DEV(SIERRA, MC8785_2, 0), 483 U3G_DEV(SIERRA, MC8790, 0), 484 U3G_DEV(SIERRA, MC8791, 0), 485 U3G_DEV(SIERRA, MC8792, 0), 486 U3G_DEV(SIERRA, MINI5725, 0), 487 U3G_DEV(SIERRA, T11, 0), 488 U3G_DEV(SIERRA, T598, 0), 489 U3G_DEV(SILABS, SAEL, U3GINIT_SAEL_M460), 490 U3G_DEV(STELERA, C105, 0), 491 U3G_DEV(STELERA, E1003, 0), 492 U3G_DEV(STELERA, E1004, 0), 493 U3G_DEV(STELERA, E1005, 0), 494 U3G_DEV(STELERA, E1006, 0), 495 U3G_DEV(STELERA, E1007, 0), 496 U3G_DEV(STELERA, E1008, 0), 497 U3G_DEV(STELERA, E1009, 0), 498 U3G_DEV(STELERA, E100A, 0), 499 U3G_DEV(STELERA, E100B, 0), 500 U3G_DEV(STELERA, E100C, 0), 501 U3G_DEV(STELERA, E100D, 0), 502 U3G_DEV(STELERA, E100E, 0), 503 U3G_DEV(STELERA, E100F, 0), 504 U3G_DEV(STELERA, E1010, 0), 505 U3G_DEV(STELERA, E1011, 0), 506 U3G_DEV(STELERA, E1012, 0), 507 U3G_DEV(TCTMOBILE, X060S, 0), 508 U3G_DEV(TCTMOBILE, X080S, U3GINIT_TCT), 509 U3G_DEV(TELIT, UC864E, 0), 510 U3G_DEV(TELIT, UC864G, 0), 511 U3G_DEV(TLAYTECH, TEU800, 0), 512 U3G_DEV(TOSHIBA, G450, 0), 513 U3G_DEV(TOSHIBA, HSDPA, 0), 514 U3G_DEV(YISO, C893, 0), 515 /* Autoinstallers */ 516 U3G_DEV(NOVATEL, ZEROCD, U3GINIT_SCSIEJECT), 517 U3G_DEV(OPTION, GTICON322, U3GINIT_REZERO), 518 U3G_DEV(QUALCOMMINC, ZTE_STOR, U3GINIT_ZTESTOR), 519 U3G_DEV(QUALCOMMINC, ZTE_STOR2, U3GINIT_SCSIEJECT), 520 U3G_DEV(QUANTA, Q101_STOR, U3GINIT_SCSIEJECT), 521 U3G_DEV(SIERRA, TRUINSTALL, U3GINIT_SIERRA), 522#undef U3G_DEV 523}; 524 525static int 526u3g_sierra_init(struct usb_device *udev) 527{ 528 struct usb_device_request req; 529 530 req.bmRequestType = UT_VENDOR; 531 req.bRequest = UR_SET_INTERFACE; 532 USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP); 533 USETW(req.wIndex, UHF_PORT_CONNECTION); 534 USETW(req.wLength, 0); 535 536 if (usbd_do_request_flags(udev, NULL, &req, 537 NULL, 0, NULL, USB_MS_HZ)) { 538 /* ignore any errors */ 539 } 540 return (0); 541} 542 543static int 544u3g_huawei_init(struct usb_device *udev) 545{ 546 struct usb_device_request req; 547 548 req.bmRequestType = UT_WRITE_DEVICE; 549 req.bRequest = UR_SET_FEATURE; 550 USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP); 551 USETW(req.wIndex, UHF_PORT_SUSPEND); 552 USETW(req.wLength, 0); 553 554 if (usbd_do_request_flags(udev, NULL, &req, 555 NULL, 0, NULL, USB_MS_HZ)) { 556 /* ignore any errors */ 557 } 558 return (0); 559} 560 561static void 562u3g_sael_m460_init(struct usb_device *udev) 563{ 564 static const uint8_t setup[][24] = { 565 { 0x41, 0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, 566 { 0x41, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00 }, 567 { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 568 0x01, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 569 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, 570 { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x40, 0x02 }, 571 { 0xc1, 0x08, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00 }, 572 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 }, 573 { 0xc1, 0x0f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }, 574 { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 }, 575 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 }, 576 { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 }, 577 { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00, 578 0x00, 0x00, 0x00, 0x00, 0x11, 0x13 }, 579 { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 580 0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 581 0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 }, 582 { 0x41, 0x12, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00 }, 583 { 0x41, 0x01, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00 }, 584 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 }, 585 { 0x41, 0x03, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00 }, 586 { 0x41, 0x19, 0x00, 0x00, 0x00, 0x00, 0x06, 0x00, 587 0x00, 0x00, 0x00, 0x00, 0x11, 0x13 }, 588 { 0x41, 0x13, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 589 0x09, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 590 0x0a, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00 }, 591 { 0x41, 0x07, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00 }, 592 }; 593 594 struct usb_device_request req; 595 usb_error_t err; 596 uint16_t len; 597 uint8_t buf[0x300]; 598 uint8_t n; 599 600 DPRINTFN(1, "\n"); 601 602 if (usbd_req_set_alt_interface_no(udev, NULL, 0, 0)) { 603 DPRINTFN(0, "Alt setting 0 failed\n"); 604 return; 605 } 606 607 for (n = 0; n != (sizeof(setup)/sizeof(setup[0])); n++) { 608 609 memcpy(&req, setup[n], sizeof(req)); 610 611 len = UGETW(req.wLength); 612 if (req.bmRequestType & UE_DIR_IN) { 613 if (len > sizeof(buf)) { 614 DPRINTFN(0, "too small buffer\n"); 615 continue; 616 } 617 err = usbd_do_request(udev, NULL, &req, buf); 618 } else { 619 if (len > (sizeof(setup[0]) - 8)) { 620 DPRINTFN(0, "too small buffer\n"); 621 continue; 622 } 623 err = usbd_do_request(udev, NULL, &req, 624 __DECONST(uint8_t *, &setup[n][8])); 625 } 626 if (err) { 627 DPRINTFN(1, "request %u failed\n", 628 (unsigned int)n); 629 /* 630 * Some of the requests will fail. Stop doing 631 * requests when we are getting timeouts so 632 * that we don't block the explore/attach 633 * thread forever. 634 */ 635 if (err == USB_ERR_TIMEOUT) 636 break; 637 } 638 } 639} 640 641/* 642 * The following function handles 3G modem devices (E220, Mobile, 643 * etc.) with auto-install flash disks for Windows/MacOSX on the first 644 * interface. After some command or some delay they change appearance 645 * to a modem. 646 */ 647static void 648u3g_test_autoinst(void *arg, struct usb_device *udev, 649 struct usb_attach_arg *uaa) 650{ 651 struct usb_interface *iface; 652 struct usb_interface_descriptor *id; 653 int error; 654 unsigned long method; 655 656 if (uaa->dev_state != UAA_DEV_READY) 657 return; 658 659 iface = usbd_get_iface(udev, 0); 660 if (iface == NULL) 661 return; 662 id = iface->idesc; 663 if (id == NULL || id->bInterfaceClass != UICLASS_MASS) 664 return; 665 666 if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEI)) 667 method = U3GINIT_HUAWEI; 668 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_SIERRA)) 669 method = U3GINIT_SIERRA; 670 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_SCSIEJECT)) 671 method = U3GINIT_SCSIEJECT; 672 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_REZERO)) 673 method = U3GINIT_REZERO; 674 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_ZTESTOR)) 675 method = U3GINIT_ZTESTOR; 676 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_CMOTECH)) 677 method = U3GINIT_CMOTECH; 678 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_WAIT)) 679 method = U3GINIT_WAIT; 680 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_HUAWEISCSI)) 681 method = U3GINIT_HUAWEISCSI; 682 else if (usb_test_quirk(uaa, UQ_MSC_EJECT_TCT)) 683 method = U3GINIT_TCT; 684 else if (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa) == 0) 685 method = USB_GET_DRIVER_INFO(uaa); 686 else 687 return; /* no device match */ 688 689 if (bootverbose) { 690 printf("Ejecting %s %s using method %ld\n", 691 usb_get_manufacturer(udev), 692 usb_get_product(udev), method); 693 } 694 695 switch (method) { 696 case U3GINIT_HUAWEI: 697 error = u3g_huawei_init(udev); 698 break; 699 case U3GINIT_HUAWEISCSI: 700 error = usb_msc_eject(udev, 0, MSC_EJECT_HUAWEI); 701 break; 702 case U3GINIT_SCSIEJECT: 703 error = usb_msc_eject(udev, 0, MSC_EJECT_STOPUNIT); 704 break; 705 case U3GINIT_REZERO: 706 error = usb_msc_eject(udev, 0, MSC_EJECT_REZERO); 707 break; 708 case U3GINIT_ZTESTOR: 709 error = usb_msc_eject(udev, 0, MSC_EJECT_STOPUNIT); 710 error |= usb_msc_eject(udev, 0, MSC_EJECT_ZTESTOR); 711 break; 712 case U3GINIT_CMOTECH: 713 error = usb_msc_eject(udev, 0, MSC_EJECT_CMOTECH); 714 break; 715 case U3GINIT_TCT: 716 error = usb_msc_eject(udev, 0, MSC_EJECT_TCT); 717 break; 718 case U3GINIT_SIERRA: 719 error = u3g_sierra_init(udev); 720 break; 721 case U3GINIT_WAIT: 722 /* Just pretend we ejected, the card will timeout */ 723 error = 0; 724 break; 725 default: 726 /* no 3G eject quirks */ 727 error = EOPNOTSUPP; 728 break; 729 } 730 if (error == 0) { 731 /* success, mark the udev as disappearing */ 732 uaa->dev_state = UAA_DEV_EJECTING; 733 } 734} 735 736static int 737u3g_driver_loaded(struct module *mod, int what, void *arg) 738{ 739 switch (what) { 740 case MOD_LOAD: 741 /* register our autoinstall handler */ 742 u3g_etag = EVENTHANDLER_REGISTER(usb_dev_configured, 743 u3g_test_autoinst, NULL, EVENTHANDLER_PRI_ANY); 744 break; 745 case MOD_UNLOAD: 746 EVENTHANDLER_DEREGISTER(usb_dev_configured, u3g_etag); 747 break; 748 default: 749 return (EOPNOTSUPP); 750 } 751 return (0); 752} 753 754static int 755u3g_probe(device_t self) 756{ 757 struct usb_attach_arg *uaa = device_get_ivars(self); 758 759 if (uaa->usb_mode != USB_MODE_HOST) { 760 return (ENXIO); 761 } 762 if (uaa->info.bConfigIndex != U3G_CONFIG_INDEX) { 763 return (ENXIO); 764 } 765 if (uaa->info.bInterfaceClass != UICLASS_VENDOR) { 766 return (ENXIO); 767 } 768 return (usbd_lookup_id_by_uaa(u3g_devs, sizeof(u3g_devs), uaa)); 769} 770 771static int 772u3g_attach(device_t dev) 773{ 774 struct usb_config u3g_config_tmp[U3G_N_TRANSFER]; 775 struct usb_attach_arg *uaa = device_get_ivars(dev); 776 struct u3g_softc *sc = device_get_softc(dev); 777 struct usb_interface *iface; 778 struct usb_interface_descriptor *id; 779 uint32_t iface_valid; 780 int error, type, nports; 781 int ep, n; 782 uint8_t i; 783 784 DPRINTF("sc=%p\n", sc); 785 786 type = USB_GET_DRIVER_INFO(uaa); 787 if (type == U3GINIT_SAEL_M460 788 || usb_test_quirk(uaa, UQ_MSC_EJECT_SAEL_M460)) { 789 u3g_sael_m460_init(uaa->device); 790 } 791 792 /* copy in USB config */ 793 for (n = 0; n != U3G_N_TRANSFER; n++) 794 u3g_config_tmp[n] = u3g_config[n]; 795 796 device_set_usb_desc(dev); 797 mtx_init(&sc->sc_mtx, "u3g", NULL, MTX_DEF); 798 799 sc->sc_udev = uaa->device; 800 801 /* Claim all interfaces on the device */ 802 iface_valid = 0; 803 for (i = uaa->info.bIfaceIndex; i < USB_IFACE_MAX; i++) { 804 iface = usbd_get_iface(uaa->device, i); 805 if (iface == NULL) 806 break; 807 id = usbd_get_interface_descriptor(iface); 808 if (id == NULL || id->bInterfaceClass != UICLASS_VENDOR) 809 continue; 810 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex); 811 iface_valid |= (1<<i); 812 } 813 814 i = 0; /* interface index */ 815 ep = 0; /* endpoint index */ 816 nports = 0; /* number of ports */ 817 while (i < USB_IFACE_MAX) { 818 if ((iface_valid & (1<<i)) == 0) { 819 i++; 820 continue; 821 } 822 823 /* update BULK endpoint index */ 824 for (n = 0; n < U3G_N_TRANSFER; n++) 825 u3g_config_tmp[n].ep_index = ep; 826 827 /* try to allocate a set of BULK endpoints */ 828 error = usbd_transfer_setup(uaa->device, &i, 829 sc->sc_xfer[nports], u3g_config_tmp, U3G_N_TRANSFER, 830 &sc->sc_ucom[nports], &sc->sc_mtx); 831 if (error) { 832 /* next interface */ 833 i++; 834 ep = 0; 835 continue; 836 } 837 838 /* set stall by default */ 839 mtx_lock(&sc->sc_mtx); 840 usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_WR]); 841 usbd_xfer_set_stall(sc->sc_xfer[nports][U3G_BULK_RD]); 842 mtx_unlock(&sc->sc_mtx); 843 844 nports++; /* found one port */ 845 ep++; 846 if (nports == U3G_MAXPORTS) 847 break; 848 } 849 if (nports == 0) { 850 device_printf(dev, "no ports found\n"); 851 goto detach; 852 } 853 sc->sc_numports = nports; 854 855 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom, 856 sc->sc_numports, sc, &u3g_callback, &sc->sc_mtx); 857 if (error) { 858 DPRINTF("ucom_attach failed\n"); 859 goto detach; 860 } 861 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 862 device_printf(dev, "Found %u port%s.\n", sc->sc_numports, 863 sc->sc_numports > 1 ? "s":""); 864 865 return (0); 866 867detach: 868 u3g_detach(dev); 869 return (ENXIO); 870} 871 872static int 873u3g_detach(device_t dev) 874{ 875 struct u3g_softc *sc = device_get_softc(dev); 876 uint8_t subunit; 877 878 DPRINTF("sc=%p\n", sc); 879 880 /* NOTE: It is not dangerous to detach more ports than attached! */ 881 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom); 882 883 for (subunit = 0; subunit != U3G_MAXPORTS; subunit++) 884 usbd_transfer_unsetup(sc->sc_xfer[subunit], U3G_N_TRANSFER); 885 mtx_destroy(&sc->sc_mtx); 886 887 return (0); 888} 889 890static void 891u3g_start_read(struct ucom_softc *ucom) 892{ 893 struct u3g_softc *sc = ucom->sc_parent; 894 895 /* start read endpoint */ 896 usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_RD]); 897 return; 898} 899 900static void 901u3g_stop_read(struct ucom_softc *ucom) 902{ 903 struct u3g_softc *sc = ucom->sc_parent; 904 905 /* stop read endpoint */ 906 usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_RD]); 907 return; 908} 909 910static void 911u3g_start_write(struct ucom_softc *ucom) 912{ 913 struct u3g_softc *sc = ucom->sc_parent; 914 915 usbd_transfer_start(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_WR]); 916 return; 917} 918 919static void 920u3g_stop_write(struct ucom_softc *ucom) 921{ 922 struct u3g_softc *sc = ucom->sc_parent; 923 924 usbd_transfer_stop(sc->sc_xfer[ucom->sc_subunit][U3G_BULK_WR]); 925 return; 926} 927 928static void 929u3g_write_callback(struct usb_xfer *xfer, usb_error_t error) 930{ 931 struct ucom_softc *ucom = usbd_xfer_softc(xfer); 932 struct usb_page_cache *pc; 933 uint32_t actlen; 934 935 switch (USB_GET_STATE(xfer)) { 936 case USB_ST_TRANSFERRED: 937 case USB_ST_SETUP: 938tr_setup: 939 pc = usbd_xfer_get_frame(xfer, 0); 940 if (ucom_get_data(ucom, pc, 0, U3G_BSIZE, &actlen)) { 941 usbd_xfer_set_frame_len(xfer, 0, actlen); 942 usbd_transfer_submit(xfer); 943 } 944 break; 945 946 default: /* Error */ 947 if (error != USB_ERR_CANCELLED) { 948 /* do a builtin clear-stall */ 949 usbd_xfer_set_stall(xfer); 950 goto tr_setup; 951 } 952 break; 953 } 954 return; 955} 956 957static void 958u3g_read_callback(struct usb_xfer *xfer, usb_error_t error) 959{ 960 struct ucom_softc *ucom = usbd_xfer_softc(xfer); 961 struct usb_page_cache *pc; 962 int actlen; 963 964 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 965 966 switch (USB_GET_STATE(xfer)) { 967 case USB_ST_TRANSFERRED: 968 pc = usbd_xfer_get_frame(xfer, 0); 969 ucom_put_data(ucom, pc, 0, actlen); 970 971 case USB_ST_SETUP: 972tr_setup: 973 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 974 usbd_transfer_submit(xfer); 975 break; 976 977 default: /* Error */ 978 if (error != USB_ERR_CANCELLED) { 979 /* do a builtin clear-stall */ 980 usbd_xfer_set_stall(xfer); 981 goto tr_setup; 982 } 983 break; 984 } 985 return; 986} 987