share/man/man4/stge.4

   1 .\"     $NetBSD: stge.4,v 1.7 2003/02/14 15:20:20 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 Jason R. Thorpe.
   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 November 23, 2010
  40 .Dt STGE 4
  41 .Os
  42 .Sh NAME
  43 .Nm stge
  44 .Nd Sundance/Tamarack TC9021 Gigabit Ethernet adapter 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 stge"
  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_stge_load="YES"
  59 .Ed
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 device driver provides support for various NICs based on the
  64 Sundance/Tamarack TC9021 Gigabit Ethernet controller chip.
  65 .Pp
  66 The Sundance/Tamarack TC9021 is found on the D-Link DGE-550T
  67 and the Antares Microsystems Gigabit Ethernet board.
  68 It uses an external PHY or an external 10-bit interface.
  69 .Pp
  70 All NICs supported by the
  71 .Nm
  72 driver have TCP/UDP/IP checksum offload for both receive and
  73 transmit, hardware VLAN tag stripping/insertion features, and
  74 receive interrupt moderation mechanism as well as a 64-bit
  75 multicast hash filter.
  76 The Sundance/Tamarack TC9021 supports TBI (ten bit interface)
  77 and GMII transceivers, which means it can be used with either
  78 copper or 1000baseX fiber applications.
  79 .Pp
  80 The Sundance/Tamarack TC9021 also supports jumbo frames, which can be
  81 configured via the interface MTU setting.
  82 Selecting an MTU larger than 1500 bytes with the
  83 .Xr ifconfig 8
  84 utility configures the adapter to receive and transmit jumbo frames.
  85 .Pp
  86 The
  87 .Nm
  88 driver supports the following media types:
  89 .Bl -tag -width ".Cm 10baseT/UTP"
  90 .It Cm autoselect
  91 Enable autoselection of the media type and options.
  92 The user can manually override
  93 the autoselected mode by adding media options to
  94 .Xr rc.conf 5 .
  95 .It Cm 10baseT/UTP
  96 Set 10Mbps operation.
  97 The
  98 .Xr ifconfig 8
  99 .Cm mediaopt
 100 option can also be used to select either
 101 .Cm full-duplex
 102 or
 103 .Cm half-duplex
 104 modes.
 105 .It Cm 100baseTX
 106 Set 100Mbps (Fast Ethernet) operation.
 107 The
 108 .Xr ifconfig 8
 109 .Cm mediaopt
 110 option can also be used to select either
 111 .Cm full-duplex
 112 or
 113 .Cm half-duplex
 114 modes.
 115 .It Cm 1000baseTX
 116 Set 1000baseTX operation over twisted pair.
 117 The Sundance/Tamarack supports 1000Mbps in
 118 .Cm autoselect
 119 mode only.
 120 .\" .It Cm 1000baseSX
 121 .\" Set 1000Mbps (Gigabit Ethernet) operation.
 122 .\" Both
 123 .\" .Cm full-duplex
 124 .\" and
 125 .\" .Cm half-duplex
 126 .\" modes are supported.
 127 .El
 128 .Pp
 129 The
 130 .Nm
 131 driver supports the following media options:
 132 .Bl -tag -width ".Cm full-duplex"
 133 .It Cm full-duplex
 134 Force full duplex operation.
 135 .It Cm half-duplex
 136 Force half duplex operation.
 137 .El
 138 .Pp
 139 For more information on configuring this device, see
 140 .Xr ifconfig 8 .
 141 .Sh HARDWARE
 142 The
 143 .Nm
 144 driver provides support for various NICs based on the Sundance/Tamarack
 145 TC9021 based Gigabit Ethernet controller chips, including:
 146 .Pp
 147 .Bl -bullet -compact
 148 .It
 149 Antares Microsystems Gigabit Ethernet
 150 .It
 151 ASUS NX1101 Gigabit Ethernet
 152 .It
 153 D-Link DL-4000 Gigabit Ethernet
 154 .It
 155 IC Plus IP1000A Gigabit Ethernet
 156 .It
 157 Sundance ST-2021 Gigabit Ethernet
 158 .It
 159 Sundance ST-2023 Gigabit Ethernet
 160 .It
 161 Sundance TC9021 Gigabit Ethernet
 162 .It
 163 Tamarack TC9021 Gigabit Ethernet
 164 .El
 165 .Sh SYSCTL VARIABLES
 166 The following variables are available as both
 167 .Xr sysctl 8
 168 variables and
 169 .Xr loader 8
 170 tunables:
 171 .Bl -tag -width indent
 172 .It Va dev.stge.%d.rxint_nframe
 173 Number of frames between RxDMAComplete interrupts.
 174 The accepted range is 1 to 255, default value is 8 frames.
 175 The interface has to be brought down and up again before a change takes effect.
 176 .It Va dev.stge.%d.rxint_dmawait
 177 Maximum amount of time to wait in 1us increments before issuing
 178 an Rx interrupt if the number of frames received is less than
 179 .Va rxint_nframe .
 180 The accepted range is 0 to 4194, default value is 30 microseconds.
 181 The interface has to be brought down and up again before a change takes effect.
 182 .El
 183 .Sh SEE ALSO
 184 .Xr altq 4 ,
 185 .Xr arp 4 ,
 186 .Xr miibus 4 ,
 187 .Xr netintro 4 ,
 188 .Xr ng_ether 4 ,
 189 .Xr polling 4 ,
 190 .Xr vlan 4 ,
 191 .Xr ifconfig 8
 192 .Sh HISTORY
 193 The
 194 .Nm
 195 driver was ported from
 196 .Nx
 197 and first appeared in
 198 .Fx 6.2 .
 199 The
 200 .Nx
 201 version was written by
 202 .An Jason R. Thorpe
 203 .Aq thorpej@NetBSD.org .
 204 .Sh AUTHORS
 205 The
 206 .Nm
 207 driver was ported by
 208 .An Pyun YongHyeon
 209 .Aq yongari@FreeBSD.org .