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