share/man/man4/tx.4

   1 .\"
   2 .\" Copyright (c) 1998-2001 Semen Ustimenko <semenu@FreeBSD.org>
   3 .\"
   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 DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 24, 2018
  29 .Dt TX 4
  30 .Os
  31 .Sh NAME
  32 .Nm tx
  33 .Nd "SMC 83c17x Fast Ethernet device driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device miibus"
  40 .Cd "device tx"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 if_tx_load="YES"
  48 .Ed
  49 .Sh DEPRECATION NOTICE
  50 The
  51 .Nm
  52 driver is not present in
  53 .Fx 13.0
  54 and later.
  55 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  56 information.
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for the Ethernet adapters based on the
  61 SMC 83c17x (EPIC) chips.
  62 These are mostly SMC 9432 series cards.
  63 .Pp
  64 The
  65 .Nm
  66 driver supports the following media types (depending on card's capabilities):
  67 .Bl -tag -width ".Cm 10baseT/UTP"
  68 .It Cm autoselect
  69 Enable autonegotiation (default).
  70 .It Cm 100baseFX
  71 Set 100Mbps (Fast Ethernet) fiber optic operation.
  72 .It Cm 100baseTX
  73 Set 100Mbps (Fast Ethernet) twisted pair operation.
  74 .It Cm 10baseT/UTP
  75 Set 10Mbps on 10baseT port.
  76 .It Cm 10base2/BNC
  77 Set 10Mbps on 10base2 port.
  78 .El
  79 .Pp
  80 The
  81 .Nm
  82 driver supports the following media options:
  83 .Bl -tag -width ".Cm full-duplex"
  84 .It Cm full-duplex
  85 Set full-duplex operation.
  86 .El
  87 .Pp
  88 The
  89 .Nm
  90 driver supports oversized Ethernet packets (up to 1600 bytes).
  91 Refer to the
  92 .Xr ifconfig 8
  93 man page on setting the interface's MTU.
  94 .Pp
  95 The old
  96 .Dq Li "ifconfig tx0 linkN"
  97 method of configuration is not supported.
  98 .Ss "VLAN (IEEE 802.1Q) support"
  99 The
 100 .Nm
 101 driver supports the VLAN operation (using
 102 .Xr vlan 4
 103 interfaces) without decreasing the MTU on the
 104 .Xr vlan 4
 105 interfaces.
 106 .Sh DIAGNOSTICS
 107 .Bl -diag
 108 .It "tx%d: device timeout %d packets"
 109 The device stops responding.
 110 Device and driver reset follows this error.
 111 .It "tx%d: PCI fatal error occurred (%s)"
 112 One of following errors occurred: PCI Target Abort, PCI Master Abort, Data
 113 Parity Error or Address Parity Error.
 114 Device and driver reset follows this error.
 115 .It "tx%d: cannot allocate mbuf header/cluster"
 116 Cannot allocate memory for received packet.
 117 Packet thrown away.
 118 .It "tx%d: can't stop %s DMA"
 119 While resetting, the driver failed to stop the device correctly.
 120 .El
 121 .Sh SEE ALSO
 122 .Xr arp 4 ,
 123 .Xr miibus 4 ,
 124 .Xr netintro 4 ,
 125 .Xr ng_ether 4 ,
 126 .Xr ifconfig 8
 127 .Sh BUGS
 128 The auto-negotiation does not work very well.