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