xref: /netbsd-src/sys/dev/usb/umodem.c (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: umodem.c,v 1.59 2008/06/27 16:05:59 drochner Exp $	*/
2 
3 /*
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net) at
9  * Carlstedt Research & Technology.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Comm Class spec:  http://www.usb.org/developers/devclass_docs/usbccs10.pdf
35  *                   http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
36  */
37 
38 /*
39  * TODO:
40  * - Add error recovery in various places; the big problem is what
41  *   to do in a callback if there is an error.
42  * - Implement a Call Device for modems without multiplexed commands.
43  *
44  */
45 
46 #include <sys/cdefs.h>
47 __KERNEL_RCSID(0, "$NetBSD: umodem.c,v 1.59 2008/06/27 16:05:59 drochner Exp $");
48 
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/ioctl.h>
53 #include <sys/conf.h>
54 #include <sys/tty.h>
55 #include <sys/file.h>
56 #include <sys/select.h>
57 #include <sys/proc.h>
58 #include <sys/vnode.h>
59 #include <sys/device.h>
60 #include <sys/poll.h>
61 
62 #include <dev/usb/usb.h>
63 #include <dev/usb/usbcdc.h>
64 
65 #include <dev/usb/usbdi.h>
66 #include <dev/usb/usbdi_util.h>
67 #include <dev/usb/usbdevs.h>
68 #include <dev/usb/usb_quirks.h>
69 
70 #include <dev/usb/ucomvar.h>
71 #include <dev/usb/umodemvar.h>
72 
73 Static struct ucom_methods umodem_methods = {
74 	umodem_get_status,
75 	umodem_set,
76 	umodem_param,
77 	umodem_ioctl,
78 	umodem_open,
79 	umodem_close,
80 	NULL,
81 	NULL,
82 };
83 
84 USB_DECLARE_DRIVER(umodem);
85 
86 USB_MATCH(umodem)
87 {
88 	USB_IFMATCH_START(umodem, uaa);
89 	usb_interface_descriptor_t *id;
90 	int cm, acm;
91 
92 	if (uaa->class != UICLASS_CDC ||
93 	    uaa->subclass != UISUBCLASS_ABSTRACT_CONTROL_MODEL ||
94 	    uaa->proto != UIPROTO_CDC_AT)
95 		return (UMATCH_NONE);
96 
97 	id = usbd_get_interface_descriptor(uaa->iface);
98 	if (umodem_get_caps(uaa->device, &cm, &acm, id) == -1)
99 		return (UMATCH_NONE);
100 
101 	return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
102 }
103 
104 USB_ATTACH(umodem)
105 {
106 	USB_IFATTACH_START(umodem, sc, uaa);
107 	struct ucom_attach_args uca;
108 
109 	uca.portno = UCOM_UNK_PORTNO;
110 	uca.methods = &umodem_methods;
111 	uca.info = NULL;
112 
113 	if (umodem_common_attach(self, sc, uaa, &uca))
114 		USB_ATTACH_ERROR_RETURN;
115 	USB_ATTACH_SUCCESS_RETURN;
116 }
117 
118 int
119 umodem_activate(device_ptr_t self, enum devact act)
120 {
121 	struct umodem_softc *sc = device_private(self);
122 
123 	return umodem_common_activate(sc, act);
124 }
125 
126 USB_DETACH(umodem)
127 {
128 	USB_DETACH_START(umodem, sc);
129 #ifdef __FreeBSD__
130 	int flags = 0;
131 #endif
132 
133 	return umodem_common_detach(sc, flags);
134 }
135