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