share/man/man4/isp.4

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