svn commit: r232106 - stable/8/share/man/man4

[Christian Brueffer]

Author: brueffer
Date: Fri Feb 24 12:22:29 2012
New Revision: 232106
URL: http://svn.freebsd.org/changeset/base/232106

Log:
  MFC: r231880,r231915,r231937
  
  Add a manpage for the oce(4) driver.
  
  Approved by:	re (kib)

Added:
  stable/8/share/man/man4/oce.4
     - copied, changed from r231880, head/share/man/man4/oce.4
Modified:
  stable/8/share/man/man4/Makefile
Directory Properties:
  stable/8/share/man/man4/   (props changed)

Modified: stable/8/share/man/man4/Makefile
==============================================================================
--- stable/8/share/man/man4/Makefile	Fri Feb 24 11:40:20 2012	(r232105)
+++ stable/8/share/man/man4/Makefile	Fri Feb 24 12:22:29 2012	(r232106)
@@ -315,6 +315,7 @@ MAN=	aac.4 \
 	${_nve.4} \
 	${_nvram.4} \
 	${_nxge.4} \
+	oce.4 \
 	ohci.4 \
 	orm.4 \
 	${_padlock.4} \

Copied and modified: stable/8/share/man/man4/oce.4 (from r231880, head/share/man/man4/oce.4)
==============================================================================
--- head/share/man/man4/oce.4	Fri Feb 17 14:02:44 2012	(r231880, copy source)
+++ stable/8/share/man/man4/oce.4	Fri Feb 24 12:22:29 2012	(r232106)
@@ -36,9 +36,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-
-
-.Dd February 14, 2012
+.Dd February 19, 2012
 .Dt OCE 4
 .Os
 .Sh NAME
@@ -49,64 +47,85 @@ To compile this driver into the kernel,
 place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
+.Cd "device pci"
 .Cd "device oce"
 .Ed
 .Pp
-To load the driver as a
+Alternatively, 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
+Emulex OneConnect adapters come in various skews and with
 different combinations of NIC, FCoE and iSCSI functions.
-oce claims the NIC functions in all these adapters.
+The
+.Nm
+driver 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.	
+Receive-Side Scaling (RSS) and MSI-X interrupts.
 .Sh HARDWARE
+The
 .Nm
-driver supports the following Emulex network adapters:
+driver supports the following network adapters:
+.Pp
 .Bl -bullet -compact
 .It
-BladeEngine 2
+Emulex BladeEngine 2
 .It
-BladeEngine 3
+Emulex BladeEngine 3
 .It
-Lancer
+Emulex Lancer
 .El
 .Sh UPDATING FIRMWARE
 Adapter firmware updates are persistent.
-
+.Pp
 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.
-
+.Bl -enum
+.It
+Copy the below code to a Makefile:
+.Pp
+.Bd -literal -offset indent
+\&.KMOD=elxflash
+FIRMWS=imagename.ufi:elxflash
+\&.include <bsd.kmod.mk>
+.Ed
+.It
+Replace imagename in above with UFI file name
+.It
+Copy Makefile and UFI file to a directory
+.It
+Execute make & copy generated elxflash.ko to
+.Pa /lib/modules
+.It
+sysctl dev.oce.<if_id>.fw_upgrade=elxflash
+.It
+Reboot the machine
+.El
+.Pp
 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
+of the following errors.
+.Pp
+.Bl -enum -compact
+.It
+.Qq Invalid BE3 firmware image
+.It
+.Qq "Invalid Cookie. Firmware image corrupted ?"
+.It
+.Qq cmd to write to flash rom failed.
+.El
 .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 at emulex.com.
+.Pa http://www.Emulex.com/
+or E-Mail at
+.Pa freebsd-drivers at emulex.com .
 .Sh SEE ALSO
 .Xr ifconfig 8
 .Sh AUTHORS
@@ -114,4 +133,4 @@ or E-Mail at 
 The
 .Nm
 driver was written by
-.An freebsd-drivers at emulex.com.
+.An freebsd-drivers at emulex.com .