xref: /freebsd/share/man/man4/lge.4 (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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$
33.\"
34.Dd July 16, 2005
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
41To compile support for the
42.Nm
43driver into your kernel, place the following lines in your
44kernel configuration file:
45.Bd -ragged -offset indent
46.Cd "device miibus"
47.Cd "device lge"
48.Ed
49.Pp
50Alternatively, to load the
51.Nm
52driver at boot time, place the following line in
53.Xr loader.conf 5 :
54.Bd -literal -offset indent
55if_lge_load="YES"
56.Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver provides support for various NICs based on the Level 1 LXT1001
61NetCellerator Gigabit Ethernet controller chip.
62.Pp
63The LXT1001 supports fiber PHYs and also a GMII port for use with
6410/100/1000 copper PHYs, however there are currently no NICs on the
65market that use this feature.
66.Pp
67The LXT1001 supports TCP/IP checksum offload for receive and
68VLAN-based filtering as well as a 64-bit multicast hash filter.
69It also supports jumbo frames, which can be configured
70via the interface MTU setting.
71Selecting an MTU larger than 1500 bytes with the
72.Xr ifconfig 8
73utility configures the adapter to receive and transmit jumbo frames.
74Using jumbo frames can greatly improve performance for certain tasks,
75such as file transfers and data streaming.
76.Pp
77The
78.Nm
79driver supports the following media types:
80.Bl -tag -width ".Cm 1000baseSX"
81.It Cm autoselect
82Enable autoselection of the media type and options.
83The user can manually override
84the autoselected mode by adding media options to
85.Xr rc.conf 5 .
86.It Cm 1000baseSX
87Set 1000baseSX operation over fiber optic cable.
88Both
89.Cm full-duplex
90and
91.Cm half-duplex
92modes are supported.
93.El
94.Pp
95The
96.Nm
97driver supports the following media options:
98.Bl -tag -width ".Cm full-duplex"
99.It Cm full-duplex
100Force full duplex operation.
101.It Cm half-duplex
102Force half duplex operation.
103.El
104.Pp
105For more information on configuring this device, see
106.Xr ifconfig 8 .
107.Sh HARDWARE
108Adapters supported by the
109.Nm
110driver include:
111.Pp
112.Bl -bullet -compact
113.It
114SMC TigerCard 1000 (SMC9462SX)
115.It
116D-Link DGE-500SX
117.El
118.Sh DIAGNOSTICS
119.Bl -diag
120.It "lge%d: couldn't map memory"
121A fatal initialization error has occurred.
122.It "lge%d: couldn't map ports"
123A fatal initialization error has occurred.
124.It "lge%d: couldn't map interrupt"
125A fatal initialization error has occurred.
126.It "lge%d: no memory for softc struct!"
127The driver failed to allocate memory for per-device instance information
128during initialization.
129.It "lge%d: failed to enable memory mapping!"
130The driver failed to initialize PCI shared memory mapping.
131This might
132happen if the card is not in a bus-master slot.
133.It "lge%d: no memory for jumbo buffers!"
134The driver failed to allocate memory for jumbo frames during
135initialization.
136.It "lge%d: watchdog timeout"
137The device has stopped responding to the network, or there is a problem with
138the network connection (cable).
139.El
140.Sh SEE ALSO
141.Xr arp 4 ,
142.Xr miibus 4 ,
143.Xr netintro 4 ,
144.Xr ng_ether 4 ,
145.Xr ifconfig 8
146.Rs
147.%T Level 1 LXT1001 Programming Manual
148.%O http://www.FreeBSD.org/~wpaul/Level1/LXT1001SRM.pdf
149.Re
150.Sh HISTORY
151The
152.Nm
153device driver first appeared in
154.Fx 4.4 .
155.Sh AUTHORS
156The
157.Nm
158driver was written by
159.An Bill Paul Aq william.paul@windriver.com .
160