share/man/man4/isp.4

   1 .\"     $NetBSD: isp.4,v 1.5 1999/12/18 18:33:05 mjacob Exp $
   2 .\"
   3 .\" Copyright (c) 1998, 1999, 2001
   4 .\"     Matthew Jacob, for NASA/Ames Research Center
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" Additional Copyright (c) 2006 by Marcus Alves Grando
  29 .\"
  30 .\" $FreeBSD: src/share/man/man4/isp.4,v 1.29 2010/10/08 12:40:16 uqs Exp $
  31 .\"
  32 .Dd June 28, 2017
  33 .Dt ISP 4
  34 .Os
  35 .Sh NAME
  36 .Nm isp
  37 .Nd Qlogic based SCSI and FibreChannel SCSI Host Adapters
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel,
  40 place the following lines in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device scbus"
  44 .Cd "device isp"
  45 .Cd "device ispfw"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following lines in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 isp_load="YES"
  53 isp_1040_load="YES"
  54 isp_1040_it_load="YES"
  55 isp_1080_load="YES"
  56 isp_1080_it_load="YES"
  57 isp_12160_load="YES"
  58 isp_12160_it_load="YES"
  59 isp_2100_load="YES"
  60 isp_2200_load="YES"
  61 isp_2300_load="YES"
  62 isp_2322_load="YES"
  63 isp_2400_load="YES"
  64 isp_2400_multi_load="YES"
  65 isp_2500_load="YES"
  66 isp_2500_multi_load="YES"
  67 .Ed
  68 .Sh DESCRIPTION
  69 This driver provides access to
  70 .Tn SCSI
  71 or
  72 .Tn FibreChannel
  73 devices.
  74 .Pp
  75 SCSI features include support for Ultra SCSI and wide mode transactions
  76 for
  77 .Tn SCSI ,
  78 Ultra2 LVD (for the ISP1080 and ISP1280), and Ultra3 LVD (for the
  79 ISP12160).
  80 .Pp
  81 Fibre Channel support uses FCP SCSI profile for
  82 .Tn FibreChannel .
  83 and utilizes Class 3 and Class 2 connections (Qlogic 2100 is Class
  84 3 only, minor patches to the Qlogic 2200 to force Class 2 mode).
  85 Support is available for Public and Private loops, and for
  86 point-to-point connections (Qlogic 2200 only).
  87 The newer 2-Gigabit cards (2300, 2312, 2322) and 4-Gigabit (2422, 2432)
  88 are also supported.
  89 Command tagging is
  90 supported for all (in fact,
  91 .Tn FibreChannel
  92 requires tagging).
  93 Fabric support is enabled by default for other than 2100 cards.
  94 Fabric
  95 support for 2100 cards has been so problematic and these cards are so
  96 old now that it is just not worth your time to try it.
  97 .Sh FIRMWARE
  98 Firmware is available if the appropriate firmware module
  99 is loaded during bootstrap (see
 100 .Xr ispfw 4 ) .
 101 .Pp
 102 It is
 103 .Em strongly
 104 recommended that you use the firmware supplied with
 105 .Dx
 106 as it is the most likely to have been tested with this driver.
 107 .Sh HARDWARE
 108 Cards supported by the
 109 .Nm
 110 driver include:
 111 .Bl -tag -width xxxxxx -offset indent
 112 .It ISP1000
 113 SBus Fast Wide, Ultra Fast Wide cards, Single Ended or Differential
 114 cards.
 115 .It ISP1020
 116 Qlogic 1020 Fast Wide and Differential Fast Wide PCI cards.
 117 .It ISP1040
 118 Qlogic 1040 Ultra Wide and Differential Ultra Wide PCI cards.
 119 Also known as the DEC KZPBA-CA (single ended) and KZPBA-CB (HVD differential).
 120 .It Qlogic 1240
 121 Qlogic 1240 Dual Bus Ultra Wide and Differential Ultra Wide PCI
 122 cards.
 123 .It Qlogic 1020
 124 Qlogic 1020 SCSI cards.
 125 .It Qlogic 1040
 126 Qlogic 1040 Ultra SCSI cards.
 127 .It Qlogic 1080
 128 Qlogic 1280 LVD Ultra2 Wide PCI cards.
 129 .It Qlogic 1280
 130 Qlogic 1280 Dual Bus LVD Ultra2 Wide PCI cards.
 131 .It Qlogic 12160
 132 Qlogic 12160 Dual Bus LVD Ultra3 Wide PCI cards.
 133 .It Qlogic 210X
 134 Qlogic 2100 and 2100A Copper and Optical Fibre Channel Arbitrated
 135 Loop (single, dual).
 136 .It Qlogic 220X
 137 Qlogic 2200 Copper and Optical Fibre Channel Arbitrated Loop PCI
 138 cards (single, dual, quad).
 139 .It Qlogic 2300
 140 Qlogic 2300 Optical Fibre Channel PCI cards.
 141 .It Qlogic 2312
 142 Qlogic 2312 Optical Fibre Channel PCI cards.
 143 .It Qlogic 234X
 144 Qlogic 234X Optical Fibre Channel PCI cards (2312 chipset, single and dual attach).
 145 .It Qlogic 2322
 146 Qlogic 2322 Optical Fibre Channel PCIe cards.
 147 .It Qlogic 200
 148 Dell Branded version of the QLogic 2312 Fibre Channel PCI cards.
 149 .It Qlogic 2422
 150 Qlogic 2422 Optical Fibre Channel PCI cards (4 Gigabit)
 151 .It Qlogic 2432
 152 Qlogic 2432 Optical Fibre Channel PCIe cards (4 Gigabit)
 153 .El
 154 .Sh CONFIGURATION OPTIONS
 155 Target mode support may be enabled with the
 156 .Pp
 157 .Cd options ISP_TARGET_MODE
 158 .Pp
 159 option.
 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.0.disable
 167 A hint value to disable driver in kernel.
 168 .It Va hint.isp.0.fwload_disable
 169 A hint value to disable loading of firmware
 170 .Xr ispfw 4 .
 171 .It Va hint.isp.0.prefer_memmap
 172 A hint value to use PCI memory space instead of I/O space
 173 access for.
 174 .It Va hint.isp.0.prefer_iomap
 175 A hint value to use PCI I/O space instead of Memory space
 176 access for.
 177 .It Va hint.isp.0.ignore_nvram
 178 A hint value to ignore board NVRAM settings for.
 179 Otherwise use NVRAM settings.
 180 .It Va hint.isp.0.fullduplex
 181 A hint value to set full duplex mode.
 182 .It Va hint.isp.0.topology
 183 A hint value to select topology of connection.
 184 Supported values are:
 185 .Pp
 186 .Bl -tag -width ".Li lport-only" -compact
 187 .It Li lport
 188 Prefer loopback and fallback to point to point.
 189 .It Li nport
 190 Prefer point to point and fallback to loopback.
 191 .It Li lport-only
 192 Loopback only.
 193 .It Li nport-only
 194 Point to point only.
 195 .El
 196 .It Va hint.isp.0.portwwn
 197 This should be the full 64 bit World Wide Port Name you would like
 198 to use, overriding the value in NVRAM for the card.
 199 .It Va hint.isp.0.nodewwn
 200 This should be the full 64 bit World Wide Node Name you would like
 201 to use, overriding the value in NVRAM for the card.
 202 .It Va hint.isp.0.iid
 203 A hint to override or set the Initiator ID or Loop ID.
 204 For Fibre Channel
 205 cards in Local Loop topologies it is
 206 .Ar strongly
 207 recommended that you set this value to non-zero.
 208 .It Va hint.isp.0.role
 209 A hint to define default role for isp instance (target, initiator, both).
 210 .It Va hint.isp.0.debug
 211 A hint value for a driver debug level (see the file
 212 .Pa /usr/src/sys/dev/isp/ispvar.h
 213 for the values.
 214 .El
 215 .Pp
 216 By default, the driver will use MSI if it is supported.
 217 This behavior can be turned off by setting the following tunable:
 218 .Bd -literal -offset indent
 219 hw.isp.msi.enable=0
 220 .Ed
 221 .Sh SYSCTL OPTIONS
 222 .Bl -tag -width indent
 223 .It Va dev.isp.N.loop_down_limit
 224 This value says how long to wait in seconds after loop has gone down before
 225 giving up and expiring all of the devices that were visible.
 226 The default is 300 seconds (5 minutes).
 227 A separate (nonadjustable) timeout is used when
 228 booting to not stop booting on lack of FC connectivity.
 229 .It Va dev.isp.N.gone_device_time
 230 This value says how long to wait for devices to reappear if they (temporarily)
 231 disappear due to loop or fabric events.
 232 While this timeout is running, I/O
 233 to those devices will simply be held.
 234 .It Va dev.isp.N.wwnn
 235 This is the readonly World Wide Node Name value for this port.
 236 .It Va dev.isp.N.wwpn
 237 This is the readonly World Wide Port Name value for this port.
 238 .El
 239 .Sh SEE ALSO
 240 .Xr da 4 ,
 241 .Xr intro 4 ,
 242 .Xr ispfw 4 ,
 243 .Xr sa 4 ,
 244 .Xr scsi 4
 245 .Sh AUTHORS
 246 The
 247 .Nm
 248 driver was written by Matthew Jacob originally for
 249 .Nx
 250 at NASA/Ames Research Center.
 251 .Sh BUGS
 252 The driver currently ignores some NVRAM settings.
 253 .Pp
 254 Target mode support is not completely reliable yet.
 255 It works reasonably
 256 well for Fibre Channel, somewhat well for Qlogic 1040 cards, but
 257 does not yet work for the other cards (due to last minute unannounced
 258 changes in firmware interfaces).