xref: /freebsd/share/man/man4/bge.4 (revision 17d6c636720d00f77e5d098daf4c278f89d84f7b)
1.\" Copyright (c) 2001 Wind River Systems
2.\" Copyright (c) 1997, 1998, 1999, 2000, 2001
3.\"	Bill Paul <wpaul@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 September 27, 2001
35.Dt BGE 4
36.Os
37.Sh NAME
38.Nm bge
39.Nd "Broadcom BCM570x PCI gigabit ethernet adapter driver"
40.Sh SYNOPSIS
41.Cd "device miibus"
42.Cd "device bge"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for various NICs based on the Broadcom BCM570x
47family of gigabit ethernet controller chips, including the
48following:
49.Pp
50.Bl -bullet -compact
51.It
523Com 3c996-T (10/100/1000baseTX)
53.It
54Dell PowerEdge 2550 integrated BCM5700 NIC (10/100/1000baseTX)
55.It
56SysKonnect SK-9D21 (10/100/1000baseTX)
57.It
58SysKonnect SK-9D41 (1000baseSX)
59.El
60.Pp
61All of these NICs are capable of 10, 100 and 1000Mbps speeds over CAT5
62copper cable, except for the SysKonnect SK-9D41 which supports only
631000Mbps over multimode fiber.
64The BCM570x builds upon the technology of the Alteon Tigon II.
65It has two R4000 CPU cores and is PCI v2.2 and PCI-X v1.0 compliant.
66It supports IP, TCP
67and UDP checksum checksum offload for both receive and transmit,
68multiple RX and TX DMA rings for QoS applications, rules-based
69receive filtering, and VLAN tag stripping/insertion as well as
70a 256-bit multicast hash filter.
71Additional features may be
72provided via value-add firmware updates.
73The BCM570x supports TBI (ten bit interface) and GMII
74transceivers, which means it can be used with either copper of 1000baseX
75fiber applications.
76Note however the device only supports a single
77speed in TBI mode.
78.Pp
79Most cards also use the Broadcom BCM5401 or BCM5411 10/100/1000
80copper gigabit tranceivers,
81which support autonegotiation of 10, 100 and 1000mbps modes in
82full or half duplex.
83.Pp
84The BCM5700 also supports jumbo frames, which can be configured
85via the interface MTU setting.
86Selecting an MTU larger than 1500 bytes with the
87.Xr ifconfig 8
88utility configures the adapter to receive and transmit jumbo frames.
89Using jumbo frames can greatly improve performance for certain tasks,
90such as file transfers and data streaming.
91.Pp
92The
93.Nm
94driver supports the following media types:
95.Bl -tag -width ".Cm 10baseT/UTP"
96.It Cm autoselect
97Enable autoselection of the media type and options.
98The user can manually override
99the autoselected mode by adding media options to
100.Xr rc.conf 5 .
101.It Cm 10baseT/UTP
102Set 10Mbps operation.
103The
104.Xr ifconfig 8
105.Ic mediaopt
106option can also be used to select either
107.Cm full-duplex
108or
109.Cm half-duplex
110modes.
111.It Cm 100baseTX
112Set 100Mbps (fast ethernet) operation.
113The
114.Xr ifconfig 8
115.Ic mediaopt
116option can also be used to select either
117.Cm full-duplex
118or
119.Cm half-duplex
120modes.
121.It Cm 1000baseTX
122Set 1000baseTX operation over twisted pair.
123.Cm full-duplex
124and
125.Cm half-duplex
126modes are supported.
127.It Cm 1000baseSX
128Set 1000Mbps (gigabit ethernet) operation.
129Both
130.Cm full-duplex
131and
132.Cm half-duplex
133modes are supported.
134.El
135.Pp
136The
137.Nm
138driver supports the following media options:
139.Bl -tag -width ".Cm full-duplex"
140.It Cm full-duplex
141Force full duplex operation.
142.It Cm half-duplex
143Force half duplex operation.
144.El
145.Pp
146The
147.Nm
148driver also supports one special link option for 1000baseTX cards:
149.Bl -tag -width ".Cm link0"
150.It Cm link0
151With 1000baseTX cards, establishing a link between two ports requires
152that one port be configured as a master and the other a slave.
153With autonegotiation,
154the master/slave settings will be chosen automatically.
155However when manually selecting the link state, it is necessary to
156force one side of the link to be a master and the other a slave.
157The
158.Nm
159driver configures the ports as slaves by default.
160Setting the
161.Cm link0
162flag with
163.Xr ifconfig 8
164will set a port as a master instead.
165.El
166.Pp
167For more information on configuring this device, see
168.Xr ifconfig 8 .
169.Sh DIAGNOSTICS
170.Bl -diag
171.It "bge%d: couldn't map memory"
172A fatal initialization error has occurred.
173.It "bge%d: couldn't map ports"
174A fatal initialization error has occurred.
175.It "bge%d: couldn't map interrupt"
176A fatal initialization error has occurred.
177.It "bge%d: no memory for softc struct!"
178The driver failed to allocate memory for per-device instance information
179during initialization.
180.It "bge%d: failed to enable memory mapping!"
181The driver failed to initialize PCI shared memory mapping.
182This might
183happen if the card is not in a bus-master slot.
184.It "bge%d: no memory for jumbo buffers!"
185The driver failed to allocate memory for jumbo frames during
186initialization.
187.It "bge%d: watchdog timeout"
188The device has stopped responding to the network, or there is a problem with
189the network connection (cable).
190.El
191.Sh SEE ALSO
192.Xr arp 4 ,
193.Xr netintro 4 ,
194.Xr ng_ether 4 ,
195.Xr vlan 4 ,
196.Xr ifconfig 8
197.Sh HISTORY
198The
199.Nm
200device driver first appeared in
201.Fx 4.5 .
202.Sh AUTHORS
203The
204.Nm
205driver was written by
206.An Bill Paul Aq wpaul@windriver.com .
207