From: Sascha Wildner Date: Wed, 26 Dec 2007 14:27:58 +0000 (+0000) Subject: Add a manual page for msk(4). X-Git-Tag: v2.0.1~1552 X-Git-Url: https://gitweb.dragonflybsd.org/dragonfly.git/commitdiff_plain/a1cfd3c7c6f24527cef56f81cf4f6e09b4549e44 Add a manual page for msk(4). Submitted-by: sephe Taken-from: FreeBSD --- diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index cf1b1a9dff..4f86c23e7c 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,6 +1,6 @@ # @(#)Makefile 8.1 (Berkeley) 6/18/93 # $FreeBSD: src/share/man/man4/Makefile,v 1.83.2.66 2003/06/04 17:10:30 sam Exp $ -# $DragonFly: src/share/man/man4/Makefile,v 1.73 2007/11/07 09:07:44 hasso Exp $ +# $DragonFly: src/share/man/man4/Makefile,v 1.74 2007/12/26 14:27:58 swildner Exp $ MAN= aac.4 \ acpi.4 \ @@ -122,6 +122,7 @@ MAN= aac.4 \ moscom.4 \ mouse.4 \ mpt.4 \ + msk.4 \ mtio.4 \ multicast.4 \ my.4 \ diff --git a/share/man/man4/msk.4 b/share/man/man4/msk.4 new file mode 100644 index 0000000000..d7f6635a5f --- /dev/null +++ b/share/man/man4/msk.4 @@ -0,0 +1,253 @@ +.\" Copyright (c) 2006 Pyun YongHyeon +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD: src/share/man/man4/msk.4,v 1.6 2007/12/05 09:41:58 remko Exp $ +.\" $DragonFly: src/share/man/man4/msk.4,v 1.1 2007/12/26 14:27:58 swildner Exp $ +.\" +.Dd December 26, 2007 +.Dt MSK 4 +.Os +.Sh NAME +.Nm msk +.Nd Marvell/SysKonnect Yukon II Gigabit Ethernet adapter driver +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device miibus" +.Cd "device msk" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_msk_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +device driver provides support for various NICs based on the +Marvell/SysKonnect Yukon II Gigabit Ethernet controller chip. +.Pp +All NICs supported by the +.Nm +driver have +.\" NOT YET +.\"TCP/UDP/IP checksum offload for transmit, +.\"TCP segmentation offload (TSO), +.\"hardware VLAN tag stripping/insertion features and +an interrupt moderation mechanism as well as a 64-bit multicast hash filter. +The Yukon II supports TBI (ten bit interface) and GMII +transceivers, which means it can be used with either copper or +1000baseX fiber applications. +.Pp +.\" NOT YET +.\"The Yukon II also supports Jumbo Frames (up to 9022 bytes), which can be +.\"configured via the interface MTU setting. +.\"Selecting an MTU larger than 1500 bytes with the +.\".Xr ifconfig 8 +.\"utility configures the adapter to receive and transmit Jumbo Frames. +.\".Pp +The +.Nm +driver supports the following media types: +.Bl -tag -width ".Cm 10baseT/UTP" +.It Cm autoselect +Enable autoselection of the media type and options. +The user can manually override +the autoselected mode by adding media options to +.Xr rc.conf 5 . +.It Cm 10baseT/UTP +Set 10Mbps operation. +The +.Xr ifconfig 8 +.Cm mediaopt +option can also be used to select either +.Cm full-duplex +or +.Cm half-duplex +modes. +.It Cm 100baseTX +Set 100Mbps (Fast Ethernet) operation. +The +.Xr ifconfig 8 +.Cm mediaopt +option can also be used to select either +.Cm full-duplex +or +.Cm half-duplex +modes. +.It Cm 1000baseTX +Set 1000baseTX operation over twisted pair. +The +.Xr ifconfig 8 +.Cm mediaopt +option can also be used to select either +.Cm full-duplex +or +.Cm half-duplex +modes. +.It Cm 1000baseSX +Set 1000Mbps (Gigabit Ethernet) operation. +Both +.Cm full-duplex +and +.Cm half-duplex +modes are supported. +.El +.Pp +The +.Nm +driver supports the following media options: +.Bl -tag -width ".Cm full-duplex" +.It Cm full-duplex +Force full duplex operation. +.It Cm half-duplex +Force half duplex operation. +.El +.Pp +The +.Nm +driver also supports one special link option for 1000baseTX cards: +.Bl -tag -width ".Cm link0" +.It Cm link0 +With 1000baseTX cards, establishing a link between two ports requires +that one port is configured as master and the other one as slave. +With autonegotiation, +the master/slave settings will be chosen automatically. +However when manually selecting the link state, it is necessary to +force one side of the link to be a master and the other a slave. +The +.Nm +driver configures the ports as slaves by default. +Setting the +.Cm link0 +flag with +.Xr ifconfig 8 +will set a port as a master instead. +.El +.Pp +For more information on configuring this device, see +.Xr ifconfig 8 . +.Sh HARDWARE +The +.Nm +driver provides support for various NICs based on the Marvell/SysKonnect +Yukon II based Gigabit Ethernet controller chips, including: +.Pp +.Bl -bullet -compact +.It +D-Link 550SX Gigabit Ethernet +.It +D-Link 560T Gigabit Ethernet +.It +Marvell Yukon 88E8021CU Gigabit Ethernet +.It +Marvell Yukon 88E8021 SX/LX Gigabit Ethernet +.It +Marvell Yukon 88E8022CU Gigabit Ethernet +.It +Marvell Yukon 88E8022 SX/LX Gigabit Ethernet +.It +Marvell Yukon 88E8061CU Gigabit Ethernet +.It +Marvell Yukon 88E8061 SX/LX Gigabit Ethernet +.It +Marvell Yukon 88E8062CU Gigabit Ethernet +.It +Marvell Yukon 88E8062 SX/LX Gigabit Ethernet +.It +Marvell Yukon 88E8035 Gigabit Ethernet +.It +Marvell Yukon 88E8036 Gigabit Ethernet +.It +Marvell Yukon 88E8038 Gigabit Ethernet +.It +Marvell Yukon 88E8039 Gigabit Ethernet +.It +Marvell Yukon 88E8050 Gigabit Ethernet +.It +Marvell Yukon 88E8052 Gigabit Ethernet +.It +Marvell Yukon 88E8053 Gigabit Ethernet +.It +Marvell Yukon 88E8055 Gigabit Ethernet +.It +Marvell Yukon 88E8056 Gigabit Ethernet +.It +Marvell Yukon 88E8058 Gigabit Ethernet +.It +SysKonnect SK-9Sxx Gigabit Ethernet +.It +SysKonnect SK-9Exx Gigabit Ethernet +.El +.\" NOT YET +.\".Sh LOADER TUNABLES +.\"Tunables can be set at the +.\".Xr loader 8 +.\"prompt before booting the kernel or stored in +.\".Xr loader.conf 5 . +.\".Bl -tag -width indent +.\".It Va hw.msk.msi_disable +.\"This tunable disables MSI support on the Ethernet hardware. +.\"The default value is 0. +.\".El +.\".Sh SYSCTL VARIABLES +.\"The following variables are available as both +.\".Xr sysctl 8 +.\"variables and +.\".Xr loader 8 +.\"tunables: +.\".Bl -tag -width indent +.\".It Va dev.mskc.%d.process_limit +.\"Maximum amount of Rx events to be processed in the event loop before +.\"rescheduling a taskqueue. +.\"The accepted range is 30 to 256, the default value is 128 events. +.\"The interface does not need to be brought down and up again before +.\"a change takes effect. +.\".El +.Sh SEE ALSO +.Xr altq 4 , +.Xr arp 4 , +.Xr ifmedia 4 , +.Xr miibus 4 , +.Xr netintro 4 , +.Xr ng_ether 4 , +.Xr vlan 4 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver was written by +.An Pyun YongHyeon +.Aq yongari@FreeBSD.org +and it is based on +.Xr sk 4 +and Marvell's +.Fx +driver. +It first appeared in +.Dx 1.11 .