xref: /freebsd/share/man/man4/gem.4 (revision 1670a1c2a47d10ecccd001970b859caf93cd3b6e)
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
64.Pp
65Chips supported by the
66.Nm
67driver include:
68.Pp
69.Bl -bullet -compact
70.It
71Apple GMAC
72.It
73Sun ERI 10/100 Mbps Ethernet
74.It
75Sun GEM Gigabit Ethernet
76.El
77.Pp
78The
79following add-on cards are known to work with the
80.Nm
81driver at this time:
82.Pp
83.Bl -bullet -compact
84.It
85Sun Gigabit Ethernet PCI 2.0/3.0 (GBE/P)
86(part no.\& 501-4373)
87.It
88Sun Gigabit Ethernet SBus 2.0/3.0 (GBE/S)
89(part no.\& 501-4375)
90.El
91.Sh NOTES
92On sparc64 the
93.Nm
94driver respects the
95.Va local-mac-address?
96system configuration variable which can be set in the Open Firmware boot
97monitor using the
98.Ic setenv
99command or by
100.Xr eeprom 8 .
101If set to
102.Dq Li false
103(the default), the
104.Nm
105driver will use the system's default MAC address for all of its devices.
106If set to
107.Dq Li true ,
108the unique MAC address of each interface is used if present rather than
109the system's default MAC address.
110.Pp
111Supported interfaces having their own MAC address include the on-board
112Sun ERI 10/100 Mbps on boards equipped with more than one Ethernet interface
113and the Sun Gigabit Ethernet 2.0/3.0 GBE add-on cards.
114.Sh SEE ALSO
115.Xr altq 4 ,
116.Xr miibus 4 ,
117.Xr netintro 4 ,
118.Xr vlan 4 ,
119.Xr eeprom 8 ,
120.Xr ifconfig 8
121.Sh HISTORY
122The
123.Nm
124device driver appeared in
125.Nx 1.6 .
126The first
127.Fx
128version to include it was
129.Fx 5.0 .
130.Sh AUTHORS
131.An -nosplit
132The
133.Nm
134driver was written for
135.Nx
136by
137.An Eduardo Horvath
138.Aq eeh@NetBSD.org .
139It was ported to
140.Fx
141by
142.An Thomas Moestl
143.Aq tmm@FreeBSD.org
144and later on improved by
145.An Marius Strobl
146.Aq marius@FreeBSD.org .
147The man page was written by
148.An Thomas Klausner
149.Aq wiz@NetBSD.org .
150