summaryrefslogtreecommitdiff
path: root/share/man/man4
diff options
context:
space:
mode:
authorPedro Martelletto <pedro@cvs.openbsd.org>2006-12-12 23:54:45 +0000
committerPedro Martelletto <pedro@cvs.openbsd.org>2006-12-12 23:54:45 +0000
commit676cabb26db08770818f948b13e3965cf7e3e3f7 (patch)
tree4cd7cf6d9e762b92304e01fcda7064978a6318c7 /share/man/man4
parent1c2fd965cf1531278e01bc91beaa67624286988c (diff)
add msk(4), tweak sk(4) and pci(4) accordingly
okay kettenis@, from brad@
Diffstat (limited to 'share/man/man4')
-rw-r--r--share/man/man4/Makefile6
-rw-r--r--share/man/man4/msk.4193
-rw-r--r--share/man/man4/pci.44
-rw-r--r--share/man/man4/sk.4180
4 files changed, 279 insertions, 104 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index dc8a89a0be4..0b2f57aa15d 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.398 2006/12/09 05:10:43 dlg Exp $
+# $OpenBSD: Makefile,v 1.399 2006/12/12 23:54:44 pedro Exp $
MAN= aac.4 ac97.4 acphy.4 acpi.4 acx.4 \
adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \
@@ -25,7 +25,7 @@ MAN= aac.4 ac97.4 acphy.4 acpi.4 acx.4 \
ises.4 isp.4 it.4 iwi.4 ixgb.4 ksyms.4 kue.4 lc.4 lge.4 lkm.4 lm.4 \
lmc.4 lmenv.4 lmtemp.4 lo.4 lofn.4 lpt.4 lxtphy.4 luphy.4 \
maestro.4 mainbus.4 malo.4 maxds.4 maxtmp.4 midi.4 mii.4 mfi.4 \
- moscom.4 mpi.4 mpu.4 mtd.4 mtdphy.4 multicast.4 mtio.4 ne.4 \
+ moscom.4 mpi.4 mpu.4 msk.4 mtd.4 mtdphy.4 multicast.4 mtio.4 ne.4 \
neo.4 netintro.4 nfe.4 nge.4 nmea.4 noct.4 nofn.4 nsclpcsio.4 \
nsgphy.4 nsphy.4 nsphyter.4 null.4 nviic.4 ohci.4 opl.4 options.4 \
onewire.4 oosiop.4 osiop.4 owid.4 owtemp.4 \
@@ -72,7 +72,7 @@ MLINKS+=random.4 arandom.4
MLINKS+=random.4 srandom.4 random.4 urandom.4 random.4 prandom.4
MLINKS+=scsi.4 scsibus.4
MLINKS+=sequencer.4 music.4
-MLINKS+=sk.4 skc.4 sk.4 msk.4 sk.4 mskc.4
+MLINKS+=sk.4 skc.4 msk.4 mskc.4
MLINKS+=speaker.4 spkr.4
MLINKS+=tty.4 cua.4
MLINKS+=usb.4 uhub.4
diff --git a/share/man/man4/msk.4 b/share/man/man4/msk.4
new file mode 100644
index 00000000000..3c4e21ac818
--- /dev/null
+++ b/share/man/man4/msk.4
@@ -0,0 +1,193 @@
+.\" $OpenBSD: msk.4,v 1.1 2006/12/12 23:54:44 pedro Exp $
+.\"
+.\" Copyright (c) 1997, 1998, 1999
+.\" Bill Paul <wpaul@ctr.columbia.edu>. 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by Bill Paul.
+.\" 4. Neither the name of the author nor the names of any co-contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD
+.\" 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/man4.i386/sk.4,v 1.3 1999/08/28 00:20:29 peter Exp $
+.\"
+.Dd July 3, 1999
+.Dt MSK 4
+.Os
+.Sh NAME
+.Nm msk ,
+.Nm mskc
+.Nd "Marvell Yukon-2 based Fast Ethernet and Gigabit Ethernet device"
+.Sh SYNOPSIS
+.Cd "mskc* at pci?"
+.Cd "msk* at mskc?"
+.Cd "eephy* at mii?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the Marvell Yukon-2 based Fast Ethernet and Gigabit Ethernet
+adapters, including the following:
+.Pp
+.Bl -bullet -offset indent -compact
+.It
+D-Link DGE-550SX, multimode fiber adapter
+.It
+D-Link DGE-560SX, multimode fiber adapter
+.It
+D-Link DGE-560T, copper adapter
+.It
+SysKonnect SK-9E21 single port, copper adapter
+.It
+SysKonnect SK-9E22 dual port, copper adapter
+.It
+SysKonnect SK-9E81 single port, multimode fiber adapter
+.It
+SysKonnect SK-9E82 dual port, multimode fiber adapter
+.It
+SysKonnect SK-9E91 single port, single mode fiber adapter
+.It
+SysKonnect SK-9E92 dual port, single mode fiber adapter
+.It
+SysKonnect SK-9S21 single port, copper adapter
+.It
+SysKonnect SK-9S22 dual port, copper adapter
+.It
+SysKonnect SK-9S81 single port, multimode fiber adapter
+.It
+SysKonnect SK-9S82 dual port, multimode fiber adapter
+.It
+SysKonnect SK-9S91 single port, single mode fiber adapter
+.It
+SysKonnect SK-9S92 dual port, single mode fiber adapter
+.It
+SysKonnect SK-9E21D single port, copper adapter
+.El
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width 1000baseSX
+.It Cm autoselect
+Enable autoselection of the media type and options.
+The user can manually override
+the autoselected mode by adding media options to the appropriate
+.Xr hostname.if 5
+file.
+.It Cm 10baseT
+Set 10Mbps operation.
+The
+.Xr ifconfig 8
+.Ic 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
+.Ic mediaopt
+option can also be used to select either
+.Cm full-duplex
+or
+.Cm half-duplex
+modes.
+.It Cm 1000baseT
+Set 1000baseT (Gigabit Ethernet) operation over twisted pair.
+Both
+.Cm full-duplex
+and
+.Cm half-duplex
+modes are supported.
+.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 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 1000baseT cards:
+.Bl -tag -width link0
+.It Cm link0
+With 1000baseT cards, establishing a link between two ports requires
+that one port be configured as a master and the other a 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 .
+To view a list of media types and options supported by the card, try
+.Ic ifconfig -m <device> .
+For example,
+.Ic ifconfig -m sk0 .
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr eephy 4 ,
+.Xr ifmedia 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Mark Kettenis Aq kettenis@openbsd.org .
+.Sh BUGS
+The
+.Nm
+driver does not support hardware receive IP checksum offload yet.
diff --git a/share/man/man4/pci.4 b/share/man/man4/pci.4
index d8f172c426a..5ee6c265240 100644
--- a/share/man/man4/pci.4
+++ b/share/man/man4/pci.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pci.4,v 1.197 2006/12/09 05:10:43 dlg Exp $
+.\" $OpenBSD: pci.4,v 1.198 2006/12/12 23:54:44 pedro Exp $
.\" $NetBSD: pci.4,v 1.29 2000/04/01 00:32:23 tsarna Exp $
.\"
.\" Copyright (c) 2000 Theo de Raadt. All rights reserved.
@@ -184,7 +184,7 @@ Lan Media Corporation
.Tn SSI/DS1/HSSI/DS3
interfaces
.It Xr msk 4
-SysKonnect XMAC II and Marvell Yukon based Gigabit Ethernet device
+Marvell Yukon-2 based Fast Ethernet and Gigabit Ethernet device
.It Xr mtd 4
Myson Technology MTD800/MTD803/MTD891 10/100/Gigabit Ethernet device
.It Xr ne 4
diff --git a/share/man/man4/sk.4 b/share/man/man4/sk.4
index 1db94d4291d..de74cd360e3 100644
--- a/share/man/man4/sk.4
+++ b/share/man/man4/sk.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sk.4,v 1.47 2006/12/12 20:51:15 mk Exp $
+.\" $OpenBSD: sk.4,v 1.48 2006/12/12 23:54:44 pedro Exp $
.\"
.\" Copyright (c) 1997, 1998, 1999
.\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
@@ -38,20 +38,16 @@
.Sh NAME
.Nm sk ,
.Nm skc ,
-.Nm msk ,
-.Nm mskc
.Nd "SysKonnect XMAC II and Marvell Yukon based Gigabit Ethernet device"
.Sh SYNOPSIS
.Cd "skc* at pci?"
.Cd "sk* at skc?"
-.Cd "mskc* at pci?"
-.Cd "msk* at mskc?"
.Cd "brgphy* at mii?"
.Cd "eephy* at mii?"
.Cd "xmphy* at mii?"
.Sh DESCRIPTION
The
-.Nm sk
+.Nm
driver provides support for SysKonnect based Gigabit Ethernet adapters
and Marvell based Gigabit Ethernet adapters, including the following:
.Pp
@@ -71,67 +67,27 @@ Linksys EG1032v2, copper adapter
.It
Linksys EG1064v2, copper adapter
.It
-SK-9821 SK-NET GE-T single port, copper adapter
+SysKonnect SK-9821 single port, copper adapter
.It
-SK-9822 SK-NET GE-T dual port, copper adapter
+SysKonnect SK-9822 dual port, copper adapter
.It
-SK-9841 SK-NET GE-LX single port, single mode fiber adapter
+SysKonnect SK-9841 single port, single mode fiber adapter
.It
-SK-9842 SK-NET GE-LX dual port, single mode fiber adapter
+SysKonnect SK-9842 dual port, single mode fiber adapter
.It
-SK-9843 SK-NET GE-SX single port, multimode fiber adapter
+SysKonnect SK-9843 single port, multimode fiber adapter
.It
-SK-9844 SK-NET GE-SX dual port, multimode fiber adapter
+SysKonnect SK-9844 dual port, multimode fiber adapter
.It
-SK-9521 V2.0 single port, copper adapter (32-bit)
+SysKonnect SK-9521 V2.0 single port, copper adapter
.It
-SK-9821 V2.0 single port, copper adapter
+SysKonnect SK-9821 V2.0 single port, copper adapter
.It
-SK-9843 V2.0 single port, copper adapter
+SysKonnect SK-9843 V2.0 single port, copper adapter
.It
SMC 9452TX, copper adapter
.El
.Pp
-The
-.Nm msk
-driver provides support for the Marvell Yukon-2 based Gigabit Ethernet
-adapters, including the following:
-.Pp
-.Bl -bullet -offset indent -compact
-.It
-D-Link DGE-550SX, multimode fiber adapter
-.It
-D-Link DGE-560SX, multimode fiber adapter
-.It
-D-Link DGE-560T, copper adapter
-.It
-SK-9E21 1000Base-T single port, copper adapter
-.It
-SK-9E22 1000Base-T dual port, copper adapter
-.It
-SK-9E81 1000Base-SX single port, multimode fiber adapter
-.It
-SK-9E82 1000Base-SX dual port, multimode fiber adapter
-.It
-SK-9E91 1000Base-LX single port, single mode fiber adapter
-.It
-SK-9E92 1000Base-LX dual port, single mode fiber adapter
-.It
-SK-9S21 1000Base-T single port, copper adapter
-.It
-SK-9S22 1000Base-T dual port, copper adapter
-.It
-SK-9S81 1000Base-SX single port, multimode fiber adapter
-.It
-SK-9S82 1000Base-SX dual port, multimode fiber adapter
-.It
-SK-9S91 1000Base-LX single port, single mode fiber adapter
-.It
-SK-9S92 1000Base-LX dual port, single mode fiber adapter
-.It
-SK-9E21D 1000Base-T single port, copper adapter
-.El
-.Pp
The SysKonnect based adapters consist of two main components: the
XaQti Corp.\&
XMAC II Gigabit MAC (sk) and the SysKonnect GEnesis controller ASIC (skc).
@@ -144,15 +100,6 @@ allowing dual-port NIC configurations.
The Marvell based adapters are a single integrated circuit, but are
still presented as a separate MAC (sk) and controller ASIC (skc).
.Pp
-The
-.Nm
-driver configures dual port SysKonnect adapters such that each XMAC
-is treated as a separate logical network interface.
-Both ports can operate independently of each other and can be connected
-to separate networks.
-.Pp
-The XaQti XMAC II supports full and half duplex operation with
-autonegotiation.
The XMAC also supports a frame size of up to 9000 bytes.
Support for Jumbo frames is provided via the interface MTU setting.
Selecting an MTU larger than 1500 bytes with the
@@ -163,22 +110,81 @@ such as file transfers and data streaming.
.Pp
Hardware receive IP checksum offload for IPv4 is supported.
.Pp
-The following media types and options (as given to
-.Xr ifconfig 8 )
-are supported:
-.Bl -tag -width xxx -offset indent
-.It Cm media No autoselect
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width 1000baseSX
+.It Cm autoselect
Enable autoselection of the media type and options.
The user can manually override
the autoselected mode by adding media options to the appropriate
.Xr hostname.if 5
file.
-.It Cm media No 1000baseSX Cm mediaopt No full-duplex
-Set 1000Mbps (Gigabit Ethernet) operation on fiber and force full-duplex mode.
-.It Cm media No 1000baseSX Cm mediaopt No half-duplex
-Set 1000Mbps (Gigabit Ethernet) operation on fiber and force half-duplex mode.
-.It Cm media No 1000baseT Cm mediaopt No full-duplex
-Set 1000Mbps (Gigabit Ethernet) operation and force full-duplex mode.
+.It Cm 10baseT
+Set 10Mbps operation.
+The
+.Xr ifconfig 8
+.Ic 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
+.Ic mediaopt
+option can also be used to select either
+.Cm full-duplex
+or
+.Cm half-duplex
+modes.
+.It Cm 1000baseT
+Set 1000baseT (Gigabit Ethernet) operation over twisted pair.
+Both
+.Cm full-duplex
+and
+.Cm half-duplex
+modes are supported.
+.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 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 1000baseT cards:
+.Bl -tag -width link0
+.It Cm link0
+With 1000baseT cards, establishing a link between two ports requires
+that one port be configured as a master and the other a 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
@@ -187,19 +193,6 @@ To view a list of media types and options supported by the card, try
.Ic ifconfig -m <device> .
For example,
.Ic ifconfig -m sk0 .
-.Sh DIAGNOSTICS
-.Bl -diag
-.It "sk%d: can't map mem space"
-A fatal initialization error has occurred.
-.It "sk%d: couldn't map interrupt"
-A fatal initialization error has occurred.
-.It "sk%d: no memory for jumbo buffer queue!"
-The driver failed to allocate memory for jumbo frames during
-initialization.
-.It "sk%d: watchdog timeout"
-The device has stopped responding to the network, or there is a problem with
-the network connection (cable).
-.El
.Sh SEE ALSO
.Xr arp 4 ,
.Xr brgphy 4 ,
@@ -228,20 +221,9 @@ and
.Ox
support was added in
.Ox 2.6 .
-.Pp
-The
-.Nm msk
-driver first appeared in
-.Ox 4.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Bill Paul Aq wpaul@ctr.columbia.edu .
-Support for the Marvell Yukon-2 was added by
-.An Mark Kettenis Aq kettenis@openbsd.org .
-.Sh BUGS
-The
-.Nm msk
-driver does not support hardware receive IP checksum offload yet.