diff options
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man4/Makefile | 1 | ||||
-rw-r--r-- | share/man/man4/oce.4 | 117 |
2 files changed, 118 insertions, 0 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 90f9554ff673..39db5344771b 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -328,6 +328,7 @@ MAN= aac.4 \ ${_nvram.4} \ ${_nvram2env.4} \ ${_nxge.4} \ + oce.4 \ ohci.4 \ orm.4 \ ${_padlock.4} \ diff --git a/share/man/man4/oce.4 b/share/man/man4/oce.4 new file mode 100644 index 000000000000..b8af43247594 --- /dev/null +++ b/share/man/man4/oce.4 @@ -0,0 +1,117 @@ +.\" Copyright (C) 2012 Emulex +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" 3. Neither the name of the Emulex Corporation nor the names of its +.\" contributors may be used to endorse or promote products derived from +.\" this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" Contact Information: +.\" freebsd-drivers@emulex.com +.\" +.\" Emulex +.\" 3333 Susan Street +.\" Costa Mesa, CA 92626 +.\" +.\" $FreeBSD$ +.\" + + +.Dd February 14, 2012 +.Dt OCE 4 +.Os +.Sh NAME +.Nm oce +.Nd "Device driver for Emulex OneConnect 10Gb network adapters" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device oce" +.Ed +.Pp +To load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_oce_load="YES" +.Ed +.Sh DESCRIPTION +Emulex one connect adapters come in various skews and with +different combinations of NIC, FCoE and iSCSI functions. +oce claims the NIC functions in all these adapters. +.Pp +The +.Nm +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. +.Sh HARDWARE +.Nm +driver supports the following Emulex network adapters: +.Bl -bullet -compact +.It +BladeEngine 2 +.It +BladeEngine 3 +.It +Lancer +.El +.Sh UPDATING FIRMWARE +Adapter firmware updates are persistent. + +Firmware can be updated by following the steps below: +.nf + 1) Copy the below code to a Makefile + ".KMOD=elxflash + FIRMWS=imagename.ufi:elxflash + .include <bsd.kmod.mk>" + 2) Replace imagename in above with UFI file name. + 3) Copy Makefile and UFI to a directory + 4) Execute make & copy generated elxflash.ko to /lib/modules + 5) sysctl dev.oce.<if_id>.fw_upgrade=elxflash + 6) Reboot the machine. + +In case of issues with supplied UFI, flashing fails with one +of the below errors. + 1) "Invalid BE3 firmware image" + 2) "Invalid Cookie. Firmware image corrupted ?" + 3) "cmd to write to flash rom failed." +.fi +.Sh SUPPORT +For general information and support, +go to the Emulex website at: +.Fa http://www.Emulex.com/ +or E-Mail at +.Fa freebsd-drivers@emulex.com. +.Sh SEE ALSO +.Xr ifconfig 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An freebsd-drivers@emulex.com. |