xref: /netbsd-src/share/man/man4/sk.4 (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1.\"	$NetBSD: sk.4,v 1.4 2003/12/17 10:12:28 wiz 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.20 2003/08/17 00:59:58 nate 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 December 17, 2003
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.Sh DESCRIPTION
79The
80.Nm sk
81driver provides support for SysKonnect based gigabit ethernet adapters
82and Marvell based gigabit ethernet adapters, including the following:
83.Pp
84.Bl -bullet -offset indent -compact
85.It
86SK-9821 SK-NET GE-T single port, copper adapter
87.It
88SK-9822 SK-NET GE-T dual port, copper adapter
89.It
90SK-9841 SK-NET GE-LX single port, single mode fiber adapter
91.It
92SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
93.It
94SK-9843 SK-NET GE-SX single port, multimode fiber adapter
95.It
96SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
97.It
98SK-9521 V2.0 single port, copper adapter (32-bit)
99.It
100SK-9821 V2.0 single port, copper adapter
101.It
102SK-9843 V2.0 single port, copper adapter
103.It
1043com 3c940 single port, copper adapter
105.It
106D-Link DGE-530T single port, copper adapter
107.It
108Linksys EG1032v2 single-port, copper adapter
109.It
110Linksys EG1064v2 single-port, copper adapter
111.El
112.Pp
113The SysKonnect based adapters consist of two main components: the
114XaQti Corp. XMAC II Gigabit MAC
115.Pq Nm sk
116and the SysKonnect GEnesis controller ASIC
117.Pq Nm skc .
118The XMAC provides the Gigabit MAC and PHY support
119while the GEnesis provides an interface to the PCI bus, DMA support,
120packet buffering and arbitration.
121The GEnesis can control up to two XMACs simultaneously,
122allowing dual-port NIC configurations.
123.Pp
124The Marvell based adapters are a single integrated circuit, but are
125still presented as a separate MAC
126.Pq Nm sk
127and controller ASIC
128.Pq Nm skc .
129At this time, there are no dual-port Marvell based NICs.
130.Pp
131The
132.Nm
133driver configures dual port SysKonnect adapters such that each XMAC
134is treated as a separate logical network interface.
135Both ports can operate independently of each other and can be connected
136to separate networks.
137The SysKonnect driver software currently only uses the second port on
138dual port adapters for failover purposes: if the link
139on the primary port fails, the SysKonnect driver will automatically
140switch traffic onto the second port.
141.Pp
142The XaQti XMAC II supports full and half duplex operation with
143autonegotiation.
144The XMAC also supports unlimited frame sizes.
145Support for jumbo frames is provided via the interface MTU setting.
146Selecting an MTU larger than 1500 bytes with the
147.Xr ifconfig 8
148utility configures the adapter to receive and transmit jumbo frames.
149Using jumbo frames can greatly improve performance for certain tasks,
150such as file transfers and data streaming.
151.Pp
152Hardware TCP/IP checksum offloading for IPv4 is supported.
153.Pp
154The following media types and options (as given to
155.Xr ifconfig 8 )
156are supported:
157.Bl -tag -width xxx -offset indent
158.It Cm media No autoselect
159Enable autoselection of the media type and options.
160The user can manually override
161the autoselected mode.
162.\" by adding media options to the appropriate
163.\" .Xr hostname.if 5
164.\" file.
165.It Cm media No 1000baseSX Cm mediaopt No full-duplex
166Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode.
167.It Cm media No 1000baseSX Cm mediaopt No half-duplex
168Set 1000Mbps (Gigabit Ethernet) operation on fiber and force half-duplex mode.
169.It Cm media No 1000baseT Cm mediaopt No full-duplex
170Set 1000Mbps (Gigabit Ethernet) operation and force full-duplex mode.
171.El
172.Pp
173For more information on configuring this device, see
174.Xr ifconfig 8 .
175To view a list of media types and options supported by the card, try
176.Ic ifconfig -m Aq device .
177For example,
178.Ic ifconfig -m sk0 .
179.Sh DIAGNOSTICS
180.Bl -diag
181.It "sk%d: couldn't map memory"
182A fatal initialization error has occurred.
183.It "sk%d: couldn't map ports"
184A fatal initialization error has occurred.
185.It "sk%d: couldn't map interrupt"
186A fatal initialization error has occurred.
187.It "sk%d: failed to enable memory mapping!"
188The driver failed to initialize PCI shared memory mapping.
189This might happen if the card is not in a bus-master slot.
190.It "sk%d: no memory for jumbo buffers!"
191The driver failed to allocate memory for jumbo frames during
192initialization.
193.It "sk%d: watchdog timeout"
194The device has stopped responding to the network, or there is a problem with
195the network connection (cable).
196.El
197.Sh SEE ALSO
198.Xr ifmedia 4 ,
199.Xr intro 4 ,
200.Xr netintro 4 ,
201.Xr pci 4 ,
202.Xr ifconfig 8
203.Rs
204.%T XaQti XMAC II datasheet
205.%O http://www.xaqti.com
206.Re
207.Rs
208.%T SysKonnect GEnesis programming manual
209.%O http://www.syskonnect.com
210.Re
211.Sh HISTORY
212The
213.Nm
214device driver first appeared in
215.Fx 3.0 .
216.Ox
217support was added in
218.Ox 2.6 .
219.Nx
220support was added in
221.Nx 2.0 .
222.Sh AUTHORS
223The
224.Nm
225driver was written by
226.An Bill Paul Aq wpaul@ctr.columbia.edu .
227.Sh BUGS
228This driver is
229.Em experimental .
230.Pp
231Support for the jumbo-frame feature does not currently work with
232Marvell-based adapters under
233.Nx
234and is disabled.
235.Pp
236Support for checksum offload is unimplemented.
237.Pp
238Performance with at least some Marvell-based adapters is poor,
239especially on loaded PCI buses or when the adapters are behind
240PCI-PCI bridges.
241It is believed that this is because the Marvell parts have
242significantly less buffering than the original SysKonnect cards
243had.
244