share/man/man4/sis.4

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ee.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 September 2, 2010
  34 .Dt SIS 4
  35 .Os
  36 .Sh NAME
  37 .Nm sis
  38 .Nd "SiS 900, SiS 7016 and NS DP83815/DP83816 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 sis"
  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_sis_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 Silicon Integrated Systems SiS 900
  59 and SiS 7016 Fast Ethernet controller chips.
  60 .Pp
  61 This driver also supports
  62 adapters based on the National Semiconductor DP83815 (MacPhyter) and DP83816
  63 PCI Ethernet controller chip.
  64 .Pp
  65 The SiS 900 is a 100Mbps Ethernet MAC and MII-compliant transceiver
  66 in a single package.
  67 It uses a bus master DMA and a scatter/gather
  68 descriptor scheme.
  69 The SiS 7016 is similar to the SiS 900 except
  70 that it has no internal PHY, requiring instead an external transceiver
  71 to be attached to its MII interface.
  72 The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
  73 and a single perfect filter entry for the station address.
  74 .Pp
  75 The NS DP83815 is also a 100Mbps Ethernet MAC with integrated PHY.
  76 The NatSemi chip and the SiS 900 share many of the same features and
  77 a fairly similar programming interface, hence both chips are supported
  78 by the same driver.
  79 .Pp
  80 The
  81 .Nm
  82 driver supports the following media types:
  83 .Bl -tag -width 10baseTXUTP
  84 .It autoselect
  85 Enable autoselection of the media type and options.
  86 The user can manually override
  87 the autoselected mode by adding media options to
  88 .Xr rc.conf 5 .
  89 .It 10baseT/UTP
  90 Set 10Mbps operation.
  91 The
  92 .Xr ifconfig 8
  93 .Cm mediaopt
  94 option can also be used to select either
  95 .Sq full-duplex
  96 or
  97 .Sq half-duplex
  98 modes.
  99 .It 100baseTX
 100 Set 100Mbps (Fast Ethernet) operation.
 101 The
 102 .Xr ifconfig 8
 103 .Cm mediaopt
 104 option can also be used to select either
 105 .Sq full-duplex
 106 or
 107 .Sq half-duplex
 108 modes.
 109 .El
 110 .Pp
 111 The
 112 .Nm
 113 driver supports the following media options:
 114 .Bl -tag -width full-duplex
 115 .It full-duplex
 116 Force full duplex operation.
 117 .It half-duplex
 118 Force half duplex operation.
 119 .El
 120 .Pp
 121 For more information on configuring this device, see
 122 .Xr ifconfig 8 .
 123 .Sh HARDWARE
 124 The
 125 .Nm
 126 driver supports Silicon Integrated Systems SiS 900 and SiS 7016 based
 127 Fast Ethernet adapters and embedded controllers, as well as Fast Ethernet
 128 adapters based on the National Semiconductor DP83815 (MacPhyter) and DP83816
 129 chips.
 130 Supported adapters include:
 131 .Pp
 132 .Bl -bullet -compact
 133 .It
 134 @Nifty FNECHARD IFC USUP-TX
 135 .It
 136 MELCO LGY-PCI-TXC
 137 .It
 138 Netgear FA311-TX (DP83815)
 139 .It
 140 Netgear FA312-TX (DP83815)
 141 .It
 142 SiS 630, 635, and 735 motherboard chipsets
 143 .It
 144 Soekris Engineering net45xx, net48xx, lan1621, and lan1641
 145 .El
 146 .Sh SYSCTL VARIABLES
 147 The following variable is available as both
 148 .Xr sysctl 8
 149 variable and
 150 .Xr loader 8
 151 tunable:
 152 .Bl -tag -width indent
 153 .It Va dev.sis.%unit.manual_pad
 154 This variable controls how to pad short frames for DP83815/DP83816
 155 controllers on the specified device.
 156 DP83815/DP83816 controllers are known to pad 0xFF for short frames
 157 which is violation of RFC 1042.
 158 Set this variable to a non-zero value to let driver manually pad
 159 each short frame with zeros at the cost of extra CPU cycles.
 160 The default value is 0 to let hardware perform automatic padding.
 161 .El
 162 .Sh DIAGNOSTICS
 163 .Bl -diag
 164 .It "sis%d: couldn't map ports/memory"
 165 A fatal initialization error has occurred.
 166 .It "sis%d: couldn't map interrupt"
 167 A fatal initialization error has occurred.
 168 .It "sis%d: watchdog timeout"
 169 The device has stopped responding to the network, or there is a problem with
 170 the network connection (e.g.\& a cable fault).
 171 .It "sis%d: no memory for rx list"
 172 The driver failed to allocate an mbuf for the receiver ring.
 173 .It "sis%d: no memory for tx list"
 174 The driver failed to allocate an mbuf for the transmitter ring when
 175 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 176 .It "sis%d: chip is in D3 power state -- setting to D0"
 177 This message applies only to adapters which support power
 178 management.
 179 Some operating systems place the controller in low power
 180 mode when shutting down, and some PCI BIOSes fail to bring the chip
 181 out of this state before configuring it.
 182 The controller loses all of
 183 its PCI configuration in the D3 state, so if the BIOS does not set
 184 it back to full power mode in time, it will not be able to configure it
 185 correctly.
 186 The driver tries to detect this condition and bring
 187 the adapter back to the D0 (full power) state, but this may not be
 188 enough to return the driver to a fully operational condition.
 189 If
 190 you see this message at boot time and the driver fails to attach
 191 the device as a network interface, you will have to perform a
 192 warm boot to have the device properly configured.
 193 .Pp
 194 Note that this condition only occurs when warm booting from another
 195 operating system.
 196 If you power down your system prior to booting
 197 .Fx ,
 198 the card should be configured correctly.
 199 .El
 200 .Sh SEE ALSO
 201 .Xr altq 4 ,
 202 .Xr arp 4 ,
 203 .Xr miibus 4 ,
 204 .Xr netintro 4 ,
 205 .Xr ng_ether 4 ,
 206 .Xr polling 4 ,
 207 .Xr vlan 4 ,
 208 .Xr ifconfig 8
 209 .Rs
 210 .%T SiS 900 and SiS 7016 datasheets
 211 .%U http://www.sis.com.tw
 212 .Re
 213 .Rs
 214 .%T NatSemi DP83815 datasheet
 215 .%U http://www.national.com
 216 .Re
 217 .Sh HISTORY
 218 The
 219 .Nm
 220 device driver first appeared in
 221 .Fx 3.0 .
 222 .Sh AUTHORS
 223 The
 224 .Nm
 225 driver was written by
 226 .An Bill Paul Aq wpaul@ee.columbia.edu .