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 January 15, 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 many Sun UltraSPARCs.
  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 .El
  88 .Sh NOTES
  89 On sparc64 the
  90 .Nm
  91 driver respects the
  92 .Va local-mac-address?
  93 system configuration variable which can be set in the Open Firmware boot
  94 monitor using the
  95 .Ic setenv
  96 command or by
  97 .Xr eeprom 8 .
  98 If set to
  99 .Dq Li false
 100 (the default), the
 101 .Nm
 102 driver will use the system's default MAC address for all of its devices.
 103 If set to
 104 .Dq Li true ,
 105 the unique MAC address of each interface is used if present rather than
 106 the system's default MAC address.
 107 .Pp
 108 Supported interfaces having their own MAC address include the on-board
 109 Sun ERI 10/100 Mbps on boards equipped with more than one Ethernet interface
 110 and the Sun Gigabit Ethernet 2.0/3.0 GBE add-on cards.
 111 .Sh CAVEATS
 112 Currently the
 113 .Nm
 114 driver fails to attach to Sun Gigabit Ethernet SBus 2.0/3.0 (GBE/S) cards,
 115 as no SBus front-end has been written so far.
 116 .Sh SEE ALSO
 117 .Xr altq 4 ,
 118 .Xr miibus 4 ,
 119 .Xr netintro 4 ,
 120 .Xr eeprom 8 ,
 121 .Xr ifconfig 8
 122 .Sh HISTORY
 123 The
 124 .Nm
 125 device driver appeared in
 126 .Nx 1.6 .
 127 The first
 128 .Fx
 129 version to include it was
 130 .Fx 5.0 .
 131 .Sh AUTHORS
 132 .An -nosplit
 133 The
 134 .Nm
 135 driver was written by
 136 .An Eduardo Horvath
 137 .Aq eeh@NetBSD.org .
 138 The man page was written by
 139 .An Thomas Klausner
 140 .Aq wiz@NetBSD.org .