1#include <sys/cdefs.h>
2__FBSDID("$FreeBSD$");
3
4/*-
5 * Copyright (c) 2004 Dag-Erling Coïdan Smørgrav
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer
13 *    in this position and unchanged.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 * 3. The name of the author may not be used to endorse or promote products
18 *    derived from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32/*
33 * Device driver for Cypress CY7C637xx and CY7C640/1xx series USB to
34 * RS232 bridges.
35 */
36
37#include <sys/stdint.h>
38#include <sys/stddef.h>
39#include <sys/param.h>
40#include <sys/queue.h>
41#include <sys/types.h>
42#include <sys/systm.h>
43#include <sys/kernel.h>
44#include <sys/bus.h>
45#include <sys/module.h>
46#include <sys/lock.h>
47#include <sys/mutex.h>
48#include <sys/condvar.h>
49#include <sys/sysctl.h>
50#include <sys/sx.h>
51#include <sys/unistd.h>
52#include <sys/callout.h>
53#include <sys/malloc.h>
54#include <sys/priv.h>
55
56#include <dev/usb/usb.h>
57#include <dev/usb/usbdi.h>
58#include <dev/usb/usbdi_util.h>
59#include <dev/usb/usbhid.h>
60#include "usbdevs.h"
61
62#define	USB_DEBUG_VAR usb_debug
63#include <dev/usb/usb_debug.h>
64#include <dev/usb/usb_process.h>
65
66#include <dev/usb/serial/usb_serial.h>
67
68#define	UCYCOM_MAX_IOLEN	(1024 + 2)	/* bytes */
69
70#define	UCYCOM_IFACE_INDEX	0
71
72enum {
73	UCYCOM_CTRL_RD,
74	UCYCOM_INTR_RD,
75	UCYCOM_N_TRANSFER,
76};
77
78struct ucycom_softc {
79	struct ucom_super_softc sc_super_ucom;
80	struct ucom_softc sc_ucom;
81
82	struct usb_device *sc_udev;
83	struct usb_xfer *sc_xfer[UCYCOM_N_TRANSFER];
84	struct mtx sc_mtx;
85
86	uint32_t sc_model;
87#define	MODEL_CY7C63743		0x63743
88#define	MODEL_CY7C64013		0x64013
89
90	uint16_t sc_flen;		/* feature report length */
91	uint16_t sc_ilen;		/* input report length */
92	uint16_t sc_olen;		/* output report length */
93
94	uint8_t	sc_fid;			/* feature report id */
95	uint8_t	sc_iid;			/* input report id */
96	uint8_t	sc_oid;			/* output report id */
97	uint8_t	sc_cfg;
98#define	UCYCOM_CFG_RESET	0x80
99#define	UCYCOM_CFG_PARODD	0x20
100#define	UCYCOM_CFG_PAREN	0x10
101#define	UCYCOM_CFG_STOPB	0x08
102#define	UCYCOM_CFG_DATAB	0x03
103	uint8_t	sc_ist;			/* status flags from last input */
104	uint8_t	sc_iface_no;
105	uint8_t	sc_temp_cfg[32];
106};
107
108/* prototypes */
109
110static device_probe_t ucycom_probe;
111static device_attach_t ucycom_attach;
112static device_detach_t ucycom_detach;
113static void ucycom_free_softc(struct ucycom_softc *);
114
115static usb_callback_t ucycom_ctrl_write_callback;
116static usb_callback_t ucycom_intr_read_callback;
117
118static void	ucycom_free(struct ucom_softc *);
119static void	ucycom_cfg_open(struct ucom_softc *);
120static void	ucycom_start_read(struct ucom_softc *);
121static void	ucycom_stop_read(struct ucom_softc *);
122static void	ucycom_start_write(struct ucom_softc *);
123static void	ucycom_stop_write(struct ucom_softc *);
124static void	ucycom_cfg_write(struct ucycom_softc *, uint32_t, uint8_t);
125static int	ucycom_pre_param(struct ucom_softc *, struct termios *);
126static void	ucycom_cfg_param(struct ucom_softc *, struct termios *);
127static void	ucycom_poll(struct ucom_softc *ucom);
128
129static const struct usb_config ucycom_config[UCYCOM_N_TRANSFER] = {
130
131	[UCYCOM_CTRL_RD] = {
132		.type = UE_CONTROL,
133		.endpoint = 0x00,	/* Control pipe */
134		.direction = UE_DIR_ANY,
135		.bufsize = (sizeof(struct usb_device_request) + UCYCOM_MAX_IOLEN),
136		.callback = &ucycom_ctrl_write_callback,
137		.timeout = 1000,	/* 1 second */
138	},
139
140	[UCYCOM_INTR_RD] = {
141		.type = UE_INTERRUPT,
142		.endpoint = UE_ADDR_ANY,
143		.direction = UE_DIR_IN,
144		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
145		.bufsize = UCYCOM_MAX_IOLEN,
146		.callback = &ucycom_intr_read_callback,
147	},
148};
149
150static const struct ucom_callback ucycom_callback = {
151	.ucom_cfg_param = &ucycom_cfg_param,
152	.ucom_cfg_open = &ucycom_cfg_open,
153	.ucom_pre_param = &ucycom_pre_param,
154	.ucom_start_read = &ucycom_start_read,
155	.ucom_stop_read = &ucycom_stop_read,
156	.ucom_start_write = &ucycom_start_write,
157	.ucom_stop_write = &ucycom_stop_write,
158	.ucom_poll = &ucycom_poll,
159	.ucom_free = &ucycom_free,
160};
161
162static device_method_t ucycom_methods[] = {
163	DEVMETHOD(device_probe, ucycom_probe),
164	DEVMETHOD(device_attach, ucycom_attach),
165	DEVMETHOD(device_detach, ucycom_detach),
166	DEVMETHOD_END
167};
168
169static devclass_t ucycom_devclass;
170
171static driver_t ucycom_driver = {
172	.name = "ucycom",
173	.methods = ucycom_methods,
174	.size = sizeof(struct ucycom_softc),
175};
176
177/*
178 * Supported devices
179 */
180static const STRUCT_USB_HOST_ID ucycom_devs[] = {
181	{USB_VPI(USB_VENDOR_DELORME, USB_PRODUCT_DELORME_EARTHMATE, MODEL_CY7C64013)},
182};
183
184DRIVER_MODULE(ucycom, uhub, ucycom_driver, ucycom_devclass, NULL, 0);
185MODULE_DEPEND(ucycom, ucom, 1, 1, 1);
186MODULE_DEPEND(ucycom, usb, 1, 1, 1);
187MODULE_VERSION(ucycom, 1);
188USB_PNP_HOST_INFO(ucycom_devs);
189
190#define	UCYCOM_DEFAULT_RATE	 4800
191#define	UCYCOM_DEFAULT_CFG	 0x03	/* N-8-1 */
192
193static int
194ucycom_probe(device_t dev)
195{
196	struct usb_attach_arg *uaa = device_get_ivars(dev);
197
198	if (uaa->usb_mode != USB_MODE_HOST) {
199		return (ENXIO);
200	}
201	if (uaa->info.bConfigIndex != 0) {
202		return (ENXIO);
203	}
204	if (uaa->info.bIfaceIndex != UCYCOM_IFACE_INDEX) {
205		return (ENXIO);
206	}
207	return (usbd_lookup_id_by_uaa(ucycom_devs, sizeof(ucycom_devs), uaa));
208}
209
210static int
211ucycom_attach(device_t dev)
212{
213	struct usb_attach_arg *uaa = device_get_ivars(dev);
214	struct ucycom_softc *sc = device_get_softc(dev);
215	void *urd_ptr = NULL;
216	int32_t error;
217	uint16_t urd_len;
218	uint8_t iface_index;
219
220	sc->sc_udev = uaa->device;
221
222	device_set_usb_desc(dev);
223	mtx_init(&sc->sc_mtx, "ucycom", NULL, MTX_DEF);
224	ucom_ref(&sc->sc_super_ucom);
225
226	DPRINTF("\n");
227
228	/* get chip model */
229	sc->sc_model = USB_GET_DRIVER_INFO(uaa);
230	if (sc->sc_model == 0) {
231		device_printf(dev, "unsupported device\n");
232		goto detach;
233	}
234	device_printf(dev, "Cypress CY7C%X USB to RS232 bridge\n", sc->sc_model);
235
236	/* get report descriptor */
237
238	error = usbd_req_get_hid_desc(uaa->device, NULL,
239	    &urd_ptr, &urd_len, M_USBDEV,
240	    UCYCOM_IFACE_INDEX);
241
242	if (error) {
243		device_printf(dev, "failed to get report "
244		    "descriptor: %s\n",
245		    usbd_errstr(error));
246		goto detach;
247	}
248	/* get report sizes */
249
250	sc->sc_flen = hid_report_size(urd_ptr, urd_len, hid_feature, &sc->sc_fid);
251	sc->sc_ilen = hid_report_size(urd_ptr, urd_len, hid_input, &sc->sc_iid);
252	sc->sc_olen = hid_report_size(urd_ptr, urd_len, hid_output, &sc->sc_oid);
253
254	if ((sc->sc_ilen > UCYCOM_MAX_IOLEN) || (sc->sc_ilen < 1) ||
255	    (sc->sc_olen > UCYCOM_MAX_IOLEN) || (sc->sc_olen < 2) ||
256	    (sc->sc_flen > UCYCOM_MAX_IOLEN) || (sc->sc_flen < 5)) {
257		device_printf(dev, "invalid report size i=%d, o=%d, f=%d, max=%d\n",
258		    sc->sc_ilen, sc->sc_olen, sc->sc_flen,
259		    UCYCOM_MAX_IOLEN);
260		goto detach;
261	}
262	sc->sc_iface_no = uaa->info.bIfaceNum;
263
264	iface_index = UCYCOM_IFACE_INDEX;
265	error = usbd_transfer_setup(uaa->device, &iface_index,
266	    sc->sc_xfer, ucycom_config, UCYCOM_N_TRANSFER,
267	    sc, &sc->sc_mtx);
268	if (error) {
269		device_printf(dev, "allocating USB "
270		    "transfers failed\n");
271		goto detach;
272	}
273	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
274	    &ucycom_callback, &sc->sc_mtx);
275	if (error) {
276		goto detach;
277	}
278	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
279
280	if (urd_ptr) {
281		free(urd_ptr, M_USBDEV);
282	}
283
284	return (0);			/* success */
285
286detach:
287	if (urd_ptr) {
288		free(urd_ptr, M_USBDEV);
289	}
290	ucycom_detach(dev);
291	return (ENXIO);
292}
293
294static int
295ucycom_detach(device_t dev)
296{
297	struct ucycom_softc *sc = device_get_softc(dev);
298
299	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
300	usbd_transfer_unsetup(sc->sc_xfer, UCYCOM_N_TRANSFER);
301
302	device_claim_softc(dev);
303
304	ucycom_free_softc(sc);
305
306	return (0);
307}
308
309UCOM_UNLOAD_DRAIN(ucycom);
310
311static void
312ucycom_free_softc(struct ucycom_softc *sc)
313{
314	if (ucom_unref(&sc->sc_super_ucom)) {
315		mtx_destroy(&sc->sc_mtx);
316		device_free_softc(sc);
317	}
318}
319
320static void
321ucycom_free(struct ucom_softc *ucom)
322{
323	ucycom_free_softc(ucom->sc_parent);
324}
325
326static void
327ucycom_cfg_open(struct ucom_softc *ucom)
328{
329	struct ucycom_softc *sc = ucom->sc_parent;
330
331	/* set default configuration */
332	ucycom_cfg_write(sc, UCYCOM_DEFAULT_RATE, UCYCOM_DEFAULT_CFG);
333}
334
335static void
336ucycom_start_read(struct ucom_softc *ucom)
337{
338	struct ucycom_softc *sc = ucom->sc_parent;
339
340	usbd_transfer_start(sc->sc_xfer[UCYCOM_INTR_RD]);
341}
342
343static void
344ucycom_stop_read(struct ucom_softc *ucom)
345{
346	struct ucycom_softc *sc = ucom->sc_parent;
347
348	usbd_transfer_stop(sc->sc_xfer[UCYCOM_INTR_RD]);
349}
350
351static void
352ucycom_start_write(struct ucom_softc *ucom)
353{
354	struct ucycom_softc *sc = ucom->sc_parent;
355
356	usbd_transfer_start(sc->sc_xfer[UCYCOM_CTRL_RD]);
357}
358
359static void
360ucycom_stop_write(struct ucom_softc *ucom)
361{
362	struct ucycom_softc *sc = ucom->sc_parent;
363
364	usbd_transfer_stop(sc->sc_xfer[UCYCOM_CTRL_RD]);
365}
366
367static void
368ucycom_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
369{
370	struct ucycom_softc *sc = usbd_xfer_softc(xfer);
371	struct usb_device_request req;
372	struct usb_page_cache *pc0, *pc1;
373	uint8_t data[2];
374	uint8_t offset;
375	uint32_t actlen;
376
377	pc0 = usbd_xfer_get_frame(xfer, 0);
378	pc1 = usbd_xfer_get_frame(xfer, 1);
379
380	switch (USB_GET_STATE(xfer)) {
381	case USB_ST_TRANSFERRED:
382tr_transferred:
383	case USB_ST_SETUP:
384
385		switch (sc->sc_model) {
386		case MODEL_CY7C63743:
387			offset = 1;
388			break;
389		case MODEL_CY7C64013:
390			offset = 2;
391			break;
392		default:
393			offset = 0;
394			break;
395		}
396
397		if (ucom_get_data(&sc->sc_ucom, pc1, offset,
398		    sc->sc_olen - offset, &actlen)) {
399
400			req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
401			req.bRequest = UR_SET_REPORT;
402			USETW2(req.wValue, UHID_OUTPUT_REPORT, sc->sc_oid);
403			req.wIndex[0] = sc->sc_iface_no;
404			req.wIndex[1] = 0;
405			USETW(req.wLength, sc->sc_olen);
406
407			switch (sc->sc_model) {
408			case MODEL_CY7C63743:
409				data[0] = actlen;
410				break;
411			case MODEL_CY7C64013:
412				data[0] = 0;
413				data[1] = actlen;
414				break;
415			default:
416				break;
417			}
418
419			usbd_copy_in(pc0, 0, &req, sizeof(req));
420			usbd_copy_in(pc1, 0, data, offset);
421
422			usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
423			usbd_xfer_set_frame_len(xfer, 1, sc->sc_olen);
424			usbd_xfer_set_frames(xfer, sc->sc_olen ? 2 : 1);
425			usbd_transfer_submit(xfer);
426		}
427		return;
428
429	default:			/* Error */
430		if (error == USB_ERR_CANCELLED) {
431			return;
432		}
433		DPRINTF("error=%s\n",
434		    usbd_errstr(error));
435		goto tr_transferred;
436	}
437}
438
439static void
440ucycom_cfg_write(struct ucycom_softc *sc, uint32_t baud, uint8_t cfg)
441{
442	struct usb_device_request req;
443	uint16_t len;
444	usb_error_t err;
445
446	len = sc->sc_flen;
447	if (len > sizeof(sc->sc_temp_cfg)) {
448		len = sizeof(sc->sc_temp_cfg);
449	}
450	sc->sc_cfg = cfg;
451
452	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
453	req.bRequest = UR_SET_REPORT;
454	USETW2(req.wValue, UHID_FEATURE_REPORT, sc->sc_fid);
455	req.wIndex[0] = sc->sc_iface_no;
456	req.wIndex[1] = 0;
457	USETW(req.wLength, len);
458
459	sc->sc_temp_cfg[0] = (baud & 0xff);
460	sc->sc_temp_cfg[1] = (baud >> 8) & 0xff;
461	sc->sc_temp_cfg[2] = (baud >> 16) & 0xff;
462	sc->sc_temp_cfg[3] = (baud >> 24) & 0xff;
463	sc->sc_temp_cfg[4] = cfg;
464
465	err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
466	    &req, sc->sc_temp_cfg, 0, 1000);
467	if (err) {
468		DPRINTFN(0, "device request failed, err=%s "
469		    "(ignored)\n", usbd_errstr(err));
470	}
471}
472
473static int
474ucycom_pre_param(struct ucom_softc *ucom, struct termios *t)
475{
476	switch (t->c_ospeed) {
477		case 600:
478		case 1200:
479		case 2400:
480		case 4800:
481		case 9600:
482		case 19200:
483		case 38400:
484		case 57600:
485#if 0
486		/*
487		 * Stock chips only support standard baud rates in the 600 - 57600
488		 * range, but higher rates can be achieved using custom firmware.
489		 */
490		case 115200:
491		case 153600:
492		case 192000:
493#endif
494		break;
495	default:
496		return (EINVAL);
497	}
498	return (0);
499}
500
501static void
502ucycom_cfg_param(struct ucom_softc *ucom, struct termios *t)
503{
504	struct ucycom_softc *sc = ucom->sc_parent;
505	uint8_t cfg;
506
507	DPRINTF("\n");
508
509	if (t->c_cflag & CIGNORE) {
510		cfg = sc->sc_cfg;
511	} else {
512		cfg = 0;
513		switch (t->c_cflag & CSIZE) {
514		default:
515		case CS8:
516			++cfg;
517		case CS7:
518			++cfg;
519		case CS6:
520			++cfg;
521		case CS5:
522			break;
523		}
524
525		if (t->c_cflag & CSTOPB)
526			cfg |= UCYCOM_CFG_STOPB;
527		if (t->c_cflag & PARENB)
528			cfg |= UCYCOM_CFG_PAREN;
529		if (t->c_cflag & PARODD)
530			cfg |= UCYCOM_CFG_PARODD;
531	}
532
533	ucycom_cfg_write(sc, t->c_ospeed, cfg);
534}
535
536static void
537ucycom_intr_read_callback(struct usb_xfer *xfer, usb_error_t error)
538{
539	struct ucycom_softc *sc = usbd_xfer_softc(xfer);
540	struct usb_page_cache *pc;
541	uint8_t buf[2];
542	uint32_t offset;
543	int len;
544	int actlen;
545
546	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
547	pc = usbd_xfer_get_frame(xfer, 0);
548
549	switch (USB_GET_STATE(xfer)) {
550	case USB_ST_TRANSFERRED:
551		switch (sc->sc_model) {
552		case MODEL_CY7C63743:
553			if (actlen < 1) {
554				goto tr_setup;
555			}
556			usbd_copy_out(pc, 0, buf, 1);
557
558			sc->sc_ist = buf[0] & ~0x07;
559			len = buf[0] & 0x07;
560
561			actlen--;
562			offset = 1;
563
564			break;
565
566		case MODEL_CY7C64013:
567			if (actlen < 2) {
568				goto tr_setup;
569			}
570			usbd_copy_out(pc, 0, buf, 2);
571
572			sc->sc_ist = buf[0] & ~0x07;
573			len = buf[1];
574
575			actlen -= 2;
576			offset = 2;
577
578			break;
579
580		default:
581			DPRINTFN(0, "unsupported model number\n");
582			goto tr_setup;
583		}
584
585		if (len > actlen)
586			len = actlen;
587		if (len)
588			ucom_put_data(&sc->sc_ucom, pc, offset, len);
589		/* FALLTHROUGH */
590	case USB_ST_SETUP:
591tr_setup:
592		usbd_xfer_set_frame_len(xfer, 0, sc->sc_ilen);
593		usbd_transfer_submit(xfer);
594		return;
595
596	default:			/* Error */
597		if (error != USB_ERR_CANCELLED) {
598			/* try to clear stall first */
599			usbd_xfer_set_stall(xfer);
600			goto tr_setup;
601		}
602		return;
603
604	}
605}
606
607static void
608ucycom_poll(struct ucom_softc *ucom)
609{
610	struct ucycom_softc *sc = ucom->sc_parent;
611	usbd_transfer_poll(sc->sc_xfer, UCYCOM_N_TRANSFER);
612}
613