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