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