diff options
Diffstat (limited to 'static/freebsd/man4/isp.4 3.html')
| -rw-r--r-- | static/freebsd/man4/isp.4 3.html | 266 |
1 files changed, 266 insertions, 0 deletions
diff --git a/static/freebsd/man4/isp.4 3.html b/static/freebsd/man4/isp.4 3.html new file mode 100644 index 00000000..52df9d2c --- /dev/null +++ b/static/freebsd/man4/isp.4 3.html @@ -0,0 +1,266 @@ +<table class="head"> + <tr> + <td class="head-ltitle">ISP(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">ISP(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">isp</code> — <span class="Nd">Qlogic + FibreChannel SCSI Host Adapters driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile this driver into the kernel, place the following lines + in your kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device scbus</code> +<br/> +<code class="Cd">device isp</code> +<br/> +<code class="Cd">device ispfw</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + the following lines in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>isp_load="YES" +ispfw_load="YES"</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">This driver provides access to FibreChannel SCSI devices.</p> +<p class="Pp">It supports initiator and target modes of FCP SCSI profile, + utilizing Class 3 and Class 2 connections. Support is available for Public + and Private loops, Point-to-Point and Fabric connections.</p> +<p class="Pp">Supported FC-Tape functionality is highly recommended for + connections to tape drives that support it. It encompasses four elements + from the T-10 FCP-4 specification:</p> +<ul class="Bl-bullet Bd-indent"> + <li>Precise Delivery of Commands</li> + <li>Confirmed Completion of FCP I/O Operations</li> + <li>Retransmission of Unsuccessfully Transmitted IUs</li> + <li>Task Retry Identification</li> +</ul> +<p class="Pp">Together these features allow for link level error recovery with + tape devices. Without it, an initiator cannot, for instance, tell whether a + tape write command that has timed out resulted in all, part or none of the + data going to the tape drive. FC-Tape is automatically enabled when + connecting controller that supports it to a target that supports it. It may + be disabled using configuration and hint options described below.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> +<p class="Pp">The <code class="Nm">isp</code> driver supports the following + optical Fibre Channel adapters:</p> +<table class="Bl-column"> + <tr> + <td>Model:</td> + <td>Speed:</td> + <td>Bus:</td> + </tr> + <tr> + <td>Qlogic QLE2874 (2814)</td> + <td>64Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic QLE2870/QLE2872 (2812)</td> + <td>64Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic QLE2774 (2814)</td> + <td>32Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic QLE2770/QLE2772 (2812)</td> + <td>32Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic 2740/2742/2764 (2722/2714)</td> + <td>32Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic 2690/2692/2694 (2684/2692)</td> + <td>16Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic 267x/836x (2031/8031) FCoE</td> + <td>16Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic 256x (2532)</td> + <td>8Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic 246x (2432)</td> + <td>4Gb</td> + <td>PCIe</td> + </tr> + <tr> + <td>Qlogic 2422</td> + <td>4Gb</td> + <td>PCI-X</td> + </tr> +</table> +</section> +<section class="Sh"> +<h1 class="Sh" id="FIRMWARE"><a class="permalink" href="#FIRMWARE">FIRMWARE</a></h1> +<p class="Pp">Firmware loading is supported and handled by + <a class="Xr">firmware(9)</a>. The correct firmware is either loaded + automatically, if available for this type of adapter, or by manually loading + the <a class="Xr">ispfw(4)</a> module. It is strongly recommended that you + use the firmware available from <a class="Xr">ispfw(4)</a> as it is the one + that most likely has been tested with this driver.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="CONFIGURATION_OPTIONS"><a class="permalink" href="#CONFIGURATION_OPTIONS">CONFIGURATION + OPTIONS</a></h1> +<p class="Pp">Target mode support for Fibre Channel adapters may be enabled with + the</p> +<p class="Pp"><code class="Cd">options ISP_TARGET_MODE</code></p> +<p class="Pp">option.</p> +<p class="Pp">To disable FC-Tape, use the following configuration option:</p> +<p class="Pp"><code class="Cd">options ISP_FCTAPE_OFF</code></p> +<p class="Pp">Note that even if the ISP_FCTAPE_OFF option is used, it may be + overridden by the fctape hint described below.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BOOT_OPTIONS"><a class="permalink" href="#BOOT_OPTIONS">BOOT + OPTIONS</a></h1> +<p class="Pp">The following options are switchable by setting values in + <span class="Pa">/boot/device.hints</span>.</p> +<p class="Pp">They are:</p> +<dl class="Bl-tag"> + <dt id="hint.isp."><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.msi</var></dt> + <dd>Limit on number of Message Signaled Interrupts (MSI) to be used.</dd> + <dt id="hint.isp.~2"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.msix</var></dt> + <dd>Limit on number of Extended Message Signaled Interrupts (MSI-X) to be + used.</dd> + <dt id="hint.isp.~3"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.fwload_disable</var></dt> + <dd>A hint value to disable loading of firmware provided by + <a class="Xr">ispfw(4)</a>.</dd> + <dt id="hint.isp.~4"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.fwload_force</var></dt> + <dd>A hint value to prefer firmware provided by <a class="Xr">ispfw(4)</a>, + even if it is older than the firmware in flash on the board. If + fwload_disable is also specified, fwload_force will be ignored. + <p class="Pp">By default, with 27XX and newer controllers, the + <a class="Xr">isp(4)</a> driver will use the newer firmware. For older + controllers, the <a class="Xr">isp(4)</a> driver will use the firmware + provided by <a class="Xr">ispfw(4)</a> if it is available, and otherwise + use the firmware in flash on the board.</p> + </dd> + <dt id="hint.isp.~5"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.ignore_nvram</var></dt> + <dd>A hint value to ignore board NVRAM settings for. Otherwise use NVRAM + settings.</dd> + <dt id="hint.isp.~6"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.fullduplex</var></dt> + <dd>A hint value to set full duplex mode.</dd> + <dt id="hint.isp.~7"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.topology</var></dt> + <dd>A hint value to select topology of connection. Supported values are: + <p class="Pp"></p> + <dl class="Bl-tag Bl-compact"> + <dt id="lport"><a class="permalink" href="#lport"><code class="Li">lport</code></a></dt> + <dd>Prefer arbitrated loop and fallback to point to point.</dd> + <dt id="nport"><a class="permalink" href="#nport"><code class="Li">nport</code></a></dt> + <dd>Prefer point to point and fallback to arbitrated loop.</dd> + <dt id="lport-only"><a class="permalink" href="#lport-only"><code class="Li">lport-only</code></a></dt> + <dd>Arbitrated loop only.</dd> + <dt id="nport-only"><a class="permalink" href="#nport-only"><code class="Li">nport-only</code></a></dt> + <dd>Point to point only.</dd> + </dl> + </dd> + <dt id="hint.isp.~8"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.portwwn</var></dt> + <dd>This should be the full 64 bit World Wide Port Name you would like to use, + overriding the value in NVRAM for the card.</dd> + <dt id="hint.isp.~9"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.nodewwn</var></dt> + <dd>This should be the full 64 bit World Wide Node Name you would like to use, + overriding the value in NVRAM for the card.</dd> + <dt id="hint.isp.~10"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.iid</var></dt> + <dd>A hint to override or set the Initiator ID or Loop ID. For Fibre Channel + cards in Local Loop topologies it is <var class="Ar">strongly</var> + recommended that you set this value to non-zero.</dd> + <dt id="hint.isp.~11"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.role</var></dt> + <dd>A hint to define default role for isp instance (0 -- none, 1 -- target, 2 + -- initiator, 3 -- both).</dd> + <dt id="hint.isp.~12"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.debug</var></dt> + <dd>A hint value for a driver debug level (see the file + <span class="Pa">/usr/src/sys/dev/isp/ispvar.h</span> for the values.</dd> + <dt id="hint.isp.~13"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.vports</var></dt> + <dd>A hint to create specified number of additional virtual ports.</dd> + <dt id="hint.isp.~14"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.nofctape</var></dt> + <dd>Set this to 1 to disable FC-Tape operation on the given isp instance.</dd> + <dt id="hint.isp.~15"><var class="Va">hint.isp.</var><var class="Ar">N</var><var class="Va">.fctape</var></dt> + <dd>Set this to 1 to enable FC-Tape operation on the given isp instance for + targets that support it.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYSCTL_OPTIONS"><a class="permalink" href="#SYSCTL_OPTIONS">SYSCTL + OPTIONS</a></h1> +<dl class="Bl-tag"> + <dt id="dev.isp."><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.loop_down_limit</var></dt> + <dd>This value says how long to wait in seconds after loop has gone down + before giving up and expiring all of the devices that were visible. The + default is 300 seconds (5 minutes). A separate (nonadjustable) timeout is + used when booting to not stop booting on lack of FC connectivity.</dd> + <dt id="dev.isp.~2"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.gone_device_time</var></dt> + <dd>This value says how long to wait for devices to reappear if they + (temporarily) disappear due to loop or fabric events. While this timeout + is running, I/O to those devices will simply be held.</dd> + <dt id="dev.isp.~3"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.use_gff_id</var></dt> + <dd style="width: auto;"> </dd> + <dt id="dev.isp.~4"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.use_gft_id</var></dt> + <dd>Setting those options to 0 allows to disable use of GFF_ID and GFT_ID SNS + requests during FC fabric scan. It may be useful if switch does not + implement them correctly, preventing some devices from being found. + Disabling them may cause unneeded logins to ports not supporting target + role or even FCP at all. The default is 1 (enabled).</dd> + <dt id="dev.isp.~5"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.wwnn</var></dt> + <dd>This is the readonly World Wide Node Name value for this port.</dd> + <dt id="dev.isp.~6"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.wwpn</var></dt> + <dd>This is the readonly World Wide Port Name value for this port.</dd> + <dt id="dev.isp.~7"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.fw_version_flash</var></dt> + <dd>The readonly flash firmware version value in the active region of the + controller.</dd> + <dt id="dev.isp.~8"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.fw_version_ispfw</var></dt> + <dd>The readonly firmware version value provided by + <a class="Xr">ispfw(4)</a>.</dd> + <dt id="dev.isp.~9"><var class="Va">dev.isp.</var><var class="Ar">N</var><var class="Va">.fw_version_run</var></dt> + <dd>The readonly firmware version value currently executed on the + controller.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">da(4)</a>, <a class="Xr">intro(4)</a>, + <a class="Xr">ispfw(4)</a>, <a class="Xr">sa(4)</a>, + <a class="Xr">scsi(4)</a>, <a class="Xr">gmultipath(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">isp</code> driver was written by + <span class="An">Matthew Jacob</span> originally for NetBSD at NASA/Ames + Research Center. Later improvement was done by + <br/> + <span class="An">Alexander Motin</span> + <<a class="Mt" href="mailto:mav@FreeBSD.org">mav@FreeBSD.org</a>>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">The driver currently ignores some NVRAM settings.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">April 8, 2025</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |