xref: /freebsd/share/man/man4/smartpqi.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1.\" Copyright (C) 2019-2023, Microchip Technology Inc. and its subsidiaries
2.\" Copyright (C) 2016-2018, Microsemi Corporation
3.\" Copyright (C) 2016, PMC-Sierra, Inc.
4.\" Written by John Hall <john.hall@microchip.com>
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd August 24, 2023
28.Dt SMARTPQI 4
29.Os
30.Sh NAME
31.Nm smartpqi
32.Nd "Microchip Smart Storage SCSI driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel, place these lines in the kernel
35configuration file:
36.Bd -ragged -offset indent
37.Cd device pci
38.Cd device scbus
39.Cd device smartpqi
40.Ed
41.Pp
42The driver can be loaded as a module at boot time by placing this line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45smartpqi_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for Microchip Technology Inc. / Adaptec SmartRaid and
51SmartHBA SATA/SAS/NVME PCIe controllers
52.Sh HARDWARE
53Controllers supported by the
54.Nm
55driver include, but not limited to:
56.Pp
57.Bl -bullet -compact
58.It
59HPE Gen10 Smart Array Controller Family
60.It
61Adaptec SmartRaid and SmartHBA Controllers
62.It
63OEM Controllers based on the Microchip Technology Inc. SmartROC
64and SmartIOC Chipsets
65.El
66.Sh FILES
67.Bl -tag -width /boot/kernel/smartpqi.ko -compact
68.It Pa /dev/smartpqi?
69smartpqi management interface
70.El
71.Sh NOTES
72.Ss Configuration
73To configure a Microchip Smart Storage controller,
74refer to the User Guide for the controller,
75which can be found by searching for the specific controller at
76https://www.microchip.com/design-centers/storage
77.Sh SEE ALSO
78.Xr kld 4 ,
79.Xr linux 4 ,
80.Xr pass 4 ,
81.Xr scsi 4 ,
82.Xr xpt 4 ,
83.Xr loader.conf 5 ,
84.Xr camcontrol 8 ,
85.Xr kldload 8
86.Sh HISTORY
87The
88.Nm
89driver first appeared in
90.Fx 11.1 .
91.Sh AUTHORS
92.An John Hall
93.Aq john.hall@microchip.com
94.Sh BUGS
95The controller is not actually paused on suspend/resume.
96