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 July 3, 1999
  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 .Cd "device miibus"
  41 .Cd "device sk"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides support for the SysKonnect SK-984x and SK-982x series PCI
  46 gigabit ethernet adapters, including the following:
  47 .Pp
  48 .Bl -bullet -offset indent -compact
  49 .It
  50 SK-9821 SK-NET GE-T single port, 1000baseT adapter
  51 .It
  52 SK-9822 SK-NET GE-T dual port, 1000baseT adapter
  53 .It
  54 SK-9841 SK-NET GE-LX single port, single mode fiber adapter
  55 .It
  56 SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
  57 .It
  58 SK-9843 SK-NET GE-SX single port, multimode fiber adapter
  59 .It
  60 SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
  61 .El
  62 .Pp
  63 The SysKonnect adapters consist of two main components: the XaQti Corp.
  64 XMAC II gigabit MAC and the SysKonnect GEnesis controller ASIC.
  65 The
  66 XMAC provides the gigabit MAC and PHY suspport while the GEnesis
  67 provides an interface to the PCI bus, DMA support, packet buffering
  68 and arbitration.
  69 The GEnesis can control up to two XMACs simultaneously,
  70 allowing dual-port NIC configurations.
  71 .Pp
  72 The SK-982x 1000baseT adapters also include a Broadcom BCM5400 1000baseTX
  73 PHY which is used in place of the XMAC's internal PHY.
  74 The Broadcom PHY is connected to the XMAC via its GMII port.
  75 .Pp
  76 The
  77 .Nm
  78 driver configures dual port SysKonnect adapters such that each XMAC
  79 is treated as a separate logical network interface.
  80 Both ports can
  81 operate indepenently of each other and can be connected to separate
  82 networks.
  83 The SysKonnect driver software currently only uses the
  84 second port on dual port adapters for failover purposes: if the link
  85 on the primary port fails, the SysKonnect driver will automatically
  86 switch traffic onto the second port.
  87 .Pp
  88 The XaQti XMAC II supports full and half duplex operation with
  89 autonegotiation.
  90 The XMAC also supports unlimited frame sizes.
  91 Support for jumbo frames is provided via the interface MTU setting.
  92 Selecting an MTU larger than 1500 bytes with the
  93 .Xr ifconfig 8
  94 utility configures the adapter to receive and transmit jumbo frames.
  95 Using jumbo frames can greatly improve performance for certain tasks,
  96 such as file transfers and data streaming.
  97 .Pp
  98 The
  99 .Nm
 100 driver supports the following media types:
 101 .Pp
 102 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 103 .It autoselect
 104 Enable autoselection of the media type and options.
 105 The user can manually override
 106 the autoselected mode by adding media options to the
 107 .Pa /etc/rc.conf
 108 file.
 109 .It 1000baseTX
 110 Set 1000baseTX operation over twisted pair.
 111 This is only available
 112 for SK-982x series adapters with 1000baseT ports.
 113 Both
 114 .Ar full-duplex
 115 and
 116 .Ar half-duplex
 117 modes are supported.
 118 .It 1000baseSX
 119 Set 1000Mbps (gigabit ethernet) operation.
 120 Both
 121 .Ar full-duplex
 122 and
 123 .Ar half-duplex
 124 modes are supported.
 125 .El
 126 .Pp
 127 The
 128 .Nm
 129 driver supports the following media options:
 130 .Pp
 131 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 132 .It full-duplex
 133 Force full duplex operation
 134 .It half-duplex
 135 Force half duplex operation.
 136 .El
 137 .Pp
 138 The
 139 .Nm
 140 driver also supports one special link option for 1000baseTX cards:
 141 .Pp
 142 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 143 .It link0
 144 With 1000baseTX cards, establishing a link between two ports requires
 145 that one port be configured as a master and the other a slave.
 146 With autonegotiation,
 147 the master/slave settings will be chosen automatically.
 148 However when manually selecting the link state, it is necessary to
 149 force one side of the link to be a master and the other a slave.
 150 The
 151 .Nm
 152 driver configures the ports as slaves by default.
 153 Setting the
 154 .Ar link0
 155 flag with
 156 .Xr ifconfig 8
 157 will set a port as a master instead.
 158 .El
 159 .Pp
 160 For more information on configuring this device, see
 161 .Xr ifconfig 8 .
 162 .Sh DIAGNOSTICS
 163 .Bl -diag
 164 .It "sk%d: couldn't map memory"
 165 A fatal initialization error has occurred.
 166 .It "sk%d: couldn't map ports"
 167 A fatal initialization error has occurred.
 168 .It "sk%d: couldn't map interrupt"
 169 A fatal initialization error has occurred.
 170 .It "sk%d: no memory for softc struct!"
 171 The driver failed to allocate memory for per-device instance information
 172 during initialization.
 173 .It "sk%d: failed to enable memory mapping!"
 174 The driver failed to initialize PCI shared memory mapping.
 175 This might
 176 happen if the card is not in a bus-master slot.
 177 .It "sk%d: no memory for jumbo buffers!"
 178 The driver failed to allocate memory for jumbo frames during
 179 initialization.
 180 .It "sk%d: watchdog timeout"
 181 The device has stopped responding to the network, or there is a problem with
 182 the network connection (cable).
 183 .El
 184 .Sh SEE ALSO
 185 .Xr arp 4 ,
 186 .Xr netintro 4 ,
 187 .Xr ng_ether 4 ,
 188 .Xr vlan 4 ,
 189 .Xr ifconfig 8
 190 .Rs
 191 .%T XaQti XMAC II datasheet
 192 .%O http://www.xaqti.com
 193 .Re
 194 .Rs
 195 .%T SysKonnect GEnesis programming manual
 196 .%O http://www.syskonnect.com
 197 .Re
 198 .Sh HISTORY
 199 The
 200 .Nm
 201 device driver first appeared in
 202 .Fx 3.0 .
 203 .Sh AUTHORS
 204 The
 205 .Nm
 206 driver was written by
 207 .An Bill Paul Aq wpaul@ctr.columbia.edu .