Add nv(4) man page.
[dragonfly.git] / share / man / man4 / nv.4
1 .\"
2 .\" Copyright (c) 2003 Quinton Dolan
3 .\"
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\" $Id: nvnet.4,v 1.1 2003/10/09 16:48:01 q Exp $
28 .\" $DragonFly: src/share/man/man4/Attic/nv.4,v 1.1 2005/04/05 17:39:22 joerg Exp $
29 .\"
30 .Dd October 5, 2003
31 .Dt NV 4
32 .Os
33 .Sh NAME
34 .Nm nv
35 .Nd NVIDIA nForce MCP network adapter device driver
36 .Sh SYNOPSIS
37 .Cd "kldload if_nv.ko"
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver provides support for the NVIDIA nForce MCP and nForce2 MCP2 networking 
42 adapter that is embedded in the southbridge of most nForce and nForce2 
43 motherboards. This driver is a reimplementation of the NVIDIA supported Linux 
44 nvnet driver, and uses the same closed source API library to access the 
45 underlying hardware. There is currently no programming documentation available 
46 for this device, and therefore little is known about the internal architecture
47 of the MAC engine itself. 
48 .Pp
49 The
50 .Nm
51 driver supports the following media types:
52 .Pp
53 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
54 .It autoselect
55 Enable autoselection of the media type and options
56 .It 10baseT/UTP
57 Set 10Mbps operation
58 .It 100baseTX
59 Set 100Mbps (fast ethernet) operation
60 .El
61 .Pp
62 The
63 .Nm
64 driver supports the following media options:
65 .Pp
66 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
67 .It full-duplex
68 Set full duplex operation
69 .El
70 .Pp
71 Note that the nForce3 MCP3 may also work when run in 32/64bit compatibility
72 mode but as yet has not been tested. For further information on configuring this device, see
73 .Xr ifconfig 8 .
74 .Pp
75 .El
76 .Sh DIAGNOSTICS
77 .Bl -diag
78 .It "nv%d: couldn't map memory"
79 A fatal initialization error has occurred.
80 .It "nv%d: couldn't map interrupt"
81 A fatal initialization error has occurred.
82 .It "nv%d: failed to allocate memory"
83 There are not enough mbuf's available for allocation.
84 .It "nv%d: device timeout"
85 The device has stopped responding to the network, or there is a problem with
86 the network connection (cable).
87 .El
88 .Sh SEE ALSO
89 .Xr arp 4 ,
90 .Xr miibus 4 ,
91 .Xr netintro 4 ,
92 .Xr ng_ether 4 ,
93 .Xr ifconfig 8
94 .Sh AUTHORS
95 .An -nosplit
96 The
97 .Nm
98 device driver was written by
99 .An Quinton Dolan <q@onthenet.com.au> .