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