Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/iw_ixl.4
- This file was added.
.\" Copyright (c) 2017 Intel Corporation. All rights reserved. | |||||
.\" | |||||
.\" This software is available to you under a choice of one of two | |||||
.\" licenses. You may choose to be licensed under the terms of the GNU | |||||
.\" General Public License (GPL) Version 2, available from the file | |||||
.\" COPYING in the main directory of this source tree, or the | |||||
.\" OpenFabrics.org BSD license below: | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or | |||||
.\" without modification, are permitted provided that the following | |||||
.\" conditions are met: | |||||
.\" | |||||
.\" - Redistributions of source code must retain the above | |||||
.\" copyright notice, this list of conditions and the following | |||||
.\" disclaimer. | |||||
.\" | |||||
.\" - 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. | |||||
.\" | |||||
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |||||
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |||||
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | |||||
.\" NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS | |||||
.\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN | |||||
.\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | |||||
.\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||||
.\" SOFTWARE. | |||||
.Dd June 20, 2017 | |||||
.Dt IW_IXL 4 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm iw_ixl | |||||
.Nd "Beta iWARP Driver for the Intel(R) Ethernet Connection X722 for the FreeBSD* operating system" | |||||
.Sh SYNOPSIS | |||||
wblock: Appears that an (R) symbol after "Intel" was replaced with a question mark. Not sure about the… | |||||
This module relies on | |||||
.Xr if_ixl 4 | |||||
and requires a number of adjustments before it is ready to use. | |||||
.Bl -tag -nested-width indent | |||||
.It The following kernel options should be included in the configuration: | |||||
.Bl -tag | |||||
.It IXL_IW | |||||
.It OFED | |||||
.It OFED_DEBUG_INIT | |||||
.It IPOIB_CM | |||||
.It COMPAT_LINUXKPI | |||||
.El | |||||
.It The following tunable should be set: | |||||
.Bl -tag | |||||
.It hw.ixl.enable_iwarp=1 | |||||
.El | |||||
.El | |||||
.Pp | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
driver provides support for iWARP capability of the Intel(R) Ethernet Controller X722 family of Ethernet devices. | |||||
The driver requires | |||||
.Xr if_ixl 4 | |||||
version 1.7.12 or higher. | |||||
Not Done Inline ActionsPlease start new sentences on new lines. wblock: Please start new sentences on new lines. | |||||
Currently, only kernel verbs are supported. | |||||
For further hardware information and questions related to hardware requirements, see | |||||
.Lk http://support.intel.com/ . | |||||
Not Done Inline Actionss/ethernet/Ethernet/ wblock: s/ethernet/Ethernet/ | |||||
.Sh HARDWARE | |||||
The driver supports the Intel(R) Ethernet Controller X722 family of Ethernet devices with iWARP support. | |||||
.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 | |||||
Not Done Inline ActionsThe verb can be removed to make this a little clearer: s/Determines the maximum/The maximum/ s/msix/MSI-X/ (I think) Also, please start new sentences on new lines. wblock: The verb can be removed to make this a little clearer: s/Determines the maximum/The maximum/… | |||||
.It Va hw.iw_ixl.max_ceq | |||||
The maximum number of MSI-X vectors available to the driver for CEQ usage. | |||||
Not Done Inline ActionsThe amount of debug messages to print. wblock: ```The amount of debug messages to print.``` | |||||
The value is usually evaluated with respect to maximal number of MSI-X vectors on the PCI, hardware limitations and number of CPUs. | |||||
The tunable controls how many MSI-X vectors are actually used by the driver. | |||||
Not Done Inline ActionsSelect which MPA version to use. The default is 2. wblock: ```Select which MPA version to use.
The default is 2.``` | |||||
If equal to 0, the value will be ignored. | |||||
.It Va hw.iw_ixl.debug | |||||
The amount of debug messages to print. | |||||
.It Va hw.iw_ixl.mpa_version | |||||
Select which MPA version to use. | |||||
Not Done Inline ActionsAs above: The amount of debug messages to print. wblock: As above:
```The amount of debug messages to print.``` | |||||
The default is 2. | |||||
.El | |||||
.Sh SYSCTL PROCEDURES | |||||
.Bl -tag -width indent | |||||
.It Va hw.iw_ixl.debug | |||||
Not Done Inline ActionsPlease start new sentences on new lines. Note that 40G operation can generate high numbers of interrupts, which are often incorrectly interpreted as a storm condition in the kernel. This can be resolved by setting: wblock: Please start new sentences on new lines.
Please avoid the informal "you" (https://www.freebsd. | |||||
The amount of debug messages to print. | |||||
.El | |||||
.Sh KNOWN ISSUES | |||||
.Bl -dash -nested | |||||
.It | |||||
Note that 40G operation can generate high numbers of interrupts, which are often incorrectly interpreted as a storm condition in the kernel. | |||||
This can be resolved by setting: | |||||
.Bl -tag -width indent | |||||
.It Va hw.intr_storm_threshold: 0 | |||||
.El | |||||
Consult | |||||
.Xr ixl 4 , | |||||
or | |||||
.Lk http://support.intel.com/ | |||||
for details. | |||||
.It | |||||
Loopback connection is not supported. | |||||
.It | |||||
Connection using IPv6 is not supported. | |||||
.It | |||||
Changing the MTU size is not supported. | |||||
.It | |||||
MW memory mode is not supported. | |||||
Not Done Inline ActionsUse .Lk for links: .Lk http://support.intel.com/ . wblock: Use .Lk for links:
```.Lk http://support.intel.com/ .``` | |||||
.It | |||||
MR memory mode supports only single buffer. | |||||
Not Done Inline ActionsRedundant "with", suggested: If an issue with this driver is identified on a supported adapter, wblock: Redundant "with", suggested:
```If an issue with this driver is identified on a supported… | |||||
.It | |||||
ib_cq_resize function is not supported. | |||||
.El | |||||
.Sh SUPPORT | |||||
For general information and support, | |||||
go to the Intel support website at: | |||||
.Lk http://support.intel.com/ . | |||||
.Pp | |||||
If an issue with this driver is identified on a supported adapter, | |||||
email all the specific information related to the issue to | |||||
.Aq freebsd@intel.com . | |||||
.Sh SEE ALSO | |||||
.Xr ixl 4 , | |||||
.Xr ixlv 4 , | |||||
.Sh AUTHORS | |||||
.An -nosplit | |||||
The | |||||
.Nm | |||||
driver has been ported, prepared and maintained by | |||||
.An Maciej Sosnowski Aq Mt maciej.m.sosnowski@gmail.com | |||||
and | |||||
.An Bartosz Sobczak Aq Mt bartosz.m.sobczak@gmail.com . |
Appears that an (R) symbol after "Intel" was replaced with a question mark. Not sure about the star after "FreeBSD".