share/man/man4/sk.4

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ctr.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 January 23, 2009
  34 .Dt SK 4
  35 .Os
  36 .Sh NAME
  37 .Nm sk
  38 .Nd "SysKonnect SK-984x and SK-982x PCI Gigabit Ethernet adapter 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 sk"
  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_sk_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for the SysKonnect SK-984x and SK-982x series PCI
  58 Gigabit Ethernet adapters.
  59 .Pp
  60 The SysKonnect adapters consist of two main components: the XaQti Corp.
  61 XMAC II gigabit MAC and the SysKonnect GEnesis controller ASIC.
  62 The
  63 XMAC provides the gigabit MAC and PHY support while the GEnesis
  64 provides an interface to the PCI bus, DMA support, packet buffering
  65 and arbitration.
  66 The GEnesis can control up to two XMACs simultaneously,
  67 allowing dual-port NIC configurations.
  68 .Pp
  69 The SK-982x 1000baseT adapters also include a Broadcom BCM5400 1000baseTX
  70 PHY which is used in place of the XMAC's internal PHY.
  71 The Broadcom PHY is connected to the XMAC via its GMII port.
  72 .Pp
  73 The
  74 .Nm
  75 driver configures dual port SysKonnect adapters such that each XMAC
  76 is treated as a separate logical network interface.
  77 Both ports can
  78 operate independently of each other and can be connected to separate
  79 networks.
  80 The SysKonnect driver software currently only uses the
  81 second port on dual port adapters for failover purposes: if the link
  82 on the primary port fails, the SysKonnect driver will automatically
  83 switch traffic onto the second port.
  84 .Pp
  85 Also supported is the Marvell Semiconductor 88E100* gigabit PHY.
  86 .Pp
  87 The XaQti XMAC II supports full and half duplex operation with
  88 autonegotiation.
  89 The XMAC also supports unlimited frame sizes.
  90 Support for jumbo frames is provided via the interface MTU setting.
  91 Selecting an MTU larger than 1500 bytes with the
  92 .Xr ifconfig 8
  93 utility configures the adapter to receive and transmit jumbo frames.
  94 Using jumbo frames can greatly improve performance for certain tasks,
  95 such as file transfers and data streaming.
  96 .Pp
  97 The
  98 .Nm
  99 driver supports the following media types:
 100 .Pp
 101 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 102 .It autoselect
 103 Enable autoselection of the media type and options.
 104 The user can manually override
 105 the autoselected mode by adding media options to the
 106 .Pa /etc/rc.conf
 107 file.
 108 .It 1000baseTX
 109 Set 1000baseTX operation over twisted pair.
 110 This is only available
 111 for SK-982x series adapters with 1000baseT ports.
 112 Both
 113 .Ar full-duplex
 114 and
 115 .Ar half-duplex
 116 modes are supported.
 117 .It 1000baseSX
 118 Set 1000Mbps (Gigabit Ethernet) operation.
 119 Both
 120 .Ar full-duplex
 121 and
 122 .Ar half-duplex
 123 modes are supported.
 124 .El
 125 .Pp
 126 The
 127 .Nm
 128 driver supports the following media options:
 129 .Pp
 130 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 131 .It full-duplex
 132 Force full duplex operation
 133 .It half-duplex
 134 Force half duplex operation.
 135 .El
 136 .Pp
 137 The
 138 .Nm
 139 driver also supports one special link option for 1000baseTX cards:
 140 .Pp
 141 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 142 .It link0
 143 With 1000baseTX cards, establishing a link between two ports requires
 144 that one port is configured as master and the other one as slave.
 145 With autonegotiation,
 146 the master/slave settings will be chosen automatically.
 147 However when manually selecting the link state, it is necessary to
 148 force one side of the link to be a master and the other a slave.
 149 The
 150 .Nm
 151 driver configures the ports as slaves by default.
 152 Setting the
 153 .Ar link0
 154 flag with
 155 .Xr ifconfig 8
 156 will set a port as a master instead.
 157 .El
 158 .Pp
 159 For more information on configuring this device, see
 160 .Xr ifconfig 8 .
 161 .Sh HARDWARE
 162 Adapters supported by the
 163 .Nm
 164 driver include:
 165 .Pp
 166 .Bl -bullet -compact
 167 .It
 168 3Com 3C940 single port, 1000baseT adapter
 169 .It
 170 3Com 3C2000-T single port, 1000baseT adapter
 171 .It
 172 Belkin F5D5005 single port, 1000baseT adapter
 173 .It
 174 D-Link DGE-530T single port, 1000baseT adapter
 175 .It
 176 Linksys (revision 2) single port, 1000baseT adapter
 177 .It
 178 SK-9521 SK-NET GE-T single port, 1000baseT adapter
 179 .It
 180 SK-9821 SK-NET GE-T single port, 1000baseT adapter
 181 .It
 182 SK-9822 SK-NET GE-T dual port, 1000baseT adapter
 183 .It
 184 SK-9841 SK-NET GE-LX single port, single mode fiber adapter
 185 .It
 186 SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
 187 .It
 188 SK-9843 SK-NET GE-SX single port, multimode fiber adapter
 189 .It
 190 SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
 191 .It
 192 SMC 9452TX single port, 1000baseT adapter
 193 .El
 194 .Sh LOADER TUNABLES
 195 Tunables can be set at the
 196 .Xr loader 8
 197 prompt before booting the kernel or stored in
 198 .Xr loader.conf 5 .
 199 .Bl -tag -width xxxxxx
 200 .It Va hw.skc.jumbo_disable
 201 Disable jumbo frame support.
 202 Systems with less memory can set it to a non-zero value to save memory.
 203 The default value is 0.
 204 .El
 205 .Sh SYSCTL VARIABLES
 206 The following variable is available as both
 207 .Xr sysctl 8
 208 variable and
 209 .Xr loader 8
 210 tunable:
 211 .Bl -tag -width xxxxxx
 212 .It Va dev.skc.%d.int_mod
 213 This variable controls interrupt moderation.
 214 The accepted range is 10 to 10000.
 215 The default value is 100 microseconds.
 216 The interface has to be brought down and up again before a change takes effect.
 217 .El
 218 .Sh DIAGNOSTICS
 219 .Bl -diag
 220 .It "sk%d: couldn't map memory"
 221 A fatal initialization error has occurred.
 222 .It "sk%d: couldn't map ports"
 223 A fatal initialization error has occurred.
 224 .It "sk%d: couldn't map interrupt"
 225 A fatal initialization error has occurred.
 226 .It "sk%d: no memory for softc struct!"
 227 The driver failed to allocate memory for per-device instance information
 228 during initialization.
 229 .It "sk%d: failed to enable memory mapping!"
 230 The driver failed to initialize PCI shared memory mapping.
 231 This might
 232 happen if the card is not in a bus-master slot.
 233 .It "sk%d: no memory for jumbo buffers!"
 234 The driver failed to allocate memory for jumbo frames during
 235 initialization.
 236 .It "sk%d: watchdog timeout"
 237 The device has stopped responding to the network, or there is a problem with
 238 the network connection (cable).
 239 .El
 240 .Sh SEE ALSO
 241 .Xr altq 4 ,
 242 .Xr arp 4 ,
 243 .Xr miibus 4 ,
 244 .Xr netintro 4 ,
 245 .Xr ng_ether 4 ,
 246 .Xr vlan 4 ,
 247 .Xr ifconfig 8
 248 .Rs
 249 .%T XaQti XMAC II datasheet
 250 .%O http://www.xaqti.com
 251 .Re
 252 .Rs
 253 .%T SysKonnect GEnesis programming manual
 254 .%O http://www.syskonnect.com
 255 .Re
 256 .Sh HISTORY
 257 The
 258 .Nm
 259 device driver first appeared in
 260 .Fx 3.0 .
 261 .Sh AUTHORS
 262 The
 263 .Nm
 264 driver was written by
 265 .An Bill Paul Aq wpaul@ctr.columbia.edu .