xref: /netbsd-src/share/man/man4/cz.4 (revision 6cb10275d08f045e872662c371fe2f2724f2f6e6)
1*6cb10275Sriastradh.\"	$NetBSD: cz.4,v 1.7 2014/03/18 18:20:39 riastradh Exp $
26c7c329bSthorpej.\"
36c7c329bSthorpej.\" Copyright (c) 2000 Zembu Labs, Inc.
46c7c329bSthorpej.\" All rights reserved.
56c7c329bSthorpej.\"
66c7c329bSthorpej.\" Author: Jason R. Thorpe <thorpej@zembu.com>
76c7c329bSthorpej.\"
86c7c329bSthorpej.\" Redistribution and use in source and binary forms, with or without
96c7c329bSthorpej.\" modification, are permitted provided that the following conditions
106c7c329bSthorpej.\" are met:
116c7c329bSthorpej.\" 1. Redistributions of source code must retain the above copyright
126c7c329bSthorpej.\"    notice, this list of conditions and the following disclaimer.
136c7c329bSthorpej.\" 2. Redistributions in binary form must reproduce the above copyright
146c7c329bSthorpej.\"    notice, this list of conditions and the following disclaimer in the
156c7c329bSthorpej.\"    documentation and/or other materials provided with the distribution.
166c7c329bSthorpej.\" 3. All advertising materials mentioning features or use of this software
176c7c329bSthorpej.\"    must display the following acknowledgement:
186c7c329bSthorpej.\"        This product includes software developed by Zembu Labs, Inc.
196c7c329bSthorpej.\" 4. Neither the name of Zembu Labs nor the names of its employees may
206c7c329bSthorpej.\"    be used to endorse or promote products derived from this software
216c7c329bSthorpej.\"    without specific prior written permission.
226c7c329bSthorpej.\"
236c7c329bSthorpej.\" THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS
246c7c329bSthorpej.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR-
256c7c329bSthorpej.\" RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS-
266c7c329bSthorpej.\" CLAIMED.  IN NO EVENT SHALL ZEMBU LABS BE LIABLE FOR ANY DIRECT, INDIRECT,
276c7c329bSthorpej.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
286c7c329bSthorpej.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
296c7c329bSthorpej.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
306c7c329bSthorpej.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
316c7c329bSthorpej.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
326c7c329bSthorpej.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
336c7c329bSthorpej.\"
346c7c329bSthorpej.Dd May 17, 2000
356c7c329bSthorpej.Dt CZ 4
366c7c329bSthorpej.Os
376c7c329bSthorpej.Sh NAME
386c7c329bSthorpej.Nm cz
396c7c329bSthorpej.Nd Cyclades-Z series multi-port serial adapter device driver
406c7c329bSthorpej.Sh SYNOPSIS
416c7c329bSthorpej.Cd "cz* at pci? dev ? function ?"
426c7c329bSthorpej.Sh DESCRIPTION
436c7c329bSthorpejThe
446c7c329bSthorpej.Nm
456c7c329bSthorpejdevice driver supports the Cyclades-Z series of multi-port serial adapters.
46ccb6f405SwizThe Cyclades-Z is an intelligent serial controller comprising:
476c7c329bSthorpej.Bl -bullet -offset indent
486c7c329bSthorpej.It
496c7c329bSthorpejPLX9060ES PCI bus interface
506c7c329bSthorpej.It
516c7c329bSthorpejXilinx XC5204 FPGA
526c7c329bSthorpej.It
536c7c329bSthorpejIDT R3052 MIPS CPU
546c7c329bSthorpej.El
556c7c329bSthorpej.Pp
566c7c329bSthorpejThe MIPS CPU runs firmware provided by the device driver.  Communication
576c7c329bSthorpejwith the MIPS is performed by modifying data structures located in board
586c7c329bSthorpejlocal RAM or host RAM.
596c7c329bSthorpej.Pp
606c7c329bSthorpejThe Cyclades-Z comes in three basic flavors:
616c7c329bSthorpej.Bl -bullet -offset indent
626c7c329bSthorpej.It
636c7c329bSthorpejCyclades-8Zo rev. 1 -- This is an older 8-port board with no FPGA.  The
646c7c329bSthorpejserial ports are provided by an octopus cable.
656c7c329bSthorpej.It
666c7c329bSthorpejCyclades-8Zo rev. 2 -- This is the newer 8-port board.  The serial ports
676c7c329bSthorpejare provided by an octopus cable.
686c7c329bSthorpej.It
696c7c329bSthorpejCyclades-Ze -- This is the expandable version of the Cyclades-Z.  It uses
706c7c329bSthorpejan HD-50 SCSI cable to connect the board to a 1U rack mountable serial
716c7c329bSthorpejexpansion box.  Each box has 16 RJ45 serial ports, and up to 4 boxes may
726c7c329bSthorpejbe chained together, for a total of 64 ports.  Boxes 3 and 4 require their
7329a0f47fSwizown external power supply, otherwise the firmware will refuse to start
746c7c329bSthorpej(as it cannot communicate with the UARTs in those boxes).
756c7c329bSthorpej.El
766c7c329bSthorpej.Pp
776c7c329bSthorpejThe Cyclades-Z has several features to improve performance under
786c7c329bSthorpejhigh serial I/O load:
796c7c329bSthorpej.Bl -bullet -offset indent
806c7c329bSthorpej.It
816c7c329bSthorpejThe board may operate in interrupt-driven mode or polled mode to reduce
826c7c329bSthorpejinterrupt load.
836c7c329bSthorpej.It
846c7c329bSthorpejEach channel has a large input and output buffer.
856c7c329bSthorpej.It
866c7c329bSthorpejEach channel may be programmed to generate an interrupt based on
876c7c329bSthorpejreception of a specific character, e.g. a PPP End-Of-Frame character.
886c7c329bSthorpej.It
896c7c329bSthorpejThe MIPS CPU on the board performs all flow-control handling.
906c7c329bSthorpej.El
916c7c329bSthorpej.Sh FILES
926c7c329bSthorpej.Bl -tag -width Pa -compact
936c7c329bSthorpej.It Pa /dev/ttyCZnnnn -- dial-in (normal) TTY device
946c7c329bSthorpej.It Pa /dev/dtyCZnnnn -- dial-out TTY device
956c7c329bSthorpej.El
966c7c329bSthorpej.\" .Sh DIAGNOSTICS
976c7c329bSthorpej.\" XXX too be done.
986c7c329bSthorpej.Sh SEE ALSO
996c7c329bSthorpej.Xr pci 4 ,
100022de488Swiz.Xr termios 4 ,
101022de488Swiz.Xr tty 4
1026c7c329bSthorpej.Sh HISTORY
1036c7c329bSthorpejThe
1046c7c329bSthorpej.Nm
1056c7c329bSthorpejdriver first appeared in
1066c7c329bSthorpej.Nx 1.5 .
107022de488Swiz.Sh AUTHORS
108022de488SwizThe
109022de488Swiz.Nm
110022de488Swizdriver was written by
111a5684d07Swiz.An Jason R. Thorpe Aq Mt thorpej@zembu.com
112022de488Swizand
113a5684d07Swiz.An Bill Studenmund Aq Mt wrstuden@zembu.com
114022de488Swizof Zembu Labs, Inc.
1156c7c329bSthorpej.Sh BUGS
1166c7c329bSthorpejThe
1176c7c329bSthorpej.Nm
1186c7c329bSthorpejdriver does not currently implement communication via host RAM.  While
1196c7c329bSthorpejthis may improve performance by reducing the number of PCI memory
1206c7c329bSthorpejspace read/write cycles, it is not straightforward to implement with
1216c7c329bSthorpejthe current
1226c7c329bSthorpej.Xr bus_dma 9
1236c7c329bSthorpejAPI.
1246c7c329bSthorpej.Pp
1256c7c329bSthorpejInterrupt mode has not been tested.
1266c7c329bSthorpej.Pp
1276c7c329bSthorpejThere is no support for reading or writing the EEPROM connected to
1286c7c329bSthorpejthe PLX PCI bus controller.
129