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.\" $FreeBSD$ 31.\" 32.Dd March 30, 2018 33.Dt OCS_FC 4 34.Os 35.Sh NAME 36.Nm ocs_fc 37.Nd "Device driver for Emulex Fibre Channel Host Adapters" 38.Sh SYNOPSIS 39To compile this driver into the kernel, add this line to the 40kernel configuration file: 41.Bd -ragged -offset indent 42.Cd "device ocs_fc" 43.Ed 44.Pp 45To load the driver as a module at boot, add this line to 46.Xr loader.conf 5 : 47.Bd -literal -offset indent 48ocs_fc_load="YES" 49.Ed 50.Sh DESCRIPTION 51The 52.Nm 53driver provides access to Fibre Channel SCSI devices. 54.Pp 55The 56.Nm 57driver supports initiator and target modes. 58Support is available for Arbitrated loops, Point-to-Point, 59and Fabric connections. 60FC-Tape is highly recommended for connections to tape drives that support 61it. 62FC-Tape includes four elements from the T-10 FCP-4 specification: 63.Bl -bullet -offset indent 64.It 65Precise Delivery of Commands 66.It 67Confirmed Completion of FCP I/O Operations 68.It 69Retransmission of Unsuccessfully Transmitted IUs 70.It 71Task Retry Identification 72.El 73.Pp 74Together these features allow for link level error recovery with tape 75devices. 76Without link level error recovery, an initiator cannot, for instance, tell whether a tape write 77command that has timed out resulted in all, part, or none of the data going to 78the tape drive. 79FC-Tape is automatically enabled when both the controller and target support it. 80 81.Sh HARDWARE 82The 83.Nm 84driver supports these Fibre Channel adapters: 85.Bl -tag -width xxxxxx -offset indent 86.It Emulex 16/8G FC GEN 5 HBAS 87.Bd -literal -offset indent 88LPe15004 FC Host Bus Adapters 89LPe160XX FC Host Bus Adapters 90.Ed 91.It Emulex 32/16G FC GEN 6 HBAS 92.Bd -literal -offset indent 93LPe3100X FC Host Bus Adapters 94LPe3200X FC Host Bus Adapters 95.Ed 96.El 97.Sh UPDATING FIRMWARE 98Adapter firmware updates are persistent. 99.Pp 100Firmware can be updated by following these steps: 101.Bl -enum 102.It 103Copy this code to a 104.Pa Makefile : 105.Bd -literal -offset indent 106KMOD=ocsflash 107FIRMWS=imagename.grp:ocsflash 108\&.include <bsd.kmod.mk> 109.Ed 110.It 111Replace 112.Pa imagename 113with the name of the GRP file. 114.It 115Copy the 116.Pa Makefile 117and GRP file to a local directory 118.It 119Execute 120.Cm make 121and copy the generated 122.Pa ocsflash.ko 123file to 124.Pa /lib/modules 125.It 126.Cm sysctl dev.ocs_fc.<N>.fw_upgrade=ocsflash 127.It 128Check kernel messages regarding status of the operation 129.It 130Reboot the machine 131.El 132.Pp 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