/share/man/man4/isp.4

https://bitbucket.org/freebsd/freebsd-head/ · Forth · 238 lines · 238 code · 0 blank · 0 comment · 20 complexity · e35b2aa5f93ef364308db6617218bdb8 MD5 · raw file

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