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 June 14, 2009
  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
  64 .Dq Happy Meal Ethernet
  65 Fast Ethernet interfaces.
  66 .Pp
  67 All controllers supported by the
  68 .Nm
  69 driver have TCP checksum offload capability for both receive and transmit,
  70 support for the reception and transmission of extended frames for
  71 .Xr vlan 4
  72 and a 128-bit multicast hash filter.
  73 .Sh HARDWARE
  74 The
  75 .Nm
  76 driver supports the on-board Ethernet interfaces of many
  77 Sun
  78 .Tn UltraSPARC
  79 workstation and server models.
  80 .Pp
  81 Cards supported by the
  82 .Nm
  83 driver include:
  84 .Pp
  85 .Bl -bullet -compact
  86 .It
  87 Sun PCI SunSwift Adapter
  88 .Pq Dq SUNW,hme
  89 .It
  90 Sun SBus SunSwift Adapter
  91 .Dq ( hme
  92 and
  93 .Dq SUNW,hme )
  94 .It
  95 Sun PCI Sun100BaseT Adapter 2.0
  96 .Pq Dq SUNW,hme
  97 .It
  98 Sun SBus Sun100BaseT 2.0
  99 .Pq Dq SUNW,hme
 100 .It
 101 Sun PCI Quad FastEthernet Controller
 102 .Pq Dq SUNW,qfe
 103 .It
 104 Sun SBus Quad FastEthernet Controller
 105 .Pq Dq SUNW,qfe
 106 .El
 107 .Sh NOTES
 108 On sparc64 the
 109 .Nm
 110 driver respects the
 111 .Va local-mac-address?
 112 system configuration variable which can be set in the Open Firmware boot
 113 monitor using the
 114 .Ic setenv
 115 command or by
 116 .Xr eeprom 8 .
 117 If set to
 118 .Dq Li false
 119 (the default), the
 120 .Nm
 121 driver will use the system's default MAC address for all of its devices.
 122 If set to
 123 .Dq Li true ,
 124 the unique MAC address of each interface is used if present rather than
 125 the system's default MAC address.
 126 .Pp
 127 Supported interfaces having their own MAC address include on-board versions
 128 on boards equipped with more than one Ethernet interface and all add-on cards
 129 except the single-port SBus versions.
 130 .Sh SEE ALSO
 131 .Xr altq 4 ,
 132 .Xr intro 4 ,
 133 .Xr miibus 4 ,
 134 .Xr netintro 4 ,
 135 .Xr vlan 4 ,
 136 .Xr eeprom 8 ,
 137 .Xr ifconfig 8
 138 .Rs
 139 .%T "STP2002QFP Fast Ethernet, Parallel Port, SCSI (FEPS) User's Guide"
 140 .%D April 1996
 141 .%A Sun Microelectronics
 142 .%O http://mediacast.sun.com/users/Barton808/media/STP2002QFP-FEPs_UG.pdf
 143 .Re
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 driver first appeared in
 148 .Nx 1.5 .
 149 The first
 150 .Fx
 151 version to include it was
 152 .Fx 5.0 .
 153 .Sh AUTHORS
 154 The
 155 .Nm
 156 driver was written by
 157 .An Paul Kranenburg
 158 .Aq pk@NetBSD.org .