Home | History | Annotate | Line # | Download | only in usb
umodem_common.c revision 1.28
      1  1.28       mrg /*	$NetBSD: umodem_common.c,v 1.28 2019/05/04 08:04:13 mrg Exp $	*/
      2   1.1     itohy 
      3   1.1     itohy /*
      4   1.1     itohy  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5   1.1     itohy  * All rights reserved.
      6   1.1     itohy  *
      7   1.1     itohy  * This code is derived from software contributed to The NetBSD Foundation
      8   1.1     itohy  * by Lennart Augustsson (lennart (at) augustsson.net) at
      9   1.1     itohy  * Carlstedt Research & Technology.
     10   1.1     itohy  *
     11   1.1     itohy  * Redistribution and use in source and binary forms, with or without
     12   1.1     itohy  * modification, are permitted provided that the following conditions
     13   1.1     itohy  * are met:
     14   1.1     itohy  * 1. Redistributions of source code must retain the above copyright
     15   1.1     itohy  *    notice, this list of conditions and the following disclaimer.
     16   1.1     itohy  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.1     itohy  *    notice, this list of conditions and the following disclaimer in the
     18   1.1     itohy  *    documentation and/or other materials provided with the distribution.
     19   1.1     itohy  *
     20   1.1     itohy  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21   1.1     itohy  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22   1.1     itohy  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23   1.1     itohy  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24   1.1     itohy  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25   1.1     itohy  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26   1.1     itohy  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27   1.1     itohy  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28   1.1     itohy  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29   1.1     itohy  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30   1.1     itohy  * POSSIBILITY OF SUCH DAMAGE.
     31   1.1     itohy  */
     32   1.1     itohy 
     33   1.1     itohy /*
     34   1.1     itohy  * Comm Class spec:  http://www.usb.org/developers/devclass_docs/usbccs10.pdf
     35   1.1     itohy  *                   http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
     36   1.1     itohy  */
     37   1.1     itohy 
     38   1.1     itohy /*
     39   1.1     itohy  * TODO:
     40   1.1     itohy  * - Add error recovery in various places; the big problem is what
     41   1.1     itohy  *   to do in a callback if there is an error.
     42   1.1     itohy  * - Implement a Call Device for modems without multiplexed commands.
     43   1.1     itohy  *
     44   1.1     itohy  */
     45   1.1     itohy 
     46   1.1     itohy #include <sys/cdefs.h>
     47  1.28       mrg __KERNEL_RCSID(0, "$NetBSD: umodem_common.c,v 1.28 2019/05/04 08:04:13 mrg Exp $");
     48  1.25     skrll 
     49  1.25     skrll #ifdef _KERNEL_OPT
     50  1.25     skrll #include "opt_usb.h"
     51  1.25     skrll #endif
     52   1.1     itohy 
     53   1.1     itohy #include <sys/param.h>
     54   1.1     itohy #include <sys/systm.h>
     55   1.1     itohy #include <sys/kernel.h>
     56   1.1     itohy #include <sys/ioctl.h>
     57   1.1     itohy #include <sys/conf.h>
     58   1.1     itohy #include <sys/tty.h>
     59   1.1     itohy #include <sys/file.h>
     60   1.1     itohy #include <sys/select.h>
     61   1.1     itohy #include <sys/proc.h>
     62   1.1     itohy #include <sys/vnode.h>
     63   1.1     itohy #include <sys/device.h>
     64   1.1     itohy #include <sys/poll.h>
     65   1.1     itohy 
     66   1.1     itohy #include <dev/usb/usb.h>
     67   1.1     itohy #include <dev/usb/usbcdc.h>
     68   1.1     itohy 
     69   1.1     itohy #include <dev/usb/usbdi.h>
     70   1.1     itohy #include <dev/usb/usbdi_util.h>
     71   1.1     itohy #include <dev/usb/usbdevs.h>
     72   1.1     itohy #include <dev/usb/usb_quirks.h>
     73   1.1     itohy 
     74   1.1     itohy #include <dev/usb/ucomvar.h>
     75   1.1     itohy #include <dev/usb/umodemvar.h>
     76   1.1     itohy 
     77   1.1     itohy #ifdef UMODEM_DEBUG
     78  1.22    dyoung #define DPRINTFN(n, x)	if (umodemdebug > (n)) printf x
     79   1.1     itohy int	umodemdebug = 0;
     80   1.1     itohy #else
     81   1.1     itohy #define DPRINTFN(n, x)
     82   1.1     itohy #endif
     83   1.1     itohy #define DPRINTF(x) DPRINTFN(0, x)
     84   1.1     itohy 
     85   1.1     itohy /*
     86   1.1     itohy  * These are the maximum number of bytes transferred per frame.
     87   1.1     itohy  * If some really high speed devices should use this driver they
     88   1.1     itohy  * may need to be increased, but this is good enough for normal modems.
     89   1.7       smb  *
     90   1.7       smb  * Note: increased from 64/256, to better support EVDO wireless PPP.
     91   1.7       smb  * The sizes should not be increased further, or there
     92   1.7       smb  * will be problems with contiguous storage allocation.
     93   1.1     itohy  */
     94   1.7       smb #define UMODEMIBUFSIZE 4096
     95   1.7       smb #define UMODEMOBUFSIZE 4096
     96   1.1     itohy 
     97  1.27       mrg static usbd_status umodem_set_comm_feature(struct umodem_softc *,
     98  1.23     skrll 					   int, int);
     99  1.27       mrg static usbd_status umodem_set_line_coding(struct umodem_softc *,
    100  1.23     skrll 					  usb_cdc_line_state_t *);
    101   1.1     itohy 
    102  1.27       mrg static void	umodem_dtr(struct umodem_softc *, int);
    103  1.27       mrg static void	umodem_rts(struct umodem_softc *, int);
    104  1.27       mrg static void	umodem_break(struct umodem_softc *, int);
    105  1.27       mrg static void	umodem_set_line_state(struct umodem_softc *);
    106  1.27       mrg static void	umodem_intr(struct usbd_xfer *, void *, usbd_status);
    107   1.1     itohy 
    108   1.1     itohy int
    109  1.22    dyoung umodem_common_attach(device_t self, struct umodem_softc *sc,
    110  1.23     skrll     struct usbif_attach_arg *uiaa, struct ucom_attach_args *ucaa)
    111   1.1     itohy {
    112  1.23     skrll 	struct usbd_device *dev = uiaa->uiaa_device;
    113   1.1     itohy 	usb_interface_descriptor_t *id;
    114   1.1     itohy 	usb_endpoint_descriptor_t *ed;
    115   1.4  augustss 	char *devinfop;
    116   1.1     itohy 	usbd_status err;
    117   1.1     itohy 	int data_ifcno;
    118   1.1     itohy 	int i;
    119   1.1     itohy 
    120  1.15      cube 	sc->sc_dev = self;
    121   1.1     itohy 	sc->sc_udev = dev;
    122  1.23     skrll 	sc->sc_ctl_iface = uiaa->uiaa_iface;
    123  1.27       mrg 	sc->sc_refcnt = 0;
    124  1.27       mrg 	sc->sc_dying = false;
    125   1.1     itohy 
    126  1.16    plunky 	aprint_naive("\n");
    127  1.16    plunky 	aprint_normal("\n");
    128  1.16    plunky 
    129  1.27       mrg 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB);
    130  1.27       mrg 	cv_init(&sc->sc_detach_cv, "umodemdet");
    131  1.27       mrg 
    132   1.1     itohy 	id = usbd_get_interface_descriptor(sc->sc_ctl_iface);
    133  1.23     skrll 	devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0);
    134  1.15      cube 	aprint_normal_dev(self, "%s, iclass %d/%d\n",
    135   1.4  augustss 	       devinfop, id->bInterfaceClass, id->bInterfaceSubClass);
    136   1.4  augustss 	usbd_devinfo_free(devinfop);
    137  1.16    plunky 
    138   1.1     itohy 	sc->sc_ctl_iface_no = id->bInterfaceNumber;
    139   1.1     itohy 
    140   1.2     itohy 	/* Get the data interface no. */
    141   1.2     itohy 	sc->sc_data_iface_no = data_ifcno =
    142   1.2     itohy 	    umodem_get_caps(dev, &sc->sc_cm_cap, &sc->sc_acm_cap, id);
    143   1.1     itohy 
    144   1.2     itohy 	if (data_ifcno == -1) {
    145  1.15      cube 		aprint_error_dev(self, "no pointer to data interface\n");
    146   1.1     itohy 		goto bad;
    147   1.1     itohy 	}
    148   1.1     itohy 
    149  1.15      cube 	aprint_normal_dev(self,
    150  1.15      cube 	    "data interface %d, has %sCM over data, has %sbreak\n",
    151  1.15      cube 	    data_ifcno, sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
    152  1.15      cube 	    sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
    153   1.1     itohy 
    154   1.1     itohy 	/* Get the data interface too. */
    155  1.23     skrll 	for (i = 0; i < uiaa->uiaa_nifaces; i++) {
    156  1.23     skrll 		if (uiaa->uiaa_ifaces[i] != NULL) {
    157  1.23     skrll 			id = usbd_get_interface_descriptor(uiaa->uiaa_ifaces[i]);
    158   1.1     itohy 			if (id != NULL && id->bInterfaceNumber == data_ifcno) {
    159  1.23     skrll 				sc->sc_data_iface = uiaa->uiaa_ifaces[i];
    160  1.23     skrll 				uiaa->uiaa_ifaces[i] = NULL;
    161   1.1     itohy 			}
    162   1.1     itohy 		}
    163   1.1     itohy 	}
    164   1.1     itohy 	if (sc->sc_data_iface == NULL) {
    165  1.15      cube 		aprint_error_dev(self, "no data interface\n");
    166   1.1     itohy 		goto bad;
    167   1.1     itohy 	}
    168   1.1     itohy 
    169   1.1     itohy 	/*
    170   1.1     itohy 	 * Find the bulk endpoints.
    171   1.1     itohy 	 * Iterate over all endpoints in the data interface and take note.
    172   1.1     itohy 	 */
    173  1.23     skrll 	ucaa->ucaa_bulkin = ucaa->ucaa_bulkout = -1;
    174   1.1     itohy 
    175   1.1     itohy 	id = usbd_get_interface_descriptor(sc->sc_data_iface);
    176   1.1     itohy 	for (i = 0; i < id->bNumEndpoints; i++) {
    177   1.1     itohy 		ed = usbd_interface2endpoint_descriptor(sc->sc_data_iface, i);
    178   1.1     itohy 		if (ed == NULL) {
    179  1.15      cube 			aprint_error_dev(self,
    180  1.15      cube 			    "no endpoint descriptor for %d\n)", i);
    181   1.1     itohy 			goto bad;
    182   1.1     itohy 		}
    183   1.1     itohy 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    184   1.1     itohy 		    (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    185  1.23     skrll 			ucaa->ucaa_bulkin = ed->bEndpointAddress;
    186   1.3     itohy 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    187   1.1     itohy 			   (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    188  1.23     skrll 			ucaa->ucaa_bulkout = ed->bEndpointAddress;
    189   1.3     itohy 		}
    190   1.3     itohy 	}
    191   1.1     itohy 
    192  1.23     skrll 	if (ucaa->ucaa_bulkin == -1) {
    193  1.15      cube 		aprint_error_dev(self, "Could not find data bulk in\n");
    194   1.1     itohy 		goto bad;
    195   1.1     itohy 	}
    196  1.23     skrll 	if (ucaa->ucaa_bulkout == -1) {
    197  1.15      cube 		aprint_error_dev(self, "Could not find data bulk out\n");
    198   1.1     itohy 		goto bad;
    199   1.1     itohy 	}
    200   1.1     itohy 
    201   1.1     itohy 	if (usbd_get_quirks(sc->sc_udev)->uq_flags & UQ_ASSUME_CM_OVER_DATA) {
    202   1.1     itohy 		sc->sc_cm_over_data = 1;
    203   1.1     itohy 	} else {
    204   1.1     itohy 		if (sc->sc_cm_cap & USB_CDC_CM_OVER_DATA) {
    205   1.1     itohy 			if (sc->sc_acm_cap & USB_CDC_ACM_HAS_FEATURE)
    206   1.1     itohy 				err = umodem_set_comm_feature(sc,
    207   1.1     itohy 				    UCDC_ABSTRACT_STATE, UCDC_DATA_MULTIPLEXED);
    208   1.1     itohy 			else
    209   1.1     itohy 				err = 0;
    210   1.1     itohy 			if (err) {
    211  1.15      cube 				aprint_error_dev(self,
    212  1.15      cube 				    "could not set data multiplex mode\n");
    213   1.1     itohy 				goto bad;
    214   1.1     itohy 			}
    215   1.1     itohy 			sc->sc_cm_over_data = 1;
    216   1.1     itohy 		}
    217   1.1     itohy 	}
    218   1.1     itohy 
    219   1.1     itohy 	/*
    220   1.1     itohy 	 * The standard allows for notification messages (to indicate things
    221   1.1     itohy 	 * like a modem hangup) to come in via an interrupt endpoint
    222   1.1     itohy 	 * off of the control interface.  Iterate over the endpoints on
    223   1.1     itohy 	 * the control interface and see if there are any interrupt
    224   1.1     itohy 	 * endpoints; if there are, then register it.
    225   1.1     itohy 	 */
    226   1.1     itohy 
    227   1.1     itohy 	sc->sc_ctl_notify = -1;
    228   1.1     itohy 	sc->sc_notify_pipe = NULL;
    229   1.1     itohy 
    230  1.19  christos 	id = usbd_get_interface_descriptor(sc->sc_ctl_iface);
    231   1.1     itohy 	for (i = 0; i < id->bNumEndpoints; i++) {
    232   1.1     itohy 		ed = usbd_interface2endpoint_descriptor(sc->sc_ctl_iface, i);
    233   1.1     itohy 		if (ed == NULL)
    234   1.1     itohy 			continue;
    235   1.1     itohy 
    236   1.1     itohy 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    237   1.1     itohy 		    (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
    238  1.26       tih 			aprint_verbose_dev(self,
    239  1.15      cube 			    "status change notification available\n");
    240   1.1     itohy 			sc->sc_ctl_notify = ed->bEndpointAddress;
    241   1.1     itohy 		}
    242   1.1     itohy 	}
    243   1.1     itohy 
    244   1.1     itohy 	sc->sc_dtr = -1;
    245   1.1     itohy 
    246  1.23     skrll 	/* ucaa_bulkin, ucaa_bulkout set above */
    247  1.23     skrll 	ucaa->ucaa_ibufsize = UMODEMIBUFSIZE;
    248  1.23     skrll 	ucaa->ucaa_obufsize = UMODEMOBUFSIZE;
    249  1.23     skrll 	ucaa->ucaa_ibufsizepad = UMODEMIBUFSIZE;
    250  1.23     skrll 	ucaa->ucaa_opkthdrlen = 0;
    251  1.23     skrll 	ucaa->ucaa_device = sc->sc_udev;
    252  1.23     skrll 	ucaa->ucaa_iface = sc->sc_data_iface;
    253  1.23     skrll 	ucaa->ucaa_arg = sc;
    254   1.1     itohy 
    255  1.24   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
    256   1.1     itohy 
    257   1.1     itohy 	DPRINTF(("umodem_common_attach: sc=%p\n", sc));
    258  1.23     skrll 	sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, ucaa,
    259   1.1     itohy 					    ucomprint, ucomsubmatch);
    260   1.1     itohy 
    261   1.1     itohy 	return 0;
    262   1.1     itohy 
    263   1.1     itohy  bad:
    264  1.27       mrg 	sc->sc_dying = true;
    265   1.1     itohy 	return 1;
    266   1.1     itohy }
    267   1.1     itohy 
    268   1.1     itohy int
    269   1.9  christos umodem_open(void *addr, int portno)
    270   1.1     itohy {
    271   1.1     itohy 	struct umodem_softc *sc = addr;
    272   1.1     itohy 	int err;
    273   1.1     itohy 
    274  1.27       mrg 	mutex_enter(&sc->sc_lock);
    275  1.27       mrg 	if (sc->sc_dying) {
    276  1.27       mrg 		mutex_exit(&sc->sc_lock);
    277  1.27       mrg 		return EIO;
    278  1.27       mrg 	}
    279  1.27       mrg 
    280  1.27       mrg 	sc->sc_refcnt++;
    281  1.27       mrg 	mutex_exit(&sc->sc_lock);
    282  1.27       mrg 
    283   1.1     itohy 	DPRINTF(("umodem_open: sc=%p\n", sc));
    284   1.1     itohy 
    285   1.1     itohy 	if (sc->sc_ctl_notify != -1 && sc->sc_notify_pipe == NULL) {
    286   1.1     itohy 		err = usbd_open_pipe_intr(sc->sc_ctl_iface, sc->sc_ctl_notify,
    287   1.1     itohy 		    USBD_SHORT_XFER_OK, &sc->sc_notify_pipe, sc,
    288   1.1     itohy 		    &sc->sc_notify_buf, sizeof(sc->sc_notify_buf),
    289   1.1     itohy 		    umodem_intr, USBD_DEFAULT_INTERVAL);
    290   1.1     itohy 
    291   1.1     itohy 		if (err) {
    292   1.1     itohy 			DPRINTF(("Failed to establish notify pipe: %s\n",
    293   1.1     itohy 				usbd_errstr(err)));
    294  1.27       mrg 			mutex_enter(&sc->sc_lock);
    295  1.27       mrg 			if (--sc->sc_refcnt < 0)
    296  1.27       mrg 				cv_broadcast(&sc->sc_detach_cv);
    297  1.27       mrg 			mutex_exit(&sc->sc_lock);
    298   1.1     itohy 			return EIO;
    299   1.1     itohy 		}
    300   1.1     itohy 	}
    301   1.1     itohy 
    302   1.1     itohy 	return 0;
    303   1.1     itohy }
    304   1.1     itohy 
    305   1.1     itohy void
    306   1.9  christos umodem_close(void *addr, int portno)
    307   1.1     itohy {
    308   1.1     itohy 	struct umodem_softc *sc = addr;
    309   1.1     itohy 	int err;
    310   1.1     itohy 
    311  1.27       mrg 	mutex_enter(&sc->sc_lock);
    312  1.27       mrg 	if (sc->sc_dying)
    313  1.27       mrg 		goto out;
    314  1.27       mrg 	mutex_exit(&sc->sc_lock);
    315  1.27       mrg 
    316   1.1     itohy 	DPRINTF(("umodem_close: sc=%p\n", sc));
    317   1.1     itohy 
    318   1.1     itohy 	if (sc->sc_notify_pipe != NULL) {
    319   1.1     itohy 		err = usbd_abort_pipe(sc->sc_notify_pipe);
    320   1.1     itohy 		if (err)
    321   1.1     itohy 			printf("%s: abort notify pipe failed: %s\n",
    322  1.22    dyoung 			    device_xname(sc->sc_dev), usbd_errstr(err));
    323   1.1     itohy 		err = usbd_close_pipe(sc->sc_notify_pipe);
    324   1.1     itohy 		if (err)
    325   1.1     itohy 			printf("%s: close notify pipe failed: %s\n",
    326  1.22    dyoung 			    device_xname(sc->sc_dev), usbd_errstr(err));
    327   1.1     itohy 		sc->sc_notify_pipe = NULL;
    328   1.1     itohy 	}
    329  1.27       mrg 
    330  1.27       mrg 	mutex_enter(&sc->sc_lock);
    331  1.27       mrg out:
    332  1.27       mrg 	if (--sc->sc_refcnt < 0)
    333  1.27       mrg 		cv_broadcast(&sc->sc_detach_cv);
    334  1.27       mrg 	mutex_exit(&sc->sc_lock);
    335   1.1     itohy }
    336   1.1     itohy 
    337  1.27       mrg static void
    338  1.23     skrll umodem_intr(struct usbd_xfer *xfer, void *priv,
    339   1.8  christos     usbd_status status)
    340   1.1     itohy {
    341   1.1     itohy 	struct umodem_softc *sc = priv;
    342   1.1     itohy 	u_char mstatus;
    343   1.1     itohy 
    344   1.1     itohy 	if (sc->sc_dying)
    345   1.1     itohy 		return;
    346   1.1     itohy 
    347   1.1     itohy 	if (status != USBD_NORMAL_COMPLETION) {
    348   1.1     itohy 		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
    349   1.1     itohy 			return;
    350  1.22    dyoung 		printf("%s: abnormal status: %s\n", device_xname(sc->sc_dev),
    351   1.1     itohy 		       usbd_errstr(status));
    352  1.21  christos 		if (status == USBD_STALLED)
    353  1.21  christos 			usbd_clear_endpoint_stall_async(sc->sc_notify_pipe);
    354   1.1     itohy 		return;
    355   1.1     itohy 	}
    356   1.1     itohy 
    357   1.1     itohy 	if (sc->sc_notify_buf.bmRequestType != UCDC_NOTIFICATION) {
    358   1.1     itohy 		DPRINTF(("%s: unknown message type (%02x) on notify pipe\n",
    359  1.22    dyoung 			 device_xname(sc->sc_dev),
    360   1.1     itohy 			 sc->sc_notify_buf.bmRequestType));
    361   1.1     itohy 		return;
    362   1.1     itohy 	}
    363   1.1     itohy 
    364   1.1     itohy 	switch (sc->sc_notify_buf.bNotification) {
    365   1.1     itohy 	case UCDC_N_SERIAL_STATE:
    366   1.1     itohy 		/*
    367   1.1     itohy 		 * Set the serial state in ucom driver based on
    368   1.1     itohy 		 * the bits from the notify message
    369   1.1     itohy 		 */
    370   1.1     itohy 		if (UGETW(sc->sc_notify_buf.wLength) != 2) {
    371   1.1     itohy 			printf("%s: Invalid notification length! (%d)\n",
    372  1.22    dyoung 			       device_xname(sc->sc_dev),
    373   1.1     itohy 			       UGETW(sc->sc_notify_buf.wLength));
    374   1.1     itohy 			break;
    375   1.1     itohy 		}
    376   1.1     itohy 		DPRINTF(("%s: notify bytes = %02x%02x\n",
    377  1.22    dyoung 			 device_xname(sc->sc_dev),
    378   1.1     itohy 			 sc->sc_notify_buf.data[0],
    379   1.1     itohy 			 sc->sc_notify_buf.data[1]));
    380   1.1     itohy 		/* Currently, lsr is always zero. */
    381   1.1     itohy 		sc->sc_lsr = sc->sc_msr = 0;
    382   1.1     itohy 		mstatus = sc->sc_notify_buf.data[0];
    383   1.1     itohy 
    384   1.1     itohy 		if (ISSET(mstatus, UCDC_N_SERIAL_RI))
    385   1.1     itohy 			sc->sc_msr |= UMSR_RI;
    386   1.1     itohy 		if (ISSET(mstatus, UCDC_N_SERIAL_DSR))
    387   1.1     itohy 			sc->sc_msr |= UMSR_DSR;
    388   1.1     itohy 		if (ISSET(mstatus, UCDC_N_SERIAL_DCD))
    389   1.1     itohy 			sc->sc_msr |= UMSR_DCD;
    390  1.15      cube 		ucom_status_change(device_private(sc->sc_subdev));
    391   1.1     itohy 		break;
    392   1.1     itohy 	default:
    393   1.1     itohy 		DPRINTF(("%s: unknown notify message: %02x\n",
    394  1.22    dyoung 			 device_xname(sc->sc_dev),
    395   1.1     itohy 			 sc->sc_notify_buf.bNotification));
    396   1.1     itohy 		break;
    397   1.1     itohy 	}
    398   1.1     itohy }
    399   1.1     itohy 
    400   1.2     itohy int
    401  1.23     skrll umodem_get_caps(struct usbd_device *dev, int *cm, int *acm,
    402   1.1     itohy 		usb_interface_descriptor_t *id)
    403   1.1     itohy {
    404   1.1     itohy 	const usb_cdc_cm_descriptor_t *cmd;
    405   1.1     itohy 	const usb_cdc_acm_descriptor_t *cad;
    406   1.2     itohy 	const usb_cdc_union_descriptor_t *cud;
    407  1.23     skrll 	uint32_t uq_flags;
    408   1.1     itohy 
    409   1.1     itohy 	*cm = *acm = 0;
    410  1.20  christos 	uq_flags = usbd_get_quirks(dev)->uq_flags;
    411   1.1     itohy 
    412  1.20  christos 	if (uq_flags & UQ_NO_UNION_NRM) {
    413  1.18    kardel 		DPRINTF(("umodem_get_caps: NO_UNION_NRM quirk - returning 0\n"));
    414  1.18    kardel 		return 0;
    415  1.18    kardel 	}
    416  1.18    kardel 
    417  1.20  christos 	if (uq_flags & UQ_LOST_CS_DESC)
    418  1.20  christos 		id = NULL;
    419  1.20  christos 
    420   1.5  christos 	cmd = (const usb_cdc_cm_descriptor_t *)usb_find_desc_if(dev,
    421   1.1     itohy 							  UDESC_CS_INTERFACE,
    422   1.1     itohy 							  UDESCSUB_CDC_CM, id);
    423   1.1     itohy 	if (cmd == NULL) {
    424   1.3     itohy 		DPRINTF(("umodem_get_caps: no CM desc\n"));
    425   1.2     itohy 	} else {
    426   1.2     itohy 		*cm = cmd->bmCapabilities;
    427   1.1     itohy 	}
    428   1.1     itohy 
    429   1.5  christos 	cad = (const usb_cdc_acm_descriptor_t *)usb_find_desc_if(dev,
    430   1.1     itohy 							   UDESC_CS_INTERFACE,
    431   1.1     itohy 							   UDESCSUB_CDC_ACM,
    432   1.1     itohy 							   id);
    433   1.1     itohy 	if (cad == NULL) {
    434   1.3     itohy 		DPRINTF(("umodem_get_caps: no ACM desc\n"));
    435   1.2     itohy 	} else {
    436   1.2     itohy 		*acm = cad->bmCapabilities;
    437   1.2     itohy 	}
    438   1.2     itohy 
    439   1.5  christos 	cud = (const usb_cdc_union_descriptor_t *)usb_find_desc_if(dev,
    440   1.2     itohy 							     UDESC_CS_INTERFACE,
    441   1.2     itohy 							     UDESCSUB_CDC_UNION,
    442   1.2     itohy 							     id);
    443   1.2     itohy 	if (cud == NULL) {
    444   1.3     itohy 		DPRINTF(("umodem_get_caps: no UNION desc\n"));
    445   1.1     itohy 	}
    446   1.3     itohy 
    447   1.2     itohy 	return cmd ? cmd->bDataInterface : cud ? cud->bSlaveInterface[0] : -1;
    448   1.1     itohy }
    449   1.1     itohy 
    450   1.1     itohy void
    451   1.9  christos umodem_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
    452   1.1     itohy {
    453   1.1     itohy 	struct umodem_softc *sc = addr;
    454   1.1     itohy 
    455   1.1     itohy 	DPRINTF(("umodem_get_status:\n"));
    456   1.1     itohy 
    457  1.28       mrg 	*lsr = sc->sc_lsr;
    458  1.28       mrg 	*msr = sc->sc_msr;
    459   1.1     itohy }
    460   1.1     itohy 
    461   1.1     itohy int
    462   1.9  christos umodem_param(void *addr, int portno, struct termios *t)
    463   1.1     itohy {
    464   1.1     itohy 	struct umodem_softc *sc = addr;
    465   1.1     itohy 	usbd_status err;
    466   1.1     itohy 	usb_cdc_line_state_t ls;
    467   1.1     itohy 
    468  1.27       mrg 	mutex_enter(&sc->sc_lock);
    469  1.27       mrg 	if (sc->sc_dying)
    470  1.27       mrg 		return EIO;
    471  1.27       mrg 	mutex_exit(&sc->sc_lock);
    472  1.27       mrg 
    473   1.1     itohy 	DPRINTF(("umodem_param: sc=%p\n", sc));
    474   1.1     itohy 
    475   1.1     itohy 	USETDW(ls.dwDTERate, t->c_ospeed);
    476   1.1     itohy 	if (ISSET(t->c_cflag, CSTOPB))
    477   1.1     itohy 		ls.bCharFormat = UCDC_STOP_BIT_2;
    478   1.1     itohy 	else
    479   1.1     itohy 		ls.bCharFormat = UCDC_STOP_BIT_1;
    480   1.1     itohy 	if (ISSET(t->c_cflag, PARENB)) {
    481   1.1     itohy 		if (ISSET(t->c_cflag, PARODD))
    482   1.1     itohy 			ls.bParityType = UCDC_PARITY_ODD;
    483   1.1     itohy 		else
    484   1.1     itohy 			ls.bParityType = UCDC_PARITY_EVEN;
    485   1.1     itohy 	} else
    486   1.1     itohy 		ls.bParityType = UCDC_PARITY_NONE;
    487   1.1     itohy 	switch (ISSET(t->c_cflag, CSIZE)) {
    488   1.1     itohy 	case CS5:
    489   1.1     itohy 		ls.bDataBits = 5;
    490   1.1     itohy 		break;
    491   1.1     itohy 	case CS6:
    492   1.1     itohy 		ls.bDataBits = 6;
    493   1.1     itohy 		break;
    494   1.1     itohy 	case CS7:
    495   1.1     itohy 		ls.bDataBits = 7;
    496   1.1     itohy 		break;
    497   1.1     itohy 	case CS8:
    498   1.1     itohy 		ls.bDataBits = 8;
    499   1.1     itohy 		break;
    500   1.1     itohy 	}
    501   1.1     itohy 
    502   1.1     itohy 	err = umodem_set_line_coding(sc, &ls);
    503   1.1     itohy 	if (err) {
    504   1.1     itohy 		DPRINTF(("umodem_param: err=%s\n", usbd_errstr(err)));
    505  1.23     skrll 		return EPASSTHROUGH;
    506   1.1     itohy 	}
    507  1.23     skrll 	return 0;
    508   1.1     itohy }
    509   1.1     itohy 
    510   1.1     itohy int
    511  1.11  christos umodem_ioctl(void *addr, int portno, u_long cmd, void *data,
    512  1.22    dyoung     int flag, proc_t *p)
    513   1.1     itohy {
    514   1.1     itohy 	struct umodem_softc *sc = addr;
    515   1.1     itohy 	int error = 0;
    516   1.1     itohy 
    517  1.27       mrg 	mutex_enter(&sc->sc_lock);
    518   1.1     itohy 	if (sc->sc_dying)
    519  1.23     skrll 		return EIO;
    520  1.27       mrg 	mutex_exit(&sc->sc_lock);
    521   1.1     itohy 
    522   1.3     itohy 	DPRINTF(("umodem_ioctl: cmd=0x%08lx\n", cmd));
    523   1.1     itohy 
    524   1.1     itohy 	switch (cmd) {
    525   1.1     itohy 	case USB_GET_CM_OVER_DATA:
    526   1.1     itohy 		*(int *)data = sc->sc_cm_over_data;
    527   1.1     itohy 		break;
    528   1.1     itohy 
    529   1.1     itohy 	case USB_SET_CM_OVER_DATA:
    530   1.1     itohy 		if (*(int *)data != sc->sc_cm_over_data) {
    531   1.1     itohy 			/* XXX change it */
    532   1.1     itohy 		}
    533   1.1     itohy 		break;
    534   1.1     itohy 
    535   1.1     itohy 	default:
    536   1.3     itohy 		DPRINTF(("umodem_ioctl: unknown\n"));
    537   1.1     itohy 		error = EPASSTHROUGH;
    538   1.1     itohy 		break;
    539   1.1     itohy 	}
    540   1.1     itohy 
    541  1.23     skrll 	return error;
    542   1.1     itohy }
    543   1.1     itohy 
    544  1.27       mrg static void
    545   1.1     itohy umodem_dtr(struct umodem_softc *sc, int onoff)
    546   1.1     itohy {
    547   1.3     itohy 	DPRINTF(("umodem_dtr: onoff=%d\n", onoff));
    548   1.1     itohy 
    549   1.1     itohy 	if (sc->sc_dtr == onoff)
    550   1.1     itohy 		return;
    551   1.1     itohy 	sc->sc_dtr = onoff;
    552   1.1     itohy 
    553   1.1     itohy 	umodem_set_line_state(sc);
    554   1.1     itohy }
    555   1.1     itohy 
    556  1.27       mrg static void
    557   1.1     itohy umodem_rts(struct umodem_softc *sc, int onoff)
    558   1.1     itohy {
    559   1.3     itohy 	DPRINTF(("umodem_rts: onoff=%d\n", onoff));
    560   1.1     itohy 
    561   1.1     itohy 	if (sc->sc_rts == onoff)
    562   1.1     itohy 		return;
    563   1.1     itohy 	sc->sc_rts = onoff;
    564   1.1     itohy 
    565   1.1     itohy 	umodem_set_line_state(sc);
    566   1.1     itohy }
    567   1.1     itohy 
    568  1.27       mrg static void
    569   1.1     itohy umodem_set_line_state(struct umodem_softc *sc)
    570   1.1     itohy {
    571   1.1     itohy 	usb_device_request_t req;
    572   1.1     itohy 	int ls;
    573   1.1     itohy 
    574   1.1     itohy 	ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
    575   1.1     itohy 	     (sc->sc_rts ? UCDC_LINE_RTS : 0);
    576   1.1     itohy 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    577   1.1     itohy 	req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
    578   1.1     itohy 	USETW(req.wValue, ls);
    579   1.1     itohy 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    580   1.1     itohy 	USETW(req.wLength, 0);
    581   1.1     itohy 
    582   1.1     itohy 	(void)usbd_do_request(sc->sc_udev, &req, 0);
    583   1.1     itohy 
    584   1.1     itohy }
    585   1.1     itohy 
    586  1.27       mrg static void
    587   1.1     itohy umodem_break(struct umodem_softc *sc, int onoff)
    588   1.1     itohy {
    589   1.1     itohy 	usb_device_request_t req;
    590   1.1     itohy 
    591   1.1     itohy 	DPRINTF(("umodem_break: onoff=%d\n", onoff));
    592   1.1     itohy 
    593   1.1     itohy 	if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK))
    594   1.1     itohy 		return;
    595   1.1     itohy 
    596   1.1     itohy 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    597   1.1     itohy 	req.bRequest = UCDC_SEND_BREAK;
    598   1.1     itohy 	USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
    599   1.1     itohy 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    600   1.1     itohy 	USETW(req.wLength, 0);
    601   1.1     itohy 
    602   1.1     itohy 	(void)usbd_do_request(sc->sc_udev, &req, 0);
    603   1.1     itohy }
    604   1.1     itohy 
    605   1.1     itohy void
    606   1.9  christos umodem_set(void *addr, int portno, int reg, int onoff)
    607   1.1     itohy {
    608   1.1     itohy 	struct umodem_softc *sc = addr;
    609   1.1     itohy 
    610  1.27       mrg 	mutex_enter(&sc->sc_lock);
    611  1.27       mrg 	if (sc->sc_dying)
    612  1.27       mrg 		return;
    613  1.27       mrg 	mutex_exit(&sc->sc_lock);
    614  1.27       mrg 
    615   1.1     itohy 	switch (reg) {
    616   1.1     itohy 	case UCOM_SET_DTR:
    617   1.1     itohy 		umodem_dtr(sc, onoff);
    618   1.1     itohy 		break;
    619   1.1     itohy 	case UCOM_SET_RTS:
    620   1.1     itohy 		umodem_rts(sc, onoff);
    621   1.1     itohy 		break;
    622   1.1     itohy 	case UCOM_SET_BREAK:
    623   1.1     itohy 		umodem_break(sc, onoff);
    624   1.1     itohy 		break;
    625   1.1     itohy 	default:
    626   1.1     itohy 		break;
    627   1.1     itohy 	}
    628   1.1     itohy }
    629   1.1     itohy 
    630  1.27       mrg static usbd_status
    631   1.1     itohy umodem_set_line_coding(struct umodem_softc *sc, usb_cdc_line_state_t *state)
    632   1.1     itohy {
    633   1.1     itohy 	usb_device_request_t req;
    634   1.1     itohy 	usbd_status err;
    635   1.1     itohy 
    636   1.1     itohy 	DPRINTF(("umodem_set_line_coding: rate=%d fmt=%d parity=%d bits=%d\n",
    637   1.1     itohy 		 UGETDW(state->dwDTERate), state->bCharFormat,
    638   1.1     itohy 		 state->bParityType, state->bDataBits));
    639   1.1     itohy 
    640   1.1     itohy 	if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
    641   1.1     itohy 		DPRINTF(("umodem_set_line_coding: already set\n"));
    642  1.23     skrll 		return USBD_NORMAL_COMPLETION;
    643   1.1     itohy 	}
    644   1.1     itohy 
    645   1.1     itohy 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    646   1.1     itohy 	req.bRequest = UCDC_SET_LINE_CODING;
    647   1.1     itohy 	USETW(req.wValue, 0);
    648   1.1     itohy 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    649   1.1     itohy 	USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
    650   1.1     itohy 
    651   1.1     itohy 	err = usbd_do_request(sc->sc_udev, &req, state);
    652   1.1     itohy 	if (err) {
    653   1.1     itohy 		DPRINTF(("umodem_set_line_coding: failed, err=%s\n",
    654   1.1     itohy 			 usbd_errstr(err)));
    655  1.23     skrll 		return err;
    656   1.1     itohy 	}
    657   1.1     itohy 
    658   1.1     itohy 	sc->sc_line_state = *state;
    659   1.1     itohy 
    660  1.23     skrll 	return USBD_NORMAL_COMPLETION;
    661   1.1     itohy }
    662   1.1     itohy 
    663  1.27       mrg static usbd_status
    664   1.1     itohy umodem_set_comm_feature(struct umodem_softc *sc, int feature, int state)
    665   1.1     itohy {
    666   1.1     itohy 	usb_device_request_t req;
    667   1.1     itohy 	usbd_status err;
    668   1.1     itohy 	usb_cdc_abstract_state_t ast;
    669   1.1     itohy 
    670   1.1     itohy 	DPRINTF(("umodem_set_comm_feature: feature=%d state=%d\n", feature,
    671   1.1     itohy 		 state));
    672   1.1     itohy 
    673   1.1     itohy 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    674   1.1     itohy 	req.bRequest = UCDC_SET_COMM_FEATURE;
    675   1.1     itohy 	USETW(req.wValue, feature);
    676   1.1     itohy 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    677   1.1     itohy 	USETW(req.wLength, UCDC_ABSTRACT_STATE_LENGTH);
    678   1.1     itohy 	USETW(ast.wState, state);
    679   1.1     itohy 
    680   1.1     itohy 	err = usbd_do_request(sc->sc_udev, &req, &ast);
    681   1.1     itohy 	if (err) {
    682   1.1     itohy 		DPRINTF(("umodem_set_comm_feature: feature=%d, err=%s\n",
    683   1.1     itohy 			 feature, usbd_errstr(err)));
    684  1.23     skrll 		return err;
    685   1.1     itohy 	}
    686   1.1     itohy 
    687  1.23     skrll 	return USBD_NORMAL_COMPLETION;
    688   1.1     itohy }
    689   1.1     itohy 
    690   1.1     itohy int
    691   1.1     itohy umodem_common_activate(struct umodem_softc *sc, enum devact act)
    692   1.1     itohy {
    693   1.1     itohy 	switch (act) {
    694   1.1     itohy 	case DVACT_DEACTIVATE:
    695  1.27       mrg 		mutex_enter(&sc->sc_lock);
    696  1.27       mrg 		sc->sc_dying = true;
    697  1.27       mrg 		mutex_exit(&sc->sc_lock);
    698  1.17    dyoung 		return 0;
    699  1.17    dyoung 	default:
    700  1.17    dyoung 		return EOPNOTSUPP;
    701   1.1     itohy 	}
    702   1.1     itohy }
    703   1.1     itohy 
    704  1.13    dyoung void
    705  1.13    dyoung umodem_common_childdet(struct umodem_softc *sc, device_t child)
    706  1.13    dyoung {
    707  1.13    dyoung 	KASSERT(sc->sc_subdev == child);
    708  1.13    dyoung 	sc->sc_subdev = NULL;
    709  1.13    dyoung }
    710  1.13    dyoung 
    711   1.1     itohy int
    712   1.1     itohy umodem_common_detach(struct umodem_softc *sc, int flags)
    713   1.1     itohy {
    714   1.1     itohy 	int rv = 0;
    715   1.1     itohy 
    716   1.1     itohy 	DPRINTF(("umodem_common_detach: sc=%p flags=%d\n", sc, flags));
    717   1.1     itohy 
    718  1.27       mrg 	mutex_enter(&sc->sc_lock);
    719  1.27       mrg 	sc->sc_dying = true;
    720  1.27       mrg 
    721  1.27       mrg 	sc->sc_refcnt--;
    722  1.27       mrg 	while (sc->sc_refcnt > 0) {
    723  1.27       mrg 		if (cv_timedwait(&sc->sc_detach_cv, &sc->sc_lock, hz * 60))
    724  1.27       mrg 			aprint_error_dev(sc->sc_dev, ": didn't detach\n");
    725  1.27       mrg 	}
    726  1.27       mrg 	mutex_exit(&sc->sc_lock);
    727   1.1     itohy 
    728   1.1     itohy 	if (sc->sc_subdev != NULL)
    729   1.1     itohy 		rv = config_detach(sc->sc_subdev, flags);
    730   1.1     itohy 
    731  1.24   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
    732   1.1     itohy 
    733  1.27       mrg 	mutex_destroy(&sc->sc_lock);
    734  1.27       mrg 	cv_destroy(&sc->sc_detach_cv);
    735  1.27       mrg 
    736  1.23     skrll 	return rv;
    737   1.1     itohy }
    738