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 .\"
  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
  36 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device miibus"
  41 .Cd "device gem"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 if_gem_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for the GMAC Ethernet hardware found mostly in
  54 the last Apple PowerBooks G3s and most G4-based Apple hardware, as
  55 well as Sun UltraSPARC machines.
  56 .Pp
  57 All controllers supported by the
  58 .Nm
  59 driver have TCP checksum offload capability for both receive and transmit,
  60 support for the reception and transmission of extended frames for
  61 .Xr vlan 4
  62 and a 512-bit multicast hash filter.
  63 .Sh HARDWARE
  64 Chips supported by the
  65 .Nm
  66 driver include:
  67 .Pp
  68 .Bl -bullet -compact
  69 .It
  70 Apple GMAC
  71 .It
  72 Sun ERI 10/100 Mbps Ethernet
  73 .It
  74 Sun GEM Gigabit Ethernet
  75 .El
  76 .Pp
  77 The
  78 following add-on cards are known to work with the
  79 .Nm
  80 driver at this time:
  81 .Pp
  82 .Bl -bullet -compact
  83 .It
  84 Sun Gigabit Ethernet PCI 2.0/3.0 (GBE/P)
  85 (part no.\& 501-4373)
  86 .It
  87 Sun Gigabit Ethernet SBus 2.0/3.0 (GBE/S)
  88 (part no.\& 501-4375)
  89 .El
  90 .Sh NOTES
  91 On sparc64 the
  92 .Nm
  93 driver respects the
  94 .Va local-mac-address?
  95 system configuration variable which can be set in the Open Firmware boot
  96 monitor using the
  97 .Ic setenv
  98 command or by
  99 .Xr eeprom 8 .
 100 If set to
 101 .Dq Li false
 102 (the default), the
 103 .Nm
 104 driver will use the system's default MAC address for all of its devices.
 105 If set to
 106 .Dq Li true ,
 107 the unique MAC address of each interface is used if present rather than
 108 the system's default MAC address.
 109 .Pp
 110 Supported interfaces having their own MAC address include the on-board
 111 Sun ERI 10/100 Mbps on boards equipped with more than one Ethernet interface
 112 and 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
 121 The
 122 .Nm
 123 device driver appeared in
 124 .Nx 1.6 .
 125 The first
 126 .Fx
 127 version to include it was
 128 .Fx 5.0 .
 129 .Sh AUTHORS
 130 .An -nosplit
 131 The
 132 .Nm
 133 driver was written for
 134 .Nx
 135 by
 136 .An Eduardo Horvath
 137 .Aq eeh@NetBSD.org .
 138 It was ported to
 139 .Fx
 140 by
 141 .An Thomas Moestl
 142 .Aq tmm@FreeBSD.org
 143 and later on improved by
 144 .An Marius Strobl
 145 .Aq marius@FreeBSD.org .
 146 The man page was written by
 147 .An Thomas Klausner
 148 .Aq wiz@NetBSD.org .