xref: /netbsd-src/sys/dev/ic/z8530tty.c (revision 7c3f385475147b6e1c4753f2bee961630e2dfc40)
1 /*	$NetBSD: z8530tty.c,v 1.122 2008/03/29 19:15:36 tsutsui Exp $	*/
2 
3 /*-
4  * Copyright (c) 1993, 1994, 1995, 1996, 1997, 1998, 1999
5  *	Charles M. Hannum.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
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.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Charles M. Hannum.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1992, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * This software was developed by the Computer Systems Engineering group
38  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
39  * contributed to Berkeley.
40  *
41  * All advertising materials mentioning features or use of this software
42  * must display the following acknowledgement:
43  *	This product includes software developed by the University of
44  *	California, Lawrence Berkeley Laboratory.
45  *
46  * Redistribution and use in source and binary forms, with or without
47  * modification, are permitted provided that the following conditions
48  * are met:
49  * 1. Redistributions of source code must retain the above copyright
50  *    notice, this list of conditions and the following disclaimer.
51  * 2. Redistributions in binary form must reproduce the above copyright
52  *    notice, this list of conditions and the following disclaimer in the
53  *    documentation and/or other materials provided with the distribution.
54  * 3. Neither the name of the University nor the names of its contributors
55  *    may be used to endorse or promote products derived from this software
56  *    without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68  * SUCH DAMAGE.
69  *
70  *	@(#)zs.c	8.1 (Berkeley) 7/19/93
71  */
72 
73 /*
74  * Copyright (c) 1994 Gordon W. Ross
75  *
76  * This software was developed by the Computer Systems Engineering group
77  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
78  * contributed to Berkeley.
79  *
80  * All advertising materials mentioning features or use of this software
81  * must display the following acknowledgement:
82  *	This product includes software developed by the University of
83  *	California, Lawrence Berkeley Laboratory.
84  *
85  * Redistribution and use in source and binary forms, with or without
86  * modification, are permitted provided that the following conditions
87  * are met:
88  * 1. Redistributions of source code must retain the above copyright
89  *    notice, this list of conditions and the following disclaimer.
90  * 2. Redistributions in binary form must reproduce the above copyright
91  *    notice, this list of conditions and the following disclaimer in the
92  *    documentation and/or other materials provided with the distribution.
93  * 3. All advertising materials mentioning features or use of this software
94  *    must display the following acknowledgement:
95  *	This product includes software developed by the University of
96  *	California, Berkeley and its contributors.
97  * 4. Neither the name of the University nor the names of its contributors
98  *    may be used to endorse or promote products derived from this software
99  *    without specific prior written permission.
100  *
101  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
102  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
103  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
104  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
105  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
106  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
107  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
108  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
109  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
110  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
111  * SUCH DAMAGE.
112  *
113  *	@(#)zs.c	8.1 (Berkeley) 7/19/93
114  */
115 
116 /*
117  * Zilog Z8530 Dual UART driver (tty interface)
118  *
119  * This is the "slave" driver that will be attached to
120  * the "zsc" driver for plain "tty" async. serial lines.
121  *
122  * Credits, history:
123  *
124  * The original version of this code was the sparc/dev/zs.c driver
125  * as distributed with the Berkeley 4.4 Lite release.  Since then,
126  * Gordon Ross reorganized the code into the current parent/child
127  * driver scheme, separating the Sun keyboard and mouse support
128  * into independent child drivers.
129  *
130  * RTS/CTS flow-control support was a collaboration of:
131  *	Gordon Ross <gwr@NetBSD.org>,
132  *	Bill Studenmund <wrstuden@loki.stanford.edu>
133  *	Ian Dall <Ian.Dall@dsto.defence.gov.au>
134  *
135  * The driver was massively overhauled in November 1997 by Charles Hannum,
136  * fixing *many* bugs, and substantially improving performance.
137  */
138 
139 #include <sys/cdefs.h>
140 __KERNEL_RCSID(0, "$NetBSD: z8530tty.c,v 1.122 2008/03/29 19:15:36 tsutsui Exp $");
141 
142 #include "opt_kgdb.h"
143 #include "opt_ntp.h"
144 
145 #include <sys/param.h>
146 #include <sys/systm.h>
147 #include <sys/proc.h>
148 #include <sys/device.h>
149 #include <sys/conf.h>
150 #include <sys/file.h>
151 #include <sys/ioctl.h>
152 #include <sys/malloc.h>
153 #include <sys/timepps.h>
154 #include <sys/tty.h>
155 #include <sys/time.h>
156 #include <sys/kernel.h>
157 #include <sys/syslog.h>
158 #include <sys/kauth.h>
159 
160 #include <dev/ic/z8530reg.h>
161 #include <machine/z8530var.h>
162 
163 #include <dev/cons.h>
164 
165 #include "ioconf.h"
166 #include "locators.h"
167 
168 /*
169  * How many input characters we can buffer.
170  * The port-specific var.h may override this.
171  * Note: must be a power of two!
172  */
173 #ifndef	ZSTTY_RING_SIZE
174 #define	ZSTTY_RING_SIZE	2048
175 #endif
176 
177 static struct cnm_state zstty_cnm_state;
178 /*
179  * Make this an option variable one can patch.
180  * But be warned:  this must be a power of 2!
181  */
182 u_int zstty_rbuf_size = ZSTTY_RING_SIZE;
183 
184 /* Stop input when 3/4 of the ring is full; restart when only 1/4 is full. */
185 u_int zstty_rbuf_hiwat = (ZSTTY_RING_SIZE * 1) / 4;
186 u_int zstty_rbuf_lowat = (ZSTTY_RING_SIZE * 3) / 4;
187 
188 struct zstty_softc {
189 	device_t zst_dev;		/* required first: base device */
190 	struct  tty *zst_tty;
191 	struct	zs_chanstate *zst_cs;
192 
193 	struct callout zst_diag_ch;
194 
195 	u_int zst_overflows,
196 	      zst_floods,
197 	      zst_errors;
198 
199 	int zst_hwflags,	/* see z8530var.h */
200 	    zst_swflags;	/* TIOCFLAG_SOFTCAR, ... <ttycom.h> */
201 
202 	u_int zst_r_hiwat,
203 	      zst_r_lowat;
204 	uint8_t *volatile zst_rbget,
205 	        *volatile zst_rbput;
206 	volatile u_int zst_rbavail;
207 	uint8_t *zst_rbuf,
208 	        *zst_ebuf;
209 
210 	/*
211 	 * The transmit byte count and address are used for pseudo-DMA
212 	 * output in the hardware interrupt code.  PDMA can be suspended
213 	 * to get pending changes done; heldtbc is used for this.  It can
214 	 * also be stopped for ^S; this sets TS_TTSTOP in tp->t_state.
215 	 */
216 	uint8_t *zst_tba;		/* transmit buffer address */
217 	u_int zst_tbc,			/* transmit byte count */
218 	      zst_heldtbc;		/* held tbc while xmission stopped */
219 
220 	/* Flags to communicate with zstty_softint() */
221 	volatile uint8_t zst_rx_flags,	/* receiver blocked */
222 #define	RX_TTY_BLOCKED		0x01
223 #define	RX_TTY_OVERFLOWED	0x02
224 #define	RX_IBUF_BLOCKED		0x04
225 #define	RX_IBUF_OVERFLOWED	0x08
226 #define	RX_ANY_BLOCK		0x0f
227 			zst_tx_busy,	/* working on an output chunk */
228 			zst_tx_done,	/* done with one output chunk */
229 			zst_tx_stopped,	/* H/W level stop (lost CTS) */
230 			zst_st_check,	/* got a status interrupt */
231 			zst_rx_ready;
232 
233 	/* PPS signal on DCD, with or without inkernel clock disciplining */
234 	uint8_t  zst_ppsmask;			/* pps signal mask */
235 	struct pps_state zst_pps_state;
236 };
237 
238 /* Definition of the driver for autoconfig. */
239 static int	zstty_match(device_t, cfdata_t, void *);
240 static void	zstty_attach(device_t, device_t, void *);
241 
242 CFATTACH_DECL_NEW(zstty, sizeof(struct zstty_softc),
243     zstty_match, zstty_attach, NULL, NULL);
244 
245 dev_type_open(zsopen);
246 dev_type_close(zsclose);
247 dev_type_read(zsread);
248 dev_type_write(zswrite);
249 dev_type_ioctl(zsioctl);
250 dev_type_stop(zsstop);
251 dev_type_tty(zstty);
252 dev_type_poll(zspoll);
253 
254 const struct cdevsw zstty_cdevsw = {
255 	zsopen, zsclose, zsread, zswrite, zsioctl,
256 	zsstop, zstty, zspoll, nommap, ttykqfilter, D_TTY
257 };
258 
259 struct zsops zsops_tty;
260 
261 static void zs_shutdown(struct zstty_softc *);
262 static void	zsstart(struct tty *);
263 static int	zsparam(struct tty *, struct termios *);
264 static void zs_modem(struct zstty_softc *, int);
265 static void tiocm_to_zs(struct zstty_softc *, u_long, int);
266 static int  zs_to_tiocm(struct zstty_softc *);
267 static int    zshwiflow(struct tty *, int);
268 static void  zs_hwiflow(struct zstty_softc *);
269 static void zs_maskintr(struct zstty_softc *);
270 
271 /* Low-level routines. */
272 static void zstty_rxint  (struct zs_chanstate *);
273 static void zstty_stint  (struct zs_chanstate *, int);
274 static void zstty_txint  (struct zs_chanstate *);
275 static void zstty_softint(struct zs_chanstate *);
276 static void zstty_softint1(struct zs_chanstate *);
277 
278 #define	ZSUNIT(x)	(minor(x) & 0x7ffff)
279 #define	ZSDIALOUT(x)	(minor(x) & 0x80000)
280 
281 struct tty *zstty_get_tty_from_dev(struct device *);
282 
283 /*
284  * XXX get the (struct tty *) out of a (struct device *) we trust to be a
285  * (struct zstty_softc *) - needed by sparc/dev/zs.c, sparc64/dev/zs.c,
286  * sun3/dev/zs.c and sun2/dev/zs.c will probably need it at some point
287  */
288 
289 struct tty *
290 zstty_get_tty_from_dev(struct device *dev)
291 {
292 	struct zstty_softc *sc = device_private(dev);
293 
294 	return sc->zst_tty;
295 }
296 
297 /*
298  * zstty_match: how is this zs channel configured?
299  */
300 int
301 zstty_match(device_t parent, cfdata_t cf, void *aux)
302 {
303 	struct zsc_attach_args *args = aux;
304 
305 	/* Exact match is better than wildcard. */
306 	if (cf->zsccf_channel == args->channel)
307 		return 2;
308 
309 	/* This driver accepts wildcard. */
310 	if (cf->zsccf_channel == ZSCCF_CHANNEL_DEFAULT)
311 		return 1;
312 
313 	return 0;
314 }
315 
316 void
317 zstty_attach(device_t parent, device_t self, void *aux)
318 {
319 	struct zstty_softc *zst = device_private(self);
320 	struct zsc_softc *zsc = device_private(parent);
321 	struct cfdata *cf = device_cfdata(self);
322 	struct zsc_attach_args *args = aux;
323 	struct zs_chanstate *cs;
324 	struct tty *tp;
325 	int channel, tty_unit;
326 	dev_t dev;
327 	const char *i, *o;
328 	int dtr_on;
329 	int resetbit;
330 
331 	zst->zst_dev = self;
332 
333 	callout_init(&zst->zst_diag_ch, 0);
334 	cn_init_magic(&zstty_cnm_state);
335 
336 	tty_unit = device_unit(self);
337 	channel = args->channel;
338 	cs = zsc->zsc_cs[channel];
339 	cs->cs_private = zst;
340 	cs->cs_ops = &zsops_tty;
341 
342 	zst->zst_cs = cs;
343 	zst->zst_swflags = cf->cf_flags;	/* softcar, etc. */
344 	zst->zst_hwflags = args->hwflags;
345 	dev = makedev(cdevsw_lookup_major(&zstty_cdevsw), tty_unit);
346 
347 	if (zst->zst_swflags)
348 		aprint_normal(" flags 0x%x", zst->zst_swflags);
349 
350 	/*
351 	 * Check whether we serve as a console device.
352 	 * XXX - split console input/output channels aren't
353 	 *	 supported yet on /dev/console
354 	 */
355 	i = o = NULL;
356 	if ((zst->zst_hwflags & ZS_HWFLAG_CONSOLE_INPUT) != 0) {
357 		i = "input";
358 		if ((args->hwflags & ZS_HWFLAG_USE_CONSDEV) != 0) {
359 			args->consdev->cn_dev = dev;
360 			cn_tab->cn_pollc = args->consdev->cn_pollc;
361 			cn_tab->cn_getc = args->consdev->cn_getc;
362 		}
363 		cn_tab->cn_dev = dev;
364 		/* Set console magic to BREAK */
365 		cn_set_magic("\047\001");
366 	}
367 	if ((zst->zst_hwflags & ZS_HWFLAG_CONSOLE_OUTPUT) != 0) {
368 		o = "output";
369 		if ((args->hwflags & ZS_HWFLAG_USE_CONSDEV) != 0) {
370 			cn_tab->cn_putc = args->consdev->cn_putc;
371 		}
372 		cn_tab->cn_dev = dev;
373 	}
374 	if (i != NULL || o != NULL)
375 		aprint_normal(" (console %s)", i ? (o ? "i/o" : i) : o);
376 
377 #ifdef KGDB
378 	if (zs_check_kgdb(cs, dev)) {
379 		/*
380 		 * Allow kgdb to "take over" this port.  Returns true
381 		 * if this serial port is in-use by kgdb.
382 		 */
383 		aprint_normal(" (kgdb)\n");
384 		/*
385 		 * This is the kgdb port (exclusive use)
386 		 * so skip the normal attach code.
387 		 */
388 		return;
389 	}
390 #endif
391 	aprint_normal("\n");
392 
393 	tp = ttymalloc();
394 	tp->t_dev = dev;
395 	tp->t_oproc = zsstart;
396 	tp->t_param = zsparam;
397 	tp->t_hwiflow = zshwiflow;
398 	tty_attach(tp);
399 
400 	zst->zst_tty = tp;
401 	zst->zst_rbuf = malloc(zstty_rbuf_size << 1, M_DEVBUF, M_NOWAIT);
402 	if (zst->zst_rbuf == NULL) {
403 		aprint_error_dev(zst->zst_dev,
404 		    "unable to allocate ring buffer\n");
405 		return;
406 	}
407 	zst->zst_ebuf = zst->zst_rbuf + (zstty_rbuf_size << 1);
408 	/* Disable the high water mark. */
409 	zst->zst_r_hiwat = 0;
410 	zst->zst_r_lowat = 0;
411 	zst->zst_rbget = zst->zst_rbput = zst->zst_rbuf;
412 	zst->zst_rbavail = zstty_rbuf_size;
413 
414 	/* if there are no enable/disable functions, assume the device
415 	   is always enabled */
416 	if (!cs->enable)
417 		cs->enabled = 1;
418 
419 	/*
420 	 * Hardware init
421 	 */
422 	dtr_on = 0;
423 	resetbit = 0;
424 	if (ISSET(zst->zst_hwflags, ZS_HWFLAG_CONSOLE)) {
425 		/* Call zsparam similar to open. */
426 		struct termios t;
427 
428 		/* Wait a while for previous console output to complete */
429 		DELAY(10000);
430 
431 		/* Setup the "new" parameters in t. */
432 		t.c_ispeed = 0;
433 		t.c_ospeed = cs->cs_defspeed;
434 		t.c_cflag = cs->cs_defcflag;
435 
436 		/*
437 		 * Turn on receiver and status interrupts.
438 		 * We defer the actual write of the register to zsparam(),
439 		 * but we must make sure status interrupts are turned on by
440 		 * the time zsparam() reads the initial rr0 state.
441 		 */
442 		SET(cs->cs_preg[1], ZSWR1_RIE | ZSWR1_SIE);
443 
444 		/* Make sure zsparam will see changes. */
445 		tp->t_ospeed = 0;
446 		(void) zsparam(tp, &t);
447 
448 		/* Make sure DTR is on now. */
449 		dtr_on = 1;
450 
451 	} else if (!ISSET(zst->zst_hwflags, ZS_HWFLAG_NORESET)) {
452 		/* Not the console; may need reset. */
453 		resetbit = (channel == 0) ? ZSWR9_A_RESET : ZSWR9_B_RESET;
454 	}
455 
456 	mutex_spin_enter(&cs->cs_lock);
457 	if (resetbit)
458 		zs_write_reg(cs, 9, resetbit);
459 	zs_modem(zst, dtr_on);
460 	mutex_spin_exit(&cs->cs_lock);
461 }
462 
463 
464 /*
465  * Return pointer to our tty.
466  */
467 struct tty *
468 zstty(dev_t dev)
469 {
470 	struct zstty_softc *zst;
471 
472 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
473 
474 	return (zst->zst_tty);
475 }
476 
477 
478 void
479 zs_shutdown(struct zstty_softc *zst)
480 {
481 	struct zs_chanstate *cs = zst->zst_cs;
482 	struct tty *tp = zst->zst_tty;
483 
484 	mutex_spin_enter(&cs->cs_lock);
485 
486 	/* If we were asserting flow control, then deassert it. */
487 	SET(zst->zst_rx_flags, RX_IBUF_BLOCKED);
488 	zs_hwiflow(zst);
489 
490 	/* Clear any break condition set with TIOCSBRK. */
491 	zs_break(cs, 0);
492 
493 	/*
494 	 * Hang up if necessary.  Wait a bit, so the other side has time to
495 	 * notice even if we immediately open the port again.
496 	 */
497 	if (ISSET(tp->t_cflag, HUPCL)) {
498 		zs_modem(zst, 0);
499 		mutex_spin_exit(&cs->cs_lock);
500 		/*
501 		 * XXX -    another process is not prevented from opening
502 		 *	    the device during our sleep.
503 		 */
504 		(void) tsleep(cs, TTIPRI, ttclos, hz);
505 		/* Re-check state in case we were opened during our sleep */
506 		if (ISSET(tp->t_state, TS_ISOPEN) || tp->t_wopen != 0)
507 			return;
508 
509 		mutex_spin_enter(&cs->cs_lock);
510 	}
511 
512 	/* Turn off interrupts if not the console. */
513 	if (!ISSET(zst->zst_hwflags, ZS_HWFLAG_CONSOLE)) {
514 		CLR(cs->cs_preg[1], ZSWR1_RIE | ZSWR1_SIE);
515 		cs->cs_creg[1] = cs->cs_preg[1];
516 		zs_write_reg(cs, 1, cs->cs_creg[1]);
517 	}
518 
519 	/* Call the power management hook. */
520 	if (cs->disable) {
521 #ifdef DIAGNOSTIC
522 		if (!cs->enabled)
523 			panic("%s: not enabled?", __func__);
524 #endif
525 		(*cs->disable)(zst->zst_cs);
526 	}
527 
528 	mutex_spin_exit(&cs->cs_lock);
529 }
530 
531 /*
532  * Open a zs serial (tty) port.
533  */
534 int
535 zsopen(dev_t dev, int flags, int mode, struct lwp *l)
536 {
537 	struct zstty_softc *zst;
538 	struct zs_chanstate *cs;
539 	struct tty *tp;
540 	int error;
541 
542 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
543 	if (zst == NULL)
544 		return (ENXIO);
545 
546 	tp = zst->zst_tty;
547 	cs = zst->zst_cs;
548 
549 	/* If KGDB took the line, then tp==NULL */
550 	if (tp == NULL)
551 		return (EBUSY);
552 
553 	if (kauth_authorize_device_tty(l->l_cred, KAUTH_DEVICE_TTY_OPEN, tp))
554 		return (EBUSY);
555 
556 	mutex_spin_enter(&tty_lock);
557 
558 	/*
559 	 * Do the following iff this is a first open.
560 	 */
561 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
562 		struct termios t;
563 
564 		tp->t_dev = dev;
565 
566 		/* Call the power management hook. */
567 		if (cs->enable) {
568 			if ((*cs->enable)(cs)) {
569 				mutex_spin_exit(&tty_lock);
570 				printf("%s: device enable failed\n",
571 				    device_xname(zst->zst_dev));
572 				return (EIO);
573 			}
574 		}
575 
576 		/*
577 		 * Initialize the termios status to the defaults.  Add in the
578 		 * sticky bits from TIOCSFLAGS.
579 		 */
580 		t.c_ispeed = 0;
581 		t.c_ospeed = cs->cs_defspeed;
582 		t.c_cflag = cs->cs_defcflag;
583 		if (ISSET(zst->zst_swflags, TIOCFLAG_CLOCAL))
584 			SET(t.c_cflag, CLOCAL);
585 		if (ISSET(zst->zst_swflags, TIOCFLAG_CRTSCTS))
586 			SET(t.c_cflag, CRTSCTS);
587 		if (ISSET(zst->zst_swflags, TIOCFLAG_CDTRCTS))
588 			SET(t.c_cflag, CDTRCTS);
589 		if (ISSET(zst->zst_swflags, TIOCFLAG_MDMBUF))
590 			SET(t.c_cflag, MDMBUF);
591 
592 		mutex_spin_enter(&cs->cs_lock);
593 
594 		/*
595 		 * Turn on receiver and status interrupts.
596 		 * We defer the actual write of the register to zsparam(),
597 		 * but we must make sure status interrupts are turned on by
598 		 * the time zsparam() reads the initial rr0 state.
599 		 */
600 		SET(cs->cs_preg[1], ZSWR1_RIE | ZSWR1_SIE);
601 
602 		/* Clear PPS capture state on first open. */
603 		zst->zst_ppsmask = 0;
604 		memset(&zst->zst_pps_state, 0, sizeof(zst->zst_pps_state));
605 		zst->zst_pps_state.ppscap =
606 		    PPS_CAPTUREASSERT | PPS_CAPTURECLEAR;
607 		pps_init(&zst->zst_pps_state);
608 
609 		mutex_spin_exit(&cs->cs_lock);
610 
611 		/* Make sure zsparam will see changes. */
612 		tp->t_ospeed = 0;
613 		(void) zsparam(tp, &t);
614 
615 		/*
616 		 * Note: zsparam has done: cflag, ispeed, ospeed
617 		 * so we just need to do: iflag, oflag, lflag, cc
618 		 * For "raw" mode, just leave all zeros.
619 		 */
620 		if (!ISSET(zst->zst_hwflags, ZS_HWFLAG_RAW)) {
621 			tp->t_iflag = TTYDEF_IFLAG;
622 			tp->t_oflag = TTYDEF_OFLAG;
623 			tp->t_lflag = TTYDEF_LFLAG;
624 		} else {
625 			tp->t_iflag = 0;
626 			tp->t_oflag = 0;
627 			tp->t_lflag = 0;
628 		}
629 		ttychars(tp);
630 		ttsetwater(tp);
631 
632 		mutex_spin_enter(&cs->cs_lock);
633 
634 		/*
635 		 * Turn on DTR.  We must always do this, even if carrier is not
636 		 * present, because otherwise we'd have to use TIOCSDTR
637 		 * immediately after setting CLOCAL, which applications do not
638 		 * expect.  We always assert DTR while the device is open
639 		 * unless explicitly requested to deassert it.
640 		 */
641 		zs_modem(zst, 1);
642 
643 		/* Clear the input ring, and unblock. */
644 		zst->zst_rbget = zst->zst_rbput = zst->zst_rbuf;
645 		zst->zst_rbavail = zstty_rbuf_size;
646 		zs_iflush(cs);
647 		CLR(zst->zst_rx_flags, RX_ANY_BLOCK);
648 		zs_hwiflow(zst);
649 
650 		mutex_spin_exit(&cs->cs_lock);
651 	}
652 
653 	mutex_spin_exit(&tty_lock);
654 
655 	error = ttyopen(tp, ZSDIALOUT(dev), ISSET(flags, O_NONBLOCK));
656 	if (error)
657 		goto bad;
658 
659 	error = (*tp->t_linesw->l_open)(dev, tp);
660 	if (error)
661 		goto bad;
662 
663 	return (0);
664 
665 bad:
666 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
667 		/*
668 		 * We failed to open the device, and nobody else had it opened.
669 		 * Clean up the state as appropriate.
670 		 */
671 		zs_shutdown(zst);
672 	}
673 
674 	return (error);
675 }
676 
677 /*
678  * Close a zs serial port.
679  */
680 int
681 zsclose(dev_t dev, int flags, int mode, struct lwp *l)
682 {
683 	struct zstty_softc *zst;
684 	struct tty *tp;
685 
686 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
687 	tp = zst->zst_tty;
688 
689 	/* XXX This is for cons.c. */
690 	if (!ISSET(tp->t_state, TS_ISOPEN))
691 		return 0;
692 
693 	(*tp->t_linesw->l_close)(tp, flags);
694 	ttyclose(tp);
695 
696 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
697 		/*
698 		 * Although we got a last close, the device may still be in
699 		 * use; e.g. if this was the dialout node, and there are still
700 		 * processes waiting for carrier on the non-dialout node.
701 		 */
702 		zs_shutdown(zst);
703 	}
704 
705 	return (0);
706 }
707 
708 /*
709  * Read/write zs serial port.
710  */
711 int
712 zsread(dev_t dev, struct uio *uio, int flags)
713 {
714 	struct zstty_softc *zst;
715 	struct tty *tp;
716 
717 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
718 	tp = zst->zst_tty;
719 
720 	return ((*tp->t_linesw->l_read)(tp, uio, flags));
721 }
722 
723 int
724 zswrite(dev_t dev, struct uio *uio, int flags)
725 {
726 	struct zstty_softc *zst;
727 	struct tty *tp;
728 
729 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
730 	tp = zst->zst_tty;
731 
732 	return ((*tp->t_linesw->l_write)(tp, uio, flags));
733 }
734 
735 int
736 zspoll(dev_t dev, int events, struct lwp *l)
737 {
738 	struct zstty_softc *zst;
739 	struct tty *tp;
740 
741 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
742 	tp = zst->zst_tty;
743 
744 	return ((*tp->t_linesw->l_poll)(tp, events, l));
745 }
746 
747 int
748 zsioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
749 {
750 	struct zstty_softc *zst;
751 	struct zs_chanstate *cs;
752 	struct tty *tp;
753 	int error;
754 
755 	zst = device_lookup_private(&zstty_cd, ZSUNIT(dev));
756 	cs = zst->zst_cs;
757 	tp = zst->zst_tty;
758 	error = (*tp->t_linesw->l_ioctl)(tp, cmd, data, flag, l);
759 	if (error != EPASSTHROUGH)
760 		return (error);
761 
762 	error = ttioctl(tp, cmd, data, flag, l);
763 	if (error != EPASSTHROUGH)
764 		return (error);
765 
766 #ifdef	ZS_MD_IOCTL
767 	error = ZS_MD_IOCTL(cs, cmd, data);
768 	if (error != EPASSTHROUGH)
769 		return (error);
770 #endif	/* ZS_MD_IOCTL */
771 
772 	error = 0;
773 
774 	mutex_spin_enter(&cs->cs_lock);
775 
776 	switch (cmd) {
777 	case TIOCSBRK:
778 		zs_break(cs, 1);
779 		break;
780 
781 	case TIOCCBRK:
782 		zs_break(cs, 0);
783 		break;
784 
785 	case TIOCGFLAGS:
786 		*(int *)data = zst->zst_swflags;
787 		break;
788 
789 	case TIOCSFLAGS:
790 		error = kauth_authorize_device_tty(l->l_cred,
791 			KAUTH_DEVICE_TTY_PRIVSET, tp);
792 		if (error)
793 			break;
794 		zst->zst_swflags = *(int *)data;
795 		break;
796 
797 	case TIOCSDTR:
798 		zs_modem(zst, 1);
799 		break;
800 
801 	case TIOCCDTR:
802 		zs_modem(zst, 0);
803 		break;
804 
805 	case TIOCMSET:
806 	case TIOCMBIS:
807 	case TIOCMBIC:
808 		tiocm_to_zs(zst, cmd, *(int *)data);
809 		break;
810 
811 	case TIOCMGET:
812 		*(int *)data = zs_to_tiocm(zst);
813 		break;
814 
815 	case PPS_IOC_CREATE:
816 	case PPS_IOC_DESTROY:
817 	case PPS_IOC_GETPARAMS:
818 	case PPS_IOC_SETPARAMS:
819 	case PPS_IOC_GETCAP:
820 	case PPS_IOC_FETCH:
821 #ifdef PPS_SYNC
822 	case PPS_IOC_KCBIND:
823 #endif
824 		error = pps_ioctl(cmd, data, &zst->zst_pps_state);
825 		if (zst->zst_pps_state.ppsparam.mode & PPS_CAPTUREBOTH)
826 			zst->zst_ppsmask = ZSRR0_DCD;
827 		else
828 			zst->zst_ppsmask = 0;
829 		break;
830 
831 	case TIOCDCDTIMESTAMP:	/* XXX old, overloaded  API used by xntpd v3 */
832 		if (cs->cs_rr0_pps == 0) {
833 			error = EINVAL;
834 			break;
835 		}
836 #ifndef PPS_TRAILING_EDGE
837 		TIMESPEC_TO_TIMEVAL((struct timeval *)data,
838 		    &zst->zst_pps_state.ppsinfo.assert_timestamp);
839 #else
840 		TIMESPEC_TO_TIMEVAL((struct timeval *)data,
841 		    &zst->zst_pps_state.ppsinfo.clear_timestamp);
842 #endif
843 		/*
844 		 * Now update interrupts.
845 		 */
846 		zs_maskintr(zst);
847 		/*
848 		 * If nothing is being transmitted, set up new current values,
849 		 * else mark them as pending.
850 		 */
851 		if (!cs->cs_heldchange) {
852 			if (zst->zst_tx_busy) {
853 				zst->zst_heldtbc = zst->zst_tbc;
854 				zst->zst_tbc = 0;
855 				cs->cs_heldchange = 1;
856 			} else
857 				zs_loadchannelregs(cs);
858 		}
859 
860 		break;
861 
862 	default:
863 		error = EPASSTHROUGH;
864 		break;
865 	}
866 
867 	mutex_spin_exit(&cs->cs_lock);
868 
869 	return (error);
870 }
871 
872 /*
873  * Start or restart transmission.
874  */
875 static void
876 zsstart(struct tty *tp)
877 {
878 	struct zstty_softc *zst;
879 	struct zs_chanstate *cs;
880 	u_char *tba;
881 	int tbc;
882 
883 	zst = device_lookup_private(&zstty_cd, ZSUNIT(tp->t_dev));
884 	cs = zst->zst_cs;
885 
886 	if (ISSET(tp->t_state, TS_BUSY | TS_TIMEOUT | TS_TTSTOP))
887 		return;
888 	if (zst->zst_tx_stopped)
889 		return;
890 	if (!ttypull(tp))
891 		return;
892 
893 	/* Grab the first contiguous region of buffer space. */
894 	tba = tp->t_outq.c_cf;
895 	tbc = ndqb(&tp->t_outq, 0);
896 
897 	mutex_spin_enter(&cs->cs_lock);
898 
899 	zst->zst_tba = tba;
900 	zst->zst_tbc = tbc;
901 	SET(tp->t_state, TS_BUSY);
902 	zst->zst_tx_busy = 1;
903 
904 #ifdef ZS_TXDMA
905 	if (zst->zst_tbc > 1) {
906 		zs_dma_setup(cs, zst->zst_tba, zst->zst_tbc);
907 		mutex_spin_exit(&cs->cs_lock);
908 		return;
909 	}
910 #endif
911 
912 	/* Enable transmit completion interrupts if necessary. */
913 	if (!ISSET(cs->cs_preg[1], ZSWR1_TIE)) {
914 		SET(cs->cs_preg[1], ZSWR1_TIE);
915 		cs->cs_creg[1] = cs->cs_preg[1];
916 		zs_write_reg(cs, 1, cs->cs_creg[1]);
917 	}
918 
919 	/* Output the first character of the contiguous buffer. */
920 	zs_write_data(cs, *zst->zst_tba);
921 	zst->zst_tbc--;
922 	zst->zst_tba++;
923 
924 	mutex_spin_exit(&cs->cs_lock);
925 }
926 
927 /*
928  * Stop output, e.g., for ^S or output flush.
929  */
930 void
931 zsstop(struct tty *tp, int flag)
932 {
933 	struct zstty_softc *zst;
934 	int s;
935 
936 	zst = device_lookup_private(&zstty_cd, ZSUNIT(tp->t_dev));
937 
938 	s = splzs();
939 	if (ISSET(tp->t_state, TS_BUSY)) {
940 		/* Stop transmitting at the next chunk. */
941 		zst->zst_tbc = 0;
942 		zst->zst_heldtbc = 0;
943 		if (!ISSET(tp->t_state, TS_TTSTOP))
944 			SET(tp->t_state, TS_FLUSH);
945 	}
946 	splx(s);
947 }
948 
949 /*
950  * Set ZS tty parameters from termios.
951  * XXX - Should just copy the whole termios after
952  * making sure all the changes could be done.
953  */
954 static int
955 zsparam(struct tty *tp, struct termios *t)
956 {
957 	struct zstty_softc *zst;
958 	struct zs_chanstate *cs;
959 	int ospeed;
960 	tcflag_t cflag;
961 	uint8_t tmp3, tmp4, tmp5;
962 	int error;
963 
964 	zst = device_lookup_private(&zstty_cd, ZSUNIT(tp->t_dev));
965 	cs = zst->zst_cs;
966 	ospeed = t->c_ospeed;
967 	cflag = t->c_cflag;
968 
969 	/* Check requested parameters. */
970 	if (ospeed < 0)
971 		return (EINVAL);
972 	if (t->c_ispeed && t->c_ispeed != ospeed)
973 		return (EINVAL);
974 
975 	/*
976 	 * For the console, always force CLOCAL and !HUPCL, so that the port
977 	 * is always active.
978 	 */
979 	if (ISSET(zst->zst_swflags, TIOCFLAG_SOFTCAR) ||
980 	    ISSET(zst->zst_hwflags, ZS_HWFLAG_CONSOLE)) {
981 		SET(cflag, CLOCAL);
982 		CLR(cflag, HUPCL);
983 	}
984 
985 	/*
986 	 * Only whack the UART when params change.
987 	 * Some callers need to clear tp->t_ospeed
988 	 * to make sure initialization gets done.
989 	 */
990 	if (tp->t_ospeed == ospeed &&
991 	    tp->t_cflag == cflag)
992 		return (0);
993 
994 	/*
995 	 * Call MD functions to deal with changed
996 	 * clock modes or H/W flow control modes.
997 	 * The BRG divisor is set now. (reg 12,13)
998 	 */
999 	error = zs_set_speed(cs, ospeed);
1000 	if (error)
1001 		return (error);
1002 	error = zs_set_modes(cs, cflag);
1003 	if (error)
1004 		return (error);
1005 
1006 	/*
1007 	 * Block interrupts so that state will not
1008 	 * be altered until we are done setting it up.
1009 	 *
1010 	 * Initial values in cs_preg are set before
1011 	 * our attach routine is called.  The master
1012 	 * interrupt enable is handled by zsc.c
1013 	 *
1014 	 */
1015 	mutex_spin_enter(&cs->cs_lock);
1016 
1017 	/*
1018 	 * Recalculate which status ints to enable.
1019 	 */
1020 	zs_maskintr(zst);
1021 
1022 	/* Recompute character size bits. */
1023 	tmp3 = cs->cs_preg[3];
1024 	tmp5 = cs->cs_preg[5];
1025 	CLR(tmp3, ZSWR3_RXSIZE);
1026 	CLR(tmp5, ZSWR5_TXSIZE);
1027 	switch (ISSET(cflag, CSIZE)) {
1028 	case CS5:
1029 		SET(tmp3, ZSWR3_RX_5);
1030 		SET(tmp5, ZSWR5_TX_5);
1031 		break;
1032 	case CS6:
1033 		SET(tmp3, ZSWR3_RX_6);
1034 		SET(tmp5, ZSWR5_TX_6);
1035 		break;
1036 	case CS7:
1037 		SET(tmp3, ZSWR3_RX_7);
1038 		SET(tmp5, ZSWR5_TX_7);
1039 		break;
1040 	case CS8:
1041 		SET(tmp3, ZSWR3_RX_8);
1042 		SET(tmp5, ZSWR5_TX_8);
1043 		break;
1044 	}
1045 	cs->cs_preg[3] = tmp3;
1046 	cs->cs_preg[5] = tmp5;
1047 
1048 	/*
1049 	 * Recompute the stop bits and parity bits.  Note that
1050 	 * zs_set_speed() may have set clock selection bits etc.
1051 	 * in wr4, so those must preserved.
1052 	 */
1053 	tmp4 = cs->cs_preg[4];
1054 	CLR(tmp4, ZSWR4_SBMASK | ZSWR4_PARMASK);
1055 	if (ISSET(cflag, CSTOPB))
1056 		SET(tmp4, ZSWR4_TWOSB);
1057 	else
1058 		SET(tmp4, ZSWR4_ONESB);
1059 	if (!ISSET(cflag, PARODD))
1060 		SET(tmp4, ZSWR4_EVENP);
1061 	if (ISSET(cflag, PARENB))
1062 		SET(tmp4, ZSWR4_PARENB);
1063 	cs->cs_preg[4] = tmp4;
1064 
1065 	/* And copy to tty. */
1066 	tp->t_ispeed = 0;
1067 	tp->t_ospeed = ospeed;
1068 	tp->t_cflag = cflag;
1069 
1070 	/*
1071 	 * If nothing is being transmitted, set up new current values,
1072 	 * else mark them as pending.
1073 	 */
1074 	if (!cs->cs_heldchange) {
1075 		if (zst->zst_tx_busy) {
1076 			zst->zst_heldtbc = zst->zst_tbc;
1077 			zst->zst_tbc = 0;
1078 			cs->cs_heldchange = 1;
1079 		} else
1080 			zs_loadchannelregs(cs);
1081 	}
1082 
1083 	/*
1084 	 * If hardware flow control is disabled, turn off the buffer water
1085 	 * marks and unblock any soft flow control state.  Otherwise, enable
1086 	 * the water marks.
1087 	 */
1088 	if (!ISSET(cflag, CHWFLOW)) {
1089 		zst->zst_r_hiwat = 0;
1090 		zst->zst_r_lowat = 0;
1091 		if (ISSET(zst->zst_rx_flags, RX_TTY_OVERFLOWED)) {
1092 			CLR(zst->zst_rx_flags, RX_TTY_OVERFLOWED);
1093 			zst->zst_rx_ready = 1;
1094 			cs->cs_softreq = 1;
1095 		}
1096 		if (ISSET(zst->zst_rx_flags, RX_TTY_BLOCKED|RX_IBUF_BLOCKED)) {
1097 			CLR(zst->zst_rx_flags, RX_TTY_BLOCKED|RX_IBUF_BLOCKED);
1098 			zs_hwiflow(zst);
1099 		}
1100 	} else {
1101 		zst->zst_r_hiwat = zstty_rbuf_hiwat;
1102 		zst->zst_r_lowat = zstty_rbuf_lowat;
1103 	}
1104 
1105 	/*
1106 	 * Force a recheck of the hardware carrier and flow control status,
1107 	 * since we may have changed which bits we're looking at.
1108 	 */
1109 	zstty_stint(cs, 1);
1110 
1111 	mutex_spin_exit(&cs->cs_lock);
1112 
1113 	/*
1114 	 * If hardware flow control is disabled, unblock any hard flow control
1115 	 * state.
1116 	 */
1117 	if (!ISSET(cflag, CHWFLOW)) {
1118 		if (zst->zst_tx_stopped) {
1119 			zst->zst_tx_stopped = 0;
1120 			zsstart(tp);
1121 		}
1122 	}
1123 
1124 	zstty_softint1(cs);
1125 
1126 	return (0);
1127 }
1128 
1129 /*
1130  * Compute interrupt enable bits and set in the pending bits. Called both
1131  * in zsparam() and when PPS (pulse per second timing) state changes.
1132  * Must be called at splzs().
1133  */
1134 static void
1135 zs_maskintr(struct zstty_softc *zst)
1136 {
1137 	struct zs_chanstate *cs = zst->zst_cs;
1138 	uint8_t tmp15;
1139 
1140 	cs->cs_rr0_mask = cs->cs_rr0_cts | cs->cs_rr0_dcd;
1141 	if (zst->zst_ppsmask != 0)
1142 		cs->cs_rr0_mask |= cs->cs_rr0_pps;
1143 	tmp15 = cs->cs_preg[15];
1144 	if (ISSET(cs->cs_rr0_mask, ZSRR0_DCD))
1145 		SET(tmp15, ZSWR15_DCD_IE);
1146 	else
1147 		CLR(tmp15, ZSWR15_DCD_IE);
1148 	if (ISSET(cs->cs_rr0_mask, ZSRR0_CTS))
1149 		SET(tmp15, ZSWR15_CTS_IE);
1150 	else
1151 		CLR(tmp15, ZSWR15_CTS_IE);
1152 	cs->cs_preg[15] = tmp15;
1153 }
1154 
1155 
1156 /*
1157  * Raise or lower modem control (DTR/RTS) signals.  If a character is
1158  * in transmission, the change is deferred.
1159  * Called at splzs() and with the channel lock held.
1160  */
1161 static void
1162 zs_modem(struct zstty_softc *zst, int onoff)
1163 {
1164 	struct zs_chanstate *cs = zst->zst_cs, *ccs;
1165 
1166 	if (cs->cs_wr5_dtr == 0)
1167 		return;
1168 
1169 	ccs = (cs->cs_ctl_chan != NULL ? cs->cs_ctl_chan : cs);
1170 
1171 	if (onoff)
1172 		SET(ccs->cs_preg[5], cs->cs_wr5_dtr);
1173 	else
1174 		CLR(ccs->cs_preg[5], cs->cs_wr5_dtr);
1175 
1176 	if (!cs->cs_heldchange) {
1177 		if (zst->zst_tx_busy) {
1178 			zst->zst_heldtbc = zst->zst_tbc;
1179 			zst->zst_tbc = 0;
1180 			cs->cs_heldchange = 1;
1181 		} else
1182 			zs_loadchannelregs(cs);
1183 	}
1184 }
1185 
1186 /*
1187  * Set modem bits.
1188  * Called at splzs() and with the channel lock held.
1189  */
1190 static void
1191 tiocm_to_zs(struct zstty_softc *zst, u_long how, int ttybits)
1192 {
1193 	struct zs_chanstate *cs = zst->zst_cs, *ccs;
1194 	uint8_t zsbits;
1195 
1196 	ccs = (cs->cs_ctl_chan != NULL ? cs->cs_ctl_chan : cs);
1197 
1198 	zsbits = 0;
1199 	if (ISSET(ttybits, TIOCM_DTR))
1200 		SET(zsbits, ZSWR5_DTR);
1201 	if (ISSET(ttybits, TIOCM_RTS))
1202 		SET(zsbits, ZSWR5_RTS);
1203 
1204 	switch (how) {
1205 	case TIOCMBIC:
1206 		CLR(ccs->cs_preg[5], zsbits);
1207 		break;
1208 
1209 	case TIOCMBIS:
1210 		SET(ccs->cs_preg[5], zsbits);
1211 		break;
1212 
1213 	case TIOCMSET:
1214 		CLR(ccs->cs_preg[5], ZSWR5_RTS | ZSWR5_DTR);
1215 		SET(ccs->cs_preg[5], zsbits);
1216 		break;
1217 	}
1218 
1219 	if (!cs->cs_heldchange) {
1220 		if (zst->zst_tx_busy) {
1221 			zst->zst_heldtbc = zst->zst_tbc;
1222 			zst->zst_tbc = 0;
1223 			cs->cs_heldchange = 1;
1224 		} else
1225 			zs_loadchannelregs(cs);
1226 	}
1227 }
1228 
1229 /*
1230  * Get modem bits.
1231  * Called at splzs() and with the channel lock held.
1232  */
1233 static int
1234 zs_to_tiocm(struct zstty_softc *zst)
1235 {
1236 	struct zs_chanstate *cs = zst->zst_cs, *ccs;
1237 	uint8_t zsbits;
1238 	int ttybits = 0;
1239 
1240 	ccs = (cs->cs_ctl_chan != NULL ? cs->cs_ctl_chan : cs);
1241 
1242 	zsbits = ccs->cs_preg[5];
1243 	if (ISSET(zsbits, ZSWR5_DTR))
1244 		SET(ttybits, TIOCM_DTR);
1245 	if (ISSET(zsbits, ZSWR5_RTS))
1246 		SET(ttybits, TIOCM_RTS);
1247 
1248 	zsbits = cs->cs_rr0;
1249 	if (ISSET(zsbits, ZSRR0_DCD))
1250 		SET(ttybits, TIOCM_CD);
1251 	if (ISSET(zsbits, ZSRR0_CTS))
1252 		SET(ttybits, TIOCM_CTS);
1253 
1254 	return (ttybits);
1255 }
1256 
1257 /*
1258  * Try to block or unblock input using hardware flow-control.
1259  * This is called by kern/tty.c if MDMBUF|CRTSCTS is set, and
1260  * if this function returns non-zero, the TS_TBLOCK flag will
1261  * be set or cleared according to the "block" arg passed.
1262  */
1263 int
1264 zshwiflow(struct tty *tp, int block)
1265 {
1266 	struct zstty_softc *zst;
1267 	struct zs_chanstate *cs;
1268 
1269 	zst = device_lookup_private(&zstty_cd, ZSUNIT(tp->t_dev));
1270 	cs = zst->zst_cs;
1271 
1272 	if (cs->cs_wr5_rts == 0)
1273 		return (0);
1274 
1275 	mutex_spin_enter(&cs->cs_lock);
1276 	if (block) {
1277 		if (!ISSET(zst->zst_rx_flags, RX_TTY_BLOCKED)) {
1278 			SET(zst->zst_rx_flags, RX_TTY_BLOCKED);
1279 			zs_hwiflow(zst);
1280 		}
1281 	} else {
1282 		if (ISSET(zst->zst_rx_flags, RX_TTY_OVERFLOWED)) {
1283 			CLR(zst->zst_rx_flags, RX_TTY_OVERFLOWED);
1284 			zst->zst_rx_ready = 1;
1285 			cs->cs_softreq = 1;
1286 		}
1287 		if (ISSET(zst->zst_rx_flags, RX_TTY_BLOCKED)) {
1288 			CLR(zst->zst_rx_flags, RX_TTY_BLOCKED);
1289 			zs_hwiflow(zst);
1290 		}
1291 	}
1292 	mutex_spin_exit(&cs->cs_lock);
1293 	return (1);
1294 }
1295 
1296 /*
1297  * Internal version of zshwiflow
1298  * Called at splzs() and with the channel lock held.
1299  */
1300 static void
1301 zs_hwiflow(struct zstty_softc *zst)
1302 {
1303 	struct zs_chanstate *cs = zst->zst_cs, *ccs;
1304 
1305 	if (cs->cs_wr5_rts == 0)
1306 		return;
1307 
1308 	ccs = (cs->cs_ctl_chan != NULL ? cs->cs_ctl_chan : cs);
1309 
1310 	if (ISSET(zst->zst_rx_flags, RX_ANY_BLOCK)) {
1311 		CLR(ccs->cs_preg[5], cs->cs_wr5_rts);
1312 		CLR(ccs->cs_creg[5], cs->cs_wr5_rts);
1313 	} else {
1314 		SET(ccs->cs_preg[5], cs->cs_wr5_rts);
1315 		SET(ccs->cs_creg[5], cs->cs_wr5_rts);
1316 	}
1317 	zs_write_reg(ccs, 5, ccs->cs_creg[5]);
1318 }
1319 
1320 
1321 /****************************************************************
1322  * Interface to the lower layer (zscc)
1323  ****************************************************************/
1324 
1325 #define	integrate	static inline
1326 integrate void zstty_rxsoft(struct zstty_softc *, struct tty *);
1327 integrate void zstty_txsoft(struct zstty_softc *, struct tty *);
1328 integrate void zstty_stsoft(struct zstty_softc *, struct tty *);
1329 static void zstty_diag(void *);
1330 
1331 /*
1332  * Receiver Ready interrupt.
1333  * Called at splzs() and with the channel lock held.
1334  */
1335 static void
1336 zstty_rxint(struct zs_chanstate *cs)
1337 {
1338 	struct zstty_softc *zst = cs->cs_private;
1339 	uint8_t *put, *end;
1340 	u_int cc;
1341 	uint8_t rr0, rr1, c;
1342 
1343 	end = zst->zst_ebuf;
1344 	put = zst->zst_rbput;
1345 	cc = zst->zst_rbavail;
1346 
1347 	while (cc > 0) {
1348 		/*
1349 		 * First read the status, because reading the received char
1350 		 * destroys the status of this char.
1351 		 */
1352 		rr1 = zs_read_reg(cs, 1);
1353 		c = zs_read_data(cs);
1354 
1355 		if (ISSET(rr1, ZSRR1_FE | ZSRR1_DO | ZSRR1_PE)) {
1356 			/* Clear the receive error. */
1357 			zs_write_csr(cs, ZSWR0_RESET_ERRORS);
1358 		}
1359 
1360 		cn_check_magic(zst->zst_tty->t_dev, c, zstty_cnm_state);
1361 		put[0] = c;
1362 		put[1] = rr1;
1363 		put += 2;
1364 		if (put >= end)
1365 			put = zst->zst_rbuf;
1366 		cc--;
1367 
1368 		rr0 = zs_read_csr(cs);
1369 		if (!ISSET(rr0, ZSRR0_RX_READY))
1370 			break;
1371 	}
1372 
1373 	/*
1374 	 * Current string of incoming characters ended because
1375 	 * no more data was available or we ran out of space.
1376 	 * Schedule a receive event if any data was received.
1377 	 * If we're out of space, turn off receive interrupts.
1378 	 */
1379 	zst->zst_rbput = put;
1380 	zst->zst_rbavail = cc;
1381 	if (!ISSET(zst->zst_rx_flags, RX_TTY_OVERFLOWED)) {
1382 		zst->zst_rx_ready = 1;
1383 		cs->cs_softreq = 1;
1384 	}
1385 
1386 	/*
1387 	 * See if we are in danger of overflowing a buffer. If
1388 	 * so, use hardware flow control to ease the pressure.
1389 	 */
1390 	if (!ISSET(zst->zst_rx_flags, RX_IBUF_BLOCKED) &&
1391 	    cc < zst->zst_r_hiwat) {
1392 		SET(zst->zst_rx_flags, RX_IBUF_BLOCKED);
1393 		zs_hwiflow(zst);
1394 	}
1395 
1396 	/*
1397 	 * If we're out of space, disable receive interrupts
1398 	 * until the queue has drained a bit.
1399 	 */
1400 	if (!cc) {
1401 		SET(zst->zst_rx_flags, RX_IBUF_OVERFLOWED);
1402 		CLR(cs->cs_preg[1], ZSWR1_RIE);
1403 		cs->cs_creg[1] = cs->cs_preg[1];
1404 		zs_write_reg(cs, 1, cs->cs_creg[1]);
1405 	}
1406 
1407 #if 0
1408 	printf("%xH%04d\n", zst->zst_rx_flags, zst->zst_rbavail);
1409 #endif
1410 }
1411 
1412 /*
1413  * Transmitter Ready interrupt.
1414  * Called at splzs() and with the channel lock held.
1415  */
1416 static void
1417 zstty_txint(struct zs_chanstate *cs)
1418 {
1419 	struct zstty_softc *zst = cs->cs_private;
1420 
1421 	/*
1422 	 * If we've delayed a parameter change, do it now, and restart
1423 	 * output.
1424 	 */
1425 	if (cs->cs_heldchange) {
1426 		zs_loadchannelregs(cs);
1427 		cs->cs_heldchange = 0;
1428 		zst->zst_tbc = zst->zst_heldtbc;
1429 		zst->zst_heldtbc = 0;
1430 	}
1431 
1432 	/* Output the next character in the buffer, if any. */
1433 	if (zst->zst_tbc > 0) {
1434 		zs_write_data(cs, *zst->zst_tba);
1435 		zst->zst_tbc--;
1436 		zst->zst_tba++;
1437 	} else {
1438 		/* Disable transmit completion interrupts if necessary. */
1439 		if (ISSET(cs->cs_preg[1], ZSWR1_TIE)) {
1440 			CLR(cs->cs_preg[1], ZSWR1_TIE);
1441 			cs->cs_creg[1] = cs->cs_preg[1];
1442 			zs_write_reg(cs, 1, cs->cs_creg[1]);
1443 		}
1444 		if (zst->zst_tx_busy) {
1445 			zst->zst_tx_busy = 0;
1446 			zst->zst_tx_done = 1;
1447 			cs->cs_softreq = 1;
1448 		}
1449 	}
1450 }
1451 
1452 /*
1453  * Status Change interrupt.
1454  * Called at splzs() and with the channel lock held.
1455  */
1456 static void
1457 zstty_stint(struct zs_chanstate *cs, int force)
1458 {
1459 	struct zstty_softc *zst = cs->cs_private;
1460 	uint8_t rr0, delta;
1461 
1462 	rr0 = zs_read_csr(cs);
1463 	zs_write_csr(cs, ZSWR0_RESET_STATUS);
1464 
1465 	/*
1466 	 * Check here for console break, so that we can abort
1467 	 * even when interrupts are locking up the machine.
1468 	 */
1469 	if (ISSET(rr0, ZSRR0_BREAK))
1470 		cn_check_magic(zst->zst_tty->t_dev, CNC_BREAK, zstty_cnm_state);
1471 
1472 	if (!force)
1473 		delta = rr0 ^ cs->cs_rr0;
1474 	else
1475 		delta = cs->cs_rr0_mask;
1476 	cs->cs_rr0 = rr0;
1477 
1478 	if (ISSET(delta, cs->cs_rr0_mask)) {
1479 		SET(cs->cs_rr0_delta, delta);
1480 
1481 		/*
1482 		 * Pulse-per-second clock signal on edge of DCD?
1483 		 */
1484 		if (ISSET(delta, zst->zst_ppsmask)) {
1485 			if (zst->zst_pps_state.ppsparam.mode &
1486 			    PPS_CAPTUREBOTH) {
1487 				pps_capture(&zst->zst_pps_state);
1488 				pps_event(&zst->zst_pps_state,
1489 				    (ISSET(cs->cs_rr0, zst->zst_ppsmask))
1490 				    ? PPS_CAPTUREASSERT
1491 				    : PPS_CAPTURECLEAR);
1492 			}
1493 		}
1494 
1495 		/*
1496 		 * Stop output immediately if we lose the output
1497 		 * flow control signal or carrier detect.
1498 		 */
1499 		if (ISSET(~rr0, cs->cs_rr0_mask)) {
1500 			zst->zst_tbc = 0;
1501 			zst->zst_heldtbc = 0;
1502 		}
1503 
1504 		zst->zst_st_check = 1;
1505 		cs->cs_softreq = 1;
1506 	}
1507 }
1508 
1509 void
1510 zstty_diag(void *arg)
1511 {
1512 	struct zstty_softc *zst = arg;
1513 	int overflows, floods;
1514 	int s;
1515 
1516 	s = splzs();
1517 	overflows = zst->zst_overflows;
1518 	zst->zst_overflows = 0;
1519 	floods = zst->zst_floods;
1520 	zst->zst_floods = 0;
1521 	zst->zst_errors = 0;
1522 	splx(s);
1523 
1524 	log(LOG_WARNING, "%s: %d silo overflow%s, %d ibuf flood%s\n",
1525 	    device_xname(zst->zst_dev),
1526 	    overflows, overflows == 1 ? "" : "s",
1527 	    floods, floods == 1 ? "" : "s");
1528 }
1529 
1530 integrate void
1531 zstty_rxsoft(struct zstty_softc *zst, struct tty *tp)
1532 {
1533 	struct zs_chanstate *cs = zst->zst_cs;
1534 	int (*rint)(int, struct tty *) = tp->t_linesw->l_rint;
1535 	uint8_t *get, *end;
1536 	u_int cc, scc;
1537 	uint8_t rr1;
1538 	int code;
1539 
1540 	end = zst->zst_ebuf;
1541 	get = zst->zst_rbget;
1542 	scc = cc = zstty_rbuf_size - zst->zst_rbavail;
1543 
1544 	if (cc == zstty_rbuf_size) {
1545 		zst->zst_floods++;
1546 		if (zst->zst_errors++ == 0)
1547 			callout_reset(&zst->zst_diag_ch, 60 * hz,
1548 			    zstty_diag, zst);
1549 	}
1550 
1551 	/* If not yet open, drop the entire buffer content here */
1552 	if (!ISSET(tp->t_state, TS_ISOPEN)) {
1553 		get += cc << 1;
1554 		if (get >= end)
1555 			get -= zstty_rbuf_size << 1;
1556 		cc = 0;
1557 	}
1558 	while (cc) {
1559 		code = get[0];
1560 		rr1 = get[1];
1561 		if (ISSET(rr1, ZSRR1_DO | ZSRR1_FE | ZSRR1_PE)) {
1562 			if (ISSET(rr1, ZSRR1_DO)) {
1563 				zst->zst_overflows++;
1564 				if (zst->zst_errors++ == 0)
1565 					callout_reset(&zst->zst_diag_ch,
1566 					    60 * hz, zstty_diag, zst);
1567 			}
1568 			if (ISSET(rr1, ZSRR1_FE))
1569 				SET(code, TTY_FE);
1570 			if (ISSET(rr1, ZSRR1_PE))
1571 				SET(code, TTY_PE);
1572 		}
1573 		if ((*rint)(code, tp) == -1) {
1574 			/*
1575 			 * The line discipline's buffer is out of space.
1576 			 */
1577 			if (!ISSET(zst->zst_rx_flags, RX_TTY_BLOCKED)) {
1578 				/*
1579 				 * We're either not using flow control, or the
1580 				 * line discipline didn't tell us to block for
1581 				 * some reason.  Either way, we have no way to
1582 				 * know when there's more space available, so
1583 				 * just drop the rest of the data.
1584 				 */
1585 				get += cc << 1;
1586 				if (get >= end)
1587 					get -= zstty_rbuf_size << 1;
1588 				cc = 0;
1589 			} else {
1590 				/*
1591 				 * Don't schedule any more receive processing
1592 				 * until the line discipline tells us there's
1593 				 * space available (through comhwiflow()).
1594 				 * Leave the rest of the data in the input
1595 				 * buffer.
1596 				 */
1597 				SET(zst->zst_rx_flags, RX_TTY_OVERFLOWED);
1598 			}
1599 			break;
1600 		}
1601 		get += 2;
1602 		if (get >= end)
1603 			get = zst->zst_rbuf;
1604 		cc--;
1605 	}
1606 
1607 	if (cc != scc) {
1608 		zst->zst_rbget = get;
1609 		mutex_spin_enter(&cs->cs_lock);
1610 		cc = zst->zst_rbavail += scc - cc;
1611 		/* Buffers should be ok again, release possible block. */
1612 		if (cc >= zst->zst_r_lowat) {
1613 			if (ISSET(zst->zst_rx_flags, RX_IBUF_OVERFLOWED)) {
1614 				CLR(zst->zst_rx_flags, RX_IBUF_OVERFLOWED);
1615 				SET(cs->cs_preg[1], ZSWR1_RIE);
1616 				cs->cs_creg[1] = cs->cs_preg[1];
1617 				zs_write_reg(cs, 1, cs->cs_creg[1]);
1618 			}
1619 			if (ISSET(zst->zst_rx_flags, RX_IBUF_BLOCKED)) {
1620 				CLR(zst->zst_rx_flags, RX_IBUF_BLOCKED);
1621 				zs_hwiflow(zst);
1622 			}
1623 		}
1624 		mutex_spin_exit(&cs->cs_lock);
1625 	}
1626 
1627 #if 0
1628 	printf("%xS%04d\n", zst->zst_rx_flags, zst->zst_rbavail);
1629 #endif
1630 }
1631 
1632 integrate void
1633 zstty_txsoft(struct zstty_softc *zst, struct tty *tp)
1634 {
1635 	struct zs_chanstate *cs = zst->zst_cs;
1636 
1637 	mutex_spin_enter(&cs->cs_lock);
1638 	CLR(tp->t_state, TS_BUSY);
1639 	if (ISSET(tp->t_state, TS_FLUSH))
1640 		CLR(tp->t_state, TS_FLUSH);
1641 	else
1642 		ndflush(&tp->t_outq, (int)(zst->zst_tba - tp->t_outq.c_cf));
1643 	mutex_spin_exit(&cs->cs_lock);
1644 	(*tp->t_linesw->l_start)(tp);
1645 }
1646 
1647 integrate void
1648 zstty_stsoft(struct zstty_softc *zst, struct tty *tp)
1649 {
1650 	struct zs_chanstate *cs = zst->zst_cs;
1651 	uint8_t rr0, delta;
1652 
1653 	mutex_spin_enter(&cs->cs_lock);
1654 	rr0 = cs->cs_rr0;
1655 	delta = cs->cs_rr0_delta;
1656 	cs->cs_rr0_delta = 0;
1657 	mutex_spin_exit(&cs->cs_lock);
1658 
1659 	if (ISSET(delta, cs->cs_rr0_dcd)) {
1660 		/*
1661 		 * Inform the tty layer that carrier detect changed.
1662 		 */
1663 		mutex_spin_exit(&tty_lock);
1664 		(void) (*tp->t_linesw->l_modem)(tp, ISSET(rr0, ZSRR0_DCD));
1665 		mutex_spin_enter(&tty_lock);
1666 	}
1667 
1668 	if (ISSET(delta, cs->cs_rr0_cts)) {
1669 		/* Block or unblock output according to flow control. */
1670 		if (ISSET(rr0, cs->cs_rr0_cts)) {
1671 			zst->zst_tx_stopped = 0;
1672 			(*tp->t_linesw->l_start)(tp);
1673 		} else {
1674 			zst->zst_tx_stopped = 1;
1675 		}
1676 	}
1677 }
1678 
1679 /*
1680  * Software interrupt.  Called at zssoft
1681  *
1682  * The main job to be done here is to empty the input ring
1683  * by passing its contents up to the tty layer.  The ring is
1684  * always emptied during this operation, therefore the ring
1685  * must not be larger than the space after "high water" in
1686  * the tty layer, or the tty layer might drop our input.
1687  *
1688  * Note: an "input blockage" condition is assumed to exist if
1689  * EITHER the TS_TBLOCK flag or zst_rx_blocked flag is set.
1690  */
1691 static void
1692 zstty_softint(struct zs_chanstate *cs)
1693 {
1694 
1695 	zstty_softint1(cs);
1696 }
1697 
1698 static void
1699 zstty_softint1(struct zs_chanstate *cs)
1700 {
1701 	struct zstty_softc *zst = cs->cs_private;
1702 	struct tty *tp = zst->zst_tty;
1703 
1704 
1705 	if (zst->zst_rx_ready) {
1706 		zst->zst_rx_ready = 0;
1707 		zstty_rxsoft(zst, tp);
1708 	}
1709 
1710 	if (zst->zst_st_check) {
1711 		zst->zst_st_check = 0;
1712 		zstty_stsoft(zst, tp);
1713 	}
1714 
1715 	if (zst->zst_tx_done) {
1716 		zst->zst_tx_done = 0;
1717 		zstty_txsoft(zst, tp);
1718 	}
1719 }
1720 
1721 struct zsops zsops_tty = {
1722 	zstty_rxint,	/* receive char available */
1723 	zstty_stint,	/* external/status */
1724 	zstty_txint,	/* xmit buffer empty */
1725 	zstty_softint,	/* process software interrupt */
1726 };
1727 
1728 #ifdef ZS_TXDMA
1729 void
1730 zstty_txdma_int(void *arg)
1731 {
1732 	struct zs_chanstate *cs = arg;
1733 	struct zstty_softc *zst = cs->cs_private;
1734 
1735 	zst->zst_tba += zst->zst_tbc;
1736 	zst->zst_tbc = 0;
1737 
1738 	if (zst->zst_tx_busy) {
1739 		zst->zst_tx_busy = 0;
1740 		zst->zst_tx_done = 1;
1741 		cs->cs_softreq = 1;
1742 	}
1743 }
1744 #endif
1745