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 .\" $DragonFly: src/share/man/man4/man4.i386/ar.4,v 1.6 2006/10/24 17:09:45 swildner Exp $
  30 .\"
  31 .Dd November 19, 1995
  32 .Dt AR 4 i386
  33 .Os
  34 .Sh NAME
  35 .Nm ar
  36 .Nd synchronous Digi/Arnet device driver
  37 .Sh SYNOPSIS
  38 .Cd "device ar0 at isa? port 0x300 irq 10 iomem 0xd0000"
  39 .Cd "device ar1 at isa? port 0x310 irq 11 iomem 0xd0000"
  40 .Pp
  41 .Cd "pseudo-device sppp"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver supports the Digi/Arnet SYNC/570i ISA and PCI cards that is based on the
  46 HD64570 chip.
  47 Both the 2 and 4 port cards are supported and auto detected.
  48 .Pp
  49 The standard
  50 .Fx
  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 .Ar 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 .Sh NUMBERING
  64 Only one line for each card is needed in the kernel configuration file.
  65 The first card's ports will be installed from ar0. The numbering of the
  66 next card will continue where the first stopped, eg. if the first card
  67 is a two port card it will use ar0 and ar1. The next card will then
  68 start at ar2.
  69 .Pp
  70 The card only supports IRQ 3, 5, 7, 10, 11, 12 and 15.
  71 .Pp
  72 The iomem area is a 16Kb block and must start at a 16Kb boundary.
  73 .Sh NETGRAPH SUPPORT
  74 If the kernel is compiled with
  75 .Cd "options NETGRAPH"
  76 then the sppp and Cisco HDLC modes are disabled (and the sppp driver
  77 is unneeded), and this driver functions as a
  78 .Xr netgraph 4
  79 node with a single hook named
  80 .Dv rawdata .
  81 Connecting to this hook enables the transmission of raw HDLC frames.
  82 The node will have the same name as the device with ``sync_''
  83 prepended, e.g.,
  84 .Dv sync_ar0 .
  85 .Sh FILES
  86 .Bl -tag -width /sys/arch/i386/isa/ic/hd64570.h -compact
  87 .It Pa /sys/dev/netif/ar/if_ar.c
  88 .It Pa /sys/dev/netif/ar/if_ar.h
  89 .It Pa /sys/dev/netif/ar/if_ar_pci.c
  90 .It Pa /sys/dev/netif/ar/if_arregs.h
  91 .It Pa /sys/arch/i386/isa/ic/hd64570.h
  92 .El
  93 .Sh DIAGNOSTICS
  94 .Bl -diag
  95 .It "ar%d: Warning illegal interrupt %d."
  96 The card cannot use the specified interrupt.
  97 Choose a different one.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr cx 4 ,
 101 .Xr netgraph 4 ,
 102 .Xr netintro 4 ,
 103 .Xr sr 4 ,
 104 .Xr ifconfig 8
 105 .Sh HISTORY
 106 The
 107 .Nm
 108 device driver first appeared in
 109 .Fx 2.2 .
 110 .Sh AUTHORS
 111 .An -nosplit
 112 The
 113 .Nm
 114 device driver was written by
 115 .An John Hay Aq jhay@FreeBSD.org .
 116 Netgraph support was added by
 117 .An Julian Elischer Aq julian@FreeBSD.org .
 118 .Sh BUGS
 119 At the moment only the V.35 and X.21 interfaces are tested.
 120 The others
 121 may need tweaks to the clock selection code.
 122 .Pp
 123 The code can probably stand some optimizing.
 124 .Pp
 125 Please report bugs to
 126 .Aq jhay@FreeBSD.org .