share/man/man4/msk.4

   1 .\" Copyright (c) 2006 Pyun YongHyeon
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 5, 2007
  28 .Dt MSK 4
  29 .Os
  30 .Sh NAME
  31 .Nm msk
  32 .Nd Marvell/SysKonnect Yukon II Gigabit Ethernet adapter driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device miibus"
  39 .Cd "device msk"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 if_msk_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 device driver provides support for various NICs based on the
  52 Marvell/SysKonnect Yukon II Gigabit Ethernet controller chip.
  53 .Pp
  54 All NICs supported by the
  55 .Nm
  56 driver have TCP/UDP/IP checksum offload for transmit, TCP
  57 segmentation offload (TSO), hardware VLAN tag stripping/insertion
  58 features and an interrupt moderation mechanism as well as a 64-bit
  59 multicast hash filter.
  60 The Yukon II supports TBI (ten bit interface) and GMII
  61 transceivers, which means it can be used with either copper or
  62 1000baseX fiber applications.
  63 .Pp
  64 The Yukon II also supports Jumbo Frames (up to 9022 bytes), which can be
  65 configured via the interface MTU setting.
  66 Selecting an MTU larger than 1500 bytes with the
  67 .Xr ifconfig 8
  68 utility configures the adapter to receive and transmit Jumbo Frames.
  69 .Pp
  70 The
  71 .Nm
  72 driver supports the following media types:
  73 .Bl -tag -width ".Cm 10baseT/UTP"
  74 .It Cm autoselect
  75 Enable autoselection of the media type and options.
  76 The user can manually override
  77 the autoselected mode by adding media options to
  78 .Xr rc.conf 5 .
  79 .It Cm 10baseT/UTP
  80 Set 10Mbps operation.
  81 The
  82 .Xr ifconfig 8
  83 .Cm mediaopt
  84 option can also be used to select either
  85 .Cm full-duplex
  86 or
  87 .Cm half-duplex
  88 modes.
  89 .It Cm 100baseTX
  90 Set 100Mbps (Fast Ethernet) operation.
  91 The
  92 .Xr ifconfig 8
  93 .Cm mediaopt
  94 option can also be used to select either
  95 .Cm full-duplex
  96 or
  97 .Cm half-duplex
  98 modes.
  99 .It Cm 1000baseTX
 100 Set 1000baseTX operation over twisted pair.
 101 The
 102 .Xr ifconfig 8
 103 .Cm mediaopt
 104 option can also be used to select either
 105 .Cm full-duplex
 106 or
 107 .Cm half-duplex
 108 modes.
 109 .It Cm 1000baseSX
 110 Set 1000Mbps (Gigabit Ethernet) operation.
 111 Both
 112 .Cm full-duplex
 113 and
 114 .Cm half-duplex
 115 modes are supported.
 116 .El
 117 .Pp
 118 The
 119 .Nm
 120 driver supports the following media options:
 121 .Bl -tag -width ".Cm full-duplex"
 122 .It Cm full-duplex
 123 Force full duplex operation.
 124 .It Cm half-duplex
 125 Force half duplex operation.
 126 .El
 127 .Pp
 128 The
 129 .Nm
 130 driver also supports one special link option for 1000baseTX cards:
 131 .Bl -tag -width ".Cm link0"
 132 .It Cm link0
 133 With 1000baseTX cards, establishing a link between two ports requires
 134 that one port is configured as master and the other one as slave.
 135 With autonegotiation,
 136 the master/slave settings will be chosen automatically.
 137 However when manually selecting the link state, it is necessary to
 138 force one side of the link to be a master and the other a slave.
 139 The
 140 .Nm
 141 driver configures the ports as slaves by default.
 142 Setting the
 143 .Cm link0
 144 flag with
 145 .Xr ifconfig 8
 146 will set a port as a master instead.
 147 .El
 148 .Pp
 149 For more information on configuring this device, see
 150 .Xr ifconfig 8 .
 151 .Sh HARDWARE
 152 The
 153 .Nm
 154 driver provides support for various NICs based on the Marvell/SysKonnect
 155 Yukon II based Gigabit Ethernet controller chips, including:
 156 .Pp
 157 .Bl -bullet -compact
 158 .It
 159 D-Link 550SX Gigabit Ethernet
 160 .It
 161 D-Link 560T Gigabit Ethernet
 162 .It
 163 Marvell Yukon 88E8021CU Gigabit Ethernet
 164 .It
 165 Marvell Yukon 88E8021 SX/LX Gigabit Ethernet
 166 .It
 167 Marvell Yukon 88E8022CU Gigabit Ethernet
 168 .It
 169 Marvell Yukon 88E8022 SX/LX Gigabit Ethernet
 170 .It
 171 Marvell Yukon 88E8061CU Gigabit Ethernet
 172 .It
 173 Marvell Yukon 88E8061 SX/LX Gigabit Ethernet
 174 .It
 175 Marvell Yukon 88E8062CU Gigabit Ethernet
 176 .It
 177 Marvell Yukon 88E8062 SX/LX Gigabit Ethernet
 178 .It
 179 Marvell Yukon 88E8035 Gigabit Ethernet
 180 .It
 181 Marvell Yukon 88E8036 Gigabit Ethernet
 182 .It
 183 Marvell Yukon 88E8038 Gigabit Ethernet
 184 .It
 185 Marvell Yukon 88E8039 Gigabit Ethernet
 186 .It
 187 Marvell Yukon 88E8050 Gigabit Ethernet
 188 .It
 189 Marvell Yukon 88E8052 Gigabit Ethernet
 190 .It
 191 Marvell Yukon 88E8053 Gigabit Ethernet
 192 .It
 193 Marvell Yukon 88E8055 Gigabit Ethernet
 194 .It
 195 Marvell Yukon 88E8056 Gigabit Ethernet
 196 .It
 197 Marvell Yukon 88E8058 Gigabit Ethernet
 198 .It
 199 SysKonnect SK-9Sxx Gigabit Ethernet
 200 .It
 201 SysKonnect SK-9Exx Gigabit Ethernet
 202 .El
 203 .Sh LOADER TUNABLES
 204 Tunables can be set at the
 205 .Xr loader 8
 206 prompt before booting the kernel or stored in
 207 .Xr loader.conf 5 .
 208 .Bl -tag -width indent
 209 .It Va hw.msk.msi_disable
 210 This tunable disables MSI support on the Ethernet hardware.
 211 The default value is 0.
 212 .El
 213 .Sh SYSCTL VARIABLES
 214 The following variables are available as both
 215 .Xr sysctl 8
 216 variables and
 217 .Xr loader 8
 218 tunables:
 219 .Bl -tag -width indent
 220 .It Va dev.mskc.%d.process_limit
 221 Maximum amount of Rx events to be processed in the event loop before
 222 rescheduling a taskqueue.
 223 The accepted range is 30 to 256, the default value is 128 events.
 224 The interface does not need to be brought down and up again before
 225 a change takes effect.
 226 .El
 227 .Sh SEE ALSO
 228 .Xr altq 4 ,
 229 .Xr arp 4 ,
 230 .Xr miibus 4 ,
 231 .Xr netintro 4 ,
 232 .Xr ng_ether 4 ,
 233 .Xr vlan 4 ,
 234 .Xr ifconfig 8
 235 .Sh HISTORY
 236 The
 237 .Nm
 238 driver was written by
 239 .An Pyun YongHyeon
 240 .Aq yongari@FreeBSD.org
 241 and it is based on
 242 .Xr sk 4
 243 and Marvell's
 244 .Fx
 245 driver.
 246 It first appeared in
 247 .Fx 7.0
 248 and
 249 .Fx 6.3 .