Home | History | Annotate | Line # | Download | only in usb
uhmodem.c revision 1.16
      1 /*	$NetBSD: uhmodem.c,v 1.16 2019/05/04 08:04:13 mrg Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2008 Yojiro UO <yuo (at) nui.org>.
      5  * All rights reserved.
      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 MIND, USE, DATA OR PROFITS, WHETHER IN
     16  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
     17  * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 /*-
     20  * Copyright (c) 2002, Alexander Kabaev <kan.FreeBSD.org>.
     21  * All rights reserved.
     22  *
     23  * Redistribution and use in source and binary forms, with or without
     24  * modification, are permitted provided that the following conditions
     25  * are met:
     26  * 1. Redistributions of source code must retain the above copyright
     27  *    notice, this list of conditions and the following disclaimer.
     28  * 2. Redistributions in binary form must reproduce the above copyright
     29  *    notice, this list of conditions and the following disclaimer in the
     30  *    documentation and/or other materials provided with the distribution.
     31  *
     32  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     42  * SUCH DAMAGE.
     43  */
     44 /*
     45  * Copyright (c) 2001 The NetBSD Foundation, Inc.
     46  * All rights reserved.
     47  *
     48  * This code is derived from software contributed to The NetBSD Foundation
     49  * by Ichiro FUKUHARA (ichiro (at) ichiro.org).
     50  *
     51  * Redistribution and use in source and binary forms, with or without
     52  * modification, are permitted provided that the following conditions
     53  * are met:
     54  * 1. Redistributions of source code must retain the above copyright
     55  *    notice, this list of conditions and the following disclaimer.
     56  * 2. Redistributions in binary form must reproduce the above copyright
     57  *    notice, this list of conditions and the following disclaimer in the
     58  *    documentation and/or other materials provided with the distribution.
     59  *
     60  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     61  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     62  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     63  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     64  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     65  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     66  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     67  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     68  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     69  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     70  * POSSIBILITY OF SUCH DAMAGE.
     71  */
     72 
     73 #include <sys/cdefs.h>
     74 __KERNEL_RCSID(0, "$NetBSD: uhmodem.c,v 1.16 2019/05/04 08:04:13 mrg Exp $");
     75 
     76 #ifdef _KERNEL_OPT
     77 #include "opt_usb.h"
     78 #endif
     79 
     80 #include <sys/param.h>
     81 #include <sys/systm.h>
     82 #include <sys/kernel.h>
     83 #include <sys/kmem.h>
     84 #include <sys/ioccom.h>
     85 #include <sys/fcntl.h>
     86 #include <sys/conf.h>
     87 #include <sys/tty.h>
     88 #include <sys/file.h>
     89 #include <sys/select.h>
     90 #include <sys/proc.h>
     91 #include <sys/device.h>
     92 #include <sys/poll.h>
     93 #include <sys/sysctl.h>
     94 #include <sys/bus.h>
     95 
     96 #include <dev/usb/usb.h>
     97 #include <dev/usb/usbdi.h>
     98 #include <dev/usb/usbdi_util.h>
     99 #include <dev/usb/usbdivar.h>
    100 
    101 #include <dev/usb/usbcdc.h>
    102 #include <dev/usb/usbdevs.h>
    103 #include <dev/usb/usb_quirks.h>
    104 #include <dev/usb/ucomvar.h>
    105 #include <dev/usb/ubsavar.h>
    106 
    107 /* vendor specific bRequest */
    108 #define	UHMODEM_REGWRITE	0x20
    109 #define	UHMODEM_REGREAD		0x21
    110 #define UHMODEM_SETUP		0x22
    111 
    112 #define UHMODEMIBUFSIZE	4096
    113 #define UHMODEMOBUFSIZE	4096
    114 
    115 #ifdef UHMODEM_DEBUG
    116 Static int	uhmodemdebug = 0;
    117 #define DPRINTFN(n, x)  do { \
    118 				if (uhmodemdebug > (n)) \
    119 					printf x; \
    120 			} while (0)
    121 #else
    122 #define DPRINTFN(n, x)
    123 #endif
    124 #define DPRINTF(x) DPRINTFN(0, x)
    125 
    126 Static int uhmodem_open(void *, int);
    127 Static  usbd_status e220_modechange_request(struct usbd_device *);
    128 Static	usbd_status uhmodem_endpointhalt(struct ubsa_softc *, int);
    129 Static	usbd_status uhmodem_regwrite(struct usbd_device *, uint8_t *, size_t);
    130 Static	usbd_status uhmodem_regread(struct usbd_device *, uint8_t *, size_t);
    131 Static  usbd_status a2502_init(struct usbd_device *);
    132 #if 0
    133 Static	usbd_status uhmodem_regsetup(struct usbd_device *, uint16_t);
    134 Static  usbd_status e220_init(struct usbd_device *);
    135 #endif
    136 
    137 struct	uhmodem_softc {
    138 	struct ubsa_softc	sc_ubsa;
    139 };
    140 
    141 struct	ucom_methods uhmodem_methods = {
    142 	.ucom_get_status = ubsa_get_status,
    143 	.ucom_set = ubsa_set,
    144 	.ucom_param = ubsa_param,
    145 	.ucom_open = uhmodem_open,
    146 	.ucom_close = ubsa_close,
    147 };
    148 
    149 struct uhmodem_type {
    150 	struct usb_devno	uhmodem_dev;
    151 	uint16_t		uhmodem_coms;	/* number of serial interfaces on the device */
    152 	uint16_t		uhmodem_flags;
    153 #define	E220	0x0001
    154 #define	A2502	0x0002
    155 #define	E620	0x0004		/* XXX */
    156 				/* Whether or not it is a device different from E220 is not clear. */
    157 };
    158 
    159 Static const struct uhmodem_type uhmodem_devs[] = {
    160 	/* HUAWEI E220 / Emobile D0[12]HW */
    161 	{{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E220 }, 2,	E220},
    162 	/* ANYDATA / NTT DoCoMo A2502 */
    163 	{{ USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_A2502 }, 3,	A2502},
    164 	/* HUAWEI E620 */
    165 	{{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_MOBILE }, 3,   E620},
    166 };
    167 #define uhmodem_lookup(v, p) ((const struct uhmodem_type *)usb_lookup(uhmodem_devs, v, p))
    168 
    169 int uhmodem_match(device_t, cfdata_t, void *);
    170 void uhmodem_attach(device_t, device_t, void *);
    171 void uhmodem_childdet(device_t, device_t);
    172 int uhmodem_detach(device_t, int);
    173 int uhmodem_activate(device_t, enum devact);
    174 extern struct cfdriver uhmodem_cd;
    175 CFATTACH_DECL2_NEW(uhmodem, sizeof(struct uhmodem_softc), uhmodem_match,
    176     uhmodem_attach, uhmodem_detach, uhmodem_activate, NULL, uhmodem_childdet);
    177 
    178 int
    179 uhmodem_match(device_t parent, cfdata_t match, void *aux)
    180 {
    181 	struct usbif_attach_arg *uiaa = aux;
    182 
    183 	if (uhmodem_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product) != NULL)
    184 		/* XXX interface# 0,1 provide modem function, but this driver
    185 		   handles all modem in single device.  */
    186 		if (uiaa->uiaa_ifaceno == 0)
    187 			return UMATCH_VENDOR_PRODUCT;
    188 	return UMATCH_NONE;
    189 }
    190 
    191 void
    192 uhmodem_attach(device_t parent, device_t self, void *aux)
    193 {
    194 	struct uhmodem_softc *sc = device_private(self);
    195 	struct usbif_attach_arg *uiaa = aux;
    196 	struct usbd_device *dev = uiaa->uiaa_device;
    197 	usb_config_descriptor_t *cdesc;
    198 	usb_interface_descriptor_t *id;
    199 	usb_endpoint_descriptor_t *ed;
    200 	char *devinfop;
    201 	usbd_status err;
    202 	struct ucom_attach_args ucaa;
    203 	int i;
    204 	int j;
    205 	char comname[16];
    206 
    207 	aprint_naive("\n");
    208 	aprint_normal("\n");
    209 
    210 	devinfop = usbd_devinfo_alloc(dev, 0);
    211 	aprint_normal_dev(self, "%s\n", devinfop);
    212 	usbd_devinfo_free(devinfop);
    213 
    214 	sc->sc_ubsa.sc_dev = self;
    215 	sc->sc_ubsa.sc_udev = dev;
    216 	sc->sc_ubsa.sc_config_index = UBSA_DEFAULT_CONFIG_INDEX;
    217 	sc->sc_ubsa.sc_numif = 1; /* defaut device has one interface */
    218 
    219 	/* Hauwei E220 need special request to change its mode to modem */
    220 	if ((uiaa->uiaa_ifaceno == 0) && (uiaa->uiaa_class != 255)) {
    221 		err = e220_modechange_request(dev);
    222 		if (err) {
    223 			aprint_error_dev(self, "failed to change mode: %s\n",
    224 				usbd_errstr(err));
    225 			sc->sc_ubsa.sc_dying = 1;
    226 			goto error;
    227 		}
    228 		aprint_error_dev(self,
    229 		    "mass storage only mode, reattach to enable modem\n");
    230 		sc->sc_ubsa.sc_dying = 1;
    231 		goto error;
    232 	}
    233 
    234 	/*
    235 	 * initialize rts, dtr variables to something
    236 	 * different from boolean 0, 1
    237 	 */
    238 	sc->sc_ubsa.sc_dtr = -1;
    239 	sc->sc_ubsa.sc_rts = -1;
    240 
    241 	sc->sc_ubsa.sc_quadumts = 1;
    242 	sc->sc_ubsa.sc_config_index = 0;
    243 	sc->sc_ubsa.sc_numif = uhmodem_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product)->uhmodem_coms;
    244 	sc->sc_ubsa.sc_devflags = uhmodem_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product)->uhmodem_flags;
    245 
    246 	DPRINTF(("uhmodem attach: sc = %p\n", sc));
    247 
    248 	/* Move the device into the configured state. */
    249 	err = usbd_set_config_index(dev, sc->sc_ubsa.sc_config_index, 1);
    250 	if (err) {
    251 		aprint_error_dev(self, "failed to set configuration: %s\n",
    252 		    usbd_errstr(err));
    253 		sc->sc_ubsa.sc_dying = 1;
    254 		goto error;
    255 	}
    256 
    257 	/* get the config descriptor */
    258 	cdesc = usbd_get_config_descriptor(sc->sc_ubsa.sc_udev);
    259 	if (cdesc == NULL) {
    260 		aprint_error_dev(self,
    261 		    "failed to get configuration descriptor\n");
    262 		sc->sc_ubsa.sc_dying = 1;
    263 		goto error;
    264 	}
    265 
    266 	sc->sc_ubsa.sc_intr_number = -1;
    267 	sc->sc_ubsa.sc_intr_pipe = NULL;
    268 
    269 	/* get the interfaces */
    270 	for (i = 0; i < sc->sc_ubsa.sc_numif; i++) {
    271 		err = usbd_device2interface_handle(dev, UBSA_IFACE_INDEX_OFFSET+i,
    272 				 &sc->sc_ubsa.sc_iface[i]);
    273 		if (err) {
    274 			if (i == 0){
    275 				/* can not get main interface */
    276 				sc->sc_ubsa.sc_dying = 1;
    277 				goto error;
    278 			} else
    279 				break;
    280 		}
    281 
    282 		/* Find the endpoints */
    283 		id = usbd_get_interface_descriptor(sc->sc_ubsa.sc_iface[i]);
    284 		sc->sc_ubsa.sc_iface_number[i] = id->bInterfaceNumber;
    285 
    286 		/* initialize endpoints */
    287 		ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1;
    288 
    289 		for (j = 0; j < id->bNumEndpoints; j++) {
    290 			ed = usbd_interface2endpoint_descriptor(
    291 				sc->sc_ubsa.sc_iface[i], j);
    292 			if (ed == NULL) {
    293 				aprint_error_dev(self,
    294 				    "no endpoint descriptor for %d "
    295 				    "(interface: %d)\n", j, i);
    296 				break;
    297 			}
    298 
    299 			if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    300 			    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
    301 				sc->sc_ubsa.sc_intr_number = ed->bEndpointAddress;
    302 				sc->sc_ubsa.sc_isize = UGETW(ed->wMaxPacketSize);
    303 			} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    304 			    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    305 				ucaa.ucaa_bulkin = ed->bEndpointAddress;
    306 			} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    307 			    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    308 				ucaa.ucaa_bulkout = ed->bEndpointAddress;
    309 			}
    310 		} /* end of Endpoint loop */
    311 
    312 		if (sc->sc_ubsa.sc_intr_number == -1) {
    313 			aprint_error_dev(self, "HUAWEI E220 need to re-attach "
    314 			    "to enable modem function\n");
    315 			if (i == 0) {
    316 				/* could not get intr for main tty */
    317 				sc->sc_ubsa.sc_dying = 1;
    318 				goto error;
    319 			} else
    320 				break;
    321 		}
    322 		if (ucaa.ucaa_bulkin == -1) {
    323 			aprint_error_dev(self,
    324 			    "Could not find data bulk in\n");
    325 			sc->sc_ubsa.sc_dying = 1;
    326 			goto error;
    327 		}
    328 
    329 		if (ucaa.ucaa_bulkout == -1) {
    330 			aprint_error_dev(self,
    331 			    "Could not find data bulk out\n");
    332 			sc->sc_ubsa.sc_dying = 1;
    333 			goto error;
    334 		}
    335 
    336 		switch (i) {
    337 		case 0:
    338 			snprintf(comname, sizeof(comname), "modem");
    339 			break;
    340 		case 1:
    341 			snprintf(comname, sizeof(comname), "alt#1");
    342 			break;
    343 		case 2:
    344 			snprintf(comname, sizeof(comname), "alt#2");
    345 			break;
    346 		default:
    347 			snprintf(comname, sizeof(comname), "int#%d", i);
    348 			break;
    349 		}
    350 
    351 		ucaa.ucaa_portno = i;
    352 		/* ucaa_bulkin, ucaa_bulkout set above */
    353 		ucaa.ucaa_ibufsize = UHMODEMIBUFSIZE;
    354 		ucaa.ucaa_obufsize = UHMODEMOBUFSIZE;
    355 		ucaa.ucaa_ibufsizepad = UHMODEMIBUFSIZE;
    356 		ucaa.ucaa_opkthdrlen = 0;
    357 		ucaa.ucaa_device = dev;
    358 		ucaa.ucaa_iface = sc->sc_ubsa.sc_iface[i];
    359 		ucaa.ucaa_methods = &uhmodem_methods;
    360 		ucaa.ucaa_arg = &sc->sc_ubsa;
    361 		ucaa.ucaa_info = comname;
    362 		DPRINTF(("uhmodem: int#=%d, in = 0x%x, out = 0x%x, intr = 0x%x\n",
    363 		    i, ucaa.ucaa_bulkin, ucaa.ucaa_bulkout,
    364 		    sc->sc_ubsa.sc_intr_number));
    365 		sc->sc_ubsa.sc_subdevs[i] = config_found_sm_loc(self, "ucombus", NULL,
    366 				 &ucaa, ucomprint, ucomsubmatch);
    367 
    368 		/* issue endpoint halt to each interface */
    369 		err = uhmodem_endpointhalt(&sc->sc_ubsa, i);
    370 		if (err)
    371 			aprint_error("%s: endpointhalt fail\n", __func__);
    372 		else
    373 			usbd_delay_ms(sc->sc_ubsa.sc_udev, 50);
    374 	} /* end of Interface loop */
    375 
    376 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_ubsa.sc_udev,
    377 			   sc->sc_ubsa.sc_dev);
    378 
    379 	return;
    380 
    381 error:
    382 	return;
    383 }
    384 
    385 void
    386 uhmodem_childdet(device_t self, device_t child)
    387 {
    388 	int i;
    389 	struct uhmodem_softc *sc = device_private(self);
    390 
    391 	for (i = 0; i < sc->sc_ubsa.sc_numif; i++) {
    392 		if (sc->sc_ubsa.sc_subdevs[i] == child)
    393 			break;
    394 	}
    395 	KASSERT(i < sc->sc_ubsa.sc_numif);
    396 	sc->sc_ubsa.sc_subdevs[i] = NULL;
    397 }
    398 
    399 int
    400 uhmodem_detach(device_t self, int flags)
    401 {
    402 	struct uhmodem_softc *sc = device_private(self);
    403 	int i;
    404 	int rv = 0;
    405 
    406 	DPRINTF(("uhmodem_detach: sc = %p\n", sc));
    407 
    408 	if (sc->sc_ubsa.sc_intr_pipe != NULL) {
    409 		usbd_abort_pipe(sc->sc_ubsa.sc_intr_pipe);
    410 		usbd_close_pipe(sc->sc_ubsa.sc_intr_pipe);
    411 		kmem_free(sc->sc_ubsa.sc_intr_buf, sc->sc_ubsa.sc_isize);
    412 		sc->sc_ubsa.sc_intr_pipe = NULL;
    413 	}
    414 
    415 	sc->sc_ubsa.sc_dying = 1;
    416 	for (i = 0; i < sc->sc_ubsa.sc_numif; i++) {
    417 		if (sc->sc_ubsa.sc_subdevs[i] != NULL)
    418 			rv |= config_detach(sc->sc_ubsa.sc_subdevs[i], flags);
    419 	}
    420 
    421 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_ubsa.sc_udev,
    422 			   sc->sc_ubsa.sc_dev);
    423 
    424 	return rv;
    425 }
    426 
    427 int
    428 uhmodem_activate(device_t self, enum devact act)
    429 {
    430 	struct uhmodem_softc *sc = device_private(self);
    431 
    432 	switch (act) {
    433 	case DVACT_DEACTIVATE:
    434 		sc->sc_ubsa.sc_dying = 1;
    435 		return 0;
    436 	default:
    437 		return EOPNOTSUPP;
    438 	}
    439 }
    440 
    441 Static int
    442 uhmodem_open(void *addr, int portno)
    443 {
    444 	struct ubsa_softc *sc = addr;
    445 	usbd_status err;
    446 
    447 	if (sc->sc_dying)
    448 		return ENXIO;
    449 
    450 	DPRINTF(("%s: sc = %p\n", __func__, sc));
    451 
    452 	err = uhmodem_endpointhalt(sc, 0);
    453 	if (err)
    454 		aprint_error("%s: endpointhalt fail\n", __func__);
    455 	else
    456 		usbd_delay_ms(sc->sc_udev, 50);
    457 
    458 	if (sc->sc_devflags & A2502) {
    459 		err = a2502_init(sc->sc_udev);
    460 		if (err)
    461 			aprint_error("%s: a2502init fail\n", __func__);
    462 		else
    463 			usbd_delay_ms(sc->sc_udev, 50);
    464 	}
    465 #if 0 /* currently disabled */
    466 	if (sc->sc_devflags & E220) {
    467 		err = e220_init(sc->sc_udev);
    468 		if (err)
    469 			aprint_error("%s: e220init fail\n", __func__);
    470 		else
    471 			usbd_delay_ms(sc->sc_udev, 50);
    472 	}
    473 #endif
    474 	if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
    475 		sc->sc_intr_buf = kmem_alloc(sc->sc_isize, KM_SLEEP);
    476 		/* XXX only iface# = 0 has intr line */
    477 		/* XXX E220 specific? need to check */
    478 		err = usbd_open_pipe_intr(sc->sc_iface[0],
    479 		    sc->sc_intr_number,
    480 		    USBD_SHORT_XFER_OK,
    481 		    &sc->sc_intr_pipe,
    482 		    sc,
    483 		    sc->sc_intr_buf,
    484 		    sc->sc_isize,
    485 		    ubsa_intr,
    486 		    UBSA_INTR_INTERVAL);
    487 		if (err) {
    488 			aprint_error_dev(sc->sc_dev,
    489 			    "cannot open interrupt pipe (addr %d)\n",
    490 			    sc->sc_intr_number);
    491 			return EIO;
    492 		}
    493 	}
    494 
    495 	return 0;
    496 }
    497 
    498 /*
    499  * Hauwei E220 needs special request to enable modem function.
    500  * -- DEVICE_REMOTE_WAKEUP ruquest to endpoint 2.
    501  */
    502 Static  usbd_status
    503 e220_modechange_request(struct usbd_device *dev)
    504 {
    505 #define E220_MODE_CHANGE_REQUEST 0x2
    506 	usb_device_request_t req;
    507 	usbd_status err;
    508 
    509 	req.bmRequestType = UT_WRITE_DEVICE;
    510 	req.bRequest = UR_SET_FEATURE;
    511 	USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
    512 	USETW(req.wIndex, E220_MODE_CHANGE_REQUEST);
    513 	USETW(req.wLength, 0);
    514 
    515 	DPRINTF(("%s: send e220 mode change request\n", __func__));
    516 	err = usbd_do_request(dev, &req, 0);
    517 	if (err) {
    518 		DPRINTF(("%s: E220 mode change fail\n", __func__));
    519 		return EIO;
    520 	}
    521 
    522 	return 0;
    523 #undef E220_MODE_CHANGE_REQUEST
    524 }
    525 
    526 Static  usbd_status
    527 uhmodem_endpointhalt(struct ubsa_softc *sc, int iface)
    528 {
    529 	usb_device_request_t req;
    530 	usb_endpoint_descriptor_t *ed;
    531 	usb_interface_descriptor_t *id;
    532 	usbd_status err;
    533 	int i;
    534 
    535 	/* Find the endpoints */
    536 	id = usbd_get_interface_descriptor(sc->sc_iface[iface]);
    537 
    538 	for (i = 0; i < id->bNumEndpoints; i++) {
    539 		ed = usbd_interface2endpoint_descriptor(sc->sc_iface[iface], i);
    540 		if (ed == NULL)
    541 			return EIO;
    542 
    543 		if (UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
    544 			/* issue ENDPOINT_HALT request */
    545 			req.bmRequestType = UT_WRITE_ENDPOINT;
    546 			req.bRequest = UR_CLEAR_FEATURE;
    547 			USETW(req.wValue, UF_ENDPOINT_HALT);
    548 			USETW(req.wIndex, ed->bEndpointAddress);
    549 			USETW(req.wLength, 0);
    550 			err = usbd_do_request(sc->sc_udev, &req, 0);
    551 			if (err) {
    552 				DPRINTF(("%s: ENDPOINT_HALT to EP:%d fail\n",
    553 					__func__, ed->bEndpointAddress));
    554 				return EIO;
    555 			}
    556 
    557 		}
    558 	} /* end of Endpoint loop */
    559 
    560 	return 0;
    561 }
    562 
    563 Static usbd_status
    564 uhmodem_regwrite(struct usbd_device *dev, uint8_t *data, size_t len)
    565 {
    566 	usb_device_request_t req;
    567 	usbd_status err;
    568 
    569 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    570 	req.bRequest = UHMODEM_REGWRITE;
    571 	USETW(req.wValue, 0x0000);
    572 	USETW(req.wIndex, 0x0000);
    573 	USETW(req.wLength, len);
    574 	err = usbd_do_request(dev, &req, data);
    575 	if (err)
    576 		return err;
    577 
    578 	return 0;
    579 }
    580 
    581 Static usbd_status
    582 uhmodem_regread(struct usbd_device *dev, uint8_t *data, size_t len)
    583 {
    584 	usb_device_request_t req;
    585 	usbd_status err;
    586 
    587 	req.bmRequestType = UT_READ_CLASS_INTERFACE;
    588 	req.bRequest = UHMODEM_REGREAD;
    589 	USETW(req.wValue, 0x0000);
    590 	USETW(req.wIndex, 0x0000);
    591 	USETW(req.wLength, len);
    592 	err = usbd_do_request(dev, &req, data);
    593 
    594 	if (err)
    595 		return err;
    596 
    597 	return 0;
    598 }
    599 
    600 #if 0
    601 Static usbd_status
    602 uhmodem_regsetup(struct usbd_device *dev, uint16_t cmd)
    603 {
    604 	usb_device_request_t req;
    605 	usbd_status err;
    606 
    607 	req.bmRequestType = UT_READ_CLASS_INTERFACE;
    608 	req.bRequest = UHMODEM_SETUP;
    609 	USETW(req.wValue, cmd);
    610 	USETW(req.wIndex, 0x0000);
    611 	USETW(req.wLength, 0);
    612 	err = usbd_do_request(dev, &req, 0);
    613 
    614 	if (err)
    615 		return err;
    616 
    617 	return 0;
    618 }
    619 #endif
    620 
    621 Static  usbd_status
    622 a2502_init(struct usbd_device *dev)
    623 {
    624 	uint8_t data[8];
    625 	static uint8_t init_cmd[] = {0x00, 0xE1, 0x00, 0x00, 0x00, 0x00, 0x08};
    626 #ifdef UHMODEM_DEBUG
    627 	int i;
    628 #endif
    629 	if (uhmodem_regread(dev, data, 7)) {
    630 		DPRINTF(("%s: read fail\n", __func__));
    631 		return EIO;
    632 	}
    633 #ifdef UHMODEM_DEBUG
    634 	printf("%s: readdata: ", __func__);
    635 	for (i = 0; i < 7; i++)
    636 		printf("0x%x ", data[i]);
    637 #endif
    638 	if (uhmodem_regwrite(dev, init_cmd, sizeof(init_cmd)) ) {
    639 		DPRINTF(("%s: write fail\n", __func__));
    640 		return EIO;
    641 	}
    642 
    643 	if (uhmodem_regread(dev, data, 7)) {
    644 		DPRINTF(("%s: read fail\n", __func__));
    645 		return EIO;
    646 	}
    647 #ifdef UHMODEM_DEBUG
    648 	printf("%s: readdata: ", __func__);
    649 	printf(" => ");
    650 	for (i = 0; i < 7; i++)
    651 		printf("0x%x ", data[i]);
    652 	printf("\n");
    653 #endif
    654 	return 0;
    655 }
    656 
    657 
    658 #if 0
    659 /*
    660  * Windows device driver send these sequens of USB requests.
    661  * However currently I can't understand what the messege is,
    662  * disable this code when I get more information about it.
    663  */
    664 Static  usbd_status
    665 e220_init(struct usbd_device *dev)
    666 {
    667 	uint8_t data[8];
    668 	usb_device_request_t req;
    669 	int i;
    670 
    671 	/* vendor specific unknown request */
    672 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    673 	req.bRequest = 0x02;
    674 	USETW(req.wValue, 0x0001);
    675 	USETW(req.wIndex, 0x0000);
    676 	USETW(req.wLength, 2);
    677 	data[0] = 0x0;
    678 	data[1] = 0x0;
    679 	if (usbd_do_request(dev, &req, data))
    680 		goto error;
    681 
    682 	/* vendor specific unknown sequence */
    683 	if(uhmodem_regsetup(dev, 0x1))
    684 		goto error;
    685 
    686 	if (uhmodem_regread(dev, data, 7))
    687 		goto error;
    688 
    689 	data[1] = 0x8;
    690 	data[2] = 0x7;
    691 	if (uhmodem_regwrite(dev, data, sizeof(data)) )
    692 		goto error;
    693 
    694 	if (uhmodem_regread(dev, data, 7))
    695 		goto error;
    696 		/* XXX should verify the read data ? */
    697 
    698 	if (uhmodem_regsetup(dev, 0x3))
    699 		goto error;
    700 
    701 	return 0;
    702 error:
    703 	DPRINTF(("%s: E220 init request fail\n", __func__));
    704 	return EIO;
    705 }
    706 #endif
    707 
    708