xref: /openbsd-src/share/man/man4/sk.4 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\"	$OpenBSD: sk.4,v 1.59 2009/03/30 04:44:30 jmc Exp $
2.\"
3.\" Copyright (c) 1997, 1998, 1999
4.\"	Bill Paul <wpaul@ctr.columbia.edu>. 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 Bill Paul.
17.\" 4. Neither the name of the author nor the names of any co-contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"   without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31.\" THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\" $FreeBSD: src/share/man/man4/man4.i386/sk.4,v 1.3 1999/08/28 00:20:29 peter Exp $
34.\"
35.Dd $Mdocdate: March 30 2009 $
36.Dt SK 4
37.Os
38.Sh NAME
39.Nm sk ,
40.Nm skc
41.Nd "SysKonnect XMAC II and Marvell Yukon 10/100/Gigabit Ethernet device"
42.Sh SYNOPSIS
43.Cd "skc* at pci?"
44.Cd "sk* at skc?"
45.Cd "brgphy* at mii?"
46.Cd "eephy* at mii?"
47.Cd "xmphy* at mii?"
48.Sh DESCRIPTION
49The
50.Nm
51driver provides support for SysKonnect GEnesis and Marvell Yukon
5288E8001, 88E8003 and 88E8010 based Gigabit Ethernet adapters,
53including the following:
54.Pp
55.Bl -bullet -offset indent -compact
56.It
573Com 3c940 single port, copper adapter
58.It
593Com 3c2000-T single port, copper adapter
60.It
61Belkin F5D5005 v1000, copper adapter
62.It
63D-Link DGE-530T A1, copper adapter
64.It
65D-Link DGE-530T B1, copper adapter
66.It
67Fujitsu PP028GE1U, multimode fiber adapter
68.It
69Fujitsu PP028GE1X, multimode fiber adapter
70.It
71Fujitsu PW008GE1U, copper adapter
72.It
73Fujitsu PW008GE1X, copper adapter
74.It
75Linksys EG1032v2, copper adapter
76.It
77Linksys EG1064v2, copper adapter
78.It
79SMC 9452TX, copper adapter
80.It
81SysKonnect SK-9521 V2.0 single port, copper adapter
82.It
83SysKonnect SK-9821 single port, copper adapter
84.It
85SysKonnect SK-9821 V2.0 single port, copper adapter
86.It
87SysKonnect SK-9822 dual port, copper adapter
88.It
89SysKonnect SK-9841 single port, single mode fiber adapter
90.It
91SysKonnect SK-9842 dual port, single mode fiber adapter
92.It
93SysKonnect SK-9843 single port, multimode fiber adapter
94.It
95SysKonnect SK-9843 V2.0 single port, copper adapter
96.It
97SysKonnect SK-9844 dual port, multimode fiber adapter
98.El
99.Pp
100The SysKonnect based adapters consist of two main components: the
101XaQti Corp.\&
102XMAC II Gigabit MAC (sk) and the SysKonnect GEnesis controller ASIC (skc).
103The XMAC provides the Gigabit MAC and PHY support
104while the GEnesis provides an interface to the PCI bus, DMA support,
105packet buffering and arbitration.
106The GEnesis can control up to two XMACs simultaneously,
107allowing dual-port NIC configurations.
108.Pp
109The Marvell based adapters are a single integrated circuit, but are
110still presented as a separate MAC (sk) and controller ASIC (skc).
111.Pp
112The GEnesis and Yukon 88E8001, 88E8003 and 88E8010 also support a
113frame size of up to 9000 bytes.
114Support for Jumbo frames is provided via the interface MTU setting.
115Selecting an MTU larger than 1500 bytes with the
116.Xr ifconfig 8
117utility configures the adapter to transmit Jumbo frames.
118Using Jumbo frames can greatly improve performance for certain tasks,
119such as file transfers and data streaming.
120.Pp
121Hardware receive IP checksum offload for IPv4 is supported.
122.Pp
123The
124.Nm
125driver supports the following media types:
126.Bl -tag -width 1000baseSX
127.It Cm autoselect
128Enable autoselection of the media type and options.
129The user can manually override
130the autoselected mode by adding media options to the appropriate
131.Xr hostname.if 5
132file.
133.It Cm 10baseT
134Set 10Mbps operation.
135The
136.Xr ifconfig 8
137.Ic mediaopt
138option can also be used to select either
139.Cm full-duplex
140or
141.Cm half-duplex
142modes.
143.It Cm 100baseTX
144Set 100Mbps (Fast Ethernet) operation.
145The
146.Xr ifconfig 8
147.Ic mediaopt
148option can also be used to select either
149.Cm full-duplex
150or
151.Cm half-duplex
152modes.
153.It Cm 1000baseT
154Set 1000baseT (Gigabit Ethernet) operation over twisted pair.
155Both
156.Cm full-duplex
157and
158.Cm half-duplex
159modes are supported.
160.It Cm 1000baseSX
161Set 1000Mbps (Gigabit Ethernet) operation.
162Both
163.Cm full-duplex
164and
165.Cm half-duplex
166modes are supported.
167.El
168.Pp
169The
170.Nm
171driver supports the following media options:
172.Bl -tag -width full-duplex
173.It Cm full-duplex
174Force full duplex operation.
175.It Cm half-duplex
176Force half duplex operation.
177.El
178.Pp
179For more information on configuring this device, see
180.Xr ifconfig 8 .
181To view a list of media types and options supported by the card, try
182.Ic ifconfig <device> media .
183For example,
184.Ic ifconfig sk0 media .
185.Sh SEE ALSO
186.Xr arp 4 ,
187.Xr brgphy 4 ,
188.Xr eephy 4 ,
189.Xr ifmedia 4 ,
190.Xr intro 4 ,
191.Xr netintro 4 ,
192.Xr pci 4 ,
193.Xr xmphy 4 ,
194.Xr hostname.if 5 ,
195.Xr ifconfig 8
196.Rs
197.%T XaQti XMAC II datasheet
198.Re
199.Rs
200.%T SysKonnect GEnesis programming manual
201.%O http://www.syskonnect.com
202.Re
203.Sh HISTORY
204The
205.Nm
206device driver first appeared in
207.Fx 3.0 ,
208and
209.Ox
210support was added in
211.Ox 2.6 .
212.Sh AUTHORS
213.An -nosplit
214The
215.Nm
216driver was written by
217.An Bill Paul Aq wpaul@ctr.columbia.edu .
218