summaryrefslogtreecommitdiffstats
path: root/share/man/man4/em.4
diff options
context:
space:
mode:
authorpdeuskar <pdeuskar@FreeBSD.org>2002-02-13 18:19:27 +0000
committerpdeuskar <pdeuskar@FreeBSD.org>2002-02-13 18:19:27 +0000
commit59699901cf6676124969480fe58eb1a8b64b7708 (patch)
tree459e47e9920416c2371f77bf0d6073cfb8870ac0 /share/man/man4/em.4
parentc34beebab28585cc95b625d661cf798297547504 (diff)
downloadFreeBSD-src-59699901cf6676124969480fe58eb1a8b64b7708.zip
FreeBSD-src-59699901cf6676124969480fe58eb1a8b64b7708.tar.gz
- Added support for receive in multiple
descriptors. This simplifies code for jumbo frames. - Cleaned up coding conventions to make code more unix-like. - Cleaned up code in if_em_fxhw.c and if_em_phy.c. Added relevant comments. MFC after: 1 week
Diffstat (limited to 'share/man/man4/em.4')
-rw-r--r--share/man/man4/em.4150
1 files changed, 71 insertions, 79 deletions
diff --git a/share/man/man4/em.4 b/share/man/man4/em.4
index 7587252..4552de0 100644
--- a/share/man/man4/em.4
+++ b/share/man/man4/em.4
@@ -1,107 +1,105 @@
.\" Copyright (c) 2001 Intel Corporation
.\" All rights reserved.
-.\" Redistribution and use in source and binary forms of the Software, with or without
-.\" modification, are permitted provided that the following conditions
+.\" Redistribution and use in source and binary forms of the Software, with or without
+.\" modification, are permitted provided that the following conditions
.\" are met:
-.\" 1. Redistributions of source code of the Software may retain the above
+.\" 1. Redistributions of source code of the Software may retain the above
.\" copyright notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form of the Software may reproduce the
-.\" above copyright notice, this list of conditions and the following
-.\" disclaimer in the documentation and/or other materials provided with the
+.\" 2. Redistributions in binary form of the Software may reproduce the
+.\" above copyright notice, this list of conditions and the following
+.\" disclaimer in the documentation and/or other materials provided with the
.\" distribution.
-.\" 3. Neither the name of the Intel Corporation nor the names of its contributors
-.\" shall be used to endorse or promote products derived from this Software
+.\" 3. Neither the name of the Intel Corporation nor the names of its contributors
+.\" shall be used to endorse or promote products derived from this Software
.\" without specific prior written permission.
.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR ITS CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR ITS CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
.\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
-.\"
-.Dd December 8, 2001
+.Dd December, 2001
.Dt EM 4
-.Os
+.Os FreeBSD
.Sh NAME
.Nm em
-.Nd Intel(R) PRO/1000 gigabit ethernet driver for the FreeBSD operating system
+.Nd
+Intel(R) PRO/1000 gigabit Ethernet driver for the FreeBSD operating system
.Sh SYNOPSIS
.Cd "device em"
.Sh DESCRIPTION
The
.Nm
-driver provides support for PCI gigabit ethernet adapters based on
-the Intel 82542, 82543 and 82544 ethernet controller chip.
+driver provides support for PCI gigabit Ethernet adapters based on
+the Intel 82542, 82543 and 82544 Ethernet controller chip.
The driver supports Transmit/Receive checksum offload
-and jumbo frames only on 82543 and 82544-based adapters.
-For a list of supported adapters, see the
-.Pa README
+and Jumbo Frames only on 82543 and 82544-based adapters.
+For a list of supported adapters, see the README
included with the driver.
.Pp
-For questions related to hardware requirements,
-refer to the documentation supplied with your Intel PRO/1000 adapter.
-All hardware requirements listed apply to use with
-.Fx .
+For questions related to hardware requirements,
+refer to the documentation supplied with your Intel PRO/1000 adapter.
+All hardware requirements listed apply to use with FreeBSD.
.Pp
-Support for jumbo frames is provided via the interface MTU setting.
+Support for Jumbo Frames is provided via the interface MTU setting.
Selecting an MTU larger than 1500 bytes with the
.Xr ifconfig 8
-utility configures the adapter to receive and transmit jumbo frames.
-The maximum MTU size for jumbo frames is 9000.
+utility configures the adapter to receive and transmit Jumbo Frames.
+The maximum MTU size for Jumbo Frames is 16114.
.Pp
The
.Nm
driver supports the following media types:
-.Bl -tag -width ".Cm 10baseT/UTP"
-.It Cm autoselect
+.Pp
+.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
+.It autoselect
Enables auto-negotiation for speed and duplex.
-.It Cm 10baseT/UTP
+.It 10baseT/UTP
Sets 10Mbps operation.
-The
-.Cm mediaopt
-option can also be used to select either
-.Cm full-duplex
-or
-.Cm half-duplex
-modes.
-.It Cm 100baseTX
+Use the
+.Ar mediaopt
+option to select
+.Ar full-duplex
+mode.
+.It 100baseTX
Sets 100Mbps operation.
-The
-.Cm mediaopt
-option can also be used to select either
-.Cm full-duplex
-or
-.Cm half-duplex
-modes.
-.It Cm 1000baseSX
+Use the
+.Ar mediaopt
+option to select
+.Ar full-duplex
+mode.
+.It 1000baseSX
Sets 1000Mbps operation.
-Only
-.Cm full-duplex
+Only
+.Ar full-duplex
mode is supported at this speed.
-.It Cm 1000baseTX
+.It 1000baseTX
Sets 1000Mbps operation.
-Only
-.Cm full-duplex
+Only
+.Ar full-duplex
mode is supported at this speed.
.El
.Pp
The
.Nm
driver supports the following media options:
-.Bl -tag -width ".Cm full-duplex"
-.It Cm full-duplex
-Forces full duplex operation
-.It Cm half-duplex
-Forces half duplex operation.
+.Pp
+.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
+.It full-duplex
+Forces full-duplex operation
+.It half-duplex
+Forces half-duplex operation.
.El
.Pp
+Only use mediaopt to set the driver to full-duplex. If mediaopt is not specified, the driver defaults to half-duplex.
+.Pp
For more information on configuring this device, see
.Xr ifconfig 8 .
.Sh DIAGNOSTICS
@@ -110,37 +108,31 @@ For more information on configuring this device, see
A fatal initialization error has occurred.
.It "em%d: Unable to allocate bus resource: interrupt"
A fatal initialization error has occurred.
-.It "em%d: No memory for jumbo buffers!"
-The driver failed to allocate memory for jumbo frames during
-initialization.
.It "em%d: watchdog timeout -- resetting"
The device has stopped responding to the network, or there is a problem with
the network connection (cable).
.El
.Sh SUPPORT
-For additional information regarding building and installation,
-see the
-.Pa README
-included with the driver.
-For general information and support,
-go to the Intel support Website at
-.Pa http://support.intel.com .
+For additional information regarding building and installation,
+see the README included with the driver. For general information and support,
+go to the Intel support website at:
+.Ar http://support.intel.com.
.Pp
-If an issue is identified with the released source code on the supported kernel
-with a supported adapter, email the specific information related to the
-issue to
-.Aq freebsdnic@mailbox.intel.com .
+If an issue is identified with the released source code on the supported kernel
+with a supported adapter, email the specific information related to the
+issue to freebsdnic@mailbox.intel.com.
+.El
.Sh SEE ALSO
.Xr arp 4 ,
-.Xr netintro 4 ,
-.Xr ng_ether 4 ,
+.Xr netintro 4 ,
.Xr vlan 4 ,
+.Xr ng_ether 4 ,
.Xr ifconfig 8
.Sh HISTORY
The
.Nm
device driver first appeared in
-.Fx 4.5 .
+.Fx 4.4 .
.Sh AUTHORS
The
.Nm
OpenPOWER on IntegriCloud