manpages for VIA VT612x driver + Cicada PHY

3 files changed, 237 insertions, 4 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 9985a4e4b3c..cff09fc4cea 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,12 +1,12 @@
-#	$OpenBSD: Makefile,v 1.281 2004/11/29 22:56:04 canacar Exp $
+#	$OpenBSD: Makefile,v 1.282 2004/12/01 01:29:37 pvalchev Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \
 	aic.4 amdpm.4 ami.4 amphy.4 an.4 aria.4 ast.4 atalk.4 \
 	atapiscsi.4 ath.4 atu.4 atw.4 audio.4 aue.4 auich.4 autri.4 \
 	auvia.4 awi.4 axe.4 az.4 bce.4 bge.4 bha.4 bio.4 bktr.4 \
 	bmtphy.4 boca.4 bpf.4 brgphy.4 bridge.4 cac.4 cardbus.4 \
-	carp.4 ccd.4 cd.4 cdce.4 ch.4 clcs.4 clct.4 cmpci.4 cnw.4 com.4 \
-	crypto.4 cue.4 cy.4 cz.4 dc.4 dcphy.4 ddb.4 de.4 dpt.4 \
+	carp.4 ccd.4 cd.4 cdce.4 ch.4 ciphy.4 clcs.4 clct.4 cmpci.4 cnw.4 \
+	com.4 crypto.4 cue.4 cy.4 cz.4 dc.4 dcphy.4 ddb.4 de.4 dpt.4 \
 	drum.4 eap.4 ec.4 eephy.4 ef.4 eg.4 ehci.4 eisa.4 el.4 em.4 \
 	emu.4 enc.4 ep.4 esa.4 eso.4 ess.4 exphy.4 \
 	faith.4 fd.4 fdc.4 fms.4 fpa.4 fxp.4 gdt.4 gentbi.4 gem.4 gif.4 \
@@ -33,7 +33,7 @@ MAN=	aac.4 ac97.4 acphy.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 \
 	uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uk.4 ukbd.4 \
 	ukphy.4 ulpt.4 umass.4 umct.4 umidi.4 umodem.4 ums.4 \
 	unix.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 \
-	uscanner.4 usscanner.4 uvisor.4 uvscom.4 uyap.4 vga.4 \
+	uscanner.4 usscanner.4 uvisor.4 uvscom.4 uyap.4 vga.4 vge.4 \
 	viaenv.4 vlan.4 vnd.4 vr.4 wb.4 wd.4 wdc.4 we.4 wi.4tbl \
 	wscons.4 wsdisplay.4 wskbd.4 wsmouse.4 wsmux.4 xe.4 \
 	xf86.4 xl.4 xmphy.4 yds.4 ym.4 zero.4
