[src/trunk]: src/share/man/man4 Add manual pages for the sip(4) and gsip(4) E...

[thorpej <thorpej%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/fd7628000ace
branches:  trunk
changeset: 510057:fd7628000ace
user:      thorpej <thorpej%NetBSD.org@localhost>
date:      Fri May 18 02:05:20 2001 +0000

description:
Add manual pages for the sip(4) and gsip(4) Ethernet drivers.

diffstat:

 share/man/man4/Makefile |    8 +-
 share/man/man4/gsip.4   |  103 ++++++++++++++++++++++++++++++++++++++++++++++++
 share/man/man4/sip.4    |   87 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 194 insertions(+), 4 deletions(-)

diffs (226 lines):

diff -r a84397aa6629 -r fd7628000ace share/man/man4/Makefile
--- a/share/man/man4/Makefile   Fri May 18 02:03:53 2001 +0000
+++ b/share/man/man4/Makefile   Fri May 18 02:05:20 2001 +0000
@@ -1,12 +1,12 @@
-#      $NetBSD: Makefile,v 1.197 2001/05/12 14:06:30 tsutsui Exp $
+#      $NetBSD: Makefile,v 1.198 2001/05/18 02:05:20 thorpej Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   adv.4 adw.4 ahb.4 ahc.4 an.4 aria.4 atalk.4 audio.4 auich.4 auvia.4 \
        awi.4 bba.4 bha.4 bktr.4 bpf.4 cac.4 cardbus.4 ccd.4 \
        cd.4 ch.4 clcs.4 clct.4 clnp.4 cltp.4 cmpci.4 cms.4 cnw.4 com.4 ddb.4 \
        de.4 dpt.4 drum.4 eap.4 edc.4 elmc.4 en.4 envsys.4 ep.4 esh.4 \
-       esis.4 esm.4 eso.4 exphy.4 fd.4 fpa.4 fms.4 fxp.4 gre.4 hme.4 icmp.4 \
-       icsphy.4 idp.4 ifmedia.4 inet.4 inphy.4 intersil7170.4 ioat.4 \
+       esis.4 esm.4 eso.4 exphy.4 fd.4 fpa.4 fms.4 fxp.4 gre.4 gsip.4 hme.4 \
+       icmp.4 icsphy.4 idp.4 ifmedia.4 inet.4 inphy.4 intersil7170.4 ioat.4 \
        iop.4 iophy.4 iopsp.4 ip.4 ipip.4 ipkdb.4 iso.4 isp.4 \
        lc.4 ld.4 lkm.4 lo.4 lxtphy.4 \
        mainbus.4 mbe.4 mca.4 md.4 mhzc.4 midi.4 mii.4 mk48txx.4 mlx.4 \
@@ -14,7 +14,7 @@
        nsphy.4 ntwoc.4 null.4 opl.4 options.4 osiop.4 pas.4 pcdisplay.4 \
        pciide.4 pckbc.4 pckbd.4 pcppi.4 pcscp.4 pcweasel.4 pms.4 ppp.4 \
        pty.4 puc.4 qsphy.4 raid.4 ray.4 rnd.4 route.4 \
-       rtk.4 scsi.4 sd.4 se.4 ses.4 siop.4 sl.4 sm.4 speaker.4 spp.4 \
+       rtk.4 scsi.4 sd.4 se.4 ses.4 siop.4 sip.4 sl.4 sm.4 speaker.4 spp.4 \
        sqphy.4 ss.4 st.4 sv.4 strip.4 tb.4 tcp.4 termios.4 \
        ti.4 tl.4 tlp.4 tlphy.4 tp.4 tr.4 tty.4 tun.4 tqphy.4 twe.4 \
        udp.4 uha.4 uk.4 ukphy.4 unix.4 vga.4 vlan.4 vnd.4 vr.4 wd.4 \
diff -r a84397aa6629 -r fd7628000ace share/man/man4/gsip.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/gsip.4     Fri May 18 02:05:20 2001 +0000
@@ -0,0 +1,103 @@
+.\"    $NetBSD: gsip.4,v 1.1 2001/05/18 02:05:20 thorpej Exp $
+.\"
+.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jason R. Thorpe.
+.\"
+.\" 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 the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+.\"
+.Dd May 17, 2001
+.Dt GSIP 4
+.Os
+.Sh NAME
+.Nm gsip
+.Nd National Semiconductor DP83820 Gigabit Ethernet driver
+.Sh SYNOPSIS
+.Cd "gsip* at pci? dev ? function ?"
+.Pp
+Configuration of PHYs may also be necessary.  See
+.Xr mii 4 .
+.Sh DESCRIPTION
+The
+.Nm
+device driver supports Gigabit Ethernet interfaces based on the
+National Semiconductor DP83820 Gigabit Ethernet chips.
+.Pp
+The National Semiconductor DP83820 is found on NetGear GA-622,
+Asante FriendlyNet GigaNIX, and other low-cost Gigabit Ethernet
+cards.  It uses an external PHY or an external 10-bit interface.
+.Pp
+The DP83820 supports VLAN tag insertion/removal in hardware.  The
+.Nm
+driver supports this feature of the chip.
+.Pp
+The DP83820 chip is a close relative of the DP83815 10/100 Ethernet
+chip, which is supported by the
+.Xr sip 4
+driver, hence the
+.Nm
+name.
+.\" .Sh DIAGNOSTICS
+.\" XXX too be done.
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.Xr mii 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr ifconfig 8 ,
+.Xr vlan 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Nx 1.6 .
+.Sh BUGS
+The
+.Nm
+driver does not support the IPv4/TCP/UDP checksumming features
+of the DP83820 chip.
+.Pp
+The
+.Nm
+driver does not support transmission or reception of jumbo Ethernet
+frames.
+.Pp
+The
+.Nm
+driver does not support the 10-bit interface, which is required in
+order to support fiber-optic media.
+.Sh AUTHOR
+The
+.Nm
+driver was written by
+.An Jason R. Thorpe
+.Aq thorpej%netbsd.org@localhost .
diff -r a84397aa6629 -r fd7628000ace share/man/man4/sip.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/sip.4      Fri May 18 02:05:20 2001 +0000
@@ -0,0 +1,87 @@
+.\"    $NetBSD: sip.4,v 1.1 2001/05/18 02:05:20 thorpej Exp $
+.\"
+.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jason R. Thorpe.
+.\"
+.\" 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 the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+.\"
+.Dd May 17, 2001
+.Dt SIP 4
+.Os
+.Sh NAME
+.Nm sip
+.Nd SiS 900-based Ethernet driver
+.Sh SYNOPSIS
+.Cd "sip* at pci? dev ? function ?"
+.Pp
+Configuration of PHYs is also necessary.  See
+.Xr mii 4 .
+.Sh DESCRIPTION
+The
+.Nm
+device driver supports Ethernet interfaces based on the Silicon
+Integrated Systems SiS 900, SiS 7016, and National Semiconductor
+DP83815 Ethernet chips.
+.Pp
+The SiS 900 is found on many motherboards featuring SiS chipsets,
+and on some embedded systems, and has a built-in PHY.  The SiS 7016
+is an older version of the chip, which uses an external PHY.
+.Pp
+The National Semiconductor DP83815 is found on NetGear FA-311 and
+FA-312 Ethernet boards, and has a built-in PHY.
+.\" .Sh DIAGNOSTICS
+.\" XXX too be done.
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.Xr mii 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Nx 1.5 .
+.Sh AUTHOR
+The
+.Nm
+driver was originally written by
+.An Jason R. Thorpe
+for Network Computer, Inc.
+.Pp
+It has since been modified by
+.An Jason R. Thorpe
+.Aq thorpej%netbsd.org@localhost
+and
+.An Allen Briggs
+.Aq briggs%netbsd.org@localhost .