xref: /freebsd/share/man/man4/bnxt_re.4 (revision 96190b4fef3b4a0cc3ca0606b0c4e3e69a5e6717)
1.\" Copyright (c) 2024 Broadcom, All rights reserved.
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.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.Dd May 15, 2024
25.Dt BNXT_RE 4
26.Os
27.Sh NAME
28.Nm bnxt_re
29.Nd "Broadcom NetXtreme-E RoCE driver"
30.Sh SYNOPSIS
31To compile this driver into the kernel,
32place these lines in your kernel configuration file:
33.Bd -ragged -offset indent
34.Cd "options COMPAT_LINUXKPI"
35.Cd "device bnxt"
36.Cd "device bnxt_re"
37.Ed
38.Pp
39To load the driver as a module at run-time,
40run this command as root:
41.Bd -literal -offset indent
42kldload bnxt_re
43.Ed
44.Pp
45To load the driver as a
46module at boot time, place this line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49bnxt_re_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver provides support for Remote Direct Memory Access (RDMA) over
55Converged Ethernet (RoCE) for Broadcom NetXtreme-E PCI Express network
56adapters.
57.Sh HARDWARE
58The
59.Nm
60driver provides support for NetXtreme-E BCM575xx 10/20/25/40/50/100/200Gb
61network adapters, including:
62.Pp
63.Bl -bullet -compact
64.It
65Broadcom BCM57502 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
66.It
67Broadcom BCM57504 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
68.It
69Broadcom BCM57508 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
70.El
71.Sh SUPPORT
72For general information and support,
73go to the Broadcom support website at:
74.Pa http://www.broadcom.com/ .
75.Pp
76Report driver issues with supported adapters to
77.Aq Mt freebsd.pdl@broadcom.com .
78.Sh SEE ALSO
79.Xr bnxt_re 4 ,
80.Xr ifconfig 8
81.Sh HISTORY
82The
83.Nm
84device driver first appeared in
85.Fx 15.0 .
86.Sh AUTHORS
87.An -nosplit
88The
89.Nm
90driver was written by
91.An Broadcom <freebsd.pdl@broadcom.com> .
92