xref: /netbsd-src/sys/dev/usb/ukyopon.c (revision e6c7e151de239c49d2e38720a061ed9d1fa99309)
1 /*	$NetBSD: ukyopon.c,v 1.25 2020/01/07 06:42:26 maxv Exp $	*/
2 
3 /*
4  * Copyright (c) 1998, 2005 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  * This code is derived from software contributed to The NetBSD Foundation
12  * by ITOH Yasufumi.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #include <sys/cdefs.h>
37 __KERNEL_RCSID(0, "$NetBSD: ukyopon.c,v 1.25 2020/01/07 06:42:26 maxv Exp $");
38 
39 #ifdef _KERNEL_OPT
40 #include "opt_usb.h"
41 #endif
42 
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/kernel.h>
46 #include <sys/ioctl.h>
47 #include <sys/conf.h>
48 #include <sys/tty.h>
49 #include <sys/file.h>
50 #include <sys/select.h>
51 #include <sys/proc.h>
52 #include <sys/vnode.h>
53 #include <sys/device.h>
54 #include <sys/poll.h>
55 
56 #include <sys/bus.h>
57 
58 #include <dev/usb/usb.h>
59 #include <dev/usb/usbcdc.h>
60 
61 #include <dev/usb/usbdi.h>
62 #include <dev/usb/usbdi_util.h>
63 #include <dev/usb/usbdivar.h>
64 #include <dev/usb/usbdevs.h>
65 #include <dev/usb/usb_quirks.h>
66 
67 #include <dev/usb/ucomvar.h>
68 #include <dev/usb/umodemvar.h>
69 #include <dev/usb/ukyopon.h>
70 
71 #ifdef UKYOPON_DEBUG
72 #define DPRINTFN(n, x)	if (ukyopondebug > (n)) printf x
73 int	ukyopondebug = 0;
74 #else
75 #define DPRINTFN(n, x)
76 #endif
77 #define DPRINTF(x) DPRINTFN(0, x)
78 
79 struct ukyopon_softc {
80 	/* generic umodem device */
81 	struct umodem_softc	sc_umodem;
82 
83 	/* ukyopon addition */
84 };
85 
86 #define UKYOPON_MODEM_IFACE_INDEX	0
87 #define UKYOPON_DATA_IFACE_INDEX	3
88 
89 static void	ukyopon_get_status(void *, int, u_char *, u_char *);
90 static int	ukyopon_ioctl(void *, int, u_long, void *, int, proc_t *);
91 static void	ukyopon_set(void *, int, int, int);
92 static int	ukyopon_param(void *, int, struct termios *);
93 static int	ukyopon_open(void *, int);
94 static void	ukyopon_close(void *, int);
95 
96 static const struct ucom_methods ukyopon_methods = {
97 	.ucom_get_status = ukyopon_get_status,
98 	.ucom_set = ukyopon_set,
99 	.ucom_param = ukyopon_param,
100 	.ucom_ioctl = ukyopon_ioctl,
101 	.ucom_open = ukyopon_open,
102 	.ucom_close = ukyopon_close,
103 };
104 
105 static int	ukyopon_match(device_t, cfdata_t, void *);
106 static void	ukyopon_attach(device_t, device_t, void *);
107 static int	ukyopon_detach(device_t, int);
108 
109 CFATTACH_DECL_NEW(ukyopon, sizeof(struct ukyopon_softc), ukyopon_match,
110     ukyopon_attach, ukyopon_detach, NULL);
111 
112 static int
113 ukyopon_match(device_t parent, cfdata_t match, void *aux)
114 {
115 	struct usbif_attach_arg *uiaa = aux;
116 
117 	if (uiaa->uiaa_vendor == USB_VENDOR_KYOCERA &&
118 	    uiaa->uiaa_product == USB_PRODUCT_KYOCERA_AHK3001V &&
119 	    (uiaa->uiaa_ifaceno == UKYOPON_MODEM_IFACE_INDEX ||
120 	     uiaa->uiaa_ifaceno == UKYOPON_DATA_IFACE_INDEX))
121 		return UMATCH_VENDOR_PRODUCT;
122 
123 	return UMATCH_NONE;
124 }
125 
126 static void
127 ukyopon_attach(device_t parent, device_t self, void *aux)
128 {
129 	struct ukyopon_softc *sc = device_private(self);
130 	struct usbif_attach_arg *uiaa = aux;
131 	struct ucom_attach_args ucaa;
132 
133 	ucaa.ucaa_portno = (uiaa->uiaa_ifaceno == UKYOPON_MODEM_IFACE_INDEX) ?
134 		UKYOPON_PORT_MODEM : UKYOPON_PORT_DATA;
135 	ucaa.ucaa_methods = &ukyopon_methods;
136 	ucaa.ucaa_info = (uiaa->uiaa_ifaceno == UKYOPON_MODEM_IFACE_INDEX) ?
137 	    "modem port" : "data transfer port";
138 
139 	if (umodem_common_attach(self, &sc->sc_umodem, uiaa, &ucaa))
140 		return;
141 	return;
142 }
143 
144 static void
145 ukyopon_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
146 {
147 	struct ukyopon_softc *sc = addr;
148 
149 	/*
150 	 * The device doesn't set DCD (Data Carrier Detect) bit properly.
151 	 * Assume DCD is always present.
152 	 */
153 	if ((sc->sc_umodem.sc_msr & UMSR_DCD) == 0)
154 		sc->sc_umodem.sc_msr |= UMSR_DCD;
155 
156 	umodem_get_status(&sc->sc_umodem, portno, lsr, msr);
157 }
158 
159 static void
160 ukyopon_set(void *addr, int portno, int reg, int onoff)
161 {
162 	struct ukyopon_softc *sc = addr;
163 
164 	umodem_set(&sc->sc_umodem, portno, reg, onoff);
165 }
166 
167 static int
168 ukyopon_param(void *addr, int portno, struct termios *t)
169 {
170 	struct ukyopon_softc *sc = addr;
171 
172 	return umodem_param(&sc->sc_umodem, portno, t);
173 }
174 
175 static int
176 ukyopon_open(void *addr, int portno)
177 {
178 	struct ukyopon_softc *sc = addr;
179 
180 	return umodem_open(&sc->sc_umodem, portno);
181 }
182 
183 static void
184 ukyopon_close(void *addr, int portno)
185 {
186 	struct ukyopon_softc *sc = addr;
187 
188 	umodem_close(&sc->sc_umodem, portno);
189 }
190 
191 
192 static int
193 ukyopon_ioctl(void *addr, int portno, u_long cmd, void *data, int flag,
194 	      proc_t *p)
195 {
196 	struct ukyopon_softc *sc = addr;
197 	struct ukyopon_identify *arg_id = (void*)data;
198 	int error = 0;
199 
200 	switch (cmd) {
201 	case UKYOPON_IDENTIFY:
202 		strncpy(arg_id->ui_name, UKYOPON_NAME, sizeof(arg_id->ui_name));
203 		arg_id->ui_busno =
204 		    device_unit(sc->sc_umodem.sc_udev->ud_bus->ub_usbctl);
205 		arg_id->ui_address = sc->sc_umodem.sc_udev->ud_addr;
206 		arg_id->ui_model = UKYOPON_MODEL_UNKNOWN;
207 		arg_id->ui_porttype = portno;
208 		break;
209 
210 	default:
211 		error = umodem_ioctl(&sc->sc_umodem, portno, cmd, data, flag, p);
212 		break;
213 	}
214 
215 	return error;
216 }
217 
218 int
219 ukyopon_detach(device_t self, int flags)
220 {
221 	struct ukyopon_softc *sc = device_private(self);
222 
223 	return umodem_common_detach(&sc->sc_umodem, flags);
224 }
225