share/man/man4/nfe.4

   1 .\"     $OpenBSD: nfe.4,v 1.7 2006/02/28 08:13:47 jsg Exp $
   2 .\"
   3 .\" Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" $FreeBSD$
  18 .\"
  19 .Dd January 15, 2011
  20 .Dt NFE 4
  21 .Os
  22 .Sh NAME
  23 .Nm nfe
  24 .Nd "NVIDIA nForce MCP Ethernet driver"
  25 .Sh SYNOPSIS
  26 To compile this driver into the kernel,
  27 place the following lines in your
  28 kernel configuration file:
  29 .Bd -ragged -offset indent
  30 .Cd "device miibus"
  31 .Cd "device nfe"
  32 .Ed
  33 .Pp
  34 Alternatively, to load the driver as a
  35 module at boot time, place the following line in
  36 .Xr loader.conf 5 :
  37 .Bd -literal -offset indent
  38 if_nfe_load="YES"
  39 .Ed
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver supports PCI Ethernet adapters based on the NVIDIA
  44 nForce Media and Communications Processors (MCP), such as
  45 the nForce, nForce 2, nForce 3, CK804, MCP04, MCP51, MCP55,
  46 MCP61, MCP65, MCP67, MCP73, MCP77 and MCP79 Ethernet
  47 controller chips.
  48 .Pp
  49 Supported features include (hardware support provided):
  50 .Pp
  51 .Bl -bullet -compact
  52 .It
  53 Receive/Transmit IP/TCP/UDP checksum offload
  54 .It
  55 Hardware VLAN tag insertion/stripping
  56 .It
  57 TCP segmentation offload (TSO)
  58 .It
  59 MSI/MSI-X
  60 .It
  61 Jumbo Frames
  62 .El
  63 .Pp
  64 Support for Jumbo Frames is provided via the interface MTU setting.
  65 Selecting an MTU larger than 1500 bytes with the
  66 .Xr ifconfig 8
  67 utility configures the adapter to receive and transmit Jumbo Frames.
  68 .Pp
  69 The
  70 .Nm
  71 driver supports the following media types:
  72 .Bl -tag -width "10baseT/UTP"
  73 .It Cm autoselect
  74 Enable autoselection of the media type and options.
  75 .It Cm 10baseT/UTP
  76 Set 10Mbps operation.
  77 .It Cm 100baseTX
  78 Set 100Mbps (Fast Ethernet) operation.
  79 .It Cm 1000baseT
  80 Set 1000Mbps (Gigabit Ethernet) operation (recent models only).
  81 .El
  82 .Pp
  83 The
  84 .Nm
  85 driver supports the following media options:
  86 .Bl -tag -width ".Cm 10baseT/UTP"
  87 .It Cm half-duplex
  88 Force half duplex operation.
  89 .It Cm full-duplex
  90 Force full duplex operation.
  91 .El
  92 .Pp
  93 For more information on configuring this device, see
  94 .Xr ifconfig 8 .
  95 .Sh HARDWARE
  96 The
  97 .Nm
  98 driver supports the following NVIDIA MCP onboard adapters:
  99 .Pp
 100 .Bl -bullet -compact
 101 .It
 102 NVIDIA nForce MCP Networking Adapter
 103 .It
 104 NVIDIA nForce MCP04 Networking Adapter
 105 .It
 106 NVIDIA nForce 430 MCP12 Networking Adapter
 107 .It
 108 NVIDIA nForce 430 MCP13 Networking Adapter
 109 .It
 110 NVIDIA nForce MCP51 Networking Adapter
 111 .It
 112 NVIDIA nForce MCP55 Networking Adapter
 113 .It
 114 NVIDIA nForce MCP61 Networking Adapter
 115 .It
 116 NVIDIA nForce MCP65 Networking Adapter
 117 .It
 118 NVIDIA nForce MCP67 Networking Adapter
 119 .It
 120 NVIDIA nForce MCP73 Networking Adapter
 121 .It
 122 NVIDIA nForce MCP77 Networking Adapter
 123 .It
 124 NVIDIA nForce MCP79 Networking Adapter
 125 .It
 126 NVIDIA nForce2 MCP2 Networking Adapter
 127 .It
 128 NVIDIA nForce2 400 MCP4 Networking Adapter
 129 .It
 130 NVIDIA nForce2 400 MCP5 Networking Adapter
 131 .It
 132 NVIDIA nForce3 MCP3 Networking Adapter
 133 .It
 134 NVIDIA nForce3 250 MCP6 Networking Adapter
 135 .It
 136 NVIDIA nForce3 MCP7 Networking Adapter
 137 .It
 138 NVIDIA nForce4 CK804 MCP8 Networking Adapter
 139 .It
 140 NVIDIA nForce4 CK804 MCP9 Networking Adapter
 141 .El
 142 .Sh LOADER TUNABLES
 143 Tunables can be set at the
 144 .Xr loader 8
 145 prompt before booting the kernel or stored in
 146 .Xr loader.conf 5 .
 147 .Bl -tag -width indent
 148 .It Va hw.nfe.msi_disable
 149 Whether or not MSI support is enabled in the driver.
 150 The default value is 0.
 151 .It Va hw.nfe.msix_disable
 152 Whether or not MSI-X support is enabled in the driver.
 153 The default value is 0.
 154 .El
 155 .Sh SYSCTL VARIABLES
 156 The following
 157 .Xr sysctl 8
 158 variables can be used to modify or monitor
 159 .Nm
 160 behavior.
 161 .Bl -tag -width indent
 162 .It Va dev.nfe.%d.process_limit
 163 Maximum number of Rx events to be processed in the event loop
 164 before rescheduling a taskqueue.
 165 The accepted range is 50 to 255, the default value is 192.
 166 The interface does not need to be brought down and up again
 167 before a change takes effect.
 168 .El
 169 .Sh SEE ALSO
 170 .Xr altq 4 ,
 171 .Xr arp 4 ,
 172 .Xr intro 4 ,
 173 .Xr miibus 4 ,
 174 .Xr netintro 4 ,
 175 .Xr pci 4 ,
 176 .Xr polling 4 ,
 177 .Xr rgephy 4 ,
 178 .Xr sysctl 8 ,
 179 .Xr ifconfig 8
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 device driver first appeared in
 184 .Ox 3.9 ,
 185 and then in
 186 .Fx 7.0 .
 187 .Sh AUTHORS
 188 .An -nosplit
 189 The
 190 .Nm
 191 driver was written by
 192 .An Jonathan Gray
 193 .Aq jsg@openbsd.org
 194 and
 195 .An Damien Bergamini
 196 .Aq damien@openbsd.org .
 197 The
 198 .Nm
 199 driver was ported to
 200 .Fx
 201 by
 202 .An Shigeaki Tagashira
 203 .Aq shigeaki@se.hiroshima-u.ac.jp .