xref: /freebsd/sys/dev/usb/serial/uslcom.c (revision 74036c4de983981ee2b23f91e285363293aa7c3c)
1 /*	$OpenBSD: uslcom.c,v 1.17 2007/11/24 10:52:12 jsg Exp $	*/
2 
3 #include <sys/cdefs.h>
4 __FBSDID("$FreeBSD$");
5 
6 /*
7  * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
8  *
9  * Permission to use, copy, modify, and distribute this software for any
10  * purpose with or without fee is hereby granted, provided that the above
11  * copyright notice and this permission notice appear in all copies.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20  */
21 
22 /*
23  * Driver for Silicon Laboratories CP2101/CP2102/CP2103/CP2104/CP2105
24  * USB-Serial adapters.  Based on datasheet AN571, publicly available from
25  * http://www.silabs.com/Support%20Documents/TechnicalDocs/AN571.pdf
26  */
27 
28 #include <sys/stdint.h>
29 #include <sys/stddef.h>
30 #include <sys/param.h>
31 #include <sys/queue.h>
32 #include <sys/types.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/bus.h>
36 #include <sys/module.h>
37 #include <sys/lock.h>
38 #include <sys/mutex.h>
39 #include <sys/condvar.h>
40 #include <sys/sysctl.h>
41 #include <sys/sx.h>
42 #include <sys/unistd.h>
43 #include <sys/callout.h>
44 #include <sys/malloc.h>
45 #include <sys/priv.h>
46 
47 #include <dev/usb/usb.h>
48 #include <dev/usb/usbdi.h>
49 #include <dev/usb/usbdi_util.h>
50 #include <dev/usb/usb_ioctl.h>
51 #include "usbdevs.h"
52 
53 #define	USB_DEBUG_VAR uslcom_debug
54 #include <dev/usb/usb_debug.h>
55 #include <dev/usb/usb_process.h>
56 
57 #include <dev/usb/serial/usb_serial.h>
58 
59 #ifdef USB_DEBUG
60 static int uslcom_debug = 0;
61 
62 static SYSCTL_NODE(_hw_usb, OID_AUTO, uslcom, CTLFLAG_RW, 0, "USB uslcom");
63 SYSCTL_INT(_hw_usb_uslcom, OID_AUTO, debug, CTLFLAG_RW,
64     &uslcom_debug, 0, "Debug level");
65 #endif
66 
67 #define	USLCOM_BULK_BUF_SIZE		1024
68 #define	USLCOM_CONFIG_INDEX	0
69 
70 /* Request types */
71 #define	USLCOM_WRITE		0x41
72 #define	USLCOM_READ		0xc1
73 
74 /* Request codes */
75 #define	USLCOM_IFC_ENABLE	0x00
76 #define	USLCOM_SET_BAUDDIV	0x01
77 #define	USLCOM_SET_LINE_CTL	0x03
78 #define	USLCOM_SET_BREAK	0x05
79 #define	USLCOM_SET_MHS		0x07
80 #define	USLCOM_GET_MDMSTS	0x08
81 #define	USLCOM_SET_FLOW		0x13
82 #define	USLCOM_SET_BAUDRATE	0x1e
83 #define	USLCOM_VENDOR_SPECIFIC	0xff
84 
85 /* USLCOM_IFC_ENABLE values */
86 #define	USLCOM_IFC_ENABLE_DIS	0x00
87 #define	USLCOM_IFC_ENABLE_EN	0x01
88 
89 /* USLCOM_SET_MHS/USLCOM_GET_MDMSTS values */
90 #define	USLCOM_MHS_DTR_ON	0x0001
91 #define	USLCOM_MHS_DTR_SET	0x0100
92 #define	USLCOM_MHS_RTS_ON	0x0002
93 #define	USLCOM_MHS_RTS_SET	0x0200
94 #define	USLCOM_MHS_CTS		0x0010
95 #define	USLCOM_MHS_DSR		0x0020
96 #define	USLCOM_MHS_RI		0x0040
97 #define	USLCOM_MHS_DCD		0x0080
98 
99 /* USLCOM_SET_BAUDDIV values */
100 #define	USLCOM_BAUDDIV_REF	3686400 /* 3.6864 MHz */
101 
102 /* USLCOM_SET_LINE_CTL values */
103 #define	USLCOM_STOP_BITS_1	0x00
104 #define	USLCOM_STOP_BITS_2	0x02
105 #define	USLCOM_PARITY_NONE	0x00
106 #define	USLCOM_PARITY_ODD	0x10
107 #define	USLCOM_PARITY_EVEN	0x20
108 #define	USLCOM_SET_DATA_BITS(x)	((x) << 8)
109 
110 /* USLCOM_SET_BREAK values */
111 #define	USLCOM_SET_BREAK_OFF	0x00
112 #define	USLCOM_SET_BREAK_ON	0x01
113 
114 /* USLCOM_SET_FLOW values - 1st word */
115 #define	USLCOM_FLOW_DTR_ON      0x00000001 /* DTR static active */
116 #define	USLCOM_FLOW_CTS_HS      0x00000008 /* CTS handshake */
117 /* USLCOM_SET_FLOW values - 2nd word */
118 #define	USLCOM_FLOW_RTS_ON      0x00000040 /* RTS static active */
119 #define	USLCOM_FLOW_RTS_HS      0x00000080 /* RTS handshake */
120 
121 /* USLCOM_VENDOR_SPECIFIC values */
122 #define	USLCOM_GET_PARTNUM	0x370B
123 #define	USLCOM_WRITE_LATCH	0x37E1
124 #define	USLCOM_READ_LATCH	0x00C2
125 
126 /* USLCOM_GET_PARTNUM values from hardware */
127 #define	USLCOM_PARTNUM_CP2101	1
128 #define	USLCOM_PARTNUM_CP2102	2
129 #define	USLCOM_PARTNUM_CP2103	3
130 #define	USLCOM_PARTNUM_CP2104	4
131 #define	USLCOM_PARTNUM_CP2105	5
132 
133 enum {
134 	USLCOM_BULK_DT_WR,
135 	USLCOM_BULK_DT_RD,
136 	USLCOM_CTRL_DT_RD,
137 	USLCOM_N_TRANSFER,
138 };
139 
140 struct uslcom_softc {
141 	struct ucom_super_softc sc_super_ucom;
142 	struct ucom_softc sc_ucom;
143 	struct usb_callout sc_watchdog;
144 
145 	struct usb_xfer *sc_xfer[USLCOM_N_TRANSFER];
146 	struct usb_device *sc_udev;
147 	struct mtx sc_mtx;
148 
149 	uint8_t		 sc_msr;
150 	uint8_t		 sc_lsr;
151 	uint8_t		 sc_iface_no;
152 	uint8_t		 sc_partnum;
153 };
154 
155 static device_probe_t uslcom_probe;
156 static device_attach_t uslcom_attach;
157 static device_detach_t uslcom_detach;
158 static void uslcom_free_softc(struct uslcom_softc *);
159 
160 static usb_callback_t uslcom_write_callback;
161 static usb_callback_t uslcom_read_callback;
162 static usb_callback_t uslcom_control_callback;
163 
164 static void	uslcom_free(struct ucom_softc *);
165 static void uslcom_open(struct ucom_softc *);
166 static void uslcom_close(struct ucom_softc *);
167 static uint8_t uslcom_get_partnum(struct uslcom_softc *);
168 static void uslcom_set_dtr(struct ucom_softc *, uint8_t);
169 static void uslcom_set_rts(struct ucom_softc *, uint8_t);
170 static void uslcom_set_break(struct ucom_softc *, uint8_t);
171 static int uslcom_ioctl(struct ucom_softc *, uint32_t, caddr_t, int,
172 		struct thread *);
173 static int uslcom_pre_param(struct ucom_softc *, struct termios *);
174 static void uslcom_param(struct ucom_softc *, struct termios *);
175 static void uslcom_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
176 static void uslcom_start_read(struct ucom_softc *);
177 static void uslcom_stop_read(struct ucom_softc *);
178 static void uslcom_start_write(struct ucom_softc *);
179 static void uslcom_stop_write(struct ucom_softc *);
180 static void uslcom_poll(struct ucom_softc *ucom);
181 
182 static const struct usb_config uslcom_config[USLCOM_N_TRANSFER] = {
183 
184 	[USLCOM_BULK_DT_WR] = {
185 		.type = UE_BULK,
186 		.endpoint = UE_ADDR_ANY,
187 		.direction = UE_DIR_OUT,
188 		.bufsize = USLCOM_BULK_BUF_SIZE,
189                .flags = {.pipe_bof = 1,},
190 		.callback = &uslcom_write_callback,
191 	},
192 
193 	[USLCOM_BULK_DT_RD] = {
194 		.type = UE_BULK,
195 		.endpoint = UE_ADDR_ANY,
196 		.direction = UE_DIR_IN,
197 		.bufsize = USLCOM_BULK_BUF_SIZE,
198 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
199 		.callback = &uslcom_read_callback,
200 	},
201 	[USLCOM_CTRL_DT_RD] = {
202 		.type = UE_CONTROL,
203 		.endpoint = 0x00,
204 		.direction = UE_DIR_ANY,
205 		.bufsize = sizeof(struct usb_device_request) + 8,
206 		.flags = {.pipe_bof = 1,},
207 		.callback = &uslcom_control_callback,
208 		.timeout = 1000,	/* 1 second timeout */
209 	},
210 };
211 
212 static struct ucom_callback uslcom_callback = {
213 	.ucom_cfg_open = &uslcom_open,
214 	.ucom_cfg_close = &uslcom_close,
215 	.ucom_cfg_get_status = &uslcom_get_status,
216 	.ucom_cfg_set_dtr = &uslcom_set_dtr,
217 	.ucom_cfg_set_rts = &uslcom_set_rts,
218 	.ucom_cfg_set_break = &uslcom_set_break,
219 	.ucom_ioctl = &uslcom_ioctl,
220 	.ucom_cfg_param = &uslcom_param,
221 	.ucom_pre_param = &uslcom_pre_param,
222 	.ucom_start_read = &uslcom_start_read,
223 	.ucom_stop_read = &uslcom_stop_read,
224 	.ucom_start_write = &uslcom_start_write,
225 	.ucom_stop_write = &uslcom_stop_write,
226 	.ucom_poll = &uslcom_poll,
227 	.ucom_free = &uslcom_free,
228 };
229 
230 static const STRUCT_USB_HOST_ID uslcom_devs[] = {
231 #define	USLCOM_DEV(v,p)  { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) }
232     USLCOM_DEV(BALTECH, CARDREADER),
233     USLCOM_DEV(CLIPSAL, 5000CT2),
234     USLCOM_DEV(CLIPSAL, 5500PACA),
235     USLCOM_DEV(CLIPSAL, 5500PCU),
236     USLCOM_DEV(CLIPSAL, 560884),
237     USLCOM_DEV(CLIPSAL, 5800PC),
238     USLCOM_DEV(CLIPSAL, C5000CT2),
239     USLCOM_DEV(CLIPSAL, L51xx),
240     USLCOM_DEV(DATAAPEX, MULTICOM),
241     USLCOM_DEV(DELL, DW700),
242     USLCOM_DEV(DIGIANSWER, ZIGBEE802154),
243     USLCOM_DEV(DYNASTREAM, ANTDEVBOARD),
244     USLCOM_DEV(DYNASTREAM, ANTDEVBOARD2),
245     USLCOM_DEV(DYNASTREAM, ANT2USB),
246     USLCOM_DEV(ELV, USBI2C),
247     USLCOM_DEV(FESTO, CMSP),
248     USLCOM_DEV(FESTO, CPX_USB),
249     USLCOM_DEV(FOXCONN, PIRELLI_DP_L10),
250     USLCOM_DEV(FOXCONN, TCOM_TC_300),
251     USLCOM_DEV(GEMALTO, PROXPU),
252     USLCOM_DEV(JABLOTRON, PC60B),
253     USLCOM_DEV(KAMSTRUP, OPTICALEYE),
254     USLCOM_DEV(KAMSTRUP, MBUS_250D),
255     USLCOM_DEV(LINKINSTRUMENTS, MSO19),
256     USLCOM_DEV(LINKINSTRUMENTS, MSO28),
257     USLCOM_DEV(LINKINSTRUMENTS, MSO28_2),
258     USLCOM_DEV(MEI, CASHFLOW_SC),
259     USLCOM_DEV(MEI, S2000),
260     USLCOM_DEV(OWEN, AC4),
261     USLCOM_DEV(PHILIPS, ACE1001),
262     USLCOM_DEV(PLX, CA42),
263     USLCOM_DEV(RENESAS, RX610),
264     USLCOM_DEV(SILABS, AC_SERV_CAN),
265     USLCOM_DEV(SILABS, AC_SERV_CIS),
266     USLCOM_DEV(SILABS, AC_SERV_IBUS),
267     USLCOM_DEV(SILABS, AC_SERV_OBD),
268     USLCOM_DEV(SILABS, AEROCOMM),
269     USLCOM_DEV(SILABS, AMBER_AMB2560),
270     USLCOM_DEV(SILABS, ARGUSISP),
271     USLCOM_DEV(SILABS, ARKHAM_DS101_A),
272     USLCOM_DEV(SILABS, ARKHAM_DS101_M),
273     USLCOM_DEV(SILABS, ARYGON_MIFARE),
274     USLCOM_DEV(SILABS, AVIT_USB_TTL),
275     USLCOM_DEV(SILABS, B_G_H3000),
276     USLCOM_DEV(SILABS, BALLUFF_RFID),
277     USLCOM_DEV(SILABS, BEI_VCP),
278     USLCOM_DEV(SILABS, BSM7DUSB),
279     USLCOM_DEV(SILABS, BURNSIDE),
280     USLCOM_DEV(SILABS, C2_EDGE_MODEM),
281     USLCOM_DEV(SILABS, CP2102),
282     USLCOM_DEV(SILABS, CP210X_2),
283     USLCOM_DEV(SILABS, CP210X_3),
284     USLCOM_DEV(SILABS, CP210X_4),
285     USLCOM_DEV(SILABS, CRUMB128),
286     USLCOM_DEV(SILABS, CYGNAL),
287     USLCOM_DEV(SILABS, CYGNAL_DEBUG),
288     USLCOM_DEV(SILABS, CYGNAL_GPS),
289     USLCOM_DEV(SILABS, DEGREE),
290     USLCOM_DEV(SILABS, DEKTEK_DTAPLUS),
291     USLCOM_DEV(SILABS, EMS_C1007),
292     USLCOM_DEV(SILABS, HAMLINKUSB),
293     USLCOM_DEV(SILABS, HELICOM),
294     USLCOM_DEV(SILABS, IMS_USB_RS422),
295     USLCOM_DEV(SILABS, INFINITY_MIC),
296     USLCOM_DEV(SILABS, INSYS_MODEM),
297     USLCOM_DEV(SILABS, IRZ_SG10),
298     USLCOM_DEV(SILABS, KYOCERA_GPS),
299     USLCOM_DEV(SILABS, LIPOWSKY_HARP),
300     USLCOM_DEV(SILABS, LIPOWSKY_JTAG),
301     USLCOM_DEV(SILABS, LIPOWSKY_LIN),
302     USLCOM_DEV(SILABS, MC35PU),
303     USLCOM_DEV(SILABS, MJS_TOSLINK),
304     USLCOM_DEV(SILABS, MSD_DASHHAWK),
305     USLCOM_DEV(SILABS, MULTIPLEX_RC),
306     USLCOM_DEV(SILABS, OPTRIS_MSPRO),
307     USLCOM_DEV(SILABS, POLOLU),
308     USLCOM_DEV(SILABS, PROCYON_AVS),
309     USLCOM_DEV(SILABS, SB_PARAMOUNT_ME),
310     USLCOM_DEV(SILABS, SUUNTO),
311     USLCOM_DEV(SILABS, TAMSMASTER),
312     USLCOM_DEV(SILABS, TELEGESIS_ETRX2),
313     USLCOM_DEV(SILABS, TRACIENT),
314     USLCOM_DEV(SILABS, TRAQMATE),
315     USLCOM_DEV(SILABS, USBCOUNT50),
316     USLCOM_DEV(SILABS, USBPULSE100),
317     USLCOM_DEV(SILABS, USBSCOPE50),
318     USLCOM_DEV(SILABS, USBWAVE12),
319     USLCOM_DEV(SILABS, VSTABI),
320     USLCOM_DEV(SILABS, WAVIT),
321     USLCOM_DEV(SILABS, WMRBATT),
322     USLCOM_DEV(SILABS, WMRRIGBLASTER),
323     USLCOM_DEV(SILABS, WMRRIGTALK),
324     USLCOM_DEV(SILABS, ZEPHYR_BIO),
325     USLCOM_DEV(SILABS2, DCU11CLONE),
326     USLCOM_DEV(SILABS3, GPRS_MODEM),
327     USLCOM_DEV(SILABS4, 100EU_MODEM),
328     USLCOM_DEV(SYNTECH, CYPHERLAB100),
329     USLCOM_DEV(USI, MC60),
330     USLCOM_DEV(VAISALA, CABLE),
331     USLCOM_DEV(WAGO, SERVICECABLE),
332     USLCOM_DEV(WAVESENSE, JAZZ),
333     USLCOM_DEV(WIENERPLEINBAUS, PL512),
334     USLCOM_DEV(WIENERPLEINBAUS, RCM),
335     USLCOM_DEV(WIENERPLEINBAUS, MPOD),
336     USLCOM_DEV(WIENERPLEINBAUS, CML),
337 #undef USLCOM_DEV
338 };
339 
340 static device_method_t uslcom_methods[] = {
341 	DEVMETHOD(device_probe, uslcom_probe),
342 	DEVMETHOD(device_attach, uslcom_attach),
343 	DEVMETHOD(device_detach, uslcom_detach),
344 	DEVMETHOD_END
345 };
346 
347 static devclass_t uslcom_devclass;
348 
349 static driver_t uslcom_driver = {
350 	.name = "uslcom",
351 	.methods = uslcom_methods,
352 	.size = sizeof(struct uslcom_softc),
353 };
354 
355 DRIVER_MODULE(uslcom, uhub, uslcom_driver, uslcom_devclass, NULL, 0);
356 MODULE_DEPEND(uslcom, ucom, 1, 1, 1);
357 MODULE_DEPEND(uslcom, usb, 1, 1, 1);
358 MODULE_VERSION(uslcom, 1);
359 
360 static void
361 uslcom_watchdog(void *arg)
362 {
363 	struct uslcom_softc *sc = arg;
364 
365 	mtx_assert(&sc->sc_mtx, MA_OWNED);
366 
367 	usbd_transfer_start(sc->sc_xfer[USLCOM_CTRL_DT_RD]);
368 
369 	usb_callout_reset(&sc->sc_watchdog,
370 	    hz / 4, &uslcom_watchdog, sc);
371 }
372 
373 static int
374 uslcom_probe(device_t dev)
375 {
376 	struct usb_attach_arg *uaa = device_get_ivars(dev);
377 
378 	DPRINTFN(11, "\n");
379 
380 	if (uaa->usb_mode != USB_MODE_HOST) {
381 		return (ENXIO);
382 	}
383 	if (uaa->info.bConfigIndex != USLCOM_CONFIG_INDEX) {
384 		return (ENXIO);
385 	}
386 	return (usbd_lookup_id_by_uaa(uslcom_devs, sizeof(uslcom_devs), uaa));
387 }
388 
389 static int
390 uslcom_attach(device_t dev)
391 {
392 	struct usb_attach_arg *uaa = device_get_ivars(dev);
393 	struct uslcom_softc *sc = device_get_softc(dev);
394 	int error;
395 
396 	DPRINTFN(11, "\n");
397 
398 	device_set_usb_desc(dev);
399 	mtx_init(&sc->sc_mtx, "uslcom", NULL, MTX_DEF);
400 	ucom_ref(&sc->sc_super_ucom);
401 	usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_mtx, 0);
402 
403 	sc->sc_udev = uaa->device;
404 	/* use the interface number from the USB interface descriptor */
405 	sc->sc_iface_no = uaa->info.bIfaceNum;
406 
407 	error = usbd_transfer_setup(uaa->device,
408 	    &uaa->info.bIfaceIndex, sc->sc_xfer, uslcom_config,
409 	    USLCOM_N_TRANSFER, sc, &sc->sc_mtx);
410 	if (error) {
411 		DPRINTF("one or more missing USB endpoints, "
412 		    "error=%s\n", usbd_errstr(error));
413 		goto detach;
414 	}
415 	/* clear stall at first run */
416 	mtx_lock(&sc->sc_mtx);
417 	usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_WR]);
418 	usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_RD]);
419 	mtx_unlock(&sc->sc_mtx);
420 
421 	sc->sc_partnum = uslcom_get_partnum(sc);
422 
423 	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
424 	    &uslcom_callback, &sc->sc_mtx);
425 	if (error) {
426 		goto detach;
427 	}
428 	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
429 
430 	return (0);
431 
432 detach:
433 	uslcom_detach(dev);
434 	return (ENXIO);
435 }
436 
437 static int
438 uslcom_detach(device_t dev)
439 {
440 	struct uslcom_softc *sc = device_get_softc(dev);
441 
442 	DPRINTF("sc=%p\n", sc);
443 
444 	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
445 	usbd_transfer_unsetup(sc->sc_xfer, USLCOM_N_TRANSFER);
446 
447 	usb_callout_drain(&sc->sc_watchdog);
448 
449 	device_claim_softc(dev);
450 
451 	uslcom_free_softc(sc);
452 
453 	return (0);
454 }
455 
456 UCOM_UNLOAD_DRAIN(uslcom);
457 
458 static void
459 uslcom_free_softc(struct uslcom_softc *sc)
460 {
461 	if (ucom_unref(&sc->sc_super_ucom)) {
462 		mtx_destroy(&sc->sc_mtx);
463 		device_free_softc(sc);
464 	}
465 }
466 
467 static void
468 uslcom_free(struct ucom_softc *ucom)
469 {
470 	uslcom_free_softc(ucom->sc_parent);
471 }
472 
473 static void
474 uslcom_open(struct ucom_softc *ucom)
475 {
476 	struct uslcom_softc *sc = ucom->sc_parent;
477 	struct usb_device_request req;
478 
479 	req.bmRequestType = USLCOM_WRITE;
480 	req.bRequest = USLCOM_IFC_ENABLE;
481 	USETW(req.wValue, USLCOM_IFC_ENABLE_EN);
482 	USETW(req.wIndex, sc->sc_iface_no);
483 	USETW(req.wLength, 0);
484 
485         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
486 	    &req, NULL, 0, 1000)) {
487 		DPRINTF("UART enable failed (ignored)\n");
488 	}
489 
490 	/* start polling status */
491 	uslcom_watchdog(sc);
492 }
493 
494 static void
495 uslcom_close(struct ucom_softc *ucom)
496 {
497 	struct uslcom_softc *sc = ucom->sc_parent;
498 	struct usb_device_request req;
499 
500 	/* stop polling status */
501 	usb_callout_stop(&sc->sc_watchdog);
502 
503 	req.bmRequestType = USLCOM_WRITE;
504 	req.bRequest = USLCOM_IFC_ENABLE;
505 	USETW(req.wValue, USLCOM_IFC_ENABLE_DIS);
506 	USETW(req.wIndex, sc->sc_iface_no);
507 	USETW(req.wLength, 0);
508 
509 	if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
510 	    &req, NULL, 0, 1000)) {
511 		DPRINTF("UART disable failed (ignored)\n");
512 	}
513 }
514 
515 static uint8_t
516 uslcom_get_partnum(struct uslcom_softc *sc)
517 {
518 	struct usb_device_request req;
519 	uint8_t partnum;
520 
521 	/* Find specific chip type */
522 	partnum = 0;
523 	req.bmRequestType = USLCOM_READ;
524 	req.bRequest = USLCOM_VENDOR_SPECIFIC;
525 	USETW(req.wValue, USLCOM_GET_PARTNUM);
526 	USETW(req.wIndex, sc->sc_iface_no);
527 	USETW(req.wLength, sizeof(partnum));
528 
529 	if (usbd_do_request_flags(sc->sc_udev, NULL,
530 	    &req, &partnum, 0, NULL, 1000)) {
531 		DPRINTF("GET_PARTNUM failed\n");
532 	}
533 
534 	return(partnum);
535 }
536 
537 static void
538 uslcom_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
539 {
540         struct uslcom_softc *sc = ucom->sc_parent;
541 	struct usb_device_request req;
542 	uint16_t ctl;
543 
544         DPRINTF("onoff = %d\n", onoff);
545 
546 	ctl = onoff ? USLCOM_MHS_DTR_ON : 0;
547 	ctl |= USLCOM_MHS_DTR_SET;
548 
549 	req.bmRequestType = USLCOM_WRITE;
550 	req.bRequest = USLCOM_SET_MHS;
551 	USETW(req.wValue, ctl);
552 	USETW(req.wIndex, sc->sc_iface_no);
553 	USETW(req.wLength, 0);
554 
555         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
556 	    &req, NULL, 0, 1000)) {
557 		DPRINTF("Setting DTR failed (ignored)\n");
558 	}
559 }
560 
561 static void
562 uslcom_set_rts(struct ucom_softc *ucom, uint8_t onoff)
563 {
564         struct uslcom_softc *sc = ucom->sc_parent;
565 	struct usb_device_request req;
566 	uint16_t ctl;
567 
568         DPRINTF("onoff = %d\n", onoff);
569 
570 	ctl = onoff ? USLCOM_MHS_RTS_ON : 0;
571 	ctl |= USLCOM_MHS_RTS_SET;
572 
573 	req.bmRequestType = USLCOM_WRITE;
574 	req.bRequest = USLCOM_SET_MHS;
575 	USETW(req.wValue, ctl);
576 	USETW(req.wIndex, sc->sc_iface_no);
577 	USETW(req.wLength, 0);
578 
579         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
580 	    &req, NULL, 0, 1000)) {
581 		DPRINTF("Setting DTR failed (ignored)\n");
582 	}
583 }
584 
585 static int
586 uslcom_pre_param(struct ucom_softc *ucom, struct termios *t)
587 {
588 	if (t->c_ospeed <= 0 || t->c_ospeed > 921600)
589 		return (EINVAL);
590 	return (0);
591 }
592 
593 static void
594 uslcom_param(struct ucom_softc *ucom, struct termios *t)
595 {
596 	struct uslcom_softc *sc = ucom->sc_parent;
597 	struct usb_device_request req;
598 	uint32_t baudrate, flowctrl[4];
599 	uint16_t data;
600 
601 	DPRINTF("\n");
602 
603 	baudrate = t->c_ospeed;
604 	req.bmRequestType = USLCOM_WRITE;
605 	req.bRequest = USLCOM_SET_BAUDRATE;
606 	USETW(req.wValue, 0);
607 	USETW(req.wIndex, sc->sc_iface_no);
608 	USETW(req.wLength, sizeof(baudrate));
609 
610 	if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
611 	    &req, &baudrate, 0, 1000)) {
612 		DPRINTF("Set baudrate failed (ignored)\n");
613 	}
614 
615 	if (t->c_cflag & CSTOPB)
616 		data = USLCOM_STOP_BITS_2;
617 	else
618 		data = USLCOM_STOP_BITS_1;
619 	if (t->c_cflag & PARENB) {
620 		if (t->c_cflag & PARODD)
621 			data |= USLCOM_PARITY_ODD;
622 		else
623 			data |= USLCOM_PARITY_EVEN;
624 	} else
625 		data |= USLCOM_PARITY_NONE;
626 	switch (t->c_cflag & CSIZE) {
627 	case CS5:
628 		data |= USLCOM_SET_DATA_BITS(5);
629 		break;
630 	case CS6:
631 		data |= USLCOM_SET_DATA_BITS(6);
632 		break;
633 	case CS7:
634 		data |= USLCOM_SET_DATA_BITS(7);
635 		break;
636 	case CS8:
637 		data |= USLCOM_SET_DATA_BITS(8);
638 		break;
639 	}
640 
641 	req.bmRequestType = USLCOM_WRITE;
642 	req.bRequest = USLCOM_SET_LINE_CTL;
643 	USETW(req.wValue, data);
644 	USETW(req.wIndex, sc->sc_iface_no);
645 	USETW(req.wLength, 0);
646 
647         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
648 	    &req, NULL, 0, 1000)) {
649 		DPRINTF("Set format failed (ignored)\n");
650 	}
651 
652 	if (t->c_cflag & CRTSCTS) {
653 		flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON | USLCOM_FLOW_CTS_HS);
654 		flowctrl[1] = htole32(USLCOM_FLOW_RTS_HS);
655 	} else {
656 		flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON);
657 		flowctrl[1] = htole32(USLCOM_FLOW_RTS_ON);
658 	}
659 	flowctrl[2] = 0;
660 	flowctrl[3] = 0;
661 	req.bmRequestType = USLCOM_WRITE;
662 	req.bRequest = USLCOM_SET_FLOW;
663 	USETW(req.wValue, 0);
664 	USETW(req.wIndex, sc->sc_iface_no);
665 	USETW(req.wLength, sizeof(flowctrl));
666 
667 	if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
668 	    &req, flowctrl, 0, 1000)) {
669 		DPRINTF("Set flowcontrol failed (ignored)\n");
670 	}
671 }
672 
673 static void
674 uslcom_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
675 {
676 	struct uslcom_softc *sc = ucom->sc_parent;
677 
678 	DPRINTF("\n");
679 
680 	*lsr = sc->sc_lsr;
681 	*msr = sc->sc_msr;
682 }
683 
684 static void
685 uslcom_set_break(struct ucom_softc *ucom, uint8_t onoff)
686 {
687         struct uslcom_softc *sc = ucom->sc_parent;
688 	struct usb_device_request req;
689 	uint16_t brk = onoff ? USLCOM_SET_BREAK_ON : USLCOM_SET_BREAK_OFF;
690 
691 	req.bmRequestType = USLCOM_WRITE;
692 	req.bRequest = USLCOM_SET_BREAK;
693 	USETW(req.wValue, brk);
694 	USETW(req.wIndex, sc->sc_iface_no);
695 	USETW(req.wLength, 0);
696 
697         if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
698 	    &req, NULL, 0, 1000)) {
699 		DPRINTF("Set BREAK failed (ignored)\n");
700 	}
701 }
702 
703 static int
704 uslcom_ioctl(struct ucom_softc *ucom, uint32_t cmd, caddr_t data,
705     int flag, struct thread *td)
706 {
707 	struct uslcom_softc *sc = ucom->sc_parent;
708 	struct usb_device_request req;
709 	int error = 0;
710 	uint8_t latch;
711 
712 	DPRINTF("cmd=0x%08x\n", cmd);
713 
714 	switch (cmd) {
715 	case USB_GET_GPIO:
716 		if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) {
717 			error = ENODEV;
718 			break;
719 		}
720 		req.bmRequestType = USLCOM_READ;
721 		req.bRequest = USLCOM_VENDOR_SPECIFIC;
722 		USETW(req.wValue, USLCOM_READ_LATCH);
723 		USETW(req.wIndex, sc->sc_iface_no);
724 		USETW(req.wLength, sizeof(latch));
725 
726 		if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
727 		    &req, &latch, 0, 1000)) {
728 			DPRINTF("Get LATCH failed\n");
729 			error = EIO;
730 		}
731 		*(int *)data = latch;
732 		break;
733 
734 	case USB_SET_GPIO:
735 		if (sc->sc_partnum < USLCOM_PARTNUM_CP2103)
736 			error = ENODEV;
737 		else if ((sc->sc_partnum == USLCOM_PARTNUM_CP2103) ||
738 		    (sc->sc_partnum == USLCOM_PARTNUM_CP2104)) {
739 			req.bmRequestType = USLCOM_WRITE;
740 			req.bRequest = USLCOM_VENDOR_SPECIFIC;
741 			USETW(req.wValue, USLCOM_WRITE_LATCH);
742 			USETW(req.wIndex, (*(int *)data));
743 			USETW(req.wLength, 0);
744 
745 			if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
746 			    &req, NULL, 0, 1000)) {
747 				DPRINTF("Set LATCH failed\n");
748 				error = EIO;
749 			}
750 		} else
751 			error = ENODEV;	/* Not yet */
752 		break;
753 
754 	default:
755 		DPRINTF("Unknown IOCTL\n");
756 		error = ENOIOCTL;
757 		break;
758 	}
759 	return (error);
760 }
761 
762 static void
763 uslcom_write_callback(struct usb_xfer *xfer, usb_error_t error)
764 {
765 	struct uslcom_softc *sc = usbd_xfer_softc(xfer);
766 	struct usb_page_cache *pc;
767 	uint32_t actlen;
768 
769 	switch (USB_GET_STATE(xfer)) {
770 	case USB_ST_SETUP:
771 	case USB_ST_TRANSFERRED:
772 tr_setup:
773 		pc = usbd_xfer_get_frame(xfer, 0);
774 		if (ucom_get_data(&sc->sc_ucom, pc, 0,
775 		    USLCOM_BULK_BUF_SIZE, &actlen)) {
776 
777 			DPRINTF("actlen = %d\n", actlen);
778 
779 			usbd_xfer_set_frame_len(xfer, 0, actlen);
780 			usbd_transfer_submit(xfer);
781 		}
782 		return;
783 
784 	default:			/* Error */
785 		if (error != USB_ERR_CANCELLED) {
786 			/* try to clear stall first */
787 			usbd_xfer_set_stall(xfer);
788 			goto tr_setup;
789 		}
790 		return;
791 	}
792 }
793 
794 static void
795 uslcom_read_callback(struct usb_xfer *xfer, usb_error_t error)
796 {
797 	struct uslcom_softc *sc = usbd_xfer_softc(xfer);
798 	struct usb_page_cache *pc;
799 	int actlen;
800 
801 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
802 
803 	switch (USB_GET_STATE(xfer)) {
804 	case USB_ST_TRANSFERRED:
805 		pc = usbd_xfer_get_frame(xfer, 0);
806 		ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
807 
808 	case USB_ST_SETUP:
809 tr_setup:
810 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
811 		usbd_transfer_submit(xfer);
812 		return;
813 
814 	default:			/* Error */
815 		if (error != USB_ERR_CANCELLED) {
816 			/* try to clear stall first */
817 			usbd_xfer_set_stall(xfer);
818 			goto tr_setup;
819 		}
820 		return;
821 	}
822 }
823 
824 static void
825 uslcom_control_callback(struct usb_xfer *xfer, usb_error_t error)
826 {
827 	struct uslcom_softc *sc = usbd_xfer_softc(xfer);
828 	struct usb_page_cache *pc;
829 	struct usb_device_request req;
830 	uint8_t msr = 0;
831 	uint8_t buf;
832 
833 	switch (USB_GET_STATE(xfer)) {
834 	case USB_ST_TRANSFERRED:
835 		pc = usbd_xfer_get_frame(xfer, 1);
836 		usbd_copy_out(pc, 0, &buf, sizeof(buf));
837 		if (buf & USLCOM_MHS_CTS)
838 			msr |= SER_CTS;
839 		if (buf & USLCOM_MHS_DSR)
840 			msr |= SER_DSR;
841 		if (buf & USLCOM_MHS_RI)
842 			msr |= SER_RI;
843 		if (buf & USLCOM_MHS_DCD)
844 			msr |= SER_DCD;
845 
846 		if (msr != sc->sc_msr) {
847 			DPRINTF("status change msr=0x%02x "
848 			    "(was 0x%02x)\n", msr, sc->sc_msr);
849 			sc->sc_msr = msr;
850 			ucom_status_change(&sc->sc_ucom);
851 		}
852 		break;
853 
854 	case USB_ST_SETUP:
855 		req.bmRequestType = USLCOM_READ;
856 		req.bRequest = USLCOM_GET_MDMSTS;
857 		USETW(req.wValue, 0);
858 		USETW(req.wIndex, sc->sc_iface_no);
859 		USETW(req.wLength, sizeof(buf));
860 
861 		usbd_xfer_set_frames(xfer, 2);
862 		usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
863 		usbd_xfer_set_frame_len(xfer, 1, sizeof(buf));
864 
865 		pc = usbd_xfer_get_frame(xfer, 0);
866 		usbd_copy_in(pc, 0, &req, sizeof(req));
867 		usbd_transfer_submit(xfer);
868 		break;
869 
870 	default:		/* error */
871 		if (error != USB_ERR_CANCELLED)
872 			DPRINTF("error=%s\n", usbd_errstr(error));
873 		break;
874 	}
875 }
876 
877 static void
878 uslcom_start_read(struct ucom_softc *ucom)
879 {
880 	struct uslcom_softc *sc = ucom->sc_parent;
881 
882 	/* start read endpoint */
883 	usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_RD]);
884 }
885 
886 static void
887 uslcom_stop_read(struct ucom_softc *ucom)
888 {
889 	struct uslcom_softc *sc = ucom->sc_parent;
890 
891 	/* stop read endpoint */
892 	usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_RD]);
893 }
894 
895 static void
896 uslcom_start_write(struct ucom_softc *ucom)
897 {
898 	struct uslcom_softc *sc = ucom->sc_parent;
899 
900 	usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_WR]);
901 }
902 
903 static void
904 uslcom_stop_write(struct ucom_softc *ucom)
905 {
906 	struct uslcom_softc *sc = ucom->sc_parent;
907 
908 	usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_WR]);
909 }
910 
911 static void
912 uslcom_poll(struct ucom_softc *ucom)
913 {
914 	struct uslcom_softc *sc = ucom->sc_parent;
915 	usbd_transfer_poll(sc->sc_xfer, USLCOM_N_TRANSFER);
916 }
917