]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - share/man/man4/isp.4
MFC: r314691
[FreeBSD/stable/10.git] / 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 December 20, 2016
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 .El
143 .Sh CONFIGURATION OPTIONS
144 Target mode support for Fibre Channel adapters may be enabled with the
145 .Pp
146 .Cd options ISP_TARGET_MODE
147 .Pp
148 option.
149 .Pp
150 To disable FC-Tape, use the following configuration option:
151 .Pp
152 .Cd options ISP_FCTAPE_OFF
153 .Pp
154 Note that even if the ISP_FCTAPE_OFF option is used, it may be overridden
155 by the fctape hint described below.
156 .Sh BOOT OPTIONS
157 The following options are switchable by setting values in
158 .Pa /boot/device.hints .
159 .Pp
160 They are:
161 .Bl -tag -width indent
162 .It Va hint.isp.0.fwload_disable
163 A hint value to disable loading of firmware
164 .Xr ispfw 4 .
165 .It Va hint.isp.0.ignore_nvram
166 A hint value to ignore board NVRAM settings for.
167 Otherwise use NVRAM settings.
168 .It Va hint.isp.0.fullduplex
169 A hint value to set full duplex mode.
170 .It Va hint.isp.0.topology
171 A hint value to select topology of connection.
172 Supported values are:
173 .Pp
174 .Bl -tag -width ".Li lport-only" -compact
175 .It Li lport
176 Prefer loopback and fallback to point to point.
177 .It Li nport
178 Prefer point to point and fallback to loopback.
179 .It Li lport-only
180 Loopback only.
181 .It Li nport-only
182 Point to point only.
183 .El
184 .It Va hint.isp.0.portwwn
185 This should be the full 64 bit World Wide Port Name you would like
186 to use, overriding the value in NVRAM for the card.
187 .It Va hint.isp.0.nodewwn
188 This should be the full 64 bit World Wide Node Name you would like
189 to use, overriding the value in NVRAM for the card.
190 .It Va hint.isp.0.iid
191 A hint to override or set the Initiator ID or Loop ID.
192 For Fibre Channel
193 cards in Local Loop topologies it is
194 .Ar strongly
195 recommended that you set this value to non-zero.
196 .It Va hint.isp.0.role
197 A hint to define default role for isp instance (0 -- none, 1 -- target,
198 2 -- initiator, 3 -- both).
199 .It Va hint.isp.0.debug
200 A hint value for a driver debug level (see the file
201 .Pa /usr/src/sys/dev/isp/ispvar.h
202 for the values.
203 .It Va hint.isp.0.vports
204 A hint to create specified number of additional virtual ports.
205 .It Va hint.isp.0.nofctape
206 Set this to 1 to disable FC-Tape operation on the given isp instance.
207 .It Va hint.isp.0.fctape
208 Set this to 1 to enable FC-Tape operation on the given isp instance for
209 targets that support it.
210 .El
211 .Sh SYSCTL OPTIONS
212 .Bl -tag -width indent
213 .It Va dev.isp.N.loop_down_limit
214 This value says how long to wait in seconds after loop has gone down before
215 giving up and expiring all of the devices that were visible.
216 The default is 300 seconds (5 minutes).
217 A separate (nonadjustable) timeout is used when
218 booting to not stop booting on lack of FC connectivity.
219 .It Va dev.isp.N.gone_device_time
220 This value says how long to wait for devices to reappear if they (temporarily)
221 disappear due to loop or fabric events.
222 While this timeout is running, I/O
223 to those devices will simply be held.
224 .It Va dev.isp.N.wwnn
225 This is the readonly World Wide Node Name value for this port.
226 .It Va dev.isp.N.wwpn
227 This is the readonly World Wide Port Name value for this port.
228 .El
229 .Sh SEE ALSO
230 .Xr da 4 ,
231 .Xr intro 4 ,
232 .Xr ispfw 4 ,
233 .Xr sa 4 ,
234 .Xr scsi 4 ,
235 .Xr gmultipath 8
236 .Sh AUTHORS
237 The
238 .Nm
239 driver was written by
240 .An Matthew Jacob
241 originally for NetBSD at NASA/Ames Research Center.
242 Some later improvement was done by
243 .An Alexander Motin Aq Mt mav@FreeBSD.org .
244 .Sh BUGS
245 The driver currently ignores some NVRAM settings.
246 .Pp
247 Fabric support for 2100 cards has been so problematic, and these cards are so
248 old now that it is just not worth your time to try it.