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