[src/trunk]: src/share/man/man4 Manual page for the Cyclades-Z mutli-port ser...

[thorpej <thorpej%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/cddb1d5d3be3
branches:  trunk
changeset: 486282:cddb1d5d3be3
user:      thorpej <thorpej%NetBSD.org@localhost>
date:      Wed May 17 18:15:08 2000 +0000

description:
Manual page for the Cyclades-Z mutli-port serial adapter driver.

diffstat:

 share/man/man4/Makefile |    4 +-
 share/man/man4/cz.4     |  128 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 130 insertions(+), 2 deletions(-)

diffs (150 lines):

diff -r 917b1d11e612 -r cddb1d5d3be3 share/man/man4/Makefile
--- a/share/man/man4/Makefile   Wed May 17 18:14:10 2000 +0000
+++ b/share/man/man4/Makefile   Wed May 17 18:15:08 2000 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.154 2000/05/15 06:31:56 bouyer Exp $
+#      $NetBSD: Makefile,v 1.155 2000/05/17 18:15:08 thorpej Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   adv.4 adw.4 ahb.4 ahc.4 aria.4 atalk.4 audio.4 auvia.4 awi.4 bba.4 \
@@ -29,7 +29,7 @@
 MAN+=  eisa.4 isa.4 isapnp.4 pci.4 pcmcia.4
 
 # machine-independent PCI devices
-MAN+=  epic.4 lmc.4 viaenv.4
+MAN+=  cz.4 epic.4 lmc.4 viaenv.4
 
 # machine-independent ISA devices
 MAN+=  aha.4 ai.4 aic.4 ast.4 ate.4 boca.4 cs.4 cy.4 ec.4 ef.4 eg.4 el.4 \
diff -r 917b1d11e612 -r cddb1d5d3be3 share/man/man4/cz.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/cz.4       Wed May 17 18:15:08 2000 +0000
@@ -0,0 +1,128 @@
+.\"    $NetBSD: cz.4,v 1.1 2000/05/17 18:15:08 thorpej Exp $
+.\"
+.\" Copyright (c) 2000 Zembu Labs, Inc.
+.\" All rights reserved.
+.\"
+.\" Author: Jason R. Thorpe <thorpej%zembu.com@localhost>
+.\"
+.\" 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 Zembu Labs, Inc.
+.\" 4. Neither the name of Zembu Labs nor the names of its employees may
+.\"    be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS
+.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR-
+.\" RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS-
+.\" CLAIMED.  IN NO EVENT SHALL ZEMBU LABS 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.
+.\"
+.Dd May 17, 2000
+.Dt CZ 4
+.Os
+.Sh NAME
+.Nm cz
+.Nd Cyclades-Z series multi-port serial adapter device driver
+.Sh SYNOPSIS
+.Cd "cz* at pci? dev ? function ?"
+.Sh DESCRIPTION
+The
+.Nm
+device driver supports the Cyclades-Z series of multi-port serial adapters.
+The Cyclades-Z is an intelligent serial controller comprised of:
+.Bl -bullet -offset indent
+.It
+PLX9060ES PCI bus interface
+.It
+Xilinx XC5204 FPGA
+.It
+IDT R3052 MIPS CPU
+.El
+.Pp
+The MIPS CPU runs firmware provided by the device driver.  Communication
+with the MIPS is performed by modifying data structures located in board
+local RAM or host RAM.
+.Pp
+The Cyclades-Z comes in three basic flavors:
+.Bl -bullet -offset indent
+.It
+Cyclades-8Zo rev. 1 -- This is an older 8-port board with no FPGA.  The
+serial ports are provided by an octopus cable.
+.It
+Cyclades-8Zo rev. 2 -- This is the newer 8-port board.  The serial ports
+are provided by an octopus cable.
+.It
+Cyclades-Ze -- This is the expandable version of the Cyclades-Z.  It uses
+an HD-50 SCSI cable to connect the board to a 1U rack mountable serial
+expansion box.  Each box has 16 RJ45 serial ports, and up to 4 boxes may
+be chained together, for a total of 64 ports.  Boxes 3 and 4 require their
+own external power supply, otherwise the fimrware will refuse to start
+(as it cannot communicate with the UARTs in those boxes).
+.El
+.Pp
+The Cyclades-Z has several features to improve performance under
+high serial I/O load:
+.Bl -bullet -offset indent
+.It
+The board may operate in interrupt-driven mode or polled mode to reduce
+interrupt load.
+.It
+Each channel has a large input and output buffer.
+.It
+Each channel may be programmed to generate an interrupt based on
+reception of a specific character, e.g. a PPP End-Of-Frame character.
+.It
+The MIPS CPU on the board performs all flow-control handling.
+.El
+.Sh FILES
+.Bl -tag -width Pa -compact
+.It Pa /dev/ttyCZnnnn -- dial-in (normal) TTY device
+.It Pa /dev/dtyCZnnnn -- dial-out TTY device
+.El
+.\" .Sh DIAGNOSTICS
+.\" XXX too be done.
+.Sh SEE ALSO
+.Xr pci 4 ,
+.Xr tty 4 ,
+.Xr termios 4
+.Sh HISTORY
+The
+.Nm 
+driver first appeared in
+.Nx 1.5 .
+.Sh BUGS
+The
+.Nm
+driver does not currently implement communication via host RAM.  While
+this may improve performance by reducing the number of PCI memory
+space read/write cycles, it is not straightforward to implement with
+the current
+.Xr bus_dma 9
+API.
+.Pp
+Interrupt mode has not been tested.
+.Pp
+There is no support for reading or writing the EEPROM connected to
+the PLX PCI bus controller.
+.Sh AUTHOR
+The
+.Nm
+driver was written by
+.An Jason R. Thorpe Aq thorpej%zembu.com@localhost
+and
+.An Bill Studenmund Aq wrstuden%zembu.com@localhost
+of Zembu Labs, Inc.