From cc264d0083fbc5f7b096ffe88dd5f7b0481cdcee Mon Sep 17 00:00:00 2001 From: Thomas Moestl Date: Tue, 10 Jun 2003 18:53:15 +0000 Subject: [PATCH] - Add manpages for the gem and hme ethernet drivers. These were obtained from NetBSD, and changed slightly to account for FreeBSD specifics. - Hook them up to the build. - Add them to the list of miibus-using drivers in miibus(4). --- share/man/man4/Makefile | 4 ++ share/man/man4/gem.4 | 82 +++++++++++++++++++++++++++++ share/man/man4/hme.4 | 113 ++++++++++++++++++++++++++++++++++++++++ share/man/man4/miibus.4 | 6 +++ 4 files changed, 205 insertions(+) create mode 100644 share/man/man4/gem.4 create mode 100644 share/man/man4/hme.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 2b5c9421fc1c..8171ba2b2512 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -61,12 +61,14 @@ MAN= aac.4 \ fwohci.4 \ fxp.4 \ gbde.4 \ + gem.4 \ geom.4 \ gif.4 \ gre.4 \ gusc.4 \ gx.4 \ hifn.4 \ + hme.4 \ ichsmb.4 \ icmp.4 \ icmp6.4 \ @@ -290,9 +292,11 @@ MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4 MLINKS+=fpa.4 fea.4 MLINKS+=fwe.4 if_fwp.4 MLINKS+=fxp.4 if_fxp.4 +MLINKS+=gem.4 if_gem.4 MLINKS+=gif.4 if_gif.4 MLINKS+=gre.4 if_gre.4 MLINKS+=gx.4 if_gx.4 +MLINKS+=hme.4 if_hme.4 MLINKS+=ipfirewall.4 ipacct.4 ipfirewall.4 ipaccounting.4 ipfirewall.4 ipfw.4 MLINKS+=kue.4 if_kue.4 MLINKS+=lge.4 if_lge.4 diff --git a/share/man/man4/gem.4 b/share/man/man4/gem.4 new file mode 100644 index 000000000000..7fb2739ede24 --- /dev/null +++ b/share/man/man4/gem.4 @@ -0,0 +1,82 @@ +.\" $FreeBSD$ +.\" $NetBSD: gem.4,v 1.2 2003/02/14 15:20:18 grant Exp $ +.\" +.\" Copyright (c) 2002 The NetBSD Foundation, Inc. +.\" 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 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 June 10, 2003 +.Dt GEM 4 +.Os +.Sh NAME +.Nm gem +.Nd ERI/GEM/GMAC Ethernet device driver +.Sh SYNOPSIS +.Cd "device miibus" +.Cd "device gem" +.Sh DESCRIPTION +The +.Nm +driver provides support for the GMac Ethernet hardware found mostly in +the last Apple PowerBooks G3s and most G4-based Apple hardware, as +well as many Sun UltraSPARCs. +.Pp +Cards supported by this driver include: +.Bl -bullet -compact -offset indent +.It +Sun GEM gigabit ethernet +.It +Sun ERI 10/100 Mbps ethernet +.It +Apple GMAC +.El +.Sh SEE ALSO +.Xr hme 4 , +.Xr miibus 4 , +.Xr netintro 4 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +device driver appeared in +.Nx 1.6 . +The first +.Fx +version to include it was +.Fx 5.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Eduardo Horvath +.Aq eeh@NetBSD.org . +The man page was written by +.An Thomas Klausner +.Aq wiz@NetBSD.org . diff --git a/share/man/man4/hme.4 b/share/man/man4/hme.4 new file mode 100644 index 000000000000..78c6a1cbb8be --- /dev/null +++ b/share/man/man4/hme.4 @@ -0,0 +1,113 @@ +.\" $FreeBSD$ +.\" $NetBSD: hme.4,v 1.4 2003/02/14 15:20:18 grant Exp $ +.\" +.\" Copyright (c) 2001 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Klaus Klein. +.\" +.\" 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 21, 2003 +.Dt HME 4 +.Os +.Sh NAME +.Nm hme +.Nd Sun Microelectronics STP2002-STQ Ethernet interfaces device driver +.Sh SYNOPSIS +.Cd "device miibus" +.Cd "device hme" +.Sh DESCRIPTION +The +.Nm +driver supports Sun Microelectronics STP2002-STQ Fast Ethernet interfaces. +.Sh HARDWARE +The +.Nm +driver supports the on-board Ethernet interfaces of many +Sun +.Tn UltraSPARC +workstation and server models. +.Pp +Cards supported by the +.Nm +driver include: +.Pp +.Bl -item -compact +.It +Sun PCI SunSwift Adapter +.Po Do SUNW,hme Dc Pc +.It +Sun SBus SunSwift Adapter +.Po +.Dq hme +and +.Dq SUNW,hme +.Pc +.It +Sun PCI Sun100BaseT Adapter 2.0 +.Po Do SUNW,hme Dc Pc +.It +Sun SBus Sun100BaseT 2.0 +.Po Do SUNW,hme Dc Pc +.It +Sun PCI Quad FastEthernet Controller +.Po Do SUNW,qfe Dc Pc +.It +Sun SBus Quad FastEthernet Controller +.Po Do SUNW,qfe Dc Pc +.El +.Sh SEE ALSO +.Xr gem 4 , +.Xr intro 4 , +.Xr miibus 4 , +.Xr netintro 4 , +.Xr ifconfig 8 +.Rs +.%T "STP2002QFP Fast Ethernet, Parallel Port, SCSI (FEPS) User's Guide" +.%D April 1996 +.%A Sun Microelectronics +.%O http://www.sun.com/microelectronics/manuals/STP2002QFP-UG.pdf +.Re +.Sh HISTORY +The +.Nm +driver first appeared in +.Nx 1.5 . +The first +.Fx +version to include it was +.Fx 5.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Paul Kranenburg +.Aq pk@NetBSD.org . diff --git a/share/man/man4/miibus.4 b/share/man/man4/miibus.4 index c98f4723d05d..c03a45089b47 100644 --- a/share/man/man4/miibus.4 +++ b/share/man/man4/miibus.4 @@ -61,6 +61,10 @@ DEC/Intel 21143 and various workalikes NE[12]000, SMC Ultra, 3c503, DS8390 cards .It Xr fxp 4 Intel EtherExpress PRO/100B (82557, 82558) +.It Xr gem 4 +Sun ERI, Sun GEM and Apple GMAC Ethernet +.It Xr hme 4 +Sun HME Ethernet .It Xr kue 4 Kawasaki LSI USB Ethernet .It Xr pcn 4 @@ -103,6 +107,8 @@ but as a result are not well behaved newbus device drivers. .Xr dc 4 , .Xr ed 4 , .Xr fxp 4 , +.Xr gem 4 , +.Xr hme 4 , .Xr kue 4 , .Xr netintro 4 , .Xr pcn 4 ,