share/man/man4/isp.4

   1 .\" Copyright (c) 2009-2015 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 November 22, 2015
  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 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 isp_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 This driver provides access to
  52 .Tn SPI
  53 or
  54 .Tn FibreChannel
  55 SCSI devices.
  56 .Pp
  57 SPI supports initiator mode for Ultra SCSI and wide mode transactions for
  58 .Tn SCSI ,
  59 Ultra2 LVD (1080, 1280), and Ultra3 LVD (10160, 12160).
  60 .Pp
  61 Fibre Channel supports initiator and target modes of FCP SCSI profile,
  62 utilizing Class 3 and Class 2 (2200 and later) connections.
  63 Support is available for Public and Private loops, Point-to-Point
  64 and Fabric connections.
  65 .Sh FIRMWARE
  66 Firmware loading is supported if the
  67 .Xr ispfw 4
  68 module is loaded.
  69 It is strongly recommended that you use the firmware available from
  70 .Xr ispfw 4
  71 as it is the most likely to have been tested with this driver.
  72 .Sh HARDWARE
  73 Cards supported by the
  74 .Nm
  75 driver include:
  76 .Bl -tag -width xxxxxx -offset indent
  77 .It Qlogic 1000
  78 Fast Wide, Ultra Fast Wide cards, Single Ended or Differential SBus cards.
  79 .It Qlogic 1020
  80 Fast Wide and Differential Fast Wide SCSI PCI cards.
  81 .It Qlogic 1040
  82 Ultra Wide and Differential Ultra Wide SCSI PCI cards.
  83 Also known as the DEC KZPBA-CA (single ended) and KZPBA-CB (HVD differential).
  84 .It Qlogic 1080
  85 LVD Ultra2 Wide SCSI PCI cards.
  86 .It Qlogic 10160
  87 LVD Ultra3 Wide SCSI PCI cards.
  88 .It Qlogic 1240
  89 Dual Bus Ultra Wide and Differential Ultra Wide SCSI PCI cards.
  90 .It Qlogic 1280
  91 Dual Bus LVD Ultra2 Wide SCSI PCI cards.
  92 .It Qlogic 12160
  93 Dual Bus LVD Ultra3 Wide SCSI PCI cards.
  94 .It Qlogic 210X
  95 Copper and Optical Fibre Channel Arbitrated Loop PCI cards (single, dual).
  96 .It Qlogic 220X
  97 Copper and Optical Fibre Channel Arbitrated Loop PCI cards (single, dual, quad).
  98 .It Qlogic 2300
  99 Optical 2Gb Fibre Channel PCI cards.
 100 .It Qlogic 2312
 101 Optical 2Gb Fibre Channel PCI cards.
 102 .It Qlogic 234X
 103 Optical 2Gb Fibre Channel PCI cards (2312 chipset, single and dual attach).
 104 .It Qlogic 2322
 105 Optical 2Gb Fibre Channel PCIe cards.
 106 .It Qlogic 200
 107 Dell branded version of the QLogic 2312.
 108 .It Qlogic 2422
 109 Optical 4Gb Fibre Channel PCI cards.
 110 .It Qlogic 2432
 111 Optical 4Gb Fibre Channel PCIe cards.
 112 .It Qlogic 2532
 113 Optical 8Gb 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 .Sh BOOT OPTIONS
 122 The following options are switchable by setting values in
 123 .Pa /boot/device.hints .
 124 .Pp
 125 They are:
 126 .Bl -tag -width indent
 127 .It Va hint.isp.0.fwload_disable
 128 A hint value to disable loading of firmware
 129 .Xr ispfw 4 .
 130 .It Va hint.isp.0.prefer_memmap
 131 A hint value to use PCI memory space instead of I/O space
 132 access for.
 133 .It Va hint.isp.0.prefer_iomap
 134 A hint value to use PCI I/O space instead of Memory space
 135 access for.
 136 .It Va hint.isp.0.ignore_nvram
 137 A hint value to ignore board NVRAM settings for.
 138 Otherwise use NVRAM settings.
 139 .It Va hint.isp.0.fullduplex
 140 A hint value to set full duplex mode.
 141 .It Va hint.isp.0.topology
 142 A hint value to select topology of connection.
 143 Supported values are:
 144 .Pp
 145 .Bl -tag -width ".Li lport-only" -compact
 146 .It Li lport
 147 Prefer loopback and fallback to point to point.
 148 .It Li nport
 149 Prefer point to point and fallback to loopback.
 150 .It Li lport-only
 151 Loopback only.
 152 .It Li nport-only
 153 Point to point only.
 154 .El
 155 .It Va hint.isp.0.portwwn
 156 This should be the full 64 bit World Wide Port Name you would like
 157 to use, overriding the value in NVRAM for the card.
 158 .It Va hint.isp.0.nodewwn
 159 This should be the full 64 bit World Wide Node Name you would like
 160 to use, overriding the value in NVRAM for the card.
 161 .It Va hint.isp.0.iid
 162 A hint to override or set the Initiator ID or Loop ID.
 163 For Fibre Channel
 164 cards in Local Loop topologies it is
 165 .Ar strongly
 166 recommended that you set this value to non-zero.
 167 .It Va hint.isp.0.role
 168 A hint to define default role for isp instance (0 -- none, 1 -- target,
 169 2 -- initiator, 3 -- both).
 170 .It Va hint.isp.0.debug
 171 A hint value for a driver debug level (see the file
 172 .Pa /usr/src/sys/dev/isp/ispvar.h
 173 for the values.
 174 .It Va hint.isp.0.vports
 175 A hint to create specified number of additional virtual ports.
 176 .El
 177 .Sh SYSCTL OPTIONS
 178 .Bl -tag -width indent
 179 .It Va dev.isp.N.loop_down_limit
 180 This value says how long to wait in seconds after loop has gone down before
 181 giving up and expiring all of the devices that were visible.
 182 The default is 300 seconds (5 minutes).
 183 A separate (nonadjustable) timeout is used when
 184 booting to not stop booting on lack of FC connectivity.
 185 .It Va dev.isp.N.gone_device_time
 186 This value says how long to wait for devices to reappear if they (temporarily)
 187 disappear due to loop or fabric events.
 188 While this timeout is running, I/O
 189 to those devices will simply be held.
 190 .It Va dev.isp.N.wwnn
 191 This is the readonly World Wide Node Name value for this port.
 192 .It Va dev.isp.N.wwpn
 193 This is the readonly World Wide Port Name value for this port.
 194 .El
 195 .Sh SEE ALSO
 196 .Xr da 4 ,
 197 .Xr intro 4 ,
 198 .Xr ispfw 4 ,
 199 .Xr sa 4 ,
 200 .Xr scsi 4 ,
 201 .Xr gmultipath 8
 202 .Sh AUTHORS
 203 The
 204 .Nm
 205 driver was written by
 206 .An Matthew Jacob
 207 originally for NetBSD at NASA/Ames Research Center.
 208 Some later improvement was done by
 209 .An Alexander Motin Aq Mt mav@FreeBSD.org .
 210 .Sh BUGS
 211 The driver currently ignores some NVRAM settings.
 212 .Pp
 213 Fabric support for 2100 cards has been so problematic, and these cards are so
 214 old now that it is just not worth your time to try it.