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 February 12, 2020
  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 DEPRECATION NOTICE
  54 The
  55 .Nm
  56 driver is not present in
  57 .Fx 13.0
  58 and later.
  59 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  60 information.
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver supports Sun Microelectronics STP2002-STQ
  65 .Dq Happy Meal Ethernet
  66 Fast Ethernet interfaces.
  67 .Pp
  68 All controllers supported by the
  69 .Nm
  70 driver have TCP checksum offload capability for both receive and transmit,
  71 support for the reception and transmission of extended frames for
  72 .Xr vlan 4
  73 and a 128-bit multicast hash filter.
  74 .Sh HARDWARE
  75 The
  76 .Nm
  77 driver supports the on-board Ethernet interfaces of many
  78 Sun
  79 .Tn UltraSPARC
  80 workstation and server models.
  81 .Pp
  82 Cards supported by the
  83 .Nm
  84 driver include:
  85 .Pp
  86 .Bl -bullet -compact
  87 .It
  88 Sun PCI SunSwift Adapter
  89 .Pq Dq SUNW,hme
  90 .It
  91 Sun SBus SunSwift Adapter
  92 .Dq ( hme
  93 and
  94 .Dq SUNW,hme )
  95 .It
  96 Sun PCI Sun100BaseT Adapter 2.0
  97 .Pq Dq SUNW,hme
  98 .It
  99 Sun SBus Sun100BaseT 2.0
 100 .Pq Dq SUNW,hme
 101 .It
 102 Sun PCI Quad FastEthernet Controller
 103 .Pq Dq SUNW,qfe
 104 .It
 105 Sun SBus Quad FastEthernet Controller
 106 .Pq Dq SUNW,qfe
 107 .El
 108 .Sh SEE ALSO
 109 .Xr altq 4 ,
 110 .Xr intro 4 ,
 111 .Xr miibus 4 ,
 112 .Xr netintro 4 ,
 113 .Xr vlan 4 ,
 114 .Xr eeprom 8 ,
 115 .Xr ifconfig 8
 116 .Rs
 117 .%T "STP2002QFP Fast Ethernet, Parallel Port, SCSI (FEPS) User's Guide"
 118 .%D April 1996
 119 .%A Sun Microelectronics
 120 .%U http://mediacast.sun.com/users/Barton808/media/STP2002QFP-FEPs_UG.pdf
 121 .Re
 122 .Sh HISTORY
 123 The
 124 .Nm
 125 driver first appeared in
 126 .Nx 1.5 .
 127 The first
 128 .Fx
 129 version to include it was
 130 .Fx 5.0 .
 131 .Sh AUTHORS
 132 The
 133 .Nm
 134 driver was written by
 135 .An Paul Kranenburg Aq Mt pk@NetBSD.org .