share/man/man4/man4.i386/ar.4

   1 .\"
   2 .\" Copyright (c) 1995, 1999 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. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY John Hay ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL John Hay BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/share/man/man4/man4.i386/ar.4,v 1.17.2.4 2001/08/17 13:08:45 ru Exp $
  29 .\"
  30 .Dd November 19, 1995
  31 .Dt AR 4 i386
  32 .Os
  33 .Sh NAME
  34 .Nm ar
  35 .Nd synchronous Digi/Arnet device driver
  36 .Sh SYNOPSIS
  37 .Cd "device ar"
  38 .Pp
  39 .Cd "pseudo-device sppp"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver supports the Digi/Arnet SYNC/570i PCI cards that is based on the
  44 HD64570 chip.
  45 Both the 2 and 4 port cards are supported and auto detected.
  46 .Pp
  47 The standard
  48 .Dx
  49 sppp code is used for the link level layer.
  50 The
  51 default protocol used is PPP.
  52 The Cisco HDLC protocol can be used by
  53 adding
  54 .Ar link2
  55 to
  56 .Xr ifconfig 8 .
  57 .Pp
  58 Alternately, the driver can be compiled to support
  59 .Xr netgraph 4
  60 (see below).
  61 .Sh NUMBERING
  62 Only one line for each card is needed in the kernel configuration file.
  63 The first card's ports will be installed from ar0. The numbering of the
  64 next card will continue where the first stopped, eg. if the first card
  65 is a two port card it will use ar0 and ar1. The next card will then
  66 start at ar2.
  67 .Pp
  68 The card only supports IRQ 3, 5, 7, 10, 11, 12 and 15.
  69 .Pp
  70 The iomem area is a 16Kb block and must start at a 16Kb boundary.
  71 .Sh NETGRAPH SUPPORT
  72 If the kernel is compiled with
  73 .Cd "options NETGRAPH"
  74 then the sppp and Cisco HDLC modes are disabled (and the sppp driver
  75 is unneeded), and this driver functions as a
  76 .Xr netgraph 4
  77 node with a single hook named
  78 .Dv rawdata .
  79 Connecting to this hook enables the transmission of raw HDLC frames.
  80 The node will have the same name as the device with ``sync_''
  81 prepended, e.g.,
  82 .Dv sync_ar0 .
  83 .Sh FILES
  84 .Bl -tag -width /sys/platform/pc32/isa/ic/hd64570.h -compact
  85 .It Pa /sys/dev/netif/ar/if_ar.c
  86 .It Pa /sys/dev/netif/ar/if_ar.h
  87 .It Pa /sys/dev/netif/ar/if_ar_pci.c
  88 .It Pa /sys/dev/netif/ar/if_arregs.h
  89 .It Pa /sys/platform/pc32/isa/ic/hd64570.h
  90 .El
  91 .Sh DIAGNOSTICS
  92 .Bl -diag
  93 .It "ar%d: Warning illegal interrupt %d."
  94 The card cannot use the specified interrupt.
  95 Choose a different one.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr netgraph 4 ,
  99 .Xr netintro 4 ,
 100 .Xr sr 4 ,
 101 .Xr ifconfig 8
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 device driver first appeared in
 106 .Fx 2.2 .
 107 .Sh AUTHORS
 108 .An -nosplit
 109 The
 110 .Nm
 111 device driver was written by
 112 .An John Hay Aq Mt jhay@FreeBSD.org .
 113 Netgraph support was added by
 114 .An Julian Elischer Aq Mt julian@FreeBSD.org .
 115 .Sh BUGS
 116 At the moment only the V.35 and X.21 interfaces are tested.
 117 The others
 118 may need tweaks to the clock selection code.
 119 .Pp
 120 The code can probably stand some optimizing.
 121 .Pp
 122 Please report bugs to
 123 .Aq Mt jhay@FreeBSD.org .