bnxt_re/bnxt_en: man page support for bnxt_re driver

Added new man page support for bnxt_re driver.
Updated existing bnxt ethernet driver man page with new controllers support.

Reviewed by:            markj
Approved by:            imp
Differential revision:  https://reviews.freebsd.org/D45203
This commit is contained in:
Chandrakanth Patil
2024-07-09 11:02:01 +00:00
committed by Sumit Saxena
parent a970610a3a
commit e213cdb4a2
2 changed files with 98 additions and 1 deletions
+7 -1
View File
@@ -48,7 +48,7 @@ if_bnxt_load="YES"
The
.Nm
driver provides support for various NICs based on the Broadcom BCM57301/2/4,
and BCM57402/4/6 Ethernet controller chips.
BCM57402/4/6, and BCM57502/4/8 Ethernet controller chips.
.Pp
For more information on configuring this device, see
.Xr ifconfig 8 .
@@ -102,6 +102,12 @@ Broadcom BCM57416 NetXtreme-E Partition
Broadcom BCM57417 NetXtreme-E Ethernet Partition
.It
Broadcom BCM57454 NetXtreme-E 10Gb/25Gb/40Gb/50Gb/100Gb Ethernet
.It
Broadcom BCM57502 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
.It
Broadcom BCM57504 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
.It
Broadcom BCM57508 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
.El
.Sh SYSCTL VARIABLES
These variables must be set before loading the driver, either via
+91
View File
@@ -0,0 +1,91 @@
.\" Copyright (c) 2024 Broadcom, All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd May 15, 2024
.Dt BNXT_RE 4
.Os
.Sh NAME
.Nm bnxt_re
.Nd "Broadcom NetXtreme-E RoCE driver"
.Sh SYNOPSIS
To compile this driver into the kernel,
place these lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "options COMPAT_LINUXKPI"
.Cd "device bnxt"
.Cd "device bnxt_re"
.Ed
.Pp
To load the driver as a module at run-time,
run this command as root:
.Bd -literal -offset indent
kldload bnxt_re
.Ed
.Pp
To load the driver as a
module at boot time, place this line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
bnxt_re_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides support for Remote Direct Memory Access (RDMA) over
Converged Ethernet (RoCE) for Broadcom NetXtreme-E PCI Express network
adapters.
.Sh HARDWARE
The
.Nm
driver provides support for NetXtreme-E BCM575xx 10/20/25/40/50/100/200Gb
network adapters, including:
.Pp
.Bl -bullet -compact
.It
Broadcom BCM57502 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
.It
Broadcom BCM57504 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
.It
Broadcom BCM57508 NetXtreme-E 10Gb/25Gb/50Gb/100Gb/200Gb Ethernet
.El
.Sh SUPPORT
For general information and support,
go to the Broadcom support website at:
.Pa http://www.broadcom.com/ .
.Pp
Report driver issues with supported adapters to
.Aq Mt freebsd.pdl@broadcom.com .
.Sh SEE ALSO
.Xr bnxt_re 4 ,
.Xr ifconfig 8
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 15.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Broadcom <freebsd.pdl@broadcom.com> .