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 April 16, 2008
  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 and MCP73 Ethernet controller chips.
  47 .Pp
  48 Supported features include (hardware support provided):
  49 .Pp
  50 .Bl -bullet -compact
  51 .It
  52 Receive/Transmit IP/TCP/UDP checksum offload
  53 .It
  54 Hardware VLAN tag insertion/stripping
  55 .It
  56 TCP segmentation offload (TSO)
  57 .It
  58 MSI/MSI-X
  59 .It
  60 Jumbo Frames
  61 .El
  62 .Pp
  63 Support for Jumbo Frames is provided via the interface MTU setting.
  64 Selecting an MTU larger than 1500 bytes with the
  65 .Xr ifconfig 8
  66 utility configures the adapter to receive and transmit Jumbo Frames.
  67 .Pp
  68 The
  69 .Nm
  70 driver supports the following media types:
  71 .Bl -tag -width "10baseT/UTP"
  72 .It Cm autoselect
  73 Enable autoselection of the media type and options.
  74 .It Cm 10baseT/UTP
  75 Set 10Mbps operation.
  76 .It Cm 100baseTX
  77 Set 100Mbps (Fast Ethernet) operation.
  78 .It Cm 1000baseT
  79 Set 1000Mbps (Gigabit Ethernet) operation (recent models only).
  80 .El
  81 .Pp
  82 The
  83 .Nm
  84 driver supports the following media options:
  85 .Bl -tag -width ".Cm 10baseT/UTP"
  86 .It Cm half-duplex
  87 Force half duplex operation.
  88 .It Cm full-duplex
  89 Force full duplex operation.
  90 .El
  91 .Pp
  92 For more information on configuring this device, see
  93 .Xr ifconfig 8 .
  94 .Sh HARDWARE
  95 The
  96 .Nm
  97 driver supports the following NVIDIA MCP onboard adapters:
  98 .Pp
  99 .Bl -bullet -compact
 100 .It
 101 NVIDIA nForce MCP Networking Adapter
 102 .It
 103 NVIDIA nForce MCP04 Networking Adapter
 104 .It
 105 NVIDIA nForce 430 MCP12 Networking Adapter
 106 .It
 107 NVIDIA nForce 430 MCP13 Networking Adapter
 108 .It
 109 NVIDIA nForce MCP51 Networking Adapter
 110 .It
 111 NVIDIA nForce MCP55 Networking Adapter
 112 .It
 113 NVIDIA nForce MCP61 Networking Adapter
 114 .It
 115 NVIDIA nForce MCP65 Networking Adapter
 116 .It
 117 NVIDIA nForce MCP67 Networking Adapter
 118 .It
 119 NVIDIA nForce MCP73 Networking Adapter
 120 .It
 121 NVIDIA nForce2 MCP2 Networking Adapter
 122 .It
 123 NVIDIA nForce2 400 MCP4 Networking Adapter
 124 .It
 125 NVIDIA nForce2 400 MCP5 Networking Adapter
 126 .It
 127 NVIDIA nForce3 MCP3 Networking Adapter
 128 .It
 129 NVIDIA nForce3 250 MCP6 Networking Adapter
 130 .It
 131 NVIDIA nForce3 MCP7 Networking Adapter
 132 .It
 133 NVIDIA nForce4 CK804 MCP8 Networking Adapter
 134 .It
 135 NVIDIA nForce4 CK804 MCP9 Networking Adapter
 136 .El
 137 .Sh LOADER TUNABLES
 138 Tunables can be set at the
 139 .Xr loader 8
 140 prompt before booting the kernel or stored in
 141 .Xr loader.conf 5 .
 142 .Bl -tag -width indent
 143 .It Va hw.nfe.msi_disable
 144 Whether or not MSI support is enabled in the driver.
 145 The default value is 0.
 146 .It Va hw.nfe.msix_disable
 147 Whether or not MSI-X support is enabled in the driver.
 148 The default value is 0.
 149 .El
 150 .Sh SYSCTL VARIABLES
 151 The following
 152 .Xr sysctl 8
 153 variables can be used to modify or monitor
 154 .Nm
 155 behavior.
 156 .Bl -tag -width indent
 157 .It Va dev.nfe.%d.process_limit
 158 Maximum number of Rx events to be processed in the event loop
 159 before rescheduling a taskqueue.
 160 The accepted range is 50 to 255, the default value is 192.
 161 The interface does not need to be brought down and up again
 162 before a change takes effect.
 163 .El
 164 .Sh SEE ALSO
 165 .Xr altq 4 ,
 166 .Xr arp 4 ,
 167 .Xr intro 4 ,
 168 .Xr miibus 4 ,
 169 .Xr netintro 4 ,
 170 .Xr pci 4 ,
 171 .Xr polling 4 ,
 172 .Xr sysctl 8 ,
 173 .Xr ifconfig 8
 174 .Sh HISTORY
 175 The
 176 .Nm
 177 device driver first appeared in
 178 .Ox 3.9 ,
 179 and then in
 180 .Fx 7.0 .
 181 .Sh AUTHORS
 182 .An -nosplit
 183 The
 184 .Nm
 185 driver was written by
 186 .An Jonathan Gray
 187 .Aq jsg@openbsd.org
 188 and
 189 .An Damien Bergamini
 190 .Aq damien@openbsd.org .
 191 The
 192 .Nm
 193 driver was ported to
 194 .Fx
 195 by
 196 .An Shigeaki Tagashira
 197 .Aq shigeaki@se.hiroshima-u.ac.jp .