1.\" $OpenBSD: cz.4,v 1.4 2001/10/05 14:45:53 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. 58Communication with the MIPS is performed by modifying data structures located 59in board local 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. 65The serial ports are provided by an octopus cable. 66.It 67Cyclades-8Zo rev. 2 -- This is the newer 8-port board. 68The serial ports are provided by an octopus cable. 69.It 70Cyclades-Ze -- This is the expandable version of the Cyclades-Z. 71It uses an HD-50 SCSI cable to connect the board to a 1U rack mountable serial 72expansion box. 73Each box has 16 RJ45 serial ports, and up to 4 boxes may be chained together, 74for a total of 64 ports. 75Boxes 3 and 4 require their own external power supply, otherwise the firmware 76will refuse to start (as it cannot communicate with the UARTs in those boxes). 77.El 78.Pp 79The Cyclades-Z has several features to improve performance under 80high serial I/O load: 81.Bl -bullet -offset indent 82.It 83The board may operate in interrupt-driven mode or polled mode to reduce 84interrupt load. 85.It 86Each channel has a large input and output buffer. 87.It 88Each channel may be programmed to generate an interrupt based on 89reception of a specific character, e.g. a PPP End-Of-Frame character. 90.It 91The MIPS CPU on the board performs all flow-control handling. 92.El 93.Sh FILES 94.Bl -tag -width Pa -compact 95.It Pa /dev/ttyZ?? -- dial-in (normal) TTY device 96.It Pa /dev/cuaZ?? -- dial-out TTY device 97.El 98.\" .Sh DIAGNOSTICS 99.\" XXX too be done. 100.Sh SEE ALSO 101.Xr pci 4 , 102.Xr termios 4 , 103.Xr tty 4 104.Sh HISTORY 105The 106.Nm 107driver first appeared in 108.Ox 3.0 . 109.Sh BUGS 110The 111.Nm 112driver does not currently implement communication via host RAM. 113While this may improve performance by reducing the number of PCI memory 114space read/write cycles, it is not straightforward to implement with 115the current 116.Xr bus_dma 9 117API. 118.Pp 119Interrupt mode has not been tested. 120.Pp 121There is no support for reading or writing the EEPROM connected to 122the PLX PCI bus controller. 123.Sh AUTHORS 124The 125.Nm 126driver was written by 127.An Jason R. Thorpe Aq thorpej@zembu.com 128and 129.An Bill Studenmund Aq wrstuden@zembu.com 130of Zembu Labs, Inc. 131