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: src/share/man/man4/sk.4,v 1.8.2.6 2001/08/17 13:08:39 ru Exp $
  32 .\"
  33 .Dd November 2, 2006
  34 .Dt SK 4
  35 .Os
  36 .Sh NAME
  37 .Nm sk
  38 .Nd "SysKonnect XMAC II and Marvell Yukon based Gigabit Ethernet device"
  39 .Sh SYNOPSIS
  40 .Cd "device miibus"
  41 .Cd "device sk"
  42 .Pp
  43 Alternatively, to load the driver as a module at boot time, place the
  44 following line in
  45 .Pa /boot/loader.conf :
  46 .Bd -literal -offset indent
  47 if_sk_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for SysKonnect based Gigabit Ethernet adapters and
  53 Marvell based Gigabit Ethernet adapters.
  54 .Pp
  55 The SysKonnect based adapters consist of two main components:
  56 the XaQti Corp. XMAC II gigabit MAC and
  57 the SysKonnect GEnesis controller ASIC.
  58 The XMAC provides the gigabit MAC and PHY support
  59 while the GEnesis provides an interface to the PCI bus,
  60 DMA support, packet buffering and arbitration.
  61 The GEnesis can control up to two XMACs simultaneously,
  62 allowing dual-port NIC configurations.
  63 .Pp
  64 The Marvell based adapters are a single integrated circuit,
  65 but are still presented as a separate MAC and controller ASIC.
  66 .Pp
  67 The
  68 .Nm
  69 driver configures dual port SysKonnect adapters such that each XMAC
  70 is treated as a separate logical network interface.
  71 Both ports can
  72 operate independently of each other and can be connected to separate
  73 networks.
  74 The SysKonnect driver software currently only uses the
  75 second port on dual port adapters for failover purposes: if the link
  76 on the primary port fails, the SysKonnect driver will automatically
  77 switch traffic onto the second port.
  78 .Pp
  79 The XaQti XMAC II supports full and half duplex operation with
  80 autonegotiation.
  81 The XMAC also supports unlimited frame sizes.
  82 Support for jumbo frames is provided via the interface MTU setting.
  83 Selecting an MTU larger than 1500 bytes with the
  84 .Xr ifconfig 8
  85 utility configures the adapter to receive and transmit jumbo frames.
  86 Using jumbo frames can greatly improve performance for certain tasks,
  87 such as file transfers and data streaming.
  88 .Pp
  89 The
  90 .Nm
  91 driver supports the following media types:
  92 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  93 .It autoselect
  94 Enable autoselection of the media type and options.
  95 The user can manually override
  96 the autoselected mode by adding media options to the
  97 .Pa /etc/rc.conf
  98 file.
  99 .It 1000baseT
 100 Set 1000baseT operation over twisted pair.
 101 This is only available
 102 for SK-982x series adapters with 1000baseT ports.
 103 Both
 104 .Ar full-duplex
 105 and
 106 .Ar half-duplex
 107 modes are supported.
 108 .It 1000baseSX
 109 Set 1000Mbps (gigabit ethernet) operation.
 110 Both
 111 .Ar full-duplex
 112 and
 113 .Ar half-duplex
 114 modes are supported.
 115 .El
 116 .Pp
 117 The
 118 .Nm
 119 driver supports the following media options:
 120 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 121 .It full-duplex
 122 Force full duplex operation
 123 .It half-duplex
 124 Force half duplex operation.
 125 .El
 126 .Pp
 127 The
 128 .Nm
 129 driver also supports one special link option for 1000baseT cards:
 130 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 131 .It link0
 132 With 1000baseT cards, establishing a link between two ports requires
 133 that one port be configured as a master and the other a slave.
 134 With autonegotiation,
 135 the master/slave settings will be chosen automatically.
 136 However when manually selecting the link state, it is necessary to
 137 force one side of the link to be a master and the other a slave.
 138 The
 139 .Nm
 140 driver configures the ports as slaves by default.
 141 Setting the
 142 .Ar link0
 143 flag with
 144 .Xr ifconfig 8
 145 will set a port as a master instead.
 146 .El
 147 .Pp
 148 For more information on configuring this device, see
 149 .Xr ifconfig 8 .
 150 .Sh HARDWARE
 151 The
 152 .Nm
 153 driver supports SysKonnect based Gigabit Ethernet adapters and
 154 Marvell based Gigabit Ethernet adapters, including the following:
 155 .Pp
 156 .Bl -bullet -compact
 157 .It
 158 3Com 3c940 single port, copper adapter
 159 .It
 160 3Com 3c2000-T single port, copper adapter
 161 .It
 162 Belkin F5D5005, copper adapter
 163 .It
 164 D-Link DGE-530T, copper adapter
 165 .It
 166 Linksys EG1032v2, copper adapter
 167 .It
 168 Linksys EG1064v2, copper adapter
 169 .It
 170 SK-9821 SK-NET GE-T single port, copper adapter
 171 .It
 172 SK-9822 SK-NET GE-T dual port, copper adapter
 173 .It
 174 SK-9841 SK-NET GE-LX single port, single mode fiber adapter
 175 .It
 176 SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
 177 .It
 178 SK-9843 SK-NET GE-SX single port, multimode fiber adapter
 179 .It
 180 SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
 181 .It
 182 SK-9521 V2.0 single port, copper adapter (32-bit)
 183 .It
 184 SK-9821 V2.0 single port, copper adapter
 185 .It
 186 SK-9843 V2.0 single port, copper adapter
 187 .It
 188 SMC 9452TX, copper adapter
 189 .El
 190 .Sh DIAGNOSTICS
 191 .Bl -diag
 192 .It "skc%d: couldn't map memory"
 193 A fatal initialization error has occurred.
 194 .It "skc%d: couldn't map interrupt"
 195 A fatal initialization error has occurred.
 196 .It "sk%d: jumbo buffer allocation failed"
 197 The driver failed to allocate memory for jumbo frames
 198 during initialization.
 199 .It "sk%d: watchdog timeout"
 200 The device has stopped responding to the network, or there is a problem with
 201 the network connection (cable).
 202 .El
 203 .Sh SEE ALSO
 204 .Xr arp 4 ,
 205 .Xr ifmedia 4 ,
 206 .Xr miibus 4 ,
 207 .Xr netintro 4 ,
 208 .Xr ng_ether 4 ,
 209 .Xr vlan 4 ,
 210 .Xr ifconfig 8
 211 .Rs
 212 .%T XaQti XMAC II datasheet
 213 .%O http://www.xaqti.com
 214 .Re
 215 .Rs
 216 .%T SysKonnect GEnesis programming manual
 217 .%O http://www.syskonnect.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 Mt wpaul@ctr.columbia.edu .