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