Initial import from FreeBSD RELENG_4:
[games.git] / share / man / man4 / isp.4
1 .\"     $FreeBSD: src/share/man/man4/isp.4,v 1.3.4.9 2001/12/17 11:30:12 ru Exp $
2 .\"     $NetBSD: isp.4,v 1.5 1999/12/18 18:33:05 mjacob Exp $
3 .\"
4 .\" Copyright (c) 1998, 1999
5 .\"     Matthew Jacob, for NASA/Ames Research Center
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. The name of the author may not be used to endorse or promote products
16 .\"    derived from this software without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .\"
30 .Dd February 14, 2000
31 .Dt ISP 4
32 .Os
33 .Sh NAME
34 .Nm isp
35 .Nd Qlogic based SCSI and FibreChannel SCSI Host Adapters
36 .Sh SYNOPSIS
37 .Cd "device isp"
38 .Pp
39 For one or more SCSI busses:
40 .Cd device scbus0
41 .Sh DESCRIPTION
42 This driver provides access to
43 .Tn SCSI
44 or
45 .Tn FibreChannel
46 devices.
47 .Pp
48 SCSI features include support for Ultra SCSI and wide mode transactions
49 for
50 .Tn SCSI ,
51 Ultra2 LVD (for the ISP1080 and ISP1280), and Ultra3 LVD (for the
52 ISP12160).
53 .Pp
54 Fibre Channel support uses FCP SCSI profile for
55 .Tn FibreChannel .
56 and utilizes Class 3 and Class 2 connections (Qlogic 2100 is Class
57 3 only, minor patches to the Qlogic 2200 to force Class 2 mode).
58 Support is available for Public and Private loops, and for
59 point-to-point connections (Qlogic 2200 only).
60 The newer 2-Gigabit cards (2300, 2312) are also supported.
61 Command tagging is
62 supported for all (in fact,
63 .Tn FibreChannel
64 requires tagging).
65 Fabric support is enabled by default (but may
66 be contingent upon the correct firmware being loaded).
67 .Sh FIRMWARE
68 Firmware is now available if the
69 .Xr ispfw 4
70 module is loaded during bootstrap (q.v.).
71 .Pp
72 It is very strongly recommended that you use the firmware available
73 from
74 .Xr ispfw 4
75 as it is the most likely to have been tested with this driver.
76 .Sh HARDWARE
77 Supported cards include:
78 .Pp
79 .Bl -tag -width xxxxxx -offset indent
80 .It ISP1000
81 SBus Fast Wide, Ultra Fast Wide cards, Single Ended or Differential
82 cards.
83 .It PTI SBS440
84 Performance Technology ISP1000 variants.
85 .It ISP1020
86 Qlogic 1020 Fast Wide and Differential Fast Wide PCI cards.
87 .It ISP1040
88 Qlogic 1040 Ultra Wide and Differential Ultra Wide PCI cards.
89 .It PTI SBS450
90 Performance Technology ISP1040 variants.
91 .It Qlogic 1240
92 Qlogic 1240 Dual Bus Ultra Wide and Differential Ultra Wide PCI
93 cards.
94 .It Qlogic 1080
95 Qlogic 1280 LVD Ultra2 Wide PCI cards.
96 .It Qlogic 1280
97 Qlogic 1280 Dual Bus LVD Ultra2 Wide PCI cards.
98 .It Qlogic 12160
99 Qlogic 12160 Dual Bus LVD Ultra3 Wide PCI cards.
100 .It Qlogic 2100
101 Qlogic 2100 and 2100A Copper and Optical Fibre Channel Arbitrated
102 Loop
103 .It Qlogic 2102
104 Qlogic Dual Loop 2100A Optical Fibre Channel Arbitrated Loop PCI
105 cards.
106 .It Qlogic 2200
107 Qlogic 2200 Copper and Optical Fibre Channel Arbitrated Loop PCI
108 cards.
109 .It Qlogic 2202
110 Qlogic 2200 Dual Bus Optical Fibre Channel Arbitrated Loop PCI
111 cards.
112 .It Qlogic 2300
113 Qlogic 2300 Optical Fibre Channel PCI cards.
114 .It Qlogic 2312
115 Qlogic 2312 Optical Fibre Channel PCI cards.
116 .It PTI SBS470
117 Performance Technology ISP2100 variants.
118 .It Antares P-0033
119 Antares Microsystems ISP2100 variants.
120 .El
121 .Sh CONFIGURATION OPTIONS
122 .Pp
123 Target mode support may be enabled with the
124 .Pp
125 .Cd options ISP_TARGET_MODE
126 .Pp
127 option.
128 .Sh BOOT OPTIONS
129 The following options are switchable by setting values in the loader
130 configuration file (see the
131 .Xr loader 8
132 manual page).
133 They are:
134 .Pp
135 .Bl -tag -width "isp_no_fwload" -compact
136 .It isp_disable
137 A bit mask of units to skip configuration for.
138 .It isp_mem_map
139 A bit mask of units to use PCI Memory space instead of I/O space
140 access for.
141 .It isp_io_map
142 A bit mask of units to use PCI I/O space instead of Memory space
143 access for.
144 .It isp_no_nvram
145 A bit mask of units that you wish to ignore board NVRAM settings
146 for.
147 .It isp_nvram
148 A bit mask of units that you wish to specifically use board NVRAM
149 settings for.
150 .It isp_fcduplex
151 A bit mask of units that you wish to specifically to set into full
152 duplex mode.
153 .It isp_no_fcduplex
154 A bit mask of units that you wish to specifically to not set into
155 full duplex mode.
156 .It isp_wwn
157 This should be the full 64 bit World Wide Node Name you would like
158 to use, overriding the value in NVRAM for the card.
159 .It isp_debug
160 This is a driver debug level- meaningful from 0 through 7.
161 .It isp_tdebug
162 This is a driver target mode debug level- meaningful from 0 through
163 5.
164 .El
165 .Sh BUGS
166 The driver currently ignores some NVRAM settings.
167 .Pp
168 The driver currently doesn't do error recovery for timed out commands
169 very gracefully.
170 .Pp
171 Target mode support isn't completely debugged yet.
172 It works reasonably
173 well for Fibre Channel, somewhat well for Qlogic 1040 cards, but
174 doesn't yet work for the other cards (due to last minute unnanounced
175 changes in firmware interfaces).
176 .Pp
177 Sometimes, when booting, the driver gets stuck waiting for the
178 Fibre Channel f/w to tell it that the loop port database is ready,
179 or waiting for a good loop to be seen (this does not yet support
180 booting without being connected to a fibre channel device).
181 To
182 unwedge the system, unplug and replug the fibre channel connection,
183 or otherwise cause a LIP (Loop Initialization Primitive sequence)-
184 this will kick the f/w into getting unstuck.
185 .Sh SEE ALSO
186 .Xr da 4 ,
187 .Xr intro 4 ,
188 .Xr ispfw 4 ,
189 .Xr sa 4 ,
190 .Xr scsi 4
191 .Sh AUTHORS
192 The
193 .Nm
194 driver was written by Matthew Jacob for NASA/Ames Research Center.