share/man/man4/tl.4

   1 .\" Copyright (c) 1997, 1998
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd October 24, 2018
  34 .Dt TL 4
  35 .Os
  36 .Sh NAME
  37 .Nm tl
  38 .Nd "Texas Instruments ThunderLAN Ethernet device driver"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following lines in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device miibus"
  45 .Cd "device tl"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_tl_load="YES"
  53 .Ed
  54 .Sh DEPRECATION NOTICE
  55 The
  56 .Nm
  57 driver is not present in
  58 .Fx 13.0
  59 and later.
  60 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  61 information.
  62 .Sh DESCRIPTION
  63 The
  64 .Nm
  65 driver provides support for PCI Ethernet adapters based on the Texas
  66 Instruments ThunderLAN Ethernet controller chip.
  67 .Pp
  68 The ThunderLAN controller has a standard MII interface that supports
  69 up to 32 physical interface devices (PHYs).
  70 It also has a built-in
  71 10baseT PHY hardwired at MII address 31, which may be used in some
  72 10Mbps-only hardware configurations.
  73 In 100Mbps configurations, a
  74 National Semiconductor DP83840A or other MII-compliant PHY may be
  75 attached to the ThunderLAN's MII bus.
  76 If a DP83840A or equivalent
  77 is available, the ThunderLAN chip can operate at either 100Mbps or
  78 10Mbps in either half-duplex or full-duplex modes.
  79 The ThunderLAN's
  80 built-in PHY and the DP83840A also support autonegotiation.
  81 .Pp
  82 The
  83 .Nm
  84 driver supports the following media types:
  85 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  86 .It autoselect
  87 Enable autoselection of the media type and options.
  88 Note that this
  89 option is only available on those PHYs that support autonegotiation.
  90 Also, the PHY will not advertise those modes that have been explicitly
  91 disabled using the following media options.
  92 .It 10baseT/UTP
  93 Set 10Mbps operation.
  94 .It 100baseTX
  95 Set 100Mbps (Fast Ethernet) operation.
  96 .It 10base5/AUI
  97 Enable AUI/BNC interface (useful only with the built-in PHY).
  98 .El
  99 .Pp
 100 The
 101 .Nm
 102 driver supports the following media options:
 103 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 104 .It full-duplex
 105 Force full duplex operation.
 106 .It half-duplex
 107 Force half duplex operation.
 108 .It hw-loopback
 109 Enable hardware loopback mode.
 110 .El
 111 .Pp
 112 Note that the 100baseTX media type is only available if supported
 113 by the PHY.
 114 For more information on configuring this device, see
 115 .Xr ifconfig 8 .
 116 .Sh HARDWARE
 117 The
 118 .Nm
 119 driver supports Texas Instruments ThunderLAN based
 120 Ethernet and Fast Ethernet adapters including a large
 121 number of Compaq PCI Ethernet adapters.
 122 Also supported are:
 123 .Pp
 124 .Bl -bullet -compact
 125 .It
 126 Olicom OC-2135/2138 10/100 TX UTP adapter
 127 .It
 128 Olicom OC-2325/OC-2326 10/100 TX UTP adapter
 129 .It
 130 Racore 8148 10baseT/100baseTX/100baseFX adapter
 131 .It
 132 Racore 8165 10/100baseTX adapter
 133 .El
 134 .Pp
 135 The
 136 .Nm
 137 driver also supports the built-in Ethernet adapters of
 138 various Compaq Prosignia servers and Compaq Deskpro desktop
 139 machines including:
 140 .Pp
 141 .Bl -bullet -compact
 142 .It
 143 Compaq Netelligent 10
 144 .It
 145 Compaq Netelligent 10 T PCI UTP/Coax
 146 .It
 147 Compaq Netelligent 10/100
 148 .It
 149 Compaq Netelligent 10/100 Dual-Port
 150 .It
 151 Compaq Netelligent 10/100 Proliant
 152 .It
 153 Compaq Netelligent 10/100 TX Embedded UTP
 154 .It
 155 Compaq Netelligent 10/100 TX UTP
 156 .It
 157 Compaq NetFlex 3P
 158 .It
 159 Compaq NetFlex 3P Integrated
 160 .It
 161 Compaq NetFlex 3P w/BNC
 162 .El
 163 .Sh DIAGNOSTICS
 164 .Bl -diag
 165 .It "tl%d: couldn't map memory"
 166 A fatal initialization error has occurred.
 167 .It "tl%d: couldn't map interrupt"
 168 A fatal initialization error has occurred.
 169 .It "tl%d: device timeout"
 170 The device has stopped responding to the network, or there is a problem with
 171 the network connection (cable).
 172 .It "tl%d: no memory for rx list"
 173 The driver failed to allocate an mbuf for the receiver ring.
 174 .It "tl%d: no memory for tx list"
 175 The driver failed to allocate an mbuf for the transmitter ring when
 176 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 177 .El
 178 .Sh SEE ALSO
 179 .Xr arp 4 ,
 180 .Xr miibus 4 ,
 181 .Xr netintro 4 ,
 182 .Xr ng_ether 4 ,
 183 .Xr ifconfig 8
 184 .Sh HISTORY
 185 The
 186 .Nm
 187 device driver first appeared in
 188 .Fx 2.2 .
 189 .Sh AUTHORS
 190 The
 191 .Nm
 192 driver was written by
 193 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu .