share/man/man4/rc.4

   1 .\"
   2 .\" Copyright (c) 2004 Tom Rhodes
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd March 18, 2005
  29 .Dt RC 4
  30 .Os
  31 .Sh NAME
  32 .Nm rc
  33 .Nd RISCom/8 multiport card
  34 .Sh SYNOPSIS
  35 .Cd device isa
  36 .Cd device rc
  37 .Sh DESCRIPTION
  38 The
  39 .Tn RISCom/8
  40 is an eight port
  41 .Tn ISA
  42 .Tn RS-232C
  43 communications multiplexer with a built in
  44 .Tn RISC
  45 processor.
  46 It uses a block of sixteen
  47 .Tn I/O
  48 ports in the range 0x200 to 0x3f0 selectable by on-board
  49 switches or jumpers.
  50 The block must be aligned on a sixteen port boundary.
  51 The jumper-selectable hardware interrupt level may be set to
  52 be detected during system
  53 initialization using settings found in the
  54 .Pa /boot/device.hints
  55 file.
  56 .Pp
  57 This driver is mostly based on the Cirrus Logic CL-CD180 driver.
  58 .Sh HARDWARE
  59 The
  60 .Nm
  61 driver provides support for the
  62 .Tn SDL
  63 Communications
  64 .Tn RISCom/8
  65 boards.
  66 .Sh DIAGNOSTICS
  67 The following driver specific error messages
  68 may be reported:
  69 .Bl -diag
  70 .It "rc%d channel%d: interrupt-level buffer overflow"
  71 An internal buffer overflow error has occurred on
  72 the listed channel.
  73 The
  74 .Nm
  75 driver will need to be reloaded to correct this.
  76 .It "rc%d: Bad char chan %d"
  77 The channel has obtained a bad set of characters.
  78 .It "rc%d: Got extra chars chan %d"
  79 The
  80 .Nm
  81 driver got more characters than expected on the channel shown.
  82 .It "rc%d: data mismatch chan %d ptr %d (%d != %d)"
  83 Data sent from channel
  84 .Ar %d
  85 to the rx buffer was different then expected.
  86 .It "rc%d: channel %d command timeout, rc.c line: %d"
  87 A command timeout has occurred on the channel, the
  88 .Pa src/sys/dev/rc/rc.c
  89 file can be consulted for more information.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr tty 1 ,
  93 .Xr ttyname 3 ,
  94 .Xr sio 4 ,
  95 .Xr tty 4 ,
  96 .Xr device.hints 5 ,
  97 .Xr comcontrol 8 ,
  98 .Xr getty 8 ,
  99 .Xr mutex 9 ,
 100 .Xr splx 9
 101 .Pp
 102 .Pa http://www.sdlcomm.com
 103 .Sh HISTORY
 104 The
 105 .Nm
 106 driver first appeared in
 107 .Fx 2.0.5 .
 108 This manual page first appeared in
 109 .Fx 5.3 .
 110 .Sh AUTHORS
 111 This manual page was written by
 112 .An Tom Rhodes Aq trhodes@FreeBSD.org .
 113 .Sh BUGS
 114 The
 115 .Nm
 116 driver code still uses the
 117 .Xr spl 9
 118 functions.
 119 These should be replaced by
 120 .Xr mutex 9
 121 functions.
 122 .Pp
 123 The various
 124 .Fn ttyld_*
 125 functions should be documented.