No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / xge.4
blob2015bba4578fb2068effd8724bacbf2ce400a26d
1 .\"     $NetBSD: xge.4,v 1.2 2005/09/10 22:48:09 wiz Exp $
2 .\"
3 .\" Copyright (c) 2005, 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 SUNET
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 September 9, 2005
36 .Dt XGE 4
37 .Os
38 .Sh NAME
39 .Nm xge
40 .Nd Neterion Xframe-I Ten Gigabit Ethernet driver
41 .Sh SYNOPSIS
42 .Cd "xge* at pci? dev ? function ?"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 device driver supports the Neterion Xframe-I LR Ethernet adapter,
47 which uses a single mode fiber (1310nm) interface.
48 .Pp
49 The Xframe supports IPv4/TCP/UDP checksumming in hardware, as well
50 as TCP Segmentation Offloading (TSO) and hardware VLAN handling.
51 The driver currently does not support the hardware VLAN feature.
52 See
53 .Xr ifconfig 8
54 for information on how to enable TSO and hardware checksum calculation.
55 .Sh DIAGNOSTICS
56 .Bl -diag
57 .It xge%s: failed configuring endian, %llx != %llx!
58 The Xframe could not be turned into the correct endian operation.
59 This is most likely a hardware error.
60 .Pp
61 .It xge%d: failed allocating txmem.
62 .It xge%d: failed allocating rxmem.
63 The computer has run out of kernel memory.
64 .Pp
65 .It xge%d: adapter not quiescent, aborting
66 .It xge%d: ADAPTER_STATUS missing bits %s
67 The Xframe could not be turned into a usable state.
68 Most likely an Xframe hardware error.
69 .Pp
70 .It xge%d: cannot create TX DMA maps
71 .It xge%d: cannot create RX DMA maps
72 This error is either a kernel error or that the kernel has run out
73 of available memory.
74 .Pp
75 .It xge%d: bad compiler struct alignment, %d != %d
76 The compiler did not align the structure correctly.
77 This is a compiler problem.
78 .El
79 .Sh SEE ALSO
80 .Xr arp 4 ,
81 .Xr ifmedia 4 ,
82 .Xr netintro 4 ,
83 .Xr pci 4 ,
84 .Xr ifconfig 8
85 .Sh HISTORY
86 The
87 .Nm
88 driver first appeared in
89 .Nx 3.0 .
90 .Sh AUTHORS
91 The
92 .Nm
93 driver was written by
94 .An Anders Magnusson Aq ragge@ludd.luth.se .
95 .Sh BUGS
96 There should be an XGMII framework for the driver to use.