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