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