xref: /freebsd/share/man/man4/sk.4 (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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 i386
35.Os FreeBSD
36.Sh NAME
37.Nm sk
38.Nd
39SysKonnect SK-984x PCI gigabit ethernet adapter driver
40.Sh SYNOPSIS
41.Cd "device sk0"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for the SysKonnect SK-984x series PCI
46gigabit ethernet adapters, including the following:
47.Bl -bullet -offset indent
48.It
49SK-9841 SK-NET GE-LX single port, single mode fiber adapter
50.It
51SK-9842 SK-NET GE-SX single port, multimode fiber adapter
52.It
53SK-9843 SK-NET GE-LX dual port, single mode fiber adapter
54.It
55SK-9844 SK-NET GE-SX duak port, multimode fiber adapter
56.El
57.Pp
58The SysKonnect adapters consist of two main components: the XaQti Corp.
59XMAC II gigabit MAC and the SysKonnect GEnesis controller ASIC. The
60XMAC provides the gigabit MAC and PHY suspport while the GEnesis
61provides an interface to the PCI bus, DMA support, packet buffering
62and arbitration. The GEnesis can control up to two XMACs simultaneously,
63allowing dual-port NIC configurations.
64.Pp
65The
66.Nm
67driver configures dual port SysKonnect adapters such that each XMAC
68is treated as a separate logical network interface. Both ports can
69operate indepenently of each other and can be connected to separate
70networks. The SysKonnect driver software currently only uses the
71second port on dual port adapters for failover purposes: if the link
72on the primary port fails, the SysKonnect driver will automatically
73switch traffic onto the second port.
74.Pp
75The XaQti XMAC II supports full and half duplex operation with
76autonegotiation. The XMAC also supports unlimited frame sizes.
77Support for jumbo frames is provided via the interface MTU setting.
78Selecting an MTU larger than 1500 bytes with the
79.Xr ifconfig 8
80utility configures the adapter to receive and transmit jumbo frames.
81Using jumbo frames can greatly improve performance for certain tasks,
82such as file transfers and data streaming.
83.Pp
84The
85.Nm
86driver supports the following media types:
87.Pp
88.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
89.It autoselect
90Enable autoselection of the media type and options.
91The user can manually override
92the autoselected mode by adding media options to the
93.Pa /etc/rc.conf
94file.
95.It 1000baseSX
96Set 1000Mbps (gigabit ethernet) operation. Both
97.Ar full-duplex
98and
99.Ar half-duplex
100modes are supported.
101.El
102.Pp
103The
104.Nm
105driver supports the following media options:
106.Pp
107.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
108.It full-duplex
109Force full duplex operation
110.It half-duplex
111Force half duplex operation.
112.El
113.Pp
114For more information on configuring this device, see
115.Xr ifconfig 8 .
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: no memory for softc struct!"
125The driver failed to allocate memory for per-device instance information
126during initialization.
127.It "sk%d: failed to enable memory mapping!"
128The driver failed to initialize PCI shared memory mapping. This might
129happen if the card is not in a bus-master slot.
130.It "sk%d: no memory for jumbo buffers!"
131The driver failed to allocate memory for jumbo frames during
132initialization.
133.It "sk%d: watchdog timeout"
134The device has stopped responding to the network, or there is a problem with
135the network connection (cable).
136.El
137.Sh SEE ALSO
138.Xr arp 4 ,
139.Xr netintro 4 ,
140.Xr vlan 4 ,
141.Xr ifconfig 8
142.Rs
143.%T XaQti XMAC II datasheet
144.%O http://www.xaqti.com
145.Re
146.Rs
147.%T SysKonnect GEnesis programming manual
148.%O http://www.syskonnect.com
149.Re
150.Sh HISTORY
151The
152.Nm
153device driver first appeared in
154.Fx 3.0 .
155.Sh AUTHORS
156The
157.Nm
158driver was written by
159.An Bill Paul Aq wpaul@ctr.columbia.edu .
160