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: src/share/man/man4/man4.i386/sr.4,v 1.15.2.4 2001/08/17 13:08:46 ru Exp $
  32 .\"
  33 .Dd July 4, 1996
  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 .Cd "pseudo-device sppp"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver supports the WANic 400/405 PCI cards
  47 that are based on the HD64570 chip.
  48 .Pp
  49 The standard
  50 .Dx
  51 sppp code is used for the link level layer.
  52 The
  53 default protocol used is PPP.
  54 The Cisco HDLC protocol can be used by
  55 adding
  56 .Em link2
  57 to
  58 .Xr ifconfig 8 .
  59 .Pp
  60 Alternately, the driver can be compiled to support
  61 .Xr netgraph 4
  62 (see below).
  63 .Pp
  64 The
  65 .Em flags
  66 field is optional.
  67 If it isn't specified, the driver will
  68 assume the following:
  69 .Bl -hang -offset indent
  70 .It "The card has 2 ports."
  71 .It "The clock for the serial ports is external and the transmitter uses"
  72 the same clock as the receiver.
  73 .El
  74 .Pp
  75 The
  76 .Em flags
  77 are a bit field and can be used to force a different
  78 behaviour than the default.
  79 .Bl -hang -offset indent
  80 .It Em 0x01
  81 The card has only one port.
  82 .It Em 0x10
  83 Use separate external clocks for transmit and receive on port 0.
  84 .It Em 0x40
  85 Use separate external clocks for transmit and receive on port 1.
  86 .El
  87 .Sh NUMBERING
  88 Only one line for each card is needed in the kernel configuration file.
  89 The first card's ports will be installed from sr0. The numbering of the
  90 next card will continue where the first stopped, eg. if the first card
  91 is a two port card it will use sr0 and sr1. The next card will then
  92 start at sr2.
  93 .Pp
  94 The card only supports IRQ 3, 4, 5, 7, 10, 11, 12 and 15.
  95 .Pp
  96 The iomem area is a 16Kb block and must start at a 16Kb boundary.
  97 .Sh NETGRAPH SUPPORT
  98 If the kernel is compiled with
  99 .Cd "options NETGRAPH"
 100 then the sppp and Cisco HDLC modes are disabled (and the sppp driver
 101 is unneeded), and this driver functions as a
 102 .Xr netgraph 4
 103 node with a single hook named
 104 .Dv rawdata .
 105 Connecting to this hook enables the transmission of raw HDLC frames.
 106 The node will have the same name as the device with ``sync_''
 107 prepended, e.g.,
 108 .Dv sync_sr0 .
 109 .Sh FILES
 110 .Bl -tag -width ".Pa /sys/dev/netif/sr/if_sr_pci.c" -compact
 111 .It Pa /sys/dev/netif/sr/if_sr.c
 112 .It Pa /sys/dev/netif/sr/if_sr.h
 113 .It Pa /sys/dev/netif/sr/if_sr_pci.c
 114 .It Pa /sys/dev/netif/sr/if_srregs.h
 115 .El
 116 .Sh DIAGNOSTICS
 117 .Bl -diag
 118 .It "sr%d: Warning illegal interrupt %d."
 119 The card cannot use the specified interrupt.
 120 Choose a different one.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr ar 4 ,
 124 .Xr netgraph 4 ,
 125 .Xr netintro 4 ,
 126 .Xr ifconfig 8
 127 .Sh AUTHORS
 128 .An -nosplit
 129 The
 130 .Nm
 131 device driver was written by
 132 .An John Hay Aq Mt jhay@FreeBSD.org .
 133 .Pp
 134 Netgraph support was added by
 135 .An Julian Elischer Aq Mt julian@FreeBSD.org .
 136 .Sh BUGS
 137 At the moment only the X.21 interface is tested.
 138 The others
 139 may need tweaks to the clock selection code.
 140 .Pp
 141 The code can probably stand some optimizing.