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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd June 14, 2009
  33 .Dt HME 4
  34 .Os
  35 .Sh NAME
  36 .Nm hme
  37 .Nd "Sun Microelectronics STP2002-STQ Ethernet interfaces device driver"
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel,
  40 place the following lines in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device miibus"
  44 .Cd "device hme"
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_hme_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver supports Sun Microelectronics STP2002-STQ
  57 .Dq Happy Meal Ethernet
  58 Fast Ethernet interfaces.
  59 .Pp
  60 All controllers supported by the
  61 .Nm
  62 driver have TCP checksum offload capability for both receive and transmit,
  63 support for the reception and transmission of extended frames for
  64 .Xr vlan 4
  65 and a 128-bit multicast hash filter.
  66 .Sh HARDWARE
  67 The
  68 .Nm
  69 driver supports the on-board Ethernet interfaces of many
  70 Sun
  71 .Tn UltraSPARC
  72 workstation and server models.
  73 .Pp
  74 Cards supported by the
  75 .Nm
  76 driver include:
  77 .Pp
  78 .Bl -bullet -compact
  79 .It
  80 Sun PCI SunSwift Adapter
  81 .Pq Dq SUNW,hme
  82 .It
  83 Sun SBus SunSwift Adapter
  84 .Dq ( hme
  85 and
  86 .Dq SUNW,hme )
  87 .It
  88 Sun PCI Sun100BaseT Adapter 2.0
  89 .Pq Dq SUNW,hme
  90 .It
  91 Sun SBus Sun100BaseT 2.0
  92 .Pq Dq SUNW,hme
  93 .It
  94 Sun PCI Quad FastEthernet Controller
  95 .Pq Dq SUNW,qfe
  96 .It
  97 Sun SBus Quad FastEthernet Controller
  98 .Pq Dq SUNW,qfe
  99 .El
 100 .Sh NOTES
 101 On sparc64 the
 102 .Nm
 103 driver respects the
 104 .Va local-mac-address?
 105 system configuration variable which can be set in the Open Firmware boot
 106 monitor using the
 107 .Ic setenv
 108 command or by
 109 .Xr eeprom 8 .
 110 If set to
 111 .Dq Li false
 112 (the default), the
 113 .Nm
 114 driver will use the system's default MAC address for all of its devices.
 115 If set to
 116 .Dq Li true ,
 117 the unique MAC address of each interface is used if present rather than
 118 the system's default MAC address.
 119 .Pp
 120 Supported interfaces having their own MAC address include on-board versions
 121 on boards equipped with more than one Ethernet interface and all add-on cards
 122 except the single-port SBus versions.
 123 .Sh SEE ALSO
 124 .Xr altq 4 ,
 125 .Xr intro 4 ,
 126 .Xr miibus 4 ,
 127 .Xr netintro 4 ,
 128 .Xr vlan 4 ,
 129 .Xr eeprom 8 ,
 130 .Xr ifconfig 8
 131 .Rs
 132 .%T "STP2002QFP Fast Ethernet, Parallel Port, SCSI (FEPS) User's Guide"
 133 .%D April 1996
 134 .%A Sun Microelectronics
 135 .%U http://mediacast.sun.com/users/Barton808/media/STP2002QFP-FEPs_UG.pdf
 136 .Re
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 driver first appeared in
 141 .Nx 1.5 .
 142 The first
 143 .Fx
 144 version to include it was
 145 .Fx 5.0 .
 146 .Sh AUTHORS
 147 The
 148 .Nm
 149 driver was written by
 150 .An Paul Kranenburg
 151 .Aq pk@NetBSD.org .