2 /* $OpenBSD: umoscom.c,v 1.2 2006/10/26 06:02:43 jsg Exp $ */
5 * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
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.
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.
20 #include <sys/stdint.h>
21 #include <sys/stddef.h>
22 #include <sys/param.h>
23 #include <sys/queue.h>
24 #include <sys/types.h>
25 #include <sys/systm.h>
26 #include <sys/kernel.h>
28 #include <sys/linker_set.h>
29 #include <sys/module.h>
31 #include <sys/mutex.h>
32 #include <sys/condvar.h>
33 #include <sys/sysctl.h>
35 #include <sys/unistd.h>
36 #include <sys/callout.h>
37 #include <sys/malloc.h>
40 #include <dev/usb/usb.h>
41 #include <dev/usb/usbdi.h>
42 #include <dev/usb/usbdi_util.h>
45 #define USB_DEBUG_VAR umoscom_debug
46 #include <dev/usb/usb_debug.h>
47 #include <dev/usb/usb_process.h>
49 #include <dev/usb/serial/usb_serial.h>
52 static int umoscom_debug = 0;
54 SYSCTL_NODE(_hw_usb, OID_AUTO, umoscom, CTLFLAG_RW, 0, "USB umoscom");
55 SYSCTL_INT(_hw_usb_umoscom, OID_AUTO, debug, CTLFLAG_RW,
56 &umoscom_debug, 0, "Debug level");
59 #define UMOSCOM_BUFSIZE 1024 /* bytes */
61 #define UMOSCOM_CONFIG_INDEX 0
62 #define UMOSCOM_IFACE_INDEX 0
64 /* interrupt packet */
65 #define UMOSCOM_IIR_RLS 0x06
66 #define UMOSCOM_IIR_RDA 0x04
67 #define UMOSCOM_IIR_CTI 0x0c
68 #define UMOSCOM_IIR_THR 0x02
69 #define UMOSCOM_IIR_MS 0x00
72 #define UMOSCOM_READ 0x0d
73 #define UMOSCOM_WRITE 0x0e
74 #define UMOSCOM_UART_REG 0x0300
75 #define UMOSCOM_VEND_REG 0x0000
77 #define UMOSCOM_TXBUF 0x00 /* Write */
78 #define UMOSCOM_RXBUF 0x00 /* Read */
79 #define UMOSCOM_INT 0x01
80 #define UMOSCOM_FIFO 0x02 /* Write */
81 #define UMOSCOM_ISR 0x02 /* Read */
82 #define UMOSCOM_LCR 0x03
83 #define UMOSCOM_MCR 0x04
84 #define UMOSCOM_LSR 0x05
85 #define UMOSCOM_MSR 0x06
86 #define UMOSCOM_SCRATCH 0x07
87 #define UMOSCOM_DIV_LO 0x08
88 #define UMOSCOM_DIV_HI 0x09
89 #define UMOSCOM_EFR 0x0a
90 #define UMOSCOM_XON1 0x0b
91 #define UMOSCOM_XON2 0x0c
92 #define UMOSCOM_XOFF1 0x0d
93 #define UMOSCOM_XOFF2 0x0e
95 #define UMOSCOM_BAUDLO 0x00
96 #define UMOSCOM_BAUDHI 0x01
98 #define UMOSCOM_INT_RXEN 0x01
99 #define UMOSCOM_INT_TXEN 0x02
100 #define UMOSCOM_INT_RSEN 0x04
101 #define UMOSCOM_INT_MDMEM 0x08
102 #define UMOSCOM_INT_SLEEP 0x10
103 #define UMOSCOM_INT_XOFF 0x20
104 #define UMOSCOM_INT_RTS 0x40
106 #define UMOSCOM_FIFO_EN 0x01
107 #define UMOSCOM_FIFO_RXCLR 0x02
108 #define UMOSCOM_FIFO_TXCLR 0x04
109 #define UMOSCOM_FIFO_DMA_BLK 0x08
110 #define UMOSCOM_FIFO_TXLVL_MASK 0x30
111 #define UMOSCOM_FIFO_TXLVL_8 0x00
112 #define UMOSCOM_FIFO_TXLVL_16 0x10
113 #define UMOSCOM_FIFO_TXLVL_32 0x20
114 #define UMOSCOM_FIFO_TXLVL_56 0x30
115 #define UMOSCOM_FIFO_RXLVL_MASK 0xc0
116 #define UMOSCOM_FIFO_RXLVL_8 0x00
117 #define UMOSCOM_FIFO_RXLVL_16 0x40
118 #define UMOSCOM_FIFO_RXLVL_56 0x80
119 #define UMOSCOM_FIFO_RXLVL_80 0xc0
121 #define UMOSCOM_ISR_MDM 0x00
122 #define UMOSCOM_ISR_NONE 0x01
123 #define UMOSCOM_ISR_TX 0x02
124 #define UMOSCOM_ISR_RX 0x04
125 #define UMOSCOM_ISR_LINE 0x06
126 #define UMOSCOM_ISR_RXTIMEOUT 0x0c
127 #define UMOSCOM_ISR_RX_XOFF 0x10
128 #define UMOSCOM_ISR_RTSCTS 0x20
129 #define UMOSCOM_ISR_FIFOEN 0xc0
131 #define UMOSCOM_LCR_DBITS(x) ((x) - 5)
132 #define UMOSCOM_LCR_STOP_BITS_1 0x00
133 #define UMOSCOM_LCR_STOP_BITS_2 0x04 /* 2 if 6-8 bits/char or 1.5 if 5 */
134 #define UMOSCOM_LCR_PARITY_NONE 0x00
135 #define UMOSCOM_LCR_PARITY_ODD 0x08
136 #define UMOSCOM_LCR_PARITY_EVEN 0x18
137 #define UMOSCOM_LCR_BREAK 0x40
138 #define UMOSCOM_LCR_DIVLATCH_EN 0x80
140 #define UMOSCOM_MCR_DTR 0x01
141 #define UMOSCOM_MCR_RTS 0x02
142 #define UMOSCOM_MCR_LOOP 0x04
143 #define UMOSCOM_MCR_INTEN 0x08
144 #define UMOSCOM_MCR_LOOPBACK 0x10
145 #define UMOSCOM_MCR_XONANY 0x20
146 #define UMOSCOM_MCR_IRDA_EN 0x40
147 #define UMOSCOM_MCR_BAUD_DIV4 0x80
149 #define UMOSCOM_LSR_RXDATA 0x01
150 #define UMOSCOM_LSR_RXOVER 0x02
151 #define UMOSCOM_LSR_RXPAR_ERR 0x04
152 #define UMOSCOM_LSR_RXFRM_ERR 0x08
153 #define UMOSCOM_LSR_RXBREAK 0x10
154 #define UMOSCOM_LSR_TXEMPTY 0x20
155 #define UMOSCOM_LSR_TXALLEMPTY 0x40
156 #define UMOSCOM_LSR_TXFIFO_ERR 0x80
158 #define UMOSCOM_MSR_CTS_CHG 0x01
159 #define UMOSCOM_MSR_DSR_CHG 0x02
160 #define UMOSCOM_MSR_RI_CHG 0x04
161 #define UMOSCOM_MSR_CD_CHG 0x08
162 #define UMOSCOM_MSR_CTS 0x10
163 #define UMOSCOM_MSR_RTS 0x20
164 #define UMOSCOM_MSR_RI 0x40
165 #define UMOSCOM_MSR_CD 0x80
167 #define UMOSCOM_BAUD_REF 115200
176 struct umoscom_softc {
177 struct ucom_super_softc sc_super_ucom;
178 struct ucom_softc sc_ucom;
180 struct usb_xfer *sc_xfer[UMOSCOM_N_TRANSFER];
181 struct usb_device *sc_udev;
190 static device_probe_t umoscom_probe;
191 static device_attach_t umoscom_attach;
192 static device_detach_t umoscom_detach;
194 static usb_callback_t umoscom_write_callback;
195 static usb_callback_t umoscom_read_callback;
196 static usb_callback_t umoscom_intr_callback;
198 static void umoscom_cfg_open(struct ucom_softc *);
199 static void umoscom_cfg_close(struct ucom_softc *);
200 static void umoscom_cfg_set_break(struct ucom_softc *, uint8_t);
201 static void umoscom_cfg_set_dtr(struct ucom_softc *, uint8_t);
202 static void umoscom_cfg_set_rts(struct ucom_softc *, uint8_t);
203 static int umoscom_pre_param(struct ucom_softc *, struct termios *);
204 static void umoscom_cfg_param(struct ucom_softc *, struct termios *);
205 static void umoscom_cfg_get_status(struct ucom_softc *, uint8_t *,
207 static void umoscom_cfg_write(struct umoscom_softc *, uint16_t, uint16_t);
208 static uint8_t umoscom_cfg_read(struct umoscom_softc *, uint16_t);
209 static void umoscom_start_read(struct ucom_softc *);
210 static void umoscom_stop_read(struct ucom_softc *);
211 static void umoscom_start_write(struct ucom_softc *);
212 static void umoscom_stop_write(struct ucom_softc *);
214 static const struct usb_config umoscom_config_data[UMOSCOM_N_TRANSFER] = {
216 [UMOSCOM_BULK_DT_WR] = {
218 .endpoint = UE_ADDR_ANY,
219 .direction = UE_DIR_OUT,
220 .bufsize = UMOSCOM_BUFSIZE,
221 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
222 .callback = &umoscom_write_callback,
225 [UMOSCOM_BULK_DT_RD] = {
227 .endpoint = UE_ADDR_ANY,
228 .direction = UE_DIR_IN,
229 .bufsize = UMOSCOM_BUFSIZE,
230 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
231 .callback = &umoscom_read_callback,
234 [UMOSCOM_INTR_DT_RD] = {
235 .type = UE_INTERRUPT,
236 .endpoint = UE_ADDR_ANY,
237 .direction = UE_DIR_IN,
238 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
239 .bufsize = 0, /* use wMaxPacketSize */
240 .callback = &umoscom_intr_callback,
244 static const struct ucom_callback umoscom_callback = {
245 /* configuration callbacks */
246 .ucom_cfg_get_status = &umoscom_cfg_get_status,
247 .ucom_cfg_set_dtr = &umoscom_cfg_set_dtr,
248 .ucom_cfg_set_rts = &umoscom_cfg_set_rts,
249 .ucom_cfg_set_break = &umoscom_cfg_set_break,
250 .ucom_cfg_param = &umoscom_cfg_param,
251 .ucom_cfg_open = &umoscom_cfg_open,
252 .ucom_cfg_close = &umoscom_cfg_close,
254 /* other callbacks */
255 .ucom_pre_param = &umoscom_pre_param,
256 .ucom_start_read = &umoscom_start_read,
257 .ucom_stop_read = &umoscom_stop_read,
258 .ucom_start_write = &umoscom_start_write,
259 .ucom_stop_write = &umoscom_stop_write,
262 static device_method_t umoscom_methods[] = {
263 DEVMETHOD(device_probe, umoscom_probe),
264 DEVMETHOD(device_attach, umoscom_attach),
265 DEVMETHOD(device_detach, umoscom_detach),
269 static devclass_t umoscom_devclass;
271 static driver_t umoscom_driver = {
273 .methods = umoscom_methods,
274 .size = sizeof(struct umoscom_softc),
277 DRIVER_MODULE(umoscom, uhub, umoscom_driver, umoscom_devclass, NULL, 0);
278 MODULE_DEPEND(umoscom, ucom, 1, 1, 1);
279 MODULE_DEPEND(umoscom, usb, 1, 1, 1);
281 static const struct usb_device_id umoscom_devs[] = {
282 {USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7703, 0)}
286 umoscom_probe(device_t dev)
288 struct usb_attach_arg *uaa = device_get_ivars(dev);
290 if (uaa->usb_mode != USB_MODE_HOST) {
293 if (uaa->info.bConfigIndex != UMOSCOM_CONFIG_INDEX) {
296 if (uaa->info.bIfaceIndex != UMOSCOM_IFACE_INDEX) {
299 return (usbd_lookup_id_by_uaa(umoscom_devs, sizeof(umoscom_devs), uaa));
303 umoscom_attach(device_t dev)
305 struct usb_attach_arg *uaa = device_get_ivars(dev);
306 struct umoscom_softc *sc = device_get_softc(dev);
310 sc->sc_udev = uaa->device;
311 sc->sc_mcr = 0x08; /* enable interrupts */
313 /* XXX the device doesn't provide any ID string, so set a static one */
314 device_set_desc(dev, "MOSCHIP USB Serial Port Adapter");
315 device_printf(dev, "<MOSCHIP USB Serial Port Adapter>\n");
317 mtx_init(&sc->sc_mtx, "umoscom", NULL, MTX_DEF);
319 iface_index = UMOSCOM_IFACE_INDEX;
320 error = usbd_transfer_setup(uaa->device, &iface_index,
321 sc->sc_xfer, umoscom_config_data,
322 UMOSCOM_N_TRANSFER, sc, &sc->sc_mtx);
327 /* clear stall at first run */
328 mtx_lock(&sc->sc_mtx);
329 usbd_xfer_set_stall(sc->sc_xfer[UMOSCOM_BULK_DT_WR]);
330 usbd_xfer_set_stall(sc->sc_xfer[UMOSCOM_BULK_DT_RD]);
331 mtx_unlock(&sc->sc_mtx);
333 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
334 &umoscom_callback, &sc->sc_mtx);
341 device_printf(dev, "attach error: %s\n", usbd_errstr(error));
347 umoscom_detach(device_t dev)
349 struct umoscom_softc *sc = device_get_softc(dev);
351 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1);
352 usbd_transfer_unsetup(sc->sc_xfer, UMOSCOM_N_TRANSFER);
353 mtx_destroy(&sc->sc_mtx);
359 umoscom_cfg_open(struct ucom_softc *ucom)
361 struct umoscom_softc *sc = ucom->sc_parent;
365 /* Purge FIFOs or odd things happen */
366 umoscom_cfg_write(sc, UMOSCOM_FIFO, 0x00 | UMOSCOM_UART_REG);
369 umoscom_cfg_write(sc, UMOSCOM_FIFO, UMOSCOM_FIFO_EN |
370 UMOSCOM_FIFO_RXCLR | UMOSCOM_FIFO_TXCLR |
371 UMOSCOM_FIFO_DMA_BLK | UMOSCOM_FIFO_RXLVL_MASK |
374 /* Enable Interrupt Registers */
375 umoscom_cfg_write(sc, UMOSCOM_INT, 0x0C | UMOSCOM_UART_REG);
378 umoscom_cfg_write(sc, 0x01, 0x08);
381 umoscom_cfg_write(sc, 0x00, 0x02);
385 umoscom_cfg_close(struct ucom_softc *ucom)
391 umoscom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
393 struct umoscom_softc *sc = ucom->sc_parent;
398 val |= UMOSCOM_LCR_BREAK;
400 umoscom_cfg_write(sc, UMOSCOM_LCR, val | UMOSCOM_UART_REG);
404 umoscom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
406 struct umoscom_softc *sc = ucom->sc_parent;
409 sc->sc_mcr |= UMOSCOM_MCR_DTR;
411 sc->sc_mcr &= ~UMOSCOM_MCR_DTR;
413 umoscom_cfg_write(sc, UMOSCOM_MCR, sc->sc_mcr | UMOSCOM_UART_REG);
417 umoscom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
419 struct umoscom_softc *sc = ucom->sc_parent;
422 sc->sc_mcr |= UMOSCOM_MCR_RTS;
424 sc->sc_mcr &= ~UMOSCOM_MCR_RTS;
426 umoscom_cfg_write(sc, UMOSCOM_MCR, sc->sc_mcr | UMOSCOM_UART_REG);
430 umoscom_pre_param(struct ucom_softc *ucom, struct termios *t)
432 if ((t->c_ospeed <= 1) || (t->c_ospeed > 115200))
439 umoscom_cfg_param(struct ucom_softc *ucom, struct termios *t)
441 struct umoscom_softc *sc = ucom->sc_parent;
444 DPRINTF("speed=%d\n", t->c_ospeed);
446 data = ((uint32_t)UMOSCOM_BAUD_REF) / ((uint32_t)t->c_ospeed);
449 DPRINTF("invalid baud rate!\n");
452 umoscom_cfg_write(sc, UMOSCOM_LCR,
453 UMOSCOM_LCR_DIVLATCH_EN | UMOSCOM_UART_REG);
455 umoscom_cfg_write(sc, UMOSCOM_BAUDLO,
456 (data & 0xFF) | UMOSCOM_UART_REG);
458 umoscom_cfg_write(sc, UMOSCOM_BAUDHI,
459 ((data >> 8) & 0xFF) | UMOSCOM_UART_REG);
461 if (t->c_cflag & CSTOPB)
462 data = UMOSCOM_LCR_STOP_BITS_2;
464 data = UMOSCOM_LCR_STOP_BITS_1;
466 if (t->c_cflag & PARENB) {
467 if (t->c_cflag & PARODD)
468 data |= UMOSCOM_LCR_PARITY_ODD;
470 data |= UMOSCOM_LCR_PARITY_EVEN;
472 data |= UMOSCOM_LCR_PARITY_NONE;
474 switch (t->c_cflag & CSIZE) {
476 data |= UMOSCOM_LCR_DBITS(5);
479 data |= UMOSCOM_LCR_DBITS(6);
482 data |= UMOSCOM_LCR_DBITS(7);
485 data |= UMOSCOM_LCR_DBITS(8);
490 umoscom_cfg_write(sc, UMOSCOM_LCR, data | UMOSCOM_UART_REG);
494 umoscom_cfg_get_status(struct ucom_softc *ucom, uint8_t *p_lsr, uint8_t *p_msr)
496 struct umoscom_softc *sc = ucom->sc_parent;
502 /* read status registers */
504 lsr = umoscom_cfg_read(sc, UMOSCOM_LSR);
505 msr = umoscom_cfg_read(sc, UMOSCOM_MSR);
509 if (msr & UMOSCOM_MSR_CTS)
512 if (msr & UMOSCOM_MSR_CD)
515 if (msr & UMOSCOM_MSR_RI)
518 if (msr & UMOSCOM_MSR_RTS)
523 umoscom_cfg_write(struct umoscom_softc *sc, uint16_t reg, uint16_t val)
525 struct usb_device_request req;
527 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
528 req.bRequest = UMOSCOM_WRITE;
529 USETW(req.wValue, val);
530 USETW(req.wIndex, reg);
531 USETW(req.wLength, 0);
533 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
534 &req, NULL, 0, 1000);
538 umoscom_cfg_read(struct umoscom_softc *sc, uint16_t reg)
540 struct usb_device_request req;
543 req.bmRequestType = UT_READ_VENDOR_DEVICE;
544 req.bRequest = UMOSCOM_READ;
545 USETW(req.wValue, 0);
546 USETW(req.wIndex, reg);
547 USETW(req.wLength, 1);
549 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
550 &req, &val, 0, 1000);
552 DPRINTF("reg=0x%04x, val=0x%02x\n", reg, val);
558 umoscom_start_read(struct ucom_softc *ucom)
560 struct umoscom_softc *sc = ucom->sc_parent;
563 /* start interrupt endpoint */
564 usbd_transfer_start(sc->sc_xfer[UMOSCOM_INTR_DT_RD]);
566 /* start read endpoint */
567 usbd_transfer_start(sc->sc_xfer[UMOSCOM_BULK_DT_RD]);
571 umoscom_stop_read(struct ucom_softc *ucom)
573 struct umoscom_softc *sc = ucom->sc_parent;
575 /* stop interrupt transfer */
576 usbd_transfer_stop(sc->sc_xfer[UMOSCOM_INTR_DT_RD]);
578 /* stop read endpoint */
579 usbd_transfer_stop(sc->sc_xfer[UMOSCOM_BULK_DT_RD]);
583 umoscom_start_write(struct ucom_softc *ucom)
585 struct umoscom_softc *sc = ucom->sc_parent;
587 usbd_transfer_start(sc->sc_xfer[UMOSCOM_BULK_DT_WR]);
591 umoscom_stop_write(struct ucom_softc *ucom)
593 struct umoscom_softc *sc = ucom->sc_parent;
595 usbd_transfer_stop(sc->sc_xfer[UMOSCOM_BULK_DT_WR]);
599 umoscom_write_callback(struct usb_xfer *xfer, usb_error_t error)
601 struct umoscom_softc *sc = usbd_xfer_softc(xfer);
602 struct usb_page_cache *pc;
605 switch (USB_GET_STATE(xfer)) {
607 case USB_ST_TRANSFERRED:
611 pc = usbd_xfer_get_frame(xfer, 0);
612 if (ucom_get_data(&sc->sc_ucom, pc, 0,
613 UMOSCOM_BUFSIZE, &actlen)) {
615 usbd_xfer_set_frame_len(xfer, 0, actlen);
616 usbd_transfer_submit(xfer);
621 if (error != USB_ERR_CANCELLED) {
622 DPRINTFN(0, "transfer failed\n");
623 /* try to clear stall first */
624 usbd_xfer_set_stall(xfer);
632 umoscom_read_callback(struct usb_xfer *xfer, usb_error_t error)
634 struct umoscom_softc *sc = usbd_xfer_softc(xfer);
635 struct usb_page_cache *pc;
638 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
640 switch (USB_GET_STATE(xfer)) {
641 case USB_ST_TRANSFERRED:
642 DPRINTF("got %d bytes\n", actlen);
643 pc = usbd_xfer_get_frame(xfer, 0);
644 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
650 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
651 usbd_transfer_submit(xfer);
655 if (error != USB_ERR_CANCELLED) {
656 DPRINTFN(0, "transfer failed\n");
657 /* try to clear stall first */
658 usbd_xfer_set_stall(xfer);
666 umoscom_intr_callback(struct usb_xfer *xfer, usb_error_t error)
668 struct umoscom_softc *sc = usbd_xfer_softc(xfer);
671 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
673 switch (USB_GET_STATE(xfer)) {
674 case USB_ST_TRANSFERRED:
676 DPRINTF("too short message\n");
679 ucom_status_change(&sc->sc_ucom);
683 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
684 usbd_transfer_submit(xfer);
688 if (error != USB_ERR_CANCELLED) {
689 DPRINTFN(0, "transfer failed\n");
690 /* try to clear stall first */
691 usbd_xfer_set_stall(xfer);