1.\" Copyright (c) 2017 Broadcom. All rights reserved. 2.\" The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions are met: 6.\" 7.\" 1. Redistributions of source code must retain the above copyright notice, 8.\" this list of conditions and the following disclaimer. 9.\" 10.\" 2. Redistributions in binary form must reproduce the above copyright notice, 11.\" this list of conditions and the following disclaimer in the documentation 12.\" and/or other materials provided with the distribution. 13.\" 14.\" 3. Neither the name of the copyright holder nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd December 29, 2021 31.Dt OCS_FC 4 32.Os 33.Sh NAME 34.Nm ocs_fc 35.Nd "Device driver for Emulex Fibre Channel Host Adapters" 36.Sh SYNOPSIS 37To compile this driver into the kernel, add this line to the 38kernel configuration file: 39.Bd -ragged -offset indent 40.Cd "device ocs_fc" 41.Ed 42.Pp 43To load the driver as a module at boot, add this line to 44.Xr loader.conf 5 : 45.Bd -literal -offset indent 46ocs_fc_load="YES" 47.Ed 48.Sh DESCRIPTION 49The 50.Nm 51driver provides access to Fibre Channel SCSI devices. 52.Pp 53The 54.Nm 55driver supports initiator and target modes. 56Support is available for Arbitrated loops, Point-to-Point, 57and Fabric connections. 58FC-Tape is highly recommended for connections to tape drives that support 59it. 60FC-Tape includes four elements from the T-10 FCP-4 specification: 61.Bl -bullet -offset indent 62.It 63Precise Delivery of Commands 64.It 65Confirmed Completion of FCP I/O Operations 66.It 67Retransmission of Unsuccessfully Transmitted IUs 68.It 69Task Retry Identification 70.El 71.Pp 72Together these features allow for link level error recovery with tape 73devices. 74Without link level error recovery, an initiator cannot, for instance, tell whether a tape write 75command that has timed out resulted in all, part, or none of the data going to 76the tape drive. 77FC-Tape is automatically enabled when both the controller and target support it. 78.Sh HARDWARE 79The 80.Nm 81driver supports these Fibre Channel adapters: 82.Bl -tag -width xxxxxx -offset indent 83.It Emulex 16/8G FC GEN 5 HBAS 84.Bd -literal -offset indent 85LPe15004 FC Host Bus Adapters 86LPe160XX FC Host Bus Adapters 87.Ed 88.It Emulex 32/16G FC GEN 6 HBAS 89.Bd -literal -offset indent 90LPe3100X FC Host Bus Adapters 91LPe3200X FC Host Bus Adapters 92.Ed 93.It Emulex 64/32G FC GEN 7 HBAS 94.Bd -literal -offset indent 95LPe3500X FC Host Bus Adapters 96.Ed 97.El 98.Sh UPDATING FIRMWARE 99Adapter firmware updates are persistent. 100.Pp 101Firmware can be updated by following these steps: 102.Bl -enum 103.It 104Copy this code to a 105.Pa Makefile : 106.Bd -literal -offset indent 107KMOD=ocsflash 108FIRMWS=imagename.grp:ocsflash 109\&.include <bsd.kmod.mk> 110.Ed 111.It 112Replace 113.Pa imagename 114with the name of the GRP file. 115.It 116Copy the 117.Pa Makefile 118and GRP file to a local directory 119.It 120Execute 121.Cm make 122and copy the generated 123.Pa ocsflash.ko 124file to 125.Pa /lib/modules 126.It 127.Cm sysctl dev.ocs_fc.<N>.fw_upgrade=ocsflash 128.It 129Check kernel messages regarding status of the operation 130.It 131Reboot the machine 132.El 133.Sh BOOT OPTIONS 134Options are controlled by setting values in 135.Pa /boot/device.hints . 136.Pp 137They are: 138.Bl -tag -width indent 139.It Va hint.ocs_fc.N.initiator 140Enable initiator functionality. 141Default 1 (enabled), 0 to disable. 142.It Va hint.ocs_fc.N.target 143Enable target functionality. 144Default 1 (enabled), 0 to disable. 145.It Va hint.ocs_fc.N.topology 146Topology: 0 for Auto, 1 for NPort only, 2 for Loop only. 147.It Va hint.ocs_fc.N.speed 148Link speed in megabits per second. 149Possible values include: 1500 Auto-speed negotiation (default), 4000 (4GFC), 8000 (8GFC), 16000 (16GFC). 151.El 152.Sh SYSCTL OPTIONS 153.Bl -tag -width indent 154.It Va dev.ocs_fc.N.port_state 155Port state (read/write). 156Valid values are 157.Li online 158and 159.Li offline . 160.It Va dev.ocs_fc.N.wwpn 161World Wide Port Name (read/write). 162.It Va dev.ocs_fc.N.wwnn 163World Wide Node Name (read/write). 164.It Va dev.ocs_fc.N.fwrev 165Firmware revision (read-only). 166.It Va dev.ocs_fc.N.sn 167Adapter serial number (read-only). 168.It Va dev.ocs_fc.N.configured_speed 169Configured Port Speed (read/write). 170Valid values are: 1710 Auto-speed negotiation (default), 4000 (4GFC), 8000 (8GFC), 16000 (16GFC). 172.It Va dev.ocs_fc.N.configured_topology 173Configured Port Topology (read/write). 174Valid values are: 1750-Auto; 1-NPort; 2-Loop. 176.It Va dev.ocs_fc.N.current_speed 177Current Port Speed (read-only). 178.It Va dev.ocs_fc.N.current_topology 179Current Port Topology (read-only). 180.El 181.Sh SUPPORT 182For general information and support, 183go to the Broadcom website at: 184.Pa http://www.broadcom.com/ 185or E-Mail at 186.Pa ocs-driver-team.pdl@broadcom.com . 187.Sh SEE ALSO 188.Xr ifconfig 8 189.Sh AUTHORS 190.An -nosplit 191The 192.Nm 193driver was written by 194.An Broadcom . 195