umcs.c revision 1.15.10.1 1 /* $NetBSD: umcs.c,v 1.15.10.1 2021/03/22 02:01:02 thorpej Exp $ */
2 /* $FreeBSD: head/sys/dev/usb/serial/umcs.c 260559 2014-01-12 11:44:28Z hselasky $ */
3
4 /*-
5 * Copyright (c) 2010 Lev Serebryakov <lev (at) FreeBSD.org>.
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 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30 /*
31 * This driver supports several multiport USB-to-RS232 serial adapters driven
32 * by MosChip mos7820 and mos7840, bridge chips.
33 * The adapters are sold under many different brand names.
34 *
35 * Datasheets are available at MosChip www site at
36 * http://www.moschip.com. The datasheets don't contain full
37 * programming information for the chip.
38 *
39 * It is nornal to have only two enabled ports in devices, based on
40 * quad-port mos7840.
41 *
42 */
43 #include <sys/cdefs.h>
44 __KERNEL_RCSID(0, "$NetBSD: umcs.c,v 1.15.10.1 2021/03/22 02:01:02 thorpej Exp $");
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/atomic.h>
49 #include <sys/kernel.h>
50 #include <sys/conf.h>
51 #include <sys/tty.h>
52 #include <sys/device.h>
53 #include <sys/kmem.h>
54
55 #include <dev/usb/usb.h>
56 #include <dev/usb/usbdi.h>
57 #include <dev/usb/usbdi_util.h>
58 #include <dev/usb/usbdevs.h>
59
60 #include <dev/usb/usbdevs.h>
61 #include <dev/usb/ucomvar.h>
62
63 #include "umcs.h"
64
65 #if 0
66 #define DPRINTF(ARG) printf ARG
67 #else
68 #define DPRINTF(ARG)
69 #endif
70
71 /*
72 * Two-port devices (both with 7820 chip and 7840 chip configured as two-port)
73 * have ports 0 and 2, with ports 1 and 3 omitted.
74 * So, PHYSICAL port numbers on two-port device will be 0 and 2.
75 *
76 * We use an array of the following struct, indexed by ucom port index,
77 * and include the physical port number in it.
78 */
79 struct umcs7840_softc_oneport {
80 device_t sc_port_ucom; /* ucom subdevice */
81 unsigned int sc_port_phys; /* physical port number */
82 uint8_t sc_port_lcr; /* local line control register */
83 uint8_t sc_port_mcr; /* local modem control register */
84 };
85
86 struct umcs7840_softc {
87 device_t sc_dev; /* ourself */
88 enum {
89 UMCS_INIT_NONE,
90 UMCS_INIT_INITED
91 } sc_init_state;
92 struct usbd_interface *sc_iface; /* the usb interface */
93 struct usbd_device *sc_udev; /* the usb device */
94 struct usbd_pipe *sc_intr_pipe; /* interrupt pipe */
95 uint8_t *sc_intr_buf; /* buffer for interrupt xfer */
96 unsigned int sc_intr_buflen; /* size of buffer */
97 struct usb_task sc_change_task; /* async status changes */
98 volatile uint32_t sc_change_mask; /* mask of port changes */
99 struct umcs7840_softc_oneport sc_ports[UMCS7840_MAX_PORTS];
100 /* data for each port */
101 uint8_t sc_numports; /* number of ports (subunits) */
102 bool sc_init_done; /* special one time init in open */
103 bool sc_dying; /* we have been deactivated */
104 };
105
106 static int umcs7840_get_reg(struct umcs7840_softc *, uint8_t, uint8_t *);
107 static int umcs7840_set_reg(struct umcs7840_softc *, uint8_t, uint8_t);
108 static int umcs7840_get_UART_reg(struct umcs7840_softc *, uint8_t, uint8_t, uint8_t *);
109 static int umcs7840_set_UART_reg(struct umcs7840_softc *, uint8_t, uint8_t, uint8_t );
110 static int umcs7840_calc_baudrate(uint32_t, uint16_t *, uint8_t *);
111 static void umcs7840_dtr(struct umcs7840_softc *, int, bool);
112 static void umcs7840_rts(struct umcs7840_softc *, int, bool);
113 static void umcs7840_break(struct umcs7840_softc *, int, bool );
114
115 static int umcs7840_match(device_t, cfdata_t, void *);
116 static void umcs7840_attach(device_t, device_t, void *);
117 static int umcs7840_detach(device_t, int);
118 static void umcs7840_intr(struct usbd_xfer *, void *, usbd_status);
119 static void umcs7840_change_task(void *arg);
120 static void umcs7840_childdet(device_t, device_t);
121
122 static void umcs7840_get_status(void *, int, u_char *, u_char *);
123 static void umcs7840_set(void *, int, int, int);
124 static int umcs7840_param(void *, int, struct termios *);
125 static int umcs7840_port_open(void *, int);
126 static void umcs7840_port_close(void *, int);
127
128 static const struct ucom_methods umcs7840_methods = {
129 .ucom_get_status = umcs7840_get_status,
130 .ucom_set = umcs7840_set,
131 .ucom_param = umcs7840_param,
132 .ucom_open = umcs7840_port_open,
133 .ucom_close = umcs7840_port_close,
134 };
135
136 static const struct usb_devno umcs7840_devs[] = {
137 { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7703 },
138 { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7810 },
139 { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7820 },
140 { USB_VENDOR_MOSCHIP, USB_PRODUCT_MOSCHIP_MCS7840 },
141 { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC2324 }
142 };
143 #define umcs7840_lookup(v, p) usb_lookup(umcs7840_devs, v, p)
144
145 CFATTACH_DECL2_NEW(umcs, sizeof(struct umcs7840_softc), umcs7840_match,
146 umcs7840_attach, umcs7840_detach, NULL, NULL,
147 umcs7840_childdet);
148
149 static inline int
150 umcs7840_reg_sp(int phyport)
151 {
152 KASSERT(phyport >= 0 && phyport < 4);
153 switch (phyport) {
154 default:
155 case 0: return MCS7840_DEV_REG_SP1;
156 case 1: return MCS7840_DEV_REG_SP2;
157 case 2: return MCS7840_DEV_REG_SP3;
158 case 3: return MCS7840_DEV_REG_SP4;
159 }
160 }
161
162 static inline int
163 umcs7840_reg_ctrl(int phyport)
164 {
165 KASSERT(phyport >= 0 && phyport < 4);
166 switch (phyport) {
167 default:
168 case 0: return MCS7840_DEV_REG_CONTROL1;
169 case 1: return MCS7840_DEV_REG_CONTROL2;
170 case 2: return MCS7840_DEV_REG_CONTROL3;
171 case 3: return MCS7840_DEV_REG_CONTROL4;
172 }
173 }
174
175 static int
176 umcs7840_match(device_t dev, cfdata_t match, void *aux)
177 {
178 struct usb_attach_arg *uaa = aux;
179
180 return umcs7840_lookup(uaa->uaa_vendor, uaa->uaa_product) != NULL ?
181 UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
182 }
183
184 static void
185 umcs7840_attach(device_t parent, device_t self, void *aux)
186 {
187 struct umcs7840_softc *sc = device_private(self);
188 struct usb_attach_arg *uaa = aux;
189 struct usbd_device *dev = uaa->uaa_device;
190 usb_interface_descriptor_t *id;
191 usb_endpoint_descriptor_t *ed;
192 char *devinfop;
193 struct ucom_attach_args ucaa;
194 int error, i, intr_addr;
195 uint8_t data;
196
197 sc->sc_dev = self;
198 sc->sc_udev = uaa->uaa_device;
199 sc->sc_dying = false;
200 sc->sc_init_state = UMCS_INIT_NONE;
201
202 if (usbd_set_config_index(sc->sc_udev, MCS7840_CONFIG_INDEX, 1) != 0) {
203 aprint_error(": could not set configuration no\n");
204 sc->sc_dying = true;
205 return;
206 }
207
208 /* get the first interface handle */
209 error = usbd_device2interface_handle(sc->sc_udev, MCS7840_IFACE_INDEX,
210 &sc->sc_iface);
211 if (error != 0) {
212 aprint_error(": could not get interface handle\n");
213 sc->sc_dying = true;
214 return;
215 }
216
217 /*
218 * Get number of ports
219 * Documentation (full datasheet) says, that number of ports is
220 * set as MCS7840_DEV_MODE_SELECT24S bit in MODE R/Only
221 * register. But vendor driver uses these undocumented
222 * register & bit.
223 *
224 * Experiments show, that MODE register can have `0'
225 * (4 ports) bit on 2-port device, so use vendor driver's way.
226 *
227 * Also, see notes in header file for these constants.
228 */
229 umcs7840_get_reg(sc, MCS7840_DEV_REG_GPIO, &data);
230 if (data & MCS7840_DEV_GPIO_4PORTS) {
231 sc->sc_numports = 4;
232 /* physical port no are : 0, 1, 2, 3 */
233 } else {
234 if (uaa->uaa_product == USB_PRODUCT_MOSCHIP_MCS7810)
235 sc->sc_numports = 1;
236 else {
237 sc->sc_numports = 2;
238 /* physical port no are : 0 and 2 */
239 }
240 }
241 devinfop = usbd_devinfo_alloc(dev, 0);
242 aprint_normal(": %s\n", devinfop);
243 usbd_devinfo_free(devinfop);
244 aprint_verbose_dev(self, "found %d active ports\n", sc->sc_numports);
245
246 if (!umcs7840_get_reg(sc, MCS7840_DEV_REG_MODE, &data)) {
247 aprint_verbose_dev(self, "On-die confguration: RST: active %s, "
248 "HRD: %s, PLL: %s, POR: %s, Ports: %s, EEPROM write %s, "
249 "IrDA is %savailable\n",
250 (data & MCS7840_DEV_MODE_RESET) ? "low" : "high",
251 (data & MCS7840_DEV_MODE_SER_PRSNT) ? "yes" : "no",
252 (data & MCS7840_DEV_MODE_PLLBYPASS) ? "bypassed" : "avail",
253 (data & MCS7840_DEV_MODE_PORBYPASS) ? "bypassed" : "avail",
254 (data & MCS7840_DEV_MODE_SELECT24S) ? "2" : "4",
255 (data & MCS7840_DEV_MODE_EEPROMWR) ? "enabled" : "disabled",
256 (data & MCS7840_DEV_MODE_IRDA) ? "" : "not ");
257 }
258
259 /*
260 * Set up the interrupt pipe
261 */
262 id = usbd_get_interface_descriptor(sc->sc_iface);
263 intr_addr = -1;
264 for (i = 0 ; i < id->bNumEndpoints ; i++) {
265 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
266 if (ed == NULL) continue;
267 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN
268 || UE_GET_XFERTYPE(ed->bmAttributes) != UE_INTERRUPT)
269 continue;
270 sc->sc_intr_buflen = UGETW(ed->wMaxPacketSize);
271 intr_addr = ed->bEndpointAddress;
272 break;
273 }
274 if (intr_addr < 0) {
275 aprint_error_dev(self, "interrupt pipe not found\n");
276 sc->sc_dying = true;
277 return;
278 }
279 sc->sc_intr_buf = kmem_alloc(sc->sc_intr_buflen, KM_SLEEP);
280
281 error = usbd_open_pipe_intr(sc->sc_iface, intr_addr,
282 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buf,
283 sc->sc_intr_buflen, umcs7840_intr, 100);
284 if (error) {
285 aprint_error_dev(self, "cannot open interrupt pipe "
286 "(addr %d)\n", intr_addr);
287 sc->sc_dying = true;
288 return;
289 }
290
291 usb_init_task(&sc->sc_change_task, umcs7840_change_task, sc,
292 USB_TASKQ_MPSAFE);
293
294 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
295
296 sc->sc_init_state = UMCS_INIT_INITED;
297
298 memset(&ucaa, 0, sizeof(ucaa));
299 ucaa.ucaa_ibufsize = 256;
300 ucaa.ucaa_obufsize = 256;
301 ucaa.ucaa_ibufsizepad = 256;
302 ucaa.ucaa_opkthdrlen = 0;
303 ucaa.ucaa_device = sc->sc_udev;
304 ucaa.ucaa_iface = sc->sc_iface;
305 ucaa.ucaa_methods = &umcs7840_methods;
306 ucaa.ucaa_arg = sc;
307
308 for (i = 0; i < sc->sc_numports; i++) {
309 ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1;
310
311 /*
312 * On four port cards, endpoints are 0/1 for first,
313 * 2/3 for second, ...
314 * On two port cards, they are 0/1 for first, 4/5 for second.
315 * On single port, just 0/1 will be used.
316 */
317 int phyport = i * (sc->sc_numports == 2 ? 2 : 1);
318
319 ed = usbd_interface2endpoint_descriptor(sc->sc_iface,
320 phyport*2);
321 if (ed == NULL) {
322 aprint_error_dev(self,
323 "no bulk in endpoint found for %d\n", i);
324 sc->sc_dying = true;
325 return;
326 }
327 ucaa.ucaa_bulkin = ed->bEndpointAddress;
328
329 ed = usbd_interface2endpoint_descriptor(sc->sc_iface,
330 phyport*2 + 1);
331 if (ed == NULL) {
332 aprint_error_dev(self,
333 "no bulk out endpoint found for %d\n", i);
334 return;
335 }
336 ucaa.ucaa_bulkout = ed->bEndpointAddress;
337 ucaa.ucaa_portno = i;
338 DPRINTF(("port %d physical port %d bulk-in %d bulk-out %d\n",
339 i, phyport, ucaa.ucaa_bulkin, ucaa.ucaa_bulkout));
340
341 sc->sc_ports[i].sc_port_phys = phyport;
342 sc->sc_ports[i].sc_port_ucom =
343 config_found(self, &ucaa, ucomprint,
344 CFARG_SUBMATCH, ucomsubmatch,
345 CFARG_IATTR, "ucombus",
346 CFARG_EOL);
347 }
348 }
349
350 static int
351 umcs7840_get_reg(struct umcs7840_softc *sc, uint8_t reg, uint8_t *data)
352 {
353 usb_device_request_t req;
354 int err;
355
356 req.bmRequestType = UT_READ_VENDOR_DEVICE;
357 req.bRequest = MCS7840_RDREQ;
358 USETW(req.wValue, 0);
359 USETW(req.wIndex, reg);
360 USETW(req.wLength, UMCS7840_READ_LENGTH);
361
362 err = usbd_do_request(sc->sc_udev, &req, data);
363 if (err)
364 aprint_normal_dev(sc->sc_dev,
365 "Reading register %d failed: %s\n", reg, usbd_errstr(err));
366 return err;
367 }
368
369 static int
370 umcs7840_set_reg(struct umcs7840_softc *sc, uint8_t reg, uint8_t data)
371 {
372 usb_device_request_t req;
373 int err;
374
375 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
376 req.bRequest = MCS7840_WRREQ;
377 USETW(req.wValue, data);
378 USETW(req.wIndex, reg);
379 USETW(req.wLength, 0);
380
381 err = usbd_do_request(sc->sc_udev, &req, 0);
382 if (err)
383 aprint_normal_dev(sc->sc_dev, "Writing register %d failed: %s\n", reg, usbd_errstr(err));
384
385 return err;
386 }
387
388 static int
389 umcs7840_get_UART_reg(struct umcs7840_softc *sc, uint8_t portno,
390 uint8_t reg, uint8_t *data)
391 {
392 usb_device_request_t req;
393 uint16_t wVal;
394 int err;
395
396 /* portno is port number */
397 wVal = ((uint16_t)(portno + 1)) << 8;
398
399 req.bmRequestType = UT_READ_VENDOR_DEVICE;
400 req.bRequest = MCS7840_RDREQ;
401 USETW(req.wValue, wVal);
402 USETW(req.wIndex, reg);
403 USETW(req.wLength, UMCS7840_READ_LENGTH);
404
405 err = usbd_do_request(sc->sc_udev, &req, data);
406 if (err)
407 aprint_normal_dev(sc->sc_dev, "Reading UART %d register %d failed: %s\n", portno, reg, usbd_errstr(err));
408 return err;
409 }
410
411 static int
412 umcs7840_set_UART_reg(struct umcs7840_softc *sc, uint8_t portno, uint8_t reg, uint8_t data)
413 {
414 usb_device_request_t req;
415 int err;
416 uint16_t wVal;
417
418 /* portno is the physical port number */
419 wVal = ((uint16_t)(portno + 1)) << 8 | data;
420
421 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
422 req.bRequest = MCS7840_WRREQ;
423 USETW(req.wValue, wVal);
424 USETW(req.wIndex, reg);
425 USETW(req.wLength, 0);
426
427 err = usbd_do_request(sc->sc_udev, &req, NULL);
428 if (err)
429 aprint_error_dev(sc->sc_dev,
430 "Writing UART %d register %d failed: %s\n",
431 portno, reg, usbd_errstr(err));
432 return err;
433 }
434
435 static int
436 umcs7840_set_baudrate(struct umcs7840_softc *sc, uint8_t portno,
437 uint32_t rate)
438 {
439 int err;
440 uint16_t divisor;
441 uint8_t clk;
442 uint8_t data;
443 uint8_t physport = sc->sc_ports[portno].sc_port_phys;
444 int spreg = umcs7840_reg_sp(physport);
445
446 if (umcs7840_calc_baudrate(rate, &divisor, &clk)) {
447 DPRINTF(("Port %d bad speed: %d\n", portno, rate));
448 return -1;
449 }
450 if (divisor == 0 || (clk & MCS7840_DEV_SPx_CLOCK_MASK) != clk) {
451 DPRINTF(("Port %d bad speed calculation: %d\n", portno,
452 rate));
453 return -1;
454 }
455 DPRINTF(("Port %d set speed: %d (%02x / %d)\n", portno, rate, clk, divisor));
456
457 /* Set clock source for standard BAUD frequences */
458 err = umcs7840_get_reg(sc, spreg, &data);
459 if (err)
460 return err;
461 data &= MCS7840_DEV_SPx_CLOCK_MASK;
462 data |= clk;
463 err = umcs7840_set_reg(sc, spreg, data);
464 if (err)
465 return err;
466
467 /* Set divider */
468 sc->sc_ports[portno].sc_port_lcr |= MCS7840_UART_LCR_DIVISORS;
469 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_LCR, sc->sc_ports[portno].sc_port_lcr);
470 if (err)
471 return err;
472
473 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_DLL, (uint8_t)(divisor & 0xff));
474 if (err)
475 return err;
476 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_DLM, (uint8_t)((divisor >> 8) & 0xff));
477 if (err)
478 return err;
479
480 /* Turn off access to DLL/DLM registers of UART */
481 sc->sc_ports[portno].sc_port_lcr &= ~MCS7840_UART_LCR_DIVISORS;
482 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_LCR, sc->sc_ports[portno].sc_port_lcr);
483 if (err)
484 return err;
485 return 0;
486 }
487
488 static int
489 umcs7840_calc_baudrate(uint32_t rate, uint16_t *divisor, uint8_t *clk)
490 {
491 /* Maximum speeds for standard frequences, when PLL is not used */
492 static const uint32_t umcs7840_baudrate_divisors[] =
493 {0, 115200, 230400, 403200, 460800, 806400, 921600,
494 1572864, 3145728,};
495 static const uint8_t umcs7840_baudrate_divisors_len =
496 __arraycount(umcs7840_baudrate_divisors);
497 uint8_t i = 0;
498
499 if (rate > umcs7840_baudrate_divisors[umcs7840_baudrate_divisors_len - 1])
500 return -1;
501
502 for (i = 0; i < umcs7840_baudrate_divisors_len - 1
503 && !(rate > umcs7840_baudrate_divisors[i]
504 && rate <= umcs7840_baudrate_divisors[i + 1]); ++i);
505 *divisor = umcs7840_baudrate_divisors[i + 1] / rate;
506 /* 0x00 .. 0x70 */
507 *clk = i << MCS7840_DEV_SPx_CLOCK_SHIFT;
508 return 0;
509 }
510
511 static int
512 umcs7840_detach(device_t self, int flags)
513 {
514 struct umcs7840_softc *sc = device_private(self);
515 int rv = 0, i;
516
517 sc->sc_dying = true;
518
519 /* close interrupt pipe */
520 if (sc->sc_intr_pipe != NULL) {
521 usbd_abort_pipe(sc->sc_intr_pipe);
522 usbd_close_pipe(sc->sc_intr_pipe);
523 sc->sc_intr_pipe = NULL;
524 }
525 if (sc->sc_intr_buf != NULL) {
526 kmem_free(sc->sc_intr_buf, sc->sc_intr_buflen);
527 sc->sc_intr_buf = NULL;
528 }
529
530 if (sc->sc_init_state < UMCS_INIT_INITED)
531 return 0;
532
533 usb_rem_task_wait(sc->sc_udev, &sc->sc_change_task, USB_TASKQ_DRIVER,
534 NULL);
535
536 /* detach children */
537 for (i = 0; i < sc->sc_numports; i++) {
538 if (sc->sc_ports[i].sc_port_ucom) {
539 rv |= config_detach(sc->sc_ports[i].sc_port_ucom,
540 flags);
541 sc->sc_ports[i].sc_port_ucom = NULL;
542 }
543 }
544
545 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
546
547 return rv;
548 }
549
550 static void
551 umcs7840_childdet(device_t self, device_t child)
552 {
553 struct umcs7840_softc *sc = device_private(self);
554 int i;
555
556 for (i = 0; i < sc->sc_numports; i++) {
557 if (child == sc->sc_ports[i].sc_port_ucom) {
558 sc->sc_ports[i].sc_port_ucom = NULL;
559 return;
560 }
561 }
562 }
563
564 static void
565 umcs7840_get_status(void *self, int portno, u_char *lsr, u_char *msr)
566 {
567 struct umcs7840_softc *sc = self;
568 uint8_t pn = sc->sc_ports[portno].sc_port_phys;
569 uint8_t hw_lsr = 0; /* local line status register */
570 uint8_t hw_msr = 0; /* local modem status register */
571
572 if (sc->sc_dying)
573 return;
574
575 /* Read LSR & MSR */
576 umcs7840_get_UART_reg(sc, pn, MCS7840_UART_REG_LSR, &hw_lsr);
577 umcs7840_get_UART_reg(sc, pn, MCS7840_UART_REG_MSR, &hw_msr);
578
579 *lsr = hw_lsr;
580 *msr = hw_msr;
581 }
582
583 static void
584 umcs7840_set(void *self, int portno, int reg, int onoff)
585 {
586 struct umcs7840_softc *sc = self;
587
588 if (sc->sc_dying)
589 return;
590
591 switch (reg) {
592 case UCOM_SET_DTR:
593 umcs7840_dtr(sc, portno, onoff);
594 break;
595 case UCOM_SET_RTS:
596 umcs7840_rts(sc, portno, onoff);
597 break;
598 case UCOM_SET_BREAK:
599 umcs7840_break(sc, portno, onoff);
600 break;
601 default:
602 break;
603 }
604 }
605
606 static int
607 umcs7840_param(void *self, int portno, struct termios *t)
608 {
609 struct umcs7840_softc *sc = self;
610 int pn = sc->sc_ports[portno].sc_port_phys;
611 uint8_t lcr = sc->sc_ports[portno].sc_port_lcr;
612 uint8_t mcr = sc->sc_ports[portno].sc_port_mcr;
613
614 if (sc->sc_dying)
615 return EIO;
616
617 if (t->c_cflag & CSTOPB) {
618 lcr |= MCS7840_UART_LCR_STOPB2;
619 } else {
620 lcr |= MCS7840_UART_LCR_STOPB1;
621 }
622
623 lcr &= ~MCS7840_UART_LCR_PARITYMASK;
624 if (t->c_cflag & PARENB) {
625 lcr |= MCS7840_UART_LCR_PARITYON;
626 if (t->c_cflag & PARODD) {
627 lcr = MCS7840_UART_LCR_PARITYODD;
628 } else {
629 lcr = MCS7840_UART_LCR_PARITYEVEN;
630 }
631 } else {
632 lcr &= ~MCS7840_UART_LCR_PARITYON;
633 }
634
635 lcr &= ~MCS7840_UART_LCR_DATALENMASK;
636 switch (t->c_cflag & CSIZE) {
637 case CS5:
638 lcr |= MCS7840_UART_LCR_DATALEN5;
639 break;
640 case CS6:
641 lcr |= MCS7840_UART_LCR_DATALEN6;
642 break;
643 case CS7:
644 lcr |= MCS7840_UART_LCR_DATALEN7;
645 break;
646 case CS8:
647 lcr |= MCS7840_UART_LCR_DATALEN8;
648 break;
649 }
650
651 if (t->c_cflag & CRTSCTS)
652 mcr |= MCS7840_UART_MCR_CTSRTS;
653 else
654 mcr &= ~MCS7840_UART_MCR_CTSRTS;
655
656 if (t->c_cflag & CLOCAL)
657 mcr &= ~MCS7840_UART_MCR_DTRDSR;
658 else
659 mcr |= MCS7840_UART_MCR_DTRDSR;
660
661 sc->sc_ports[portno].sc_port_lcr = lcr;
662 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
663 sc->sc_ports[pn].sc_port_lcr);
664
665 sc->sc_ports[portno].sc_port_mcr = mcr;
666 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
667 sc->sc_ports[pn].sc_port_mcr);
668
669 if (umcs7840_set_baudrate(sc, portno, t->c_ospeed))
670 return EIO;
671
672 return 0;
673 }
674
675 static void
676 umcs7840_dtr(struct umcs7840_softc *sc, int portno, bool onoff)
677 {
678 int pn = sc->sc_ports[portno].sc_port_phys;
679 uint8_t mcr = sc->sc_ports[portno].sc_port_mcr;
680
681 if (onoff)
682 mcr |= MCS7840_UART_MCR_DTR;
683 else
684 mcr &= ~MCS7840_UART_MCR_DTR;
685
686 sc->sc_ports[portno].sc_port_mcr = mcr;
687 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
688 sc->sc_ports[pn].sc_port_mcr);
689 }
690
691 static void
692 umcs7840_rts(struct umcs7840_softc *sc, int portno, bool onoff)
693 {
694 int pn = sc->sc_ports[portno].sc_port_phys;
695 uint8_t mcr = sc->sc_ports[portno].sc_port_mcr;
696
697 if (onoff)
698 mcr |= MCS7840_UART_MCR_RTS;
699 else
700 mcr &= ~MCS7840_UART_MCR_RTS;
701
702 sc->sc_ports[portno].sc_port_mcr = mcr;
703 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
704 sc->sc_ports[pn].sc_port_mcr);
705 }
706
707 static void
708 umcs7840_break(struct umcs7840_softc *sc, int portno, bool onoff)
709 {
710 int pn = sc->sc_ports[portno].sc_port_phys;
711 uint8_t lcr = sc->sc_ports[portno].sc_port_lcr;
712
713 if (onoff)
714 lcr |= MCS7840_UART_LCR_BREAK;
715 else
716 lcr &= ~MCS7840_UART_LCR_BREAK;
717
718 sc->sc_ports[portno].sc_port_lcr = lcr;
719 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
720 sc->sc_ports[pn].sc_port_lcr);
721 }
722
723 static int
724 umcs7840_port_open(void *self, int portno)
725 {
726 struct umcs7840_softc *sc = self;
727 int pn = sc->sc_ports[portno].sc_port_phys;
728 int spreg = umcs7840_reg_sp(pn);
729 int ctrlreg = umcs7840_reg_ctrl(pn);
730 uint8_t data;
731
732 if (sc->sc_dying)
733 return EIO;
734
735 /* If it very first open, finish global configuration */
736 if (!sc->sc_init_done) {
737 if (umcs7840_get_reg(sc, MCS7840_DEV_REG_CONTROL1, &data))
738 return EIO;
739 data |= MCS7840_DEV_CONTROL1_DRIVER_DONE;
740 if (umcs7840_set_reg(sc, MCS7840_DEV_REG_CONTROL1, data))
741 return EIO;
742 sc->sc_init_done = 1;
743 }
744
745 /* Toggle reset bit on-off */
746 if (umcs7840_get_reg(sc, spreg, &data))
747 return EIO;
748 data |= MCS7840_DEV_SPx_UART_RESET;
749 if (umcs7840_set_reg(sc, spreg, data))
750 return EIO;
751 data &= ~MCS7840_DEV_SPx_UART_RESET;
752 if (umcs7840_set_reg(sc, spreg, data))
753 return EIO;
754
755 /* Set RS-232 mode */
756 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_SCRATCHPAD,
757 MCS7840_UART_SCRATCHPAD_RS232))
758 return EIO;
759
760 /* Disable RX on time of initialization */
761 if (umcs7840_get_reg(sc, ctrlreg, &data))
762 return EIO;
763 data |= MCS7840_DEV_CONTROLx_RX_DISABLE;
764 if (umcs7840_set_reg(sc, ctrlreg, data))
765 return EIO;
766
767 /* Disable all interrupts */
768 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_IER, 0))
769 return EIO;
770
771 /* Reset FIFO -- documented */
772 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_FCR, 0))
773 return EIO;
774 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_FCR,
775 MCS7840_UART_FCR_ENABLE | MCS7840_UART_FCR_FLUSHRHR |
776 MCS7840_UART_FCR_FLUSHTHR | MCS7840_UART_FCR_RTL_1_14))
777 return EIO;
778
779 /* Set 8 bit, no parity, 1 stop bit -- documented */
780 sc->sc_ports[pn].sc_port_lcr =
781 MCS7840_UART_LCR_DATALEN8 | MCS7840_UART_LCR_STOPB1;
782 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
783 sc->sc_ports[pn].sc_port_lcr))
784 return EIO;
785
786 /*
787 * Enable DTR/RTS on modem control, enable modem interrupts --
788 * documented
789 */
790 sc->sc_ports[pn].sc_port_mcr = MCS7840_UART_MCR_DTR
791 | MCS7840_UART_MCR_RTS | MCS7840_UART_MCR_IE;
792 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
793 sc->sc_ports[pn].sc_port_mcr))
794 return EIO;
795
796 /* Clearing Bulkin and Bulkout FIFO */
797 if (umcs7840_get_reg(sc, spreg, &data))
798 return EIO;
799 data |= MCS7840_DEV_SPx_RESET_OUT_FIFO | MCS7840_DEV_SPx_RESET_IN_FIFO;
800 if (umcs7840_set_reg(sc, spreg, data))
801 return EIO;
802 data &= ~(MCS7840_DEV_SPx_RESET_OUT_FIFO
803 | MCS7840_DEV_SPx_RESET_IN_FIFO);
804 if (umcs7840_set_reg(sc, spreg, data))
805 return EIO;
806
807 /* Set speed 9600 */
808 if (umcs7840_set_baudrate(sc, portno, 9600))
809 return EIO;
810
811
812 /* Finally enable all interrupts -- documented */
813 /*
814 * Copied from vendor driver, I don't know why we should read LCR
815 * here
816 */
817 if (umcs7840_get_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
818 &sc->sc_ports[pn].sc_port_lcr))
819 return EIO;
820 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_IER,
821 MCS7840_UART_IER_RXSTAT | MCS7840_UART_IER_MODEM))
822 return EIO;
823
824 /* Enable RX */
825 if (umcs7840_get_reg(sc, ctrlreg, &data))
826 return EIO;
827 data &= ~MCS7840_DEV_CONTROLx_RX_DISABLE;
828 if (umcs7840_set_reg(sc, ctrlreg, data))
829 return EIO;
830 return 0;
831 }
832
833 static void
834 umcs7840_port_close(void *self, int portno)
835 {
836 struct umcs7840_softc *sc = self;
837 int pn = sc->sc_ports[portno].sc_port_phys;
838 int ctrlreg = umcs7840_reg_ctrl(pn);
839 uint8_t data;
840
841 if (sc->sc_dying)
842 return;
843
844 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR, 0);
845 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_IER, 0);
846
847 /* Disable RX */
848 if (umcs7840_get_reg(sc, ctrlreg, &data))
849 return;
850 data |= MCS7840_DEV_CONTROLx_RX_DISABLE;
851 if (umcs7840_set_reg(sc, ctrlreg, data))
852 return;
853 }
854
855 static void
856 umcs7840_intr(struct usbd_xfer *xfer, void *priv,
857 usbd_status status)
858 {
859 struct umcs7840_softc *sc = priv;
860 u_char *buf = sc->sc_intr_buf;
861 int actlen;
862 int subunit;
863
864 if (sc->sc_dying)
865 return;
866
867 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED
868 || status == USBD_IOERROR)
869 return;
870
871 if (status != USBD_NORMAL_COMPLETION) {
872 aprint_error_dev(sc->sc_dev,
873 "umcs7840_intr: abnormal status: %s\n",
874 usbd_errstr(status));
875 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
876 return;
877 }
878
879 usbd_get_xfer_status(xfer, NULL, NULL, &actlen, NULL);
880 if (actlen == 5 || actlen == 13) {
881 uint32_t change_mask = 0;
882 /* Check status of all ports */
883 for (subunit = 0; subunit < sc->sc_numports; subunit++) {
884 uint8_t pn = sc->sc_ports[subunit].sc_port_phys;
885 if (buf[pn] & MCS7840_UART_ISR_NOPENDING)
886 continue;
887 DPRINTF(("Port %d has pending interrupt: %02x "
888 "(FIFO: %02x)\n", pn,
889 buf[pn] & MCS7840_UART_ISR_INTMASK,
890 buf[pn] & (~MCS7840_UART_ISR_INTMASK)));
891 switch (buf[pn] & MCS7840_UART_ISR_INTMASK) {
892 case MCS7840_UART_ISR_RXERR:
893 case MCS7840_UART_ISR_RXHASDATA:
894 case MCS7840_UART_ISR_RXTIMEOUT:
895 case MCS7840_UART_ISR_MSCHANGE:
896 change_mask |= (1U << subunit);
897 break;
898 default:
899 /* Do nothing */
900 break;
901 }
902 }
903
904 if (change_mask != 0) {
905 atomic_or_32(&sc->sc_change_mask, change_mask);
906 usb_add_task(sc->sc_udev, &sc->sc_change_task,
907 USB_TASKQ_DRIVER);
908 }
909 } else {
910 aprint_error_dev(sc->sc_dev,
911 "Invalid interrupt data length %d", actlen);
912 }
913 }
914
915 static void
916 umcs7840_change_task(void *arg)
917 {
918 struct umcs7840_softc *sc = arg;
919 uint32_t change_mask;
920 int i;
921
922 change_mask = atomic_swap_32(&sc->sc_change_mask, 0);
923 for (i = 0; i < sc->sc_numports; i++) {
924 if (ISSET(change_mask, (1U << i)))
925 ucom_status_change(device_private(
926 sc->sc_ports[i].sc_port_ucom));
927 }
928 }
929