share/man/man4/man4.i386/vx.4

   1 .\"
   2 .\" Copyright (c) 1996, Fred Gray
   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 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by David Greenman.
  16 .\" 4. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR OR CONTRIBUTORS 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$
  32 .\"
  33 .Dd July 16, 2005
  34 .Dt VX 4 i386
  35 .Os
  36 .Sh NAME
  37 .Nm vx
  38 .Nd "3Com EtherLink III / Fast EtherLink III (3c59x) Ethernet driver"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following line in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device vx"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_vx_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for the 3Com
  57 .Dq Vortex
  58 chipset.
  59 .Pp
  60 The medium selection
  61 can be influenced by the following link flags to the
  62 .Xr ifconfig 8
  63 command:
  64 .Pp
  65 .Bl -tag -width LINK0X -compact
  66 .It Em link0
  67 Use the AUI port.
  68 .It Em link1
  69 Use the BNC port.
  70 .It Em link2
  71 Use the UTP port.
  72 .El
  73 .Sh HARDWARE
  74 The
  75 .Nm
  76 driver supports the following cards:
  77 .Pp
  78 .Bl -bullet -compact
  79 .It
  80 3Com 3c590 EtherLink III PCI
  81 .It
  82 3Com 3c592 EtherLink III EISA
  83 .It
  84 3Com 3c595 Fast EtherLink III PCI in 10 Mbps mode
  85 .It
  86 3Com 3c597 Fast EtherLink III EISA in 10 Mbps mode
  87 .El
  88 .Sh DIAGNOSTICS
  89 .Bl -diag
  90 .It "vx%d: not configured; kernel is built for only %d devices."
  91 There are not enough devices in the kernel configuration file for the number
  92 of adapters present in the system.
  93 Add devices to the configuration file,
  94 rebuild the kernel, and reboot.
  95 .El
  96 .Pp
  97 All other diagnostics indicate either a hardware problem or a bug in the
  98 driver.
  99 .Sh CAVEATS
 100 Some early-revision 3c590 cards are defective and suffer from many receive
 101 overruns, which cause lost packets.
 102 The author has attempted to implement
 103 a test for it based on the information supplied by 3Com, but the test resulted
 104 mostly in spurious warnings.
 105 .Pp
 106 The performance of this driver is somewhat limited by the fact that it uses
 107 only polled-mode I/O and does not make use of the bus-mastering capability
 108 of the cards.
 109 .Sh SEE ALSO
 110 .Xr arp 4 ,
 111 .Xr netintro 4 ,
 112 .Xr ng_ether 4 ,
 113 .Xr ifconfig 8
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 device driver first appeared in
 118 .Fx 2.1 .
 119 It was derived from the
 120 .Nm ep
 121 driver, from which it inherits most of its limitations.
 122 .Sh AUTHORS
 123 .An -nosplit
 124 The
 125 .Nm
 126 device driver and this manual page were written by
 127 .An Fred Gray Aq fgray@rice.edu ,
 128 based on the work of
 129 .An Herb Peyerl
 130 and with the assistance of numerous others.
 131 .Sh BUGS
 132 The
 133 .Nm
 134 driver is known not to reset the adapter correctly following a warm boot
 135 on some systems.
 136 .Pp
 137 The
 138 .Nm
 139 driver has not been exhaustively tested with all the models of cards that it
 140 claims to support.