xref: /freebsd/share/man/man4/gem.4 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
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 NOTES
91On sparc64 the
92.Nm
93driver respects the
94.Va local-mac-address?
95system configuration variable which can be set in the Open Firmware boot
96monitor using the
97.Ic setenv
98command or by
99.Xr eeprom 8 .
100If set to
101.Dq Li false
102(the default), the
103.Nm
104driver will use the system's default MAC address for all of its devices.
105If set to
106.Dq Li true ,
107the unique MAC address of each interface is used if present rather than
108the system's default MAC address.
109.Pp
110Supported interfaces having their own MAC address include the on-board
111Sun ERI 10/100 Mbps on boards equipped with more than one Ethernet interface
112and the Sun Gigabit Ethernet 2.0/3.0 GBE add-on cards.
113.Sh SEE ALSO
114.Xr altq 4 ,
115.Xr miibus 4 ,
116.Xr netintro 4 ,
117.Xr vlan 4 ,
118.Xr eeprom 8 ,
119.Xr ifconfig 8
120.Sh HISTORY
121The
122.Nm
123device driver appeared in
124.Nx 1.6 .
125The first
126.Fx
127version to include it was
128.Fx 5.0 .
129.Sh AUTHORS
130.An -nosplit
131The
132.Nm
133driver was written for
134.Nx
135by
136.An Eduardo Horvath Aq Mt eeh@NetBSD.org .
137It was ported to
138.Fx
139by
140.An Thomas Moestl Aq Mt tmm@FreeBSD.org
141and later on improved by
142.An Marius Strobl Aq Mt marius@FreeBSD.org .
143The man page was written by
144.An Thomas Klausner Aq Mt wiz@NetBSD.org .
145