man-pages/man4/smartpqi.4.html
2021-03-31 01:06:50 +01:00

471 lines
10 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SMARTPQI</TITLE>
</HEAD><BODY>
<H1>SMARTPQI</H1>
Section: Linux Programmer's Manual (4)<BR>Updated: 2019-10-10<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
smartpqi - Microsemi Smart Family SCSI driver
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
[<B>disable_device_id_wildcards=</B>{<B>0</B>|<B>1</B>}]
[<B>disable_heartbeat=</B>{<B>0</B>|<B>1</B>}]
[<B>disable_ctrl_shutdown=</B>{<B>0</B>|<B>1</B>}]
[<B>lockup_action=</B>{<B>none</B>|<B>reboot</B>|<B>panic</B>}]
[<B>expose_ld_first=</B>{<B>0</B>|<B>1</B>}]
[<B>hide_vsep=</B>{<B>0</B>|<B>1</B>}]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>smartpqi</B>
is a SCSI driver for Microsemi Smart Family controllers.
<A NAME="lbAE">&nbsp;</A>
<H3>Supported ioctl/() operations</H3>
For compatibility with applications written for the
<B><A HREF="/cgi-bin/man/man2html?4+cciss">cciss</A></B>(4)
and
<B><A HREF="/cgi-bin/man/man2html?4+hpsa">hpsa</A></B>(4)
drivers, many, but not all of the
<B><A HREF="/cgi-bin/man/man2html?2+ioctl">ioctl</A></B>(2)
operations supported by the
<B>hpsa</B>
driver are also supported by the
<B>smartpqi</B>
driver.
The data structures used by these operations
are described in the Linux kernel source file
<I>include/linux/cciss_ioctl.h</I>.
<DL COMPACT>
<DT id="1"><B>CCISS_DEREGDISK</B>, <B>CCISS_REGNEWDISK</B>, <B>CCISS_REGNEWD</B>
<DD>
These operations
all do exactly the same thing, which is to cause the driver to re-scan
for new devices.
This does exactly the same thing as writing to the
<B>smartpqi</B>-specific
host
<I>rescan</I>
attribute.
<DT id="2"><B>CCISS_GETPCIINFO</B>
<DD>
This operation Returns the PCI domain, bus,
device and function and &quot;board ID&quot; (PCI subsystem ID).
<DT id="3"><B>CCISS_GETDRIVVER</B>
<DD>
This operation returns the driver version in four bytes, encoded as:
<DT id="4"><DD>
(major_version &lt;&lt; 28) | (minor_version &lt;&lt; 24) |
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(release&nbsp;&lt;&lt;&nbsp;16)&nbsp;|&nbsp;revision
<DT id="5"><B>CCISS_PASSTHRU</B>
<DD>
Allows BMIC and CISS commands to be passed through to the controller.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H3>Boot options</H3>
<DL COMPACT>
<DT id="6"><B>disable_device_id_wildcards=</B>{<B>0</B>|<B>1</B>}
<DD>
Disables support for device ID wildcards.
The default value is 0.
<DT id="7"><B>disable_heartbeat=</B>{<B>0</B>|<B>1</B>}
<DD>
Disables support for the controller's heartbeat check.
This parameter is used for debugging purposes.
The default value is 0, leaving the controller's heartbeat check active.
<DT id="8"><B>disable_ctrl_shutdown=</B>{<B>0</B>|<B>1</B>}
<DD>
Disables support for shutting down the controller in the
event of a controller lockup.
The default value is 0.
<DT id="9"><B>lockup_action=</B>{<B>none</B>|<B>reboot</B>|<B>panic</B>}
<DD>
Specifies the action the driver takes when a controller
lockup is detected.
The default action is
<B>none</B>.
<TABLE>
<TR VALIGN=top><TD>parameter</TD><TD>action<BR></TD></TR>
<TR VALIGN=top><TD><B>none</B></TD></TR>
<TR VALIGN=top><TD><B>reboot</B></TD><TD>reboot the system<BR></TD></TR>
<TR VALIGN=top><TD><B>panic</B></TD><TD>panic the system<BR></TD></TR>
</TABLE>
<DT id="10"><B>expose_ld_first=</B>{<B>0</B>|<B>1</B>}
<DD>
This option enables support for exposing logical devices to
the operating system before physical devices.
The default value is 0.
<DT id="11"><B>hide_vsep=</B>{<B>0</B>|<B>1</B>}
<DD>
This option enables disabling exposure of the virtual SEP to the host.
This is usually associated with direct attached drives.
The default value is 0.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>FILES</H2>
<A NAME="lbAH">&nbsp;</A>
<H3>Device nodes</H3>
Logical drives are accessed via the SCSI disk driver
(<I>sd</I>),
tape drives via the SCSI tape driver
(<I>st</I>),
and the RAID controller via the SCSI generic driver
(<I>sg</I>),
with device nodes named
<I>/dev/sd</I>*,
<I>/dev/st</I>*,
and
<I>/dev/sg</I>*,
respectively.
<A NAME="lbAI">&nbsp;</A>
<H3>SmartPQI-specific host attribute files in /sys</H3>
<DL COMPACT>
<DT id="12"><I>/sys/class/scsi_host/host</I>*<I>/rescan</I>
<DD>
The host
<I>rescan</I>
attribute is a write-only attribute.
Writing to this attribute will cause the driver to scan for new,
changed, or removed devices (e.g., hot-plugged tape drives, or newly
configured or deleted logical drives) and notify the SCSI mid-layer of
any changes detected.
Usually this action is triggered automatically by configuration
changes, so the user should not normally have to write to this file.
Doing so may be useful when hot-plugging devices such as tape drives or
entire storage boxes containing pre-configured logical drives.
<DT id="13"><I>/sys/class/scsi_host/host</I>*<I>/version</I>
<DD>
The host
<I>version</I>
attribute is a read-only attribute.
This attribute contains the driver version and the controller firmware
version.
<DT id="14"><DD>
For example:
<DT id="15"><DD>
$ <B>cat /sys/class/scsi_host/host1/version</B>
driver: 1.1.2-126
firmware: 1.29-112
<DT id="16"><I>/sys/class/scsi_host/host</I>*<I>/lockup_action</I>
<DD>
The host
<I>lockup_action</I>
attribute is a read/write attribute.
This attribute will cause the driver to perform a specific action in the
unlikely event that a controller lockup has been detected.
See
<B>OPTIONS</B>
above
for an explanation of the
<I>lockup_action</I>
values.
<DT id="17"><I>/sys/class/scsi_host/host*/driver_version</I>
<DD>
The
<I>driver_version</I>
attribute is read-only.
This attribute contains the smartpqi driver version.
<DT id="18"><DD>
For example:
<DT id="19"><DD>
$ <B>cat /sys/class/scsi_host/host1/driver_version</B>
1.1.2-126
<DT id="20"><I>/sys/class/scsi_host/host*/firmware_version</I>
<DD>
The
<I>firmware_version</I>
attribute is read-only.
This attribute contains the controller firmware version.
<DT id="21"><DD>
For example:
<DT id="22"><DD>
$ <B>cat /sys/class/scsi_host/host1/firmware_version</B>
1.29-112
<DT id="23"><I>/sys/class/scsi_host/host*/model</I>
<DD>
The
<I>model</I>
attribute is read-only.
This attribute contains the product identification string of the controller.
<DT id="24"><DD>
For example:
<DT id="25"><DD>
$ <B>cat /sys/class/scsi_host/host1/model</B>
1100-16i
<DT id="26"><I>/sys/class/scsi_host/host*/serial_number</I>
<DD>
The
<I>serial_number</I>
attribute is read-only.
This attribute contains the unique identification number of the controller.
<DT id="27"><DD>
For example:
<DT id="28"><DD>
$ <B>cat /sys/class/scsi_host/host1/serial_number</B>
6A316373777
<DT id="29"><I>/sys/class/scsi_host/host*/vendor</I>
<DD>
The
<I>vendor</I>
attribute is read-only.
This attribute contains the vendor identification string of the controller.
<DT id="30"><DD>
For example:
<DT id="31"><DD>
$ <B>cat /sys/class/scsi_host/host1/vendor</B>
Adaptec
</DL>
<A NAME="lbAJ">&nbsp;</A>
<H3>SmartPQI-specific disk attribute files in /sys</H3>
In the file specifications below,
<I>c</I>
stands for the number of the appropriate SCSI controller,
<I>b</I>
is the bus number,
<I>t</I>
the target number, and
<I>l</I>
is the logical unit number (LUN).
<DL COMPACT>
<DT id="32"><I>/sys/class/scsi_disk/</I>c<I>:</I>b<I>:</I>t<I>:</I>l<I>/device/raid_level</I>
<DD>
The
<I>raid_level</I>
attribute is read-only.
This attribute contains the RAID level of each logical drive.
<DT id="33"><DD>
For example:
<DT id="34"><DD>
$ <B>cat /sys/class/scsi_disk/4:0:0:0/device/raid_level</B>
RAID 0
<DT id="35"><I>/sys/class/scsi_disk/c</I>:<I>b</I>:<I>t</I>:<I>l/device/sas_address</I>
<DD>
The
<I>sas_address</I>
attribute is read-only.
This attribute contains the unique identifier of the disk.
<DT id="36"><DD>
For example:
<DT id="37"><DD>
$ <B>cat /sys/class/scsi_disk/1:0:3:0/device/sas_address</B>
0x5001173d028543a2
<DT id="38"><I>/sys/class/scsi_disk/c</I>:<I>b</I>:<I>t</I>:<I>l/device/ssd_smart_path_enabled</I>
<DD>
The
<I>ssd_smart_path_enabled</I>
attribute is read-only.
This attribute is for ioaccel-enabled volumes.
(Ioaccel is an alternative driver submission path that allows the
driver to send I/O requests directly to backend SCSI devices,
bypassing the controller firmware.
This results in an increase in performance.
This method is used for HBA disks and for logical volumes comprised of SSDs.)
Contains 1 if ioaccel is enabled for the volume and 0 otherwise.
<DT id="39"><DD>
For example:
<DT id="40"><DD>
$ <B>cat /sys/class/scsi_disk/1:0:3:0/device/ssd_smart_path_enabled</B>
0
</DL>
<A NAME="lbAK">&nbsp;</A>
<H2>VERSIONS</H2>
The
<B>smartpqi</B>
driver was added in Linux 4.9.
<A NAME="lbAL">&nbsp;</A>
<H2>NOTES</H2>
<A NAME="lbAM">&nbsp;</A>
<H3>Configuration</H3>
To configure a Microsemi Smart Family controller,
refer to the User Guide for the controller,
which can be found by searching for the specific controller at
<A NAME="lbAN">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?4+cciss">cciss</A></B>(4),
<B><A HREF="/cgi-bin/man/man2html?4+hpsa">hpsa</A></B>(4),
<B><A HREF="/cgi-bin/man/man2html?4+sd">sd</A></B>(4),
<B><A HREF="/cgi-bin/man/man2html?4+st">st</A></B>(4)
<P>
<I>Documentation/ABI/testing/sysfs-bus-pci-devices-cciss</I>
in the Linux kernel source tree.
<A NAME="lbAO">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="41"><A HREF="#lbAB">NAME</A><DD>
<DT id="42"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="43"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DL>
<DT id="44"><A HREF="#lbAE">Supported ioctl/() operations</A><DD>
<DT id="45"><A HREF="#lbAF">Boot options</A><DD>
</DL>
<DT id="46"><A HREF="#lbAG">FILES</A><DD>
<DL>
<DT id="47"><A HREF="#lbAH">Device nodes</A><DD>
<DT id="48"><A HREF="#lbAI">SmartPQI-specific host attribute files in /sys</A><DD>
<DT id="49"><A HREF="#lbAJ">SmartPQI-specific disk attribute files in /sys</A><DD>
</DL>
<DT id="50"><A HREF="#lbAK">VERSIONS</A><DD>
<DT id="51"><A HREF="#lbAL">NOTES</A><DD>
<DL>
<DT id="52"><A HREF="#lbAM">Configuration</A><DD>
</DL>
<DT id="53"><A HREF="#lbAN">SEE ALSO</A><DD>
<DT id="54"><A HREF="#lbAO">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:02 GMT, March 31, 2021
</BODY>
</HTML>