umcs.c revision 1.16.8.1 1 /* $NetBSD: umcs.c,v 1.16.8.1 2021/08/04 23:07:57 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.16.8.1 2021/08/04 23:07:57 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 CFARGS(.submatch = ucomsubmatch));
345 }
346 }
347
348 static int
349 umcs7840_get_reg(struct umcs7840_softc *sc, uint8_t reg, uint8_t *data)
350 {
351 usb_device_request_t req;
352 int err;
353
354 req.bmRequestType = UT_READ_VENDOR_DEVICE;
355 req.bRequest = MCS7840_RDREQ;
356 USETW(req.wValue, 0);
357 USETW(req.wIndex, reg);
358 USETW(req.wLength, UMCS7840_READ_LENGTH);
359
360 err = usbd_do_request(sc->sc_udev, &req, data);
361 if (err)
362 aprint_normal_dev(sc->sc_dev,
363 "Reading register %d failed: %s\n", reg, usbd_errstr(err));
364 return err;
365 }
366
367 static int
368 umcs7840_set_reg(struct umcs7840_softc *sc, uint8_t reg, uint8_t data)
369 {
370 usb_device_request_t req;
371 int err;
372
373 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
374 req.bRequest = MCS7840_WRREQ;
375 USETW(req.wValue, data);
376 USETW(req.wIndex, reg);
377 USETW(req.wLength, 0);
378
379 err = usbd_do_request(sc->sc_udev, &req, 0);
380 if (err)
381 aprint_normal_dev(sc->sc_dev, "Writing register %d failed: %s\n", reg, usbd_errstr(err));
382
383 return err;
384 }
385
386 static int
387 umcs7840_get_UART_reg(struct umcs7840_softc *sc, uint8_t portno,
388 uint8_t reg, uint8_t *data)
389 {
390 usb_device_request_t req;
391 uint16_t wVal;
392 int err;
393
394 /* portno is port number */
395 wVal = ((uint16_t)(portno + 1)) << 8;
396
397 req.bmRequestType = UT_READ_VENDOR_DEVICE;
398 req.bRequest = MCS7840_RDREQ;
399 USETW(req.wValue, wVal);
400 USETW(req.wIndex, reg);
401 USETW(req.wLength, UMCS7840_READ_LENGTH);
402
403 err = usbd_do_request(sc->sc_udev, &req, data);
404 if (err)
405 aprint_normal_dev(sc->sc_dev, "Reading UART %d register %d failed: %s\n", portno, reg, usbd_errstr(err));
406 return err;
407 }
408
409 static int
410 umcs7840_set_UART_reg(struct umcs7840_softc *sc, uint8_t portno, uint8_t reg, uint8_t data)
411 {
412 usb_device_request_t req;
413 int err;
414 uint16_t wVal;
415
416 /* portno is the physical port number */
417 wVal = ((uint16_t)(portno + 1)) << 8 | data;
418
419 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
420 req.bRequest = MCS7840_WRREQ;
421 USETW(req.wValue, wVal);
422 USETW(req.wIndex, reg);
423 USETW(req.wLength, 0);
424
425 err = usbd_do_request(sc->sc_udev, &req, NULL);
426 if (err)
427 aprint_error_dev(sc->sc_dev,
428 "Writing UART %d register %d failed: %s\n",
429 portno, reg, usbd_errstr(err));
430 return err;
431 }
432
433 static int
434 umcs7840_set_baudrate(struct umcs7840_softc *sc, uint8_t portno,
435 uint32_t rate)
436 {
437 int err;
438 uint16_t divisor;
439 uint8_t clk;
440 uint8_t data;
441 uint8_t physport = sc->sc_ports[portno].sc_port_phys;
442 int spreg = umcs7840_reg_sp(physport);
443
444 if (umcs7840_calc_baudrate(rate, &divisor, &clk)) {
445 DPRINTF(("Port %d bad speed: %d\n", portno, rate));
446 return -1;
447 }
448 if (divisor == 0 || (clk & MCS7840_DEV_SPx_CLOCK_MASK) != clk) {
449 DPRINTF(("Port %d bad speed calculation: %d\n", portno,
450 rate));
451 return -1;
452 }
453 DPRINTF(("Port %d set speed: %d (%02x / %d)\n", portno, rate, clk, divisor));
454
455 /* Set clock source for standard BAUD frequences */
456 err = umcs7840_get_reg(sc, spreg, &data);
457 if (err)
458 return err;
459 data &= MCS7840_DEV_SPx_CLOCK_MASK;
460 data |= clk;
461 err = umcs7840_set_reg(sc, spreg, data);
462 if (err)
463 return err;
464
465 /* Set divider */
466 sc->sc_ports[portno].sc_port_lcr |= MCS7840_UART_LCR_DIVISORS;
467 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_LCR, sc->sc_ports[portno].sc_port_lcr);
468 if (err)
469 return err;
470
471 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_DLL, (uint8_t)(divisor & 0xff));
472 if (err)
473 return err;
474 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_DLM, (uint8_t)((divisor >> 8) & 0xff));
475 if (err)
476 return err;
477
478 /* Turn off access to DLL/DLM registers of UART */
479 sc->sc_ports[portno].sc_port_lcr &= ~MCS7840_UART_LCR_DIVISORS;
480 err = umcs7840_set_UART_reg(sc, physport, MCS7840_UART_REG_LCR, sc->sc_ports[portno].sc_port_lcr);
481 if (err)
482 return err;
483 return 0;
484 }
485
486 static int
487 umcs7840_calc_baudrate(uint32_t rate, uint16_t *divisor, uint8_t *clk)
488 {
489 /* Maximum speeds for standard frequences, when PLL is not used */
490 static const uint32_t umcs7840_baudrate_divisors[] =
491 {0, 115200, 230400, 403200, 460800, 806400, 921600,
492 1572864, 3145728,};
493 static const uint8_t umcs7840_baudrate_divisors_len =
494 __arraycount(umcs7840_baudrate_divisors);
495 uint8_t i = 0;
496
497 if (rate > umcs7840_baudrate_divisors[umcs7840_baudrate_divisors_len - 1])
498 return -1;
499
500 for (i = 0; i < umcs7840_baudrate_divisors_len - 1
501 && !(rate > umcs7840_baudrate_divisors[i]
502 && rate <= umcs7840_baudrate_divisors[i + 1]); ++i);
503 *divisor = umcs7840_baudrate_divisors[i + 1] / rate;
504 /* 0x00 .. 0x70 */
505 *clk = i << MCS7840_DEV_SPx_CLOCK_SHIFT;
506 return 0;
507 }
508
509 static int
510 umcs7840_detach(device_t self, int flags)
511 {
512 struct umcs7840_softc *sc = device_private(self);
513 int rv = 0, i;
514
515 sc->sc_dying = true;
516
517 /* close interrupt pipe */
518 if (sc->sc_intr_pipe != NULL) {
519 usbd_abort_pipe(sc->sc_intr_pipe);
520 usbd_close_pipe(sc->sc_intr_pipe);
521 sc->sc_intr_pipe = NULL;
522 }
523 if (sc->sc_intr_buf != NULL) {
524 kmem_free(sc->sc_intr_buf, sc->sc_intr_buflen);
525 sc->sc_intr_buf = NULL;
526 }
527
528 if (sc->sc_init_state < UMCS_INIT_INITED)
529 return 0;
530
531 usb_rem_task_wait(sc->sc_udev, &sc->sc_change_task, USB_TASKQ_DRIVER,
532 NULL);
533
534 /* detach children */
535 for (i = 0; i < sc->sc_numports; i++) {
536 if (sc->sc_ports[i].sc_port_ucom) {
537 rv |= config_detach(sc->sc_ports[i].sc_port_ucom,
538 flags);
539 sc->sc_ports[i].sc_port_ucom = NULL;
540 }
541 }
542
543 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
544
545 return rv;
546 }
547
548 static void
549 umcs7840_childdet(device_t self, device_t child)
550 {
551 struct umcs7840_softc *sc = device_private(self);
552 int i;
553
554 for (i = 0; i < sc->sc_numports; i++) {
555 if (child == sc->sc_ports[i].sc_port_ucom) {
556 sc->sc_ports[i].sc_port_ucom = NULL;
557 return;
558 }
559 }
560 }
561
562 static void
563 umcs7840_get_status(void *self, int portno, u_char *lsr, u_char *msr)
564 {
565 struct umcs7840_softc *sc = self;
566 uint8_t pn = sc->sc_ports[portno].sc_port_phys;
567 uint8_t hw_lsr = 0; /* local line status register */
568 uint8_t hw_msr = 0; /* local modem status register */
569
570 if (sc->sc_dying)
571 return;
572
573 /* Read LSR & MSR */
574 umcs7840_get_UART_reg(sc, pn, MCS7840_UART_REG_LSR, &hw_lsr);
575 umcs7840_get_UART_reg(sc, pn, MCS7840_UART_REG_MSR, &hw_msr);
576
577 *lsr = hw_lsr;
578 *msr = hw_msr;
579 }
580
581 static void
582 umcs7840_set(void *self, int portno, int reg, int onoff)
583 {
584 struct umcs7840_softc *sc = self;
585
586 if (sc->sc_dying)
587 return;
588
589 switch (reg) {
590 case UCOM_SET_DTR:
591 umcs7840_dtr(sc, portno, onoff);
592 break;
593 case UCOM_SET_RTS:
594 umcs7840_rts(sc, portno, onoff);
595 break;
596 case UCOM_SET_BREAK:
597 umcs7840_break(sc, portno, onoff);
598 break;
599 default:
600 break;
601 }
602 }
603
604 static int
605 umcs7840_param(void *self, int portno, struct termios *t)
606 {
607 struct umcs7840_softc *sc = self;
608 int pn = sc->sc_ports[portno].sc_port_phys;
609 uint8_t lcr = sc->sc_ports[portno].sc_port_lcr;
610 uint8_t mcr = sc->sc_ports[portno].sc_port_mcr;
611
612 if (sc->sc_dying)
613 return EIO;
614
615 if (t->c_cflag & CSTOPB) {
616 lcr |= MCS7840_UART_LCR_STOPB2;
617 } else {
618 lcr |= MCS7840_UART_LCR_STOPB1;
619 }
620
621 lcr &= ~MCS7840_UART_LCR_PARITYMASK;
622 if (t->c_cflag & PARENB) {
623 lcr |= MCS7840_UART_LCR_PARITYON;
624 if (t->c_cflag & PARODD) {
625 lcr = MCS7840_UART_LCR_PARITYODD;
626 } else {
627 lcr = MCS7840_UART_LCR_PARITYEVEN;
628 }
629 } else {
630 lcr &= ~MCS7840_UART_LCR_PARITYON;
631 }
632
633 lcr &= ~MCS7840_UART_LCR_DATALENMASK;
634 switch (t->c_cflag & CSIZE) {
635 case CS5:
636 lcr |= MCS7840_UART_LCR_DATALEN5;
637 break;
638 case CS6:
639 lcr |= MCS7840_UART_LCR_DATALEN6;
640 break;
641 case CS7:
642 lcr |= MCS7840_UART_LCR_DATALEN7;
643 break;
644 case CS8:
645 lcr |= MCS7840_UART_LCR_DATALEN8;
646 break;
647 }
648
649 if (t->c_cflag & CRTSCTS)
650 mcr |= MCS7840_UART_MCR_CTSRTS;
651 else
652 mcr &= ~MCS7840_UART_MCR_CTSRTS;
653
654 if (t->c_cflag & CLOCAL)
655 mcr &= ~MCS7840_UART_MCR_DTRDSR;
656 else
657 mcr |= MCS7840_UART_MCR_DTRDSR;
658
659 sc->sc_ports[portno].sc_port_lcr = lcr;
660 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
661 sc->sc_ports[pn].sc_port_lcr);
662
663 sc->sc_ports[portno].sc_port_mcr = mcr;
664 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
665 sc->sc_ports[pn].sc_port_mcr);
666
667 if (umcs7840_set_baudrate(sc, portno, t->c_ospeed))
668 return EIO;
669
670 return 0;
671 }
672
673 static void
674 umcs7840_dtr(struct umcs7840_softc *sc, int portno, bool onoff)
675 {
676 int pn = sc->sc_ports[portno].sc_port_phys;
677 uint8_t mcr = sc->sc_ports[portno].sc_port_mcr;
678
679 if (onoff)
680 mcr |= MCS7840_UART_MCR_DTR;
681 else
682 mcr &= ~MCS7840_UART_MCR_DTR;
683
684 sc->sc_ports[portno].sc_port_mcr = mcr;
685 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
686 sc->sc_ports[pn].sc_port_mcr);
687 }
688
689 static void
690 umcs7840_rts(struct umcs7840_softc *sc, int portno, bool onoff)
691 {
692 int pn = sc->sc_ports[portno].sc_port_phys;
693 uint8_t mcr = sc->sc_ports[portno].sc_port_mcr;
694
695 if (onoff)
696 mcr |= MCS7840_UART_MCR_RTS;
697 else
698 mcr &= ~MCS7840_UART_MCR_RTS;
699
700 sc->sc_ports[portno].sc_port_mcr = mcr;
701 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
702 sc->sc_ports[pn].sc_port_mcr);
703 }
704
705 static void
706 umcs7840_break(struct umcs7840_softc *sc, int portno, bool onoff)
707 {
708 int pn = sc->sc_ports[portno].sc_port_phys;
709 uint8_t lcr = sc->sc_ports[portno].sc_port_lcr;
710
711 if (onoff)
712 lcr |= MCS7840_UART_LCR_BREAK;
713 else
714 lcr &= ~MCS7840_UART_LCR_BREAK;
715
716 sc->sc_ports[portno].sc_port_lcr = lcr;
717 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
718 sc->sc_ports[pn].sc_port_lcr);
719 }
720
721 static int
722 umcs7840_port_open(void *self, int portno)
723 {
724 struct umcs7840_softc *sc = self;
725 int pn = sc->sc_ports[portno].sc_port_phys;
726 int spreg = umcs7840_reg_sp(pn);
727 int ctrlreg = umcs7840_reg_ctrl(pn);
728 uint8_t data;
729
730 if (sc->sc_dying)
731 return EIO;
732
733 /* If it very first open, finish global configuration */
734 if (!sc->sc_init_done) {
735 if (umcs7840_get_reg(sc, MCS7840_DEV_REG_CONTROL1, &data))
736 return EIO;
737 data |= MCS7840_DEV_CONTROL1_DRIVER_DONE;
738 if (umcs7840_set_reg(sc, MCS7840_DEV_REG_CONTROL1, data))
739 return EIO;
740 sc->sc_init_done = 1;
741 }
742
743 /* Toggle reset bit on-off */
744 if (umcs7840_get_reg(sc, spreg, &data))
745 return EIO;
746 data |= MCS7840_DEV_SPx_UART_RESET;
747 if (umcs7840_set_reg(sc, spreg, data))
748 return EIO;
749 data &= ~MCS7840_DEV_SPx_UART_RESET;
750 if (umcs7840_set_reg(sc, spreg, data))
751 return EIO;
752
753 /* Set RS-232 mode */
754 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_SCRATCHPAD,
755 MCS7840_UART_SCRATCHPAD_RS232))
756 return EIO;
757
758 /* Disable RX on time of initialization */
759 if (umcs7840_get_reg(sc, ctrlreg, &data))
760 return EIO;
761 data |= MCS7840_DEV_CONTROLx_RX_DISABLE;
762 if (umcs7840_set_reg(sc, ctrlreg, data))
763 return EIO;
764
765 /* Disable all interrupts */
766 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_IER, 0))
767 return EIO;
768
769 /* Reset FIFO -- documented */
770 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_FCR, 0))
771 return EIO;
772 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_FCR,
773 MCS7840_UART_FCR_ENABLE | MCS7840_UART_FCR_FLUSHRHR |
774 MCS7840_UART_FCR_FLUSHTHR | MCS7840_UART_FCR_RTL_1_14))
775 return EIO;
776
777 /* Set 8 bit, no parity, 1 stop bit -- documented */
778 sc->sc_ports[pn].sc_port_lcr =
779 MCS7840_UART_LCR_DATALEN8 | MCS7840_UART_LCR_STOPB1;
780 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
781 sc->sc_ports[pn].sc_port_lcr))
782 return EIO;
783
784 /*
785 * Enable DTR/RTS on modem control, enable modem interrupts --
786 * documented
787 */
788 sc->sc_ports[pn].sc_port_mcr = MCS7840_UART_MCR_DTR
789 | MCS7840_UART_MCR_RTS | MCS7840_UART_MCR_IE;
790 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR,
791 sc->sc_ports[pn].sc_port_mcr))
792 return EIO;
793
794 /* Clearing Bulkin and Bulkout FIFO */
795 if (umcs7840_get_reg(sc, spreg, &data))
796 return EIO;
797 data |= MCS7840_DEV_SPx_RESET_OUT_FIFO | MCS7840_DEV_SPx_RESET_IN_FIFO;
798 if (umcs7840_set_reg(sc, spreg, data))
799 return EIO;
800 data &= ~(MCS7840_DEV_SPx_RESET_OUT_FIFO
801 | MCS7840_DEV_SPx_RESET_IN_FIFO);
802 if (umcs7840_set_reg(sc, spreg, data))
803 return EIO;
804
805 /* Set speed 9600 */
806 if (umcs7840_set_baudrate(sc, portno, 9600))
807 return EIO;
808
809
810 /* Finally enable all interrupts -- documented */
811 /*
812 * Copied from vendor driver, I don't know why we should read LCR
813 * here
814 */
815 if (umcs7840_get_UART_reg(sc, pn, MCS7840_UART_REG_LCR,
816 &sc->sc_ports[pn].sc_port_lcr))
817 return EIO;
818 if (umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_IER,
819 MCS7840_UART_IER_RXSTAT | MCS7840_UART_IER_MODEM))
820 return EIO;
821
822 /* Enable RX */
823 if (umcs7840_get_reg(sc, ctrlreg, &data))
824 return EIO;
825 data &= ~MCS7840_DEV_CONTROLx_RX_DISABLE;
826 if (umcs7840_set_reg(sc, ctrlreg, data))
827 return EIO;
828 return 0;
829 }
830
831 static void
832 umcs7840_port_close(void *self, int portno)
833 {
834 struct umcs7840_softc *sc = self;
835 int pn = sc->sc_ports[portno].sc_port_phys;
836 int ctrlreg = umcs7840_reg_ctrl(pn);
837 uint8_t data;
838
839 if (sc->sc_dying)
840 return;
841
842 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_MCR, 0);
843 umcs7840_set_UART_reg(sc, pn, MCS7840_UART_REG_IER, 0);
844
845 /* Disable RX */
846 if (umcs7840_get_reg(sc, ctrlreg, &data))
847 return;
848 data |= MCS7840_DEV_CONTROLx_RX_DISABLE;
849 if (umcs7840_set_reg(sc, ctrlreg, data))
850 return;
851 }
852
853 static void
854 umcs7840_intr(struct usbd_xfer *xfer, void *priv,
855 usbd_status status)
856 {
857 struct umcs7840_softc *sc = priv;
858 u_char *buf = sc->sc_intr_buf;
859 int actlen;
860 int subunit;
861
862 if (sc->sc_dying)
863 return;
864
865 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED
866 || status == USBD_IOERROR)
867 return;
868
869 if (status != USBD_NORMAL_COMPLETION) {
870 aprint_error_dev(sc->sc_dev,
871 "umcs7840_intr: abnormal status: %s\n",
872 usbd_errstr(status));
873 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
874 return;
875 }
876
877 usbd_get_xfer_status(xfer, NULL, NULL, &actlen, NULL);
878 if (actlen == 5 || actlen == 13) {
879 uint32_t change_mask = 0;
880 /* Check status of all ports */
881 for (subunit = 0; subunit < sc->sc_numports; subunit++) {
882 uint8_t pn = sc->sc_ports[subunit].sc_port_phys;
883 if (buf[pn] & MCS7840_UART_ISR_NOPENDING)
884 continue;
885 DPRINTF(("Port %d has pending interrupt: %02x "
886 "(FIFO: %02x)\n", pn,
887 buf[pn] & MCS7840_UART_ISR_INTMASK,
888 buf[pn] & (~MCS7840_UART_ISR_INTMASK)));
889 switch (buf[pn] & MCS7840_UART_ISR_INTMASK) {
890 case MCS7840_UART_ISR_RXERR:
891 case MCS7840_UART_ISR_RXHASDATA:
892 case MCS7840_UART_ISR_RXTIMEOUT:
893 case MCS7840_UART_ISR_MSCHANGE:
894 change_mask |= (1U << subunit);
895 break;
896 default:
897 /* Do nothing */
898 break;
899 }
900 }
901
902 if (change_mask != 0) {
903 atomic_or_32(&sc->sc_change_mask, change_mask);
904 usb_add_task(sc->sc_udev, &sc->sc_change_task,
905 USB_TASKQ_DRIVER);
906 }
907 } else {
908 aprint_error_dev(sc->sc_dev,
909 "Invalid interrupt data length %d", actlen);
910 }
911 }
912
913 static void
914 umcs7840_change_task(void *arg)
915 {
916 struct umcs7840_softc *sc = arg;
917 uint32_t change_mask;
918 int i;
919
920 change_mask = atomic_swap_32(&sc->sc_change_mask, 0);
921 for (i = 0; i < sc->sc_numports; i++) {
922 if (ISSET(change_mask, (1U << i)))
923 ucom_status_change(device_private(
924 sc->sc_ports[i].sc_port_ucom));
925 }
926 }
927