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