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