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