Subject: kern/5478: No support for TC-400 or TC-800 multiport serial boards
To: None <gnats-bugs@gnats.netbsd.org>
From: Eric S. Hvozda <hvozda@ra.ack.org>
List: netbsd-bugs
Date: 05/21/1998 06:53:02
>Number:         5478
>Category:       kern
>Synopsis:       patch to add support for TC-400 or TC-800 multiport serial boards
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    kern-bug-people (Kernel Bug People)
>State:          open
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Thu May 21 04:05:01 1998
>Last-Modified:
>Originator:     
>Organization:
	Klub Kev
>Release:        NetBSD-1.3.1
>Environment:
System: NetBSD ra.ack.org 1.3.1 NetBSD 1.3.1 (RA_ATAPI) #2: Tue May 19 16:22:36 EDT 1998 hvozda@ra.ack.org:/usr/src/sys/arch/i386/compile/RA_ATAPI i386


>Description:
	There is no support for TC-400 or TC-800 multiport serial boards
>How-To-Repeat:
	Obtain a TC-400 or TC-800 multiport serial board from Byte Runner
	Technologies and discover that boca(4) doesn't do what is
	expected
>Fix:
	Jukka Marin has already written a driver for these boards; I
	am simply submitting it in hopes it makes the tree.

	The patch below includes Jukka's work, a small man page,
	and mods to the GENERIC kernel config file for the i386
	showing usage of the driver:

