Index: share/man/man4/ocs_fc.4 =================================================================== --- /dev/null +++ share/man/man4/ocs_fc.4 @@ -0,0 +1,176 @@ +.\" Copyright (c) 2017 Broadcom. All rights reserved. +.\" The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright notice, +.\" this list of conditions and the following disclaimer in the documentation +.\" and/or other materials provided with the distribution. +.\" +.\" 3. Neither the name of the copyright holder nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" + +.Dd November 10, 2017 +.Dt OCS_FC 4 +.Os +.Sh NAME +.Nm ocs_fc +.Nd Device driver for Emulex Fibre Channel Host Adapters +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device ocs_fc" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +ocs_fc_load="YES" +.Ed +.Sh DESCRIPTION +This driver provides access to FibreChannel SCSI devices. +.Pp +The +.Nm +driver supports initiator and target modes. +Support is available for Arbitrated loops, Point-to-Point +and Fabric connections. +FC-Tape is highly recommended for connections to tape drives that support +it. +It encompasses four elements from the T-10 FCP-4 specification: +.Bl -bullet -offset indent +.It +Precise Delivery of Commands +.It +Confirmed Completion of FCP I/O Operations +.It +Retransmission of Unsuccessfully Transmitted IUs +.It +Task Retry Identification +.El +.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. + +.Sh HARDWARE +The +.Nm +Driver supports the following FibreChannel adapters: +.Bl -tag -width xxxxxx -offset indent +.It Emulex 16/8G FC GEN 5 HBAS +.Bd -literal -offset indent +LPe15004 FC Host Bus Adapters. +LPe1600XX FC Host Bus Adapters. +.Ed +.It Emulex 16/8G FC GEN 6 HBAS +.Bd -literal -offset indent +LPe3100X FC Host Bus Adapters. +LPe3200X FC Host Bus Adapters. +.Ed +.El +.Sh UPDATING FIRMWARE +Adapter firmware updates are persistent. +.Pp +Firmware can be updated by following the steps below: +.Bl -enum +.It +Copy the below code to a Makefile: +.Bd -literal -offset indent +KMOD=ocsflash +FIRMWS=imagename.grp:ocsflash +\&.include +.Ed +.It +Replace imagename in above with GRP file name +.It +Copy Makefile and GRP file to a directory +.It +Execute make & copy generated ocsflash.ko to +.Pa /lib/modules +.It +sysctl dev.ocs_fc..fw_upgrade=ocsflash +.It +Check kernel messages regarding status of the operation +.It +Reboot the machine +.El +.Pp +.Sh BOOT OPTIONS +The following options are switchable by setting values in +.Pa /boot/device.hints . +.Pp +They are: +.Bl -tag -width indent +.It Va hint.ocs_fc.N.initiator +A hint value to disable or enable initiator functionality. +Default is 1 (enabled). Set to 0 to disable. +.It Va hint.ocs_fc.N.target +A hint value to disable or enable target functionality. +Default is 1 (enabled). Set to 0 to disable. +.It Va hint.ocs_fc.N.topology +Configure Topology, 0-Auto; 1-NPort only; 2-Loop only. +.It Va hint.ocs_fc.N.speed +Sets the link speed. Value is in megabits per second. Possible values include: + 0 Auto-speed negotiation (default), 4000 (4GFC), 8000 (8GFC), 16000 (16GFC) +.El +.Sh SYSCTL OPTIONS +.Bl -tag -width indent +.It Va dev.ocs_fc.N.port_state +Read and configure port state. Valid values "online","offline". +.It Va dev.ocs_fc.N.wwpn +Read and configure World Wide Node Name value for this port. +.It Va dev.ocs_fc.N.wwnn +Read and configure World Wide Node Name value for this port. +.It Va dev.ocs_fc.N.fwrev +This is the readonly Firmware revision. +.It Va dev.ocs_fc.N.sn +This is the readonly Adapter serial number. +.It Va dev.ocs_fc.N.configured_speed +Configure Port Speed, 0-Auto, 2000, 4000, 8000, 16000, 32000 +.It Va dev.ocs_fc.N.configured_topology +Configure Topology, 0-Auto; 1-NPort; 2-Loop +.It Va dev.ocs_fc.N.current_speed +Current Port Speed. +.It Va dev.ocs_fc.N.current_topology +Current Port Topology. +.El +.Sh SUPPORT +For general information and support, +go to the Broadcom website at: +.Pa http://www.broadcom.com/ +or E-Mail at +.Pa ocs-driver-team.pdl@broadcom.com. +.Sh SEE ALSO +.Xr ifconfig 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Broadcom.