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