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