xref: /openbsd-src/sys/dev/pci/cz.c (revision fcde59b201a29a2b4570b00b71e7aa25d61cb5c1)
1 /*	$OpenBSD: cz.c,v 1.24 2020/05/21 09:31:59 mpi Exp $ */
2 /*	$NetBSD: cz.c,v 1.15 2001/01/20 19:10:36 thorpej Exp $	*/
3 
4 /*-
5  * Copyright (c) 2000 Zembu Labs, Inc.
6  * All rights reserved.
7  *
8  * Authors: Jason R. Thorpe <thorpej@zembu.com>
9  *          Bill Studenmund <wrstuden@zembu.com>
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by Zembu Labs, Inc.
22  * 4. Neither the name of Zembu Labs nor the names of its employees may
23  *    be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR-
28  * RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS-
29  * CLAIMED.  IN NO EVENT SHALL ZEMBU LABS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /*
39  * Cyclades-Z series multi-port serial adapter driver for NetBSD.
40  *
41  * Some notes:
42  *
43  *	- The Cyclades-Z has fully automatic hardware (and software!)
44  *	  flow control.  We only utilize RTS/CTS flow control here,
45  *	  and it is implemented in a very simplistic manner.  This
46  *	  may be an area of future work.
47  *
48  *	- The PLX can map the either the board's RAM or host RAM
49  *	  into the MIPS's memory window.  This would enable us to
50  *	  use less expensive (for us) memory reads/writes to host
51  *	  RAM, rather than time-consuming reads/writes to PCI
52  *	  memory space.  However, the PLX can only map a 0-128M
53  *	  window, so we would have to ensure that the DMA address
54  *	  of the host RAM fits there.  This is kind of a pain,
55  *	  so we just don't bother right now.
56  *
57  *	- In a perfect world, we would use the autoconfiguration
58  *	  mechanism to attach the TTYs that we find.  However,
59  *	  that leads to somewhat icky looking autoconfiguration
60  *	  messages (one for every TTY, up to 64 per board!).  So
61  *	  we don't do it that way, but assign minors as if there
62  *	  were the max of 64 ports per board.
63  *
64  *	- We don't bother with PPS support here.  There are so many
65  *	  ports, each with a large amount of buffer space, that the
66  *	  normal mode of operation is to poll the boards regularly
67  *	  (generally, every 20ms or so).  This makes this driver
68  *	  unsuitable for PPS, as the latency will be generally too
69  *	  high.
70  */
71 /*
72  * This driver inspired by the FreeBSD driver written by Brian J. McGovern
73  * for FreeBSD 3.2.
74  */
75 
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/proc.h>
79 #include <sys/device.h>
80 #include <sys/malloc.h>
81 #include <sys/tty.h>
82 #include <sys/conf.h>
83 #include <sys/time.h>
84 #include <sys/kernel.h>
85 #include <sys/fcntl.h>
86 #include <sys/syslog.h>
87 
88 #include <dev/pci/pcireg.h>
89 #include <dev/pci/pcivar.h>
90 #include <dev/pci/pcidevs.h>
91 #include <dev/pci/czreg.h>
92 
93 #include <dev/pci/plx9060reg.h>
94 #include <dev/pci/plx9060var.h>
95 
96 #include <dev/microcode/cyclades/cyzfirm.h>
97 
98 #define	CZ_DRIVER_VERSION	0x20000411
99 
100 #define CZ_POLL_MS			20
101 
102 /* These are the interrupts we always use. */
103 #define	CZ_INTERRUPTS							\
104 	(C_IN_MDSR | C_IN_MRI | C_IN_MRTS | C_IN_MCTS | C_IN_TXBEMPTY |	\
105 	 C_IN_TXFEMPTY | C_IN_TXLOWWM | C_IN_RXHIWM | C_IN_RXNNDT |	\
106 	 C_IN_MDCD | C_IN_PR_ERROR | C_IN_FR_ERROR | C_IN_OVR_ERROR |	\
107 	 C_IN_RXOFL | C_IN_IOCTLW | C_IN_RXBRK)
108 
109 /*
110  * cztty_softc:
111  *
112  *	Per-channel (TTY) state.
113  */
114 struct cztty_softc {
115 	struct cz_softc *sc_parent;
116 	struct tty *sc_tty;
117 
118 	struct timeout sc_diag_to;
119 
120 	int sc_channel;			/* Also used to flag unattached chan */
121 #define CZTTY_CHANNEL_DEAD	-1
122 
123 	bus_space_tag_t sc_chan_st;	/* channel space tag */
124 	bus_space_handle_t sc_chan_sh;	/* channel space handle */
125 	bus_space_handle_t sc_buf_sh;	/* buffer space handle */
126 
127 	u_int sc_overflows,
128 	      sc_parity_errors,
129 	      sc_framing_errors,
130 	      sc_errors;
131 
132 	int sc_swflags;
133 
134 	u_int32_t sc_rs_control_dtr,
135 		  sc_chanctl_hw_flow,
136 		  sc_chanctl_comm_baud,
137 		  sc_chanctl_rs_control,
138 		  sc_chanctl_comm_data_l,
139 		  sc_chanctl_comm_parity;
140 };
141 
142 /*
143  * cz_softc:
144  *
145  *	Per-board state.
146  */
147 struct cz_softc {
148 	struct device cz_dev;		/* generic device info */
149 	struct plx9060_config cz_plx;	/* PLX 9060 config info */
150 	bus_space_tag_t cz_win_st;	/* window space tag */
151 	bus_space_handle_t cz_win_sh;	/* window space handle */
152 	struct timeout cz_timeout;	/* timeout for polling-mode */
153 
154 	void *cz_ih;			/* interrupt handle */
155 
156 	u_int32_t cz_mailbox0;		/* our MAILBOX0 value */
157 	int cz_nchannels;		/* number of channels */
158 	int cz_nopenchan;		/* number of open channels */
159 	struct cztty_softc *cz_ports;	/* our array of ports */
160 
161 	bus_addr_t cz_fwctl;		/* offset of firmware control */
162 };
163 
164 int	cz_match(struct device *, void *, void *);
165 void	cz_attach(struct device *, struct device *, void *);
166 int	cz_wait_pci_doorbell(struct cz_softc *, char *);
167 
168 struct cfattach cz_ca = {
169 	sizeof(struct cz_softc), cz_match, cz_attach
170 };
171 
172 void	cz_reset_board(struct cz_softc *);
173 int	cz_load_firmware(struct cz_softc *);
174 
175 int	cz_intr(void *);
176 void	cz_poll(void *);
177 int	cztty_transmit(struct cztty_softc *, struct tty *);
178 int	cztty_receive(struct cztty_softc *, struct tty *);
179 
180 struct	cztty_softc * cztty_getttysoftc(dev_t dev);
181 int	cztty_findmajor(void);
182 int	cztty_major;
183 int	cztty_attached_ttys;
184 
185 cdev_decl(cztty);
186 
187 void    czttystart(struct tty *tp);
188 int	czttyparam(struct tty *tp, struct termios *t);
189 void    cztty_shutdown(struct cztty_softc *sc);
190 void	cztty_modem(struct cztty_softc *sc, int onoff);
191 void	cztty_break(struct cztty_softc *sc, int onoff);
192 void	tiocm_to_cztty(struct cztty_softc *sc, u_long how, int ttybits);
193 int	cztty_to_tiocm(struct cztty_softc *sc);
194 void	cztty_diag(void *arg);
195 
196 struct cfdriver cz_cd = {
197 	0, "cz", DV_TTY
198 };
199 
200 /*
201  * Macros to read and write the PLX.
202  */
203 #define	CZ_PLX_READ(cz, reg)						\
204 	bus_space_read_4((cz)->cz_plx.plx_st, (cz)->cz_plx.plx_sh, (reg))
205 #define	CZ_PLX_WRITE(cz, reg, val)					\
206 	bus_space_write_4((cz)->cz_plx.plx_st, (cz)->cz_plx.plx_sh,	\
207 	    (reg), (val))
208 
209 /*
210  * Macros to read and write the FPGA.  We must already be in the FPGA
211  * window for this.
212  */
213 #define	CZ_FPGA_READ(cz, reg)						\
214 	bus_space_read_4((cz)->cz_win_st, (cz)->cz_win_sh, (reg))
215 #define	CZ_FPGA_WRITE(cz, reg, val)					\
216 	bus_space_write_4((cz)->cz_win_st, (cz)->cz_win_sh, (reg), (val))
217 
218 /*
219  * Macros to read and write the firmware control structures in board RAM.
220  */
221 #define	CZ_FWCTL_READ(cz, off)						\
222 	bus_space_read_4((cz)->cz_win_st, (cz)->cz_win_sh,		\
223 	    (cz)->cz_fwctl + (off))
224 
225 #define	CZ_FWCTL_WRITE(cz, off, val)					\
226 	bus_space_write_4((cz)->cz_win_st, (cz)->cz_win_sh,		\
227 	    (cz)->cz_fwctl + (off), (val))
228 
229 /*
230  * Convenience macros for cztty routines.  PLX window MUST be to RAM.
231  */
232 #define CZTTY_CHAN_READ(sc, off)					\
233 	bus_space_read_4((sc)->sc_chan_st, (sc)->sc_chan_sh, (off))
234 
235 #define CZTTY_CHAN_WRITE(sc, off, val)					\
236 	bus_space_write_4((sc)->sc_chan_st, (sc)->sc_chan_sh,		\
237 	    (off), (val))
238 
239 #define CZTTY_BUF_READ(sc, off)						\
240 	bus_space_read_4((sc)->sc_chan_st, (sc)->sc_buf_sh, (off))
241 
242 #define CZTTY_BUF_WRITE(sc, off, val)					\
243 	bus_space_write_4((sc)->sc_chan_st, (sc)->sc_buf_sh,		\
244 	    (off), (val))
245 
246 /*
247  * Convenience macros.
248  */
249 #define	CZ_WIN_RAM(cz)							\
250 do {									\
251 	CZ_PLX_WRITE((cz), PLX_LAS0BA, LOCAL_ADDR0_RAM);		\
252 	delay(100);							\
253 } while (0)
254 
255 #define	CZ_WIN_FPGA(cz)							\
256 do {									\
257 	CZ_PLX_WRITE((cz), PLX_LAS0BA, LOCAL_ADDR0_FPGA);		\
258 	delay(100);							\
259 } while (0)
260 
261 /*****************************************************************************
262  * Cyclades-Z controller code starts here...
263  *****************************************************************************/
264 
265 /*
266  * cz_match:
267  *
268  *	Determine if the given PCI device is a Cyclades-Z board.
269  */
270 int
271 cz_match(parent, match, aux)
272 	struct device *parent;
273 	void *match, *aux;
274 {
275 	struct pci_attach_args *pa = aux;
276 
277 	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_CYCLADES &&
278 	    PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_CYCLADES_CYCLOMZ_2)
279 		return (1);
280 	return (0);
281 }
282 
283 /*
284  * cz_attach:
285  *
286  *	A Cyclades-Z board was found; attach it.
287  */
288 void
289 cz_attach(parent, self, aux)
290 	struct device *parent, *self;
291 	void *aux;
292 {
293 	struct cz_softc *cz = (void *) self;
294 	struct pci_attach_args *pa = aux;
295 	pci_chipset_tag_t pc = pa->pa_pc;
296 	pci_intr_handle_t ih;
297 	const char *intrstr = NULL;
298 	struct cztty_softc *sc;
299 	struct tty *tp;
300 	int i;
301 
302 	cz->cz_plx.plx_pc = pa->pa_pc;
303 	cz->cz_plx.plx_tag = pa->pa_tag;
304 
305 	if (pci_mapreg_map(pa, PLX_PCI_RUNTIME_MEMADDR,
306 	    PCI_MAPREG_TYPE_MEM|PCI_MAPREG_MEM_TYPE_32BIT, 0,
307 	    &cz->cz_plx.plx_st, &cz->cz_plx.plx_sh, NULL, NULL, 0) != 0) {
308 		printf(": unable to map PLX registers\n");
309 		return;
310 	}
311 	if (pci_mapreg_map(pa, PLX_PCI_LOCAL_ADDR0,
312 	    PCI_MAPREG_TYPE_MEM|PCI_MAPREG_MEM_TYPE_32BIT, 0,
313 	    &cz->cz_win_st, &cz->cz_win_sh, NULL, NULL, 0) != 0) {
314 		printf(": unable to map device window\n");
315 		return;
316 	}
317 
318 	cz->cz_mailbox0 = CZ_PLX_READ(cz, PLX_MAILBOX0);
319 	cz->cz_nopenchan = 0;
320 
321 	/*
322 	 * Make sure that the board is completely stopped.
323 	 */
324 	CZ_WIN_FPGA(cz);
325 	CZ_FPGA_WRITE(cz, FPGA_CPU_STOP, 0);
326 
327 	/*
328 	 * Load the board's firmware.
329 	 */
330 	if (cz_load_firmware(cz) != 0)
331 		return;
332 
333 	/*
334 	 * Now that we're ready to roll, map and establish the interrupt
335 	 * handler.
336 	 */
337 	if (pci_intr_map(pa, &ih) != 0) {
338 		/*
339 		 * The common case is for Cyclades-Z boards to run
340 		 * in polling mode, and thus not have an interrupt
341 		 * mapped for them.  Don't bother reporting that
342 		 * the interrupt is not mappable, since this isn't
343 		 * really an error.
344 		 */
345 		cz->cz_ih = NULL;
346 		goto polling_mode;
347 	} else {
348 		intrstr = pci_intr_string(pa->pa_pc, ih);
349 		cz->cz_ih = pci_intr_establish(pc, ih, IPL_TTY,
350 			    cz_intr, cz, cz->cz_dev.dv_xname);
351 	}
352 	if (cz->cz_ih == NULL) {
353 		printf(": unable to establish interrupt");
354 		if (intrstr != NULL)
355 			printf(" at %s", intrstr);
356 		printf("\n");
357 		/* We will fall-back on polling mode. */
358 	} else
359 		printf(": %s\n", intrstr);
360 
361  polling_mode:
362 	if (cz->cz_ih == NULL) {
363 		timeout_set(&cz->cz_timeout, cz_poll, cz);
364 		printf("%s: polling mode, %d ms interval\n",
365 		    cz->cz_dev.dv_xname, CZ_POLL_MS);
366 	}
367 
368 	if (cztty_major == 0)
369 		cztty_major = cztty_findmajor();
370 	/*
371 	 * Allocate sufficient pointers for the children and
372 	 * attach them.  Set all ports to a reasonable initial
373 	 * configuration while we're at it:
374 	 *
375 	 *	disabled
376 	 *	8N1
377 	 *	default baud rate
378 	 *	hardware flow control.
379 	 */
380 	CZ_WIN_RAM(cz);
381 
382 	if (cz->cz_nchannels == 0) {
383 		/* No channels?  No more work to do! */
384 		return;
385 	}
386 
387 	cz->cz_ports = mallocarray(cz->cz_nchannels,
388 	    sizeof(struct cztty_softc), M_DEVBUF, M_WAITOK | M_ZERO);
389 	cztty_attached_ttys += cz->cz_nchannels;
390 
391 	for (i = 0; i < cz->cz_nchannels; i++) {
392 		sc = &cz->cz_ports[i];
393 
394 		sc->sc_channel = i;
395 		sc->sc_chan_st = cz->cz_win_st;
396 		sc->sc_parent = cz;
397 
398 		if (bus_space_subregion(cz->cz_win_st, cz->cz_win_sh,
399 		    cz->cz_fwctl + ZFIRM_CHNCTL_OFF(i, 0),
400 		    ZFIRM_CHNCTL_SIZE, &sc->sc_chan_sh)) {
401 			printf("%s: unable to subregion channel %d control\n",
402 			    cz->cz_dev.dv_xname, i);
403 			sc->sc_channel = CZTTY_CHANNEL_DEAD;
404 			continue;
405 		}
406 		if (bus_space_subregion(cz->cz_win_st, cz->cz_win_sh,
407 		    cz->cz_fwctl + ZFIRM_BUFCTL_OFF(i, 0),
408 		    ZFIRM_BUFCTL_SIZE, &sc->sc_buf_sh)) {
409 			printf("%s: unable to subregion channel %d buffer\n",
410 			    cz->cz_dev.dv_xname, i);
411 			sc->sc_channel = CZTTY_CHANNEL_DEAD;
412 			continue;
413 		}
414 
415 		timeout_set(&sc->sc_diag_to, cztty_diag, sc);
416 
417 		tp = ttymalloc(0);
418 		tp->t_dev = makedev(cztty_major,
419 		    (cz->cz_dev.dv_unit * ZFIRM_MAX_CHANNELS) + i);
420 		tp->t_oproc = czttystart;
421 		tp->t_param = czttyparam;
422 
423 		sc->sc_tty = tp;
424 
425 		CZTTY_CHAN_WRITE(sc, CHNCTL_OP_MODE, C_CH_DISABLE);
426 		CZTTY_CHAN_WRITE(sc, CHNCTL_INTR_ENABLE, CZ_INTERRUPTS);
427 		CZTTY_CHAN_WRITE(sc, CHNCTL_SW_FLOW, 0);
428 		CZTTY_CHAN_WRITE(sc, CHNCTL_FLOW_XON, 0x11);
429 		CZTTY_CHAN_WRITE(sc, CHNCTL_FLOW_XOFF, 0x13);
430 		CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_BAUD, TTYDEF_SPEED);
431 		CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_PARITY, C_PR_NONE);
432 		CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_DATA_L, C_DL_CS8 | C_DL_1STOP);
433 		CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_FLAGS, 0);
434 		CZTTY_CHAN_WRITE(sc, CHNCTL_HW_FLOW, C_RS_CTS | C_RS_RTS);
435 		CZTTY_CHAN_WRITE(sc, CHNCTL_RS_CONTROL, 0);
436 	}
437 }
438 
439 /*
440  * cz_reset_board:
441  *
442  *	Reset the board via the PLX.
443  */
444 void
445 cz_reset_board(struct cz_softc *cz)
446 {
447 	u_int32_t reg;
448 
449 	reg = CZ_PLX_READ(cz, PLX_CONTROL);
450 	CZ_PLX_WRITE(cz, PLX_CONTROL, reg | CONTROL_SWR);
451 	delay(1000);
452 
453 	CZ_PLX_WRITE(cz, PLX_CONTROL, reg);
454 	delay(1000);
455 
456 	/* Now reload the PLX from its EEPROM. */
457 	reg = CZ_PLX_READ(cz, PLX_CONTROL);
458 	CZ_PLX_WRITE(cz, PLX_CONTROL, reg | CONTROL_RELOADCFG);
459 	delay(1000);
460 	CZ_PLX_WRITE(cz, PLX_CONTROL, reg);
461 }
462 
463 /*
464  * cz_load_firmware:
465  *
466  *	Load the ZFIRM firmware into the board's RAM and start it
467  *	running.
468  */
469 int
470 cz_load_firmware(struct cz_softc *cz)
471 {
472 	struct zfirm_header *zfh;
473 	struct zfirm_config *zfc;
474 	struct zfirm_block *zfb, *zblocks;
475 	const u_int8_t *cp;
476 	const char *board;
477 	u_int32_t fid;
478 	int i, j, nconfigs, nblocks, nbytes;
479 
480 	zfh = (struct zfirm_header *) cycladesz_firmware;
481 
482 	/* Find the config header. */
483 	if (letoh32(zfh->zfh_configoff) & (sizeof(u_int32_t) - 1)) {
484 		printf("%s: bad ZFIRM config offset: 0x%x\n",
485 		    cz->cz_dev.dv_xname, letoh32(zfh->zfh_configoff));
486 		return (EIO);
487 	}
488 	zfc = (struct zfirm_config *)(cycladesz_firmware +
489 	    letoh32(zfh->zfh_configoff));
490 	nconfigs = letoh32(zfh->zfh_nconfig);
491 
492 	/* Locate the correct configuration for our board. */
493 	for (i = 0; i < nconfigs; i++, zfc++) {
494 		if (letoh32(zfc->zfc_mailbox) == cz->cz_mailbox0 &&
495 		    letoh32(zfc->zfc_function) == ZFC_FUNCTION_NORMAL)
496 			break;
497 	}
498 	if (i == nconfigs) {
499 		printf("%s: unable to locate config header\n",
500 		    cz->cz_dev.dv_xname);
501 		return (EIO);
502 	}
503 
504 	nblocks = letoh32(zfc->zfc_nblocks);
505 	zblocks = (struct zfirm_block *)(cycladesz_firmware +
506 	    letoh32(zfh->zfh_blockoff));
507 
508 	/*
509 	 * 8Zo ver. 1 doesn't have an FPGA.  Load it on all others if
510 	 * necessary.
511 	 */
512 	if (cz->cz_mailbox0 != MAILBOX0_8Zo_V1
513 #if 0
514 	    && ((CZ_PLX_READ(cz, PLX_CONTROL) & CONTROL_FPGA_LOADED) == 0)
515 #endif
516 								) {
517 #ifdef CZ_DEBUG
518 		printf("%s: Loading FPGA...", cz->cz_dev.dv_xname);
519 #endif
520 		CZ_WIN_FPGA(cz);
521 		for (i = 0; i < nblocks; i++) {
522 			/* zfb = zblocks + letoh32(zfc->zfc_blocklist[i]) ?? */
523 			zfb = &zblocks[letoh32(zfc->zfc_blocklist[i])];
524 			if (letoh32(zfb->zfb_type) == ZFB_TYPE_FPGA) {
525 				nbytes = letoh32(zfb->zfb_size);
526 				cp = &cycladesz_firmware[
527 				    letoh32(zfb->zfb_fileoff)];
528 				for (j = 0; j < nbytes; j++, cp++) {
529 					bus_space_write_1(cz->cz_win_st,
530 					    cz->cz_win_sh, 0, *cp);
531 					/* FPGA needs 30-100us to settle. */
532 					delay(10);
533 				}
534 			}
535 		}
536 #ifdef CZ_DEBUG
537 		printf("done\n");
538 #endif
539 	}
540 
541 	/* Now load the firmware. */
542 	CZ_WIN_RAM(cz);
543 
544 	for (i = 0; i < nblocks; i++) {
545 		/* zfb = zblocks + letoh32(zfc->zfc_blocklist[i]) ?? */
546 		zfb = &zblocks[letoh32(zfc->zfc_blocklist[i])];
547 		if (letoh32(zfb->zfb_type) == ZFB_TYPE_FIRMWARE) {
548 			const u_int32_t *lp;
549 			u_int32_t ro = letoh32(zfb->zfb_ramoff);
550 			nbytes = letoh32(zfb->zfb_size);
551 			lp = (const u_int32_t *)
552 			    &cycladesz_firmware[letoh32(zfb->zfb_fileoff)];
553 			for (j = 0; j < nbytes; j += 4, lp++) {
554 				bus_space_write_4(cz->cz_win_st, cz->cz_win_sh,
555 				    ro + j, letoh32(*lp));
556 				delay(10);
557 			}
558 		}
559 	}
560 
561 	/* Now restart the MIPS. */
562 	CZ_WIN_FPGA(cz);
563 	CZ_FPGA_WRITE(cz, FPGA_CPU_START, 0);
564 
565 	/* Wait for the MIPS to start, then report the results. */
566 	CZ_WIN_RAM(cz);
567 
568 #ifdef CZ_DEBUG
569 	printf("%s: waiting for MIPS to start", cz->cz_dev.dv_xname);
570 #endif
571 	for (i = 0; i < 100; i++) {
572 		fid = bus_space_read_4(cz->cz_win_st, cz->cz_win_sh,
573 		    ZFIRM_SIG_OFF);
574 		if (fid == ZFIRM_SIG) {
575 			/* MIPS has booted. */
576 			break;
577 		} else if (fid == ZFIRM_HLT) {
578 			/*
579 			 * The MIPS has halted, usually due to a power
580 			 * shortage on the expansion module.
581 			 */
582 			printf("%s: MIPS halted; possible power supply "
583 			    "problem\n", cz->cz_dev.dv_xname);
584 			return (EIO);
585 		} else {
586 #ifdef CZ_DEBUG
587 			if ((i % 8) == 0)
588 				printf(".");
589 #endif
590 			delay(250000);
591 		}
592 	}
593 #ifdef CZ_DEBUG
594 	printf("\n");
595 #endif
596 	if (i == 100) {
597 		CZ_WIN_FPGA(cz);
598 		printf("%s: MIPS failed to start; wanted 0x%08x got 0x%08x\n",
599 		    cz->cz_dev.dv_xname, ZFIRM_SIG, fid);
600 		printf("%s: FPGA ID 0x%08x, FPGA version 0x%08x\n",
601 		    cz->cz_dev.dv_xname, CZ_FPGA_READ(cz, FPGA_ID),
602 		    CZ_FPGA_READ(cz, FPGA_VERSION));
603 		return (EIO);
604 	}
605 
606 	/*
607 	 * Locate the firmware control structures.
608 	 */
609 	cz->cz_fwctl = bus_space_read_4(cz->cz_win_st, cz->cz_win_sh,
610 	    ZFIRM_CTRLADDR_OFF);
611 #ifdef CZ_DEBUG
612 	printf("%s: FWCTL structure at offset 0x%08lx\n",
613 	    cz->cz_dev.dv_xname, cz->cz_fwctl);
614 #endif
615 
616 	CZ_FWCTL_WRITE(cz, BRDCTL_C_OS, C_OS_BSD);
617 	CZ_FWCTL_WRITE(cz, BRDCTL_DRVERSION, CZ_DRIVER_VERSION);
618 
619 	cz->cz_nchannels = CZ_FWCTL_READ(cz, BRDCTL_NCHANNEL);
620 
621 	switch (cz->cz_mailbox0) {
622 	case MAILBOX0_8Zo_V1:
623 		board = "Cyclades-8Zo ver. 1";
624 		break;
625 
626 	case MAILBOX0_8Zo_V2:
627 		board = "Cyclades-8Zo ver. 2";
628 		break;
629 
630 	case MAILBOX0_Ze_V1:
631 		board = "Cyclades-Ze";
632 		break;
633 
634 	default:
635 		board = "unknown Cyclades Z-series";
636 		break;
637 	}
638 
639 	fid = CZ_FWCTL_READ(cz, BRDCTL_FWVERSION);
640 	printf("%s: %s, ", cz->cz_dev.dv_xname, board);
641 	if (cz->cz_nchannels == 0)
642 		printf("no channels attached, ");
643 	else
644 		printf("%d channels (ttyCZ%04d..ttyCZ%04d), ",
645 		    cz->cz_nchannels, cztty_attached_ttys,
646 		    cztty_attached_ttys + (cz->cz_nchannels - 1));
647 	printf("firmware %x.%x.%x\n",
648 	    (fid >> 8) & 0xf, (fid >> 4) & 0xf, fid & 0xf);
649 
650 	return (0);
651 }
652 
653 /*
654  * cz_poll:
655  *
656  * This card doesn't do interrupts, so scan it for activity every CZ_POLL_MS
657  * ms.
658  */
659 void
660 cz_poll(void *arg)
661 {
662 	int s = spltty();
663 	struct cz_softc *cz = arg;
664 
665 	cz_intr(cz);
666 	timeout_add_msec(&cz->cz_timeout, CZ_POLL_MS);
667 
668 	splx(s);
669 }
670 
671 /*
672  * cz_intr:
673  *
674  *	Interrupt service routine.
675  *
676  * We either are receiving an interrupt directly from the board, or we are
677  * in polling mode and it's time to poll.
678  */
679 int
680 cz_intr(void *arg)
681 {
682 	int	rval = 0;
683 	u_int	command, channel, param;
684 	struct	cz_softc *cz = arg;
685 	struct	cztty_softc *sc;
686 	struct	tty *tp;
687 
688 	while ((command = (CZ_PLX_READ(cz, PLX_LOCAL_PCI_DOORBELL) & 0xff))) {
689 		rval = 1;
690 		channel = CZ_FWCTL_READ(cz, BRDCTL_FWCMD_CHANNEL);
691 		param = CZ_FWCTL_READ(cz, BRDCTL_FWCMD_PARAM);
692 
693 		/* now clear this interrupt, posslibly enabling another */
694 		CZ_PLX_WRITE(cz, PLX_LOCAL_PCI_DOORBELL, command);
695 
696 		if (cz->cz_ports == NULL) {
697 #ifdef CZ_DEBUG
698 			printf("%s: interrupt on channel %d, but no channels\n",
699 			    cz->cz_dev.dv_xname, channel);
700 #endif
701 			continue;
702 		}
703 
704 		sc = &cz->cz_ports[channel];
705 
706 		if (sc->sc_channel == CZTTY_CHANNEL_DEAD)
707 			break;
708 
709 		tp = sc->sc_tty;
710 
711 		switch (command) {
712 		case C_CM_TXFEMPTY:		/* transmit cases */
713 		case C_CM_TXBEMPTY:
714 		case C_CM_TXLOWWM:
715 		case C_CM_INTBACK:
716 			if (!ISSET(tp->t_state, TS_ISOPEN)) {
717 #ifdef CZ_DEBUG
718 				printf("%s: tx intr on closed channel %d\n",
719 				    cz->cz_dev.dv_xname, channel);
720 #endif
721 				break;
722 			}
723 
724 			if (cztty_transmit(sc, tp)) {
725 				/*
726 				 * Do wakeup stuff here.
727 				 */
728 				ttwakeup(tp);
729 				wakeup(tp);
730 			}
731 			break;
732 
733 		case C_CM_RXNNDT:		/* receive cases */
734 		case C_CM_RXHIWM:
735 		case C_CM_INTBACK2:		/* from restart ?? */
736 #if 0
737 		case C_CM_ICHAR:
738 #endif
739 			if (!ISSET(tp->t_state, TS_ISOPEN)) {
740 				CZTTY_BUF_WRITE(sc, BUFCTL_RX_GET,
741 				    CZTTY_BUF_READ(sc, BUFCTL_RX_PUT));
742 				break;
743 			}
744 
745 			if (cztty_receive(sc, tp)) {
746 				/*
747 				 * Do wakeup stuff here.
748 				 */
749 				ttwakeup(tp);
750 				wakeup(tp);
751 			}
752 			break;
753 
754 		case C_CM_MDCD:
755 			if (!ISSET(tp->t_state, TS_ISOPEN))
756 				break;
757 
758 			(void) (*linesw[tp->t_line].l_modem)(tp,
759 			    ISSET(C_RS_DCD, CZTTY_CHAN_READ(sc,
760 			    CHNCTL_RS_STATUS)));
761 			break;
762 
763 		case C_CM_MDSR:
764 		case C_CM_MRI:
765 		case C_CM_MCTS:
766 		case C_CM_MRTS:
767 			break;
768 
769 		case C_CM_IOCTLW:
770 			break;
771 
772 		case C_CM_PR_ERROR:
773 			sc->sc_parity_errors++;
774 			goto error_common;
775 
776 		case C_CM_FR_ERROR:
777 			sc->sc_framing_errors++;
778 			goto error_common;
779 
780 		case C_CM_OVR_ERROR:
781 			sc->sc_overflows++;
782  error_common:
783 			if (sc->sc_errors++ == 0)
784 				timeout_add_sec(&sc->sc_diag_to, 60);
785 			break;
786 
787 		case C_CM_RXBRK:
788 			if (!ISSET(tp->t_state, TS_ISOPEN))
789 				break;
790 
791 			/*
792 			 * A break is a \000 character with TTY_FE error
793 			 * flags set. So TTY_FE by itself works.
794 			 */
795 			(*linesw[tp->t_line].l_rint)(TTY_FE, tp);
796 			ttwakeup(tp);
797 			wakeup(tp);
798 			break;
799 
800 		default:
801 #ifdef CZ_DEBUG
802 			printf("%s: channel %d: Unknown interrupt 0x%x\n",
803 			    cz->cz_dev.dv_xname, sc->sc_channel, command);
804 #endif
805 			break;
806 		}
807 	}
808 
809 	return (rval);
810 }
811 
812 /*
813  * cz_wait_pci_doorbell:
814  *
815  *	Wait for the pci doorbell to be clear - wait for pending
816  *	activity to drain.
817  */
818 int
819 cz_wait_pci_doorbell(struct cz_softc *cz, char *wstring)
820 {
821 	int	error;
822 
823 	while (CZ_PLX_READ(cz, PLX_PCI_LOCAL_DOORBELL)) {
824 		error = tsleep_nsec(cz, TTIPRI | PCATCH, wstring,
825 		    MSEC_TO_NSEC(10));
826 		if ((error != 0) && (error != EWOULDBLOCK))
827 			return (error);
828 	}
829 	return (0);
830 }
831 
832 /*****************************************************************************
833  * Cyclades-Z TTY code starts here...
834  *****************************************************************************/
835 
836 #define CZTTYDIALOUT_MASK	0x80
837 
838 #define	CZTTY_DIALOUT(dev)	(minor((dev)) & CZTTYDIALOUT_MASK)
839 #define	CZTTY_CZ(sc)		((sc)->sc_parent)
840 
841 #define	CZTTY_SOFTC(dev)	cztty_getttysoftc(dev)
842 
843 struct cztty_softc *
844 cztty_getttysoftc(dev_t dev)
845 {
846 	int i, j, k, u = minor(dev) & ~CZTTYDIALOUT_MASK;
847 	struct cz_softc *cz;
848 
849 	for (i = 0, j = 0; i < cz_cd.cd_ndevs; i++) {
850 		k = j;
851 		cz = (struct cz_softc *)device_lookup(&cz_cd, i);
852 		if (cz == NULL)
853 			continue;
854 		if (cz->cz_ports == NULL)
855 			continue;
856 		j += cz->cz_nchannels;
857 		if (j > u)
858 			break;
859 	}
860 
861 	if (i >= cz_cd.cd_ndevs)
862 		return (NULL);
863 	else
864 		return (&cz->cz_ports[u - k]);
865 }
866 
867 int
868 cztty_findmajor(void)
869 {
870 	int	maj;
871 
872 	for (maj = 0; maj < nchrdev; maj++) {
873 		if (cdevsw[maj].d_open == czttyopen)
874 			break;
875 	}
876 
877 	return (maj == nchrdev) ? 0 : maj;
878 }
879 
880 /*
881  * czttytty:
882  *
883  *	Return a pointer to our tty.
884  */
885 struct tty *
886 czttytty(dev_t dev)
887 {
888 	struct cztty_softc *sc = CZTTY_SOFTC(dev);
889 
890 #ifdef DIAGNOSTIC
891 	if (sc == NULL)
892 		panic("czttytty");
893 #endif
894 
895 	return (sc->sc_tty);
896 }
897 
898 /*
899  * cztty_shutdown:
900  *
901  *	Shut down a port.
902  */
903 void
904 cztty_shutdown(struct cztty_softc *sc)
905 {
906 	struct cz_softc *cz = CZTTY_CZ(sc);
907 	struct tty *tp = sc->sc_tty;
908 	int s;
909 
910 	s = spltty();
911 
912 	/* Clear any break condition set with TIOCSBRK. */
913 	cztty_break(sc, 0);
914 
915 	/*
916 	 * Hang up if necessary.  Wait a bit, so the other side has time to
917 	 * notice even if we immediately open the port again.
918 	 */
919 	if (ISSET(tp->t_cflag, HUPCL)) {
920 		cztty_modem(sc, 0);
921 		tsleep_nsec(tp, TTIPRI, ttclos, SEC_TO_NSEC(1));
922 	}
923 
924 	/* Disable the channel. */
925 	cz_wait_pci_doorbell(cz, "czdis");
926 	CZTTY_CHAN_WRITE(sc, CHNCTL_OP_MODE, C_CH_DISABLE);
927 	CZ_FWCTL_WRITE(cz, BRDCTL_HCMD_CHANNEL, sc->sc_channel);
928 	CZ_PLX_WRITE(cz, PLX_PCI_LOCAL_DOORBELL, C_CM_IOCTL);
929 
930 	if ((--cz->cz_nopenchan == 0) && (cz->cz_ih == NULL)) {
931 #ifdef CZ_DEBUG
932 		printf("%s: Disabling polling\n", cz->cz_dev.dv_xname);
933 #endif
934 		timeout_del(&cz->cz_timeout);
935 	}
936 
937 	splx(s);
938 }
939 
940 /*
941  * czttyopen:
942  *
943  *	Open a Cyclades-Z serial port.
944  */
945 int
946 czttyopen(dev_t dev, int flags, int mode, struct proc *p)
947 {
948 	struct cztty_softc *sc = CZTTY_SOFTC(dev);
949 	struct cz_softc *cz;
950 	struct tty *tp;
951 	int s, error;
952 
953 	if (sc == NULL)
954 		return (ENXIO);
955 
956 	if (sc->sc_channel == CZTTY_CHANNEL_DEAD)
957 		return (ENXIO);
958 
959 	cz = CZTTY_CZ(sc);
960 	tp = sc->sc_tty;
961 
962 	if (ISSET(tp->t_state, TS_ISOPEN) &&
963 	    ISSET(tp->t_state, TS_XCLUDE) &&
964 	    suser(p) != 0)
965 		return (EBUSY);
966 
967 	s = spltty();
968 
969 	/*
970 	 * Do the following iff this is a first open.
971 	 */
972 	if (!ISSET(tp->t_state, TS_ISOPEN)) {
973 		struct termios t;
974 
975 		tp->t_dev = dev;
976 
977 		/* If we're turning things on, enable interrupts */
978 		if ((cz->cz_nopenchan++ == 0) && (cz->cz_ih == NULL)) {
979 #ifdef CZ_DEBUG
980 			printf("%s: Enabling polling.\n",
981 			    cz->cz_dev.dv_xname);
982 #endif
983 			timeout_add_msec(&cz->cz_timeout, CZ_POLL_MS);
984 		}
985 
986 		/*
987 		 * Enable the channel.  Don't actually ring the
988 		 * doorbell here; czttyparam() will do it for us.
989 		 */
990 		cz_wait_pci_doorbell(cz, "czopen");
991 
992 		CZTTY_CHAN_WRITE(sc, CHNCTL_OP_MODE, C_CH_ENABLE);
993 
994 		/*
995 		 * Initialize the termios status to the defaults.  Add in the
996 		 * sticky bits from TIOCSFLAGS.
997 		 */
998 		t.c_ispeed = 0;
999 		t.c_ospeed = TTYDEF_SPEED;
1000 		t.c_cflag = TTYDEF_CFLAG;
1001 		if (ISSET(sc->sc_swflags, TIOCFLAG_CLOCAL))
1002 			SET(t.c_cflag, CLOCAL);
1003 		if (ISSET(sc->sc_swflags, TIOCFLAG_CRTSCTS))
1004 			SET(t.c_cflag, CRTSCTS);
1005 
1006 		/*
1007 		 * Reset the input and output rings.  Do this before
1008 		 * we call czttyparam(), as that function enables
1009 		 * the channel.
1010 		 */
1011 		CZTTY_BUF_WRITE(sc, BUFCTL_RX_GET,
1012 		    CZTTY_BUF_READ(sc, BUFCTL_RX_PUT));
1013 		CZTTY_BUF_WRITE(sc, BUFCTL_TX_PUT,
1014 		    CZTTY_BUF_READ(sc, BUFCTL_TX_GET));
1015 
1016 		/* Make sure czttyparam() will see changes. */
1017 		tp->t_ospeed = 0;
1018 		(void) czttyparam(tp, &t);
1019 		tp->t_iflag = TTYDEF_IFLAG;
1020 		tp->t_oflag = TTYDEF_OFLAG;
1021 		tp->t_lflag = TTYDEF_LFLAG;
1022 		ttychars(tp);
1023 		ttsetwater(tp);
1024 
1025 		/*
1026 		 * Turn on DTR.  We must always do this, even if carrier is not
1027 		 * present, because otherwise we'd have to use TIOCSDTR
1028 		 * immediately after setting CLOCAL, which applications do not
1029 		 * expect.  We always assert DTR while the device is open
1030 		 * unless explicitly requested to deassert it.
1031 		 */
1032 		cztty_modem(sc, 1);
1033 	}
1034 
1035 	splx(s);
1036 
1037 	error = ttyopen(CZTTY_DIALOUT(dev), tp, p);
1038 	if (error)
1039 		goto bad;
1040 
1041 	error = (*linesw[tp->t_line].l_open)(dev, tp, p);
1042 	if (error)
1043 		goto bad;
1044 
1045 	return (0);
1046 
1047  bad:
1048 	if (!ISSET(tp->t_state, TS_ISOPEN)) {
1049 		/*
1050 		 * We failed to open the device, and nobody else had it opened.
1051 		 * Clean up the state as appropriate.
1052 		 */
1053 		cztty_shutdown(sc);
1054 	}
1055 
1056 	return (error);
1057 }
1058 
1059 /*
1060  * czttyclose:
1061  *
1062  *	Close a Cyclades-Z serial port.
1063  */
1064 int
1065 czttyclose(dev_t dev, int flags, int mode, struct proc *p)
1066 {
1067 	struct cztty_softc *sc = CZTTY_SOFTC(dev);
1068 	struct tty *tp = sc->sc_tty;
1069 
1070 	/* XXX This is for cons.c. */
1071 	if (!ISSET(tp->t_state, TS_ISOPEN))
1072 		return (0);
1073 
1074 	(*linesw[tp->t_line].l_close)(tp, flags, p);
1075 	ttyclose(tp);
1076 
1077 	if (!ISSET(tp->t_state, TS_ISOPEN)) {
1078 		/*
1079 		 * Although we got a last close, the device may still be in
1080 		 * use; e.g. if this was the dialout node, and there are still
1081 		 * processes waiting for carrier on the non-dialout node.
1082 		 */
1083 		cztty_shutdown(sc);
1084 	}
1085 
1086 	return (0);
1087 }
1088 
1089 /*
1090  * czttyread:
1091  *
1092  *	Read from a Cyclades-Z serial port.
1093  */
1094 int
1095 czttyread(dev_t dev, struct uio *uio, int flags)
1096 {
1097 	struct cztty_softc *sc = CZTTY_SOFTC(dev);
1098 	struct tty *tp = sc->sc_tty;
1099 
1100 	return ((*linesw[tp->t_line].l_read)(tp, uio, flags));
1101 }
1102 
1103 /*
1104  * czttywrite:
1105  *
1106  *	Write to a Cyclades-Z serial port.
1107  */
1108 int
1109 czttywrite(dev_t dev, struct uio *uio, int flags)
1110 {
1111 	struct cztty_softc *sc = CZTTY_SOFTC(dev);
1112 	struct tty *tp = sc->sc_tty;
1113 
1114 	return ((*linesw[tp->t_line].l_write)(tp, uio, flags));
1115 }
1116 
1117 /*
1118  * czttyioctl:
1119  *
1120  *	Perform a control operation on a Cyclades-Z serial port.
1121  */
1122 int
1123 czttyioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct proc *p)
1124 {
1125 	struct cztty_softc *sc = CZTTY_SOFTC(dev);
1126 	struct tty *tp = sc->sc_tty;
1127 	int s, error;
1128 
1129 	error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, p);
1130 	if (error >= 0)
1131 		return (error);
1132 
1133 	error = ttioctl(tp, cmd, data, flag, p);
1134 	if (error >= 0)
1135 		return (error);
1136 
1137 	error = 0;
1138 
1139 	s = spltty();
1140 
1141 	switch (cmd) {
1142 	case TIOCSBRK:
1143 		cztty_break(sc, 1);
1144 		break;
1145 
1146 	case TIOCCBRK:
1147 		cztty_break(sc, 0);
1148 		break;
1149 
1150 	case TIOCGFLAGS:
1151 		*(int *)data = sc->sc_swflags;
1152 		break;
1153 
1154 	case TIOCSFLAGS:
1155 		error = suser(p);
1156 		if (error)
1157 			break;
1158 		sc->sc_swflags = *(int *)data;
1159 		break;
1160 
1161 	case TIOCSDTR:
1162 		cztty_modem(sc, 1);
1163 		break;
1164 
1165 	case TIOCCDTR:
1166 		cztty_modem(sc, 0);
1167 		break;
1168 
1169 	case TIOCMSET:
1170 	case TIOCMBIS:
1171 	case TIOCMBIC:
1172 		tiocm_to_cztty(sc, cmd, *(int *)data);
1173 		break;
1174 
1175 	case TIOCMGET:
1176 		*(int *)data = cztty_to_tiocm(sc);
1177 		break;
1178 
1179 	default:
1180 		error = ENOTTY;
1181 		break;
1182 	}
1183 
1184 	splx(s);
1185 
1186 	return (error);
1187 }
1188 
1189 /*
1190  * cztty_break:
1191  *
1192  *	Set or clear BREAK on a port.
1193  */
1194 void
1195 cztty_break(struct cztty_softc *sc, int onoff)
1196 {
1197 	struct cz_softc *cz = CZTTY_CZ(sc);
1198 
1199 	cz_wait_pci_doorbell(cz, "czbreak");
1200 
1201 	CZ_FWCTL_WRITE(cz, BRDCTL_HCMD_CHANNEL, sc->sc_channel);
1202 	CZ_PLX_WRITE(cz, PLX_PCI_LOCAL_DOORBELL,
1203 	    onoff ? C_CM_SET_BREAK : C_CM_CLR_BREAK);
1204 }
1205 
1206 /*
1207  * cztty_modem:
1208  *
1209  *	Set or clear DTR on a port.
1210  */
1211 void
1212 cztty_modem(struct cztty_softc *sc, int onoff)
1213 {
1214 	struct cz_softc *cz = CZTTY_CZ(sc);
1215 
1216 	if (sc->sc_rs_control_dtr == 0)
1217 		return;
1218 
1219 	cz_wait_pci_doorbell(cz, "czmod");
1220 
1221 	if (onoff)
1222 		sc->sc_chanctl_rs_control |= sc->sc_rs_control_dtr;
1223 	else
1224 		sc->sc_chanctl_rs_control &= ~sc->sc_rs_control_dtr;
1225 	CZTTY_CHAN_WRITE(sc, CHNCTL_RS_CONTROL, sc->sc_chanctl_rs_control);
1226 
1227 	CZ_FWCTL_WRITE(cz, BRDCTL_HCMD_CHANNEL, sc->sc_channel);
1228 	CZ_PLX_WRITE(cz, PLX_PCI_LOCAL_DOORBELL, C_CM_IOCTLM);
1229 }
1230 
1231 /*
1232  * tiocm_to_cztty:
1233  *
1234  *	Process TIOCM* ioctls.
1235  */
1236 void
1237 tiocm_to_cztty(struct cztty_softc *sc, u_long how, int ttybits)
1238 {
1239 	struct cz_softc *cz = CZTTY_CZ(sc);
1240 	u_int32_t czttybits;
1241 
1242 	czttybits = 0;
1243 	if (ISSET(ttybits, TIOCM_DTR))
1244 		SET(czttybits, C_RS_DTR);
1245 	if (ISSET(ttybits, TIOCM_RTS))
1246 		SET(czttybits, C_RS_RTS);
1247 
1248 	cz_wait_pci_doorbell(cz, "cztiocm");
1249 
1250 	switch (how) {
1251 	case TIOCMBIC:
1252 		CLR(sc->sc_chanctl_rs_control, czttybits);
1253 		break;
1254 
1255 	case TIOCMBIS:
1256 		SET(sc->sc_chanctl_rs_control, czttybits);
1257 		break;
1258 
1259 	case TIOCMSET:
1260 		CLR(sc->sc_chanctl_rs_control, C_RS_DTR | C_RS_RTS);
1261 		SET(sc->sc_chanctl_rs_control, czttybits);
1262 		break;
1263 	}
1264 
1265 	CZTTY_CHAN_WRITE(sc, CHNCTL_RS_CONTROL, sc->sc_chanctl_rs_control);
1266 
1267 	CZ_FWCTL_WRITE(cz, BRDCTL_HCMD_CHANNEL, sc->sc_channel);
1268 	CZ_PLX_WRITE(cz, PLX_PCI_LOCAL_DOORBELL, C_CM_IOCTLM);
1269 }
1270 
1271 /*
1272  * cztty_to_tiocm:
1273  *
1274  *	Process the TIOCMGET ioctl.
1275  */
1276 int
1277 cztty_to_tiocm(struct cztty_softc *sc)
1278 {
1279 	struct cz_softc *cz = CZTTY_CZ(sc);
1280 	u_int32_t rs_status, op_mode;
1281 	int ttybits = 0;
1282 
1283 	cz_wait_pci_doorbell(cz, "cztty");
1284 
1285 	rs_status = CZTTY_CHAN_READ(sc, CHNCTL_RS_STATUS);
1286 	op_mode = CZTTY_CHAN_READ(sc, CHNCTL_OP_MODE);
1287 
1288 	if (ISSET(rs_status, C_RS_RTS))
1289 		SET(ttybits, TIOCM_RTS);
1290 	if (ISSET(rs_status, C_RS_CTS))
1291 		SET(ttybits, TIOCM_CTS);
1292 	if (ISSET(rs_status, C_RS_DCD))
1293 		SET(ttybits, TIOCM_CAR);
1294 	if (ISSET(rs_status, C_RS_DTR))
1295 		SET(ttybits, TIOCM_DTR);
1296 	if (ISSET(rs_status, C_RS_RI))
1297 		SET(ttybits, TIOCM_RNG);
1298 	if (ISSET(rs_status, C_RS_DSR))
1299 		SET(ttybits, TIOCM_DSR);
1300 
1301 	if (ISSET(op_mode, C_CH_ENABLE))
1302 		SET(ttybits, TIOCM_LE);
1303 
1304 	return (ttybits);
1305 }
1306 
1307 /*
1308  * czttyparam:
1309  *
1310  *	Set Cyclades-Z serial port parameters from termios.
1311  *
1312  *	XXX Should just copy the whole termios after making
1313  *	XXX sure all the changes could be done.
1314  */
1315 int
1316 czttyparam(struct tty *tp, struct termios *t)
1317 {
1318 	struct cztty_softc *sc = CZTTY_SOFTC(tp->t_dev);
1319 	struct cz_softc *cz = CZTTY_CZ(sc);
1320 	u_int32_t rs_status;
1321 	int ospeed, cflag;
1322 
1323 	ospeed = t->c_ospeed;
1324 	cflag = t->c_cflag;
1325 
1326 	/* Check requested parameters. */
1327 	if (ospeed < 0)
1328 		return (EINVAL);
1329 	if (t->c_ispeed && t->c_ispeed != ospeed)
1330 		return (EINVAL);
1331 
1332 	if (ISSET(sc->sc_swflags, TIOCFLAG_SOFTCAR)) {
1333 		SET(cflag, CLOCAL);
1334 		CLR(cflag, HUPCL);
1335 	}
1336 
1337 	/*
1338 	 * If there were no changes, don't do anything.  This avoids dropping
1339 	 * input and improves performance when all we did was frob things like
1340 	 * VMIN and VTIME.
1341 	 */
1342 	if (tp->t_ospeed == ospeed &&
1343 	    tp->t_cflag == cflag)
1344 		return (0);
1345 
1346 	/* Data bits. */
1347 	sc->sc_chanctl_comm_data_l = 0;
1348 	switch (t->c_cflag & CSIZE) {
1349 	case CS5:
1350 		sc->sc_chanctl_comm_data_l |= C_DL_CS5;
1351 		break;
1352 
1353 	case CS6:
1354 		sc->sc_chanctl_comm_data_l |= C_DL_CS6;
1355 		break;
1356 
1357 	case CS7:
1358 		sc->sc_chanctl_comm_data_l |= C_DL_CS7;
1359 		break;
1360 
1361 	case CS8:
1362 		sc->sc_chanctl_comm_data_l |= C_DL_CS8;
1363 		break;
1364 	}
1365 
1366 	/* Stop bits. */
1367 	if (t->c_cflag & CSTOPB) {
1368 		if ((sc->sc_chanctl_comm_data_l & C_DL_CS) == C_DL_CS5)
1369 			sc->sc_chanctl_comm_data_l |= C_DL_15STOP;
1370 		else
1371 			sc->sc_chanctl_comm_data_l |= C_DL_2STOP;
1372 	} else
1373 		sc->sc_chanctl_comm_data_l |= C_DL_1STOP;
1374 
1375 	/* Parity. */
1376 	if (t->c_cflag & PARENB) {
1377 		if (t->c_cflag & PARODD)
1378 			sc->sc_chanctl_comm_parity = C_PR_ODD;
1379 		else
1380 			sc->sc_chanctl_comm_parity = C_PR_EVEN;
1381 	} else
1382 		sc->sc_chanctl_comm_parity = C_PR_NONE;
1383 
1384 	/*
1385 	 * Initialize flow control pins depending on the current flow control
1386 	 * mode.
1387 	 */
1388 	if (ISSET(t->c_cflag, CRTSCTS)) {
1389 		sc->sc_rs_control_dtr = C_RS_DTR;
1390 		sc->sc_chanctl_hw_flow = C_RS_CTS | C_RS_RTS;
1391 	} else if (ISSET(t->c_cflag, MDMBUF)) {
1392 		sc->sc_rs_control_dtr = 0;
1393 		sc->sc_chanctl_hw_flow = C_RS_DCD | C_RS_DTR;
1394 	} else {
1395 		/*
1396 		 * If no flow control, then always set RTS.  This will make
1397 		 * the other side happy if it mistakenly thinks we're doing
1398 		 * RTS/CTS flow control.
1399 		 */
1400 		sc->sc_rs_control_dtr = C_RS_DTR | C_RS_RTS;
1401 		sc->sc_chanctl_hw_flow = 0;
1402 		if (ISSET(sc->sc_chanctl_rs_control, C_RS_DTR))
1403 			SET(sc->sc_chanctl_rs_control, C_RS_RTS);
1404 		else
1405 			CLR(sc->sc_chanctl_rs_control, C_RS_RTS);
1406 	}
1407 
1408 	/* Baud rate. */
1409 	sc->sc_chanctl_comm_baud = ospeed;
1410 
1411 	/* Copy to tty. */
1412 	tp->t_ispeed =  0;
1413 	tp->t_ospeed = t->c_ospeed;
1414 	tp->t_cflag = t->c_cflag;
1415 
1416 	/*
1417 	 * Now load the channel control structure.
1418 	 */
1419 
1420 	cz_wait_pci_doorbell(cz, "czparam");
1421 
1422 	CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_BAUD, sc->sc_chanctl_comm_baud);
1423 	CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_DATA_L, sc->sc_chanctl_comm_data_l);
1424 	CZTTY_CHAN_WRITE(sc, CHNCTL_COMM_PARITY, sc->sc_chanctl_comm_parity);
1425 	CZTTY_CHAN_WRITE(sc, CHNCTL_HW_FLOW, sc->sc_chanctl_hw_flow);
1426 	CZTTY_CHAN_WRITE(sc, CHNCTL_RS_CONTROL, sc->sc_chanctl_rs_control);
1427 
1428 	CZ_FWCTL_WRITE(cz, BRDCTL_HCMD_CHANNEL, sc->sc_channel);
1429 	CZ_PLX_WRITE(cz, PLX_PCI_LOCAL_DOORBELL, C_CM_IOCTLW);
1430 
1431 	cz_wait_pci_doorbell(cz, "czparam");
1432 
1433 	CZ_FWCTL_WRITE(cz, BRDCTL_HCMD_CHANNEL, sc->sc_channel);
1434 	CZ_PLX_WRITE(cz, PLX_PCI_LOCAL_DOORBELL, C_CM_IOCTLM);
1435 
1436 	cz_wait_pci_doorbell(cz, "czparam");
1437 
1438 	/*
1439 	 * Update the tty layer's idea of the carrier bit, in case we changed
1440 	 * CLOCAL.  We don't hang up here; we only do that by explicit
1441 	 * request.
1442 	 */
1443 	rs_status = CZTTY_CHAN_READ(sc, CHNCTL_RS_STATUS);
1444 	(void) (*linesw[tp->t_line].l_modem)(tp, ISSET(rs_status, C_RS_DCD));
1445 
1446 	return (0);
1447 }
1448 
1449 /*
1450  * czttystart:
1451  *
1452  *	Start or restart transmission.
1453  */
1454 void
1455 czttystart(struct tty *tp)
1456 {
1457 	struct cztty_softc *sc = CZTTY_SOFTC(tp->t_dev);
1458 	int s;
1459 
1460 	s = spltty();
1461 	if (ISSET(tp->t_state, TS_BUSY | TS_TIMEOUT | TS_TTSTOP))
1462 		goto out;
1463 
1464 	ttwakeupwr(tp);
1465 	if (tp->t_outq.c_cc == 0)
1466 		goto out;
1467 
1468 	cztty_transmit(sc, tp);
1469  out:
1470 	splx(s);
1471 }
1472 
1473 /*
1474  * czttystop:
1475  *
1476  *	Stop output, e.g., for ^S or output flush.
1477  */
1478 int
1479 czttystop(struct tty *tp, int flag)
1480 {
1481 
1482 	/*
1483 	 * XXX We don't do anything here, yet.  Mostly, I don't know
1484 	 * XXX exactly how this should be implemented on this device.
1485 	 * XXX We've given a big chunk of data to the MIPS already,
1486 	 * XXX and I don't know how we request the MIPS to stop sending
1487 	 * XXX the data.  So, punt for now.  --thorpej
1488 	 */
1489 	return (0);
1490 }
1491 
1492 /*
1493  * cztty_diag:
1494  *
1495  *	Issue a scheduled diagnostic message.
1496  */
1497 void
1498 cztty_diag(void *arg)
1499 {
1500 	struct cztty_softc *sc = arg;
1501 	struct cz_softc *cz = CZTTY_CZ(sc);
1502 	u_int overflows, parity_errors, framing_errors;
1503 	int s;
1504 
1505 	s = spltty();
1506 
1507 	overflows = sc->sc_overflows;
1508 	sc->sc_overflows = 0;
1509 
1510 	parity_errors = sc->sc_parity_errors;
1511 	sc->sc_parity_errors = 0;
1512 
1513 	framing_errors = sc->sc_framing_errors;
1514 	sc->sc_framing_errors = 0;
1515 
1516 	sc->sc_errors = 0;
1517 
1518 	splx(s);
1519 
1520 	log(LOG_WARNING,
1521 	    "%s: channel %d: %u overflow%s, %u parity, %u framing error%s\n",
1522 	    cz->cz_dev.dv_xname, sc->sc_channel,
1523 	    overflows, overflows == 1 ? "" : "s",
1524 	    parity_errors,
1525 	    framing_errors, framing_errors == 1 ? "" : "s");
1526 }
1527 
1528 /*
1529  * tx and rx ring buffer size macros:
1530  *
1531  * The transmitter and receiver both use ring buffers. For each one, there
1532  * is a get (consumer) and a put (producer) offset. The get value is the
1533  * next byte to be read from the ring, and the put is the next one to be
1534  * put into the ring.  get == put means the ring is empty.
1535  *
1536  * For each ring, the firmware controls one of (get, put) and this driver
1537  * controls the other. For transmission, this driver updates put to point
1538  * past the valid data, and the firmware moves get as bytes are sent. Likewise
1539  * for receive, the driver controls put, and this driver controls get.
1540  */
1541 #define	TX_MOVEABLE(g, p, s)	(((g) > (p)) ? ((g) - (p) - 1) : ((s) - (p)))
1542 #define RX_MOVEABLE(g, p, s)	(((g) > (p)) ? ((s) - (g)) : ((p) - (g)))
1543 
1544 /*
1545  * cztty_transmit()
1546  *
1547  * Look at the tty for this port and start sending.
1548  */
1549 int
1550 cztty_transmit(struct cztty_softc *sc, struct tty *tp)
1551 {
1552 	struct cz_softc *cz = CZTTY_CZ(sc);
1553 	u_int move, get, put, size, address;
1554 #ifdef HOSTRAMCODE
1555 	int error, done = 0;
1556 #else
1557 	int done = 0;
1558 #endif
1559 
1560 	size	= CZTTY_BUF_READ(sc, BUFCTL_TX_BUFSIZE);
1561 	get	= CZTTY_BUF_READ(sc, BUFCTL_TX_GET);
1562 	put	= CZTTY_BUF_READ(sc, BUFCTL_TX_PUT);
1563 	address	= CZTTY_BUF_READ(sc, BUFCTL_TX_BUFADDR);
1564 
1565 	while ((tp->t_outq.c_cc > 0) && ((move = TX_MOVEABLE(get, put, size)))){
1566 #ifdef HOSTRAMCODE
1567 		if (0) {
1568 			move = min(tp->t_outq.c_cc, move);
1569 			error = q_to_b(&tp->t_outq, 0, move);
1570 			if (error != move) {
1571 				printf("%s: channel %d: error moving to "
1572 				    "transmit buf\n", cz->cz_dev.dv_xname,
1573 				    sc->sc_channel);
1574 				move = error;
1575 			}
1576 		} else {
1577 #endif
1578 			move = min(ndqb(&tp->t_outq, 0), move);
1579 			bus_space_write_region_1(cz->cz_win_st, cz->cz_win_sh,
1580 			    address + put, tp->t_outq.c_cf, move);
1581 			ndflush(&tp->t_outq, move);
1582 #ifdef HOSTRAMCODE
1583 		}
1584 #endif
1585 
1586 		put = ((put + move) % size);
1587 		done = 1;
1588 	}
1589 	if (done) {
1590 		CZTTY_BUF_WRITE(sc, BUFCTL_TX_PUT, put);
1591 	}
1592 	return (done);
1593 }
1594 
1595 int
1596 cztty_receive(struct cztty_softc *sc, struct tty *tp)
1597 {
1598 	struct cz_softc *cz = CZTTY_CZ(sc);
1599 	u_int get, put, size, address;
1600 	int done = 0, ch;
1601 
1602 	size	= CZTTY_BUF_READ(sc, BUFCTL_RX_BUFSIZE);
1603 	get	= CZTTY_BUF_READ(sc, BUFCTL_RX_GET);
1604 	put	= CZTTY_BUF_READ(sc, BUFCTL_RX_PUT);
1605 	address	= CZTTY_BUF_READ(sc, BUFCTL_RX_BUFADDR);
1606 
1607 	while ((get != put) && ((tp->t_canq.c_cc + tp->t_rawq.c_cc) < tp->t_hiwat)) {
1608 #ifdef HOSTRAMCODE
1609 		if (hostram)
1610 			ch = ((char *)fifoaddr)[get];
1611 		} else {
1612 #endif
1613 			ch = bus_space_read_1(cz->cz_win_st, cz->cz_win_sh,
1614 			    address + get);
1615 #ifdef HOSTRAMCODE
1616 		}
1617 #endif
1618 		(*linesw[tp->t_line].l_rint)(ch, tp);
1619 		get = (get + 1) % size;
1620 		done = 1;
1621 	}
1622 	if (done) {
1623 		CZTTY_BUF_WRITE(sc, BUFCTL_RX_GET, get);
1624 	}
1625 	return (done);
1626 }
1627