share/man/man4/cz.4

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