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 October 24, 2018
  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 DEPRECATION NOTICE
  54 The
  55 .Nm
  56 driver is not present in
  57 .Fx 13.0
  58 and later.
  59 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  60 information.
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for the 3Com
  65 .Dq Vortex
  66 chipset.
  67 .Pp
  68 The medium selection
  69 can be influenced by the following link flags to the
  70 .Xr ifconfig 8
  71 command:
  72 .Pp
  73 .Bl -tag -width LINK0X -compact
  74 .It Em link0
  75 Use the AUI port.
  76 .It Em link1
  77 Use the BNC port.
  78 .It Em link2
  79 Use the UTP port.
  80 .El
  81 .Sh HARDWARE
  82 The
  83 .Nm
  84 driver supports the following cards:
  85 .Pp
  86 .Bl -bullet -compact
  87 .It
  88 3Com 3c590 EtherLink III PCI
  89 .It
  90 3Com 3c595 Fast EtherLink III PCI in 10 Mbps mode
  91 .El
  92 .Sh DIAGNOSTICS
  93 All other diagnostics indicate either a hardware problem or a bug in the
  94 driver.
  95 .Sh SEE ALSO
  96 .Xr arp 4 ,
  97 .Xr netintro 4 ,
  98 .Xr ng_ether 4 ,
  99 .Xr ifconfig 8
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 device driver first appeared in
 104 .Fx 2.1 .
 105 It was derived from the
 106 .Nm ep
 107 driver, from which it inherits most of its limitations.
 108 .Sh AUTHORS
 109 .An -nosplit
 110 The
 111 .Nm
 112 device driver and this manual page were written by
 113 .An Fred Gray Aq Mt fgray@rice.edu ,
 114 based on the work of
 115 .An Herb Peyerl
 116 and with the assistance of numerous others.
 117 .Sh CAVEATS
 118 Some early-revision 3c590 cards are defective and suffer from many receive
 119 overruns, which cause lost packets.
 120 The author has attempted to implement
 121 a test for it based on the information supplied by 3Com, but the test resulted
 122 mostly in spurious warnings.
 123 .Pp
 124 The performance of this driver is somewhat limited by the fact that it uses
 125 only polled-mode I/O and does not make use of the bus-mastering capability
 126 of the cards.
 127 .Sh BUGS
 128 The
 129 .Nm
 130 driver is known not to reset the adapter correctly following a warm boot
 131 on some systems.
 132 .Pp
 133 The
 134 .Nm
 135 driver has not been exhaustively tested with all the models of cards that it
 136 claims to support.