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