Sync with FreeBSD's rev. 1.7.
[dragonfly.git] / share / man / man4 / nv.4
1 .\" Copyright (c) 2003 Quinton Dolan
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $Id: nvnet.4,v 1.1 2003/10/09 16:48:01 q Exp $
26 .\"
27 .\" $FreeBSD: src/share/man/man4/nve.4,v 1.7 2005/11/24 09:25:09 joel Exp $
28 .\" $DragonFly: src/share/man/man4/Attic/nv.4,v 1.5 2006/04/17 20:13:57 swildner Exp $
29 .\"
30 .Dd August 9, 2005
31 .Dt NV 4
32 .Os
33 .Sh NAME
34 .Nm nv
35 .Nd "NVIDIA nForce MCP Networking Adapter device driver"
36 .Sh SYNOPSIS
37 To compile this driver into the kernel,
38 place the following lines in your
39 kernel configuration file:
40 .Bd -ragged -offset indent
41 .Cd "device miibus"
42 .Cd "device nv"
43 .Ed
44 .Pp
45 Alternatively, to load the driver as a
46 module at boot time, place the following line in
47 .Xr loader.conf 5 :
48 .Bd -literal -offset indent
49 if_nv_load="YES"
50 .Ed
51 .Sh DESCRIPTION
52 The
53 .Nm
54 driver provides support for the NVIDIA nForce MCP and nForce2 MCP2
55 networking adapter that is embedded in the southbridge of most
56 nForce and nForce2 motherboards.
57 .Pp
58 This driver is a reimplementation of the NVIDIA supported Linux
59 .Nm nvnet
60 driver and uses the same closed source API library to access
61 the underlying hardware.
62 There is currently no programming documentation available for this
63 device, and therefore little is known about the internal architecture
64 of the MAC engine itself.
65 .Pp
66 The
67 .Nm
68 driver supports the following media types:
69 .Bl -tag -width ".Cm 10baseT/UTP"
70 .It Cm autoselect
71 Enable autoselection of the media type and options.
72 .It Cm 10baseT/UTP
73 Set 10Mbps operation.
74 .It Cm 100baseTX
75 Set 100Mbps (Fast Ethernet) operation.
76 .El
77 .Pp
78 The
79 .Nm
80 driver supports the following media options:
81 .Bl -tag -width ".Cm 10baseT/UTP"
82 .It Cm full-duplex
83 Set full duplex operation.
84 .El
85 .Pp
86 For more information on configuring this device, see
87 .Xr ifconfig 8 .
88 .Sh HARDWARE
89 The
90 .Nm
91 driver supports the NVIDIA MCP onboard adapters of mainboards with
92 the following chipsets:
93 .Pp
94 .Bl -bullet -compact
95 .It
96 nForce
97 .It
98 nForce2
99 .It
100 nForce3
101 .It
102 nForce4
103 .El
104 .Sh DIAGNOSTICS
105 .Bl -diag
106 .It "nv%d: couldn't map memory"
107 A fatal initialization error has occurred.
108 .It "nv%d: couldn't map interrupt"
109 A fatal initialization error has occurred.
110 .It "nv%d: failed to allocate memory"
111 There are not enough mbufs available for allocation.
112 .It "nv%d: device timeout"
113 The device has stopped responding to the network, or there is a problem with
114 the network connection (cable).
115 .El
116 .Sh SEE ALSO
117 .Xr arp 4 ,
118 .Xr miibus 4 ,
119 .Xr netintro 4 ,
120 .Xr ng_ether 4 ,
121 .Xr ifconfig 8
122 .Sh HISTORY
123 The
124 .Nm
125 driver first appeared in
126 .Fx 6.0 .
127 It was imported into
128 .Dx 1.1 .
129 .Sh AUTHORS
130 .An -nosplit
131 The
132 .Nm
133 driver was written by
134 .An Quinton Dolan Aq q@onthenet.com.au
135 and
136 .An "David E. O'Brien" Aq obrien@FreeBSD.org .