xref: /openbsd-src/share/man/man4/sk.4 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: sk.4,v 1.12 2001/06/22 12:15:47 mpech 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 July 3, 1999
36.Dt SK 4
37.Os
38.Sh NAME
39.Nm sk
40.Nd SysKonnect SK-984x PCI Gigabit Ethernet driver
41.Sh SYNOPSIS
42.Cd "skc* at pci? dev ? function ?"
43.Cd "sk* at skc?"
44.Sh DESCRIPTION
45The
46.Nm
47driver provides support for the SysKonnect SK-984x series PCI
48Gigabit Ethernet adapters, including the following:
49.Pp
50.Bl -bullet -offset indent -compact
51.It
52SK-9821 SK-NET GE-T single port, copper adapter
53.It
54SK-9822 SK-NET GE-T dual port, copper adapter
55.It
56SK-9841 SK-NET GE-LX single port, single mode fiber adapter
57.It
58SK-9842 SK-NET GE-SX single port, multimode fiber adapter
59.It
60SK-9843 SK-NET GE-LX dual port, single mode fiber adapter
61.It
62SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
63.El
64.Pp
65The SysKonnect adapters consist of two main components: the XaQti Corp.
66XMAC II Gigabit MAC (sk) and the SysKonnect GEnesis controller ASIC (skc).
67The XMAC provides the Gigabit MAC and PHY support while the GEnesis
68provides an interface to the PCI bus, DMA support, packet buffering
69and arbitration. The GEnesis can control up to two XMACs simultaneously,
70allowing dual-port NIC configurations.
71.Pp
72The
73.Nm
74driver configures dual port SysKonnect adapters such that each XMAC
75is treated as a separate logical network interface. Both ports can
76operate independently of each other and can be connected to separate
77networks. The SysKonnect driver software currently only uses the
78second port on dual port adapters for failover purposes: if the link
79on the primary port fails, the SysKonnect driver will automatically
80switch traffic onto the second port.
81.Pp
82The XaQti XMAC II supports full and half duplex operation with
83autonegotiation. The XMAC also supports unlimited frame sizes.
84Support for jumbo frames is provided via the interface MTU setting.
85Selecting an MTU larger than 1500 bytes with the
86.Xr ifconfig 8
87utility configures the adapter to receive and transmit jumbo frames.
88Using jumbo frames can greatly improve performance for certain tasks,
89such as file transfers and data streaming.
90.Pp
91The following media types and options (as given to
92.Xr ifconfig 8 )
93are supported:
94.Pp
95.Bl -tag -width xxx -offset indent
96.It Cm media No autoselect
97Enable autoselection of the media type and options.
98The user can manually override
99the autoselected mode by adding media options to the appropriate
100.Pa /etc/hostname.skX
101file.
102.It Cm media No 1000baseSX Cm mediaopt No full-duplex
103Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode.
104.It Cm media No 1000baseSX Cm mediaopt No half-duplex
105Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode.
106.It Cm media No 1000baseT Cm mediaopt
107Set 1000Mbps (Gigabit Ethernet) operation and force full-duplex mode.
108.El
109.Pp
110For more information on configuring this device, see
111.Xr ifconfig 8 .
112To view a list of media types and options supported by your card try
113.Ic ifconfig -m <device> .
114For example,
115.Ic ifconfig -m sk0 .
116.Sh DIAGNOSTICS
117.Bl -diag
118.It "sk%d: couldn't map memory"
119A fatal initialization error has occurred.
120.It "sk%d: couldn't map ports"
121A fatal initialization error has occurred.
122.It "sk%d: couldn't map interrupt"
123A fatal initialization error has occurred.
124.It "sk%d: failed to enable memory mapping!"
125The driver failed to initialize PCI shared memory mapping. This might
126happen if the card is not in a bus-master slot.
127.It "sk%d: no memory for jumbo buffers!"
128The driver failed to allocate memory for jumbo frames during
129initialization.
130.It "sk%d: watchdog timeout"
131The device has stopped responding to the network, or there is a problem with
132the network connection (cable).
133.El
134.Sh SEE ALSO
135.Xr ifmedia 4 ,
136.Xr ifconfig 8
137.Rs
138.%T XaQti XMAC II datasheet
139.%O http://www.xaqti.com
140.Re
141.Rs
142.%T SysKonnect GEnesis programming manual
143.%O http://www.syskonnect.com
144.Re
145.Sh HISTORY
146The
147.Nm
148device driver first appeared in
149.Fx 3.0 ,
150and
151.Ox
152support was added in
153.Ox 2.6 .
154.Sh AUTHORS
155The
156.Nm
157driver was written by
158.An Bill Paul Aq wpaul@ctr.columbia.edu .
159