share/man/man4/fatm.4

   1 .\"
   2 .\" Copyright (c) 2001-2003
   3 .\"     Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   4 .\"     All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" Author: Hartmut Brandt <harti@FreeBSD.org>
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .\" fatm(4) man page
  32 .\"
  33 .Dd May 15, 2003
  34 .Dt FATM 4
  35 .Os
  36 .Sh NAME
  37 .Nm fatm
  38 .Nd "device driver for Fore PCA200E ATM interfaces"
  39 .Sh SYNOPSIS
  40 .Cd device fatm
  41 .Cd device utopia
  42 .Cd device atm
  43 .Pp
  44 .Cd options NATM
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 device driver supports the FORE (now Marconi) PCA200E ATM interface cards.
  49 The driver interfaces with the
  50 .Xr natm 4
  51 framework,
  52 .Xr netgraph 4
  53 and HARP.
  54 It provides only PVC services.
  55 Signalling, ATMARP, ILMI and other
  56 higher layer protocols are implemented using
  57 .Xr netgraph 4
  58 or HARP.
  59 .Pp
  60 For configuring the card for IP see
  61 .Xr natmip 4 .
  62 The following sysctls are recognized by the driver additionally to those
  63 handled by
  64 .Xr utopia 4 :
  65 .Bl -tag -width indent
  66 .It Va hw.atm.fatm Ns Ar N Ns Va .stats
  67 Returns a device specific statistic list of
  68 .Vt uint32_t
  69 statistic counters.
  70 .It Va hw.atm.fatm Ns Ar N Ns Va .istats
  71 Returns a list of
  72 .Vt uint32_t
  73 with internal driver statistics.
  74 .It Va hw.atm.fatm Ns Ar N Ns Va .retry_tx
  75 If this is set packets are stuffed back into the interface's send queue when
  76 the cards transmit queue is found to be full.
  77 They are transmitted later.
  78 If this is not set the packets are dropped.
  79 It may be useful to set this
  80 if only UBR traffic is sent.
  81 .It Va hw.atm.fatm Ns Ar N Ns Va .debug
  82 .Bf Em
  83 (Only if debugging enabled.)
  84 .Ef
  85 These are debugging flags.
  86 See
  87 .Pa src/sys/dev/fatm/if_fatmvar.h
  88 for the possible flags.
  89 .El
  90 .Pp
  91 The driver supports the media options
  92 .Cm sdh , noscramb
  93 and
  94 .Cm unassigned
  95 (see
  96 .Xr utopia 4 ) .
  97 .Sh DIAGNOSTICS
  98 .Bd -literal
  99 fatm0: <FORE PCA200E> mem 0xd5800000-0xd59fffff irq 9 at device 9.0 on pci0
 100 .Ed
 101 .Sh SEE ALSO
 102 .Xr natm 4 ,
 103 .Xr natmip 4 ,
 104 .Xr utopia 4
 105 .Sh AUTHORS
 106 .An Harti Brandt Aq harti@FreeBSD.org
 107 .Sh BUGS
 108 These cards can CBR shape a single VCC only.
 109 It is currently possible to
 110 request more than one CBR connection.
 111 In this case all the timing will be
 112 wrong.
 113 See
 114 .Xr hatm 4
 115 for a better card.