share/man/man4/man4.i386/sr.4

   1 .\"
   2 .\" Copyright (c) 1996 John Hay.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"        This product includes software developed by John Hay.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY John Hay ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL John Hay BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd March 18, 2005
  34 .Dt SR 4 i386
  35 .Os
  36 .Sh NAME
  37 .Nm sr
  38 .Nd synchronous RISCom/N2 / WANic 400/405 device driver
  39 .Sh SYNOPSIS
  40 .Cd "device sr"
  41 .Pp
  42 For ISA cards, in
  43 .Pa /boot/device.hints :
  44 .Cd hint.sr.0.at="isa"
  45 .Cd hint.sr.0.port="0x300"
  46 .Cd hint.sr.0.irq="10"
  47 .Cd hint.sr.0.maddr="0xd0000"
  48 .Cd hint.sr.0.flags="0x0"
  49 .Pp
  50 .Cd "device sppp"
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver supports the RISCom/N2 ISA cards, N2pci and the WANic 400/405 PCI
  55 cards that are based on the HD64570 chip.
  56 .Pp
  57 If you have ISA cards, you need to specify the resources for them in
  58 .Pa /boot/device.hints .
  59 If you have the second ISA card, add
  60 .Pp
  61 .Dl hint.sr.1.at="isa"
  62 .Dl hint.sr.1.port="0x310"
  63 .Dl hint.sr.1.irq="11"
  64 .Dl hint.sr.1.maddr="0xd0000"
  65 .Dl hint.sr.1.flags="0x0"
  66 .Pp
  67 The standard
  68 .Fx
  69 sppp code is used for the link level layer.
  70 The
  71 default protocol used is PPP.
  72 The Cisco HDLC protocol can be used by
  73 adding
  74 .Em link2
  75 to
  76 .Xr ifconfig 8 .
  77 .Pp
  78 Alternately, the driver can be compiled to support
  79 .Xr netgraph 4
  80 (see below).
  81 .Pp
  82 The
  83 .Em flags
  84 specification in
  85 .Pa /boot/device.hints
  86 is optional.
  87 If it is not specified, the driver will
  88 assume the following:
  89 .Pp
  90 .Bl -hang -offset indent
  91 .It "The card has 2 ports."
  92 .It "The clock for the serial ports is external and the transmitter uses"
  93 the same clock as the receiver.
  94 .El
  95 .Pp
  96 The
  97 .Em flags
  98 are a bit field and can be used to force a different
  99 behaviour than the default.
 100 .Pp
 101 .Bl -hang -offset indent
 102 .It Em 0x01
 103 The card has only one port.
 104 .It Em 0x10
 105 Use separate external clocks for transmit and receive on port 0.
 106 .It Em 0x40
 107 Use separate external clocks for transmit and receive on port 1.
 108 .El
 109 .Pp
 110 The card only supports IRQ 3, 4, 5, 7, 10, 11, 12 and 15.
 111 .Pp
 112 The iomem area is a 16Kb block and must start at a 16Kb boundary.
 113 .Sh HARDWARE
 114 The
 115 .Nm
 116 driver supports the following hardware:
 117 .Pp
 118 .Bl -bullet -compact
 119 .It
 120 SDL Communications RISCom/N2 ISA
 121 .It
 122 SDL Communications N2pci
 123 .It
 124 SDL Communications WANic 400/405 PCI
 125 .El
 126 .Sh NETGRAPH SUPPORT
 127 If the kernel is compiled with
 128 .Dv "options NETGRAPH"
 129 then the sppp and Cisco HDLC modes are disabled (and the sppp driver
 130 is unneeded), and this driver functions as a
 131 .Xr netgraph 4
 132 node with a single hook named
 133 .Dv rawdata .
 134 Connecting to this hook enables the transmission of raw HDLC frames.
 135 The node will have the same name as the device with ``sync_''
 136 prepended, e.g.,
 137 .Dv sync_sr0 .
 138 .Sh DIAGNOSTICS
 139 .Bl -diag
 140 .It "sr%d: Warning illegal interrupt %d."
 141 The card cannot use the specified interrupt.
 142 Choose a different one.
 143 .El
 144 .Sh SEE ALSO
 145 .Xr ar 4 ,
 146 .Xr cx 4 ,
 147 .Xr netgraph 4 ,
 148 .Xr netintro 4 ,
 149 .Xr ifconfig 8
 150 .Sh AUTHORS
 151 .An -nosplit
 152 The
 153 .Nm
 154 device driver was written by
 155 .An John Hay Aq jhay@FreeBSD.org .
 156 .Pp
 157 Netgraph support was added by
 158 .An Julian Elischer Aq julian@FreeBSD.org .
 159 .Sh BUGS
 160 At the moment only the X.21 interface is tested.
 161 The others
 162 may need tweaks to the clock selection code.
 163 .Pp
 164 The code can probably stand some optimizing.