xref: /freebsd/share/man/man4/bce.4 (revision 39beb93c)
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 January 15, 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 1000baseTX
113Set 1000baseTX operation over twisted pair.
114Only
115.Cm full-duplex
116mode is supported.
117.El
118.Pp
119The
120.Nm
121driver supports the following media options:
122.Bl -tag -width ".Cm full-duplex"
123.It Cm full-duplex
124Force full duplex operation.
125.It Cm half-duplex
126Force half duplex operation.
127.El
128.Pp
129For more information on configuring this device, see
130.Xr ifconfig 8 .
131.Sh HARDWARE
132The
133.Nm
134driver provides support for various NICs based on the Broadcom NetXtreme II
135family of Gigabit Ethernet controllers, including the
136following:
137.Pp
138.Bl -bullet -compact
139.It
140Broadcom NetXtreme II BCM5706 1000Base-SX
141.It
142Broadcom NetXtreme II BCM5706 1000Base-T
143.It
144Broadcom NetXtreme II BCM5708 1000Base-SX
145.It
146Broadcom NetXtreme II BCM5708 1000Base-T
147.It
148Broadcom NetXtreme II BCM5709 1000Base-SX
149.It
150Broadcom NetXtreme II BCM5709 1000Base-T
151.It
152Broadcom NetXtreme II BCM5716 1000Base-T
153.It
154Dell PowerEdge 1950 integrated BCM5708 NIC
155.It
156Dell PowerEdge 2950 integrated BCM5708 NIC
157.It
158HP NC370F Multifunction Gigabit Server Adapter
159.It
160HP NC370T Multifunction Gigabit Server Adapter
161.It
162HP NC370i Multifunction Gigabit Server Adapter
163.It
164HP NC371i Multifunction Gigabit Server Adapter
165.It
166HP NC373F PCIe Multifunc Giga Server Adapter
167.It
168HP NC373T PCIe Multifunction Gig Server Adapter
169.It
170HP NC373i Multifunction Gigabit Server Adapter
171.It
172HP NC373m Multifunction Gigabit Server Adapter
173.It
174HP NC374m PCIe Multifunction Adapter
175.It
176HP NC380T PCIe DP Multifunc Gig Server Adapter
177.It
178HP NC382T PCIe DP Multifunction Gigabit Server Adapter
179.It
180HP NC382i DP Multifunction Gigabit Server Adapter
181.It
182HP NC382m DP 1GbE Multifunction BL-c Adapter
183.El
184.Sh SYSCTL VARIABLES
185The following variables are available as both
186.Xr sysctl 8
187variables and
188.Xr loader 8
189tunables:
190.Bl -tag -width indent
191.It Va hw.bce.msi_enable
192Whether or not MSI support is enabled in the driver.
193The default value is 1.
194.El
195.Sh DIAGNOSTICS
196.Bl -diag
197.It "bce%d: PCI memory allocation failed!"
198The driver has encountered a fatal initialization error.
199.It "bce%d: PCI map interrupt failed!"
200The driver has encountered a fatal initialization error.
201.It "bce%d: Unsupported controller revision (%c%d)"
202The driver does not support the controller revision in use.
203.It "bce%d: Controller initialization failed!"
204The driver has encountered a fatal initialization error.
205.It "bce%d: NVRAM test failed!"
206The driver could not access the controller NVRAM correctly.
207.It "bce%d: DMA resource allocation failed!"
208The driver could not allocate DMA memory to setup the controllers
209host memory data structures.
210.It "bce%d: Interface allocation failed!"
211The driver could not create a network interface for the controller.
212.It "bce%d: PHY probe failed!"
213The driver could not access the PHY used by the controller.
214.It "bce%d: Failed to setup IRQ!"
215The driver could not initialize the IRQ handler.
216.It "bce%d: Error: PHY read timeout!"
217The driver could not read a PHY register before the timeout period expired.
218.It "bce%d: PHY write timeout!"
219The driver could not write to the PHY register because a timeout occurred.
220.It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
221The driver could not write to NVRAM because a timeout occurred.
222.It "bce%d: Unknown Flash NVRAM found!"
223The driver does not recognize the NVRAM device being used and therefore
224cannot access it correctly.
225.It "bce%d: Invalid NVRAM magic value!"
226The driver cannot read NVRAM or the NVRAM is corrupt.
227.It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
228The driver cannot read NVRAM or the NVRAM is corrupt.
229.It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
230The driver cannot read NVRAM or the NVRAM is corrupt.
231.It "bce%d: DMA mapping error!"
232The driver was unable to map memory into DMA addressable space required
233by the controller.
234.It "bce%d: Could not allocate parent DMA tag!"
235The driver could not allocate a PCI compatible DMA tag.
236.It "bce%d: Could not allocate status block DMA tag!"
237The driver could not allocate a DMA tag for the controller's
238status block.
239.It "bce%d: Could not allocate status block DMA memory!"
240The driver could not allocate DMA addressable memory for the controller's
241status block.
242.It "bce_d: Could not map status block DMA memory!"
243The driver could not map the status block memory into the controller's DMA
244address space.
245.It "bce%d: Could not allocate statistics block DMA tag!"
246The driver could not allocate a DMA tag for the controller's
247statistics block.
248.It "bce%d: Could not allocate statistics block DMA memory!"
249The driver could not allocate DMA addressable memory for the controller's
250statistics block.
251.It "bce%d: Could not map statistics block DMA memory!"
252The driver could not map the statistics block memory into the controller's DMA
253address space.
254.It "bce%d: Could not allocate TX descriptor chain DMA tag!"
255The driver could not allocate a DMA tag for the controller's
256TX chain.
257.It "bce%d: Could not allocate TX descriptor chain DMA memory!
258The driver could not allocate DMA addressable memory for the controller's
259TX chain.
260.It "bce%d: Could not map TX descriptor chain DMA memory!"
261The driver could not map the TX descriptor chain memory into the controller's DMA
262address space.
263.It "bce%d: Could not allocate TX mbuf DMA tag!"
264The driver could not allocate a DMA tag for the controller's
265TX mbuf memory.
266.It "bce%d: Unable to create TX mbuf DMA map!"
267The driver could not map the TX mbuf memory into the controller's DMA
268address space.
269.It "bce%d: Could not allocate RX descriptor chain DMA tag!"
270The driver could not allocate a DMA tag for the controller's
271RX chain.
272.It "bce%d: Could not allocate RX descriptor chain "
273The driver could not allocate DMA addressable memory for the controller's
274RX chain.
275.It "bce%d: Could not map RX descriptor chain DMA memory!"
276The driver could not map the RX descriptor chain memory into the controller's DMA
277address space.
278.It "bce%d: Could not allocate RX mbuf DMA tag!"
279The driver could not allocate a DMA tag for the controller's
280RX mbuf memory.
281.It "bce%d: Unable to create RX mbuf DMA map!"
282The driver could not map the RX mbuf memory into the controller's DMA
283address space.
284.It "bce%d: Firmware synchronization timeout!"
285The driver was not able to synchronize with the firmware running on the
286controller.
287The firmware may be stopped or hung.
288.It "bce%d: Invalid Ethernet address!"
289The driver was not able to read a valid Ethernet MAC address from NVRAM.
290.It "bce%d: Reset failed!"
291The driver has encountered a fatal initialization error.
292.It "bce%d: Byte swap is incorrect!"
293The driver has encountered a fatal initialization error.
294Contact the author
295with details of the CPU architecture and system chipset in use.
296.It "bce%d: Firmware did not complete initialization!"
297The driver has encountered a fatal initialization error.
298.It "bce%d: Bootcode not running!"
299The driver has encountered a fatal initialization error.
300.It "bce%d: Error mapping mbuf into RX chain!"
301The driver could not map a RX mbuf into DMA addressable memory.
302.It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
303The driver was unable to allocate enough mbufs to fill the RX chain
304during initialization.
305Try increasing the number of mbufs available in
306the system, increase system memory, or if using jumbo frames, make sure
307enough 9KB mbufs are available.
308.It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
309The driver was unable to allocate a new mbuf for the RX chain and reused
310the mbuf for the received frame, dropping the incoming frame in the process.
311Try increasing the number of mbufs available in the system or increase system
312memory.
313.It "bce%d: Controller reset failed!"
314A fatal initialization error has occurred.
315.It "bce%d: Controller initialization failed!"
316A fatal initialization error has occurred.
317.It "bce%d: Block initialization failed!"
318A fatal initialization error has occurred.
319.It "bce%d: Error mapping mbuf into TX chain!"
320The driver could not map a TX mbuf into DMA addressable memory.
321.It "bce%d: Error registering poll function!"
322The driver received an error while attempting to register the poll function.
323.It "bce%d: Changing VLAN_MTU not supported."
324Changing the VLAN MTU is not currently supported by the driver.
325.It "bce%d: Cannot change VLAN_HWTAGGING while management firmware (ASF/IPMI/UMP) is running!"
326Management firmware to support ASF/IPMI/UMP requires that VLAN
327tag stripping be enabled in the controller.
328.It "bce%d: Changing VLAN_HWTAGGING not supported!"
329Disabling VLAN tag stripping is not currently supported by the driver.
330.It "bce%d: Watchdog timeout occurred, resetting!"
331The device has stopped responding to the network, there is a problem
332with the cable connection, or a driver logic problem has occurred..
333.It "bce%d: Fatal attention detected: 0x%08X!"
334A controller hardware failure has occurred.
335If the problem continues replace the controller.
336.El
337.Sh SEE ALSO
338.Xr altq 4 ,
339.Xr arp 4 ,
340.Xr miibus 4 ,
341.Xr netintro 4 ,
342.Xr ng_ether 4 ,
343.Xr vlan 4 ,
344.Xr ifconfig 8
345.Sh HISTORY
346The
347.Nm
348device driver first appeared in
349.Fx 6.1 .
350.Sh AUTHORS
351The
352.Nm
353driver was written by
354.An David Christensen Aq davidch@broadcom.com .
355