xref: /freebsd/share/man/man4/bxe.4 (revision cc16dea626cf2fc80cde667ac4798065108e596c)
1.\" Copyright (c) 2012 Edward Tomasz Napierala <trasz@FreeBSD.org>
2.\" 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.\" 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 AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14.\" 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 AUTHORS OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd June 25, 2012
28.Dt BXE 4
29.Os
30.Sh NAME
31.Nm bxe
32.Nd "Broadcom BCM57710/BCM57711/BCM57711E 10Gb 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 bxe"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45if_bxe_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for PCIe 10GbE Ethernet adapters based on
51BCM5771x chips.
52The driver supports Jumbo Frames, VLAN tagging, IP, UDP and TCP checksum
53offload, MSI-X, TCP Segmentation Offload (TSO), Large Receive Offload (LRO),
54and Receive Side Steering (RSS).
55.Pp
56For more information on configuring this device, see
57.Xr ifconfig 8 .
58.Sh HARDWARE
59The
60.Nm
61driver provides support for various NICs based on the Broadcom BCM5771x
62family of 10GbE Ethernet controller chips, including the
63following:
64.Pp
65.Bl -bullet -compact
66.It
67Broadcom NetXtreme II BCM57710 10GbE
68.It
69Broadcom NetXtreme II BCM57711 10GbE
70.It
71Broadcom NetXtreme II BCM57711E 10GbE
72.El
73.Sh SYSCTL VARIABLES
74The following variables are available as both
75.Xr sysctl 8
76variables and
77.Xr loader 8
78tunables:
79.Bl -tag -width indent
80.It Va hw.bxe.dcc_enable
81Enable HP Flex-10 support.
82Allowed values are 0 to disable and 1 to enable.
83The default value is 0.
84.It Va hw.bxe.tso_enable
85Enable TCP Segmentation Offload.
86The default value is 1.
87.It Va hw.bxe.int_mode
88Set interrupt mode.
89Allowed values are 0 for IRQ, 1 for MSI/IRQ and 2 for MSI-X/MSI/IRQ.
90The default value is 2.
91.It Va hw.bxe.queue_count
92Specify the number of queues that will be used when a multi-queue
93RSS mode is selected using bxe_multi_mode.
94Allowed values are 0 for Auto or 1 to 16 for fixed number of queues.
95The default value is 0.
96.It Va hw.bxe.multi_mode
97Enable Receive Side Steering.
98Allowed values are 0, which disables all multi-queue/packet sorting
99algorithms, and 1, which assigns incoming frames to receive queues
100according to RSS.
101The default value is 0.
102.It Va hw.bxe.rx_ticks
103Control interrupt coalescing for received frames.
104The first frame always causes an interrupt, but subsequent frames
105are coalesced until the RX/TX ticks timer value expires and another
106interrupt occurs.
107The default value is 25.
108.It Va hw.bxe.tx_ticks
109Control interrupt coalescing for trasmitted frames.
110The first frame always causes an interrupt, but subsequent frames
111are coalesced until the RX/TX ticks timer value expires and another
112interrupt occurs.
113The default value is 50.
114.It Va hw.bxe.mrrs
115Allows to set the PCIe maximum read request size.
116Allowed values are -1 for Auto, 0 for 128B, 1 for 256B, 2 for 512B,
117and 3 for 1kB.
118The default value is -1.
119.El
120.Sh SEE ALSO
121.Xr altq 4 ,
122.Xr arp 4 ,
123.Xr netintro 4 ,
124.Xr ng_ether 4 ,
125.Xr vlan 4 ,
126.Xr ifconfig 8
127.Sh HISTORY
128The
129.Nm
130device driver first appeared in
131.Fx 9.0 .
132.Sh AUTHORS
133The
134.Nm
135driver was written by
136.An Gary Zambrano Aq zambrano@broadcom.com
137and
138.An David Christensen Aq davidch@broadcom.com .
139