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