xref: /netbsd-src/sys/dev/usb/umodem.c (revision deb6f0161a9109e7de9b519dc8dfb9478668dcdd)
1 /*	$NetBSD: umodem.c,v 1.69 2016/07/07 06:55:42 msaitoh 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.69 2016/07/07 06:55:42 msaitoh 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 	.ucom_get_status = umodem_get_status,
75 	.ucom_set = umodem_set,
76 	.ucom_param = umodem_param,
77 	.ucom_ioctl = umodem_ioctl,
78 	.ucom_open = umodem_open,
79 	.ucom_close = umodem_close,
80 	.ucom_read = NULL,
81 	.ucom_write = NULL,
82 };
83 
84 int	umodem_match(device_t, cfdata_t, void *);
85 void	umodem_attach(device_t, device_t, void *);
86 int	umodem_detach(device_t, int);
87 int	umodem_activate(device_t, enum devact);
88 
89 extern struct cfdriver umodem_cd;
90 
91 CFATTACH_DECL_NEW(umodem, sizeof(struct umodem_softc), umodem_match,
92     umodem_attach, umodem_detach, umodem_activate);
93 
94 int
95 umodem_match(device_t parent, cfdata_t match, void *aux)
96 {
97 	struct usbif_attach_arg *uiaa = aux;
98 	usb_interface_descriptor_t *id;
99 	int cm, acm;
100 
101 	if (uiaa->uiaa_class != UICLASS_CDC ||
102 	    uiaa->uiaa_subclass != UISUBCLASS_ABSTRACT_CONTROL_MODEL ||
103 	    !(uiaa->uiaa_proto == UIPROTO_CDC_NOCLASS || uiaa->uiaa_proto == UIPROTO_CDC_AT))
104 		return UMATCH_NONE;
105 
106 	id = usbd_get_interface_descriptor(uiaa->uiaa_iface);
107 	if (umodem_get_caps(uiaa->uiaa_device, &cm, &acm, id) == -1)
108 		return UMATCH_NONE;
109 
110 	return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO;
111 }
112 //
113 void
114 umodem_attach(device_t parent, device_t self, void *aux)
115 {
116 	struct umodem_softc *sc = device_private(self);
117 	struct usbif_attach_arg *uiaa = aux;
118 	struct ucom_attach_args ucaa;
119 
120 	ucaa.ucaa_portno = UCOM_UNK_PORTNO;
121 	ucaa.ucaa_methods = &umodem_methods;
122 	ucaa.ucaa_info = NULL;
123 
124 	if (!pmf_device_register(self, NULL, NULL))
125 		aprint_error_dev(self, "couldn't establish power handler");
126 
127 	if (umodem_common_attach(self, sc, uiaa, &ucaa))
128 		return;
129 	return;
130 }
131 
132 int
133 umodem_activate(device_t self, enum devact act)
134 {
135 	struct umodem_softc *sc = device_private(self);
136 
137 	return umodem_common_activate(sc, act);
138 }
139 
140 int
141 umodem_detach(device_t self, int flags)
142 {
143 	struct umodem_softc *sc = device_private(self);
144 
145 	pmf_device_deregister(self);
146 
147 	return umodem_common_detach(sc, flags);
148 }
149