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