* Perform some man page maintenance bringing the miibus related
[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 .\" $DragonFly: src/share/man/man4/lge.4,v 1.3 2004/01/13 01:48:59 drhodus Exp $
34 .\"
35 .Dd May 30, 2001
36 .Dt LGE 4
37 .Os
38 .Sh NAME
39 .Nm lge
40 .Nd "Level 1 LXT1001 NetCellerator PCI gigabit ethernet adapter driver"
41 .Sh SYNOPSIS
42 .Cd "device miibus"
43 .Cd "device lge"
44 .Sh DESCRIPTION
45 The
46 .Nm
47 driver provides support for various NICs based on the Level 1 LXT1001
48 NetCellerator gigabit ethernet controller chip, including the
49 following:
50 .Pp
51 .Bl -bullet -compact
52 .It
53 SMC TigerCard 1000 (SMC9462SX)
54 .It
55 D-Link DGE-500SX
56 .El
57 .Pp
58 These NICs are capable of 1000mbps speeds over fiber optic cable.
59 The LXT1001 also supports a GMII port for use with 10/100/1000 copper
60 PHYs, however there aren't currently any NICs on the market that use
61 this feature.
62 .Pp
63 The LXT1001 supports TCP/IP checksum offload for receive and
64 VLAN-based filtering as well as a 64-bit multicast hash filter.
65 It also supports jumbo frames, which can be configured
66 via the interface MTU setting.
67 Selecting an MTU larger than 1500 bytes with the
68 .Xr ifconfig 8
69 utility configures the adapter to receive and transmit jumbo frames.
70 Using jumbo frames can greatly improve performance for certain tasks,
71 such as file transfers and data streaming.
72 .Pp
73 The
74 .Nm
75 driver supports the following media types:
76 .Bl -tag -width ".Cm 1000baseSX"
77 .It Cm autoselect
78 Enable autoselection of the media type and options.
79 The user can manually override
80 the autoselected mode by adding media options to
81 .Xr rc.conf 5 .
82 .It Cm 1000baseSX
83 Set 1000baseSX operation over fiber optic cable.
84 Both
85 .Cm full-duplex
86 and
87 .Cm half-duplex
88 modes are supported.
89 .El
90 .Pp
91 The
92 .Nm
93 driver supports the following media options:
94 .Bl -tag -width ".Cm full-duplex"
95 .It Cm full-duplex
96 Force full duplex operation.
97 .It Cm half-duplex
98 Force half duplex operation.
99 .El
100 .Pp
101 For more information on configuring this device, see
102 .Xr ifconfig 8 .
103 .Sh DIAGNOSTICS
104 .Bl -diag
105 .It "lge%d: couldn't map memory"
106 A fatal initialization error has occurred.
107 .It "lge%d: couldn't map ports"
108 A fatal initialization error has occurred.
109 .It "lge%d: couldn't map interrupt"
110 A fatal initialization error has occurred.
111 .It "lge%d: no memory for softc struct!"
112 The driver failed to allocate memory for per-device instance information
113 during initialization.
114 .It "lge%d: failed to enable memory mapping!"
115 The driver failed to initialize PCI shared memory mapping.
116 This might
117 happen if the card is not in a bus-master slot.
118 .It "lge%d: no memory for jumbo buffers!"
119 The driver failed to allocate memory for jumbo frames during
120 initialization.
121 .It "lge%d: watchdog timeout"
122 The device has stopped responding to the network, or there is a problem with
123 the network connection (cable).
124 .El
125 .Sh SEE ALSO
126 .Xr arp 4 ,
127 .Xr miibus 4 ,
128 .Xr netintro 4 ,
129 .Xr ng_ether 4 ,
130 .Xr ifconfig 8
131 .Rs
132 .%T Level 1 LXT1001 Programming Manual
133 .%O http://www.FreeBSD.org/~wpaul/Level1/LXT1001SRM.pdf
134 .Re
135 .Sh HISTORY
136 The
137 .Nm
138 device driver first appeared in
139 .Fx 4.4 .
140 .Sh AUTHORS
141 The
142 .Nm
143 driver was written by
144 .An Bill Paul Aq william.paul@windriver.com .