diff options
author | gallatin <gallatin@FreeBSD.org> | 2006-02-19 22:39:19 +0000 |
---|---|---|
committer | gallatin <gallatin@FreeBSD.org> | 2006-02-19 22:39:19 +0000 |
commit | 9a34695ace03c6cf7bf16f38837d5c90c310d5db (patch) | |
tree | 0062dda628f25042020575c33e42389f89e8c7b2 /share/man/man4 | |
parent | 35856d05d214e9842e12f9fa271f43bf8e4ccb90 (diff) | |
download | FreeBSD-src-9a34695ace03c6cf7bf16f38837d5c90c310d5db.zip FreeBSD-src-9a34695ace03c6cf7bf16f38837d5c90c310d5db.tar.gz |
10GbE mode driver and binary firmware for Myricom's PCI-express NICs.
More info regarding these nics can be found at http://www.myri.com.
Please note that the files
sys/dev/myri10ge/{mcp_gen_header.h,myri10ge_mcp.h} are internally
shared between all our drivers (solaris, macosx, windows, linux, etc).
I'd like to keep these files unchanged, so I can just import newer
versions of them when the firmware API/ABI changes. This means I'm
stuck with some of the crazy-long #define names, and possibly
non-style(9) characteristics of these files.
Many thanks to mlaier for doing firmware(9) just as I
needed it, and to scottl for his helpful review.
Reviewed by: scottl, glebius
Sponsored by: Myricom Inc.
Diffstat (limited to 'share/man/man4')
-rw-r--r-- | share/man/man4/mxge.4 | 146 | ||||
-rw-r--r-- | share/man/man4/myri10ge.4 | 146 |
2 files changed, 292 insertions, 0 deletions
diff --git a/share/man/man4/mxge.4 b/share/man/man4/mxge.4 new file mode 100644 index 0000000..c78c6b1 --- /dev/null +++ b/share/man/man4/mxge.4 @@ -0,0 +1,146 @@ +.\" Copyright (c) 2006, Myricom Inc +.\" 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 Myricom Inc 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. +.\" +.\" * Other names and brands may be claimed as the property of others. +.\" +.\" $FreeBSD$ +.\" +.Dd February 9, 2006 +.Dt MYRI10GE 4 +.Os +.Sh NAME +.Nm myri10ge +.Nd "Myricom Myri10GE 10 Gigabit Ethernet adapter driver" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device firmware" +.Cd "device myri10ge" +.Ed +.Pp +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_myri10ge_load="YES" +myri10ge_ethp_z8e_load="YES" +myri10ge_eth_z8e_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for PCI Express 10 Gigabit Ethernet adapters based on +the Myricom LANai Z8E chip. +The driver supports Transmit/Receive checksum offload +and Jumbo Frames. +For further hardware information, see http://www.myri.com +.Pp +For questions related to hardware requirements, +refer to the documentation supplied with your Myri10GE adapter. +All hardware requirements listed apply to use with +.Fx . +.Pp +Support for Jumbo Frames is provided via the interface MTU setting. +Selecting an MTU larger than 1500 bytes with the +.Xr ifconfig 8 +utility configures the adapter to receive and transmit Jumbo Frames. +The maximum MTU size for Jumbo Frames is 9000. +.Pp +For more information on configuring this device, see +.Xr ifconfig 8 . +.Sh HARDWARE +The +.Nm +driver supports 10 Gigabit Ethernet adapters based on the +Myricom LANai Z8E chips: +.Pp +.Bl -bullet -compact +.It +Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C) +.It +Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R) +.It +Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q) +.El +.Sh LOADER TUNABLES +Tunables can be set at the +.Xr loader 8 +prompt before booting the kernel or stored in +.Xr loader.conf 5 . +.Bl -tag -width indent +.It Va hw.myri10ge.flow_control_enabled +Whether or not hardware flow control is enabled on the adapter. +The default value is 1. +.It Va hw.myri10ge.intr_coal_delay +This value delays the generation of all interrupts in units of +1 microsecond. The default value is 30. +.It Va hw.myri10ge.skip_pio_read +This value determines whether or not the driver may omit doing a +pio read in the interrupt handler which ensures that the interrupt +line has been deasserted when using xPIC interrupts. A non-zero value +may result in lower CPU overhead, however it may also result in +spurious interrupts. The default value is 0. +.El +.Sh DIAGNOSTICS +.Bl -diag +.It "myri10ge%d: Unable to allocate bus resource: memory" +A fatal initialization error has occurred. +.It "myri10ge%d: Unable to allocate bus resource: interrupt" +A fatal initialization error has occurred. +.It "myri10ge%d: Could not find firmware image %s" +The appropriate firmware kld module was not installed. This is a +fatal initialization error. +.El +.Sh SUPPORT +For general information and support, +go to the Myricom support website at: +.Pa http://www.myri.com/scs . +.Pp +If an issue is identified with the released source code on the supported kernel +with a supported adapter, email the specific information related to the +issue to +.Aq help@myri.com . +.Sh SEE ALSO +.Xr arp 4 , +.Xr netintro 4 , +.Xr ng_ether 4 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 7.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Andrew Gallatin Aq gallatin@freebsd.org . + diff --git a/share/man/man4/myri10ge.4 b/share/man/man4/myri10ge.4 new file mode 100644 index 0000000..c78c6b1 --- /dev/null +++ b/share/man/man4/myri10ge.4 @@ -0,0 +1,146 @@ +.\" Copyright (c) 2006, Myricom Inc +.\" 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 Myricom Inc 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. +.\" +.\" * Other names and brands may be claimed as the property of others. +.\" +.\" $FreeBSD$ +.\" +.Dd February 9, 2006 +.Dt MYRI10GE 4 +.Os +.Sh NAME +.Nm myri10ge +.Nd "Myricom Myri10GE 10 Gigabit Ethernet adapter driver" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device firmware" +.Cd "device myri10ge" +.Ed +.Pp +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_myri10ge_load="YES" +myri10ge_ethp_z8e_load="YES" +myri10ge_eth_z8e_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for PCI Express 10 Gigabit Ethernet adapters based on +the Myricom LANai Z8E chip. +The driver supports Transmit/Receive checksum offload +and Jumbo Frames. +For further hardware information, see http://www.myri.com +.Pp +For questions related to hardware requirements, +refer to the documentation supplied with your Myri10GE adapter. +All hardware requirements listed apply to use with +.Fx . +.Pp +Support for Jumbo Frames is provided via the interface MTU setting. +Selecting an MTU larger than 1500 bytes with the +.Xr ifconfig 8 +utility configures the adapter to receive and transmit Jumbo Frames. +The maximum MTU size for Jumbo Frames is 9000. +.Pp +For more information on configuring this device, see +.Xr ifconfig 8 . +.Sh HARDWARE +The +.Nm +driver supports 10 Gigabit Ethernet adapters based on the +Myricom LANai Z8E chips: +.Pp +.Bl -bullet -compact +.It +Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C) +.It +Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R) +.It +Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q) +.El +.Sh LOADER TUNABLES +Tunables can be set at the +.Xr loader 8 +prompt before booting the kernel or stored in +.Xr loader.conf 5 . +.Bl -tag -width indent +.It Va hw.myri10ge.flow_control_enabled +Whether or not hardware flow control is enabled on the adapter. +The default value is 1. +.It Va hw.myri10ge.intr_coal_delay +This value delays the generation of all interrupts in units of +1 microsecond. The default value is 30. +.It Va hw.myri10ge.skip_pio_read +This value determines whether or not the driver may omit doing a +pio read in the interrupt handler which ensures that the interrupt +line has been deasserted when using xPIC interrupts. A non-zero value +may result in lower CPU overhead, however it may also result in +spurious interrupts. The default value is 0. +.El +.Sh DIAGNOSTICS +.Bl -diag +.It "myri10ge%d: Unable to allocate bus resource: memory" +A fatal initialization error has occurred. +.It "myri10ge%d: Unable to allocate bus resource: interrupt" +A fatal initialization error has occurred. +.It "myri10ge%d: Could not find firmware image %s" +The appropriate firmware kld module was not installed. This is a +fatal initialization error. +.El +.Sh SUPPORT +For general information and support, +go to the Myricom support website at: +.Pa http://www.myri.com/scs . +.Pp +If an issue is identified with the released source code on the supported kernel +with a supported adapter, email the specific information related to the +issue to +.Aq help@myri.com . +.Sh SEE ALSO +.Xr arp 4 , +.Xr netintro 4 , +.Xr ng_ether 4 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 7.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Andrew Gallatin Aq gallatin@freebsd.org . + |