*** src/sys/dev/isa/tcom.c.dist	Mon May 18 18:46:47 1998
--- src/sys/dev/isa/tcom.c	Wed May 20 13:40:57 1998
***************
*** 0 ****
--- 1,234 ----
+ /*	$NetBSD: tcom.c,v 1.1 1998/02/03 08:23:43 jmarin Exp $	*/
+ 
+ /*
+  * Copyright (c) 1998 Jukka Marin.  All rights reserved.
+  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
+  * Copyright (c) 1995 Charles Hannum.  All rights reserved.
+  *
+  * This code is derived from public-domain software written by
+  * Roland McGrath.
+  *
+  * Redistribution and use in source and binary forms, with or without
+  * modification, are permitted provided that the following conditions
+  * are met:
+  * 1. Redistributions of source code must retain the above copyright
+  *    notice, this list of conditions and the following disclaimer.
+  * 2. Redistributions in binary form must reproduce the above copyright
+  *    notice, this list of conditions and the following disclaimer in the
+  *    documentation and/or other materials provided with the distribution.
+  * 3. All advertising materials mentioning features or use of this software
+  *    must display the following acknowledgement:
+  *	This product includes software developed by Charles Hannum.
+  * 4. The name of the author may not be used to endorse or promote products
+  *    derived from this software without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  */
+ 
+ /*
+  * NOTE: This driver has been tested in TCOM "UNIX mode" with base address
+  * set to 0x100 or 0x200 and baud rate jumpers to "normal".  This code
+  * does NOT know about the 2x and 4x baud rates available on TCOM cards.
+  */
+ 
+ #include <sys/param.h>
+ #include <sys/systm.h>
+ #include <sys/device.h>
+ #include <sys/termios.h>
+ 
+ #include <machine/bus.h>
+ #include <machine/intr.h>
+ 
+ #include <dev/ic/comreg.h>
+ #include <dev/ic/comvar.h>
+ 
+ #include <dev/isa/isavar.h>
+ #include <dev/isa/com_multi.h>
+ 
+ #define	NSLAVES	8			/* TCOM cards have 4 or 8 UARTs */
+ #define STATUS_OFFSET	0x40		/* offset from board base address */
+ #define	STATUS_SIZE	8		/* 8 bytes reserved for irq status */
+ 
+ struct tcom_softc {
+ 	struct device sc_dev;
+ 	void *sc_ih;
+ 
+ 	bus_space_tag_t sc_iot;
+ 	int sc_iobase;
+ 
+ 	int sc_alive;			/* mask of slave units attached */
+ 	void *sc_slaves[NSLAVES];	/* com device unit numbers */
+ 	bus_space_handle_t sc_slaveioh[NSLAVES];
+ 	bus_space_handle_t sc_statusioh;
+ };
+ 
+ int tcomprobe __P((struct device *, void *, void *));
+ void tcomattach __P((struct device *, struct device *, void *));
+ int tcomintr __P((void *));
+ int tcomprint __P((void *, const char *));
+ 
+ struct cfattach tcom_ca = {
+ 	sizeof(struct tcom_softc), tcomprobe, tcomattach
+ };
+ 
+ struct cfdriver tcom_cd = {
+ 	NULL, "tcom", DV_TTY
+ };
+ 
+ int
+ tcomprobe(parent, self, aux)
+ 	struct device *parent;
+ 	void *self;
+ 	void *aux;
+ {
+ 	struct isa_attach_args *ia = aux;
+ 	int iobase = ia->ia_iobase;
+ 	bus_space_tag_t iot = ia->ia_iot;
+ 	bus_space_handle_t ioh;
+ 	int i, rv = 1;
+ 
+ 	/*
+ 	 * Do the normal com probe for the first UART and assume
+ 	 * its presence, and the ability to map the other UARTS,
+ 	 * means there is a multiport board there.
+ 	 * XXX Needs more robustness.
+ 	 */
+ 
+ 	/* Disallow wildcarded i/o address. */
+ 	if (ia->ia_iobase == ISACF_PORT_DEFAULT)
+ 		return (0);
+ 
+ 	/* if the first port is in use as console, then it. */
+ 	if (com_is_console(iot, iobase, 0))
+ 		goto checkmappings;
+ 
+ 	if (bus_space_map(iot, iobase, COM_NPORTS, 0, &ioh)) {
+ 		rv = 0;
+ 		goto out;
+ 	}
+ 	rv = comprobe1(iot, ioh, iobase);
+ 	bus_space_unmap(iot, ioh, COM_NPORTS);
+ 	if (rv == 0)
+ 		goto out;
+ 
+ checkmappings:
+ 	for (i = 1; i < NSLAVES; i++) {
+ 		iobase += COM_NPORTS;
+ 
+ 		if (com_is_console(iot, iobase, 0))
+ 			continue;
+ 
+ 		if (bus_space_map(iot, iobase, COM_NPORTS, 0, &ioh)) {
+ 			rv = 0;
+ 			goto out;
+ 		}
+ 		bus_space_unmap(iot, ioh, COM_NPORTS);
+ 	}
+ 
+ out:
+ 	if (rv)
+ 		ia->ia_iosize = NSLAVES * COM_NPORTS;
+ 	return (rv);
+ }
+ 
+ int
+ tcomprint(aux, pnp)
+ 	void *aux;
+ 	const char *pnp;
+ {
+ 	struct commulti_attach_args *ca = aux;
+ 
+ 	if (pnp)
+ 		printf("com at %s", pnp);
+ 	printf(" slave %d", ca->ca_slave);
+ 	return (UNCONF);
+ }
+ 
+ void
+ tcomattach(parent, self, aux)
+ 	struct device *parent, *self;
+ 	void *aux;
+ {
+ 	struct tcom_softc *sc = (void *)self;
+ 	struct isa_attach_args *ia = aux;
+ 	struct commulti_attach_args ca;
+ 	bus_space_tag_t iot = ia->ia_iot;
+ 	int i, iobase;
+ 
+ 	printf("\n");
+ 
+ 	sc->sc_iot = ia->ia_iot;
+ 	sc->sc_iobase = ia->ia_iobase;
+ 
+ 	for (i = 0; i < NSLAVES; i++) {
+ 		iobase = sc->sc_iobase + i * COM_NPORTS;
+ 		if (!com_is_console(iot, iobase, &sc->sc_slaveioh[i]) &&
+ 		    bus_space_map(iot, iobase, COM_NPORTS, 0,
+ 			&sc->sc_slaveioh[i])) {
+ 			printf("%s: can't map i/o space for slave %d\n",
+ 			     sc->sc_dev.dv_xname, i);
+ 			return;
+ 		}
+ 	}
+ 
+ 	if (bus_space_map(iot, sc->sc_iobase + STATUS_OFFSET, STATUS_SIZE, 0, &sc->sc_statusioh)) {
+ 		printf("%s: can't map status space\n", sc->sc_dev.dv_xname);
+ 		return;
+ 	}
+ 
+ 	for (i = 0; i < NSLAVES; i++) {
+ 		ca.ca_slave = i;
+ 		ca.ca_iot = sc->sc_iot;
+ 		ca.ca_ioh = sc->sc_slaveioh[i];
+ 		ca.ca_iobase = sc->sc_iobase + i * COM_NPORTS;
+ 		ca.ca_noien = 0;
+ 
+ 		sc->sc_slaves[i] = config_found(self, &ca, tcomprint);
+ 		if (sc->sc_slaves[i] != NULL)
+ 			sc->sc_alive |= 1 << i;
+ 	}
+ 
+ 	sc->sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq, IST_EDGE,
+ 	    IPL_SERIAL, tcomintr, sc);
+ }
+ 
+ int
+ tcomintr(arg)
+ 	void *arg;
+ {
+ 	struct tcom_softc *sc = arg;
+ 	bus_space_tag_t iot = sc->sc_iot;
+ 	int alive = sc->sc_alive;
+ 	int bits;
+ 
+ 	bits = ~bus_space_read_1(iot, sc->sc_statusioh, 0) & alive;
+ 	if (bits == 0)
+ 		return (0);
+ 
+ 	for (;;) {
+ #define	TRY(n) \
+ 		if (bits & (1 << (n))) \
+ 			comintr(sc->sc_slaves[n]);
+ 		TRY(0);
+ 		TRY(1);
+ 		TRY(2);
+ 		TRY(3);
+ 		TRY(4);
+ 		TRY(5);
+ 		TRY(6);
+ 		TRY(7);
+ #undef TRY
+ 		bits = ~bus_space_read_1(iot, sc->sc_statusioh, 0) & alive;
+ 		if (bits == 0)
+ 			return (1);
+  	}
+ }
*** src/sys/dev/isa/files.isa.dist	Tue May 19 13:23:41 1998
--- src/sys/dev/isa/files.isa	Tue May 19 13:24:30 1998
***************
*** 29,34 ****
--- 29,39 ----
  attach	ast at isa
  file	dev/isa/ast.c			ast
  
