share/man/man4/nve.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$
  28 .\"
  29 .Dd August 9, 2005
  30 .Dt NVE 4
  31 .Os
  32 .Sh NAME
  33 .Nm nve
  34 .Nd "NVIDIA nForce MCP Networking Adapter device driver"
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device miibus"
  41 .Cd "device nve"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 if_nve_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for the NVIDIA nForce MCP and nForce2 MCP2
  54 networking adapter that is embedded in the southbridge of most
  55 nForce and nForce2 motherboards.
  56 .Pp
  57 This driver is a reimplementation of the NVIDIA supported Linux
  58 .Nm nvnet
  59 driver and uses the same closed source API library to access
  60 the underlying hardware.
  61 There is currently no programming documentation available for this
  62 device, and therefore little is known about the internal architecture
  63 of the MAC engine itself.
  64 .Pp
  65 The
  66 .Nm
  67 driver supports the following media types:
  68 .Bl -tag -width ".Cm 10baseT/UTP"
  69 .It Cm autoselect
  70 Enable autoselection of the media type and options.
  71 .It Cm 10baseT/UTP
  72 Set 10Mbps operation.
  73 .It Cm 100baseTX
  74 Set 100Mbps (Fast Ethernet) operation.
  75 .El
  76 .Pp
  77 The
  78 .Nm
  79 driver supports the following media options:
  80 .Bl -tag -width ".Cm 10baseT/UTP"
  81 .It Cm full-duplex
  82 Set full duplex operation.
  83 .El
  84 .Pp
  85 For more information on configuring this device, see
  86 .Xr ifconfig 8 .
  87 .Sh HARDWARE
  88 The
  89 .Nm
  90 driver supports the NVIDIA MCP onboard adapters of mainboards with
  91 the following chipsets:
  92 .Pp
  93 .Bl -bullet -compact
  94 .It
  95 nForce
  96 .It
  97 nForce2
  98 .It
  99 nForce3
 100 .It
 101 nForce4
 102 .El
 103 .Sh DIAGNOSTICS
 104 .Bl -diag
 105 .It "nve%d: couldn't map memory"
 106 A fatal initialization error has occurred.
 107 .It "nve%d: couldn't map interrupt"
 108 A fatal initialization error has occurred.
 109 .It "nve%d: failed to allocate memory"
 110 There are not enough mbufs available for allocation.
 111 .It "nve%d: device timeout"
 112 The device has stopped responding to the network, or there is a problem with
 113 the network connection (cable).
 114 .El
 115 .Sh SEE ALSO
 116 .Xr altq 4 ,
 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 .Sh AUTHORS
 128 .An -nosplit
 129 The
 130 .Nm
 131 driver was written by
 132 .An Quinton Dolan Aq q@onthenet.com.au
 133 and
 134 .An "David E. O'Brien" Aq obrien@FreeBSD.org .