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