1 .\" Copyright (c) 2006 Broadcom Corporation
2 .\" David Christensen <davidch@broadcom.com>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
29 .\" $FreeBSD: src/share/man/man4/bce.4,v 1.7 2007/02/09 18:26:13 brueffer Exp $
36 .Nd "Broadcom NetXtreme II PCIe Gigabit Ethernet adapter driver"
38 To compile this driver into the kernel,
39 place the following lines in your
40 kernel configuration file:
41 .Bd -ragged -offset indent
46 Alternatively, to load the driver as a
47 module at boot time, place the following line in
49 .Bd -literal -offset indent
55 driver supports Broadcom's NetXtreme II product family, including the
56 BCM5706, BCM5708, BCM5709 and BCM5716 Ethernet controllers.
58 The NetXtreme II product family is composed of various Converged NIC (or CNIC)
59 Ethernet controllers which support a TCP Offload Engine (TOE), Remote DMA (RDMA),
60 and iSCSI acceleration, in addition to standard L2 Ethernet traffic, all on the
62 The following features are supported in the
66 .Bl -item -offset indent -compact
68 .\"IP/TCP/UDP checksum offload
69 TCP/UDP checksum offload
71 .\"Jumbo frames (up to 9022 bytes)
73 TCP segmentation offloading (TSO)
75 VLAN tag stripping and inserting
79 10/100/1000Mbps operation in full-duplex mode
81 10/100Mbps operation in half-duplex mode
84 The following features are supported in the
86 driver for BCM5709 and BCM5716:
88 .Bl -item -offset indent -compact
90 Receive side scaling (RSS), up to 8 reception queues
92 Multiple tranmission queues, up to 8 transmission queues
97 For BCM5709 and BCM5716,
100 driver will try enabling as many reception and transmission queues
101 as are allowed by the number of CPUs in the system.
105 driver supports the following media types:
106 .Bl -tag -width ".Cm 10baseT/UTP"
108 Enable autoselection of the media type and options.
109 The user can manually override
110 the autoselected mode by adding media options to
113 Set 10Mbps operation.
117 option can also be used to select either
123 Set 100Mbps (Fast Ethernet) operation.
127 option can also be used to select either
133 Set 1000baseT operation over twisted pair.
141 driver supports the following media options:
142 .Bl -tag -width ".Cm full-duplex"
144 Force full duplex operation.
146 Force half duplex operation.
149 For more information on configuring this device, see
157 is the device unit number.
158 .Bl -tag -width ".Va hw.bceX.npoll.offset"
160 Maximum number of sending BDs which must be processed by the device
161 before the device updates the status block and generates interrupt.
162 It is used together with
164 to achieve TX interrupt moderation.
165 Default value is 255.
166 .It Va hw.bce.tx_bds_int
167 Maximum number of sending BDs which must be processed by the device
168 before the device updates the status block
169 during host interrupt processing.
170 Default value is 255.
171 .It Va hw.bce.tx_ticks
172 How often status block should be updated and interrupt should be generated
174 due to sending packets.
175 It is used together with
177 to achieve TX interrupt moderation.
178 Default value is 1022 (microseconds).
179 .It Va hw.bce.tx_ticks_int
180 How often status block should be updated by the device
181 during host interrupt processing,
182 due to sending packets.
183 Default value is 1022 (microseconds).
185 Maximum number of BDs which must be received by the device
186 before the device updates the status block and generates interrupt.
187 It is used together with
189 to achieve RX interrupt moderation.
191 .It Va hw.bce.rx_bds_int
192 Maximum number of BDs which must be received by the device
193 before the device updates the status block
194 during host interrupt processing.
195 Default value is 128.
196 .It Va hw.bce.rx_ticks
197 How often status block should be updated and interrupt should be generated
199 due to receiving packets.
200 It is used together with
202 to achieve RX interrupt moderation.
203 Default value is 150 (microseconds).
204 .It Va hw.bce.rx_ticks_int
205 How often status block should be updated by the device
206 during host interrupt processing,
207 due to receiving packets.
208 Default value is 150 (microseconds).
209 .It Va hw.bce.msi.enable Va hw.bceX.msi.enable
210 For BCM5706 and BCM5708,
212 the driver will use MSI if it is supported.
213 This behavior can be turned off by setting this tunable to 0.
214 .It Va hw.bceX.msi.cpu
215 If MSI is used, it specifies the MSI's target CPU.
216 .It Va hw.bce.msix.enable Va hw.bceX.msix.enable
217 For BCM5709 and BCM5716,
219 the driver will use MSI-X if it is supported.
220 This behavior can be turned off by setting this tunable to 0.
221 .It Va hw.bce.rx_pages Va hw.bceX.rx_pages
222 How many reception descriptor pages should be used.
223 One reception descriptor page holds 256 reception descriptors.
225 .It Va hw.bce.tx_pages Va hw.bceX.tx_pages
226 How many transmission descriptor pages should be used.
227 One transmission descriptor page holds 256 transmission descriptors.
229 .It Va hw.bceX.msix.offset
230 For BCM5709 and BCM5716,
232 this tunable specifies the leading target CPU for transmission and reception
234 The value specificed must be aligned to the number of reception queues
235 enabled and must be less than the power of 2 number of CPUs.
236 .It Va hw.bceX.npoll.offset
237 This tunable specifies the leading target CPU for transmission and reception
241 The value specificed must be aligned to the number of reception queues
242 enabled and must be less than the power of 2 number of CPUs.
243 .It Va hw.bce.rx_rings Va hw.bceX.rx_rings
244 For BCM5709 and BCM5716,
246 this tunable specifies the number of reception queues to be enabled.
247 Maximum allowed value for these tunables is 8 and
248 it must be power of 2 aligned.
249 Setting these tunables to 0 allows the driver to enable as many reception queues
250 as allowed by the number of CPUs.
251 .It Va hw.bce.tx_rings Va hw.bceX.tx_rings
252 For BCM5709 and BCM5716,
254 this tunable specifies the number of transmission queues to be enabled.
255 Maximum allowed value for these tunables is 8,
256 it must be power of 2 aligned
257 and it must be less than or equal to the number of reception queues enabled.
258 Setting these tunables to 0 allows the driver to enable as many transmission queues
259 as allowed by the number of CPUs and number reception queues enabled.
260 .It Va hw.bce.tx_wreg
261 The number of transmission descriptors should be setup before the hardware
263 Setting this value too high will have negative effect
264 on transmission timeliness.
265 Setting this value too low will hurt overall transmission due to the frequent
266 hardware register writing.
270 A number of per-interface variables are implemented in the
275 .Bl -tag -width "tx_ticks_int"
278 .Va hw.bce.tx_bds_int .
284 .Va hw.bce.tx_ticks_int .
287 .Va hw.bce.tx_ticks .
290 .Va hw.bce.rx_bds_int .
296 .Va hw.bce.rx_ticks_int .
299 .Va hw.bce.rx_ticks .
301 Number of reception queues actually enabled (read-only).
302 For BCM5709 and BCM5716,
304 the enabled reception queues will be one more than the
305 value specified in the tunable
308 .Va hw.bceX.rx_rings .
309 The extra reception queue is for the packets whose RSS hash
310 could not be calculated by the hardware.
312 Number of transmission queues enable (read-only).
313 For BCM5709 and BCM5716,
321 Number of reception descriptor pages enabled (read-only).
328 Number of transmission descriptor pages enabled (read-only).
339 reception and transmission queues' leading target CPU.
340 It has the same constraints as the tunable
341 .Va hw.bceX.npoll.offset .
342 The set value will take effect the next time
344 is enabled on the device.
346 Various hardware statistics.
361 device driver first appeared in
366 driver was written by
367 .An David Christensen Aq davidch@broadcom.com .
368 Sepherosa Ziehau added receive side scaling,
369 multiple transmission queues
370 and multiple vector MSI-X support to