summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/oce.4 3.html
blob: c33aa18e428286b5c6c95217ec502e0f7f562847 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<table class="head">
  <tr>
    <td class="head-ltitle">OCE(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">OCE(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">oce</code> &#x2014; <span class="Nd">Device
    driver for Emulex OneConnect 10Gb network adapters</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device pci</code>
<br/>
<code class="Cd">device oce</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_oce_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">Emulex OneConnect adapters come in various skews and with
    different combinations of NIC, FCoE and iSCSI functions. The
    <code class="Nm">oce</code> driver claims the NIC functions in all these
    adapters.</p>
<p class="Pp">The <code class="Nm">oce</code> driver supports VLAN Hardware
    offload, TCP checksum offload, TCP segmentation offload (TSO), Large receive
    offload (LRO), Bonding, Jumbo frames (from 1500 - 9000), Multiple TX queues,
    Receive-Side Scaling (RSS) and MSI-X interrupts.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">oce</code> driver supports the following
    network adapters:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Emulex BladeEngine 2</li>
  <li>Emulex BladeEngine 3</li>
  <li>Emulex Lancer</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="UPDATING_FIRMWARE"><a class="permalink" href="#UPDATING_FIRMWARE">UPDATING
  FIRMWARE</a></h1>
<p class="Pp">Adapter firmware updates are persistent.</p>
<p class="Pp">Firmware can be updated by following the steps below:</p>
<ol class="Bl-enum">
  <li>Copy the below code to a Makefile:
    <div class="Bd Pp Bd-indent Li">
    <pre>KMOD=elxflash
FIRMWS=imagename.ufi:elxflash
.include &lt;bsd.kmod.mk&gt;</pre>
    </div>
  </li>
  <li>Replace imagename in above with UFI file name</li>
  <li>Copy Makefile and UFI file to a directory</li>
  <li>Execute make &amp; copy generated elxflash.ko to
      <span class="Pa">/lib/modules</span></li>
  <li>sysctl dev.oce.&lt;if_id&gt;.fw_upgrade=elxflash</li>
  <li>Reboot the machine</li>
</ol>
<p class="Pp">In case of issues with supplied UFI, flashing fails with one of
    the following errors.</p>
<p class="Pp"></p>
<ol class="Bl-enum Bl-compact">
  <li>&quot;Invalid BE3 firmware image&quot;</li>
  <li>&quot;Invalid Cookie. Firmware image corrupted ?&quot;</li>
  <li>&quot;cmd to write to flash rom failed.&quot;</li>
</ol>
</section>
<section class="Sh">
<h1 class="Sh" id="SUPPORT"><a class="permalink" href="#SUPPORT">SUPPORT</a></h1>
<p class="Pp">For general information and support, go to the Emulex website at:
    <span class="Pa">http://www.Emulex.com/</span> or E-Mail at
    <span class="Pa">freebsd-drivers@emulex.com</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">ifconfig(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">oce</code> driver was written by
    <span class="An">freebsd-drivers@emulex.com</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">January 27, 2025</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>