Man page for ngbe(4).
authorkevlo <kevlo@openbsd.org>
Fri, 31 Mar 2023 08:20:58 +0000 (08:20 +0000)
committerkevlo <kevlo@openbsd.org>
Fri, 31 Mar 2023 08:20:58 +0000 (08:20 +0000)
ok miod@

share/man/man4/Makefile
share/man/man4/ngbe.4 [new file with mode: 0644]
share/man/man4/pci.4

index 8d1cdda..15cc4d7 100644 (file)
@@ -1,4 +1,4 @@
-#      $OpenBSD: Makefile,v 1.834 2023/03/19 11:22:50 kettenis Exp $
+#      $OpenBSD: Makefile,v 1.835 2023/03/31 08:20:58 kevlo Exp $
 
 MAN=   aac.4 abcrtc.4 abl.4 ac97.4 acphy.4 acrtc.4 \
        acpi.4 acpiac.4 acpials.4 acpiasus.4 acpibat.4 \
@@ -60,7 +60,7 @@ MAN=  aac.4 abcrtc.4 abl.4 ac97.4 acphy.4 acrtc.4 \
        multicast.4 mvclock.4 mvdog.4 mvgicp.4 mvgpio.4 mvicu.4 mviic.4 \
        mvkpcie.4 mvneta.4 mvpinctrl.4 mvpp.4 mvrng.4 mvrtc.4 mvspi.4 \
        mvtemp.4 mvsw.4 mvuart.4 myx.4 \
-       ne.4 neo.4 nep.4 netintro.4 nfe.4 nge.4 nmea.4 \
+       ne.4 neo.4 nep.4 netintro.4 nfe.4 ngbe.4 nge.4 nmea.4 \
        nsclpcsio.4 nsgphy.4 nsphy.4 nsphyter.4 null.4 nviic.4 nvme.4 nvt.4 \
        oce.4 ociic.4 ohci.4 onewire.4 oosiop.4 openprom.4 options.4 \
        osiop.4 otus.4 owid.4 owctr.4 owsbm.4 owtemp.4 \
diff --git a/share/man/man4/ngbe.4 b/share/man/man4/ngbe.4
new file mode 100644 (file)
index 0000000..77cf061
--- /dev/null
@@ -0,0 +1,80 @@
+.\" $OpenBSD: ngbe.4,v 1.1 2023/03/31 08:20:58 kevlo Exp $
+.\"
+.\" Copyright (c) 2023 Kevin Lo <kevlo@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 $Mdocdate: March 31 2023 $
+.Dt NGBE 4
+.Os
+.Sh NAME
+.Nm ngbe 
+.Nd WangXun WX1860 PCI Express 10/100/1Gb Ethernet device
+.Sh SYNOPSIS
+.Cd "ngbe* at pci?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for PCI Express Gigabit Ethernet adapters based
+on the WangXun WX1860AL1 and WX1860A2 Ethernet controllers,
+including the following:
+.Pp
+.Bl -bullet -offset indent -compact
+.It
+LR-LINK LRES2034PT (WX1860AL1)
+.It
+LR-LINK LRES2045PT (WX1860A2)
+.El
+.Pp
+The
+.Nm
+driver supports IPv4 receive IP/TCP/UDP checksum offload and VLAN
+tag insertion and stripping.
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width autoselect -offset indent
+.It autoselect
+Enables auto-negotiation for speed and duplex.
+.It 10baseT Cm mediaopt No full-duplex
+Sets 10Mbps operation.
+.It 100baseTX Cm mediaopt No full-duplex
+Sets 100Mbps operation.
+.It 1000baseT
+Sets 1000Mbps operation.
+Only full-duplex mode is supported at this speed.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8
+for more details.
+.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
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 7.4 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Kevin Lo Aq Mt kevlo@openbsd.org .
index 000c64a..33d9ad7 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: pci.4,v 1.397 2023/03/31 02:20:21 kevlo Exp $
+.\"    $OpenBSD: pci.4,v 1.398 2023/03/31 08:20:58 kevlo Exp $
 .\"    $NetBSD: pci.4,v 1.29 2000/04/01 00:32:23 tsarna Exp $
 .\"
 .\" Copyright (c) 2000 Theo de Raadt.  All rights reserved.
@@ -247,6 +247,8 @@ NE2000 and compatible 10/100 Ethernet device
 Sun Neptune 10Gb Ethernet device
 .It Xr nfe 4
 NVIDIA nForce MCP 10/100/1Gb Ethernet device
+.It Xr ngbe 4
+WangXun WX1860 PCI Express 10/100/1Gb Ethernet device
 .It Xr nge 4
 National Semiconductor PCI 10/100/1Gb Ethernet device
 .It Xr oce 4