xref: /dragonfly/share/man/man4/oce.4 (revision c3762235)
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: src/share/man/man4/oce.4,v 1.7 2013/07/07 00:30:13 svnexp Exp $
38.\"
39.Dd July 1, 2013
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
70.\"VLAN Hardware offload,
71TCP checksum offload,
72.\"TCP segmentation offload (TSO), Large receive offload (LRO),
73Bonding, and Jumbo frames (from 1500 - 9000).
74.\"Multiple TX queues, Receive-Side Scaling (RSS) and MSI-X interrupts.
75.Sh HARDWARE
76The
77.Nm
78driver supports the following network adapters:
79.Pp
80.Bl -bullet -compact
81.It
82Emulex BladeEngine 2
83.It
84Emulex BladeEngine 3
85.It
86Emulex Lancer
87.El
88.Sh UPDATING FIRMWARE
89Adapter firmware updates are persistent.
90.Pp
91Firmware can be updated by following the steps below:
92.Bl -enum
93.It
94Copy the below code to a Makefile:
95.Bd -literal -offset indent
96KMOD=elxflash
97FIRMWS=imagename.ufi:elxflash
98\&.include <bsd.kmod.mk>
99.Ed
100.It
101Replace imagename in above with UFI file name
102.It
103Copy Makefile and UFI file to a directory
104.It
105Execute make & make install
106.It
107sysctl hw.oce<if_id>.fw_upgrade=elxflash
108.It
109Reboot the machine
110.El
111.Pp
112In case of issues with supplied UFI, flashing fails with one
113of the following errors.
114.Pp
115.Bl -enum -compact
116.It
117.Qq Invalid BE3 firmware image
118.It
119.Qq "Invalid Cookie. Firmware image corrupted ?"
120.It
121.Qq cmd to write to flash rom failed.
122.El
123.Sh SUPPORT
124For general information and support,
125go to the Emulex website at:
126.Pa http://www.Emulex.com/
127or E-Mail at
128.Pa freebsd-drivers@emulex.com .
129.Sh SEE ALSO
130.Xr ifmedia 4 ,
131.Xr ifconfig 8
132.Sh AUTHORS
133.An -nosplit
134The
135.Nm
136driver was written by
137.An freebsd-drivers@emulex.com .
138