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