summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorReyk Floeter <reyk@cvs.openbsd.org>2007-04-16 16:52:53 +0000
committerReyk Floeter <reyk@cvs.openbsd.org>2007-04-16 16:52:53 +0000
commitb8e0757c3a1cc273b773fdea327ebbd8731193c3 (patch)
tree7437eff06ba408267f2e814d606eeb4972d8eb86 /share/man
parentcf862b65af95b979f6ed86507994081c97c3f667 (diff)
Add a manpage for the upcoming nx(4) driver and the nxb(4) boards.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/Makefile7
-rw-r--r--share/man/man4/nx.4131
2 files changed, 135 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 1f9c31f1996..65e065fdc0a 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.413 2007/04/16 11:10:41 dlg Exp $
+# $OpenBSD: Makefile,v 1.414 2007/04/16 16:52:52 reyk Exp $
MAN= aac.4 ac97.4 acphy.4 \
acpi.4 acpiac.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -29,8 +29,8 @@ MAN= aac.4 ac97.4 acphy.4 \
maestro.4 mainbus.4 malo.4 maxds.4 maxtmp.4 mbg.4 midi.4 mii.4 mfi.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 owsbm.4 owtemp.4 \
+ nsgphy.4 nsphy.4 nsphyter.4 null.4 nviic.4 nx.4 ohci.4 opl.4 \
+ options.4 onewire.4 oosiop.4 osiop.4 owid.4 owsbm.4 owtemp.4 \
pcagpio.4 pcaled.4 pcdisplay.4 pchb.4 pci.4 pcib.4 pcfadc.4 \
pcfiic.4 pciide.4 pckbc.4 pckbd.4 pcmcia.4 pcn.4 pcppi.4 pcscp.4 \
pf.4 pflog.4 pfsync.4 pgt.4 piixpm.4 pim.4 \
@@ -63,6 +63,7 @@ MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4
MLINKS+=fpa.4 fea.4 fpa.4 fta.4
MLINKS+=isapnp.4 pnp.4
MLINKS+=netintro.4 networking.4
+MLINKS+=nx.4 nxb.4
MLINKS+=pcmcia.4 pcic.4
MLINKS+=pms.4 pmsi.4
MLINKS+=pty.4 ptm.4
diff --git a/share/man/man4/nx.4 b/share/man/man4/nx.4
new file mode 100644
index 00000000000..83f8da3991b
--- /dev/null
+++ b/share/man/man4/nx.4
@@ -0,0 +1,131 @@
+.\" $OpenBSD: nx.4,v 1.1 2007/04/16 16:52:52 reyk Exp $
+.\"
+.\" Copyright (c) 2007 Reyk Floeter <reyk@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd Saturday 14, 2007
+.Dt NX 4
+.Os
+.Sh NAME
+.Nm nx ,
+.Nm nxb
+.Nd NetXen NX2031/NX2035 10Gb and 10/100/Gigabit Ethernet device
+.Sh SYNOPSIS
+.Cd "nxb* at pci?"
+.Cd "nx* at nxb?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports multi port Gigabit and 10Gb Ethernet adapters based on
+the NetXen NX2031 and NX2035 chipsets, including the following:
+.Pp
+.Bl -bullet -offset indent -compact
+.It
+HP NC510C PCIe 10Gb Ethernet server adapter (10GbaseCX4)
+.It
+HP NC510F PCIe 10Gb Ethernet server adapter (10GbaseSR)
+.It
+NetXen NXB-10GXxR PCIe 10Gb Ethernet adapter (10GbaseSR/LR XFP)
+.It
+NetXen NXB-10GCX4 PCIe 10Gb Ethernet adapter (10GbaseCX4)
+.It
+NetXen NXB-4GCU PCIe Quad Gigabit Ethernet adapter (1000baseT)
+.It
+NetXen BladeCenter-H Dual 10Gb Ethernet Expansion Card (CFFh)
+.El
+.Pp
+.\" The
+.\" .Nm
+.\" driver supports the IPv4 receive/transmit IP/TCP/UDP checksum offload
+.\" and hardware VLAN tagging functionality of the NX2031/NX2035 chipsets.
+.\" The TSO (TCP Segmentation Offload), TOE (TCP Offload Engine), and
+.\" IPsec SA insertion/removal hardware capabilities are not supported by
+.\" the driver.
+.\" .Pp
+The NX2031/NX2035 supports a maximum hardware transmit/receive unit
+with up to 8000 bytes.
+These jumbo frames will be enabled when the MTU is set to a value
+higher than 1500 bytes using the
+.Xr ifconfig 8
+.Ar mtu
+command.
+.Pp
+Multiple
+.Nm nx
+ports can be attached to a
+.Nm nxb
+board, either operating in 10Gb or in 10/100/Gigabit Ethernet mode.
+The
+.Nm
+driver supports the following media types depending on the type
+of the port:
+.Bl -tag -width 10GbaseCX4
+.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.
+.It Cm 100baseTX
+Set 100Mbps (Fast Ethernet) operation.
+.It Cm 1000baseT
+Set 1000Mbps (Gigabit Ethernet) operation over twisted pair.
+.It Cm 10GbaseCX4
+Set 10Gbps (10Gb Ethernet) operation over copper pairs.
+.It Cm 10GbaseSR
+Set 10Gbps (10Gb Ethernet) operation over short range fibre.
+.It Cm 10GbaseLR
+Set 10Gbps (10Gb Ethernet) operation over long range fibre.
+.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
+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 nx0 .
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8
+.Pp
+NetXen, Inc.:
+.Pa http://www.netxen.com
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.2 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Reyk Floeter Aq reyk@openbsd.org .