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