diff --git a/share/man/man4/ciphy.4 b/share/man/man4/ciphy.4
new file mode 100644
index 00000000000..86121b48083
--- /dev/null
+++ b/share/man/man4/ciphy.4
@@ -0,0 +1,36 @@
+.\"	$OpenBSD: ciphy.4,v 1.1 2004/12/01 01:29:37 pvalchev Exp $
+.\"
+.\" Copyright (c) 2004 Peter Valchev <pvalchev@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 November 30, 2004
+.Dt CIPHY 4
+.Os
+.Sh NAME
+.Nm ciphy
+.Nd Cicada CS8201 10/100/1000 copper PHY driver
+.Sh SYNOPSIS
+.Cd "ciphy* at mii?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports the copper PHY found on VIA VT612x
+Gigabit Ethernet adapters (see
+.Xr vge 4 ) .
+.Sh SEE ALSO
+.Xr ifmedia 4 ,
+.Xr intro 4 ,
+.Xr mii 4 ,
+.Xr vge 4 ,
+.Xr ifconfig 8
diff --git a/share/man/man4/vge.4 b/share/man/man4/vge.4
new file mode 100644
index 00000000000..b1de2715b5c
--- /dev/null
+++ b/share/man/man4/vge.4
@@ -0,0 +1,197 @@
+.\" $OpenBSD: vge.4,v 1.1 2004/12/01 01:29:37 pvalchev Exp $
+.\" $FreeBSD: vge.4,v 1.6 2004/11/24 19:06:43 brueffer Exp $
+.\"
+.\" Copyright (c) 2004
+.\"	Bill Paul <wpaul@windriver.com>. 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.
+.\"
+.Dd November 24, 2004
+.Dt VGE 4
+.Os
+.Sh NAME
+.Nm vge
+.Nd "VIA Networking Technologies VT6122 PCI Gigabit Ethernet adapter driver"
+.Sh SYNOPSIS
+.Cd "re* at pci?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for various NICs and embedded Ethernet interfaces
+based on the VIA Networking Technologies VT6122 Gigabit Ethernet
+controller chips.
+.Pp
+The VT6122 is a 33/66Mhz 64-bit PCI device which combines a tri-speed MAC with
+an integrated 10/100/1000 copper PHY.
+(Some older cards use an external PHY.)
+.\" The MAC supports TCP/IP hardware
+.\" checksums (IPv4 only), TCP large send, VLAN tag insertion and stripping,
+.\" as well as VLAN filtering, a 64-entry CAM filter and a 64-entry VLAN filter,
+.\" 64-bit multicast hash filter, 4 separate transmit DMA queues, flow control
+.\" and jumbo frames up to 16K in size.
+.\" The VT6122 has a 16K receive FIFO and 48K transmit FIFO.
+.\" .Pp
+.\" The
+.\" .Nm
+.\" driver takes advantage of the VT6122's checksum offload and VLAN
+.\" tagging features, as well as the jumbo frame and CAM filter support.
+.\" The CAM filter is used for multicast address filtering to provide
+.\" 64 perfect multicast address filter support.
+.\" If it is necessary for the interface to join more than 64 multicast
+.\" groups, the driver will switch over to using the hash filter.
+.Pp
+The jumbo frame support can be enabled by setting the interface MTU
+to any value larger than the default of 1500 bytes, up to a maximum
+of 9000 bytes.
+The receive and transmit checksum offload support
+can be toggled on and off using the
+.Xr ifconfig 8
+utility.
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width 10baseTXUTP
+.It 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 10baseT/UTP
+Set 10Mbps operation.
+The
+.Xr ifconfig 8
+.Ic mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex
+modes.
+.It 100baseTX
+Set 100Mbps (Fast Ethernet) operation.
+The
+.Xr ifconfig 8
+.Ic mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex
+modes.
+.It 1000baseTX
+Set 1000baseTX operation over twisted pair.
+Both
+.Ar full-duplex
+and
+.Ar half-duplex
+modes are supported.
+.El
+.Pp
+The
+.Nm
+driver supports the following media options:
+.Bl -tag -width full-duplex
+.It full-duplex
+Force full duplex operation.
+.It half-duplex
+Force half duplex operation.
+.El
+.\" .Pp
+.\" The
+.\" .Nm
+.\" driver also supports one special link option for 1000baseTX cards:
+.\" .Bl -tag -width link0
+.\" .It link0
+.\" With 1000baseTX 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 .
+.Sh HARDWARE
+The
+.Nm
+driver supports VIA Networking VT3119 and VT6122 based
+Gigabit Ethernet adapters including:
+.Pp
+.Bl -bullet -compact
+.It
+VIA Networking LAN-on-motherboard Gigabit Ethernet
+.It
+ZyXEL GN650-T 64-bit PCI Gigabit Ethernet NIC (ZX1701)
+.It
+ZyXEL GN670-T 32-bit PCI Gigabit Ethernet NIC (ZX1702)
+.El
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "vge%d: can't map mem space"
+A fatal initialization error has occurred.
+.It "vge%d: can't map i/o space"
+A fatal initialization error has occurred.
+.It "vge%d: couldn't map interrupt"
+A fatal initialization error has occurred.
+.It "vge%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 ifmedia 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr ciphy 4 ,
+.Xr vlan 4 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Ox 3.7 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul@windriver.com
+and ported to
+.Ox
+by
+.An Peter Valchev Aq pvalchev@openbsd.org .