share/man/man4/gem.4

   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 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"        This product includes software developed by the NetBSD
  17 .\"        Foundation, Inc. and its contributors.
  18 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  19 .\"    contributors may be used to endorse or promote products derived
  20 .\"    from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32 .\" POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .\" $FreeBSD$
  35 .\"
  36 .Dd December 25, 2009
  37 .Dt GEM 4
  38 .Os
  39 .Sh NAME
  40 .Nm gem
  41 .Nd ERI/GEM/GMAC Ethernet device driver
  42 .Sh SYNOPSIS
  43 To compile this driver into the kernel,
  44 place the following lines in your
  45 kernel configuration file:
  46 .Bd -ragged -offset indent
  47 .Cd "device miibus"
  48 .Cd "device gem"
  49 .Ed
  50 .Pp
  51 Alternatively, to load the driver as a
  52 module at boot time, place the following line in
  53 .Xr loader.conf 5 :
  54 .Bd -literal -offset indent
  55 if_gem_load="YES"
  56 .Ed
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 driver provides support for the GMAC Ethernet hardware found mostly in
  61 the last Apple PowerBooks G3s and most G4-based Apple hardware, as
  62 well as Sun UltraSPARC machines.
  63 .Pp
  64 All controllers supported by the
  65 .Nm
  66 driver have TCP checksum offload capability for both receive and transmit,
  67 support for the reception and transmission of extended frames for
  68 .Xr vlan 4
  69 and a 512-bit multicast hash filter.
  70 .Sh HARDWARE
  71 .Pp
  72 Chips supported by the
  73 .Nm
  74 driver include:
  75 .Pp
  76 .Bl -bullet -compact
  77 .It
  78 Apple GMAC
  79 .It
  80 Sun ERI 10/100 Mbps Ethernet
  81 .It
  82 Sun GEM Gigabit Ethernet
  83 .El
  84 .Pp
  85 The
  86 following add-on cards are known to work with the
  87 .Nm
  88 driver at this time:
  89 .Pp
  90 .Bl -bullet -compact
  91 .It
  92 Sun Gigabit Ethernet PCI 2.0/3.0 (GBE/P)
  93 (part no.\& 501-4373)
  94 .It
  95 Sun Gigabit Ethernet SBus 2.0/3.0 (GBE/S)
  96 (part no.\& 501-4375)
  97 .El
  98 .Sh NOTES
  99 On sparc64 the
 100 .Nm
 101 driver respects the
 102 .Va local-mac-address?
 103 system configuration variable which can be set in the Open Firmware boot
 104 monitor using the
 105 .Ic setenv
 106 command or by
 107 .Xr eeprom 8 .
 108 If set to
 109 .Dq Li false
 110 (the default), the
 111 .Nm
 112 driver will use the system's default MAC address for all of its devices.
 113 If set to
 114 .Dq Li true ,
 115 the unique MAC address of each interface is used if present rather than
 116 the system's default MAC address.
 117 .Pp
 118 Supported interfaces having their own MAC address include the on-board
 119 Sun ERI 10/100 Mbps on boards equipped with more than one Ethernet interface
 120 and the Sun Gigabit Ethernet 2.0/3.0 GBE add-on cards.
 121 .Sh SEE ALSO
 122 .Xr altq 4 ,
 123 .Xr miibus 4 ,
 124 .Xr netintro 4 ,
 125 .Xr vlan 4 ,
 126 .Xr eeprom 8 ,
 127 .Xr ifconfig 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 device driver appeared in
 132 .Nx 1.6 .
 133 The first
 134 .Fx
 135 version to include it was
 136 .Fx 5.0 .
 137 .Sh AUTHORS
 138 .An -nosplit
 139 The
 140 .Nm
 141 driver was written for
 142 .Nx
 143 by
 144 .An Eduardo Horvath
 145 .Aq eeh@NetBSD.org .
 146 It was ported to
 147 .Fx
 148 by
 149 .An Thomas Moestl
 150 .Aq tmm@FreeBSD.org
 151 and later on improved by
 152 .An Marius Strobl
 153 .Aq marius@FreeBSD.org .
 154 The man page was written by
 155 .An Thomas Klausner
 156 .Aq wiz@NetBSD.org .