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.\" $FreeBSD$ 28.\" 29.Dd April 25, 2023 30.Dt ISP 4 31.Os 32.Sh NAME 33.Nm isp 34.Nd Qlogic FibreChannel SCSI Host Adapters driver 35.Sh SYNOPSIS 36To compile this driver into the kernel, 37place the following lines in your 38kernel configuration file: 39.Bd -ragged -offset indent 40.Cd "device scbus" 41.Cd "device isp" 42.Cd "device ispfw" 43.Ed 44.Pp 45Alternatively, to load the driver as a 46module at boot time, place the following lines in 47.Xr loader.conf 5 : 48.Bd -literal -offset indent 49isp_load="YES" 50ispfw_load="YES" 51.Ed 52.Sh DESCRIPTION 53This driver provides access to 54.Tn FibreChannel 55SCSI devices. 56.Pp 57It supports initiator and target modes of FCP SCSI profile, 58utilizing Class 3 and Class 2 connections. 59Support is available for Public and Private loops, Point-to-Point 60and Fabric connections. 61.Pp 62Supported FC-Tape functionality is highly recommended for connections 63to tape drives that support it. 64It encompasses four elements from the T-10 FCP-4 specification: 65.Bl -bullet -offset indent 66.It 67Precise Delivery of Commands 68.It 69Confirmed Completion of FCP I/O Operations 70.It 71Retransmission of Unsuccessfully Transmitted IUs 72.It 73Task Retry Identification 74.El 75.Pp 76Together these features allow for link level error recovery with tape 77devices. 78Without it, an initiator cannot, for instance, tell whether a tape write 79command that has timed out resulted in all, part or none of the data going to 80the tape drive. 81FC-Tape is automatically enabled when connecting controller that supports 82it to a target that supports it. 83It may be disabled using configuration and hint options described below. 84.Sh FIRMWARE 85Firmware loading is supported if the 86.Xr ispfw 4 87module is loaded. 88It is strongly recommended that you use the firmware available from 89.Xr ispfw 4 90as it is the most likely to have been tested with this driver. 91.Sh HARDWARE 92Cards supported by the 93.Nm 94driver include: 95.Bl -tag -width xxxxxx -offset indent 96.It Qlogic 2422 97Optical 4Gb Fibre Channel PCI-X cards. 98.It Qlogic 246x (aka 2432) 99Optical 4Gb Fibre Channel PCIe cards. 100.It Qlogic 256x (aka 2532) 101Optical 8Gb Fibre Channel PCIe cards. 102.It Qlogic 267x/836x (aka 2031/8031) 103Optical 16Gb FC/FCoE PCIe cards. 104.It Qlogic 2690/2692/2694 (aka 2684/2692) 105Optical 16Gb Fibre Channel PCIe cards. 106.It Qlogic 2740/2742/2764 (aka 2722/2714) 107Optical 32Gb Fibre Channel PCIe cards. 108.It Qlogic QLE2770/QLE2772 (aka 2812) 109Optical 32Gb Fibre Channel PCIe cards. 110.It Qlogic QLE2774 (aka 2814) 111Optical 32Gb Fibre Channel PCIe cards. 112.It Qlogic QLE2870/QLE2872 (aka 2812) 113Optical 64Gb Fibre Channel PCIe cards. 114.It Qlogic QLE2874 (aka 2814) 115Optical 64Gb Fibre Channel PCIe cards. 116.El 117.Sh CONFIGURATION OPTIONS 118Target mode support for Fibre Channel adapters may be enabled with the 119.Pp 120.Cd options ISP_TARGET_MODE 121.Pp 122option. 123.Pp 124To disable FC-Tape, use the following configuration option: 125.Pp 126.Cd options ISP_FCTAPE_OFF 127.Pp 128Note that even if the ISP_FCTAPE_OFF option is used, it may be overridden 129by the fctape hint described below. 130.Sh BOOT OPTIONS 131The following options are switchable by setting values in 132.Pa /boot/device.hints . 133.Pp 134They are: 135.Bl -tag -width indent 136.It Va hint.isp. Ns Ar N Ns Va .msi 137Limit on number of Message Signaled Interrupts (MSI) to be used. 138.It Va hint.isp. Ns Ar N Ns Va .msix 139Limit on number of Extended Message Signaled Interrupts (MSI-X) to be used. 140.It Va hint.isp. Ns Ar N Ns Va .fwload_disable 141A hint value to disable loading of firmware 142.Xr ispfw 4 . 143.It Va hint.isp. Ns Ar N Ns Va .ignore_nvram 144A hint value to ignore board NVRAM settings for. 145Otherwise use NVRAM settings. 146.It Va hint.isp. Ns Ar N Ns Va .fullduplex 147A hint value to set full duplex mode. 148.It Va hint.isp. Ns Ar N Ns Va .topology 149A hint value to select topology of connection. 150Supported values are: 151.Pp 152.Bl -tag -width ".Li lport-only" -compact 153.It Li lport 154Prefer loopback and fallback to point to point. 155.It Li nport 156Prefer point to point and fallback to loopback. 157.It Li lport-only 158Loopback only. 159.It Li nport-only 160Point to point only. 161.El 162.It Va hint.isp. Ns Ar N Ns Va .portwwn 163This should be the full 64 bit World Wide Port Name you would like 164to use, overriding the value in NVRAM for the card. 165.It Va hint.isp. Ns Ar N Ns Va .nodewwn 166This should be the full 64 bit World Wide Node Name you would like 167to use, overriding the value in NVRAM for the card. 168.It Va hint.isp. Ns Ar N Ns Va .iid 169A hint to override or set the Initiator ID or Loop ID. 170For Fibre Channel 171cards in Local Loop topologies it is 172.Ar strongly 173recommended that you set this value to non-zero. 174.It Va hint.isp. Ns Ar N Ns Va .role 175A hint to define default role for isp instance (0 -- none, 1 -- target, 1762 -- initiator, 3 -- both). 177.It Va hint.isp. Ns Ar N Ns Va .debug 178A hint value for a driver debug level (see the file 179.Pa /usr/src/sys/dev/isp/ispvar.h 180for the values. 181.It Va hint.isp. Ns Ar N Ns Va .vports 182A hint to create specified number of additional virtual ports. 183.It Va hint.isp. Ns Ar N Ns Va .nofctape 184Set this to 1 to disable FC-Tape operation on the given isp instance. 185.It Va hint.isp. Ns Ar N Ns Va .fctape 186Set this to 1 to enable FC-Tape operation on the given isp instance for 187targets that support it. 188.El 189.Sh SYSCTL OPTIONS 190.Bl -tag -width indent 191.It Va dev.isp. Ns Ar N Ns Va .loop_down_limit 192This value says how long to wait in seconds after loop has gone down before 193giving up and expiring all of the devices that were visible. 194The default is 300 seconds (5 minutes). 195A separate (nonadjustable) timeout is used when 196booting to not stop booting on lack of FC connectivity. 197.It Va dev.isp. Ns Ar N Ns Va .gone_device_time 198This value says how long to wait for devices to reappear if they (temporarily) 199disappear due to loop or fabric events. 200While this timeout is running, I/O 201to those devices will simply be held. 202.It Va dev.isp. Ns Ar N Ns Va .use_gff_id 203.It Va dev.isp. Ns Ar N Ns Va .use_gft_id 204Setting those options to 0 allows to disable use of GFF_ID and GFT_ID SNS 205requests during FC fabric scan. 206It may be useful if switch does not implement them correctly, 207preventing some devices from being found. 208Disabling them may cause unneeded logins to ports not supporting target role 209or even FCP at all. 210The default is 1 (enabled). 211.It Va dev.isp. Ns Ar N Ns Va .wwnn 212This is the readonly World Wide Node Name value for this port. 213.It Va dev.isp. Ns Ar N Ns Va .wwpn 214This is the readonly World Wide Port Name value for this port. 215.El 216.Sh SEE ALSO 217.Xr da 4 , 218.Xr intro 4 , 219.Xr ispfw 4 , 220.Xr sa 4 , 221.Xr scsi 4 , 222.Xr gmultipath 8 223.Sh AUTHORS 224The 225.Nm 226driver was written by 227.An Matthew Jacob 228originally for NetBSD at NASA/Ames Research Center. 229Later improvement was done by 230.An Alexander Motin Aq Mt mav@FreeBSD.org . 231.Sh BUGS 232The driver currently ignores some NVRAM settings. 233