Initial import from FreeBSD RELENG_4:
[dragonfly.git] / share / man / man4 / lge.4
1 .\" Copyright (c) 2001 Wind River Systems
2 .\" Copyright (c) 1997, 1998, 1999, 2000, 2001
3 .\"     Bill Paul <william.paul@windriver.com>. All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgement:
15 .\"     This product includes software developed by Bill Paul.
16 .\" 4. Neither the name of the author nor the names of any co-contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"   without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 .\" THE POSSIBILITY OF SUCH DAMAGE.
31 .\"
32 .\" $FreeBSD: src/share/man/man4/lge.4,v 1.2.2.3 2001/08/17 13:08:38 ru Exp $
33 .\"
34 .Dd May 30, 2001
35 .Dt LGE 4
36 .Os
37 .Sh NAME
38 .Nm lge
39 .Nd "Level 1 LXT1001 NetCellerator PCI gigabit ethernet adapter driver"
40 .Sh SYNOPSIS
41 .Cd "device miibus"
42 .Cd "device lge"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for various NICs based on the Level 1 LXT1001
47 NetCellerator gigabit ethernet controller chip, including the
48 following:
49 .Pp
50 .Bl -bullet -compact
51 .It
52 SMC TigerCard 1000 (SMC9462SX)
53 .It
54 D-Link DGE-500SX
55 .El
56 .Pp
57 These NICs are capable of 1000mbps speeds over fiber optic cable.
58 The LXT1001 also supports a GMII port for use with 10/100/1000 copper
59 PHYs, however there aren't currently any NICs on the market that use
60 this feature.
61 .Pp
62 The LXT1001 supports TCP/IP checksum offload for receive and
63 VLAN-based filtering as well as a 64-bit multicast hash filter.
64 It also supports jumbo frames, which can be configured
65 via the interface MTU setting.
66 Selecting an MTU larger than 1500 bytes with the
67 .Xr ifconfig 8
68 utility configures the adapter to receive and transmit jumbo frames.
69 Using jumbo frames can greatly improve performance for certain tasks,
70 such as file transfers and data streaming.
71 .Pp
72 The
73 .Nm
74 driver supports the following media types:
75 .Bl -tag -width ".Cm 1000baseSX"
76 .It Cm autoselect
77 Enable autoselection of the media type and options.
78 The user can manually override
79 the autoselected mode by adding media options to
80 .Xr rc.conf 5 .
81 .It Cm 1000baseSX
82 Set 1000baseSX operation over fiber optic cable.
83 Both
84 .Cm full-duplex
85 and
86 .Cm half-duplex
87 modes are supported.
88 .El
89 .Pp
90 The
91 .Nm
92 driver supports the following media options:
93 .Bl -tag -width ".Cm full-duplex"
94 .It Cm full-duplex
95 Force full duplex operation.
96 .It Cm half-duplex
97 Force half duplex operation.
98 .El
99 .Pp
100 For more information on configuring this device, see
101 .Xr ifconfig 8 .
102 .Sh DIAGNOSTICS
103 .Bl -diag
104 .It "lge%d: couldn't map memory"
105 A fatal initialization error has occurred.
106 .It "lge%d: couldn't map ports"
107 A fatal initialization error has occurred.
108 .It "lge%d: couldn't map interrupt"
109 A fatal initialization error has occurred.
110 .It "lge%d: no memory for softc struct!"
111 The driver failed to allocate memory for per-device instance information
112 during initialization.
113 .It "lge%d: failed to enable memory mapping!"
114 The driver failed to initialize PCI shared memory mapping.
115 This might
116 happen if the card is not in a bus-master slot.
117 .It "lge%d: no memory for jumbo buffers!"
118 The driver failed to allocate memory for jumbo frames during
119 initialization.
120 .It "lge%d: watchdog timeout"
121 The device has stopped responding to the network, or there is a problem with
122 the network connection (cable).
123 .El
124 .Sh SEE ALSO
125 .Xr arp 4 ,
126 .Xr netintro 4 ,
127 .Xr ng_ether 4 ,
128 .Xr ifconfig 8
129 .Rs
130 .%T Level 1 LXT1001 Programming Manual
131 .%O http://www.FreeBSD.org/~wpaul/Level1/LXT1001SRM.pdf
132 .Re
133 .Sh HISTORY
134 The
135 .Nm
136 device driver first appeared in
137 .Fx 4.4 .
138 .Sh AUTHORS
139 The
140 .Nm
141 driver was written by
142 .An Bill Paul Aq william.paul@windriver.com .