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