1.\" Copyright (c) 2006, Myricom Inc
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 Myricom Inc 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.\" * Other names and brands may be claimed as the property of others.
31.\"
| 1.\" Copyright (c) 2006, Myricom Inc
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 Myricom Inc 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.\" * Other names and brands may be claimed as the property of others.
31.\"
|
32.\" $FreeBSD: head/share/man/man4/mxge.4 162331 2006-09-15 19:33:15Z brueffer $
| 32.\" $FreeBSD: head/share/man/man4/mxge.4 162871 2006-09-30 15:14:49Z ru $
|
33.\"
34.Dd September 15, 2006
35.Dt MXGE 4
36.Os
37.Sh NAME
38.Nm mxge
39.Nd "Myricom Myri10GE 10 Gigabit Ethernet adapter driver"
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following lines in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device firmware"
46.Cd "device mxge"
47.Ed
48.Pp
49Alternatively, to load the driver as a
50module at boot time, place the following lines in
51.Xr loader.conf 5 :
52.Bd -literal -offset indent
53if_mxge_load="YES"
54mxge_ethp_z8e_load="YES"
55mxge_eth_z8e_load="YES"
56.Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver provides support for PCI Express 10 Gigabit Ethernet adapters based on
61the Myricom LANai Z8E chip.
62The driver supports Transmit/Receive checksum offload,
63Jumbo Frames as well as TCP segmentation offload (TSO).
| 33.\"
34.Dd September 15, 2006
35.Dt MXGE 4
36.Os
37.Sh NAME
38.Nm mxge
39.Nd "Myricom Myri10GE 10 Gigabit Ethernet adapter driver"
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following lines in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device firmware"
46.Cd "device mxge"
47.Ed
48.Pp
49Alternatively, to load the driver as a
50module at boot time, place the following lines in
51.Xr loader.conf 5 :
52.Bd -literal -offset indent
53if_mxge_load="YES"
54mxge_ethp_z8e_load="YES"
55mxge_eth_z8e_load="YES"
56.Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver provides support for PCI Express 10 Gigabit Ethernet adapters based on
61the Myricom LANai Z8E chip.
62The driver supports Transmit/Receive checksum offload,
63Jumbo Frames as well as TCP segmentation offload (TSO).
|
64For further hardware information, see http://www.myri.com
| 64For further hardware information, see
65.Pa http://www.myri.com/ .
|
65.Pp
66For questions related to hardware requirements,
67refer to the documentation supplied with your Myri10GE adapter.
68All hardware requirements listed apply to use with
69.Fx .
70.Pp
71Support for Jumbo Frames is provided via the interface MTU setting.
72Selecting an MTU larger than 1500 bytes with the
73.Xr ifconfig 8
74utility configures the adapter to receive and transmit Jumbo Frames.
75The maximum MTU size for Jumbo Frames is 9000.
76.Pp
77For more information on configuring this device, see
78.Xr ifconfig 8 .
79.Sh HARDWARE
80The
81.Nm
82driver supports 10 Gigabit Ethernet adapters based on the
83Myricom LANai Z8E chips:
84.Pp
85.Bl -bullet -compact
86.It
87Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C)
88.It
89Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R)
90.It
91Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)
92.El
93.Sh LOADER TUNABLES
94Tunables can be set at the
95.Xr loader 8
96prompt before booting the kernel or stored in
97.Xr loader.conf 5 .
98.Bl -tag -width indent
99.It Va hw.mxge.flow_control_enabled
100Whether or not hardware flow control is enabled on the adapter.
101The default value is 1.
102.It Va hw.mxge.intr_coal_delay
103This value delays the generation of all interrupts in units of
1041 microsecond.
105The default value is 30.
106.It Va hw.mxge.skip_pio_read
107This value determines whether or not the driver may omit doing a
108pio read in the interrupt handler which ensures that the interrupt
109line has been deasserted when using xPIC interrupts.
| 66.Pp
67For questions related to hardware requirements,
68refer to the documentation supplied with your Myri10GE adapter.
69All hardware requirements listed apply to use with
70.Fx .
71.Pp
72Support for Jumbo Frames is provided via the interface MTU setting.
73Selecting an MTU larger than 1500 bytes with the
74.Xr ifconfig 8
75utility configures the adapter to receive and transmit Jumbo Frames.
76The maximum MTU size for Jumbo Frames is 9000.
77.Pp
78For more information on configuring this device, see
79.Xr ifconfig 8 .
80.Sh HARDWARE
81The
82.Nm
83driver supports 10 Gigabit Ethernet adapters based on the
84Myricom LANai Z8E chips:
85.Pp
86.Bl -bullet -compact
87.It
88Myricom 10GBase-CX4 (10G-PCIE-8A-C, 10G-PCIE-8AL-C)
89.It
90Myricom 10GBase-R (10G-PCIE-8A-R, 10G-PCIE-8AL-R)
91.It
92Myricom 10G XAUI over ribbon fiber (10G-PCIE-8A-Q, 10G-PCIE-8AL-Q)
93.El
94.Sh LOADER TUNABLES
95Tunables can be set at the
96.Xr loader 8
97prompt before booting the kernel or stored in
98.Xr loader.conf 5 .
99.Bl -tag -width indent
100.It Va hw.mxge.flow_control_enabled
101Whether or not hardware flow control is enabled on the adapter.
102The default value is 1.
103.It Va hw.mxge.intr_coal_delay
104This value delays the generation of all interrupts in units of
1051 microsecond.
106The default value is 30.
107.It Va hw.mxge.skip_pio_read
108This value determines whether or not the driver may omit doing a
109pio read in the interrupt handler which ensures that the interrupt
110line has been deasserted when using xPIC interrupts.
|
110A non-zero value
| 111A non-zero value
|
111may result in lower CPU overhead, however it may also result in
112spurious interrupts.
113The default value is 0.
114.El
115.Sh DIAGNOSTICS
116.Bl -diag
117.It "mxge%d: Unable to allocate bus resource: memory"
118A fatal initialization error has occurred.
119.It "mxge%d: Unable to allocate bus resource: interrupt"
120A fatal initialization error has occurred.
121.It "mxge%d: Could not find firmware image %s"
122The appropriate firmware kld module was not installed.
123This is a fatal initialization error.
124.El
125.Sh SUPPORT
126For general information and support,
127go to the Myricom support website at:
| 112may result in lower CPU overhead, however it may also result in
113spurious interrupts.
114The default value is 0.
115.El
116.Sh DIAGNOSTICS
117.Bl -diag
118.It "mxge%d: Unable to allocate bus resource: memory"
119A fatal initialization error has occurred.
120.It "mxge%d: Unable to allocate bus resource: interrupt"
121A fatal initialization error has occurred.
122.It "mxge%d: Could not find firmware image %s"
123The appropriate firmware kld module was not installed.
124This is a fatal initialization error.
125.El
126.Sh SUPPORT
127For general information and support,
128go to the Myricom support website at:
|
128.Pa http://www.myri.com/scs .
| 129.Pa http://www.myri.com/scs/ .
|
129.Pp
130If an issue is identified with the released source code on the supported kernel
131with a supported adapter, email the specific information related to the
132issue to
133.Aq help@myri.com .
134.Sh SEE ALSO
135.Xr arp 4 ,
136.Xr netintro 4 ,
137.Xr ng_ether 4 ,
138.Xr ifconfig 8
139.Sh HISTORY
140The
141.Nm
142device driver first appeared in
143.Fx 7.0 .
144.Sh AUTHORS
145The
146.Nm
147driver was written by
148.An Andrew Gallatin Aq gallatin@FreeBSD.org .
| 130.Pp
131If an issue is identified with the released source code on the supported kernel
132with a supported adapter, email the specific information related to the
133issue to
134.Aq help@myri.com .
135.Sh SEE ALSO
136.Xr arp 4 ,
137.Xr netintro 4 ,
138.Xr ng_ether 4 ,
139.Xr ifconfig 8
140.Sh HISTORY
141The
142.Nm
143device driver first appeared in
144.Fx 7.0 .
145.Sh AUTHORS
146The
147.Nm
148driver was written by
149.An Andrew Gallatin Aq gallatin@FreeBSD.org .
|