+ # TC-800 8-port board
+ device	tcom: commulti
+ attach	tcom at isa
+ file	dev/isa/tcom.c			tcom
+ 
  # BOCA 8-port board
  device	boca: commulti
  attach	boca at isa
*** src/sys/arch/i386/conf/GENERIC.dist	Wed May 20 13:27:09 1998
--- src/sys/arch/i386/conf/GENERIC	Wed May 20 13:29:03 1998
***************
*** 202,207 ****
--- 202,209 ----
  #com3	at isa? port 0x2e8 irq 9
  #ast0	at isa? port 0x1a0 irq 5	# AST 4-port serial cards
  #com*	at ast? slave ?
+ #tcom0	at isa? port 0x100 irq 5	# TC-800 8-port serial cards
+ #com*	at tcom? slave ?
  #boca0	at isa? port 0x100 irq 5	# BOCA 8-port serial cards
  #com*	at boca? slave ?
  #rtfps0	at isa? port 0x1230 irq 10	# RT 4-port serial cards
*** src/share/man/man4/Makefile.dist	Wed May 20 13:30:09 1998
--- src/share/man/man4/Makefile	Wed May 20 13:30:27 1998
***************
*** 13,19 ****
  
  # machine-independent ISA devices
  MAN+=	aha.4 aic.4 ast.4 boca.4 cy.4 ec.4 eg.4 el.4 esp.4 gus.4 guspnp.4 \
! 	iy.4 mcd.4 pss.4 rtfps.4 sb.4 sea.4 wds.4 we.4 wss.4 wt.4
  
  MLINKS+=bha.4 bt.4
  MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4
--- 13,19 ----
  
  # machine-independent ISA devices
  MAN+=	aha.4 aic.4 ast.4 boca.4 cy.4 ec.4 eg.4 el.4 esp.4 gus.4 guspnp.4 \
! 	iy.4 mcd.4 pss.4 rtfps.4 sb.4 sea.4 tcom.4 wds.4 we.4 wss.4 wt.4
  
  MLINKS+=bha.4 bt.4
  MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4
