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 November 23, 2010
  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 For more information on configuring this device, see
 129 .Xr ifconfig 8 .
 130 .Sh HARDWARE
 131 The
 132 .Nm
 133 driver provides support for various NICs based on the Marvell/SysKonnect
 134 Yukon II based Gigabit Ethernet controller chips, including:
 135 .Pp
 136 .Bl -bullet -compact
 137 .It
 138 D-Link 550SX Gigabit Ethernet
 139 .It
 140 D-Link 560SX Gigabit Ethernet
 141 .It
 142 D-Link 560T Gigabit Ethernet
 143 .It
 144 Marvell Yukon 88E8021CU Gigabit Ethernet
 145 .It
 146 Marvell Yukon 88E8021 SX/LX Gigabit Ethernet
 147 .It
 148 Marvell Yukon 88E8022CU Gigabit Ethernet
 149 .It
 150 Marvell Yukon 88E8022 SX/LX Gigabit Ethernet
 151 .It
 152 Marvell Yukon 88E8061CU Gigabit Ethernet
 153 .It
 154 Marvell Yukon 88E8061 SX/LX Gigabit Ethernet
 155 .It
 156 Marvell Yukon 88E8062CU Gigabit Ethernet
 157 .It
 158 Marvell Yukon 88E8062 SX/LX Gigabit Ethernet
 159 .It
 160 Marvell Yukon 88E8035 Fast Ethernet
 161 .It
 162 Marvell Yukon 88E8036 Fast Ethernet
 163 .It
 164 Marvell Yukon 88E8038 Fast Ethernet
 165 .It
 166 Marvell Yukon 88E8039 Fast Ethernet
 167 .It
 168 Marvell Yukon 88E8040 Fast Ethernet
 169 .It
 170 Marvell Yukon 88E8040T Fast Ethernet
 171 .It
 172 Marvell Yukon 88E8042 Fast Ethernet
 173 .It
 174 Marvell Yukon 88E8048 Fast Ethernet
 175 .It
 176 Marvell Yukon 88E8050 Gigabit Ethernet
 177 .It
 178 Marvell Yukon 88E8052 Gigabit Ethernet
 179 .It
 180 Marvell Yukon 88E8053 Gigabit Ethernet
 181 .It
 182 Marvell Yukon 88E8055 Gigabit Ethernet
 183 .It
 184 Marvell Yukon 88E8056 Gigabit Ethernet
 185 .It
 186 Marvell Yukon 88E8057 Gigabit Ethernet
 187 .It
 188 Marvell Yukon 88E8058 Gigabit Ethernet
 189 .It
 190 Marvell Yukon 88E8059 Gigabit Ethernet
 191 .It
 192 Marvell Yukon 88E8070 Gigabit Ethernet
 193 .It
 194 Marvell Yukon 88E8071 Gigabit Ethernet
 195 .It
 196 Marvell Yukon 88E8072 Gigabit Ethernet
 197 .It
 198 SysKonnect SK-9Sxx Gigabit Ethernet
 199 .It
 200 SysKonnect SK-9Exx Gigabit Ethernet
 201 .El
 202 .Sh LOADER TUNABLES
 203 Tunables can be set at the
 204 .Xr loader 8
 205 prompt before booting the kernel or stored in
 206 .Xr loader.conf 5 .
 207 .Bl -tag -width indent
 208 .It Va hw.msk.msi_disable
 209 This tunable disables MSI support on the Ethernet hardware.
 210 The default value is 0.
 211 .El
 212 .Sh SYSCTL VARIABLES
 213 The following variables are available as both
 214 .Xr sysctl 8
 215 variables and
 216 .Xr loader 8
 217 tunables:
 218 .Bl -tag -width indent
 219 .It Va dev.mskc.%d.int_holdoff
 220 Maximum number of time to delay interrupts.
 221 The valid range is 0 to 34359738 for 125MHz clock in units of 1us,
 222 the default is 100 (100us).
 223 The interface need to be brought down and up again before a change
 224 takes effect.
 225 .It Va dev.mskc.%d.process_limit
 226 Maximum amount of Rx events to be processed in the event loop before
 227 rescheduling a taskqueue.
 228 The accepted range is 30 to 256, the default value is 128 events.
 229 The interface does not need to be brought down and up again before
 230 a change takes effect.
 231 .El
 232 .Sh SEE ALSO
 233 .Xr altq 4 ,
 234 .Xr arp 4 ,
 235 .Xr miibus 4 ,
 236 .Xr netintro 4 ,
 237 .Xr ng_ether 4 ,
 238 .Xr vlan 4 ,
 239 .Xr ifconfig 8
 240 .Sh HISTORY
 241 The
 242 .Nm
 243 driver was written by
 244 .An Pyun YongHyeon
 245 .Aq yongari@FreeBSD.org
 246 and it is based on
 247 .Xr sk 4
 248 and Marvell's
 249 .Fx
 250 driver.
 251 It first appeared in
 252 .Fx 7.0
 253 and
 254 .Fx 6.3 .