share/man/man4/ste.4

   1 .\" Copyright (c) 1997, 1998, 1999
   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 December 24, 2009
  34 .Dt STE 4
  35 .Os
  36 .Sh NAME
  37 .Nm ste
  38 .Nd "Sundance Technologies ST201 Fast 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 ste"
  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_ste_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Ethernet adapters and embedded
  58 controllers based on the Sundance Technologies ST201 PCI Fast
  59 Ethernet controller chip.
  60 .Pp
  61 The Sundance ST201 uses bus master DMA and is designed to be a
  62 3Com Etherlink XL workalike.
  63 It uses the same DMA descriptor
  64 structure and is very similar in operation, however its register
  65 layout is different.
  66 The ST201 has a 64-bit multicast hash filter
  67 and a single perfect filter entry for the station address.
  68 It supports both 10 and 100Mbps speeds in either full or half duplex
  69 using an MII transceiver.
  70 .Pp
  71 The
  72 .Nm
  73 driver supports the following media types:
  74 .Pp
  75 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  76 .It autoselect
  77 Enable autoselection of the media type and options.
  78 The user can manually override
  79 the autoselected mode by adding media options to the
  80 .Pa /etc/rc.conf
  81 file.
  82 .It 10baseT/UTP
  83 Set 10Mbps operation.
  84 The
  85 .Ar mediaopt
  86 option can also be used to select either
  87 .Ar full-duplex
  88 or
  89 .Ar half-duplex
  90 modes.
  91 .It 100baseTX
  92 Set 100Mbps (Fast Ethernet) operation.
  93 The
  94 .Ar mediaopt
  95 option can also be used to select either
  96 .Ar full-duplex
  97 or
  98 .Ar half-duplex
  99 modes.
 100 .El
 101 .Pp
 102 The
 103 .Nm
 104 driver supports the following media options:
 105 .Pp
 106 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 107 .It full-duplex
 108 Force full duplex operation
 109 .It half-duplex
 110 Force half duplex operation.
 111 .El
 112 .Pp
 113 For more information on configuring this device, see
 114 .Xr ifconfig 8 .
 115 .Sh HARDWARE
 116 The
 117 .Nm
 118 driver supports Sundance Technologies ST201 based Fast Ethernet
 119 adapters and embedded controllers including:
 120 .Pp
 121 .Bl -bullet -compact
 122 .It
 123 D-Link DFE-530TXS
 124 .It
 125 D-Link DFE-550TX
 126 .It
 127 D-Link DFE-580TX
 128 .El
 129 .Sh SYSCTL VARIABLES
 130 The following variables are available as both
 131 .Xr sysctl 8
 132 variables and
 133 .Xr loader 8
 134 tunables:
 135 .Bl -tag -width "xxxxxx"
 136 .It Va dev.ste.%d.int_rx_mod
 137 Maximum number of time to delay RX interrupts.
 138 The valid range is 0 to 209712 in units of 1us, the default is
 139 150 (150us).
 140 The value 0 effectively disables the RX interrupt moderation.
 141 The resolution of of timer is about 3.2us so finer tuning than
 142 3.2us wouldn't be available.
 143 The interface does not need to be brought down and up again before
 144 a change takes effect.
 145 .El
 146 .Sh DIAGNOSTICS
 147 .Bl -diag
 148 .It "ste%d: couldn't map ports/memory"
 149 A fatal initialization error has occurred.
 150 .It "ste%d: couldn't map interrupt"
 151 A fatal initialization error has occurred.
 152 .It "ste%d: watchdog timeout"
 153 The device has stopped responding to the network, or there is a problem with
 154 the network connection (cable).
 155 .It "ste%d: no memory for rx list"
 156 The driver failed to allocate an mbuf for the receiver ring.
 157 .It "ste%d: no memory for tx list"
 158 The driver failed to allocate an mbuf for the transmitter ring when
 159 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 160 .It "ste%d: chip is in D3 power state -- setting to D0"
 161 This message applies only to adapters which support power
 162 management.
 163 Some operating systems place the controller in low power
 164 mode when shutting down, and some PCI BIOSes fail to bring the chip
 165 out of this state before configuring it.
 166 The controller loses all of
 167 its PCI configuration in the D3 state, so if the BIOS does not set
 168 it back to full power mode in time, it will not be able to configure it
 169 correctly.
 170 The driver tries to detect this condition and bring
 171 the adapter back to the D0 (full power) state, but this may not be
 172 enough to return the driver to a fully operational condition.
 173 If
 174 you see this message at boot time and the driver fails to attach
 175 the device as a network interface, you will have to perform a second
 176 warm boot to have the device properly configured.
 177 .Pp
 178 Note that this condition only occurs when warm booting from another
 179 operating system.
 180 If you power down your system prior to booting
 181 .Fx ,
 182 the card should be configured correctly.
 183 .El
 184 .Sh SEE ALSO
 185 .Xr altq 4 ,
 186 .Xr arp 4 ,
 187 .Xr miibus 4 ,
 188 .Xr netintro 4 ,
 189 .Xr ng_ether 4 ,
 190 .Xr polling 4 ,
 191 .Xr vlan 4 ,
 192 .Xr ifconfig 8
 193 .Rs
 194 .%T Sundance ST201 data sheet
 195 .%O http://www.sundanceti.com
 196 .Re
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 device driver first appeared in
 201 .Fx 3.0 .
 202 .Sh AUTHORS
 203 The
 204 .Nm
 205 driver was written by
 206 .An Bill Paul Aq wpaul@ee.columbia.edu .