[src/trunk]: src/share/man/man4 Add the manual page for the Intel 82599 10-gi...

[dyoung <dyoung%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/4bba161fa322
branches:  trunk
changeset: 768245:4bba161fa322
user:      dyoung <dyoung%NetBSD.org@localhost>
date:      Fri Aug 12 22:00:12 2011 +0000

description:
Add the manual page for the Intel 82599 10-gigabit ethernet driver,
ixg(4).

diffstat:

 share/man/man4/ixg.4 |  133 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 133 insertions(+), 0 deletions(-)

diffs (137 lines):

diff -r 4d3bcb94dd9e -r 4bba161fa322 share/man/man4/ixg.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/ixg.4      Fri Aug 12 22:00:12 2011 +0000
@@ -0,0 +1,133 @@
+.\" Copyright (c) 2001-2008, Intel Corporation
+.\" All rights reserved.
+.\" 
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright notice,
+.\"    this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must 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 may 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 COPYRIGHT OWNER OR 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.
+.\"
+.\" * Other names and brands may be claimed as the property of others.
+.\"
+.\" $NetBSD: ixg.4,v 1.1 2011/08/12 22:00:12 dyoung Exp $
+.\" $FreeBSD: src/share/man/man4/ixgbe.4,v 1.3 2010/12/19 23:54:31 yongari Exp $
+.\"
+.Dd July 25, 2011
+.Dt IXG 4
+.Os
+.Sh NAME
+.Nm ixg
+.Nd "Intel(R) 10Gb Ethernet driver"
+.Sh SYNOPSIS
+.Cd "ixg* at pci? dev ? function ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for PCI 10Gb Ethernet adapters based on
+the Intel(R) 82598EB and 82599 10 GbE Controllers.
+The driver supports Jumbo Frames, TCP Segmentation Offload (TSO).
+.Pp
+For questions related to hardware requirements,
+refer to the documentation supplied with your Intel 10GbE adapter.
+All hardware requirements listed apply to use with
+.Nx .
+.Pp
+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.
+On .Nx ,
+the maximum MTU size for Jumbo Frames is 9000 bytes.
+.Pp
+This driver version supports VLANs.
+For information on enabling VLANs, see
+.Xr ifconfig 8 .
+.Sh HARDWARE
+The
+.Nm
+driver supports the following cards:
+.Pp
+.Bl -bullet -compact
+.It
+Intel(R) 10 Gigabit XF SR/AF Dual Port Server Adapter 
+.It
+Intel(R) 10 Gigabit XF SR/LR Server Adapter
+.It
+Intel(R) 82598EB 10 Gigabit AF Network Connection
+.It
+Intel(R) 82598EB 10 Gigabit AT CX4 Network Connection                  
+.El
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "ixg%d: Unable to allocate bus resource: memory"
+A fatal initialization error has occurred.
+.It "ixg%d: Unable to allocate bus resource: interrupt"
+A fatal initialization error has occurred.
+.It "ixg%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 general information and support,
+go to the Intel support website at:
+.Pa 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@localhost .
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr netintro 4 ,
+.Xr vlan 4 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver comes from
+.Fx ,
+where it is called
+.Xr ixgbe 4 .
+It first appeared in
+.Nx 6.0 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Intel Corporation Aq freebsdnic%mailbox.intel.com@localhost .
+It was imported from
+.Fx
+into
+.Nx
+by
+.An David Young Aq dyoung%NetBSD.org@localhost .
+.Sh BUGS
+The hardware supports a maximum MTU of 16114 bytes, but the
+.Nx
+port of the driver supports only 9000 bytes.
+.Pp
+The hardware supports Message-Signalled Interrupts (MSI and MSI-X)
+and Receive-Side Scaling (RSS), however, these features are not
+enabled in the
+.Nx
+driver at this time.