Document which drivers are using MSI and how it can be disabled.
[dragonfly.git] / share / man / man4 / isp.4
CommitLineData
984263bc
MD
1.\" $NetBSD: isp.4,v 1.5 1999/12/18 18:33:05 mjacob Exp $
2.\"
191d7ec1 3.\" Copyright (c) 1998, 1999, 2001
984263bc
MD
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.\"
191d7ec1 28.\" Additional Copyright (c) 2006 by Marcus Alves Grando
984263bc 29.\"
191d7ec1
SW
30.\" $FreeBSD: src/share/man/man4/isp.4,v 1.29 2010/10/08 12:40:16 uqs Exp $
31.\"
5cee4cf5 32.Dd April 7, 2012
984263bc
MD
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
191d7ec1
SW
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"
984263bc 44.Cd "device isp"
191d7ec1 45.Ed
984263bc 46.Pp
191d7ec1
SW
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
984263bc
MD
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).
191d7ec1
SW
72The newer 2-Gigabit cards (2300, 2312, 2322) and 4-Gigabit (2422, 2432)
73are also supported.
984263bc
MD
74Command tagging is
75supported for all (in fact,
76.Tn FibreChannel
77requires tagging).
191d7ec1
SW
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.
984263bc 82.Sh FIRMWARE
191d7ec1 83Firmware is available if the
984263bc
MD
84.Xr ispfw 4
85module is loaded during bootstrap (q.v.).
86.Pp
191d7ec1
SW
87It is
88.Ar strongly
89recommended that you use the firmware available
984263bc
MD
90from
91.Xr ispfw 4
92as it is the most likely to have been tested with this driver.
93.Sh HARDWARE
191d7ec1
SW
94Cards supported by the
95.Nm
96driver include:
984263bc
MD
97.Bl -tag -width xxxxxx -offset indent
98.It ISP1000
99SBus Fast Wide, Ultra Fast Wide cards, Single Ended or Differential
100cards.
984263bc
MD
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.
191d7ec1 105Also known as the DEC KZPBA-CA (single ended) and KZPBA-CB (HVD differential).
984263bc
MD
106.It Qlogic 1240
107Qlogic 1240 Dual Bus Ultra Wide and Differential Ultra Wide PCI
108cards.
191d7ec1
SW
109.It Qlogic 1020
110Qlogic 1020 SCSI cards.
111.It Qlogic 1040
112Qlogic 1040 Ultra SCSI cards.
984263bc
MD
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.
191d7ec1 119.It Qlogic 210X
984263bc 120Qlogic 2100 and 2100A Copper and Optical Fibre Channel Arbitrated
191d7ec1
SW
121Loop (single, dual).
122.It Qlogic 220X
984263bc 123Qlogic 2200 Copper and Optical Fibre Channel Arbitrated Loop PCI
191d7ec1 124cards (single, dual, quad).
984263bc
MD
125.It Qlogic 2300
126Qlogic 2300 Optical Fibre Channel PCI cards.
127.It Qlogic 2312
128Qlogic 2312 Optical Fibre Channel PCI cards.
191d7ec1
SW
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)
984263bc
MD
139.El
140.Sh CONFIGURATION OPTIONS
984263bc
MD
141Target mode support may be enabled with the
142.Pp
143.Cd options ISP_TARGET_MODE
144.Pp
145option.
146.Sh BOOT OPTIONS
191d7ec1
SW
147The following options are switchable by setting values in
148.Pa /boot/device.hints .
984263bc 149.Pp
191d7ec1
SW
150They are:
151.Bl -tag -width indent
152.It Va hint.isp.0.disable
153A hint value to disable driver in kernel.
154.It Va hint.isp.0.fwload_disable
155A hint value to disable loading of firmware
156.Xr ispfw 4 .
157.It Va hint.isp.0.prefer_memmap
158A hint value to use PCI memory space instead of I/O space
984263bc 159access for.
191d7ec1
SW
160.It Va hint.isp.0.prefer_iomap
161A hint value to use PCI I/O space instead of Memory space
984263bc 162access for.
191d7ec1
SW
163.It Va hint.isp.0.ignore_nvram
164A hint value to ignore board NVRAM settings for.
165Otherwise use NVRAM settings.
166.It Va hint.isp.0.fullduplex
167A hint value to set full duplex mode.
168.It Va hint.isp.0.topology
169A hint value to select topology of connection.
170Supported values are:
171.Pp
172.Bl -tag -width ".Li lport-only" -compact
173.It Li lport
174Prefer loopback and fallback to point to point.
175.It Li nport
176Prefer point to point and fallback to loopback.
177.It Li lport-only
178Loopback only.
179.It Li nport-only
180Point to point only.
181.El
182.It Va hint.isp.0.portwwn
183This should be the full 64 bit World Wide Port Name you would like
184to use, overriding the value in NVRAM for the card.
185.It Va hint.isp.0.nodewwn
984263bc
MD
186This should be the full 64 bit World Wide Node Name you would like
187to use, overriding the value in NVRAM for the card.
191d7ec1
SW
188.It Va hint.isp.0.iid
189A hint to override or set the Initiator ID or Loop ID.
190For Fibre Channel
191cards in Local Loop topologies it is
192.Ar strongly
193recommended that you set this value to non-zero.
194.It Va hint.isp.0.role
195A hint to define default role for isp instance (target, initiator, both).
196.It Va hint.isp.0.debug
197A hint value for a driver debug level (see the file
198.Pa /usr/src/sys/dev/isp/ispvar.h
199for the values.
200.El
5cee4cf5
SW
201.Pp
202By default, the driver will use MSI if it is supported.
203This behavior can be turned off by setting the following tunable:
204.Bd -literal -offset indent
205hw.isp.msi.enable=0
206.Ed
191d7ec1
SW
207.Sh SYSCTL OPTIONS
208.Bl -tag -width indent
209.It Va dev.isp.N.loop_down_limit
210This value says how long to wait in seconds after loop has gone down before
211giving up and expiring all of the devices that were visible.
212The default is 300 seconds (5 minutes).
213A separate (nonadjustable) timeout is used when
214booting to not stop booting on lack of FC connectivity.
215.It Va dev.isp.N.gone_device_time
216This value says how long to wait for devices to reappear if they (temporarily)
217disappear due to loop or fabric events.
218While this timeout is running, I/O
219to those devices will simply be held.
220.It Va dev.isp.N.wwnn
221This is the readonly World Wide Node Name value for this port.
222.It Va dev.isp.N.wwpn
223This is the readonly World Wide Port Name value for this port.
984263bc 224.El
ac561d34
SW
225.Sh SEE ALSO
226.Xr da 4 ,
227.Xr intro 4 ,
228.Xr ispfw 4 ,
229.Xr sa 4 ,
230.Xr scsi 4
231.Sh AUTHORS
232The
233.Nm
93f25fe4
SW
234driver was written by Matthew Jacob originally for
235.Nx
236at NASA/Ames Research Center.
984263bc
MD
237.Sh BUGS
238The driver currently ignores some NVRAM settings.
239.Pp
191d7ec1 240Target mode support is not completely reliable yet.
984263bc
MD
241It works reasonably
242well for Fibre Channel, somewhat well for Qlogic 1040 cards, but
191d7ec1 243does not yet work for the other cards (due to last minute unannounced
984263bc 244changes in firmware interfaces).