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