share/man/man4/hfa.4

   1 .\"
   2 .\" Copyright (c) 2004 Tom Rhodes
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd August 6, 2004
  29 .Dt HFA 4
  30 .Os
  31 .Sh NAME
  32 .Nm hfa
  33 .Nd FORE Systems 200-Series ATM adapter driver
  34 .Sh SYNOPSIS
  35 .Cd device hfa
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides support for the
  40 .Tn FORE
  41 Systems
  42 .Tn ATM
  43 series 200 adapters.
  44 This driver will support up to eight devices in a system
  45 at any given time.
  46 The
  47 .Nm
  48 driver follows the
  49 .Tn AALI
  50 or
  51 .Tn FORE
  52 .Tn ATM
  53 Adaptation Layer Interface and as such
  54 will adhere to its specifications.
  55 The supported
  56 .Tn AALs
  57 include:
  58 .Bl -bullet
  59 .It
  60 FORE AAL 0:
  61 The cell service;
  62 .It
  63 FORE AAL 4:
  64 Version three and four of AAL;
  65 .It
  66 FORE AAL 5:
  67 Version five of AAL.
  68 .El
  69 .Pp
  70 The
  71 .Nm
  72 driver supports traffic shaping for cards with firmware
  73 revisions of 4.X.X, see
  74 .Xr fore_dnld 8 .
  75 The following sysctls are recognized by the driver and
  76 may be used to enable or disable traffic shaping:
  77 .Bl -tag -width indent
  78 .It Va hw.atm.hfa Ns Ar N Ns Va .shape Pq 0
  79 Disable shaping on card number
  80 .Ar N .
  81 .It Va hw.atm.hfa Ns Ar N Ns Va .shape Pq 1
  82 Set one VCI to be traffic shaped on device
  83 .Ar N .
  84 This will shape the first CBR VCI which is opened.
  85 .It Va hw.atm.hfa Ns Ar N Ns Va .shape Pq 2
  86 Attempt to shape all VCIs on device
  87 .Ar N .
  88 .El
  89 The firmware should be loaded before using this
  90 driver, this can be an easy task if the
  91 .Xr fore_dnld 8
  92 utility is used.
  93 If the
  94 .Pa /etc/rc.d/atm1
  95 file has been properly configured then the firmware
  96 update should be automatic.
  97 .Sh HARDWARE
  98 The
  99 .Nm
 100 driver supports the following adapters:
 101 .Pp
 102 .Bl -bullet -compact
 103 .It
 104 FORE Systems PCA-200E ATM
 105 .It
 106 FORE Systems 200S
 107 .It
 108 FORE Systems 200
 109 .El
 110 .Sh DIAGNOSTICS
 111 .Bl -diag
 112 .It "fore_cmd_drain: %s%d: GET_PROM failed"
 113 The driver failed to drain the PROM buffer.
 114 .It "fore initialization failed: intf=%s%d"
 115 Initialization of the card has failed.
 116 .It "fore initialization timed out: intf=%s%d"
 117 Initialization of the card has timed out.
 118 .It "hfa: version mismatch: fore=%d.%d kernel=%d.%d"
 119 A version mismatch error has occurred.
 120 .El
 121 .Sh SEE ALSO
 122 .Xr fatm 4 ,
 123 .Xr harp 4 ,
 124 .Xr ng_atm 4 ,
 125 .Xr atm 8 ,
 126 .Xr fore_dnld 8
 127 .Sh HISTORY
 128 The
 129 .Nm
 130 driver was written by Network Computing Services, Inc.\&
 131 and added to
 132 .Fx 3.0
 133 by
 134 .An Poul-Henning Kamp Aq phk@FreeBSD.org .
 135 This manual page first appeared in
 136 .Fx 5.3 .
 137 .Sh AUTHORS
 138 This manual page was written by
 139 .An Tom Rhodes Aq trhodes@FreeBSD.org .