Home | History | Annotate | Line # | Download | only in usb
umodem.c revision 1.50
      1  1.50     itohy /*	$NetBSD: umodem.c,v 1.50 2005/04/12 13:12:10 itohy 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.46       wiz  * Comm Class spec:  http://www.usb.org/developers/devclass_docs/usbccs10.pdf
     42  1.46       wiz  *                   http://www.usb.org/developers/devclass_docs/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.50     itohy __KERNEL_RCSID(0, "$NetBSD: umodem.c,v 1.50 2005/04/12 13:12:10 itohy 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 usbd_status umodem_set_comm_feature(struct umodem_softc *sc,
    128  1.29  augustss 					   int feature, int state);
    129  1.29  augustss Static usbd_status umodem_set_line_coding(struct umodem_softc *sc,
    130  1.29  augustss 					  usb_cdc_line_state_t *state);
    131  1.29  augustss 
    132  1.50     itohy Static void	umodem_get_caps(usbd_device_handle, int *, int *,
    133  1.50     itohy 				usb_interface_descriptor_t *);
    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.42  augustss Static int	umodem_ioctl(void *, int, u_long, caddr_t, int, usb_proc_ptr );
    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.50     itohy 	umodem_get_caps(uaa->device, &cm, &acm, id);
    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.49  augustss 	const 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.47    itojun 	usbd_devinfo(uaa->device, 0, devinfo, sizeof(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.50     itohy 	umodem_get_caps(dev, &sc->sc_cm_cap, &sc->sc_acm_cap, id);
    210   1.9  augustss 
    211   1.9  augustss 	/* Get the data interface no. */
    212  1.50     itohy 	cmd = (usb_cdc_cm_descriptor_t *)usb_find_desc_if(dev,
    213  1.50     itohy 							  UDESC_CS_INTERFACE,
    214  1.50     itohy 							  UDESCSUB_CDC_CM, id);
    215  1.18  augustss 	if (cmd == NULL) {
    216  1.20  augustss 		printf("%s: no CM descriptor\n", USBDEVNAME(sc->sc_dev));
    217   1.9  augustss 		goto bad;
    218   1.9  augustss 	}
    219  1.20  augustss 	sc->sc_data_iface_no = data_ifcno = cmd->bDataInterface;
    220   1.9  augustss 
    221   1.9  augustss 	printf("%s: data interface %d, has %sCM over data, has %sbreak\n",
    222  1.20  augustss 	       USBDEVNAME(sc->sc_dev), data_ifcno,
    223   1.9  augustss 	       sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
    224   1.9  augustss 	       sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
    225   1.9  augustss 
    226   1.9  augustss 	/* Get the data interface too. */
    227   1.9  augustss 	for (i = 0; i < uaa->nifaces; i++) {
    228  1.20  augustss 		if (uaa->ifaces[i] != NULL) {
    229   1.9  augustss 			id = usbd_get_interface_descriptor(uaa->ifaces[i]);
    230  1.20  augustss 			if (id != NULL && id->bInterfaceNumber == data_ifcno) {
    231   1.9  augustss 				sc->sc_data_iface = uaa->ifaces[i];
    232  1.20  augustss 				uaa->ifaces[i] = NULL;
    233   1.9  augustss 			}
    234   1.9  augustss 		}
    235   1.9  augustss 	}
    236  1.18  augustss 	if (sc->sc_data_iface == NULL) {
    237   1.9  augustss 		printf("%s: no data interface\n", USBDEVNAME(sc->sc_dev));
    238   1.9  augustss 		goto bad;
    239   1.9  augustss 	}
    240   1.9  augustss 
    241  1.44  augustss 	/*
    242  1.44  augustss 	 * Find the bulk endpoints.
    243   1.9  augustss 	 * Iterate over all endpoints in the data interface and take note.
    244   1.9  augustss 	 */
    245  1.20  augustss 	uca.bulkin = uca.bulkout = -1;
    246   1.9  augustss 
    247   1.9  augustss 	id = usbd_get_interface_descriptor(sc->sc_data_iface);
    248   1.9  augustss 	for (i = 0; i < id->bNumEndpoints; i++) {
    249   1.9  augustss 		ed = usbd_interface2endpoint_descriptor(sc->sc_data_iface, i);
    250  1.18  augustss 		if (ed == NULL) {
    251   1.9  augustss 			printf("%s: no endpoint descriptor for %d\n",
    252   1.9  augustss 				USBDEVNAME(sc->sc_dev), i);
    253   1.9  augustss 			goto bad;
    254   1.9  augustss 		}
    255  1.12  augustss 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    256   1.9  augustss 		    (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    257  1.20  augustss                         uca.bulkin = ed->bEndpointAddress;
    258  1.12  augustss                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    259   1.9  augustss 			   (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
    260  1.20  augustss                         uca.bulkout = ed->bEndpointAddress;
    261   1.9  augustss                 }
    262   1.9  augustss         }
    263   1.9  augustss 
    264  1.20  augustss 	if (uca.bulkin == -1) {
    265  1.20  augustss 		printf("%s: Could not find data bulk in\n",
    266  1.20  augustss 		       USBDEVNAME(sc->sc_dev));
    267   1.9  augustss 		goto bad;
    268   1.9  augustss 	}
    269  1.20  augustss 	if (uca.bulkout == -1) {
    270  1.20  augustss 		printf("%s: Could not find data bulk out\n",
    271  1.20  augustss 			USBDEVNAME(sc->sc_dev));
    272   1.9  augustss 		goto bad;
    273   1.9  augustss 	}
    274   1.9  augustss 
    275  1.36  explorer 	if (usbd_get_quirks(sc->sc_udev)->uq_flags & UQ_ASSUME_CM_OVER_DATA) {
    276  1.36  explorer 		sc->sc_cm_over_data = 1;
    277  1.36  explorer 	} else {
    278  1.36  explorer 		if (sc->sc_cm_cap & USB_CDC_CM_OVER_DATA) {
    279  1.36  explorer 			if (sc->sc_acm_cap & USB_CDC_ACM_HAS_FEATURE)
    280  1.36  explorer 				err = umodem_set_comm_feature(sc,
    281  1.36  explorer 				    UCDC_ABSTRACT_STATE, UCDC_DATA_MULTIPLEXED);
    282  1.36  explorer 			else
    283  1.36  explorer 				err = 0;
    284  1.36  explorer 			if (err) {
    285  1.36  explorer 				printf("%s: could not set data multiplex mode\n",
    286  1.36  explorer 				       USBDEVNAME(sc->sc_dev));
    287  1.36  explorer 				goto bad;
    288  1.36  explorer 			}
    289  1.36  explorer 			sc->sc_cm_over_data = 1;
    290  1.34  augustss 		}
    291   1.9  augustss 	}
    292  1.39      kenh 
    293  1.39      kenh 	/*
    294  1.39      kenh 	 * The standard allows for notification messages (to indicate things
    295  1.39      kenh 	 * like a modem hangup) to come in via an interrupt endpoint
    296  1.40  augustss 	 * off of the control interface.  Iterate over the endpoints on
    297  1.39      kenh 	 * the control interface and see if there are any interrupt
    298  1.39      kenh 	 * endpoints; if there are, then register it.
    299  1.39      kenh 	 */
    300  1.39      kenh 
    301  1.39      kenh 	sc->sc_ctl_notify = -1;
    302  1.39      kenh 	sc->sc_notify_pipe = NULL;
    303  1.39      kenh 
    304  1.39      kenh 	for (i = 0; i < id->bNumEndpoints; i++) {
    305  1.39      kenh 		ed = usbd_interface2endpoint_descriptor(sc->sc_ctl_iface, i);
    306  1.39      kenh 		if (ed == NULL)
    307  1.39      kenh 			continue;
    308  1.39      kenh 
    309  1.39      kenh 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    310  1.39      kenh 		    (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
    311  1.39      kenh 			printf("%s: status change notification available\n",
    312  1.39      kenh 			       USBDEVNAME(sc->sc_dev));
    313  1.39      kenh 			sc->sc_ctl_notify = ed->bEndpointAddress;
    314  1.39      kenh 		}
    315  1.39      kenh 	}
    316  1.39      kenh 
    317  1.20  augustss 	sc->sc_dtr = -1;
    318   1.9  augustss 
    319  1.20  augustss 	uca.portno = UCOM_UNK_PORTNO;
    320  1.20  augustss 	/* bulkin, bulkout set above */
    321  1.26  augustss 	uca.ibufsize = UMODEMIBUFSIZE;
    322  1.26  augustss 	uca.obufsize = UMODEMOBUFSIZE;
    323  1.27  augustss 	uca.ibufsizepad = UMODEMIBUFSIZE;
    324  1.30  augustss 	uca.opkthdrlen = 0;
    325  1.20  augustss 	uca.device = sc->sc_udev;
    326  1.20  augustss 	uca.iface = sc->sc_data_iface;
    327  1.20  augustss 	uca.methods = &umodem_methods;
    328  1.20  augustss 	uca.arg = sc;
    329  1.38  augustss 	uca.info = NULL;
    330  1.20  augustss 
    331  1.37  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
    332  1.37  augustss 			   USBDEV(sc->sc_dev));
    333  1.37  augustss 
    334  1.20  augustss 	DPRINTF(("umodem_attach: sc=%p\n", sc));
    335  1.48  drochner 	sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca,
    336  1.48  drochner 					    ucomprint, ucomsubmatch);
    337  1.21  augustss 
    338   1.3  augustss 	USB_ATTACH_SUCCESS_RETURN;
    339   1.9  augustss 
    340   1.9  augustss  bad:
    341   1.9  augustss 	sc->sc_dying = 1;
    342   1.9  augustss 	USB_ATTACH_ERROR_RETURN;
    343   1.1  augustss }
    344   1.3  augustss 
    345  1.39      kenh Static int
    346  1.39      kenh umodem_open(void *addr, int portno)
    347  1.39      kenh {
    348  1.39      kenh 	struct umodem_softc *sc = addr;
    349  1.39      kenh 	int err;
    350  1.39      kenh 
    351  1.39      kenh 	DPRINTF(("umodem_open: sc=%p\n", sc));
    352  1.39      kenh 
    353  1.39      kenh 	if (sc->sc_ctl_notify != -1 && sc->sc_notify_pipe == NULL) {
    354  1.39      kenh 		err = usbd_open_pipe_intr(sc->sc_ctl_iface, sc->sc_ctl_notify,
    355  1.39      kenh 		    USBD_SHORT_XFER_OK, &sc->sc_notify_pipe, sc,
    356  1.39      kenh 		    &sc->sc_notify_buf, sizeof(sc->sc_notify_buf),
    357  1.39      kenh 		    umodem_intr, USBD_DEFAULT_INTERVAL);
    358  1.39      kenh 
    359  1.39      kenh 		if (err) {
    360  1.39      kenh 			DPRINTF(("Failed to establish notify pipe: %s\n",
    361  1.39      kenh 				usbd_errstr(err)));
    362  1.39      kenh 			return EIO;
    363  1.39      kenh 		}
    364  1.39      kenh 	}
    365  1.39      kenh 
    366  1.39      kenh 	return 0;
    367  1.39      kenh }
    368  1.39      kenh 
    369  1.39      kenh Static void
    370  1.39      kenh umodem_close(void *addr, int portno)
    371  1.39      kenh {
    372  1.39      kenh 	struct umodem_softc *sc = addr;
    373  1.39      kenh 	int err;
    374  1.39      kenh 
    375  1.39      kenh 	DPRINTF(("umodem_close: sc=%p\n", sc));
    376  1.39      kenh 
    377  1.39      kenh 	if (sc->sc_notify_pipe != NULL) {
    378  1.39      kenh 		err = usbd_abort_pipe(sc->sc_notify_pipe);
    379  1.39      kenh 		if (err)
    380  1.39      kenh 			printf("%s: abort notify pipe failed: %s\n",
    381  1.39      kenh 			    USBDEVNAME(sc->sc_dev), usbd_errstr(err));
    382  1.39      kenh 		err = usbd_close_pipe(sc->sc_notify_pipe);
    383  1.39      kenh 		if (err)
    384  1.39      kenh 			printf("%s: close notify pipe failed: %s\n",
    385  1.39      kenh 			    USBDEVNAME(sc->sc_dev), usbd_errstr(err));
    386  1.39      kenh 		sc->sc_notify_pipe = NULL;
    387  1.39      kenh 	}
    388  1.39      kenh }
    389  1.39      kenh 
    390  1.39      kenh Static void
    391  1.39      kenh umodem_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
    392  1.39      kenh {
    393  1.39      kenh 	struct umodem_softc *sc = priv;
    394  1.39      kenh 	u_char mstatus;
    395  1.39      kenh 
    396  1.39      kenh 	if (sc->sc_dying)
    397  1.39      kenh 		return;
    398  1.39      kenh 
    399  1.39      kenh 	if (status != USBD_NORMAL_COMPLETION) {
    400  1.39      kenh 		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
    401  1.39      kenh 			return;
    402  1.39      kenh 		printf("%s: abnormal status: %s\n", USBDEVNAME(sc->sc_dev),
    403  1.39      kenh 		       usbd_errstr(status));
    404  1.39      kenh 		return;
    405  1.39      kenh 	}
    406  1.39      kenh 
    407  1.40  augustss 	if (sc->sc_notify_buf.bmRequestType != UCDC_NOTIFICATION) {
    408  1.39      kenh 		DPRINTF(("%s: unknown message type (%02x) on notify pipe\n",
    409  1.39      kenh 			 USBDEVNAME(sc->sc_dev),
    410  1.39      kenh 			 sc->sc_notify_buf.bmRequestType));
    411  1.40  augustss 		return;
    412  1.40  augustss 	}
    413  1.39      kenh 
    414  1.40  augustss 	switch (sc->sc_notify_buf.bNotification) {
    415  1.40  augustss 	case UCDC_N_SERIAL_STATE:
    416  1.40  augustss 		/*
    417  1.40  augustss 		 * Set the serial state in ucom driver based on
    418  1.40  augustss 		 * the bits from the notify message
    419  1.40  augustss 		 */
    420  1.40  augustss 		if (UGETW(sc->sc_notify_buf.wLength) != 2) {
    421  1.40  augustss 			printf("%s: Invalid notification length! (%d)\n",
    422  1.40  augustss 			       USBDEVNAME(sc->sc_dev),
    423  1.40  augustss 			       UGETW(sc->sc_notify_buf.wLength));
    424  1.40  augustss 			break;
    425  1.40  augustss 		}
    426  1.40  augustss 		DPRINTF(("%s: notify bytes = %02x%02x\n",
    427  1.40  augustss 			 USBDEVNAME(sc->sc_dev),
    428  1.40  augustss 			 sc->sc_notify_buf.data[0],
    429  1.40  augustss 			 sc->sc_notify_buf.data[1]));
    430  1.40  augustss 		/* Currently, lsr is always zero. */
    431  1.40  augustss 		sc->sc_lsr = sc->sc_msr = 0;
    432  1.40  augustss 		mstatus = sc->sc_notify_buf.data[0];
    433  1.44  augustss 
    434  1.40  augustss 		if (ISSET(mstatus, UCDC_N_SERIAL_RI))
    435  1.40  augustss 			sc->sc_msr |= UMSR_RI;
    436  1.40  augustss 		if (ISSET(mstatus, UCDC_N_SERIAL_DSR))
    437  1.40  augustss 			sc->sc_msr |= UMSR_DSR;
    438  1.40  augustss 		if (ISSET(mstatus, UCDC_N_SERIAL_DCD))
    439  1.40  augustss 			sc->sc_msr |= UMSR_DCD;
    440  1.40  augustss 		ucom_status_change((struct ucom_softc *)sc->sc_subdev);
    441  1.40  augustss 		break;
    442  1.40  augustss 	default:
    443  1.40  augustss 		DPRINTF(("%s: unknown notify message: %02x\n",
    444  1.40  augustss 			 USBDEVNAME(sc->sc_dev),
    445  1.40  augustss 			 sc->sc_notify_buf.bNotification));
    446  1.40  augustss 		break;
    447  1.40  augustss 	}
    448  1.39      kenh }
    449  1.39      kenh 
    450   1.9  augustss void
    451  1.50     itohy umodem_get_caps(usbd_device_handle dev, int *cm, int *acm,
    452  1.50     itohy 		usb_interface_descriptor_t *id)
    453   1.9  augustss {
    454  1.49  augustss 	const usb_cdc_cm_descriptor_t *cmd;
    455  1.49  augustss 	const usb_cdc_acm_descriptor_t *cad;
    456   1.9  augustss 
    457   1.9  augustss 	*cm = *acm = 0;
    458   1.9  augustss 
    459  1.50     itohy 	cmd = (usb_cdc_cm_descriptor_t *)usb_find_desc_if(dev,
    460  1.50     itohy 							  UDESC_CS_INTERFACE,
    461  1.50     itohy 							  UDESCSUB_CDC_CM, id);
    462  1.20  augustss 	if (cmd == NULL) {
    463   1.9  augustss 		DPRINTF(("umodem_get_desc: no CM desc\n"));
    464   1.9  augustss 		return;
    465   1.9  augustss 	}
    466   1.9  augustss 	*cm = cmd->bmCapabilities;
    467   1.9  augustss 
    468  1.50     itohy 	cad = (usb_cdc_acm_descriptor_t *)usb_find_desc_if(dev,
    469  1.50     itohy 							   UDESC_CS_INTERFACE,
    470  1.50     itohy 							   UDESCSUB_CDC_ACM,
    471  1.50     itohy 							   id);
    472  1.20  augustss 	if (cad == NULL) {
    473   1.9  augustss 		DPRINTF(("umodem_get_desc: no ACM desc\n"));
    474   1.9  augustss 		return;
    475   1.9  augustss 	}
    476   1.9  augustss 	*acm = cad->bmCapabilities;
    477  1.44  augustss }
    478   1.9  augustss 
    479   1.9  augustss void
    480  1.29  augustss umodem_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
    481  1.20  augustss {
    482  1.39      kenh 	struct umodem_softc *sc = addr;
    483  1.39      kenh 
    484  1.20  augustss 	DPRINTF(("umodem_get_status:\n"));
    485  1.20  augustss 
    486  1.20  augustss 	if (lsr != NULL)
    487  1.39      kenh 		*lsr = sc->sc_lsr;
    488  1.20  augustss 	if (msr != NULL)
    489  1.39      kenh 		*msr = sc->sc_msr;
    490   1.9  augustss }
    491   1.9  augustss 
    492   1.9  augustss int
    493  1.29  augustss umodem_param(void *addr, int portno, struct termios *t)
    494   1.9  augustss {
    495  1.20  augustss 	struct umodem_softc *sc = addr;
    496  1.20  augustss 	usbd_status err;
    497   1.9  augustss 	usb_cdc_line_state_t ls;
    498   1.9  augustss 
    499  1.20  augustss 	DPRINTF(("umodem_param: sc=%p\n", sc));
    500   1.9  augustss 
    501   1.9  augustss 	USETDW(ls.dwDTERate, t->c_ospeed);
    502   1.9  augustss 	if (ISSET(t->c_cflag, CSTOPB))
    503   1.9  augustss 		ls.bCharFormat = UCDC_STOP_BIT_2;
    504   1.9  augustss 	else
    505   1.9  augustss 		ls.bCharFormat = UCDC_STOP_BIT_1;
    506   1.9  augustss 	if (ISSET(t->c_cflag, PARENB)) {
    507   1.9  augustss 		if (ISSET(t->c_cflag, PARODD))
    508   1.9  augustss 			ls.bParityType = UCDC_PARITY_ODD;
    509   1.9  augustss 		else
    510   1.9  augustss 			ls.bParityType = UCDC_PARITY_EVEN;
    511   1.9  augustss 	} else
    512   1.9  augustss 		ls.bParityType = UCDC_PARITY_NONE;
    513   1.9  augustss 	switch (ISSET(t->c_cflag, CSIZE)) {
    514   1.9  augustss 	case CS5:
    515   1.9  augustss 		ls.bDataBits = 5;
    516   1.9  augustss 		break;
    517   1.9  augustss 	case CS6:
    518   1.9  augustss 		ls.bDataBits = 6;
    519   1.9  augustss 		break;
    520   1.9  augustss 	case CS7:
    521   1.9  augustss 		ls.bDataBits = 7;
    522   1.9  augustss 		break;
    523   1.9  augustss 	case CS8:
    524   1.9  augustss 		ls.bDataBits = 8;
    525   1.9  augustss 		break;
    526   1.9  augustss 	}
    527   1.9  augustss 
    528  1.20  augustss 	err = umodem_set_line_coding(sc, &ls);
    529  1.20  augustss 	if (err) {
    530  1.20  augustss 		DPRINTF(("umodem_param: err=%s\n", usbd_errstr(err)));
    531  1.43    atatat 		return (EPASSTHROUGH);
    532   1.9  augustss 	}
    533   1.9  augustss 	return (0);
    534   1.9  augustss }
    535   1.9  augustss 
    536   1.9  augustss int
    537  1.29  augustss umodem_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag,
    538  1.42  augustss 	     usb_proc_ptr p)
    539   1.9  augustss {
    540  1.20  augustss 	struct umodem_softc *sc = addr;
    541  1.24  augustss 	int error = 0;
    542   1.9  augustss 
    543   1.9  augustss 	if (sc->sc_dying)
    544   1.9  augustss 		return (EIO);
    545  1.44  augustss 
    546   1.9  augustss 	DPRINTF(("umodemioctl: cmd=0x%08lx\n", cmd));
    547   1.9  augustss 
    548   1.9  augustss 	switch (cmd) {
    549   1.9  augustss 	case USB_GET_CM_OVER_DATA:
    550   1.9  augustss 		*(int *)data = sc->sc_cm_over_data;
    551   1.9  augustss 		break;
    552   1.9  augustss 
    553   1.9  augustss 	case USB_SET_CM_OVER_DATA:
    554   1.9  augustss 		if (*(int *)data != sc->sc_cm_over_data) {
    555   1.9  augustss 			/* XXX change it */
    556   1.9  augustss 		}
    557   1.9  augustss 		break;
    558   1.9  augustss 
    559   1.9  augustss 	default:
    560   1.9  augustss 		DPRINTF(("umodemioctl: unknown\n"));
    561  1.43    atatat 		error = EPASSTHROUGH;
    562   1.9  augustss 		break;
    563   1.9  augustss 	}
    564   1.9  augustss 
    565   1.9  augustss 	return (error);
    566   1.9  augustss }
    567   1.9  augustss 
    568   1.9  augustss void
    569  1.29  augustss umodem_dtr(struct umodem_softc *sc, int onoff)
    570   1.9  augustss {
    571  1.20  augustss 	DPRINTF(("umodem_modem: onoff=%d\n", onoff));
    572   1.9  augustss 
    573  1.20  augustss 	if (sc->sc_dtr == onoff)
    574  1.20  augustss 		return;
    575  1.20  augustss 	sc->sc_dtr = onoff;
    576  1.20  augustss 
    577  1.20  augustss 	umodem_set_line_state(sc);
    578   1.9  augustss }
    579   1.9  augustss 
    580   1.9  augustss void
    581  1.29  augustss umodem_rts(struct umodem_softc *sc, int onoff)
    582   1.9  augustss {
    583   1.9  augustss 	DPRINTF(("umodem_modem: onoff=%d\n", onoff));
    584   1.9  augustss 
    585  1.20  augustss 	if (sc->sc_rts == onoff)
    586   1.9  augustss 		return;
    587  1.20  augustss 	sc->sc_rts = onoff;
    588  1.20  augustss 
    589  1.20  augustss 	umodem_set_line_state(sc);
    590  1.20  augustss }
    591   1.9  augustss 
    592  1.20  augustss void
    593  1.29  augustss umodem_set_line_state(struct umodem_softc *sc)
    594  1.20  augustss {
    595  1.20  augustss 	usb_device_request_t req;
    596  1.20  augustss 	int ls;
    597  1.20  augustss 
    598  1.20  augustss 	ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
    599  1.20  augustss 	     (sc->sc_rts ? UCDC_LINE_RTS : 0);
    600   1.9  augustss 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    601   1.9  augustss 	req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
    602  1.20  augustss 	USETW(req.wValue, ls);
    603   1.9  augustss 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    604   1.9  augustss 	USETW(req.wLength, 0);
    605   1.9  augustss 
    606   1.9  augustss 	(void)usbd_do_request(sc->sc_udev, &req, 0);
    607   1.9  augustss 
    608   1.9  augustss }
    609   1.9  augustss 
    610   1.9  augustss void
    611  1.29  augustss umodem_break(struct umodem_softc *sc, int onoff)
    612   1.9  augustss {
    613   1.9  augustss 	usb_device_request_t req;
    614   1.9  augustss 
    615   1.9  augustss 	DPRINTF(("umodem_break: onoff=%d\n", onoff));
    616   1.9  augustss 
    617   1.9  augustss 	if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK))
    618   1.9  augustss 		return;
    619   1.9  augustss 
    620   1.9  augustss 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    621   1.9  augustss 	req.bRequest = UCDC_SEND_BREAK;
    622   1.9  augustss 	USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
    623   1.9  augustss 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    624   1.9  augustss 	USETW(req.wLength, 0);
    625   1.9  augustss 
    626   1.9  augustss 	(void)usbd_do_request(sc->sc_udev, &req, 0);
    627   1.9  augustss }
    628   1.9  augustss 
    629  1.20  augustss void
    630  1.29  augustss umodem_set(void *addr, int portno, int reg, int onoff)
    631  1.20  augustss {
    632  1.20  augustss 	struct umodem_softc *sc = addr;
    633  1.20  augustss 
    634  1.20  augustss 	switch (reg) {
    635  1.20  augustss 	case UCOM_SET_DTR:
    636  1.20  augustss 		umodem_dtr(sc, onoff);
    637  1.20  augustss 		break;
    638  1.20  augustss 	case UCOM_SET_RTS:
    639  1.20  augustss 		umodem_rts(sc, onoff);
    640  1.20  augustss 		break;
    641  1.20  augustss 	case UCOM_SET_BREAK:
    642  1.20  augustss 		umodem_break(sc, onoff);
    643  1.20  augustss 		break;
    644  1.20  augustss 	default:
    645  1.20  augustss 		break;
    646  1.20  augustss 	}
    647  1.20  augustss }
    648  1.20  augustss 
    649  1.20  augustss usbd_status
    650  1.29  augustss umodem_set_line_coding(struct umodem_softc *sc, usb_cdc_line_state_t *state)
    651  1.20  augustss {
    652  1.20  augustss 	usb_device_request_t req;
    653  1.20  augustss 	usbd_status err;
    654  1.20  augustss 
    655  1.20  augustss 	DPRINTF(("umodem_set_line_coding: rate=%d fmt=%d parity=%d bits=%d\n",
    656  1.20  augustss 		 UGETDW(state->dwDTERate), state->bCharFormat,
    657  1.20  augustss 		 state->bParityType, state->bDataBits));
    658  1.20  augustss 
    659  1.20  augustss 	if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
    660  1.20  augustss 		DPRINTF(("umodem_set_line_coding: already set\n"));
    661  1.20  augustss 		return (USBD_NORMAL_COMPLETION);
    662  1.20  augustss 	}
    663  1.20  augustss 
    664  1.20  augustss 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    665  1.20  augustss 	req.bRequest = UCDC_SET_LINE_CODING;
    666  1.20  augustss 	USETW(req.wValue, 0);
    667  1.20  augustss 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    668  1.20  augustss 	USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
    669  1.20  augustss 
    670  1.20  augustss 	err = usbd_do_request(sc->sc_udev, &req, state);
    671  1.20  augustss 	if (err) {
    672  1.44  augustss 		DPRINTF(("umodem_set_line_coding: failed, err=%s\n",
    673  1.20  augustss 			 usbd_errstr(err)));
    674  1.20  augustss 		return (err);
    675  1.20  augustss 	}
    676  1.20  augustss 
    677  1.20  augustss 	sc->sc_line_state = *state;
    678  1.20  augustss 
    679  1.20  augustss 	return (USBD_NORMAL_COMPLETION);
    680  1.20  augustss }
    681  1.20  augustss 
    682   1.9  augustss usbd_status
    683  1.29  augustss umodem_set_comm_feature(struct umodem_softc *sc, int feature, int state)
    684   1.9  augustss {
    685   1.9  augustss 	usb_device_request_t req;
    686  1.18  augustss 	usbd_status err;
    687   1.9  augustss 	usb_cdc_abstract_state_t ast;
    688   1.9  augustss 
    689  1.20  augustss 	DPRINTF(("umodem_set_comm_feature: feature=%d state=%d\n", feature,
    690  1.20  augustss 		 state));
    691  1.20  augustss 
    692   1.9  augustss 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
    693   1.9  augustss 	req.bRequest = UCDC_SET_COMM_FEATURE;
    694   1.9  augustss 	USETW(req.wValue, feature);
    695   1.9  augustss 	USETW(req.wIndex, sc->sc_ctl_iface_no);
    696   1.9  augustss 	USETW(req.wLength, UCDC_ABSTRACT_STATE_LENGTH);
    697   1.9  augustss 	USETW(ast.wState, state);
    698   1.9  augustss 
    699  1.18  augustss 	err = usbd_do_request(sc->sc_udev, &req, &ast);
    700  1.18  augustss 	if (err) {
    701  1.20  augustss 		DPRINTF(("umodem_set_comm_feature: feature=%d, err=%s\n",
    702  1.20  augustss 			 feature, usbd_errstr(err)));
    703  1.18  augustss 		return (err);
    704   1.9  augustss 	}
    705   1.9  augustss 
    706   1.9  augustss 	return (USBD_NORMAL_COMPLETION);
    707   1.9  augustss }
    708   1.9  augustss 
    709   1.9  augustss int
    710  1.29  augustss umodem_activate(device_ptr_t self, enum devact act)
    711   1.9  augustss {
    712   1.9  augustss 	struct umodem_softc *sc = (struct umodem_softc *)self;
    713  1.20  augustss 	int rv = 0;
    714   1.9  augustss 
    715   1.9  augustss 	switch (act) {
    716   1.9  augustss 	case DVACT_ACTIVATE:
    717   1.9  augustss 		return (EOPNOTSUPP);
    718   1.9  augustss 
    719   1.9  augustss 	case DVACT_DEACTIVATE:
    720   1.9  augustss 		sc->sc_dying = 1;
    721  1.20  augustss 		if (sc->sc_subdev)
    722  1.20  augustss 			rv = config_deactivate(sc->sc_subdev);
    723   1.9  augustss 		break;
    724   1.9  augustss 	}
    725  1.20  augustss 	return (rv);
    726   1.9  augustss }
    727   1.9  augustss 
    728  1.21  augustss USB_DETACH(umodem)
    729   1.9  augustss {
    730  1.21  augustss 	USB_DETACH_START(umodem, sc);
    731  1.20  augustss 	int rv = 0;
    732   1.9  augustss 
    733  1.20  augustss 	DPRINTF(("umodem_detach: sc=%p flags=%d\n", sc, flags));
    734   1.9  augustss 
    735   1.9  augustss 	sc->sc_dying = 1;
    736   1.9  augustss 
    737  1.20  augustss 	if (sc->sc_subdev != NULL)
    738  1.20  augustss 		rv = config_detach(sc->sc_subdev, flags);
    739  1.21  augustss 
    740  1.21  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
    741  1.21  augustss 			   USBDEV(sc->sc_dev));
    742   1.9  augustss 
    743  1.20  augustss 	return (rv);
    744   1.9  augustss }
    745