share/man/man4/isp.4

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