Changeset View
Changeset View
Standalone View
Standalone View
head/share/man/man4/mlx4ib.4
| Property | Old Value | New Value |
|---|---|---|
| svn:eol-style | null | native \ No newline at end of property |
| svn:keywords | null | FreeBSD=%H \ No newline at end of property |
| svn:mime-type | null | text/plain \ No newline at end of property |
| .\" Copyright (c) 2016 Mellanox Technologies | |||||
| .\" 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. | |||||
| .\" | |||||
| .\" THIS SOFTWARE IS PROVIDED BY AUTHOR 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 AUTHOR 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. | |||||
| .\" | |||||
| .\" $FreeBSD$ | |||||
| .\" | |||||
| .Dd January 18, 2017 | |||||
| .Dt MLX4IB 4 | |||||
| .Os | |||||
| .Sh NAME | |||||
| .Nm mlx4ib | |||||
| .Nd "Mellanox ConnectX-3 10GbE/40GbE network adapter driver" | |||||
| .Sh SYNOPSIS | |||||
| To compile this driver into the kernel, | |||||
| place the following lines in your | |||||
wblock: s/the following/these/ | |||||
| kernel configuration file: | |||||
| .Bd -ragged -offset indent | |||||
| .Cd "options COMPAT_LINUXKPI" | |||||
| .Cd "device mlx4" | |||||
| .Cd "device mlx4ib" | |||||
| .Ed | |||||
| .Pp | |||||
| To load the driver as a module at run-time, | |||||
| run the following command as root: | |||||
wblockUnsubmitted Not Done Inline Actionss/the following/this/ wblock: s/the following/this/ | |||||
| .Bd -literal -offset indent | |||||
| kldload mlx4ib | |||||
| .Ed | |||||
| .Pp | |||||
| To load the driver as a | |||||
| module at boot time, place the following lines in | |||||
wblockUnsubmitted Not Done Inline Actionss/the following lines/this line/ wblock: s/the following lines/this line/ | |||||
| .Xr loader.conf 5 : | |||||
| .Bd -literal -offset indent | |||||
| mlx4ib_load="YES" | |||||
| .Ed | |||||
| .Sh DESCRIPTION | |||||
| Mellanox ConnectX adapter cards with Virtual Protocol Interconnect | |||||
| (VPI) provide the highest performing and most flexible interconnect | |||||
| solution for Enterprise Data Centers, High-Performance Computing, and | |||||
| Embedded environments. | |||||
| Clustered data bases, parallelized applications, transactional | |||||
| services and high-performance embedded I/O applications will achieve | |||||
| significant performance improvements resulting in reduced completion | |||||
| time and lower cost per operation. | |||||
wblockUnsubmitted Not Done Inline ActionsWhile Mellanox cards are no doubt awesome, the DESCRIPTION section is supposed to describe what this driver does, and these two sentences don't do that at all. The HARDWARE section below identifies the specific cards, but gives no other details. Things that could be described here that would be helpful for the reader could include whether all cards in the series are supported, particular features which are or are not supported, and in general anything that would be helpful to someone either trying to use these cards on FreeBSD or evaluating FreeBSD support for these cards before obtaining them. wblock: While Mellanox cards are no doubt awesome, the DESCRIPTION section is supposed to describe what… | |||||
| .Sh HARDWARE | |||||
| The | |||||
| .Nm | |||||
| driver supports the following network adapters: | |||||
| .Pp | |||||
| .Bl -bullet -compact | |||||
| .It | |||||
| Mellanox ConnectX-2 (IB) | |||||
| .It | |||||
| Mellanox ConnectX-3 (IB) | |||||
| .El | |||||
| .Sh SUPPORT | |||||
| For general information and support, | |||||
| go to the Mellanox support website at: | |||||
| .Pa http://www.mellanox.com/ . | |||||
wblockUnsubmitted Not Done Inline ActionsMandoc provides a .Lk macro for links. The older groff_mdoc mentions .Lk but only says "to be written". Still... wblock: Mandoc provides a .Lk macro for links. The older groff_mdoc mentions .Lk but only says "to be… | |||||
| .Pp | |||||
| If an issue is identified with this driver with a supported adapter, | |||||
wblockUnsubmitted Not Done Inline ActionsIf an issue with this driver and a supported network adapter is identified, wblock: ```If an issue with this driver and a supported network adapter is identified,``` | |||||
| email all the specific information related to the issue to | |||||
wblockUnsubmitted Not Done Inline Actionsplease email the specific information to wblock: ```please email the specific information to``` | |||||
| .Aq Mt freebsd-drivers@mellanox.com . | |||||
| .Sh SEE ALSO | |||||
| .Xr mlx4en 4 , | |||||
| .Xr ifconfig 8 | |||||
| .Sh HISTORY | |||||
| The | |||||
| .Nm | |||||
| device driver first appeared in | |||||
| .Fx 9.x . | |||||
| .Sh AUTHORS | |||||
| .An -nosplit | |||||
| The | |||||
| .Nm | |||||
| driver was written by | |||||
| .An Mellanox Technologies <freebsd-drivers@mellanox.com> . | |||||
s/the following/these/