From owner-svn-src-all@FreeBSD.ORG Fri Feb 17 14:02:45 2012 Return-Path: Delivered-To: svn-src-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 41F6D106564A; Fri, 17 Feb 2012 14:02:45 +0000 (UTC) (envelope-from luigi@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 2CD488FC18; Fri, 17 Feb 2012 14:02:45 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q1HE2jB6081451; Fri, 17 Feb 2012 14:02:45 GMT (envelope-from luigi@svn.freebsd.org) Received: (from luigi@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q1HE2iEu081448; Fri, 17 Feb 2012 14:02:44 GMT (envelope-from luigi@svn.freebsd.org) Message-Id: <201202171402.q1HE2iEu081448@svn.freebsd.org> From: Luigi Rizzo Date: Fri, 17 Feb 2012 14:02:44 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org X-SVN-Group: head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r231880 - head/share/man/man4 X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 17 Feb 2012 14:02:45 -0000 Author: luigi Date: Fri Feb 17 14:02:44 2012 New Revision: 231880 URL: http://svn.freebsd.org/changeset/base/231880 Log: add manpage for the "oce" driver Submitted by: Naresh Raju Gottumukkala (Emulex) MFC after: 3 days Added: head/share/man/man4/oce.4 (contents, props changed) Modified: head/share/man/man4/Makefile Modified: head/share/man/man4/Makefile ============================================================================== --- head/share/man/man4/Makefile Fri Feb 17 13:55:17 2012 (r231879) +++ head/share/man/man4/Makefile Fri Feb 17 14:02:44 2012 (r231880) @@ -328,6 +328,7 @@ MAN= aac.4 \ ${_nvram.4} \ ${_nvram2env.4} \ ${_nxge.4} \ + oce.4 \ ohci.4 \ orm.4 \ ${_padlock.4} \ Added: head/share/man/man4/oce.4 ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/share/man/man4/oce.4 Fri Feb 17 14:02:44 2012 (r231880) @@ -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 " + 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..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.