2 .\" Copyright (c) 2012 The DragonFly Project. 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
12 .\" the documentation and/or other materials provided with the
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\" contributors may be used to endorse or promote products derived
16 .\" from this software without specific, prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .Nd "Broadcom BCM57785/BCM5718 families 10/100/Gigabit Ethernet device"
41 Alternatively, to load the driver as a module at boot time, place the
43 .Pa /boot/loader.conf :
44 .Bd -literal -offset indent
50 driver supports the PCIe Ethernet adapters based on
51 Broadcom BCM57785/BCM5718 families chips.
53 The following features are supported in the
57 .Bl -item -offset indent -compact
59 IP/TCP/UDP checksum offloading
61 TCP segmentation offloading (TSO)
63 VLAN tag stripping and inserting
67 Receive Side Scaling (RSS),
68 up to 4 reception queues
72 Multiple transmission queues
74 BCM5719 and BCM5720 only),
75 up to 4 transmission queues
81 driver will try enabling as many reception queues as are allowed
82 by the number of CPUs in the system.
85 in addition to the reception queues,
89 driver will try enabling as many transmission queues as are allowed
90 by the number of CPUs in the system
91 and the number of enabled reception queues.
92 If multiple transmission queues are enabled,
93 the round-robin arbitration is performed among the transmission queues.
94 It should be noted that
95 if both TSO and multiple transmission queues are enabled,
96 the round-robin arbitration between transmission queues is done
97 at the TSO packet boundary.
101 driver supports the following
105 .Bl -tag -width 10baseT/UTP -compact
107 Enable autoselection of the media types and options
110 Set 10Mbps operation.
113 option can also be used to select either
120 Set 100Mbps (Fast Ethernet) operation.
123 option can also be used to select either
130 Set 1000Mbps (Gigabit Ethernet) operation.
133 option can only be set
140 driver supports the following
144 .Bl -tag -width full-duplex -compact
146 Force full duplex operation.
149 Force half duplex operation.
152 Note that the 1000baseT media type is only available
153 if it is supported by the adapter.
154 For more information on configuring this device,
164 driver supports Gigabit Ethernet adapters and Fast Ethernet adapters based on
165 the Broadcom BCM57785/BCM5718 families chips:
169 Broadcom BCM5717 Gigabit Ethernet
171 Broadcom BCM5717C Gigabit Ethernet
173 Broadcom BCM5718 Gigabit Ethernet
175 Broadcom BCM5719 Gigabit Ethernet
177 Broadcom BCM5720 Gigabit Ethernet
179 Broadcom BCM5725 Gigabit Ethernet
181 Broadcom BCM5727 Gigabit Ethernet
183 Broadcom BCM5762 Gigabit Ethernet
185 Broadcom BCM57761 Gigabit Ethernet
187 Broadcom BCM57762 Gigabit Ethernet
189 Broadcom BCM57765 Gigabit Ethernet
191 Broadcom BCM57766 Gigabit Ethernet
193 Broadcom BCM57781 Gigabit Ethernet
195 Broadcom BCM57782 Gigabit Ethernet
197 Broadcom BCM57785 Gigabit Ethernet
199 Broadcom BCM57786 Gigabit Ethernet
201 Broadcom BCM57791 Fast Ethernet
203 Broadcom BCM57795 Fast Ethernet
207 is the device unit number.
208 .Bl -tag -width ".Va hw.bnxX.npoll.offset"
209 .It Va hw.bnx.rx_rings Va hw.bnxX.rx_rings
211 this tunable specifies the number of reception queues to be enabled.
212 Maximum allowed value for these tunables is 4 and
213 it must be power of 2 aligned.
214 Setting these tunables to 0 allows the driver to enable as many reception queues
215 as allowed by the number of CPUs.
216 .It Va hw.bnx.tx_rings Va hw.bnxX.tx_rings
220 this tunable specifies the number of transmission queues to be enabled.
221 Maximum allowed value for these tunables is 4,
222 it must be power of 2 aligned
223 and it must be less than or equal to the number of reception queues enabled.
224 Setting these tunables to 0 allows the driver to enable as many transmission queues
225 as allowed by the number of CPUs and number reception queues enabled.
226 .It Va hw.bnx.msix.enable Va hw.bnxX.msix.enable
228 the driver will use MSI-X
230 This behaviour can be turned off by setting this tunable to 0.
231 .It Va hw.bnxX.msix.offset
234 if more than 1 reception queues
235 and more than 1 transmission queues are enabled,
236 this tunable specifies the leading target CPU for transmission
237 and reception queues processing.
238 The value specificed must be aligned to the number of reception queues
239 enabled and must be less than the power of 2 number of CPUs.
240 .It Va hw.bnxX.msix.txoff
241 If more than 1 reception queues are enabled
242 and only 1 transmission queue is enabled,
243 this tunable specifies the target CPU for transmission queue processing.
244 The value specificed must be less than the power of 2 number of CPUs.
245 .It Va hw.bnxX.msix.rxoff
246 If more than 1 reception queues are enabled
247 and only 1 transmission queue is enabled,
248 this tunable specifies the leading target CPU for reception queues processing.
249 The value specificed must be aligned to the number of reception queues
250 enabled and must be less than the power of 2 number of CPUs.
251 .It Va hw.bnx.msi.enable Va hw.bnxX.msi.enable
252 If MSI-X is disabled and MSI is supported,
253 the driver will use MSI.
254 This behavior can be turned off by setting this tunable to 0.
255 .It Va hw.bnxX.msi.cpu
256 If MSI is used, it specifies the MSI's target CPU.
257 .It Va hw.bnxX.npoll.offset
258 If only 1 reception queue and only 1 transmission queue are enabled
259 or more than 1 reception queues and more than 1 transmission queues are enabled,
260 this tunable specifies the leading target CPU for transmission and reception
264 The value specificed must be aligned to the number of reception queues
265 enabled and must be less than the power of 2 number of CPUs.
266 .It Va hw.bnxX.npoll.txoff
267 If more than 1 reception queues are enabled
268 and only 1 transmission queue is enabled,
269 this tunable specifies the target CPU for transmission queue
272 The value specificed must be less than the power of 2 number of CPUs.
273 .It Va hw.bnxX.npoll.rxoff
274 If more than 1 reception queues are enabled
275 and only 1 transmission queue is enabled,
276 this tunable specifies the leading target CPU for reception queue
279 The value specificed must be aligned to the number of reception queues
280 enabled and must be less than the power of 2 number of CPUs.
283 A number of per-interface variables are implemented in the
288 .Bl -tag -width "rx_coal_bds_poll"
290 Number of reception queues enabled (read-only).
297 Number of transmission queues enabled (read-only).
304 How often status block should be updated and interrupt should be generated
306 due to receiving packets.
307 It is used together with
309 to achieve RX interrupt moderation.
310 Default value is 150 (microseconds).
312 How often status block should be updated and interrupt should be generated
314 due to sending packets.
315 It is used together with
317 to achieve TX interrupt moderation.
318 Default value is 1023 (microseconds).
320 Maximum number of BDs which must be received by the device
321 before the device updates the status block and generates interrupt.
322 It is used together with
324 to achieve RX interrupt moderation.
325 Default value is 0 (disabled).
326 .It Va rx_coal_bds_poll
327 Maximum number of BDs which must be received by the device
328 before the device updates the status block during
330 It is used together with
332 to reduce the frequency of status block updating due to RX.
335 Maximum number of sending BDs which must be processed by the device
336 before the device updates the status block and generates interrupt.
337 It is used together with
339 to achieve TX interrupt moderation.
340 Default value is 128.
341 .It Va tx_coal_bds_poll
342 Maximum number of sending BDs which must be processed by the device
343 before the device updates the status block during
345 It is used together with
347 to reduce the frequency of status block updating due to TX.
350 Force defragment the sending mbuf chains,
351 if the mbuf chain is not a TSO segment and contains more than 1 mbufs.
352 This improves transmission performance on certain low end chips,
354 this also increases CPU load.
355 Default value is 0 (disabled).
357 The number of transmission descriptors should be setup before the hardware
359 Setting this value too high will have negative effect
360 on transmission timeliness.
361 Setting this value too low will hurt overall transmission performance
362 due to the frequent hardware register writing.
365 Number of packets should be received
366 before the standard reception producer ring is refilled.
367 Setting this value too low will cause extra thread scheduling cost.
368 Setting this value too high will make chip drop incoming packets.
369 Default value is 128 / number of reception queues.
370 .It Va rx_coal_bds_int
371 Maximum number of BDs which must be received by the device
372 before the device updates the status block
373 during host interrupt processing.
375 .It Va tx_coal_bds_int
376 Maximum number of sending BDs which must be processed by the device
377 before the device updates the status block
378 during host interrupt processing.
382 .Va hw.bnxX.npoll.offset .
383 The set value will take effect the next time
385 is enabled on the device.
388 .Va hw.bnxX.npoll.txoff .
389 The set value will take effect the next time
391 is enabled on the device.
394 .Va hw.bnxX.npoll.rxoff .
395 The set value will take effect the next time
397 is enabled on the device.
399 Number of times the standard reception producer ring is short
401 If this value grows fast,
402 it is usually an indication that
406 Number of errors, both critical and non-critical, happened.
421 device driver first appeared in
430 .An Bill Paul Aq Mt wpaul@windriver.com .
432 added receive side scaling,
433 multiple transmission queues
434 and multiple MSI-X support to