Home | History | Annotate | Line # | Download | only in usb
ugensa.c revision 1.35.16.1
      1  1.35.16.1  christos /*	$NetBSD: ugensa.c,v 1.35.16.1 2019/06/10 22:07:34 christos Exp $	*/
      2        1.1     elric 
      3        1.1     elric /*
      4        1.1     elric  * Copyright (c) 2004, 2005 The NetBSD Foundation, Inc.
      5        1.1     elric  * All rights reserved.
      6        1.1     elric  *
      7        1.1     elric  * This code is derived from software contributed to The NetBSD Foundation
      8        1.1     elric  * by Roland C. Dowdeswell <elric (at) netbsd.org>.
      9        1.1     elric  *
     10        1.1     elric  * Redistribution and use in source and binary forms, with or without
     11        1.1     elric  * modification, are permitted provided that the following conditions
     12        1.1     elric  * are met:
     13        1.1     elric  * 1. Redistributions of source code must retain the above copyright
     14        1.1     elric  *    notice, this list of conditions and the following disclaimer.
     15        1.1     elric  * 2. Redistributions in binary form must reproduce the above copyright
     16        1.1     elric  *    notice, this list of conditions and the following disclaimer in the
     17        1.1     elric  *    documentation and/or other materials provided with the distribution.
     18        1.1     elric  *
     19        1.1     elric  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20        1.1     elric  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21        1.1     elric  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22        1.1     elric  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23        1.1     elric  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24        1.1     elric  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25        1.1     elric  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26        1.1     elric  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27        1.1     elric  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28        1.1     elric  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29        1.1     elric  * POSSIBILITY OF SUCH DAMAGE.
     30        1.1     elric  */
     31        1.1     elric 
     32       1.13     lukem #include <sys/cdefs.h>
     33  1.35.16.1  christos __KERNEL_RCSID(0, "$NetBSD: ugensa.c,v 1.35.16.1 2019/06/10 22:07:34 christos Exp $");
     34       1.35     skrll 
     35       1.35     skrll #ifdef _KERNEL_OPT
     36       1.35     skrll #include "opt_usb.h"
     37       1.35     skrll #endif
     38       1.13     lukem 
     39        1.1     elric #include <sys/param.h>
     40        1.1     elric #include <sys/systm.h>
     41        1.1     elric #include <sys/kernel.h>
     42        1.1     elric #include <sys/device.h>
     43        1.1     elric #include <sys/conf.h>
     44        1.1     elric #include <sys/tty.h>
     45        1.1     elric 
     46        1.1     elric #include <dev/usb/usb.h>
     47        1.1     elric 
     48        1.1     elric #include <dev/usb/usbdi.h>
     49        1.1     elric #include <dev/usb/usbdi_util.h>
     50        1.1     elric #include <dev/usb/usbdevs.h>
     51        1.1     elric 
     52        1.1     elric #include <dev/usb/ucomvar.h>
     53        1.1     elric 
     54        1.1     elric #ifdef UGENSA_DEBUG
     55        1.1     elric #define DPRINTF(x)	if (ugensadebug) printf x
     56        1.1     elric #define DPRINTFN(n,x)	if (ugensadebug>(n)) printf x
     57        1.1     elric int ugensadebug = 0;
     58        1.1     elric #else
     59        1.1     elric #define DPRINTF(x)
     60        1.1     elric #define DPRINTFN(n,x)
     61        1.1     elric #endif
     62        1.1     elric 
     63        1.1     elric struct ugensa_softc {
     64       1.28    dyoung 	device_t		sc_dev;		/* base device */
     65       1.32     skrll 	struct usbd_device *	sc_udev;	/* device */
     66       1.32     skrll 	struct usbd_interface *	sc_iface;	/* interface */
     67        1.1     elric 
     68       1.15    dyoung 	device_t		sc_subdev;
     69        1.1     elric 	int			sc_numcon;
     70        1.1     elric 
     71  1.35.16.1  christos 	bool			sc_dying;
     72        1.1     elric };
     73        1.1     elric 
     74  1.35.16.1  christos struct ucom_methods ugensa_methods = { 0 };
     75        1.1     elric 
     76        1.1     elric #define UGENSA_CONFIG_INDEX	0
     77        1.1     elric #define UGENSA_IFACE_INDEX	0
     78        1.1     elric #define UGENSA_BUFSIZE		1024
     79        1.1     elric 
     80       1.16     elric struct ugensa_type {
     81       1.16     elric 	struct usb_devno	ugensa_dev;
     82       1.32     skrll 	uint16_t		ugensa_flags;
     83       1.16     elric #define UNTESTED		0x0001
     84        1.1     elric };
     85       1.16     elric 
     86       1.16     elric static const struct ugensa_type ugensa_devs[] = {
     87       1.16     elric 	{{ USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220 }, 0 },
     88       1.27       riz 	{{ USB_VENDOR_DELL, USB_PRODUCT_DELL_HSDPA }, 0 },
     89       1.16     elric 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_FLEXPACKGPS }, 0 },
     90       1.16     elric 	{{ USB_VENDOR_QUALCOMM_K, USB_PRODUCT_QUALCOMM_K_CDMA_MSM_K }, 0 },
     91       1.26       riz 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_USB305 }, 0 },
     92       1.31     soren 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_AC8700 }, 0 },
     93       1.16     elric 
     94       1.16     elric 	/*
     95       1.16     elric 	 * The following devices are untested, but they are purported to
     96       1.16     elric 	 * to work in similar device drivers on other OSes:
     97       1.16     elric 	 */
     98       1.16     elric 
     99       1.32     skrll 	{{ USB_VENDOR_ANYDATA, USB_PRODUCT_ANYDATA_ADU_500A }, UNTESTED },
    100       1.32     skrll 	{{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_EXPRESSCARD }, UNTESTED },
    101  1.35.16.1  christos 	{{ USB_VENDOR_LG, USB_PRODUCT_LG_MSM_HSDPA }, UNTESTED },
    102       1.27       riz 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD875 }, UNTESTED },
    103       1.17     elric 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 }, UNTESTED },
    104       1.16     elric };
    105       1.16     elric #define ugensa_lookup(v, p) \
    106       1.16     elric 	((const struct ugensa_type *)usb_lookup(ugensa_devs, v, p))
    107        1.1     elric 
    108  1.35.16.1  christos static int	ugensa_match(device_t, cfdata_t, void *);
    109  1.35.16.1  christos static void	ugensa_attach(device_t, device_t, void *);
    110  1.35.16.1  christos static void	ugensa_childdet(device_t, device_t);
    111  1.35.16.1  christos static int	ugensa_detach(device_t, int);
    112  1.35.16.1  christos 
    113       1.20      cube CFATTACH_DECL2_NEW(ugensa, sizeof(struct ugensa_softc), ugensa_match,
    114  1.35.16.1  christos     ugensa_attach, ugensa_detach, NULL, NULL, ugensa_childdet);
    115        1.1     elric 
    116  1.35.16.1  christos static int
    117       1.28    dyoung ugensa_match(device_t parent, cfdata_t match, void *aux)
    118        1.1     elric {
    119       1.28    dyoung 	struct usb_attach_arg *uaa = aux;
    120        1.1     elric 
    121        1.1     elric 	DPRINTFN(20,("ugensa: vendor=0x%x, product=0x%x\n",
    122       1.32     skrll 		     uaa->uaa_vendor, uaa->uaa_product));
    123        1.1     elric 
    124       1.32     skrll 	return ugensa_lookup(uaa->uaa_vendor, uaa->uaa_product) != NULL ?
    125       1.32     skrll 		UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
    126        1.1     elric }
    127        1.1     elric 
    128  1.35.16.1  christos static void
    129       1.28    dyoung ugensa_attach(device_t parent, device_t self, void *aux)
    130        1.1     elric {
    131       1.28    dyoung 	struct ugensa_softc *sc = device_private(self);
    132       1.28    dyoung 	struct usb_attach_arg *uaa = aux;
    133       1.32     skrll 	struct usbd_device *dev = uaa->uaa_device;
    134       1.32     skrll 	struct usbd_interface *iface;
    135        1.1     elric 	usb_interface_descriptor_t *id;
    136        1.1     elric 	usb_endpoint_descriptor_t *ed;
    137        1.3  augustss 	char *devinfop;
    138       1.20      cube 	const char *devname = device_xname(self);
    139        1.1     elric 	usbd_status err;
    140       1.32     skrll 	struct ucom_attach_args ucaa;
    141        1.1     elric 	int i;
    142        1.1     elric 
    143        1.1     elric 	DPRINTFN(10,("\nugensa_attach: sc=%p\n", sc));
    144        1.1     elric 
    145       1.20      cube 	sc->sc_dev = self;
    146  1.35.16.1  christos 	sc->sc_dying = false;
    147       1.20      cube 
    148       1.23    plunky 	aprint_naive("\n");
    149       1.23    plunky 	aprint_normal("\n");
    150       1.23    plunky 
    151       1.23    plunky 	devinfop = usbd_devinfo_alloc(dev, 0);
    152       1.23    plunky 	aprint_normal_dev(self, "%s\n", devinfop);
    153       1.23    plunky 	usbd_devinfo_free(devinfop);
    154       1.23    plunky 
    155        1.1     elric 	/* Move the device into the configured state. */
    156        1.1     elric 	err = usbd_set_config_index(dev, UGENSA_CONFIG_INDEX, 1);
    157        1.1     elric 	if (err) {
    158       1.20      cube 		aprint_error("\n%s: failed to set configuration, err=%s\n",
    159        1.1     elric 		       devname, usbd_errstr(err));
    160        1.1     elric 		goto bad;
    161        1.1     elric 	}
    162        1.1     elric 
    163        1.1     elric 	err = usbd_device2interface_handle(dev, UGENSA_IFACE_INDEX, &iface);
    164        1.1     elric 	if (err) {
    165       1.20      cube 		aprint_error("\n%s: failed to get interface, err=%s\n",
    166        1.1     elric 		       devname, usbd_errstr(err));
    167        1.1     elric 		goto bad;
    168        1.1     elric 	}
    169        1.1     elric 
    170       1.32     skrll 	if (ugensa_lookup(uaa->uaa_vendor, uaa->uaa_product)->ugensa_flags & UNTESTED)
    171       1.20      cube 		aprint_normal_dev(self, "WARNING: This device is marked as "
    172       1.20      cube 		    "untested. Please submit a report via send-pr(1).\n");
    173       1.16     elric 
    174        1.1     elric 	id = usbd_get_interface_descriptor(iface);
    175        1.1     elric 
    176        1.1     elric 	sc->sc_udev = dev;
    177        1.1     elric 	sc->sc_iface = iface;
    178        1.1     elric 
    179       1.32     skrll 	ucaa.ucaa_info = "Generic Serial Device";
    180       1.32     skrll 	ucaa.ucaa_ibufsize = UGENSA_BUFSIZE;
    181       1.32     skrll 	ucaa.ucaa_obufsize = UGENSA_BUFSIZE;
    182       1.32     skrll 	ucaa.ucaa_ibufsizepad = UGENSA_BUFSIZE;
    183       1.32     skrll 	ucaa.ucaa_portno = UCOM_UNK_PORTNO;
    184       1.32     skrll 	ucaa.ucaa_opkthdrlen = 0;
    185       1.32     skrll 	ucaa.ucaa_device = dev;
    186       1.32     skrll 	ucaa.ucaa_iface = iface;
    187       1.32     skrll 	ucaa.ucaa_methods = &ugensa_methods;
    188       1.32     skrll 	ucaa.ucaa_arg = sc;
    189        1.1     elric 
    190       1.33   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
    191        1.1     elric 
    192       1.32     skrll 	ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1;
    193        1.1     elric 	for (i = 0; i < id->bNumEndpoints; i++) {
    194        1.1     elric 		int addr, dir, attr;
    195        1.1     elric 
    196        1.1     elric 		ed = usbd_interface2endpoint_descriptor(iface, i);
    197        1.1     elric 		if (ed == NULL) {
    198       1.20      cube 			aprint_error_dev(self,
    199       1.20      cube 			    "could not read endpoint descriptor: %s\n",
    200       1.20      cube 			    usbd_errstr(err));
    201        1.1     elric 			goto bad;
    202        1.1     elric 		}
    203        1.1     elric 
    204        1.1     elric 		addr = ed->bEndpointAddress;
    205        1.1     elric 		dir = UE_GET_DIR(ed->bEndpointAddress);
    206        1.1     elric 		attr = ed->bmAttributes & UE_XFERTYPE;
    207       1.16     elric 		if (attr == UE_BULK) {
    208       1.32     skrll 			if (ucaa.ucaa_bulkin == -1 && dir == UE_DIR_IN) {
    209       1.16     elric 				DPRINTF(("%s: Bulk in %d\n", devname, i));
    210       1.32     skrll 				ucaa.ucaa_bulkin = addr;
    211       1.16     elric 				continue;
    212       1.16     elric 			}
    213       1.32     skrll 			if (ucaa.ucaa_bulkout == -1 && dir == UE_DIR_OUT) {
    214       1.16     elric 				DPRINTF(("%s: Bulk out %d\n", devname, i));
    215       1.32     skrll 				ucaa.ucaa_bulkout = addr;
    216       1.16     elric 				continue;
    217       1.16     elric 			}
    218       1.16     elric 		}
    219       1.20      cube 		aprint_error_dev(self, "unexpected endpoint\n");
    220        1.1     elric 	}
    221       1.32     skrll 	if (ucaa.ucaa_bulkin == -1) {
    222       1.20      cube 		aprint_error_dev(self, "Could not find data bulk in\n");
    223        1.1     elric 		goto bad;
    224        1.1     elric 	}
    225       1.32     skrll 	if (ucaa.ucaa_bulkout == -1) {
    226       1.20      cube 		aprint_error_dev(self, "Could not find data bulk out\n");
    227        1.1     elric 		goto bad;
    228        1.1     elric 	}
    229        1.1     elric 
    230       1.32     skrll 	DPRINTF(("ugensa: in=0x%x out=0x%x\n", ucaa.ucaa_bulkin,
    231       1.32     skrll 	    ucaa.ucaa_bulkout));
    232       1.32     skrll 	sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &ucaa,
    233        1.1     elric 					    ucomprint, ucomsubmatch);
    234        1.1     elric 
    235       1.14       smb 	if (!pmf_device_register(self, NULL, NULL))
    236       1.14       smb 		aprint_error_dev(self, "couldn't establish power handler\n");
    237       1.28    dyoung 	return;
    238        1.1     elric 
    239        1.1     elric bad:
    240        1.1     elric 	DPRINTF(("ugensa_attach: ATTACH ERROR\n"));
    241  1.35.16.1  christos 	sc->sc_dying = true;
    242       1.28    dyoung 	return;
    243        1.1     elric }
    244        1.1     elric 
    245  1.35.16.1  christos static void
    246       1.15    dyoung ugensa_childdet(device_t self, device_t child)
    247       1.15    dyoung {
    248       1.15    dyoung 	struct ugensa_softc *sc = device_private(self);
    249       1.15    dyoung 
    250       1.15    dyoung 	KASSERT(sc->sc_subdev == child);
    251       1.15    dyoung 	sc->sc_subdev = NULL;
    252       1.15    dyoung }
    253       1.15    dyoung 
    254  1.35.16.1  christos static int
    255       1.28    dyoung ugensa_detach(device_t self, int flags)
    256        1.1     elric {
    257       1.28    dyoung 	struct ugensa_softc *sc = device_private(self);
    258        1.1     elric 	int rv = 0;
    259        1.1     elric 
    260        1.1     elric 	DPRINTF(("ugensa_detach: sc=%p flags=%d\n", sc, flags));
    261        1.1     elric 
    262  1.35.16.1  christos 	sc->sc_dying = true;
    263        1.1     elric 
    264  1.35.16.1  christos 	if (sc->sc_subdev != NULL) {
    265        1.1     elric 		rv = config_detach(sc->sc_subdev, flags);
    266  1.35.16.1  christos 		sc->sc_subdev = NULL;
    267  1.35.16.1  christos 	}
    268        1.1     elric 
    269       1.33   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
    270        1.1     elric 
    271  1.35.16.1  christos 	pmf_device_deregister(self);
    272  1.35.16.1  christos 
    273       1.32     skrll 	return rv;
    274        1.1     elric }
    275