xref: /freebsd/share/man/man4/bce.4 (revision 0efd6615cd5f39b67cec82a7034e655f3b5801e3)
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 December 2, 2006
32.Dt BCE 4
33.Os
34.Sh NAME
35.Nm bce
36.Nd "Broadcom NetXtreme II (BCM5706/BCM5708) 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 and BCM5708 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.
62The following features are supported in the
63.Nm
64driver under
65.Fx :
66.Pp
67.Bl -item -offset indent -compact
68.It
69IP/TCP/UDP checksum offload
70.It
71Jumbo frames (up to 9022 bytes)
72.It
73VLAN tag stripping
74.It
75Interrupt coalescing
76.It
7710/100/1000Mbps operation in full-duplex mode
78.It
7910/100Mbps operation in half-duplex mode
80.El
81.Pp
82The
83.Nm
84driver supports the following media types:
85.Bl -tag -width ".Cm 10baseT/UTP"
86.It Cm autoselect
87Enable autoselection of the media type and options.
88The user can manually override
89the autoselected mode by adding media options to
90.Xr rc.conf 5 .
91.It Cm 10baseT/UTP
92Set 10Mbps operation.
93The
94.Xr ifconfig 8
95.Cm mediaopt
96option can also be used to select either
97.Cm full-duplex
98or
99.Cm half-duplex
100modes.
101.It Cm 100baseTX
102Set 100Mbps (Fast Ethernet) operation.
103The
104.Xr ifconfig 8
105.Cm mediaopt
106option can also be used to select either
107.Cm full-duplex
108or
109.Cm half-duplex
110modes.
111.It Cm 1000baseTX
112Set 1000baseTX operation over twisted pair.
113Only
114.Cm full-duplex
115mode is supported.
116.El
117.Pp
118The
119.Nm
120driver supports the following media options:
121.Bl -tag -width ".Cm full-duplex"
122.It Cm full-duplex
123Force full duplex operation.
124.It Cm half-duplex
125Force half duplex operation.
126.El
127.Pp
128For more information on configuring this device, see
129.Xr ifconfig 8 .
130.Sh HARDWARE
131The
132.Nm
133driver provides support for various NICs based on the Broadcom NetXtreme II
134family of Gigabit Ethernet controllers, including the
135following:
136.Pp
137.Bl -bullet -compact
138.It
139HP NC370T Multifunction Gigabit Server Adapter
140.It
141HP NC370i Multifunction Gigabit Server Adapter
142.El
143.Sh DIAGNOSTICS
144.Bl -diag
145.It "bce%d: PCI memory allocation failed!"
146The driver has encountered a fatal initialization error.
147.It "bce%d: PCI map interrupt failed!"
148The driver has encountered a fatal initialization error.
149.It "bce%d: Unsupported controller revision (%c%d)"
150The driver does not support the controller revision in use.
151.It "bce%d: SerDes controllers are not supported!"
152The driver does not currently support SerDes/Fiber versions of the
153NetXtreme II controller.
154.It "bce%d: Controller initialization failed!"
155The driver has encountered a fatal initialization error.
156.It "bce%d: NVRAM test failed!"
157The driver could not access the controller NVRAM correctly.
158.It "bce%d: DMA resource allocation failed!"
159The driver could not allocate DMA memory to setup the controllers
160host memory data structures.
161.It "bce%d: Interface allocation failed!"
162The driver could not create a network interface for the controller.
163.It "bce%d: PHY probe failed!"
164The driver could not access the PHY used by the controller.
165.It "bce%d: Failed to setup IRQ!"
166The driver could not initialize the IRQ handler.
167.It "bce%d: Error: PHY read timeout!"
168The driver could not read a PHY register before the timeout period expired.
169.It "bce%d: PHY write timeout!"
170The driver could not write to the PHY register because a timeout occurred.
171.It "bce%d: Timeout error reading NVRAM at offset 0x%08X!"
172The driver could not write to NVRAM because a timeout occurred.
173.It "bce%d: Unknown Flash NVRAM found!"
174The driver does not recognize the NVRAM device being used and therefore
175cannot access it correctly.
176.It "bce%d: Invalid NVRAM magic value!"
177The driver cannot read NVRAM or the NVRAM is corrupt.
178.It "bce%d: Invalid Manufacturing Information NVRAM CRC!"
179The driver cannot read NVRAM or the NVRAM is corrupt.
180.It "bce%d: Invalid Feature Configuration Information NVRAM CRC!"
181The driver cannot read NVRAM or the NVRAM is corrupt.
182.It "bce%d: DMA mapping error!"
183The driver was unable to map memory into DMA addressable space required
184by the controller.
185.It "bce%d: Could not allocate parent DMA tag!"
186The driver could not allocate a PCI compatible DMA tag.
187.It "bce%d: Could not allocate status block DMA tag!"
188The driver could not allocate a DMA tag for the controller's
189status block.
190.It "bce%d: Could not allocate status block DMA memory!"
191The driver could not allocate DMA addressable memory for the controller's
192status block.
193.It "bce_d: Could not map status block DMA memory!"
194The driver could not map the status block memory into the controller's DMA
195address space.
196.It "bce%d: Could not allocate statistics block DMA tag!"
197The driver could not allocate a DMA tag for the controller's
198statistics block.
199.It "bce%d: Could not allocate statistics block DMA memory!"
200The driver could not allocate DMA addressable memory for the controller's
201statistics block.
202.It "bce%d: Could not map statistics block DMA memory!"
203The driver could not map the statistics block memory into the controller's DMA
204address space.
205.It "bce%d: Could not allocate TX descriptor chain DMA tag!"
206The driver could not allocate a DMA tag for the controller's
207TX chain.
208.It "bce%d: Could not allocate TX descriptor chain DMA memory!
209The driver could not allocate DMA addressable memory for the controller's
210TX chain.
211.It "bce%d: Could not map TX descriptor chain DMA memory!"
212The driver could not map the TX descriptor chain memory into the controller's DMA
213address space.
214.It "bce%d: Could not allocate TX mbuf DMA tag!"
215The driver could not allocate a DMA tag for the controller's
216TX mbuf memory.
217.It "bce%d: Unable to create TX mbuf DMA map!"
218The driver could not map the TX mbuf memory into the controller's DMA
219address space.
220.It "bce%d: Could not allocate RX descriptor chain DMA tag!"
221The driver could not allocate a DMA tag for the controller's
222RX chain.
223.It "bce%d: Could not allocate RX descriptor chain "
224The driver could not allocate DMA addressable memory for the controller's
225RX chain.
226.It "bce%d: Could not map RX descriptor chain DMA memory!"
227The driver could not map the RX descriptor chain memory into the controller's DMA
228address space.
229.It "bce%d: Could not allocate RX mbuf DMA tag!"
230The driver could not allocate a DMA tag for the controller's
231RX mbuf memory.
232.It "bce%d: Unable to create RX mbuf DMA map!"
233The driver could not map the RX mbuf memory into the controller's DMA
234address space.
235.It "bce%d: Firmware synchronization timeout!"
236The driver was not able to synchronize with the firmware running on the
237controller.
238The firmware may be stopped or hung.
239.It "bce%d: Invalid Ethernet address!"
240The driver was not able to read a valid Ethernet MAC address from NVRAM.
241.It "bce%d: Reset failed!"
242The driver has encountered a fatal initialization error.
243.It "bce%d: Byte swap is incorrect!"
244The driver has encountered a fatal initialization error.
245Contact the author
246with details of the CPU architecture and system chipset in use.
247.It "bce%d: Firmware did not complete initialization!"
248The driver has encountered a fatal initialization error.
249.It "bce%d: Bootcode not running!"
250The driver has encountered a fatal initialization error.
251.It "bce%d: Error mapping mbuf into RX chain!"
252The driver could not map a RX mbuf into DMA addressable memory.
253.It "bce%d: Error filling RX chain: rx_bd[0x%04X]!"
254The driver was unable to allocate enough mbufs to fill the RX chain
255during initialization.
256Try increasing the number of mbufs available in
257the system, increase system memory, or if using jumbo frames, make sure
258enough 9KB mbufs are available.
259.It "bce%d: Failed to allocate new mbuf, incoming frame dropped!"
260The driver was unable to allocate a new mbuf for the RX chain and reused
261the mbuf for the received frame, dropping the incoming frame in the process.
262Try increasing the number of mbufs available in the system or increase system
263memory.
264.It "bce%d: Controller reset failed!"
265A fatal initialization error has occurred.
266.It "bce%d: Controller initialization failed!"
267A fatal initialization error has occurred.
268.It "bce%d: Block initialization failed!"
269A fatal initialization error has occurred.
270.It "bce%d: Error mapping mbuf into TX chain!"
271The driver could not map a TX mbuf into DMA addressable memory.
272.It "bce%d: Error registering poll function!"
273The driver received an error while attempting to register the poll function.
274.It "bce%d: Changing VLAN_MTU not supported."
275Changing the VLAN MTU is not currently supported by the driver.
276.It "bce%d: Cannot change VLAN_HWTAGGING while management firmware (ASF/IPMI/UMP) is running!"
277Management firmware to support ASF/IPMI/UMP requires that VLAN
278tag stripping be enabled in the controller.
279.It "bce%d: Changing VLAN_HWTAGGING not supported!"
280Disabling VLAN tag stripping is not currently supported by the driver.
281.It "bce%d: Watchdog timeout occurred, resetting!"
282The device has stopped responding to the network, there is a problem
283with the cable connection, or a driver logic problem has occurred..
284.It "bce%d: Fatal attention detected: 0x%08X!"
285A controller hardware failure has occurred.
286If the problem continues replace the controller.
287.El
288.Sh SEE ALSO
289.Xr arp 4 ,
290.Xr miibus 4 ,
291.Xr netintro 4 ,
292.Xr ng_ether 4 ,
293.Xr vlan 4 ,
294.Xr ifconfig 8
295.Sh HISTORY
296The
297.Nm
298device driver first appeared in
299.Fx 6.1 .
300.Sh AUTHORS
301The
302.Nm
303driver was written by
304.An David Christensen Aq davidch@broadcom.com .
305