1.\" $OpenBSD: cz.4,v 1.2 2001/06/22 11:39:21 mpech Exp $ 2.\" $NetBSD: cz.4,v 1.3 2001/06/12 14:46:11 wiz Exp $ 3.\" 4.\" Copyright (c) 2000 Zembu Labs, Inc. 5.\" All rights reserved. 6.\" 7.\" Author: Jason R. Thorpe <thorpej@zembu.com> 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by Zembu Labs, Inc. 20.\" 4. Neither the name of Zembu Labs nor the names of its employees may 21.\" be used to endorse or promote products derived from this software 22.\" without specific prior written permission. 23.\" 24.\" THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS 25.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR- 26.\" RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS- 27.\" CLAIMED. IN NO EVENT SHALL ZEMBU LABS BE LIABLE FOR ANY DIRECT, INDIRECT, 28.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 29.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 30.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 31.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 32.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 33.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34.\" 35.Dd May 17, 2000 36.Dt CZ 4 37.Os 38.Sh NAME 39.Nm cz 40.Nd Cyclades-Z series multi-port serial adapter device driver 41.Sh SYNOPSIS 42.Cd "cz* at pci? dev ? function ?" 43.Sh DESCRIPTION 44The 45.Nm 46device driver supports the Cyclades-Z series of multi-port serial adapters. 47The Cyclades-Z is an intelligent serial controller comprising: 48.Bl -bullet -offset indent 49.It 50PLX9060ES PCI bus interface 51.It 52Xilinx XC5204 FPGA 53.It 54IDT R3052 MIPS CPU 55.El 56.Pp 57The MIPS CPU runs firmware provided by the device driver. Communication 58with the MIPS is performed by modifying data structures located in board 59local RAM or host RAM. 60.Pp 61The Cyclades-Z comes in three basic flavors: 62.Bl -bullet -offset indent 63.It 64Cyclades-8Zo rev. 1 -- This is an older 8-port board with no FPGA. The 65serial ports are provided by an octopus cable. 66.It 67Cyclades-8Zo rev. 2 -- This is the newer 8-port board. The serial ports 68are provided by an octopus cable. 69.It 70Cyclades-Ze -- This is the expandable version of the Cyclades-Z. It uses 71an HD-50 SCSI cable to connect the board to a 1U rack mountable serial 72expansion box. Each box has 16 RJ45 serial ports, and up to 4 boxes may 73be chained together, for a total of 64 ports. Boxes 3 and 4 require their 74own external power supply, otherwise the firmware will refuse to start 75(as it cannot communicate with the UARTs in those boxes). 76.El 77.Pp 78The Cyclades-Z has several features to improve performance under 79high serial I/O load: 80.Bl -bullet -offset indent 81.It 82The board may operate in interrupt-driven mode or polled mode to reduce 83interrupt load. 84.It 85Each channel has a large input and output buffer. 86.It 87Each channel may be programmed to generate an interrupt based on 88reception of a specific character, e.g. a PPP End-Of-Frame character. 89.It 90The MIPS CPU on the board performs all flow-control handling. 91.El 92.Sh FILES 93.Bl -tag -width Pa -compact 94.It Pa /dev/ttyZ?? -- dial-in (normal) TTY device 95.It Pa /dev/cuaZ?? -- dial-out TTY device 96.El 97.\" .Sh DIAGNOSTICS 98.\" XXX too be done. 99.Sh SEE ALSO 100.Xr pci 4 , 101.Xr termios 4 , 102.Xr tty 4 103.Sh HISTORY 104The 105.Nm 106driver first appeared in 107.Nx 1.5 . 108.Sh BUGS 109The 110.Nm 111driver does not currently implement communication via host RAM. While 112this may improve performance by reducing the number of PCI memory 113space read/write cycles, it is not straightforward to implement with 114the current 115.Xr bus_dma 9 116API. 117.Pp 118Interrupt mode has not been tested. 119.Pp 120There is no support for reading or writing the EEPROM connected to 121the PLX PCI bus controller. 122.Sh AUTHORS 123The 124.Nm 125driver was written by 126.An Jason R. Thorpe Aq thorpej@zembu.com 127and 128.An Bill Studenmund Aq wrstuden@zembu.com 129of Zembu Labs, Inc. 130