xref: /freebsd/share/man/man4/gem.4 (revision c697fb7f)
1.\" $NetBSD: gem.4,v 1.2 2003/02/14 15:20:18 grant Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd December 25, 2009
30.Dt GEM 4
31.Os
32.Sh NAME
33.Nm gem
34.Nd ERI/GEM/GMAC Ethernet device driver
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device miibus"
41.Cd "device gem"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48if_gem_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for the GMAC Ethernet hardware found mostly in
54the last Apple PowerBooks G3s and most G4-based Apple hardware, as
55well as Sun UltraSPARC machines.
56.Pp
57All controllers supported by the
58.Nm
59driver have TCP checksum offload capability for both receive and transmit,
60support for the reception and transmission of extended frames for
61.Xr vlan 4
62and a 512-bit multicast hash filter.
63.Sh HARDWARE
64Chips supported by the
65.Nm
66driver include:
67.Pp
68.Bl -bullet -compact
69.It
70Apple GMAC
71.It
72Sun ERI 10/100 Mbps Ethernet
73.It
74Sun GEM Gigabit Ethernet
75.El
76.Pp
77The
78following add-on cards are known to work with the
79.Nm
80driver at this time:
81.Pp
82.Bl -bullet -compact
83.It
84Sun Gigabit Ethernet PCI 2.0/3.0 (GBE/P)
85(part no.\& 501-4373)
86.It
87Sun Gigabit Ethernet SBus 2.0/3.0 (GBE/S)
88(part no.\& 501-4375)
89.El
90.Sh SEE ALSO
91.Xr altq 4 ,
92.Xr miibus 4 ,
93.Xr netintro 4 ,
94.Xr vlan 4 ,
95.Xr eeprom 8 ,
96.Xr ifconfig 8
97.Sh HISTORY
98The
99.Nm
100device driver appeared in
101.Nx 1.6 .
102The first
103.Fx
104version to include it was
105.Fx 5.0 .
106.Sh AUTHORS
107.An -nosplit
108The
109.Nm
110driver was written for
111.Nx
112by
113.An Eduardo Horvath Aq Mt eeh@NetBSD.org .
114It was ported to
115.Fx
116by
117.An Thomas Moestl Aq Mt tmm@FreeBSD.org
118and later on improved by
119.An Marius Strobl Aq Mt marius@FreeBSD.org .
120The man page was written by
121.An Thomas Klausner Aq Mt wiz@NetBSD.org .
122