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