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: src/share/man/man4/msk.4,v 1.6 2007/12/05 09:41:58 remko Exp $
  26 .\" $DragonFly: src/share/man/man4/msk.4,v 1.2 2007/12/26 16:11:33 swildner Exp $
  27 .\"
  28 .Dd December 26, 2007
  29 .Dt MSK 4
  30 .Os
  31 .Sh NAME
  32 .Nm msk
  33 .Nd Marvell/SysKonnect Yukon II Gigabit Ethernet adapter driver
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device miibus"
  40 .Cd "device msk"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 if_msk_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 device driver provides support for various NICs based on the
  53 Marvell/SysKonnect Yukon II Gigabit Ethernet controller chip.
  54 .Pp
  55 All NICs supported by the
  56 .Nm
  57 driver have
  58 .\" NOT YET
  59 .\"TCP/UDP/IP checksum offload for transmit,
  60 .\"TCP segmentation offload (TSO),
  61 .\"hardware VLAN tag stripping/insertion features and
  62 an interrupt moderation mechanism as well as a 64-bit multicast hash filter.
  63 The Yukon II supports TBI (ten bit interface) and GMII
  64 transceivers, which means it can be used with either copper or
  65 1000baseX fiber applications.
  66 .Pp
  67 .\" NOT YET
  68 .\"The Yukon II also supports Jumbo Frames (up to 9022 bytes), which can be
  69 .\"configured via the interface MTU setting.
  70 .\"Selecting an MTU larger than 1500 bytes with the
  71 .\".Xr ifconfig 8
  72 .\"utility configures the adapter to receive and transmit Jumbo Frames.
  73 .\".Pp
  74 The
  75 .Nm
  76 driver supports the following media types:
  77 .Bl -tag -width ".Cm 10baseT/UTP"
  78 .It Cm autoselect
  79 Enable autoselection of the media type and options.
  80 The user can manually override
  81 the autoselected mode by adding media options to
  82 .Xr rc.conf 5 .
  83 .It Cm 10baseT/UTP
  84 Set 10Mbps operation.
  85 The
  86 .Xr ifconfig 8
  87 .Cm mediaopt
  88 option can also be used to select either
  89 .Cm full-duplex
  90 or
  91 .Cm half-duplex
  92 modes.
  93 .It Cm 100baseTX
  94 Set 100Mbps (Fast Ethernet) operation.
  95 The
  96 .Xr ifconfig 8
  97 .Cm mediaopt
  98 option can also be used to select either
  99 .Cm full-duplex
 100 or
 101 .Cm half-duplex
 102 modes.
 103 .It Cm 1000baseTX
 104 Set 1000baseTX operation over twisted pair.
 105 The
 106 .Xr ifconfig 8
 107 .Cm mediaopt
 108 option can also be used to select either
 109 .Cm full-duplex
 110 or
 111 .Cm half-duplex
 112 modes.
 113 .It Cm 1000baseSX
 114 Set 1000Mbps (Gigabit Ethernet) operation.
 115 Both
 116 .Cm full-duplex
 117 and
 118 .Cm half-duplex
 119 modes are supported.
 120 .El
 121 .Pp
 122 The
 123 .Nm
 124 driver supports the following media options:
 125 .Bl -tag -width ".Cm full-duplex"
 126 .It Cm full-duplex
 127 Force full duplex operation.
 128 .It Cm half-duplex
 129 Force half duplex operation.
 130 .El
 131 .Pp
 132 The
 133 .Nm
 134 driver also supports one special link option for 1000baseTX cards:
 135 .Bl -tag -width ".Cm link0"
 136 .It Cm link0
 137 With 1000baseTX cards, establishing a link between two ports requires
 138 that one port is configured as master and the other one as slave.
 139 With autonegotiation,
 140 the master/slave settings will be chosen automatically.
 141 However when manually selecting the link state, it is necessary to
 142 force one side of the link to be a master and the other a slave.
 143 The
 144 .Nm
 145 driver configures the ports as slaves by default.
 146 Setting the
 147 .Cm link0
 148 flag with
 149 .Xr ifconfig 8
 150 will set a port as a master instead.
 151 .El
 152 .Pp
 153 For more information on configuring this device, see
 154 .Xr ifconfig 8 .
 155 .Sh HARDWARE
 156 The
 157 .Nm
 158 driver provides support for various NICs based on the Marvell/SysKonnect
 159 Yukon II based Gigabit Ethernet controller chips, including:
 160 .Pp
 161 .Bl -bullet -compact
 162 .It
 163 D-Link 550SX Gigabit Ethernet
 164 .It
 165 D-Link 560T Gigabit Ethernet
 166 .It
 167 Marvell Yukon 88E8021CU Gigabit Ethernet
 168 .It
 169 Marvell Yukon 88E8021 SX/LX Gigabit Ethernet
 170 .It
 171 Marvell Yukon 88E8022CU Gigabit Ethernet
 172 .It
 173 Marvell Yukon 88E8022 SX/LX Gigabit Ethernet
 174 .It
 175 Marvell Yukon 88E8061CU Gigabit Ethernet
 176 .It
 177 Marvell Yukon 88E8061 SX/LX Gigabit Ethernet
 178 .It
 179 Marvell Yukon 88E8062CU Gigabit Ethernet
 180 .It
 181 Marvell Yukon 88E8062 SX/LX Gigabit Ethernet
 182 .It
 183 Marvell Yukon 88E8035 Gigabit Ethernet
 184 .It
 185 Marvell Yukon 88E8036 Gigabit Ethernet
 186 .It
 187 Marvell Yukon 88E8038 Gigabit Ethernet
 188 .It
 189 Marvell Yukon 88E8039 Gigabit Ethernet
 190 .It
 191 Marvell Yukon 88E8050 Gigabit Ethernet
 192 .It
 193 Marvell Yukon 88E8052 Gigabit Ethernet
 194 .It
 195 Marvell Yukon 88E8053 Gigabit Ethernet
 196 .It
 197 Marvell Yukon 88E8055 Gigabit Ethernet
 198 .It
 199 Marvell Yukon 88E8056 Gigabit Ethernet
 200 .It
 201 Marvell Yukon 88E8058 Gigabit Ethernet
 202 .It
 203 SysKonnect SK-9Sxx Gigabit Ethernet
 204 .It
 205 SysKonnect SK-9Exx Gigabit Ethernet
 206 .El
 207 .\" NOT YET
 208 .\".Sh LOADER TUNABLES
 209 .\"Tunables can be set at the
 210 .\".Xr loader 8
 211 .\"prompt before booting the kernel or stored in
 212 .\".Xr loader.conf 5 .
 213 .\".Bl -tag -width indent
 214 .\".It Va hw.msk.msi_disable
 215 .\"This tunable disables MSI support on the Ethernet hardware.
 216 .\"The default value is 0.
 217 .\".El
 218 .\".Sh SYSCTL VARIABLES
 219 .\"The following variables are available as both
 220 .\".Xr sysctl 8
 221 .\"variables and
 222 .\".Xr loader 8
 223 .\"tunables:
 224 .\".Bl -tag -width indent
 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 ifmedia 4 ,
 236 .Xr miibus 4 ,
 237 .Xr netintro 4 ,
 238 .Xr ng_ether 4 ,
 239 .\".Xr vlan 4 ,
 240 .Xr ifconfig 8
 241 .Sh HISTORY
 242 The
 243 .Nm
 244 driver was written by
 245 .An Pyun YongHyeon
 246 .Aq yongari@FreeBSD.org
 247 and it is based on
 248 .Xr sk 4
 249 and Marvell's
 250 .Fx
 251 driver.
 252 It first appeared in
 253 .Dx 1.11 .