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