xref: /openbsd-src/sys/dev/usb/umsm.c (revision 18270f79f17989f9cfedd96c0d9a34fd91cdb415)
1 /*	$OpenBSD: umsm.c,v 1.119 2021/05/18 14:23:03 kevlo Exp $	*/
2 
3 /*
4  * Copyright (c) 2008 Yojiro UO <yuo@nui.org>
5  * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /* Driver for Qualcomm MSM EVDO and UMTS communication devices */
21 
22 #include <sys/param.h>
23 #include <sys/systm.h>
24 #include <sys/kernel.h>
25 #include <sys/malloc.h>
26 #include <sys/device.h>
27 #include <sys/conf.h>
28 #include <sys/tty.h>
29 
30 #include <dev/usb/usb.h>
31 #include <dev/usb/usbdi.h>
32 #include <dev/usb/usbdevs.h>
33 #include <dev/usb/ucomvar.h>
34 #include <dev/usb/usbcdc.h>
35 #include <dev/usb/umassvar.h>
36 #undef DPRINTF	/* undef DPRINTF for umass */
37 
38 #ifdef UMSM_DEBUG
39 int     umsmdebug = 0;
40 #define DPRINTFN(n, x)  do { if (umsmdebug > (n)) printf x; } while (0)
41 #else
42 #define DPRINTFN(n, x)
43 #endif
44 
45 #define DPRINTF(x) DPRINTFN(0, x)
46 
47 #define UMSMBUFSZ	4096
48 #define	UMSM_INTR_INTERVAL	100	/* ms */
49 #define E220_MODE_CHANGE_REQUEST 0x2
50 #define TRUINSTALL_CHANGEMODE_REQUEST 0x0b
51 
52 int umsm_match(struct device *, void *, void *);
53 void umsm_attach(struct device *, struct device *, void *);
54 int umsm_detach(struct device *, int);
55 
56 int umsm_open(void *, int);
57 void umsm_close(void *, int);
58 void umsm_intr(struct usbd_xfer *, void *, usbd_status);
59 void umsm_get_status(void *, int, u_char *, u_char *);
60 void umsm_set(void *, int, int, int);
61 
62 struct umsm_softc {
63 	struct device		 sc_dev;
64 	struct usbd_device	*sc_udev;
65 	struct usbd_interface	*sc_iface;
66 	int			 sc_iface_no;
67 	struct device		*sc_subdev;
68 	uint16_t		 sc_flag;
69 
70 	/* interrupt ep */
71 	int			 sc_intr_number;
72 	struct usbd_pipe	*sc_intr_pipe;
73 	u_char			*sc_intr_buf;
74 	int			 sc_isize;
75 
76 	u_char			 sc_lsr;	/* Local status register */
77 	u_char			 sc_msr;	/* status register */
78 	u_char			 sc_dtr;	/* current DTR state */
79 	u_char			 sc_rts;	/* current RTS state */
80 };
81 
82 usbd_status umsm_huawei_changemode(struct usbd_device *);
83 usbd_status umsm_truinstall_changemode(struct usbd_device *);
84 usbd_status umsm_umass_changemode(struct umsm_softc *);
85 
86 struct ucom_methods umsm_methods = {
87 	umsm_get_status,
88 	umsm_set,
89 	NULL,
90 	NULL,
91 	umsm_open,
92 	umsm_close,
93 	NULL,
94 	NULL,
95 };
96 
97 struct umsm_type {
98 	struct usb_devno	umsm_dev;
99 	uint16_t		umsm_flag;
100 /* device type */
101 #define	DEV_NORMAL	0x0000
102 #define	DEV_HUAWEI	0x0001
103 #define	DEV_TRUINSTALL	0x0002
104 #define	DEV_UMASS1	0x0010
105 #define	DEV_UMASS2	0x0020
106 #define	DEV_UMASS3	0x0040
107 #define	DEV_UMASS4	0x0080
108 #define	DEV_UMASS5	0x0100
109 #define	DEV_UMASS6	0x0200
110 #define	DEV_UMASS7	0x0400
111 #define	DEV_UMASS8	0x1000
112 #define DEV_UMASS	(DEV_UMASS1 | DEV_UMASS2 | DEV_UMASS3 | DEV_UMASS4 | \
113     DEV_UMASS5 | DEV_UMASS6 | DEV_UMASS7 | DEV_UMASS8)
114 };
115 
116 static const struct umsm_type umsm_devs[] = {
117 	{{ USB_VENDOR_AIRPRIME,	USB_PRODUCT_AIRPRIME_PC5220 }, 0},
118 	{{ USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_AIRCARD_313U }, 0},
119 
120 	{{ USB_VENDOR_ANYDATA,	USB_PRODUCT_ANYDATA_A2502 }, 0},
121 	{{ USB_VENDOR_ANYDATA,	USB_PRODUCT_ANYDATA_ADU_500A }, 0},
122 	{{ USB_VENDOR_ANYDATA,  USB_PRODUCT_ANYDATA_ADU_E100H }, 0},
123 
124 	{{ USB_VENDOR_DELL,	USB_PRODUCT_DELL_EU870D }, 0},
125 	{{ USB_VENDOR_DELL,	USB_PRODUCT_DELL_U740 }, 0},
126 	{{ USB_VENDOR_DELL,	USB_PRODUCT_DELL_W5500 }, 0},
127 
128 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E161 }, DEV_UMASS5},
129 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E173S_INIT }, DEV_UMASS5},
130 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E173S }, 0},
131 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E180 }, DEV_HUAWEI},
132 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E181 }, DEV_HUAWEI},
133 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E182 }, DEV_UMASS5},
134 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E1820 }, DEV_UMASS5},
135 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E220 }, DEV_HUAWEI},
136 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E303 }, DEV_UMASS5},
137 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E353_INIT }, DEV_UMASS5},
138 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E510 }, DEV_HUAWEI},
139 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E618 }, DEV_HUAWEI},
140 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E392_INIT }, DEV_UMASS5},
141 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_EM770W }, 0},
142 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_MOBILE }, DEV_HUAWEI},
143 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_K3765_INIT }, DEV_UMASS5},
144 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_K3765 }, 0},
145 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_K3772_INIT }, DEV_UMASS5},
146 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_K3772 }, 0},
147 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_MU609 }, DEV_TRUINSTALL},
148 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_K4510 }, DEV_UMASS5},
149 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_K4511 }, DEV_UMASS5},
150 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E1750 }, DEV_UMASS5},
151 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E1752 }, 0},
152 	{{ USB_VENDOR_HUAWEI,	USB_PRODUCT_HUAWEI_E3372 }, DEV_UMASS5},
153 
154 	{{ USB_VENDOR_HYUNDAI,	USB_PRODUCT_HYUNDAI_UM175 }, 0},
155 
156 	{{ USB_VENDOR_LONGCHEER, USB_PRODUCT_LONGCHEER_D21LCMASS }, DEV_UMASS3},
157 	{{ USB_VENDOR_LONGCHEER, USB_PRODUCT_LONGCHEER_D21LC }, 0},
158 	{{ USB_VENDOR_LONGCHEER, USB_PRODUCT_LONGCHEER_510FUMASS }, DEV_UMASS3},
159 	{{ USB_VENDOR_LONGCHEER, USB_PRODUCT_LONGCHEER_510FU }, 0},
160 
161 	{{ USB_VENDOR_KYOCERA2,	USB_PRODUCT_KYOCERA2_KPC650 }, 0},
162 
163 	{{ USB_VENDOR_MEDIATEK, USB_PRODUCT_MEDIATEK_UMASS }, DEV_UMASS8},
164 	{{ USB_VENDOR_MEDIATEK, USB_PRODUCT_MEDIATEK_DC_4COM }, 0},
165 
166 	/* XXX Some qualcomm devices are missing */
167 	{{ USB_VENDOR_QUALCOMM,	USB_PRODUCT_QUALCOMM_MSM_DRIVER }, DEV_UMASS1},
168 	{{ USB_VENDOR_QUALCOMM,	USB_PRODUCT_QUALCOMM_MSM_DRIVER2 }, DEV_UMASS4},
169 	{{ USB_VENDOR_QUALCOMM,	USB_PRODUCT_QUALCOMM_MSM_HSDPA }, 0},
170 	{{ USB_VENDOR_QUALCOMM,	USB_PRODUCT_QUALCOMM_MSM_HSDPA2 }, 0},
171 	{{ USB_VENDOR_QUALCOMM,	USB_PRODUCT_QUALCOMM_MSM_HSDPA3 }, 0},
172 
173 	{{ USB_VENDOR_QUANTA2, USB_PRODUCT_QUANTA2_UMASS }, DEV_UMASS4},
174 	{{ USB_VENDOR_QUANTA2, USB_PRODUCT_QUANTA2_Q101 }, 0},
175 
176 	{{ USB_VENDOR_QUECTEL, USB_PRODUCT_QUECTEL_EC25 }, 0},
177 
178 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_AC2746 }, 0},
179 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_UMASS_INSTALLER }, DEV_UMASS4},
180 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_UMASS_INSTALLER2 }, DEV_UMASS6},
181 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_UMASS_INSTALLER3 }, DEV_UMASS7},
182 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_UMASS_INSTALLER4 }, DEV_UMASS4},
183 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_K3565Z }, 0},
184 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF112 }, DEV_UMASS4},
185 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF633 }, 0},
186 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF637 }, 0},
187 	{{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MSA110UP }, 0},
188 
189 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_EXPRESSCARD }, 0},
190 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MERLINV620 }, 0},
191 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MERLINV740 }, 0},
192 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_V720 }, 0},
193 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MERLINU740 }, 0},
194 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MERLINU740_2 }, 0},
195 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_U870 }, 0},
196 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_XU870 }, 0},
197 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_EU870D }, 0},
198 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_X950D }, 0},
199 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_ES620 }, 0},
200 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_U720 }, 0},
201 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_U727 }, DEV_UMASS1},
202 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MC950D }, 0},
203 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MERLINX950D }, DEV_UMASS4},
204 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_ZEROCD2 }, DEV_UMASS4},
205 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_U760 }, DEV_UMASS4},
206 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MC760 }, 0},
207 	{{ USB_VENDOR_NOVATEL, USB_PRODUCT_NOVATEL_MC760CD }, DEV_UMASS4},
208 
209 	{{ USB_VENDOR_NOVATEL1,	USB_PRODUCT_NOVATEL1_FLEXPACKGPS }, 0},
210 
211 	{{ USB_VENDOR_NOKIA2, USB_PRODUCT_NOKIA2_CS15UMASS }, DEV_UMASS4},
212 	{{ USB_VENDOR_NOKIA2, USB_PRODUCT_NOKIA2_CS15 }, 0},
213 
214 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GT3GFUSION }, 0},
215 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GT3GPLUS }, 0},
216 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GT3GQUAD }, 0},
217 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GT3GQUADPLUS }, 0},
218 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GSICON72 }, DEV_UMASS1},
219 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GTHSUPA380E }, 0},
220 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_GTMAX36 }, 0},
221 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_ICON225 }, DEV_UMASS2},
222 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_ICON505 }, DEV_UMASS1},
223 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_SCORPION }, 0},
224 	{{ USB_VENDOR_OPTION, USB_PRODUCT_OPTION_VODAFONEMC3G }, 0},
225 
226 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 }, 0},
227 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720 }, 0},
228 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD_595 }, 0},
229 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5725 }, 0},
230 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC597E }, 0},
231 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_C597 }, 0},
232 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC595U }, 0},
233 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD_580 }, 0},
234 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720_2 }, 0},
235 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5725_2 }, 0},
236 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_2 }, 0},
237 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8765 }, 0},
238 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755 }, 0},
239 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8775 }, 0},
240 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_3 }, 0},
241 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8775_2 }, 0},
242 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD_875 }, 0},
243 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8780 }, 0},
244 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8781 }, 0},
245 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8790 }, 0},
246 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880 }, 0},
247 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881 }, 0},
248 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880E }, 0},
249 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881E }, 0},
250 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880U }, 0},
251 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881U }, 0},
252 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC885U }, 0},
253 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_C01SW }, 0},
254 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_USB305}, 0},
255 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC7304}, 0},
256 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_TRUINSTALL }, DEV_TRUINSTALL},
257 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8355}, 0},
258 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD_340U}, 0},
259 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD_770S}, 0},
260 	{{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC7455}, 0},
261 
262 	{{ USB_VENDOR_SIMCOM, USB_PRODUCT_SIMCOM_SIM7600E}, 0},
263 
264 	{{ USB_VENDOR_TCTMOBILE, USB_PRODUCT_TCTMOBILE_UMASS }, DEV_UMASS3},
265 	{{ USB_VENDOR_TCTMOBILE, USB_PRODUCT_TCTMOBILE_UMASS_2 }, DEV_UMASS3},
266 	{{ USB_VENDOR_TCTMOBILE, USB_PRODUCT_TCTMOBILE_UMSM }, 0},
267 	{{ USB_VENDOR_TCTMOBILE, USB_PRODUCT_TCTMOBILE_UMSM_2 }, 0},
268 	{{ USB_VENDOR_TCTMOBILE, USB_PRODUCT_TCTMOBILE_UMSM_3 }, 0},
269 
270 	{{ USB_VENDOR_TOSHIBA, USB_PRODUCT_TOSHIBA_HSDPA }, 0},
271 
272 	{{ USB_VENDOR_HP, USB_PRODUCT_HP_HS2300 }, 0},
273 
274 	{{ USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CNU510 }, 0}, /* ??? */
275 	{{ USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CCU550 }, 0}, /* ??? */
276 	{{ USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CGU628 }, DEV_UMASS1},
277 	{{ USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CGU628_DISK }, 0},
278 	{{ USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CNU680 }, DEV_UMASS1},
279 };
280 
281 #define umsm_lookup(v, p) ((const struct umsm_type *)usb_lookup(umsm_devs, v, p))
282 
283 struct cfdriver umsm_cd = {
284 	NULL, "umsm", DV_DULL
285 };
286 
287 const struct cfattach umsm_ca = {
288 	sizeof(struct umsm_softc), umsm_match, umsm_attach, umsm_detach
289 };
290 
291 int
292 umsm_match(struct device *parent, void *match, void *aux)
293 {
294 	struct usb_attach_arg *uaa = aux;
295 	usb_interface_descriptor_t *id;
296 	uint16_t flag;
297 
298 	if (uaa->iface == NULL)
299 		return UMATCH_NONE;
300 
301 	/*
302 	 * Some devices (eg Huawei E220) have multiple interfaces and some
303 	 * of them are of class umass. Don't claim ownership in such case.
304 	 */
305 	if (umsm_lookup(uaa->vendor, uaa->product) != NULL) {
306 		id = usbd_get_interface_descriptor(uaa->iface);
307 		flag = umsm_lookup(uaa->vendor, uaa->product)->umsm_flag;
308 
309 		if (id == NULL || id->bInterfaceClass == UICLASS_MASS) {
310 			/*
311 			 * Some high-speed modems require special care.
312 			 */
313 			if (flag & DEV_HUAWEI) {
314 				if (uaa->ifaceno != 2)
315 					return UMATCH_VENDOR_IFACESUBCLASS;
316 				else
317 					return UMATCH_NONE;
318 			} else if (flag & DEV_UMASS) {
319 				return UMATCH_VENDOR_IFACESUBCLASS;
320 			} else if (flag & DEV_TRUINSTALL) {
321 				return UMATCH_VENDOR_IFACESUBCLASS;
322 			} else
323 				return UMATCH_NONE;
324 		/*
325 		 * Some devices have interfaces which fail to attach but in
326 		 * addition seem to make the remaining interfaces unusable. Only
327 		 * attach whitelisted interfaces in this case.
328 		 */
329 		} else if ((uaa->vendor == USB_VENDOR_MEDIATEK &&
330 			    uaa->product == USB_PRODUCT_MEDIATEK_DC_4COM) &&
331 			   !(id->bInterfaceClass == UICLASS_VENDOR &&
332 			    ((id->bInterfaceSubClass == 0x02 &&
333 			      id->bInterfaceProtocol == 0x01) ||
334 			     (id->bInterfaceSubClass == 0x00 &&
335 			      id->bInterfaceProtocol == 0x00)))) {
336 			return UMATCH_NONE;
337 		} else
338 			return UMATCH_VENDOR_IFACESUBCLASS;
339 	}
340 
341 	return UMATCH_NONE;
342 }
343 
344 void
345 umsm_attach(struct device *parent, struct device *self, void *aux)
346 {
347 	struct umsm_softc *sc = (struct umsm_softc *)self;
348 	struct usb_attach_arg *uaa = aux;
349 	struct ucom_attach_args uca;
350 	usb_interface_descriptor_t *id;
351 	usb_endpoint_descriptor_t *ed;
352 	int i;
353 
354 	bzero(&uca, sizeof(uca));
355 	sc->sc_udev = uaa->device;
356 	sc->sc_iface = uaa->iface;
357 	sc->sc_flag  = umsm_lookup(uaa->vendor, uaa->product)->umsm_flag;
358 
359 	id = usbd_get_interface_descriptor(sc->sc_iface);
360 
361 	/*
362 	 * Some 3G modems have multiple interfaces and some of them
363 	 * are umass class. Don't claim ownership in such case.
364 	 */
365 	if (id == NULL || id->bInterfaceClass == UICLASS_MASS) {
366 		/*
367 		 * Some 3G modems require a special request to
368 		 * enable their modem function.
369 		 */
370 		if ((sc->sc_flag & DEV_HUAWEI) && uaa->ifaceno == 0) {
371                         umsm_huawei_changemode(uaa->device);
372 			printf("%s: umass only mode. need to reattach\n",
373 				sc->sc_dev.dv_xname);
374 		} else if (sc->sc_flag & DEV_TRUINSTALL) {
375 			umsm_truinstall_changemode(uaa->device);
376 			printf("%s: truinstall mode. need to reattach\n",
377 				sc->sc_dev.dv_xname);
378 		} else if ((sc->sc_flag & DEV_UMASS) && uaa->ifaceno == 0) {
379 			umsm_umass_changemode(sc);
380 		}
381 
382 		/*
383 		 * The device will reset its own bus from the device side
384 		 * when its mode was changed, so just return.
385 		 */
386 		return;
387 	}
388 
389 	sc->sc_iface_no = id->bInterfaceNumber;
390 	uca.bulkin = uca.bulkout = -1;
391 	sc->sc_intr_number = sc->sc_isize = -1;
392 	for (i = 0; i < id->bNumEndpoints; i++) {
393 		ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
394 		if (ed == NULL) {
395 			printf("%s: no endpoint descriptor found for %d\n",
396 			    sc->sc_dev.dv_xname, i);
397 			usbd_deactivate(sc->sc_udev);
398 			return;
399 		}
400 
401 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
402 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
403 			sc->sc_intr_number = ed->bEndpointAddress;
404 			sc->sc_isize = UGETW(ed->wMaxPacketSize);
405 			DPRINTF(("%s: find interrupt endpoint for %s\n",
406 				__func__, sc->sc_dev.dv_xname));
407 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
408 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
409 			uca.bulkin = ed->bEndpointAddress;
410 		else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
411 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
412 			uca.bulkout = ed->bEndpointAddress;
413 	}
414 	if (uca.bulkin == -1 || uca.bulkout == -1) {
415 		printf("%s: missing endpoint\n", sc->sc_dev.dv_xname);
416 		usbd_deactivate(sc->sc_udev);
417 		return;
418 	}
419 
420 	sc->sc_dtr = sc->sc_rts = -1;
421 
422 	/* We need to force size as some devices lie */
423 	uca.ibufsize = UMSMBUFSZ;
424 	uca.obufsize = UMSMBUFSZ;
425 	uca.ibufsizepad = UMSMBUFSZ;
426 	uca.opkthdrlen = 0;
427 	uca.device = sc->sc_udev;
428 	uca.iface = sc->sc_iface;
429 	uca.methods = &umsm_methods;
430 	uca.arg = sc;
431 	uca.info = NULL;
432 	uca.portno = UCOM_UNK_PORTNO;
433 
434 	sc->sc_subdev = config_found_sm(self, &uca, ucomprint, ucomsubmatch);
435 }
436 
437 int
438 umsm_detach(struct device *self, int flags)
439 {
440 	struct umsm_softc *sc = (struct umsm_softc *)self;
441 	int rv = 0;
442 
443 	/* close the interrupt endpoint if that is opened */
444 	if (sc->sc_intr_pipe != NULL) {
445 		usbd_close_pipe(sc->sc_intr_pipe);
446 		free(sc->sc_intr_buf, M_USBDEV, sc->sc_isize);
447 		sc->sc_intr_pipe = NULL;
448 	}
449 
450 	usbd_deactivate(sc->sc_udev);
451 	if (sc->sc_subdev != NULL) {
452 		rv = config_detach(sc->sc_subdev, flags);
453 		sc->sc_subdev = NULL;
454 	}
455 
456 	return (rv);
457 }
458 
459 int
460 umsm_open(void *addr, int portno)
461 {
462 	struct umsm_softc *sc = addr;
463 	int err;
464 
465 	if (usbd_is_dying(sc->sc_udev))
466 		return (ENXIO);
467 
468 	if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
469 		sc->sc_intr_buf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
470 		err = usbd_open_pipe_intr(sc->sc_iface,
471 		    sc->sc_intr_number,
472 		    USBD_SHORT_XFER_OK,
473 		    &sc->sc_intr_pipe,
474 		    sc,
475 		    sc->sc_intr_buf,
476 		    sc->sc_isize,
477 		    umsm_intr,
478 		    UMSM_INTR_INTERVAL);
479 		if (err) {
480 			printf("%s: cannot open interrupt pipe (addr %d)\n",
481 			    sc->sc_dev.dv_xname,
482 			    sc->sc_intr_number);
483 			return (EIO);
484 		}
485 	}
486 
487 	return (0);
488 }
489 
490 void
491 umsm_close(void *addr, int portno)
492 {
493 	struct umsm_softc *sc = addr;
494 	int err;
495 
496 	if (usbd_is_dying(sc->sc_udev))
497 		return;
498 
499 	if (sc->sc_intr_pipe != NULL) {
500 		err = usbd_close_pipe(sc->sc_intr_pipe);
501 		if (err)
502 			printf("%s: close interrupt pipe failed: %s\n",
503 			    sc->sc_dev.dv_xname,
504 			    usbd_errstr(err));
505 		free(sc->sc_intr_buf, M_USBDEV, sc->sc_isize);
506 		sc->sc_intr_pipe = NULL;
507 	}
508 }
509 
510 void
511 umsm_intr(struct usbd_xfer *xfer, void *priv,
512 	usbd_status status)
513 {
514 	struct umsm_softc *sc = priv;
515 	struct usb_cdc_notification *buf;
516 	u_char mstatus;
517 
518 	buf = (struct usb_cdc_notification *)sc->sc_intr_buf;
519 	if (usbd_is_dying(sc->sc_udev))
520 		return;
521 
522 	if (status != USBD_NORMAL_COMPLETION) {
523 		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
524 			return;
525 
526 		DPRINTF(("%s: umsm_intr: abnormal status: %s\n",
527 		    sc->sc_dev.dv_xname, usbd_errstr(status)));
528 		usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
529 		return;
530 	}
531 
532 	if (buf->bmRequestType != UCDC_NOTIFICATION) {
533 #if 1 /* test */
534 		printf("%s: this device is not using CDC notify message in intr pipe.\n"
535 		    "Please send your dmesg to <bugs@openbsd.org>, thanks.\n",
536 		    sc->sc_dev.dv_xname);
537 		printf("%s: intr buffer 0x%x 0x%x 0x%x 0x%x 0x%x 0x%x 0x%x\n",
538 		    sc->sc_dev.dv_xname,
539 		    sc->sc_intr_buf[0], sc->sc_intr_buf[1],
540 		    sc->sc_intr_buf[2], sc->sc_intr_buf[3],
541 		    sc->sc_intr_buf[4], sc->sc_intr_buf[5],
542 		    sc->sc_intr_buf[6]);
543 #else
544 		DPRINTF(("%s: umsm_intr: unknown message type(0x%02x)\n",
545 		    sc->sc_dev.dv_xname, buf->bmRequestType));
546 #endif
547 		return;
548 	}
549 
550 	if (buf->bNotification == UCDC_N_SERIAL_STATE) {
551 		/* invalid message length, discard it */
552 		if (UGETW(buf->wLength) != 2)
553 			return;
554 		/* XXX: sc_lsr is always 0 */
555 		sc->sc_lsr = sc->sc_msr = 0;
556 		mstatus = buf->data[0];
557 		if (ISSET(mstatus, UCDC_N_SERIAL_RI))
558 			sc->sc_msr |= UMSR_RI;
559 		if (ISSET(mstatus, UCDC_N_SERIAL_DSR))
560 			sc->sc_msr |= UMSR_DSR;
561 		if (ISSET(mstatus, UCDC_N_SERIAL_DCD))
562 			sc->sc_msr |= UMSR_DCD;
563 	} else if (buf->bNotification != UCDC_N_CONNECTION_SPEED_CHANGE) {
564 		DPRINTF(("%s: umsm_intr: unknown notify message (0x%02x)\n",
565 		    sc->sc_dev.dv_xname, buf->bNotification));
566 		return;
567 	}
568 
569 	ucom_status_change((struct ucom_softc *)sc->sc_subdev);
570 }
571 
572 void
573 umsm_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
574 {
575 	struct umsm_softc *sc = addr;
576 
577 	if (lsr != NULL)
578 		*lsr = sc->sc_lsr;
579 	if (msr != NULL)
580 		*msr = sc->sc_msr;
581 }
582 
583 void
584 umsm_set(void *addr, int portno, int reg, int onoff)
585 {
586 	struct umsm_softc *sc = addr;
587 	usb_device_request_t req;
588 	int ls;
589 
590 	switch (reg) {
591 	case UCOM_SET_DTR:
592 		if (sc->sc_dtr == onoff)
593 			return;
594 		sc->sc_dtr = onoff;
595 		break;
596 	case UCOM_SET_RTS:
597 		if (sc->sc_rts == onoff)
598 			return;
599 		sc->sc_rts = onoff;
600 		break;
601 	default:
602 		return;
603 	}
604 
605 	/* build a usb request */
606 	ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
607 	     (sc->sc_rts ? UCDC_LINE_RTS : 0);
608 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
609 	req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
610 	USETW(req.wValue, ls);
611 	USETW(req.wIndex, sc->sc_iface_no);
612 	USETW(req.wLength, 0);
613 
614 	(void)usbd_do_request(sc->sc_udev, &req, 0);
615 }
616 
617 usbd_status
618 umsm_huawei_changemode(struct usbd_device *dev)
619 {
620 	usb_device_request_t req;
621 	usbd_status err;
622 
623 	req.bmRequestType = UT_WRITE_DEVICE;
624 	req.bRequest = UR_SET_FEATURE;
625 	USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP);
626 	USETW(req.wIndex, E220_MODE_CHANGE_REQUEST);
627 	USETW(req.wLength, 0);
628 
629 	err = usbd_do_request(dev, &req, 0);
630 	if (err)
631 		return (EIO);
632 
633 	return (0);
634 }
635 
636 usbd_status
637 umsm_truinstall_changemode(struct usbd_device *dev)
638 {
639 	usb_device_request_t req;
640 	usbd_status err;
641 	req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
642 	req.bRequest = TRUINSTALL_CHANGEMODE_REQUEST;
643 	USETW(req.wValue, 0x1);
644 	USETW(req.wIndex, 0);
645 	USETW(req.wLength, 0);
646 
647 	err = usbd_do_request(dev, &req, 0);
648 	if (err)
649 		return (EIO);
650 
651 	return (0);
652 }
653 
654 usbd_status
655 umsm_umass_changemode(struct umsm_softc *sc)
656 {
657 #define UMASS_CMD_REZERO_UNIT		0x01
658 #define UMASS_CMD_START_STOP		0x1b
659 #define UMASS_CMDPARAM_EJECT		0x02
660 #define UMASS_SERVICE_ACTION_OUT	0x9f
661 	usb_interface_descriptor_t *id;
662 	usb_endpoint_descriptor_t *ed;
663 	struct usbd_xfer *xfer;
664 	struct usbd_pipe *cmdpipe;
665 	usbd_status err;
666 	u_int32_t n;
667 	void *bufp;
668 	int target_ep, i;
669 
670 	struct umass_bbb_cbw cbw;
671 	static int dCBWTag = 0x12345678;
672 
673 	USETDW(cbw.dCBWSignature, CBWSIGNATURE);
674 	USETDW(cbw.dCBWTag, dCBWTag);
675 	cbw.bCBWLUN   = 0;
676 	cbw.bCDBLength= 6;
677 	bzero(cbw.CBWCDB, sizeof(cbw.CBWCDB));
678 
679 	switch (sc->sc_flag) {
680 	case DEV_UMASS1:
681 		USETDW(cbw.dCBWDataTransferLength, 0x0);
682 		cbw.bCBWFlags = CBWFLAGS_OUT;
683 		cbw.CBWCDB[0] = UMASS_CMD_REZERO_UNIT;
684 		cbw.CBWCDB[1] = 0x0;	/* target LUN: 0 */
685 		break;
686 	case DEV_UMASS2:
687 		USETDW(cbw.dCBWDataTransferLength, 0x1);
688 		cbw.bCBWFlags = CBWFLAGS_IN;
689 		cbw.CBWCDB[0] = UMASS_CMD_REZERO_UNIT;
690 		cbw.CBWCDB[1] = 0x0;	/* target LUN: 0 */
691 		break;
692 	case DEV_UMASS3: /* longcheer */
693 		USETDW(cbw.dCBWDataTransferLength, 0x80);
694 		cbw.bCBWFlags = CBWFLAGS_IN;
695 		cbw.CBWCDB[0] = 0x06;
696 		cbw.CBWCDB[1] = 0xf5;
697 		cbw.CBWCDB[2] = 0x04;
698 		cbw.CBWCDB[3] = 0x02;
699 		cbw.CBWCDB[4] = 0x52;
700 		cbw.CBWCDB[5] = 0x70;
701 		break;
702 	case DEV_UMASS4:
703 		USETDW(cbw.dCBWDataTransferLength, 0x0);
704 		cbw.bCBWFlags = CBWFLAGS_OUT;
705 		cbw.CBWCDB[0] = UMASS_CMD_START_STOP;
706 		cbw.CBWCDB[1] = 0x00;	/* target LUN: 0 */
707 		cbw.CBWCDB[4] = UMASS_CMDPARAM_EJECT;
708 		break;
709 	case DEV_UMASS5:
710 		cbw.bCBWFlags = CBWFLAGS_OUT;
711 		cbw.CBWCDB[0] = 0x11;
712 		cbw.CBWCDB[1] = 0x06;
713 		break;
714 	case DEV_UMASS6:	/* ZTE */
715 		USETDW(cbw.dCBWDataTransferLength, 0x20);
716 		cbw.bCBWFlags = CBWFLAGS_IN;
717 		cbw.bCDBLength= 12;
718 		cbw.CBWCDB[0] = 0x85;
719 		cbw.CBWCDB[1] = 0x01;
720 		cbw.CBWCDB[2] = 0x01;
721 		cbw.CBWCDB[3] = 0x01;
722 		cbw.CBWCDB[4] = 0x18;
723 		cbw.CBWCDB[5] = 0x01;
724 		cbw.CBWCDB[6] = 0x01;
725 		cbw.CBWCDB[7] = 0x01;
726 		cbw.CBWCDB[8] = 0x01;
727 		cbw.CBWCDB[9] = 0x01;
728 		break;
729 	case DEV_UMASS7:	/* ZTE */
730 		USETDW(cbw.dCBWDataTransferLength, 0xc0);
731 		cbw.bCBWFlags = CBWFLAGS_IN;
732 		cbw.CBWCDB[0] = UMASS_SERVICE_ACTION_OUT;
733 		cbw.CBWCDB[1] = 0x03;
734 		break;
735 	case DEV_UMASS8:
736 		USETDW(cbw.dCBWDataTransferLength, 0x0);
737 		cbw.bCBWFlags = CBWFLAGS_OUT;
738 		cbw.CBWCDB[0] = 0xf0;
739 		cbw.CBWCDB[1] = 0x01;
740 		cbw.CBWCDB[2] = 0x03;
741 		break;
742 	default:
743 		DPRINTF(("%s: unknown device type.\n", sc->sc_dev.dv_xname));
744 		break;
745 	}
746 
747 	/* get command endpoint address */
748 	id = usbd_get_interface_descriptor(sc->sc_iface);
749 	for (i = 0; i < id->bNumEndpoints; i++) {
750 		ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
751 		if (ed == NULL) {
752 			return (USBD_IOERROR);
753 		}
754 
755 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
756 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK)
757 			target_ep = ed->bEndpointAddress;
758 	}
759 
760 	/* open command endppoint */
761 	err = usbd_open_pipe(sc->sc_iface, target_ep,
762 		USBD_EXCLUSIVE_USE, &cmdpipe);
763 	if (err) {
764 		DPRINTF(("%s: open pipe for modem change cmd failed: %s\n",
765 		    sc->sc_dev.dv_xname, usbd_errstr(err)));
766 		return (err);
767 	}
768 
769 	xfer = usbd_alloc_xfer(sc->sc_udev);
770 	if (xfer == NULL) {
771 		usbd_close_pipe(cmdpipe);
772 		return (USBD_NOMEM);
773 	} else {
774 		bufp = usbd_alloc_buffer(xfer, UMASS_BBB_CBW_SIZE);
775 		if (bufp == NULL)
776 			err = USBD_NOMEM;
777 		else {
778 			n = UMASS_BBB_CBW_SIZE;
779 			memcpy(bufp, &cbw, UMASS_BBB_CBW_SIZE);
780 			usbd_setup_xfer(xfer, cmdpipe, 0, bufp, n,
781 			    USBD_NO_COPY | USBD_SYNCHRONOUS, 0, NULL);
782 			err = usbd_transfer(xfer);
783 			if (err) {
784 				usbd_clear_endpoint_stall(cmdpipe);
785 				DPRINTF(("%s: send error:%s", __func__,
786 				    usbd_errstr(err)));
787 			}
788 		}
789 		usbd_close_pipe(cmdpipe);
790 		usbd_free_buffer(xfer);
791 		usbd_free_xfer(xfer);
792 	}
793 
794 	return (err);
795 }
796