1.\" Copyright (c) 2009-2018 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 February 27, 2018 30.Dt ISP 4 31.Os 32.Sh NAME 33.Nm isp 34.Nd Qlogic based SPI and FibreChannel SCSI Host Adapters 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 SPI 55or 56.Tn FibreChannel 57SCSI devices. 58.Pp 59SPI supports initiator mode for Ultra SCSI and wide mode transactions for 60.Tn SCSI , 61Ultra2 LVD (1080, 1280), and Ultra3 LVD (10160, 12160). 62.Pp 63Fibre Channel supports initiator and target modes of FCP SCSI profile, 64utilizing Class 3 and Class 2 (2200 and later) connections. 65Support is available for Public and Private loops, Point-to-Point 66and Fabric connections. 67.Pp 68FC-Tape is supported on 4Gb (2400) and newer controllers. 69FC-Tape is highly recommended for connections to tape drives that support 70it. 71It encompasses four elements from the T-10 FCP-4 specification: 72.Bl -bullet -offset indent 73.It 74Precise Delivery of Commands 75.It 76Confirmed Completion of FCP I/O Operations 77.It 78Retransmission of Unsuccessfully Transmitted IUs 79.It 80Task Retry Identification 81.El 82.Pp 83Together these features allow for link level error recovery with tape 84devices. 85Without it, an initiator cannot, for instance, tell whether a tape write 86command that has timed out resulted in all, part or none of the data going to 87the tape drive. 88FC-Tape is automatically enabled when connecting controller that supports 89it to a target that supports it. 90It may be disabled using configuration and hint options described below. 91.Sh FIRMWARE 92Firmware loading is supported if the 93.Xr ispfw 4 94module is loaded. 95It is strongly recommended that you use the firmware available from 96.Xr ispfw 4 97as it is the most likely to have been tested with this driver. 98.Sh HARDWARE 99Cards supported by the 100.Nm 101driver include: 102.Bl -tag -width xxxxxx -offset indent 103.It Qlogic 1000 104Fast Wide, Ultra Fast Wide cards, Single Ended or Differential SBus cards. 105.It Qlogic 1020 106Fast Wide and Differential Fast Wide SCSI PCI cards. 107.It Qlogic 1040 108Ultra Wide and Differential Ultra Wide SCSI PCI cards. 109Also known as the DEC KZPBA-CA (single ended) and KZPBA-CB (HVD differential). 110.It Qlogic 1080 111LVD Ultra2 Wide SCSI PCI cards. 112.It Qlogic 10160 113LVD Ultra3 Wide SCSI PCI cards. 114.It Qlogic 1240 115Dual Bus Ultra Wide and Differential Ultra Wide SCSI PCI cards. 116.It Qlogic 1280 117Dual Bus LVD Ultra2 Wide SCSI PCI cards. 118.It Qlogic 12160 119Dual Bus LVD Ultra3 Wide SCSI PCI cards. 120.It Qlogic 210X 121Copper and Optical Fibre Channel Arbitrated Loop PCI cards (single, dual). 122.It Qlogic 220X 123Copper and Optical Fibre Channel Arbitrated Loop PCI cards (single, dual, quad). 124.It Qlogic 2300 125Optical 2Gb Fibre Channel PCI cards. 126.It Qlogic 2312 127Optical 2Gb Fibre Channel PCI cards. 128.It Qlogic 234X 129Optical 2Gb Fibre Channel PCI cards (2312 chipset, single and dual attach). 130.It Qlogic 2322 131Optical 2Gb Fibre Channel PCIe cards. 132.It Qlogic 200 133Dell branded version of the QLogic 2312. 134.It Qlogic 2422 135Optical 4Gb Fibre Channel PCI cards. 136.It Qlogic 246x (aka 2432) 137Optical 4Gb Fibre Channel PCIe cards. 138.It Qlogic 256x (aka 2532) 139Optical 8Gb Fibre Channel PCIe cards. 140.It Qlogic 267x/836x (aka 2031/8031) 141Optical 16Gb FC/FCoE PCIe cards. 142.It Qlogic 2690/2692/2694 (aka 2684/2692) 143Optical 16Gb Fibre Channel PCIe cards. 144.It Qlogic 2740/2742/2764 (aka 2722/2714) 145Optical 32Gb Fibre Channel PCIe cards. 146.El 147.Sh CONFIGURATION OPTIONS 148Target mode support for Fibre Channel adapters may be enabled with the 149.Pp 150.Cd options ISP_TARGET_MODE 151.Pp 152option. 153.Pp 154To disable FC-Tape, use the following configuration option: 155.Pp 156.Cd options ISP_FCTAPE_OFF 157.Pp 158Note that even if the ISP_FCTAPE_OFF option is used, it may be overridden 159by the fctape hint described below. 160.Sh BOOT OPTIONS 161The following options are switchable by setting values in 162.Pa /boot/device.hints . 163.Pp 164They are: 165.Bl -tag -width indent 166.It Va hint.isp.0.fwload_disable 167A hint value to disable loading of firmware 168.Xr ispfw 4 . 169.It Va hint.isp.0.ignore_nvram 170A hint value to ignore board NVRAM settings for. 171Otherwise use NVRAM settings. 172.It Va hint.isp.0.fullduplex 173A hint value to set full duplex mode. 174.It Va hint.isp.0.topology 175A hint value to select topology of connection. 176Supported values are: 177.Pp 178.Bl -tag -width ".Li lport-only" -compact 179.It Li lport 180Prefer loopback and fallback to point to point. 181.It Li nport 182Prefer point to point and fallback to loopback. 183.It Li lport-only 184Loopback only. 185.It Li nport-only 186Point to point only. 187.El 188.It Va hint.isp.0.portwwn 189This should be the full 64 bit World Wide Port Name you would like 190to use, overriding the value in NVRAM for the card. 191.It Va hint.isp.0.nodewwn 192This should be the full 64 bit World Wide Node Name you would like 193to use, overriding the value in NVRAM for the card. 194.It Va hint.isp.0.iid 195A hint to override or set the Initiator ID or Loop ID. 196For Fibre Channel 197cards in Local Loop topologies it is 198.Ar strongly 199recommended that you set this value to non-zero. 200.It Va hint.isp.0.role 201A hint to define default role for isp instance (0 -- none, 1 -- target, 2022 -- initiator, 3 -- both). 203.It Va hint.isp.0.debug 204A hint value for a driver debug level (see the file 205.Pa /usr/src/sys/dev/isp/ispvar.h 206for the values. 207.It Va hint.isp.0.vports 208A hint to create specified number of additional virtual ports. 209.It Va hint.isp.0.nofctape 210Set this to 1 to disable FC-Tape operation on the given isp instance. 211.It Va hint.isp.0.fctape 212Set this to 1 to enable FC-Tape operation on the given isp instance for 213targets that support it. 214.El 215.Sh SYSCTL OPTIONS 216.Bl -tag -width indent 217.It Va dev.isp.N.loop_down_limit 218This value says how long to wait in seconds after loop has gone down before 219giving up and expiring all of the devices that were visible. 220The default is 300 seconds (5 minutes). 221A separate (nonadjustable) timeout is used when 222booting to not stop booting on lack of FC connectivity. 223.It Va dev.isp.N.gone_device_time 224This value says how long to wait for devices to reappear if they (temporarily) 225disappear due to loop or fabric events. 226While this timeout is running, I/O 227to those devices will simply be held. 228.It Va dev.isp.N.use_gff_id 229.It Va dev.isp.N.use_gft_id 230Setting those options to 0 allows to disable use of GFF_ID and GFT_ID SNS 231requests during FC fabric scan. 232It may be useful if switch does not implement them correctly, 233preventing some devices from being found. 234Disabling them may cause unneeded logins to ports not supporting target role 235or even FCP at all. 236The default is 1 (enabled). 237.It Va dev.isp.N.wwnn 238This is the readonly World Wide Node Name value for this port. 239.It Va dev.isp.N.wwpn 240This is the readonly World Wide Port Name value for this port. 241.El 242.Sh SEE ALSO 243.Xr da 4 , 244.Xr intro 4 , 245.Xr ispfw 4 , 246.Xr sa 4 , 247.Xr scsi 4 , 248.Xr gmultipath 8 249.Sh AUTHORS 250The 251.Nm 252driver was written by 253.An Matthew Jacob 254originally for NetBSD at NASA/Ames Research Center. 255Later improvement was done by 256.An Alexander Motin Aq Mt mav@FreeBSD.org . 257.Sh BUGS 258The driver currently ignores some NVRAM settings. 259.Pp 260Fabric support for 2100 cards has been so problematic, and these cards are so 261old now that it is just not worth your time to try it. 262