xref: /freebsd/share/man/man4/isp.4 (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
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 December 1, 2014
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
39To compile this driver into the kernel,
40place the following lines in your
41kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device scbus"
44.Cd "device isp"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51isp_load="YES"
52.Ed
53.Sh DESCRIPTION
54This driver provides access to
55.Tn SCSI
56or
57.Tn FibreChannel
58devices.
59.Pp
60SCSI features include support for Ultra SCSI and wide mode transactions
61for
62.Tn SCSI ,
63Ultra2 LVD (for the ISP1080 and ISP1280), and Ultra3 LVD (for the
64ISP12160).
65.Pp
66Fibre Channel support uses FCP SCSI profile for
67.Tn FibreChannel ,
68and utilizes Class 3 and Class 2 connections (Qlogic 2100 is Class
693 only, minor patches to the Qlogic 2200 to force Class 2 mode).
70Support is available for Public and Private loops, and for
71point-to-point connections (Qlogic 2200 only).
72The newer 2-Gigabit cards (2300, 2312, 2322) and 4-Gigabit (2422, 2432)
73are also supported.
74Command tagging is
75supported for all (in fact,
76.Tn FibreChannel
77requires tagging).
78Fabric support is enabled by default for other than 2100 cards.
79Fabric
80support for 2100 cards has been so problematic and these cards are so
81old now that it is just not worth your time to try it.
82.Sh FIRMWARE
83Firmware is available if the
84.Xr ispfw 4
85module is loaded during bootstrap (q.v.).
86.Pp
87It is
88.Ar strongly
89recommended that you use the firmware available
90from
91.Xr ispfw 4
92as it is the most likely to have been tested with this driver.
93.Sh HARDWARE
94Cards supported by the
95.Nm
96driver include:
97.Bl -tag -width xxxxxx -offset indent
98.It ISP1000
99SBus Fast Wide, Ultra Fast Wide cards, Single Ended or Differential
100cards.
101.It ISP1020
102Qlogic 1020 Fast Wide and Differential Fast Wide PCI cards.
103.It ISP1040
104Qlogic 1040 Ultra Wide and Differential Ultra Wide PCI cards.
105Also known as the DEC KZPBA-CA (single ended) and KZPBA-CB (HVD differential).
106.It Qlogic 1240
107Qlogic 1240 Dual Bus Ultra Wide and Differential Ultra Wide PCI
108cards.
109.It Qlogic 1020
110Qlogic 1020 SCSI cards.
111.It Qlogic 1040
112Qlogic 1040 Ultra SCSI cards.
113.It Qlogic 1080
114Qlogic 1280 LVD Ultra2 Wide PCI cards.
115.It Qlogic 1280
116Qlogic 1280 Dual Bus LVD Ultra2 Wide PCI cards.
117.It Qlogic 12160
118Qlogic 12160 Dual Bus LVD Ultra3 Wide PCI cards.
119.It Qlogic 210X
120Qlogic 2100 and 2100A Copper and Optical Fibre Channel Arbitrated
121Loop (single, dual).
122.It Qlogic 220X
123Qlogic 2200 Copper and Optical Fibre Channel Arbitrated Loop PCI
124cards (single, dual, quad).
125.It Qlogic 2300
126Qlogic 2300 Optical Fibre Channel PCI cards.
127.It Qlogic 2312
128Qlogic 2312 Optical Fibre Channel PCI cards.
129.It Qlogic 234X
130Qlogic 234X Optical Fibre Channel PCI cards (2312 chipset, single and dual attach).
131.It Qlogic 2322
132Qlogic 2322 Optical Fibre Channel PCIe cards.
133.It Qlogic 200
134Dell Branded version of the QLogic 2312 Fibre Channel PCI cards.
135.It Qlogic 2422
136Qlogic 2422 Optical Fibre Channel PCI cards (4 Gigabit)
137.It Qlogic 2432
138Qlogic 2432 Optical Fibre Channel PCIe cards (4 Gigabit)
139.It Qlogic 2432
140Qlogic 2532 Optical Fibre Channel PCIe cards (8 Gigabit)
141.El
142.Sh CONFIGURATION OPTIONS
143Target mode support may be enabled with the
144.Pp
145.Cd options ISP_TARGET_MODE
146.Pp
147option.
148.Sh BOOT OPTIONS
149The following options are switchable by setting values in
150.Pa /boot/device.hints .
151.Pp
152They are:
153.Bl -tag -width indent
154.It Va hint.isp.0.disable
155A hint value to disable driver in kernel.
156.It Va hint.isp.0.fwload_disable
157A hint value to disable loading of firmware
158.Xr ispfw 4 .
159.It Va hint.isp.0.prefer_memmap
160A hint value to use PCI memory space instead of I/O space
161access for.
162.It Va hint.isp.0.prefer_iomap
163A hint value to use PCI I/O space instead of Memory space
164access for.
165.It Va hint.isp.0.ignore_nvram
166A hint value to ignore board NVRAM settings for.
167Otherwise use NVRAM settings.
168.It Va hint.isp.0.fullduplex
169A hint value to set full duplex mode.
170.It Va hint.isp.0.topology
171A hint value to select topology of connection.
172Supported values are:
173.Pp
174.Bl -tag -width ".Li lport-only" -compact
175.It Li lport
176Prefer loopback and fallback to point to point.
177.It Li nport
178Prefer point to point and fallback to loopback.
179.It Li lport-only
180Loopback only.
181.It Li nport-only
182Point to point only.
183.El
184.It Va hint.isp.0.portwwn
185This should be the full 64 bit World Wide Port Name you would like
186to use, overriding the value in NVRAM for the card.
187.It Va hint.isp.0.nodewwn
188This should be the full 64 bit World Wide Node Name you would like
189to use, overriding the value in NVRAM for the card.
190.It Va hint.isp.0.iid
191A hint to override or set the Initiator ID or Loop ID.
192For Fibre Channel
193cards in Local Loop topologies it is
194.Ar strongly
195recommended that you set this value to non-zero.
196.It Va hint.isp.0.role
197A hint to define default role for isp instance (target, initiator, both).
198.It Va hint.isp.0.debug
199A hint value for a driver debug level (see the file
200.Pa /usr/src/sys/dev/isp/ispvar.h
201for the values.
202.It Va hint.isp.0.vports
203A hint to create specified number of additional virtual ports.
204.El
205.Sh SYSCTL OPTIONS
206.Bl -tag -width indent
207.It Va dev.isp.N.loop_down_limit
208This value says how long to wait in seconds after loop has gone down before
209giving up and expiring all of the devices that were visible.
210The default is 300 seconds (5 minutes).
211A separate (nonadjustable) timeout is used when
212booting to not stop booting on lack of FC connectivity.
213.It Va dev.isp.N.gone_device_time
214This value says how long to wait for devices to reappear if they (temporarily)
215disappear due to loop or fabric events.
216While this timeout is running, I/O
217to those devices will simply be held.
218.It Va dev.isp.N.wwnn
219This is the readonly World Wide Node Name value for this port.
220.It Va dev.isp.N.wwpn
221This is the readonly World Wide Port Name value for this port.
222.El
223.Sh SEE ALSO
224.Xr da 4 ,
225.Xr intro 4 ,
226.Xr ispfw 4 ,
227.Xr sa 4 ,
228.Xr scsi 4 ,
229.Xr gmultipath 8
230.Sh AUTHORS
231The
232.Nm
233driver was written by
234.An Matthew Jacob
235originally for NetBSD at
236NASA/Ames Research Center.
237.Sh BUGS
238The driver currently ignores some NVRAM settings.
239.Pp
240Target mode support is not completely reliable yet.
241It works reasonably
242well for Fibre Channel, somewhat well for Qlogic 1040 cards, but
243does not yet work for the other cards (due to last minute unannounced
244changes in firmware interfaces).
245