Use .Xr for manpage references.
[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.8 2007/02/25 12:03:07 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 load the driver as a
38 module at boot time, place the following line in
39 .Xr loader.conf 5 :
40 .Bd -literal -offset indent
41 if_nv_load="YES"
42 .Ed
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for the NVIDIA nForce MCP and nForce2 MCP2
47 networking adapter that is embedded in the southbridge of most
48 nForce and nForce2 motherboards.
49 .Pp
50 This driver is a reimplementation of the NVIDIA supported Linux
51 .Nm nvnet
52 driver and uses the same closed source API library to access
53 the underlying hardware.
54 There is currently no programming documentation available for this
55 device, and therefore little is known about the internal architecture
56 of the MAC engine itself.
57 .Pp
58 The
59 .Nm
60 driver supports the following media types:
61 .Bl -tag -width ".Cm 10baseT/UTP"
62 .It Cm autoselect
63 Enable autoselection of the media type and options.
64 .It Cm 10baseT/UTP
65 Set 10Mbps operation.
66 .It Cm 100baseTX
67 Set 100Mbps (Fast Ethernet) operation.
68 .El
69 .Pp
70 The
71 .Nm
72 driver supports the following media options:
73 .Bl -tag -width ".Cm 10baseT/UTP"
74 .It Cm full-duplex
75 Set full duplex operation.
76 .El
77 .Pp
78 For more information on configuring this device, see
79 .Xr ifconfig 8 .
80 .Sh HARDWARE
81 The
82 .Nm
83 driver supports the NVIDIA MCP onboard adapters of mainboards with
84 the following chipsets:
85 .Pp
86 .Bl -bullet -compact
87 .It
88 nForce
89 .It
90 nForce2
91 .It
92 nForce3
93 .It
94 nForce4
95 .El
96 .Sh DIAGNOSTICS
97 .Bl -diag
98 .It "nv%d: couldn't map memory"
99 A fatal initialization error has occurred.
100 .It "nv%d: couldn't map interrupt"
101 A fatal initialization error has occurred.
102 .It "nv%d: failed to allocate memory"
103 There are not enough mbufs available for allocation.
104 .It "nv%d: device timeout"
105 The device has stopped responding to the network, or there is a problem with
106 the network connection (cable).
107 .El
108 .Sh SEE ALSO
109 .Xr arp 4 ,
110 .Xr ifmedia 4 ,
111 .Xr miibus 4 ,
112 .Xr netintro 4 ,
113 .Xr ng_ether 4 ,
114 .Xr polling 4 ,
115 .Xr ifconfig 8
116 .Sh HISTORY
117 The
118 .Nm
119 driver first appeared in
120 .Fx 6.0 .
121 It was imported into
122 .Dx 1.1 .
123 .Sh AUTHORS
124 .An -nosplit
125 The
126 .Nm
127 driver was written by
128 .An Quinton Dolan Aq q@onthenet.com.au
129 and
130 .An "David E. O'Brien" Aq obrien@FreeBSD.org .