share/man/man4/dge.4

   1 .\"     $NetBSD: dge.4,v 1.7 2004/10/04 19:06:46 rumble Exp $
   2 .\"
   3 .\" Copyright (c) 2004, SUNET, Swedish University Computer Network.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Written by Anders Magnusson for SUNET, Swedish University Computer Network.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"      This product includes software developed for the NetBSD Project by
  19 .\"      SUNET, Swedish University Computer Network.
  20 .\" 4. The name of SUNET may not be used to endorse or promote products
  21 .\"    derived from this software without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY SUNET ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  25 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  26 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  27 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33 .\" POSSIBILITY OF SUCH DAMAGE.
  34 .\"
  35 .Dd March 18, 2004
  36 .Dt DGE 4
  37 .Os
  38 .Sh NAME
  39 .Nm dge
  40 .Nd Intel i82597EX Ten Gigabit Ethernet driver
  41 .Sh SYNOPSIS
  42 .Cd "dge* at pci? dev ? function ?"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 device driver supports the Intel i82597EX PRO/10GbE LR Ethernet
  47 adapter,
  48 which uses a single mode fiber (1310nm) interface.
  49 .Pp
  50 The i82597EX supports IPv4/TCP/UDP checksumming in hardware, as well
  51 as TCP Segmentation Offloading (TSO).
  52 The driver does currently only support the hardware checksumming
  53 features.
  54 See
  55 .Xr ifconfig 8
  56 for information on how to enable the hardware checksum calculations.
  57 .Pp
  58 The driver also makes use of the
  59 .Xr ifconfig 8
  60 link flags
  61 .Ar link0
  62 and
  63 .Ar link1
  64 to set the PCIX burst size.
  65 The burst size is set according to
  66 this table:
  67 .Pp
  68 .Bl -column "link0" "link1" "burst size"
  69 .It Em "link0   link1   burst size"
  70 .It Li off Ta off Ta 512
  71 .It Li on Ta off Ta 1024
  72 .It Li off Ta on Ta 2048
  73 .It Li on Ta on Ta 4096
  74 .El
  75 .Pp
  76 A larger burst size will increase the transmit capacity of the card
  77 dramatically but may have negative effect on other devices in
  78 the system.
  79 .Sh DIAGNOSTICS
  80 .Bl -diag
  81 .It dge%d: Tx packet consumes too many DMA segments, dropping...
  82 The packet consisted of too many small mbufs and could therefore
  83 not be loaded into a DMA map.
  84 This is most unlikely, the driver can currently handle up to 100
  85 segments, but over 80 segments has been seen using large (16k)
  86 jumbo frames.
  87 .Pp
  88 .It dge%s: device timeout (txfree %d txsfree %d txnext %d)
  89 The i82597EX had been given packets to send, but didn't interrupt
  90 within 5 seconds.
  91 This diagnostic is most likely the result of a hardware failure,
  92 and the chip will be reset to resume normal operation.
  93 .Pp
  94 .It dge%d: Receive overrun
  95 If the computer is under heavy load, the software may not be able to
  96 keep up removing received datagrams from the receive queue, and
  97 will therefore loose datagrams.
  98 To avoid this, check that the other end is using the XON/XOFF
  99 protocol, if possible, or increase the receive descriptor ring size
 100 in the driver.
 101 .Pp
 102 .It dge%d: symbol error
 103 .It dge%d: parity error
 104 An error in the XGMII communication was detected.
 105 This is a hardware error in the MAC\*[Lt]-\*[Gt]PHY communication bus.
 106 .Pp
 107 .It dge%d: CRC error
 108 A CRC error in the received datagram was detected.
 109 The error is probably caused in the fiber communication.
 110 .Pp
 111 .It dge%d: WARNING: reset failed to complete
 112 This is a fatal error and means that the hardware is broken and
 113 will most likely not function correctly.
 114 .Pp
 115 .It "dge%d: unable to allocate or map rx buffer %d error = %d"
 116 The driver was not able to map a mbuf cluster page to a receive
 117 descriptor entry in the receive ring.
 118 Most likely the system has run out of mbuf clusters or have a too
 119 small cluster map.
 120 See the errno for more information.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr arp 4 ,
 124 .Xr ifmedia 4 ,
 125 .Xr netintro 4 ,
 126 .Xr pci 4 ,
 127 .Xr ifconfig 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 driver first appeared in
 132 .Nx 2.0 .
 133 .Sh AUTHORS
 134 The
 135 .Nm
 136 driver was written by
 137 .An Anders Magnusson Aq ragge@ludd.luth.se .
 138 .Sh BUGS
 139 There should be an XGMII framework for the driver to use.