1.\" $NetBSD: sk.4,v 1.8 2005/07/22 14:18:21 peter Exp $ 2.\" 3.\" Copyright (c) 2003, The NetBSD Foundation, Inc. 4.\" 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 the NetBSD 17.\" Foundation, Inc. and its contributors. 18.\" 4. Neither the name of The NetBSD Foundation nor the names of its 19.\" contributors may be used to endorse or promote products derived 20.\" from this software without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32.\" POSSIBILITY OF SUCH DAMAGE. 33.\" 34.\" $OpenBSD: sk.4,v 1.20 2003/08/17 00:59:58 nate Exp $ 35.\" 36.\" Copyright (c) 1997, 1998, 1999 37.\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. 38.\" 39.\" Redistribution and use in source and binary forms, with or without 40.\" modification, are permitted provided that the following conditions 41.\" are met: 42.\" 1. Redistributions of source code must retain the above copyright 43.\" notice, this list of conditions and the following disclaimer. 44.\" 2. Redistributions in binary form must reproduce the above copyright 45.\" notice, this list of conditions and the following disclaimer in the 46.\" documentation and/or other materials provided with the distribution. 47.\" 3. All advertising materials mentioning features or use of this software 48.\" must display the following acknowledgement: 49.\" This product includes software developed by Bill Paul. 50.\" 4. Neither the name of the author nor the names of any co-contributors 51.\" may be used to endorse or promote products derived from this software 52.\" without specific prior written permission. 53.\" 54.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 55.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 56.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 57.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 58.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 59.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 60.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 61.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 62.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 63.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 64.\" THE POSSIBILITY OF SUCH DAMAGE. 65.\" 66.\" $FreeBSD: src/share/man/man4/man4.i386/sk.4,v 1.3 1999/08/28 00:20:29 peter Exp $ 67.\" 68.Dd January 23, 2005 69.Dt SK 4 70.Os 71.Sh NAME 72.Nm sk , 73.Nm skc 74.Nd SysKonnect XMAC II and Marvell GMAC based gigabit ethernet 75.Sh SYNOPSIS 76.Cd "skc* at pci? dev ? function ?" 77.Cd "sk* at skc?" 78.Sh DESCRIPTION 79The 80.Nm sk 81driver provides support for SysKonnect based gigabit ethernet adapters 82and Marvell based gigabit ethernet adapters, including the following: 83.Pp 84.Bl -bullet -offset indent -compact 85.It 86SK-9821 SK-NET GE-T single port, copper adapter 87.It 88SK-9822 SK-NET GE-T dual port, copper adapter 89.It 90SK-9841 SK-NET GE-LX single port, single mode fiber adapter 91.It 92SK-9842 SK-NET GE-LX dual port, single mode fiber adapter 93.It 94SK-9843 SK-NET GE-SX single port, multimode fiber adapter 95.It 96SK-9844 SK-NET GE-SX dual port, multimode fiber adapter 97.It 98SK-9521 V2.0 single port, copper adapter (32-bit) 99.It 100SK-9821 V2.0 single port, copper adapter 101.It 102SK-9843 V2.0 single port, copper adapter 103.It 1043Com 3c940 single port, copper adapter 105.It 106Belkin Gigabit Desktop Network PCI Card, single port, copper (32-bit) 107.It 108D-Link DGE-530T single port, copper adapter 109.It 110Linksys EG1032v2 single-port, copper adapter 111.It 112Linksys EG1064v2 single-port, copper adapter 113.El 114.Pp 115The SysKonnect based adapters consist of two main components: the 116XaQti Corp. XMAC II Gigabit MAC 117.Pq Nm sk 118and the SysKonnect GEnesis controller ASIC 119.Pq Nm skc . 120The XMAC provides the Gigabit MAC and PHY support 121while the GEnesis provides an interface to the PCI bus, DMA support, 122packet buffering and arbitration. 123The GEnesis can control up to two XMACs simultaneously, 124allowing dual-port NIC configurations. 125.Pp 126The Marvell based adapters are a single integrated circuit, but are 127still presented as a separate MAC 128.Pq Nm sk 129and controller ASIC 130.Pq Nm skc . 131At this time, there are no dual-port Marvell based NICs. 132.Pp 133The 134.Nm 135driver configures dual port SysKonnect adapters such that each XMAC 136is treated as a separate logical network interface. 137Both ports can operate independently of each other and can be connected 138to separate networks. 139The SysKonnect driver software currently only uses the second port on 140dual port adapters for failover purposes: if the link 141on the primary port fails, the SysKonnect driver will automatically 142switch traffic onto the second port. 143.Pp 144The XaQti XMAC II supports full and half duplex operation with 145autonegotiation. 146The XMAC also supports unlimited frame sizes. 147Support for jumbo frames is provided via the interface MTU setting. 148Selecting an MTU larger than 1500 bytes with the 149.Xr ifconfig 8 150utility configures the adapter to receive and transmit jumbo frames. 151Using jumbo frames can greatly improve performance for certain tasks, 152such as file transfers and data streaming. 153.Pp 154Hardware TCP/IP checksum offloading for IPv4 is supported. 155.Pp 156The following media types and options (as given to 157.Xr ifconfig 8 ) 158are supported: 159.Bl -tag -width xxx -offset indent 160.It Cm media No autoselect 161Enable autoselection of the media type and options. 162The user can manually override 163the autoselected mode. 164.\" by adding media options to the appropriate 165.\" .Xr hostname.if 5 166.\" file. 167.It Cm media No 1000baseSX Cm mediaopt No full-duplex 168Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode. 169.It Cm media No 1000baseSX Cm mediaopt No half-duplex 170Set 1000Mbps (Gigabit Ethernet) operation on fiber and force half-duplex mode. 171.It Cm media No 1000baseT Cm mediaopt No full-duplex 172Set 1000Mbps (Gigabit Ethernet) operation and force full-duplex mode. 173.El 174.Pp 175For more information on configuring this device, see 176.Xr ifconfig 8 . 177To view a list of media types and options supported by the card, try 178.Ic ifconfig Fl m Aq device . 179For example, 180.Ic ifconfig Fl m Ar sk0 . 181.Sh DIAGNOSTICS 182.Bl -diag 183.It "sk%d: couldn't map memory" 184A fatal initialization error has occurred. 185.It "sk%d: couldn't map ports" 186A fatal initialization error has occurred. 187.It "sk%d: couldn't map interrupt" 188A fatal initialization error has occurred. 189.It "sk%d: failed to enable memory mapping!" 190The driver failed to initialize PCI shared memory mapping. 191This might happen if the card is not in a bus-master slot. 192.It "sk%d: no memory for jumbo buffers!" 193The driver failed to allocate memory for jumbo frames during 194initialization. 195.It "sk%d: watchdog timeout" 196The device has stopped responding to the network, or there is a problem with 197the network connection (cable). 198.El 199.Sh SEE ALSO 200.Xr ifmedia 4 , 201.Xr intro 4 , 202.Xr netintro 4 , 203.Xr pci 4 , 204.Xr ifconfig 8 205.Rs 206.%T XaQti XMAC II datasheet 207.%O http://www.xaqti.com 208.Re 209.Rs 210.%T SysKonnect GEnesis programming manual 211.%O http://www.syskonnect.com 212.Re 213.Sh HISTORY 214The 215.Nm 216device driver first appeared in 217.Fx 3.0 . 218.Ox 219support was added in 220.Ox 2.6 . 221.Nx 222support was added in 223.Nx 2.0 . 224.Sh AUTHORS 225The 226.Nm 227driver was written by 228.An Bill Paul Aq wpaul@ctr.columbia.edu . 229.Sh BUGS 230This driver is 231.Em experimental . 232.Pp 233Support for the jumbo-frame feature does not currently work with 234Marvell-based adapters under 235.Nx 236and is disabled. 237.Pp 238Support for checksum offload is unimplemented. 239.Pp 240Performance with at least some Marvell-based adapters is poor, 241especially on loaded PCI buses or when the adapters are behind 242PCI-PCI bridges. 243It is believed that this is because the Marvell parts have 244significantly less buffering than the original SysKonnect cards 245had. 246