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