share/man/man4/oce.4

   1 .\" Copyright (C) 2013 Emulex
   2 .\" All rights reserved.
   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
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"   documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" 3. Neither the name of the Emulex Corporation nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived from
  16 .\"    this software 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 OWNER 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 .\" Contact Information:
  31 .\" freebsd-drivers@emulex.com
  32 .\"
  33 .\" Emulex
  34 .\" 3333 Susan Street
  35 .\" Costa Mesa, CA 92626
  36 .\"
  37 .Dd June 13, 2023
  38 .Dt OCE 4
  39 .Os
  40 .Sh NAME
  41 .Nm oce
  42 .Nd "Device driver for Emulex OneConnect 10Gb network adapters"
  43 .Sh SYNOPSIS
  44 To compile this driver into the kernel,
  45 place the following lines in your
  46 kernel configuration file:
  47 .Bd -ragged -offset indent
  48 .Cd "device pci"
  49 .Cd "device oce"
  50 .Ed
  51 .Pp
  52 Alternatively, to load the driver as a
  53 module at boot time, place the following line in
  54 .Xr loader.conf 5 :
  55 .Bd -literal -offset indent
  56 if_oce_load="YES"
  57 .Ed
  58 .Sh DEPRECATION NOTICE
  59 The
  60 .Nm
  61 driver may not be present in
  62 .Fx 15.0
  63 and later.
  64 .Sh DESCRIPTION
  65 Emulex OneConnect adapters come in various skews and with
  66 different combinations of NIC, FCoE and iSCSI functions.
  67 The
  68 .Nm
  69 driver claims the NIC functions in all these adapters.
  70 .Pp
  71 The
  72 .Nm
  73 driver supports VLAN Hardware offload, TCP checksum offload,
  74 TCP segmentation offload (TSO), Large receive offload (LRO),
  75 Bonding, Jumbo frames (from 1500 - 9000), Multiple TX queues,
  76 Receive-Side Scaling (RSS) and MSI-X interrupts.
  77 .Sh HARDWARE
  78 The
  79 .Nm
  80 driver supports the following network adapters:
  81 .Pp
  82 .Bl -bullet -compact
  83 .It
  84 Emulex BladeEngine 2
  85 .It
  86 Emulex BladeEngine 3
  87 .It
  88 Emulex Lancer
  89 .El
  90 .Sh UPDATING FIRMWARE
  91 Adapter firmware updates are persistent.
  92 .Pp
  93 Firmware can be updated by following the steps below:
  94 .Bl -enum
  95 .It
  96 Copy the below code to a Makefile:
  97 .Bd -literal -offset indent
  98 KMOD=elxflash
  99 FIRMWS=imagename.ufi:elxflash
 100 \&.include <bsd.kmod.mk>
 101 .Ed
 102 .It
 103 Replace imagename in above with UFI file name
 104 .It
 105 Copy Makefile and UFI file to a directory
 106 .It
 107 Execute make & copy generated elxflash.ko to
 108 .Pa /lib/modules
 109 .It
 110 sysctl dev.oce.<if_id>.fw_upgrade=elxflash
 111 .It
 112 Reboot the machine
 113 .El
 114 .Pp
 115 In case of issues with supplied UFI, flashing fails with one
 116 of the following errors.
 117 .Pp
 118 .Bl -enum -compact
 119 .It
 120 .Qq Invalid BE3 firmware image
 121 .It
 122 .Qq "Invalid Cookie. Firmware image corrupted ?"
 123 .It
 124 .Qq cmd to write to flash rom failed.
 125 .El
 126 .Sh SUPPORT
 127 For general information and support,
 128 go to the Emulex website at:
 129 .Pa http://www.Emulex.com/
 130 or E-Mail at
 131 .Pa freebsd-drivers@emulex.com .
 132 .Sh SEE ALSO
 133 .Xr ifconfig 8
 134 .Sh AUTHORS
 135 .An -nosplit
 136 The
 137 .Nm
 138 driver was written by
 139 .An freebsd-drivers@emulex.com .