*** src/share/man/man4/tcom.4.dist	Wed May 20 12:49:11 1998
--- src/share/man/man4/tcom.4	Wed May 20 13:13:40 1998
***************
*** 0 ****
--- 1,110 ----
+ .\"
+ .\" Copyright (c) 1990, 1991 The Regents of the University of California.
+ .\" All rights reserved.
+ .\"
+ .\" This code is derived from software contributed to Berkeley by
+ .\" the Systems Programming Group of the University of Utah Computer
+ .\" Science Department.
+ .\" Redistribution and use in source and binary forms, with or without
+ .\" modification, are permitted provided that the following conditions
+ .\" are met:
+ .\" 1. Redistributions of source code must retain the above copyright
+ .\"    notice, this list of conditions and the following disclaimer.
+ .\" 2. Redistributions in binary form must reproduce the above copyright
+ .\"    notice, this list of conditions and the following disclaimer in the
+ .\"    documentation and/or other materials provided with the distribution.
+ .\" 3. All advertising materials mentioning features or use of this software
+ .\"    must display the following acknowledgement:
+ .\"	This product includes software developed by the University of
+ .\"	California, Berkeley and its contributors.
+ .\" 4. Neither the name of the University nor the names of its contributors
+ .\"    may be used to endorse or promote products derived from this software
+ .\"    without specific prior written permission.
+ .\"
+ .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ .\" SUCH DAMAGE.
+ .\"
+ .\"     from: @(#)dca.4	5.2 (Berkeley) 3/27/91
+ .\"	from: Id: com.4,v 1.1 1993/08/06 11:19:07 cgd Exp
+ .\"
+ .Dd May 20, 1998
+ .Dt TCOM 4
+ .Os NetBSD 1.3.1
+ .Sh NAME
+ .Nm tcom
+ .Nd
+ multiplexing serial communications interface
+ .Sh SYNOPSIS
+ .Pp
+ For 4-port TC-400 series boards:
+ .Pp
+ .Cd "tcom0 at isa? port 0x100 irq 5"
+ .Cd "com2 at tcom? slave ?"
+ .Cd "com3 at tcom? slave ?"
+ .Cd "com4 at tcom? slave ?"
+ .Cd "com5 at tcom? slave ?"
+ .Pp
+ For 8-port TC-800 series boards:
+ .Pp
+ .Cd "tcom0 at isa? port 0x100 irq 5"
+ .Cd "com2 at tcom? slave ?"
+ .Cd "com3 at tcom? slave ?"
+ .Cd "com4 at tcom? slave ?"
+ .Cd "com5 at tcom? slave ?"
+ .Cd "com6 at tcom? slave ?"
+ .Cd "com7 at tcom? slave ?"
+ .Cd "com8 at tcom? slave ?"
+ .Cd "com9 at tcom? slave ?"
+ .Pp
+ .Sh DESCRIPTION
+ The
+ .Nm tcom
+ driver provides support for the Byte Runner Technologies TC-400 
+ and TC-800 series boards that multiplex together up to four or eight
+ .Tn EIA
+ .Tn RS-232C
+ .Pf ( Tn CCITT
+ .Tn V.28 )
+ communications interfaces.
+ .Pp
+ Each
+ .Nm
+ device is the master device for up to eight 
+ .Nm com
+ devices.  The kernel configuration specifies these
+ .Nm com
+ devices as slave devices of the
+ .Nm
+ device, as shown in the synopsis.  The slave ID given for each
+ .Nm com
+ device determines which bit in the interrupt multiplexing register is
+ tested to find interrupts for that device.
+ The
+ .Tn port
+ specification for the
+ .Nm
+ device is used to compute the base addresses for the
+ .Nm com
+ subdevices and the port for the interrupt multiplexing register.
+ .Pp
+ Not all possible configuration options are currently supported (for
+ example, speeds beyond 115200 baud are not currently supported).
+ .Sh FILES
+ .Bl -tag -width Pa
+ .It Pa /dev/tty??
+ .El
+ .Sh SEE ALSO
+ .Xr com 4
+ .Sh HISTORY
+ The
+ .Nm
+ driver was written by Jukka Marin.
>Audit-Trail:
>Unformatted: