xref: /freebsd/share/man/man4/bce.4 (revision c2965cd1854b75e6a13cb4bd6759b71adc8d2a87)
1.\" Copyright (c) 2006 Broadcom Corporation
2.\"  David Christensen <davidch@broadcom.com>.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
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. Neither the name of Broadcom Corporation nor the name of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written consent.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS'
18.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27.\" THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd October 7, 2009
32.Dt BCE 4
33.Os
34.Sh NAME
35.Nm bce
36.Nd "Broadcom NetXtreme II (BCM5706/5708/5709/5716) PCI/PCIe Gigabit Ethernet adapter driver"
37.Sh SYNOPSIS
38To compile this driver into the kernel,
39place the following lines in your
40kernel configuration file:
41.Bd -ragged -offset indent
42.Cd "device miibus"
43.Cd "device bce"
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50if_bce_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver supports Broadcom's NetXtreme II product family, including the
56BCM5706, BCM5708, BCM5709 and BCM5716 Ethernet controllers.
57.Pp
58The NetXtreme II product family is composed of various Converged NIC (or CNIC)
59Ethernet controllers which support a TCP Offload Engine (TOE), Remote DMA (RDMA),
60and iSCSI acceleration, in addition to standard L2 Ethernet traffic, all on the
61same controller.
62.Pp
63The following features are supported in the
64.Nm
65driver under
66.Fx :
67.Pp
68.Bl -item -offset indent -compact
69.It
70IP/TCP/UDP checksum offload
71.It
72Jumbo frames (up to 9022 bytes)
73.It
74VLAN tag stripping
75.It
76Interrupt coalescing
77.It
7810/100/1000Mbps operation in full-duplex mode
79.It
8010/100Mbps operation in half-duplex mode
81.El
82.Pp
83The
84.Nm
85driver supports the following media types:
86.Bl -tag -width ".Cm 10baseT/UTP"
87.It Cm autoselect
88Enable autoselection of the media type and options.
89The user can manually override
90the autoselected mode by adding media options to
91.Xr rc.conf 5 .
92.It Cm 10baseT/UTP
93Set 10Mbps operation.
94The
95.Xr ifconfig 8
96.Cm mediaopt
97option can also be used to select either
98.Cm full-duplex
99or
100.Cm half-duplex
101modes.
102.It Cm 100baseTX
103Set 100Mbps (Fast Ethernet) operation.
104The
105.Xr ifconfig 8
106.Cm mediaopt
107option can also be used to select either
108.Cm full-duplex
109or
110.Cm half-duplex
111modes.
112.It Cm 1000baseSX
113Sets 1000Mbps operation.
114Only
115.Cm full-duplex
116mode is supported at this speed.
117.It Cm 1000baseT
118Set 1000baseT operation over twisted pair.
119Only
120.Cm full-duplex
121mode is supported.
122.It Cm 2500BaseSX
123Set 2500Mbps operation.
124Only
125.Cm full-duplex
126mode is supported.
127.El
128.Pp
129The
130.Nm
131driver supports the following media options:
132.Bl -tag -width ".Cm full-duplex"
133.It Cm full-duplex
134Force full duplex operation.
135.It Cm half-duplex
136Force half duplex operation.
137.El
138.Pp
139For more information on configuring this device, see
140.Xr ifconfig 8 .
141.Sh HARDWARE
142The
143.Nm
144driver provides support for various NICs based on the Broadcom NetXtreme II
145family of Gigabit Ethernet controllers, including the
146following:
147.Pp
148.Bl -bullet -compact
149.It
150Broadcom NetXtreme II BCM5706 1000Base-SX
151.It
152Broadcom NetXtreme II BCM5706 1000Base-T
153.It
154Broadcom NetXtreme II BCM5708 1000Base-SX
155.It
156Broadcom NetXtreme II BCM5708 1000Base-T
157.It
158Broadcom NetXtreme II BCM5709 1000Base-SX
159.It
160Broadcom NetXtreme II BCM5709 1000Base-T
161.It
162Broadcom NetXtreme II BCM5716 1000Base-T
163.It
164Dell PowerEdge 1950 integrated BCM5708 NIC
165.It
166Dell PowerEdge 2950 integrated BCM5708 NIC
167.It
168Dell PowerEdge R710 integrated BCM5709 NIC
169.It
170HP NC370F Multifunction Gigabit Server Adapter
171.It
172HP NC370T Multifunction Gigabit Server Adapter
173.It
174HP NC370i Multifunction Gigabit Server Adapter
175.It
176HP NC371i Multifunction Gigabit Server Adapter
177.It
178HP NC373F PCIe Multifunc Giga Server Adapter
179.It
180HP NC373T PCIe Multifunction Gig Server Adapter
181.It
182HP NC373i Multifunction Gigabit Server Adapter
183.It
184HP NC373m Multifunction Gigabit Server Adapter
185.It
186HP NC374m PCIe Multifunction Adapter
187.It
188HP NC380T PCIe DP Multifunc Gig Server Adapter
189.It
190HP NC382T PCIe DP Multifunction Gigabit Server Adapter
191.It
192HP NC382i DP Multifunction Gigabit Server Adapter
193.It
194HP NC382m DP 1GbE Multifunction BL-c Adapter
195.El
196.Sh SYSCTL VARIABLES
197The following variables are available as both
198.Xr sysctl 8
199variables and
200.Xr loader 8
201tunables:
202.Bl -tag -width indent
203.It Va hw.bce.msi_enable
204Whether or not MSI support is enabled in the driver.
205The default value is 1.
206.El
207.Sh DIAGNOSTICS
208.Bl -diag
209.It "bce%d: PCI memory allocation failed!"
210The driver has encountered a fatal initialization error.
211.It "bce%d: PCI map interrupt failed!"
212The driver has encountered a fatal initialization error.
213.It "bce%d: Unsupported controller revision (%c%d)"
214The driver does not support the controller revision in use.
215.It "bce%d: Controller initialization failed!"
216The driver has encountered a fatal initialization error.
217.It "bce%d: NVRAM test failed!"
218The driver could not access the controller NVRAM correctly.
219.It "bce%d: DMA resource allocation failed!"
220The driver could not allocate DMA memory to setup the controllers
221host memory data structures.
222.It "bce%d: Interface allocation failed!"
223The driver could not create a network interface for the controller.
224.It "bce%d: PHY probe failed!"
225The driver could not access the PHY used by the controller.
226.It "bce%d: Failed to setup IRQ!"
227The driver could not initialize the IRQ handler.
228.It "bce%d: Error: PHY read timeout!"
229The driver could not read a PHY register before the timeout period expired.
230.It "bce%d: PHY write timeout!"
231The driver could not write to the PHY register because a timeout occurred.
232.It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
233The driver could not write to NVRAM because a timeout occurred.
234.It "bce%d: Unknown Flash NVRAM found!"
235The driver does not recognize the NVRAM device being used and therefore
236cannot access it correctly.
237.It "bce%d: Invalid NVRAM magic value!"
238The driver cannot read NVRAM or the NVRAM is corrupt.
239.It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
240The driver cannot read NVRAM or the NVRAM is corrupt.
241.It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
242The driver cannot read NVRAM or the NVRAM is corrupt.
243.It "bce%d: DMA mapping error!"
244The driver was unable to map memory into DMA addressable space required
245by the controller.
246.It "bce%d: Could not allocate parent DMA tag!"
247The driver could not allocate a PCI compatible DMA tag.
248.It "bce%d: Could not allocate status block DMA tag!"
249The driver could not allocate a DMA tag for the controller's
250status block.
251.It "bce%d: Could not allocate status block DMA memory!"
252The driver could not allocate DMA addressable memory for the controller's
253status block.
254.It "bce%d: Could not map status block DMA memory!"
255The driver could not map the status block memory into the controller's DMA
256address space.
257.It "bce%d: Could not allocate statistics block DMA tag!"
258The driver could not allocate a DMA tag for the controller's
259statistics block.
260.It "bce%d: Could not allocate statistics block DMA memory!"
261The driver could not allocate DMA addressable memory for the controller's
262statistics block.
263.It "bce%d: Could not map statistics block DMA memory!"
264The driver could not map the statistics block memory into the controller's DMA
265address space.
266.It "bce%d: Could not allocate TX descriptor chain DMA tag!"
267The driver could not allocate a DMA tag for the controller's
268TX chain.
269.It "bce%d: Could not allocate TX descriptor chain DMA memory!"
270The driver could not allocate DMA addressable memory for the controller's
271TX chain.
272.It "bce%d: Could not map TX descriptor chain DMA memory!"
273The driver could not map the TX descriptor chain memory into the controller's DMA
274address space.
275.It "bce%d: Could not allocate TX mbuf DMA tag!"
276The driver could not allocate a DMA tag for the controller's
277TX mbuf memory.
278.It "bce%d: Unable to create TX mbuf DMA map!"
279The driver could not map the TX mbuf memory into the controller's DMA
280address space.
281.It "bce%d: Could not allocate RX descriptor chain DMA tag!"
282The driver could not allocate a DMA tag for the controller's
283RX chain.
284.It "bce%d: Could not allocate RX descriptor chain "
285The driver could not allocate DMA addressable memory for the controller's
286RX chain.
287.It "bce%d: Could not map RX descriptor chain DMA memory!"
288The driver could not map the RX descriptor chain memory into the controller's DMA
289address space.
290.It "bce%d: Could not allocate RX mbuf DMA tag!"
291The driver could not allocate a DMA tag for the controller's
292RX mbuf memory.
293.It "bce%d: Unable to create RX mbuf DMA map!"
294The driver could not map the RX mbuf memory into the controller's DMA
295address space.
296.It "bce%d: Firmware synchronization timeout!"
297The driver was not able to synchronize with the firmware running on the
298controller.
299The firmware may be stopped or hung.
300.It "bce%d: Invalid Ethernet address!"
301The driver was not able to read a valid Ethernet MAC address from NVRAM.
302.It "bce%d: Reset failed!"
303The driver has encountered a fatal initialization error.
304.It "bce%d: Byte swap is incorrect!"
305The driver has encountered a fatal initialization error.
306Contact the author
307with details of the CPU architecture and system chipset in use.
308.It "bce%d: Firmware did not complete initialization!"
309The driver has encountered a fatal initialization error.
310.It "bce%d: Bootcode not running!"
311The driver has encountered a fatal initialization error.
312.It "bce%d: Error mapping mbuf into RX chain!"
313The driver could not map a RX mbuf into DMA addressable memory.
314.It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
315The driver was unable to allocate enough mbufs to fill the RX chain
316during initialization.
317Try increasing the number of mbufs available in
318the system, increase system memory, or if using jumbo frames, make sure
319enough 9KB mbufs are available.
320.It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
321The driver was unable to allocate a new mbuf for the RX chain and reused
322the mbuf for the received frame, dropping the incoming frame in the process.
323Try increasing the number of mbufs available in the system or increase system
324memory.
325.It "bce%d: Controller reset failed!"
326A fatal initialization error has occurred.
327.It "bce%d: Controller initialization failed!"
328A fatal initialization error has occurred.
329.It "bce%d: Block initialization failed!"
330A fatal initialization error has occurred.
331.It "bce%d: Error mapping mbuf into TX chain!"
332The driver could not map a TX mbuf into DMA addressable memory.
333.It "bce%d: Error registering poll function!"
334The driver received an error while attempting to register the poll function.
335.It "bce%d: Changing VLAN_MTU not supported."
336Changing the VLAN MTU is not currently supported by the driver.
337.It "bce%d: Cannot change VLAN_HWTAGGING while management firmware (ASF/IPMI/UMP) is running!"
338Management firmware to support ASF/IPMI/UMP requires that VLAN
339tag stripping be enabled in the controller.
340.It "bce%d: Changing VLAN_HWTAGGING not supported!"
341Disabling VLAN tag stripping is not currently supported by the driver.
342.It "bce%d: Watchdog timeout occurred, resetting!"
343The device has stopped responding to the network, there is a problem
344with the cable connection, or a driver logic problem has occurred..
345.It "bce%d: Fatal attention detected: 0x%08X!"
346A controller hardware failure has occurred.
347If the problem continues replace the controller.
348.El
349.Sh SEE ALSO
350.Xr altq 4 ,
351.Xr arp 4 ,
352.Xr miibus 4 ,
353.Xr netintro 4 ,
354.Xr ng_ether 4 ,
355.Xr vlan 4 ,
356.Xr ifconfig 8
357.Sh HISTORY
358The
359.Nm
360device driver first appeared in
361.Fx 6.1 .
362.Sh AUTHORS
363The
364.Nm
365driver was written by
366.An David Christensen Aq davidch@broadcom.com .
367