2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 Lev Serebryakov <lev@FreeBSD.org>.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * This driver supports several multiport USB-to-RS232 serial adapters driven
31 * by MosChip mos7820 and mos7840, bridge chips.
32 * The adapters are sold under many different brand names.
34 * Datasheets are available at MosChip www site at
35 * http://www.moschip.com. The datasheets don't contain full
36 * programming information for the chip.
38 * It is nornal to have only two enabled ports in devices, based on
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
45 #include <sys/stdint.h>
46 #include <sys/stddef.h>
47 #include <sys/param.h>
48 #include <sys/queue.h>
49 #include <sys/types.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
53 #include <sys/linker_set.h>
54 #include <sys/module.h>
56 #include <sys/mutex.h>
57 #include <sys/condvar.h>
58 #include <sys/sysctl.h>
60 #include <sys/unistd.h>
61 #include <sys/callout.h>
62 #include <sys/malloc.h>
65 #include <dev/usb/usb.h>
66 #include <dev/usb/usbdi.h>
67 #include <dev/usb/usbdi_util.h>
68 #include <dev/usb/usb_cdc.h>
71 #define USB_DEBUG_VAR umcs_debug
72 #include <dev/usb/usb_debug.h>
73 #include <dev/usb/usb_process.h>
75 #include <dev/usb/serial/usb_serial.h>
77 #include <dev/usb/serial/umcs.h>
79 #define UMCS7840_MODVER 1
82 static int umcs_debug = 0;
84 static SYSCTL_NODE(_hw_usb, OID_AUTO, umcs, CTLFLAG_RW, 0, "USB umcs quadport serial adapter");
85 SYSCTL_INT(_hw_usb_umcs, OID_AUTO, debug, CTLFLAG_RWTUN, &umcs_debug, 0, "Debug level");
86 #endif /* USB_DEBUG */
90 * Two-port devices (both with 7820 chip and 7840 chip configured as two-port)
91 * have ports 0 and 2, with ports 1 and 3 omitted.
92 * So,PHYSICAL port numbers (indexes) on two-port device will be 0 and 2.
93 * This driver trys to use physical numbers as much as possible.
97 * Indexed by PHYSICAL port number.
98 * Pack non-regular registers to array to easier if-less access.
100 struct umcs7840_port_registers {
101 uint8_t reg_sp; /* SP register. */
102 uint8_t reg_control; /* CONTROL register. */
103 uint8_t reg_dcr; /* DCR0 register. DCR1 & DCR2 can be
107 static const struct umcs7840_port_registers umcs7840_port_registers[UMCS7840_MAX_PORTS] = {
108 {.reg_sp = MCS7840_DEV_REG_SP1,.reg_control = MCS7840_DEV_REG_CONTROL1,.reg_dcr = MCS7840_DEV_REG_DCR0_1},
109 {.reg_sp = MCS7840_DEV_REG_SP2,.reg_control = MCS7840_DEV_REG_CONTROL2,.reg_dcr = MCS7840_DEV_REG_DCR0_2},
110 {.reg_sp = MCS7840_DEV_REG_SP3,.reg_control = MCS7840_DEV_REG_CONTROL3,.reg_dcr = MCS7840_DEV_REG_DCR0_3},
111 {.reg_sp = MCS7840_DEV_REG_SP4,.reg_control = MCS7840_DEV_REG_CONTROL4,.reg_dcr = MCS7840_DEV_REG_DCR0_4},
120 struct umcs7840_softc_oneport {
121 struct usb_xfer *sc_xfer[UMCS7840_N_TRANSFERS]; /* Control structures
122 * for two transfers */
124 uint8_t sc_lcr; /* local line control register */
125 uint8_t sc_mcr; /* local modem control register */
128 struct umcs7840_softc {
129 struct ucom_super_softc sc_super_ucom;
130 struct ucom_softc sc_ucom[UMCS7840_MAX_PORTS]; /* Need to be continuous
131 * array, so indexed by
133 * (subunit) number */
135 struct usb_xfer *sc_intr_xfer; /* Interrupt endpoint */
137 device_t sc_dev; /* Device for error prints */
138 struct usb_device *sc_udev; /* USB Device for all operations */
139 struct mtx sc_mtx; /* ucom requires this */
141 uint8_t sc_driver_done; /* Flag when enumeration is finished */
143 uint8_t sc_numports; /* Number of ports (subunits) */
144 struct umcs7840_softc_oneport sc_ports[UMCS7840_MAX_PORTS]; /* Indexed by PHYSICAL
149 static usb_error_t umcs7840_get_reg_sync(struct umcs7840_softc *, uint8_t, uint8_t *);
150 static usb_error_t umcs7840_set_reg_sync(struct umcs7840_softc *, uint8_t, uint8_t);
151 static usb_error_t umcs7840_get_UART_reg_sync(struct umcs7840_softc *, uint8_t, uint8_t, uint8_t *);
152 static usb_error_t umcs7840_set_UART_reg_sync(struct umcs7840_softc *, uint8_t, uint8_t, uint8_t);
154 static usb_error_t umcs7840_set_baudrate(struct umcs7840_softc *, uint8_t, uint32_t);
155 static usb_error_t umcs7840_calc_baudrate(uint32_t rate, uint16_t *, uint8_t *);
157 static void umcs7840_free(struct ucom_softc *);
158 static void umcs7840_cfg_get_status(struct ucom_softc *, uint8_t *, uint8_t *);
159 static void umcs7840_cfg_set_dtr(struct ucom_softc *, uint8_t);
160 static void umcs7840_cfg_set_rts(struct ucom_softc *, uint8_t);
161 static void umcs7840_cfg_set_break(struct ucom_softc *, uint8_t);
162 static void umcs7840_cfg_param(struct ucom_softc *, struct termios *);
163 static void umcs7840_cfg_open(struct ucom_softc *);
164 static void umcs7840_cfg_close(struct ucom_softc *);
166 static int umcs7840_pre_param(struct ucom_softc *, struct termios *);
168 static void umcs7840_start_read(struct ucom_softc *);
169 static void umcs7840_stop_read(struct ucom_softc *);
171 static void umcs7840_start_write(struct ucom_softc *);
172 static void umcs7840_stop_write(struct ucom_softc *);
174 static void umcs7840_poll(struct ucom_softc *ucom);
176 static device_probe_t umcs7840_probe;
177 static device_attach_t umcs7840_attach;
178 static device_detach_t umcs7840_detach;
179 static void umcs7840_free_softc(struct umcs7840_softc *);
181 static usb_callback_t umcs7840_intr_callback;
182 static usb_callback_t umcs7840_read_callback1;
183 static usb_callback_t umcs7840_read_callback2;
184 static usb_callback_t umcs7840_read_callback3;
185 static usb_callback_t umcs7840_read_callback4;
186 static usb_callback_t umcs7840_write_callback1;
187 static usb_callback_t umcs7840_write_callback2;
188 static usb_callback_t umcs7840_write_callback3;
189 static usb_callback_t umcs7840_write_callback4;
191 static void umcs7840_read_callbackN(struct usb_xfer *, usb_error_t, uint8_t);
192 static void umcs7840_write_callbackN(struct usb_xfer *, usb_error_t, uint8_t);
194 /* Indexed by LOGICAL port number (subunit), so two-port device uses 0 & 1 */
195 static usb_callback_t *umcs7840_rw_callbacks[UMCS7840_MAX_PORTS][UMCS7840_N_TRANSFERS] = {
196 {&umcs7840_read_callback1, &umcs7840_write_callback1},
197 {&umcs7840_read_callback2, &umcs7840_write_callback2},
198 {&umcs7840_read_callback3, &umcs7840_write_callback3},
199 {&umcs7840_read_callback4, &umcs7840_write_callback4},
202 static const struct usb_config umcs7840_bulk_config_data[UMCS7840_N_TRANSFERS] = {
203 [UMCS7840_BULK_RD_EP] = {
206 .direction = UE_DIR_IN,
207 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
208 .bufsize = 0, /* use wMaxPacketSize */
209 .callback = &umcs7840_read_callback1,
213 [UMCS7840_BULK_WR_EP] = {
216 .direction = UE_DIR_OUT,
217 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
218 .bufsize = 0, /* use wMaxPacketSize */
219 .callback = &umcs7840_write_callback1,
224 static const struct usb_config umcs7840_intr_config_data[1] = {
226 .type = UE_INTERRUPT,
228 .direction = UE_DIR_IN,
229 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
230 .bufsize = 0, /* use wMaxPacketSize */
231 .callback = &umcs7840_intr_callback,
236 static struct ucom_callback umcs7840_callback = {
237 .ucom_cfg_get_status = &umcs7840_cfg_get_status,
239 .ucom_cfg_set_dtr = &umcs7840_cfg_set_dtr,
240 .ucom_cfg_set_rts = &umcs7840_cfg_set_rts,
241 .ucom_cfg_set_break = &umcs7840_cfg_set_break,
243 .ucom_cfg_param = &umcs7840_cfg_param,
244 .ucom_cfg_open = &umcs7840_cfg_open,
245 .ucom_cfg_close = &umcs7840_cfg_close,
247 .ucom_pre_param = &umcs7840_pre_param,
249 .ucom_start_read = &umcs7840_start_read,
250 .ucom_stop_read = &umcs7840_stop_read,
252 .ucom_start_write = &umcs7840_start_write,
253 .ucom_stop_write = &umcs7840_stop_write,
255 .ucom_poll = &umcs7840_poll,
256 .ucom_free = &umcs7840_free,
259 static const STRUCT_USB_HOST_ID umcs7840_devs[] = {
260 {USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7820, 0)},
261 {USB_VPI(USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7840, 0)},
264 static device_method_t umcs7840_methods[] = {
265 DEVMETHOD(device_probe, umcs7840_probe),
266 DEVMETHOD(device_attach, umcs7840_attach),
267 DEVMETHOD(device_detach, umcs7840_detach),
271 static devclass_t umcs7840_devclass;
273 static driver_t umcs7840_driver = {
275 .methods = umcs7840_methods,
276 .size = sizeof(struct umcs7840_softc),
279 DRIVER_MODULE(umcs7840, uhub, umcs7840_driver, umcs7840_devclass, 0, 0);
280 MODULE_DEPEND(umcs7840, ucom, 1, 1, 1);
281 MODULE_DEPEND(umcs7840, usb, 1, 1, 1);
282 MODULE_VERSION(umcs7840, UMCS7840_MODVER);
283 USB_PNP_HOST_INFO(umcs7840_devs);
286 umcs7840_probe(device_t dev)
288 struct usb_attach_arg *uaa = device_get_ivars(dev);
290 if (uaa->usb_mode != USB_MODE_HOST)
292 if (uaa->info.bConfigIndex != MCS7840_CONFIG_INDEX)
294 if (uaa->info.bIfaceIndex != MCS7840_IFACE_INDEX)
296 return (usbd_lookup_id_by_uaa(umcs7840_devs, sizeof(umcs7840_devs), uaa));
300 umcs7840_attach(device_t dev)
302 struct usb_config umcs7840_config_tmp[UMCS7840_N_TRANSFERS];
303 struct usb_attach_arg *uaa = device_get_ivars(dev);
304 struct umcs7840_softc *sc = device_get_softc(dev);
306 uint8_t iface_index = MCS7840_IFACE_INDEX;
312 for (n = 0; n < UMCS7840_N_TRANSFERS; ++n)
313 umcs7840_config_tmp[n] = umcs7840_bulk_config_data[n];
315 device_set_usb_desc(dev);
316 mtx_init(&sc->sc_mtx, "umcs7840", NULL, MTX_DEF);
317 ucom_ref(&sc->sc_super_ucom);
320 sc->sc_udev = uaa->device;
323 * Get number of ports
324 * Documentation (full datasheet) says, that number of ports is
325 * set as MCS7840_DEV_MODE_SELECT24S bit in MODE R/Only
326 * register. But vendor driver uses these undocumented
329 * Experiments show, that MODE register can have `0'
330 * (4 ports) bit on 2-port device, so use vendor driver's way.
332 * Also, see notes in header file for these constants.
334 umcs7840_get_reg_sync(sc, MCS7840_DEV_REG_GPIO, &data);
335 if (data & MCS7840_DEV_GPIO_4PORTS) {
337 /* Store physical port numbers in sc_portno */
338 sc->sc_ucom[0].sc_portno = 0;
339 sc->sc_ucom[1].sc_portno = 1;
340 sc->sc_ucom[2].sc_portno = 2;
341 sc->sc_ucom[3].sc_portno = 3;
344 /* Store physical port numbers in sc_portno */
345 sc->sc_ucom[0].sc_portno = 0;
346 sc->sc_ucom[1].sc_portno = 2; /* '1' is skipped */
348 device_printf(dev, "Chip mcs%04x, found %d active ports\n", uaa->info.idProduct, sc->sc_numports);
349 if (!umcs7840_get_reg_sync(sc, MCS7840_DEV_REG_MODE, &data)) {
350 device_printf(dev, "On-die confguration: RST: active %s, HRD: %s, PLL: %s, POR: %s, Ports: %s, EEPROM write %s, IrDA is %savailable\n",
351 (data & MCS7840_DEV_MODE_RESET) ? "low" : "high",
352 (data & MCS7840_DEV_MODE_SER_PRSNT) ? "yes" : "no",
353 (data & MCS7840_DEV_MODE_PLLBYPASS) ? "bypassed" : "avail",
354 (data & MCS7840_DEV_MODE_PORBYPASS) ? "bypassed" : "avail",
355 (data & MCS7840_DEV_MODE_SELECT24S) ? "2" : "4",
356 (data & MCS7840_DEV_MODE_EEPROMWR) ? "enabled" : "disabled",
357 (data & MCS7840_DEV_MODE_IRDA) ? "" : "not ");
359 /* Setup all transfers */
360 for (subunit = 0; subunit < sc->sc_numports; ++subunit) {
361 for (n = 0; n < UMCS7840_N_TRANSFERS; ++n) {
362 /* Set endpoint address */
363 umcs7840_config_tmp[n].endpoint = umcs7840_bulk_config_data[n].endpoint + 2 * sc->sc_ucom[subunit].sc_portno;
364 umcs7840_config_tmp[n].callback = umcs7840_rw_callbacks[subunit][n];
366 error = usbd_transfer_setup(uaa->device,
367 &iface_index, sc->sc_ports[sc->sc_ucom[subunit].sc_portno].sc_xfer, umcs7840_config_tmp,
368 UMCS7840_N_TRANSFERS, sc, &sc->sc_mtx);
370 device_printf(dev, "allocating USB transfers failed for subunit %d of %d\n",
371 subunit + 1, sc->sc_numports);
375 error = usbd_transfer_setup(uaa->device,
376 &iface_index, &sc->sc_intr_xfer, umcs7840_intr_config_data,
379 device_printf(dev, "allocating USB transfers failed for interrupt\n");
382 /* clear stall at first run */
383 mtx_lock(&sc->sc_mtx);
384 for (subunit = 0; subunit < sc->sc_numports; ++subunit) {
385 usbd_xfer_set_stall(sc->sc_ports[sc->sc_ucom[subunit].sc_portno].sc_xfer[UMCS7840_BULK_RD_EP]);
386 usbd_xfer_set_stall(sc->sc_ports[sc->sc_ucom[subunit].sc_portno].sc_xfer[UMCS7840_BULK_WR_EP]);
388 mtx_unlock(&sc->sc_mtx);
390 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_numports, sc,
391 &umcs7840_callback, &sc->sc_mtx);
395 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
400 umcs7840_detach(dev);
405 umcs7840_detach(device_t dev)
407 struct umcs7840_softc *sc = device_get_softc(dev);
410 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom);
412 for (subunit = 0; subunit < sc->sc_numports; ++subunit)
413 usbd_transfer_unsetup(sc->sc_ports[sc->sc_ucom[subunit].sc_portno].sc_xfer, UMCS7840_N_TRANSFERS);
414 usbd_transfer_unsetup(&sc->sc_intr_xfer, 1);
416 device_claim_softc(dev);
418 umcs7840_free_softc(sc);
423 UCOM_UNLOAD_DRAIN(umcs7840);
426 umcs7840_free_softc(struct umcs7840_softc *sc)
428 if (ucom_unref(&sc->sc_super_ucom)) {
429 mtx_destroy(&sc->sc_mtx);
430 device_free_softc(sc);
435 umcs7840_free(struct ucom_softc *ucom)
437 umcs7840_free_softc(ucom->sc_parent);
441 umcs7840_cfg_open(struct ucom_softc *ucom)
443 struct umcs7840_softc *sc = ucom->sc_parent;
444 uint16_t pn = ucom->sc_portno;
447 /* If it very first open, finish global configuration */
448 if (!sc->sc_driver_done) {
450 * USB enumeration is finished, pass internal memory to FIFOs
451 * If it is done in the end of "attach", kernel panics.
453 if (umcs7840_get_reg_sync(sc, MCS7840_DEV_REG_CONTROL1, &data))
455 data |= MCS7840_DEV_CONTROL1_DRIVER_DONE;
456 if (umcs7840_set_reg_sync(sc, MCS7840_DEV_REG_CONTROL1, data))
458 sc->sc_driver_done = 1;
460 /* Toggle reset bit on-off */
461 if (umcs7840_get_reg_sync(sc, umcs7840_port_registers[pn].reg_sp, &data))
463 data |= MCS7840_DEV_SPx_UART_RESET;
464 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_sp, data))
466 data &= ~MCS7840_DEV_SPx_UART_RESET;
467 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_sp, data))
470 /* Set RS-232 mode */
471 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_SCRATCHPAD, MCS7840_UART_SCRATCHPAD_RS232))
474 /* Disable RX on time of initialization */
475 if (umcs7840_get_reg_sync(sc, umcs7840_port_registers[pn].reg_control, &data))
477 data |= MCS7840_DEV_CONTROLx_RX_DISABLE;
478 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_control, data))
481 /* Disable all interrupts */
482 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_IER, 0))
485 /* Reset FIFO -- documented */
486 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_FCR, 0))
488 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_FCR,
489 MCS7840_UART_FCR_ENABLE | MCS7840_UART_FCR_FLUSHRHR |
490 MCS7840_UART_FCR_FLUSHTHR | MCS7840_UART_FCR_RTL_1_14))
493 /* Set 8 bit, no parity, 1 stop bit -- documented */
494 sc->sc_ports[pn].sc_lcr = MCS7840_UART_LCR_DATALEN8 | MCS7840_UART_LCR_STOPB1;
495 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_LCR, sc->sc_ports[pn].sc_lcr))
499 * Enable DTR/RTS on modem control, enable modem interrupts --
502 sc->sc_ports[pn].sc_mcr = MCS7840_UART_MCR_DTR | MCS7840_UART_MCR_RTS | MCS7840_UART_MCR_IE;
503 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_MCR, sc->sc_ports[pn].sc_mcr))
506 /* Clearing Bulkin and Bulkout FIFO */
507 if (umcs7840_get_reg_sync(sc, umcs7840_port_registers[pn].reg_sp, &data))
509 data |= MCS7840_DEV_SPx_RESET_OUT_FIFO | MCS7840_DEV_SPx_RESET_IN_FIFO;
510 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_sp, data))
512 data &= ~(MCS7840_DEV_SPx_RESET_OUT_FIFO | MCS7840_DEV_SPx_RESET_IN_FIFO);
513 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_sp, data))
517 if (umcs7840_set_baudrate(sc, pn, 9600))
521 /* Finally enable all interrupts -- documented */
523 * Copied from vendor driver, I don't know why we should read LCR
526 if (umcs7840_get_UART_reg_sync(sc, pn, MCS7840_UART_REG_LCR, &sc->sc_ports[pn].sc_lcr))
528 if (umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_IER,
529 MCS7840_UART_IER_RXSTAT | MCS7840_UART_IER_MODEM))
533 if (umcs7840_get_reg_sync(sc, umcs7840_port_registers[pn].reg_control, &data))
535 data &= ~MCS7840_DEV_CONTROLx_RX_DISABLE;
536 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_control, data))
539 DPRINTF("Port %d has been opened\n", pn);
543 umcs7840_cfg_close(struct ucom_softc *ucom)
545 struct umcs7840_softc *sc = ucom->sc_parent;
546 uint16_t pn = ucom->sc_portno;
549 umcs7840_stop_read(ucom);
550 umcs7840_stop_write(ucom);
552 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_MCR, 0);
553 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_IER, 0);
556 if (umcs7840_get_reg_sync(sc, umcs7840_port_registers[pn].reg_control, &data))
558 data |= MCS7840_DEV_CONTROLx_RX_DISABLE;
559 if (umcs7840_set_reg_sync(sc, umcs7840_port_registers[pn].reg_control, data))
561 DPRINTF("Port %d has been closed\n", pn);
565 umcs7840_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
567 struct umcs7840_softc *sc = ucom->sc_parent;
568 uint8_t pn = ucom->sc_portno;
571 sc->sc_ports[pn].sc_mcr |= MCS7840_UART_MCR_DTR;
573 sc->sc_ports[pn].sc_mcr &= ~MCS7840_UART_MCR_DTR;
575 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_MCR, sc->sc_ports[pn].sc_mcr);
576 DPRINTF("Port %d DTR set to: %s\n", pn, onoff ? "on" : "off");
580 umcs7840_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
582 struct umcs7840_softc *sc = ucom->sc_parent;
583 uint8_t pn = ucom->sc_portno;
586 sc->sc_ports[pn].sc_mcr |= MCS7840_UART_MCR_RTS;
588 sc->sc_ports[pn].sc_mcr &= ~MCS7840_UART_MCR_RTS;
590 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_MCR, sc->sc_ports[pn].sc_mcr);
591 DPRINTF("Port %d RTS set to: %s\n", pn, onoff ? "on" : "off");
595 umcs7840_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
597 struct umcs7840_softc *sc = ucom->sc_parent;
598 uint8_t pn = ucom->sc_portno;
601 sc->sc_ports[pn].sc_lcr |= MCS7840_UART_LCR_BREAK;
603 sc->sc_ports[pn].sc_lcr &= ~MCS7840_UART_LCR_BREAK;
605 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_LCR, sc->sc_ports[pn].sc_lcr);
606 DPRINTF("Port %d BREAK set to: %s\n", pn, onoff ? "on" : "off");
611 umcs7840_cfg_param(struct ucom_softc *ucom, struct termios *t)
613 struct umcs7840_softc *sc = ucom->sc_parent;
614 uint8_t pn = ucom->sc_portno;
615 uint8_t lcr = sc->sc_ports[pn].sc_lcr;
616 uint8_t mcr = sc->sc_ports[pn].sc_mcr;
618 DPRINTF("Port %d config:\n", pn);
619 if (t->c_cflag & CSTOPB) {
620 DPRINTF(" 2 stop bits\n");
621 lcr |= MCS7840_UART_LCR_STOPB2;
623 lcr |= MCS7840_UART_LCR_STOPB1;
624 DPRINTF(" 1 stop bit\n");
627 lcr &= ~MCS7840_UART_LCR_PARITYMASK;
628 if (t->c_cflag & PARENB) {
629 lcr |= MCS7840_UART_LCR_PARITYON;
630 if (t->c_cflag & PARODD) {
631 lcr = MCS7840_UART_LCR_PARITYODD;
632 DPRINTF(" parity on - odd\n");
634 lcr = MCS7840_UART_LCR_PARITYEVEN;
635 DPRINTF(" parity on - even\n");
638 lcr &= ~MCS7840_UART_LCR_PARITYON;
639 DPRINTF(" parity off\n");
642 lcr &= ~MCS7840_UART_LCR_DATALENMASK;
643 switch (t->c_cflag & CSIZE) {
645 lcr |= MCS7840_UART_LCR_DATALEN5;
649 lcr |= MCS7840_UART_LCR_DATALEN6;
653 lcr |= MCS7840_UART_LCR_DATALEN7;
657 lcr |= MCS7840_UART_LCR_DATALEN8;
662 if (t->c_cflag & CRTSCTS) {
663 mcr |= MCS7840_UART_MCR_CTSRTS;
664 DPRINTF(" CTS/RTS\n");
666 mcr &= ~MCS7840_UART_MCR_CTSRTS;
668 if (t->c_cflag & (CDTR_IFLOW | CDSR_OFLOW)) {
669 mcr |= MCS7840_UART_MCR_DTRDSR;
670 DPRINTF(" DTR/DSR\n");
672 mcr &= ~MCS7840_UART_MCR_DTRDSR;
674 sc->sc_ports[pn].sc_lcr = lcr;
675 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_LCR, sc->sc_ports[pn].sc_lcr);
676 DPRINTF("Port %d LCR=%02x\n", pn, sc->sc_ports[pn].sc_lcr);
678 sc->sc_ports[pn].sc_mcr = mcr;
679 umcs7840_set_UART_reg_sync(sc, pn, MCS7840_UART_REG_MCR, sc->sc_ports[pn].sc_mcr);
680 DPRINTF("Port %d MCR=%02x\n", pn, sc->sc_ports[pn].sc_mcr);
682 umcs7840_set_baudrate(sc, pn, t->c_ospeed);
687 umcs7840_pre_param(struct ucom_softc *ucom, struct termios *t)
692 if (umcs7840_calc_baudrate(t->c_ospeed, &divisor, &clk) || !divisor)
698 umcs7840_start_read(struct ucom_softc *ucom)
700 struct umcs7840_softc *sc = ucom->sc_parent;
701 uint8_t pn = ucom->sc_portno;
703 /* Start interrupt transfer */
704 usbd_transfer_start(sc->sc_intr_xfer);
706 /* Start read transfer */
707 usbd_transfer_start(sc->sc_ports[pn].sc_xfer[UMCS7840_BULK_RD_EP]);
711 umcs7840_stop_read(struct ucom_softc *ucom)
713 struct umcs7840_softc *sc = ucom->sc_parent;
714 uint8_t pn = ucom->sc_portno;
716 /* Stop read transfer */
717 usbd_transfer_stop(sc->sc_ports[pn].sc_xfer[UMCS7840_BULK_RD_EP]);
721 umcs7840_start_write(struct ucom_softc *ucom)
723 struct umcs7840_softc *sc = ucom->sc_parent;
724 uint8_t pn = ucom->sc_portno;
726 /* Start interrupt transfer */
727 usbd_transfer_start(sc->sc_intr_xfer);
729 /* Start write transfer */
730 usbd_transfer_start(sc->sc_ports[pn].sc_xfer[UMCS7840_BULK_WR_EP]);
734 umcs7840_stop_write(struct ucom_softc *ucom)
736 struct umcs7840_softc *sc = ucom->sc_parent;
737 uint8_t pn = ucom->sc_portno;
739 /* Stop write transfer */
740 usbd_transfer_stop(sc->sc_ports[pn].sc_xfer[UMCS7840_BULK_WR_EP]);
744 umcs7840_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
746 struct umcs7840_softc *sc = ucom->sc_parent;
747 uint8_t pn = ucom->sc_portno;
748 uint8_t hw_msr = 0; /* local modem status register */
751 * Read status registers. MSR bits need translation from ns16550 to
752 * SER_* values. LSR bits are ns16550 in hardware and ucom.
754 umcs7840_get_UART_reg_sync(sc, pn, MCS7840_UART_REG_LSR, lsr);
755 umcs7840_get_UART_reg_sync(sc, pn, MCS7840_UART_REG_MSR, &hw_msr);
757 if (hw_msr & MCS7840_UART_MSR_NEGCTS)
760 if (hw_msr & MCS7840_UART_MSR_NEGDCD)
763 if (hw_msr & MCS7840_UART_MSR_NEGRI)
766 if (hw_msr & MCS7840_UART_MSR_NEGDSR)
769 DPRINTF("Port %d status: LSR=%02x MSR=%02x\n", ucom->sc_portno, *lsr, *msr);
773 umcs7840_intr_callback(struct usb_xfer *xfer, usb_error_t error)
775 struct umcs7840_softc *sc = usbd_xfer_softc(xfer);
776 struct usb_page_cache *pc;
781 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
783 switch (USB_GET_STATE(xfer)) {
784 case USB_ST_TRANSFERRED:
785 if (actlen == 5 || actlen == 13) {
786 pc = usbd_xfer_get_frame(xfer, 0);
787 usbd_copy_out(pc, 0, buf, actlen);
788 /* Check status of all ports */
789 for (subunit = 0; subunit < sc->sc_numports; ++subunit) {
790 uint8_t pn = sc->sc_ucom[subunit].sc_portno;
792 if (buf[pn] & MCS7840_UART_ISR_NOPENDING)
794 DPRINTF("Port %d has pending interrupt: %02x (FIFO: %02x)\n", pn, buf[pn] & MCS7840_UART_ISR_INTMASK, buf[pn] & (~MCS7840_UART_ISR_INTMASK));
795 switch (buf[pn] & MCS7840_UART_ISR_INTMASK) {
796 case MCS7840_UART_ISR_RXERR:
797 case MCS7840_UART_ISR_RXHASDATA:
798 case MCS7840_UART_ISR_RXTIMEOUT:
799 case MCS7840_UART_ISR_MSCHANGE:
800 ucom_status_change(&sc->sc_ucom[subunit]);
808 device_printf(sc->sc_dev, "Invalid interrupt data length %d", actlen);
812 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
813 usbd_transfer_submit(xfer);
817 if (error != USB_ERR_CANCELLED) {
818 /* try to clear stall first */
819 usbd_xfer_set_stall(xfer);
827 umcs7840_read_callback1(struct usb_xfer *xfer, usb_error_t error)
829 umcs7840_read_callbackN(xfer, error, 0);
833 umcs7840_read_callback2(struct usb_xfer *xfer, usb_error_t error)
835 umcs7840_read_callbackN(xfer, error, 1);
838 umcs7840_read_callback3(struct usb_xfer *xfer, usb_error_t error)
840 umcs7840_read_callbackN(xfer, error, 2);
844 umcs7840_read_callback4(struct usb_xfer *xfer, usb_error_t error)
846 umcs7840_read_callbackN(xfer, error, 3);
850 umcs7840_read_callbackN(struct usb_xfer *xfer, usb_error_t error, uint8_t subunit)
852 struct umcs7840_softc *sc = usbd_xfer_softc(xfer);
853 struct ucom_softc *ucom = &sc->sc_ucom[subunit];
854 struct usb_page_cache *pc;
857 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
859 DPRINTF("Port %d read, state = %d, data length = %d\n", ucom->sc_portno, USB_GET_STATE(xfer), actlen);
861 switch (USB_GET_STATE(xfer)) {
862 case USB_ST_TRANSFERRED:
863 pc = usbd_xfer_get_frame(xfer, 0);
864 ucom_put_data(ucom, pc, 0, actlen);
868 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
869 usbd_transfer_submit(xfer);
873 if (error != USB_ERR_CANCELLED) {
874 /* try to clear stall first */
875 usbd_xfer_set_stall(xfer);
883 umcs7840_write_callback1(struct usb_xfer *xfer, usb_error_t error)
885 umcs7840_write_callbackN(xfer, error, 0);
889 umcs7840_write_callback2(struct usb_xfer *xfer, usb_error_t error)
891 umcs7840_write_callbackN(xfer, error, 1);
895 umcs7840_write_callback3(struct usb_xfer *xfer, usb_error_t error)
897 umcs7840_write_callbackN(xfer, error, 2);
901 umcs7840_write_callback4(struct usb_xfer *xfer, usb_error_t error)
903 umcs7840_write_callbackN(xfer, error, 3);
907 umcs7840_write_callbackN(struct usb_xfer *xfer, usb_error_t error, uint8_t subunit)
909 struct umcs7840_softc *sc = usbd_xfer_softc(xfer);
910 struct ucom_softc *ucom = &sc->sc_ucom[subunit];
911 struct usb_page_cache *pc;
914 DPRINTF("Port %d write, state = %d\n", ucom->sc_portno, USB_GET_STATE(xfer));
916 switch (USB_GET_STATE(xfer)) {
918 case USB_ST_TRANSFERRED:
920 pc = usbd_xfer_get_frame(xfer, 0);
921 if (ucom_get_data(ucom, pc, 0, usbd_xfer_max_len(xfer), &actlen)) {
922 DPRINTF("Port %d write, has %d bytes\n", ucom->sc_portno, actlen);
923 usbd_xfer_set_frame_len(xfer, 0, actlen);
924 usbd_transfer_submit(xfer);
929 if (error != USB_ERR_CANCELLED) {
930 /* try to clear stall first */
931 usbd_xfer_set_stall(xfer);
939 umcs7840_poll(struct ucom_softc *ucom)
941 struct umcs7840_softc *sc = ucom->sc_parent;
943 DPRINTF("Port %d poll\n", ucom->sc_portno);
944 usbd_transfer_poll(sc->sc_ports[ucom->sc_portno].sc_xfer, UMCS7840_N_TRANSFERS);
945 usbd_transfer_poll(&sc->sc_intr_xfer, 1);
949 umcs7840_get_reg_sync(struct umcs7840_softc *sc, uint8_t reg, uint8_t *data)
951 struct usb_device_request req;
955 req.bmRequestType = UT_READ_VENDOR_DEVICE;
956 req.bRequest = MCS7840_RDREQ;
957 USETW(req.wValue, 0);
958 USETW(req.wIndex, reg);
959 USETW(req.wLength, UMCS7840_READ_LENGTH);
961 err = usbd_do_request_proc(sc->sc_udev, &sc->sc_super_ucom.sc_tq, &req, (void *)data, 0, &len, UMCS7840_CTRL_TIMEOUT);
962 if (err == USB_ERR_NORMAL_COMPLETION && len != 1) {
963 device_printf(sc->sc_dev, "Reading register %d failed: invalid length %d\n", reg, len);
964 return (USB_ERR_INVAL);
966 device_printf(sc->sc_dev, "Reading register %d failed: %s\n", reg, usbd_errstr(err));
971 umcs7840_set_reg_sync(struct umcs7840_softc *sc, uint8_t reg, uint8_t data)
973 struct usb_device_request req;
976 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
977 req.bRequest = MCS7840_WRREQ;
978 USETW(req.wValue, data);
979 USETW(req.wIndex, reg);
980 USETW(req.wLength, 0);
982 err = usbd_do_request_proc(sc->sc_udev, &sc->sc_super_ucom.sc_tq, &req, NULL, 0, NULL, UMCS7840_CTRL_TIMEOUT);
984 device_printf(sc->sc_dev, "Writing register %d failed: %s\n", reg, usbd_errstr(err));
990 umcs7840_get_UART_reg_sync(struct umcs7840_softc *sc, uint8_t portno, uint8_t reg, uint8_t *data)
992 struct usb_device_request req;
997 /* portno is port number */
998 wVal = ((uint16_t)(portno + 1)) << 8;
1000 req.bmRequestType = UT_READ_VENDOR_DEVICE;
1001 req.bRequest = MCS7840_RDREQ;
1002 USETW(req.wValue, wVal);
1003 USETW(req.wIndex, reg);
1004 USETW(req.wLength, UMCS7840_READ_LENGTH);
1006 err = usbd_do_request_proc(sc->sc_udev, &sc->sc_super_ucom.sc_tq, &req, (void *)data, 0, &len, UMCS7840_CTRL_TIMEOUT);
1007 if (err == USB_ERR_NORMAL_COMPLETION && len != 1) {
1008 device_printf(sc->sc_dev, "Reading UART%d register %d failed: invalid length %d\n", portno, reg, len);
1009 return (USB_ERR_INVAL);
1011 device_printf(sc->sc_dev, "Reading UART%d register %d failed: %s\n", portno, reg, usbd_errstr(err));
1016 umcs7840_set_UART_reg_sync(struct umcs7840_softc *sc, uint8_t portno, uint8_t reg, uint8_t data)
1018 struct usb_device_request req;
1022 /* portno is port number */
1023 wVal = ((uint16_t)(portno + 1)) << 8 | data;
1025 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
1026 req.bRequest = MCS7840_WRREQ;
1027 USETW(req.wValue, wVal);
1028 USETW(req.wIndex, reg);
1029 USETW(req.wLength, 0);
1031 err = usbd_do_request_proc(sc->sc_udev, &sc->sc_super_ucom.sc_tq, &req, NULL, 0, NULL, UMCS7840_CTRL_TIMEOUT);
1033 device_printf(sc->sc_dev, "Writing UART%d register %d failed: %s\n", portno, reg, usbd_errstr(err));
1038 umcs7840_set_baudrate(struct umcs7840_softc *sc, uint8_t portno, uint32_t rate)
1045 if (umcs7840_calc_baudrate(rate, &divisor, &clk)) {
1046 DPRINTF("Port %d bad speed: %d\n", portno, rate);
1049 if (divisor == 0 || (clk & MCS7840_DEV_SPx_CLOCK_MASK) != clk) {
1050 DPRINTF("Port %d bad speed calculation: %d\n", portno, rate);
1053 DPRINTF("Port %d set speed: %d (%02x / %d)\n", portno, rate, clk, divisor);
1055 /* Set clock source for standard BAUD frequences */
1056 err = umcs7840_get_reg_sync(sc, umcs7840_port_registers[portno].reg_sp, &data);
1059 data &= MCS7840_DEV_SPx_CLOCK_MASK;
1061 err = umcs7840_set_reg_sync(sc, umcs7840_port_registers[portno].reg_sp, data);
1066 sc->sc_ports[portno].sc_lcr |= MCS7840_UART_LCR_DIVISORS;
1067 err = umcs7840_set_UART_reg_sync(sc, portno, MCS7840_UART_REG_LCR, sc->sc_ports[portno].sc_lcr);
1071 err = umcs7840_set_UART_reg_sync(sc, portno, MCS7840_UART_REG_DLL, (uint8_t)(divisor & 0xff));
1074 err = umcs7840_set_UART_reg_sync(sc, portno, MCS7840_UART_REG_DLM, (uint8_t)((divisor >> 8) & 0xff));
1078 /* Turn off access to DLL/DLM registers of UART */
1079 sc->sc_ports[portno].sc_lcr &= ~MCS7840_UART_LCR_DIVISORS;
1080 err = umcs7840_set_UART_reg_sync(sc, portno, MCS7840_UART_REG_LCR, sc->sc_ports[portno].sc_lcr);
1086 /* Maximum speeds for standard frequences, when PLL is not used */
1087 static const uint32_t umcs7840_baudrate_divisors[] = {0, 115200, 230400, 403200, 460800, 806400, 921600, 1572864, 3145728,};
1088 static const uint8_t umcs7840_baudrate_divisors_len = nitems(umcs7840_baudrate_divisors);
1091 umcs7840_calc_baudrate(uint32_t rate, uint16_t *divisor, uint8_t *clk)
1095 if (rate > umcs7840_baudrate_divisors[umcs7840_baudrate_divisors_len - 1])
1098 for (i = 0; i < umcs7840_baudrate_divisors_len - 1 &&
1099 !(rate > umcs7840_baudrate_divisors[i] && rate <= umcs7840_baudrate_divisors[i + 1]); ++i);
1101 *divisor = 1; /* XXX */
1103 *divisor = umcs7840_baudrate_divisors[i + 1] / rate;
1105 *clk = i << MCS7840_DEV_SPx_CLOCK_SHIFT;