git: e27c618e20cd - main - mpi3mr: Add bare-bones manual

From: Warner Losh <imp_at_FreeBSD.org>
Date: Thu, 15 Jun 2023 15:13:29 UTC
The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=e27c618e20cd4055c295c4e867c4782a0e3a8763

commit e27c618e20cd4055c295c4e867c4782a0e3a8763
Author:     Warner Losh <imp@FreeBSD.org>
AuthorDate: 2023-06-14 22:12:28 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2023-06-15 15:03:41 +0000

    mpi3mr: Add bare-bones manual
    
    The mpi3mr driver is written by Broadcom for the 9600 Series 24G PCIe
    4.0 Tri-Mode RAID Adapters and eHBAs boards. This is 3rd-Generation
    Tri-Mode x8 and x16 NVMe/SAS/SATA (although Broadcom/Avago did muddy the
    waters by having multiple 2nd generations cards and referring to them
    inconsistently).
    
    Sponsored by:           Netflix
---
 share/man/man4/Makefile |  1 +
 share/man/man4/mpi3mr.4 | 81 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+)

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 2567cde793ee..d42f77461805 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -320,6 +320,7 @@ MAN=	aac.4 \
 	mod_cc.4 \
 	mos.4 \
 	mouse.4 \
+	mpi3mr.4 \
 	mpr.4 \
 	mps.4 \
 	mpt.4 \
diff --git a/share/man/man4/mpi3mr.4 b/share/man/man4/mpi3mr.4
new file mode 100644
index 000000000000..981979e37187
--- /dev/null
+++ b/share/man/man4/mpi3mr.4
@@ -0,0 +1,81 @@
+.\"
+.\" Copyright (c) 2023 Netflix, Inc
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.\" mpi3mr driver man page.
+.\"
+.Dd June 14, 2023
+.Dt MPI3MR 4
+.Os
+.Sh NAME
+.Nm mpi3mr
+.Nd "Broadcom MPIMR 3.0 IT/IR 24Gb/s SAS Tri-Mode RAID PCIe 4.0 driver"
+.Sh SYNOPSIS
+.\" To compile this driver into the kernel, place these lines in the kernel
+.\" configuration file:
+.\" .Bd -ragged -offset indent
+.\" .Cd "device pci"
+.\" .Cd "device scbus"
+.\" .Cd "device mpi3mr"
+.\" .Ed
+.\" .Pp
+The driver can be loaded as a module at boot time by placing this line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+mpi3mr_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for Broadcom Ltd. MPIMR 3.0 IT/IR PCIe 4 controller.
+.Sh HARDWARE
+These controllers are supported by the
+.Nm
+driver:
+.Pp
+.Bl -bullet -compact
+.It
+Broadcom Ltd. SAS 4116 Tri-Mode RAID Adapter
+.It
+Broadcom Ltd. 9670W-16i 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9670-24i 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9660-16i 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9620-16i 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9600-24i 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9600-16i 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9600W-16e 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9600-16e 24G PCIe 4.0 Tri-Mode RAID Adapters
+.It
+Broadcom Ltd. 9600-8i8e 24G PCIe 4.0 Tri-Mode RAID Adapters
+.El
+.Sh SEE ALSO
+.Xr cam 4 ,
+.Xr cd 4 ,
+.Xr ch 4 ,
+.Xr da 4 ,
+.Xr mpr 4 ,
+.Xr pci 4 ,
+.Xr sa 4 ,
+.Xr scsi 4 .
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Fx 14.0 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Sumit Saxena Aq Mt sumit.saxena@broadcom.com ,
+and
+.An Chandrakanth Patil Aq Mt chandrakanth.patil@broadcom.com .
+This manual page was written by
+.An Warner Losh Aq Mt imp@FreeBSD.org .