share/man/man4/cy.4

   1 .\"     $NetBSD: cy.4,v 1.7 2001/09/11 00:08:25 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997 Jason R. Thorpe.  All rights reserved.
   4 .\" Copyright (c) 1993 Andrew Herbert.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. The name Andrew Herbert may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .Dd November 10, 1997
  30 .Dt CY 4
  31 .Os
  32 .Sh NAME
  33 .Nm cy
  34 .Nd
  35 Cyclades Cyclom-{4, 8, 16, 32}Y asynchronous comms board serial device driver
  36 .Sh SYNOPSIS
  37 .Cd "cy0 at isa? iomem 0xd4000 irq 12"
  38 .Cd "cy* at pci? dev ? function ?"
  39 .Sh DESCRIPTION
  40 This driver provides an interface to Cyclades Cyclom-4Y, Cyclom-8Y,
  41 Cyclom-16Y, and Cyclom-32Y asynchronous multiport serial boards.  These
  42 boards are based around Cirrus Logic CD1400 communication controllers.
  43 .Pp
  44 The device minor numbers for this driver are encoded as follows:
  45 .Pp
  46 .Bd -literal
  47     d c c p p p p p     - bits in the minor device number
  48
  49     bits    meaning
  50     ----    -------
  51     ppppp   physical serial line (i.e. port) to use:
  52                 0-3 on Cyclom-4Y
  53                 0-7 on Cyclom-8Y
  54                 0-15 on Cyclom-16Y
  55                 0-31 on Cyclom-32Y
  56
  57     cc      card unit number; note this limits the driver to
  58             four cards per system
  59
  60     d       set to use as a dial-out line
  61 .Ed
  62 .Sh FLOW CONTROL
  63 The
  64 .Nm
  65 driver makes use of the CD1400's automatic CTS flow control.  In addition,
  66 the CD1400's automatic input flow control can be used.  This requires the
  67 kernel configuration option
  68 .Em CY_HW_RTS
  69 and a special cable that exchanges the RTS and DTR lines.
  70 .Sh DIAGNOSTICS
  71 .Bl -diag
  72 .It "cy%d: port %d: can't allocate tty"
  73 There is not enough memory to allocate tty data structures.
  74 .It "cy%d: can't allocate input buffer"
  75 There is not enough memory to allocate the data input buffer.
  76 .El
  77 .Pp
  78 Additional debugging output can be enable with the kernel configuration
  79 option
  80 .Em CY_DEBUG .
  81 Diagnostic counters may be enabled with the kernel configuration option
  82 .Em CY_DEBUG1 .
  83 .Sh SEE ALSO
  84 .Xr termios 4 ,
  85 .Xr tty 4
  86 .Sh AUTHORS
  87 The
  88 .Nm
  89 driver was written by Timmo Rossi.
  90 .Sh BUGS
  91 Support for the Cyclom-32Y has not been tested.