xref: /netbsd-src/share/man/man4/sk.4 (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1.\"	$NetBSD: sk.4,v 1.11 2007/11/09 03:54:45 manu Exp $
2.\"
3.\" Copyright (c) 2003, The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the NetBSD
17.\"	Foundation, Inc. and its contributors.
18.\" 4. Neither the name of The NetBSD Foundation nor the names of its
19.\"    contributors may be used to endorse or promote products derived
20.\"    from this software without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32.\" POSSIBILITY OF SUCH DAMAGE.
33.\"
34.\"	$OpenBSD: sk.4,v 1.41 2006/08/16 22:01:56 kettenis Exp $
35.\"
36.\" Copyright (c) 1997, 1998, 1999
37.\"	Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
38.\"
39.\" Redistribution and use in source and binary forms, with or without
40.\" modification, are permitted provided that the following conditions
41.\" are met:
42.\" 1. Redistributions of source code must retain the above copyright
43.\"    notice, this list of conditions and the following disclaimer.
44.\" 2. Redistributions in binary form must reproduce the above copyright
45.\"    notice, this list of conditions and the following disclaimer in the
46.\"    documentation and/or other materials provided with the distribution.
47.\" 3. All advertising materials mentioning features or use of this software
48.\"    must display the following acknowledgement:
49.\"	This product includes software developed by Bill Paul.
50.\" 4. Neither the name of the author nor the names of any co-contributors
51.\"    may be used to endorse or promote products derived from this software
52.\"   without specific prior written permission.
53.\"
54.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
55.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
58.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
59.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
60.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
61.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
62.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
63.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
64.\" THE POSSIBILITY OF SUCH DAMAGE.
65.\"
66.\" $FreeBSD: src/share/man/man4/man4.i386/sk.4,v 1.3 1999/08/28 00:20:29 peter Exp $
67.\"
68.Dd September 9, 2006
69.Dt SK 4
70.Os
71.Sh NAME
72.Nm sk ,
73.Nm skc
74.Nd SysKonnect XMAC II and Marvell GMAC based gigabit ethernet
75.Sh SYNOPSIS
76.Cd "skc* at pci? dev ? function ?"
77.Cd "sk* at skc?"
78.Cd "mskc* at pci? dev ? function ?"
79.Cd "msk* at skc?"
80.Sh DESCRIPTION
81The
82.Nm sk
83driver provides support for SysKonnect based gigabit ethernet adapters
84and Marvell based gigabit ethernet adapters, including the following:
85.Pp
86.Bl -bullet -offset indent -compact
87.It
88SK-9821 SK-NET GE-T single port, copper adapter
89.It
90SK-9822 SK-NET GE-T dual port, copper adapter
91.It
92SK-9841 SK-NET GE-LX single port, single mode fiber adapter
93.It
94SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
95.It
96SK-9843 SK-NET GE-SX single port, multimode fiber adapter
97.It
98SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
99.It
100SK-9521 V2.0 single port, copper adapter (32-bit)
101.It
102SK-9821 V2.0 single port, copper adapter
103.It
104SK-9843 V2.0 single port, copper adapter
105.It
1063Com 3c940 single port, copper adapter
107.It
108Belkin Gigabit Desktop Network PCI Card, single port, copper (32-bit)
109.It
110D-Link DGE-530T single port, copper adapter
111.It
112Linksys EG1032v2 single-port, copper adapter
113.It
114Linksys EG1064v2 single-port, copper adapter
115.El
116.Pp
117The
118.Nm msk
119driver provides support for the Marvell Yukon-2 based Gigabit Ethernet
120adapters, including the following:
121.Pp
122.Bl -bullet -offset indent -compact
123.It
124Marvell Yukon 88E8035, copper adapter
125.It
126Marvell Yukon 88E8036, copper adapter
127.It
128Marvell Yukon 88E8038, copper adapter
129.It
130Marvell Yukon 88E8050, copper adapter
131.It
132Marvell Yukon 88E8052, copper adapter
133.It
134Marvell Yukon 88E8053, copper adapter
135.It
136Marvell Yukon 88E8055, copper adapter
137.It
138SK-9E21 1000Base-T single port, copper adapter
139.It
140SK-9E22 1000Base-T dual port, copper adapter
141.It
142SK-9E81 1000Base-SX single port, multimode fiber adapter
143.It
144SK-9E82 1000Base-SX dual port, multimode fiber adapter
145.It
146SK-9E91 1000Base-LX single port, single mode fiber adapter
147.It
148SK-9E92 1000Base-LX dual port, single mode fiber adapter
149.It
150SK-9S21 1000Base-T single port, copper adapter
151.It
152SK-9S22 1000Base-T dual port, copper adapter
153.It
154SK-9S81 1000Base-SX single port, multimode fiber adapter
155.It
156SK-9S82 1000Base-SX dual port, multimode fiber adapter
157.It
158SK-9S91 1000Base-LX single port, single mode fiber adapter
159.It
160SK-9S92 1000Base-LX dual port, single mode fiber adapter
161.It
162SK-9E21D 1000Base-T single port, copper adapter
163.El
164.Pp
165The SysKonnect based adapters consist of two main components: the
166XaQti Corp. XMAC II Gigabit MAC
167.Pq Nm sk
168and the SysKonnect GEnesis controller ASIC
169.Pq Nm skc .
170The XMAC provides the Gigabit MAC and PHY support
171while the GEnesis provides an interface to the PCI bus, DMA support,
172packet buffering and arbitration.
173The GEnesis can control up to two XMACs simultaneously,
174allowing dual-port NIC configurations.
175.Pp
176The Marvell based adapters are a single integrated circuit, but are
177still presented as a separate MAC
178.Pq Nm sk
179and controller ASIC
180.Pq Nm skc .
181At this time, there are no dual-port Marvell based NICs.
182.Pp
183The
184.Nm
185driver configures dual port SysKonnect adapters such that each XMAC
186is treated as a separate logical network interface.
187Both ports can operate independently of each other and can be connected
188to separate networks.
189The SysKonnect driver software currently only uses the second port on
190dual port adapters for failover purposes: if the link
191on the primary port fails, the SysKonnect driver will automatically
192switch traffic onto the second port.
193.Pp
194The XaQti XMAC II supports full and half duplex operation with
195autonegotiation.
196The XMAC also supports unlimited frame sizes.
197Support for jumbo frames is provided via the interface MTU setting.
198Selecting an MTU larger than 1500 bytes with the
199.Xr ifconfig 8
200utility configures the adapter to receive and transmit jumbo frames.
201Using jumbo frames can greatly improve performance for certain tasks,
202such as file transfers and data streaming.
203.Pp
204Hardware TCP/IP checksum offloading for IPv4 is supported.
205.Pp
206The following media types and options (as given to
207.Xr ifconfig 8 )
208are supported:
209.Bl -tag -width xxx -offset indent
210.It Cm media No autoselect
211Enable autoselection of the media type and options.
212The user can manually override
213the autoselected mode.
214.\" by adding media options to the appropriate
215.\" .Xr hostname.if 5
216.\" file.
217.It Cm media No 1000baseSX Cm mediaopt No full-duplex
218Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode.
219.It Cm media No 1000baseSX Cm mediaopt No half-duplex
220Set 1000Mbps (Gigabit Ethernet) operation on fiber and force half-duplex mode.
221.It Cm media No 1000baseT Cm mediaopt No full-duplex
222Set 1000Mbps (Gigabit Ethernet) operation and force full-duplex mode.
223.El
224.Pp
225For more information on configuring this device, see
226.Xr ifconfig 8 .
227To view a list of media types and options supported by the card, try
228.Ic ifconfig Fl m Aq device .
229For example,
230.Ic ifconfig Fl m Ar sk0 .
231.Sh DIAGNOSTICS
232.Bl -diag
233.It "sk%d: couldn't map memory"
234A fatal initialization error has occurred.
235.It "sk%d: couldn't map ports"
236A fatal initialization error has occurred.
237.It "sk%d: couldn't map interrupt"
238A fatal initialization error has occurred.
239.It "sk%d: failed to enable memory mapping!"
240The driver failed to initialize PCI shared memory mapping.
241This might happen if the card is not in a bus-master slot.
242.It "sk%d: no memory for jumbo buffers!"
243The driver failed to allocate memory for jumbo frames during
244initialization.
245.It "sk%d: watchdog timeout"
246The device has stopped responding to the network, or there is a problem with
247the network connection (cable).
248.El
249.Sh SEE ALSO
250.Xr ifmedia 4 ,
251.Xr intro 4 ,
252.Xr netintro 4 ,
253.Xr pci 4 ,
254.Xr ifconfig 8
255.Rs
256.%T XaQti XMAC II datasheet
257.%O http://www.xaqti.com
258.Re
259.Rs
260.%T SysKonnect GEnesis programming manual
261.%O http://www.syskonnect.com
262.Re
263.Sh HISTORY
264The
265.Nm
266device driver first appeared in
267.Fx 3.0 .
268.Ox
269support was added in
270.Ox 2.6 .
271.Nx
272support was added in
273.Nx 2.0 .
274.Pp
275The
276.Nm msk
277driver first appeared in
278.Ox 4.0 ,
279and was ported to
280.Nx 4.0 .
281.Sh AUTHORS
282The
283.Nm
284driver was written by
285.An Bill Paul Aq wpaul@ctr.columbia.edu .
286Support for the Marvell Yukon-2 was added by
287.An Mark Kettenis Aq kettenis@openbsd.org .
288.Sh BUGS
289This driver is
290.Em experimental .
291.Pp
292Support for checksum offload is unimplemented.
293.Pp
294Performance with at least some Marvell-based adapters is poor,
295especially on loaded PCI buses or when the adapters are behind
296PCI-PCI bridges.
297It is believed that this is because the Marvell parts have
298significantly less buffering than the original SysKonnect cards
299had.
300