sys/dev/usbmisc/umodem/umodem.c

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