1.\" Copyright (c) 2009-2020 Alexander Motin <mav@FreeBSD.org> 2.\" Copyright (c) 2006 Marcus Alves Grando 3.\" Copyright (c) 1998-2001 Matthew Jacob, for NASA/Ames Research Center 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. The name of the author may not be used to endorse or promote products 14.\" derived from this software without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.Dd December 10, 2024 28.Dt ISP 4 29.Os 30.Sh NAME 31.Nm isp 32.Nd Qlogic FibreChannel SCSI Host Adapters driver 33.Sh SYNOPSIS 34To compile this driver into the kernel, 35place the following lines in your 36kernel configuration file: 37.Bd -ragged -offset indent 38.Cd "device scbus" 39.Cd "device isp" 40.Cd "device ispfw" 41.Ed 42.Pp 43Alternatively, to load the driver as a 44module at boot time, place the following lines in 45.Xr loader.conf 5 : 46.Bd -literal -offset indent 47isp_load="YES" 48ispfw_load="YES" 49.Ed 50.Sh DESCRIPTION 51This driver provides access to 52.Tn FibreChannel 53SCSI devices. 54.Pp 55It supports initiator and target modes of FCP SCSI profile, 56utilizing Class 3 and Class 2 connections. 57Support is available for Public and Private loops, Point-to-Point 58and Fabric connections. 59.Pp 60Supported FC-Tape functionality is highly recommended for connections 61to tape drives that support it. 62It encompasses four elements from the T-10 FCP-4 specification: 63.Bl -bullet -offset indent 64.It 65Precise Delivery of Commands 66.It 67Confirmed Completion of FCP I/O Operations 68.It 69Retransmission of Unsuccessfully Transmitted IUs 70.It 71Task Retry Identification 72.El 73.Pp 74Together these features allow for link level error recovery with tape 75devices. 76Without it, an initiator cannot, for instance, tell whether a tape write 77command that has timed out resulted in all, part or none of the data going to 78the tape drive. 79FC-Tape is automatically enabled when connecting controller that supports 80it to a target that supports it. 81It may be disabled using configuration and hint options described below. 82.Sh FIRMWARE 83Firmware loading is supported and handled by 84.Xr firmware 9 . 85The correct firmware is either loaded automatically, if available for this 86type of adapter, or by manually loading the 87.Xr ispfw 4 88module. 89It is strongly recommended that you use the firmware available from 90.Xr ispfw 4 91as it is the one that most likely has been tested with this driver. 92.Sh HARDWARE 93Cards supported by the 94.Nm 95driver include: 96.Bl -tag -width xxxxxx -offset indent 97.It Qlogic 2422 98Optical 4Gb Fibre Channel PCI-X cards. 99.It Qlogic 246x (aka 2432) 100Optical 4Gb Fibre Channel PCIe cards. 101.It Qlogic 256x (aka 2532) 102Optical 8Gb Fibre Channel PCIe cards. 103.It Qlogic 267x/836x (aka 2031/8031) 104Optical 16Gb FC/FCoE PCIe cards. 105.It Qlogic 2690/2692/2694 (aka 2684/2692) 106Optical 16Gb Fibre Channel PCIe cards. 107.It Qlogic 2740/2742/2764 (aka 2722/2714) 108Optical 32Gb Fibre Channel PCIe cards. 109.It Qlogic QLE2770/QLE2772 (aka 2812) 110Optical 32Gb Fibre Channel PCIe cards. 111.It Qlogic QLE2774 (aka 2814) 112Optical 32Gb Fibre Channel PCIe cards. 113.It Qlogic QLE2870/QLE2872 (aka 2812) 114Optical 64Gb Fibre Channel PCIe cards. 115.It Qlogic QLE2874 (aka 2814) 116Optical 64Gb Fibre Channel PCIe cards. 117.El 118.Sh CONFIGURATION OPTIONS 119Target mode support for Fibre Channel adapters may be enabled with the 120.Pp 121.Cd options ISP_TARGET_MODE 122.Pp 123option. 124.Pp 125To disable FC-Tape, use the following configuration option: 126.Pp 127.Cd options ISP_FCTAPE_OFF 128.Pp 129Note that even if the ISP_FCTAPE_OFF option is used, it may be overridden 130by the fctape hint described below. 131.Sh BOOT OPTIONS 132The following options are switchable by setting values in 133.Pa /boot/device.hints . 134.Pp 135They are: 136.Bl -tag -width indent 137.It Va hint.isp. Ns Ar N Ns Va .msi 138Limit on number of Message Signaled Interrupts (MSI) to be used. 139.It Va hint.isp. Ns Ar N Ns Va .msix 140Limit on number of Extended Message Signaled Interrupts (MSI-X) to be used. 141.It Va hint.isp. Ns Ar N Ns Va .fwload_disable 142A hint value to disable loading of firmware provided by 143.Xr ispfw 4 . 144.It Va hint.isp. Ns Ar N Ns Va .fwload_force 145A hint value to prefer firmware provided by 146.Xr ispfw 4 , 147even if it is older than the firmware in flash on the board. 148If fwload_disable is also specified, fwload_force will be ignored. 149.Pp 150By default, with 27XX and newer controllers, the 151.Xr isp 4 152driver will use the newer 153firmware. 154For older controllers, the 155.Xr isp 4 156driver will use the firmware provided by 157.Xr ispfw 4 158if it is available, and otherwise use the firmware in flash on the board. 159.It Va hint.isp. Ns Ar N Ns Va .ignore_nvram 160A hint value to ignore board NVRAM settings for. 161Otherwise use NVRAM settings. 162.It Va hint.isp. Ns Ar N Ns Va .fullduplex 163A hint value to set full duplex mode. 164.It Va hint.isp. Ns Ar N Ns Va .topology 165A hint value to select topology of connection. 166Supported values are: 167.Pp 168.Bl -tag -width ".Li lport-only" -compact 169.It Li lport 170Prefer arbitrated loop and fallback to point to point. 171.It Li nport 172Prefer point to point and fallback to arbitrated loop. 173.It Li lport-only 174Arbitrated loop only. 175.It Li nport-only 176Point to point only. 177.El 178.It Va hint.isp. Ns Ar N Ns Va .portwwn 179This should be the full 64 bit World Wide Port Name you would like 180to use, overriding the value in NVRAM for the card. 181.It Va hint.isp. Ns Ar N Ns Va .nodewwn 182This should be the full 64 bit World Wide Node Name you would like 183to use, overriding the value in NVRAM for the card. 184.It Va hint.isp. Ns Ar N Ns Va .iid 185A hint to override or set the Initiator ID or Loop ID. 186For Fibre Channel 187cards in Local Loop topologies it is 188.Ar strongly 189recommended that you set this value to non-zero. 190.It Va hint.isp. Ns Ar N Ns Va .role 191A hint to define default role for isp instance (0 -- none, 1 -- target, 1922 -- initiator, 3 -- both). 193.It Va hint.isp. Ns Ar N Ns Va .debug 194A hint value for a driver debug level (see the file 195.Pa /usr/src/sys/dev/isp/ispvar.h 196for the values. 197.It Va hint.isp. Ns Ar N Ns Va .vports 198A hint to create specified number of additional virtual ports. 199.It Va hint.isp. Ns Ar N Ns Va .nofctape 200Set this to 1 to disable FC-Tape operation on the given isp instance. 201.It Va hint.isp. Ns Ar N Ns Va .fctape 202Set this to 1 to enable FC-Tape operation on the given isp instance for 203targets that support it. 204.El 205.Sh SYSCTL OPTIONS 206.Bl -tag -width indent 207.It Va dev.isp. Ns Ar N Ns Va .loop_down_limit 208This value says how long to wait in seconds after loop has gone down before 209giving up and expiring all of the devices that were visible. 210The default is 300 seconds (5 minutes). 211A separate (nonadjustable) timeout is used when 212booting to not stop booting on lack of FC connectivity. 213.It Va dev.isp. Ns Ar N Ns Va .gone_device_time 214This value says how long to wait for devices to reappear if they (temporarily) 215disappear due to loop or fabric events. 216While this timeout is running, I/O 217to those devices will simply be held. 218.It Va dev.isp. Ns Ar N Ns Va .use_gff_id 219.It Va dev.isp. Ns Ar N Ns Va .use_gft_id 220Setting those options to 0 allows to disable use of GFF_ID and GFT_ID SNS 221requests during FC fabric scan. 222It may be useful if switch does not implement them correctly, 223preventing some devices from being found. 224Disabling them may cause unneeded logins to ports not supporting target role 225or even FCP at all. 226The default is 1 (enabled). 227.It Va dev.isp. Ns Ar N Ns Va .wwnn 228This is the readonly World Wide Node Name value for this port. 229.It Va dev.isp. Ns Ar N Ns Va .wwpn 230This is the readonly World Wide Port Name value for this port. 231.It Va dev.isp. Ns Ar N Ns Va .fw_version_flash 232The readonly flash firmware version value in the active region of the 233controller. 234.It Va dev.isp. Ns Ar N Ns Va .fw_version_ispfw 235The readonly firmware version value provided by 236.Xr ispfw 4 . 237.It Va dev.isp. Ns Ar N Ns Va .fw_version_run 238The readonly firmware version value currently executed on the controller. 239.El 240.Sh SEE ALSO 241.Xr da 4 , 242.Xr intro 4 , 243.Xr ispfw 4 , 244.Xr sa 4 , 245.Xr scsi 4 , 246.Xr gmultipath 8 247.Sh AUTHORS 248The 249.Nm 250driver was written by 251.An Matthew Jacob 252originally for NetBSD at NASA/Ames Research Center. 253Later improvement was done by 254.An Alexander Motin Aq Mt mav@FreeBSD.org . 255.Sh BUGS 256The driver currently ignores some NVRAM settings. 257