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$
  31 .\"
  32 .Dd February 6, 2006
  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 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 isp_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 This driver provides access to
  55 .Tn SCSI
  56 or
  57 .Tn FibreChannel
  58 devices.
  59 .Pp
  60 SCSI features include support for Ultra SCSI and wide mode transactions
  61 for
  62 .Tn SCSI ,
  63 Ultra2 LVD (for the ISP1080 and ISP1280), and Ultra3 LVD (for the
  64 ISP12160).
  65 .Pp
  66 Fibre Channel support uses FCP SCSI profile for
  67 .Tn FibreChannel .
  68 and utilizes Class 3 and Class 2 connections (Qlogic 2100 is Class
  69 3 only, minor patches to the Qlogic 2200 to force Class 2 mode).
  70 Support is available for Public and Private loops, and for
  71 point-to-point connections (Qlogic 2200 only).
  72 The newer 2-Gigabit cards (2300, 2312) are also supported.
  73 Command tagging is
  74 supported for all (in fact,
  75 .Tn FibreChannel
  76 requires tagging).
  77 Fabric support is enabled by default (but may
  78 be contingent upon the correct firmware being loaded).
  79 .Sh FIRMWARE
  80 Firmware is available if the
  81 .Xr ispfw 4
  82 module is loaded during bootstrap (q.v.).
  83 .Pp
  84 It is very strongly recommended that you use the firmware available
  85 from
  86 .Xr ispfw 4
  87 as it is the most likely to have been tested with this driver.
  88 .Sh HARDWARE
  89 Cards supported by the
  90 .Nm
  91 driver include:
  92 .Pp
  93 .Bl -tag -width xxxxxx -offset indent
  94 .It ISP1000
  95 SBus Fast Wide, Ultra Fast Wide cards, Single Ended or Differential
  96 cards.
  97 .It ISP1020
  98 Qlogic 1020 Fast Wide and Differential Fast Wide PCI cards.
  99 .It ISP1040
 100 Qlogic 1040 Ultra Wide and Differential Ultra Wide PCI cards.
 101 Also known as the DEC KZPBA-CA (single ended) and KZPBA-CB (HVD differential).
 102 .It Qlogic 1240
 103 Qlogic 1240 Dual Bus Ultra Wide and Differential Ultra Wide PCI
 104 cards.
 105 .It Qlogic 1020
 106 Qlogic 1020 SCSI cards.
 107 .It Qlogic 1040
 108 Qlogic 1040 Ultra SCSI cards.
 109 .It Qlogic 1080
 110 Qlogic 1280 LVD Ultra2 Wide PCI cards.
 111 .It Qlogic 1280
 112 Qlogic 1280 Dual Bus LVD Ultra2 Wide PCI cards.
 113 .It Qlogic 12160
 114 Qlogic 12160 Dual Bus LVD Ultra3 Wide PCI cards.
 115 .It Qlogic 210X
 116 Qlogic 2100 and 2100A Copper and Optical Fibre Channel Arbitrated
 117 Loop (single, dual).
 118 .It Qlogic 220X
 119 Qlogic 2200 Copper and Optical Fibre Channel Arbitrated Loop PCI
 120 cards (single, dual, quad).
 121 .It Qlogic 2300
 122 Qlogic 2300 Optical Fibre Channel PCI cards.
 123 .It Qlogic 2312
 124 Qlogic 2312 Optical Fibre Channel PCI cards.
 125 .It Qlogic 234X
 126 Qlogic 234X Optical Fibre Channel PCI cards (2312 chipset, single and dual attach).
 127 .It Qlogic 2322
 128 Qlogic 2322 Optical Fibre Channel PCI cards.
 129 .It Qlogic 200
 130 Dell Branded version of the QLogic 2312 Fibre Channel PCI cards.
 131 .El
 132 .Sh CONFIGURATION OPTIONS
 133 .Pp
 134 Target mode support may be enabled with the
 135 .Pp
 136 .Cd options ISP_TARGET_MODE
 137 .Pp
 138 option.
 139 .Sh BOOT OPTIONS
 140 The following options are switchable by setting values in
 141 .Pa /boot/device.hints .
 142 .Pp
 143 They are:
 144 .Pp
 145 .Bl -tag -width indent
 146 .It Va hint.isp.0.disable
 147 A hint value to disable driver in kernel.
 148 .It Va hint.isp.0.fwload_disable
 149 A hint value to disable loading of firmware
 150 .Cd ispfw(4) .
 151 .It Va hint.isp.0.prefer_memmap
 152 A hint value to use PCI Memory space instead of I/O space
 153 access for.
 154 .It Va hint.isp.0.prefer_iomap
 155 A hint value to use PCI I/O space instead of Memory space
 156 access for.
 157 .It Va hint.isp.0.ignore_nvram
 158 A hint value to ignore board NVRAM settings for. Otherwise
 159 use NVRAM settings.
 160 .It Va hint.isp.0.fullduplex
 161 A hint value to set full duplex mode.
 162 .It Va hint.isp.0.topology
 163 A hint value to select topology of connection. Supported
 164 values are:
 165 .Pp
 166 .Cd lport
 167 (Prefer loopback and fallback to point to point).
 168 .Pp
 169 .Cd nport
 170 (Prefer point to point and fallback to loopback).
 171 .Pp
 172 .Cd lport-only
 173 (Loopback only).
 174 .Pp
 175 .Cd nport-only
 176 (Point to point only).
 177 .Pp
 178 .It Va hint.isp.0.portwwn
 179 This should be the full 64 bit World Wide Port Name you would like
 180 to use, overriding the value in NVRAM for the card.
 181 .It Va hint.isp.0.nodewwn
 182 This should be the full 64 bit World Wide Node Name you would like
 183 to use, overriding the value in NVRAM for the card.
 184 .It Va hint.isp.0.iid
 185 A hint to override or set the Initiator ID (principally for SPI SCSI).
 186 .It Va hint.isp.0.role
 187 A hint to define default role for isp instance (target, initiator, both).
 188 .It Va hint.isp.0.debug
 189 A hint value for a driver debug level (values from 0 through 7).
 190 Default is 0.
 191 .El
 192 .Sh SEE ALSO
 193 .Xr da 4 ,
 194 .Xr intro 4 ,
 195 .Xr ispfw 4 ,
 196 .Xr sa 4 ,
 197 .Xr scsi 4
 198 .Sh AUTHORS
 199 The
 200 .Nm
 201 driver was written by Matthew Jacob for NASA/Ames Research Center.
 202 .Sh BUGS
 203 The driver currently ignores some NVRAM settings.
 204 .Pp
 205 The driver currently does not do error recovery for timed out commands
 206 very gracefully.
 207 .Pp
 208 Target mode support is not completely debugged yet.
 209 It works reasonably
 210 well for Fibre Channel, somewhat well for Qlogic 1040 cards, but
 211 does not yet work for the other cards (due to last minute unannounced
 212 changes in firmware interfaces).
 213 .Pp
 214 Sometimes, when booting, the driver gets stuck waiting for the
 215 Fibre Channel f/w to tell it that the loop port database is ready,
 216 or waiting for a good loop to be seen (this does not yet support
 217 booting without being connected to a fibre channel device).
 218 To
 219 unwedge the system, unplug and replug the fibre channel connection,
 220 or otherwise cause a LIP (Loop Initialization Primitive sequence)-
 221 this will kick the f/w into getting unstuck.
 222 .Pp
 223 QLogic 2322 support is limited to platforms where the BIOS can
 224 enable firmware as there is no code yet to do the 3 stage loading
 225 for 2322 firmware.