share/man/man4/hme.4

   1 .\"     $NetBSD: hme.4,v 1.4 2003/02/14 15:20:18 grant Exp $
   2 .\"
   3 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Klaus Klein.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"        This product includes software developed by the NetBSD
  20 .\"        Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd July 16, 2005
  40 .Dt HME 4
  41 .Os
  42 .Sh NAME
  43 .Nm hme
  44 .Nd "Sun Microelectronics STP2002-STQ Ethernet interfaces device driver"
  45 .Sh SYNOPSIS
  46 To compile this driver into the kernel,
  47 place the following lines in your
  48 kernel configuration file:
  49 .Bd -ragged -offset indent
  50 .Cd "device miibus"
  51 .Cd "device hme"
  52 .Ed
  53 .Pp
  54 Alternatively, to load the driver as a
  55 module at boot time, place the following line in
  56 .Xr loader.conf 5 :
  57 .Bd -literal -offset indent
  58 if_hme_load="YES"
  59 .Ed
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 driver supports Sun Microelectronics STP2002-STQ Fast Ethernet interfaces.
  64 .Sh HARDWARE
  65 The
  66 .Nm
  67 driver supports the on-board Ethernet interfaces of many
  68 Sun
  69 .Tn UltraSPARC
  70 workstation and server models.
  71 .Pp
  72 Cards supported by the
  73 .Nm
  74 driver include:
  75 .Pp
  76 .Bl -bullet -compact
  77 .It
  78 Sun PCI SunSwift Adapter
  79 .Pq Dq SUNW,hme
  80 .It
  81 Sun SBus SunSwift Adapter
  82 .Dq ( hme
  83 and
  84 .Dq SUNW,hme )
  85 .It
  86 Sun PCI Sun100BaseT Adapter 2.0
  87 .Pq Dq SUNW,hme
  88 .It
  89 Sun SBus Sun100BaseT 2.0
  90 .Pq Dq SUNW,hme
  91 .It
  92 Sun PCI Quad FastEthernet Controller
  93 .Pq Dq SUNW,qfe
  94 .It
  95 Sun SBus Quad FastEthernet Controller
  96 .Pq Dq SUNW,qfe
  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 on-board versions
 119 on boards equipped with more than one Ethernet interface and all add-on cards
 120 except the single-port SBus versions.
 121 .Sh SEE ALSO
 122 .Xr altq 4 ,
 123 .Xr gem 4 ,
 124 .Xr intro 4 ,
 125 .Xr miibus 4 ,
 126 .Xr netintro 4 ,
 127 .Xr eeprom 8 ,
 128 .Xr ifconfig 8
 129 .Rs
 130 .%T "STP2002QFP Fast Ethernet, Parallel Port, SCSI (FEPS) User's Guide"
 131 .%D April 1996
 132 .%A Sun Microelectronics
 133 .%O http://www.sun.com/oem/products/manuals/STP2002QFP-UG.pdf
 134 .Re
 135 .Sh HISTORY
 136 The
 137 .Nm
 138 driver first appeared in
 139 .Nx 1.5 .
 140 The first
 141 .Fx
 142 version to include it was
 143 .Fx 5.0 .
 144 .Sh AUTHORS
 145 The
 146 .Nm
 147 driver was written by
 148 .An Paul Kranenburg
 149 .Aq pk@NetBSD.org .