ed9652da5f
This driver supports both NTB-to-NTB and NTB-to-Root Port modes (though the second with predictable complications on hot-plug and reboot events). I tested it with PEX 8717 and PEX 8733 chips, but expect it should work with many other compatible ones too. It supports up to two NT bridges per chip, each of which can have up to 2 64-bit or 4 32-bit memory windows, 6 or 12 scratchpad registers and 16 doorbells. There are also 4 DMA engines in those chips, but they are not yet supported. While there, rename Intel NTB driver from generic ntb_hw(4) to more specific ntb_hw_intel(4), so now it is on par with this new ntb_hw_plx(4) driver and alike to Linux naming. MFC after: 2 weeks Sponsored by: iXsystems, Inc.
103 lines
3.3 KiB
Groff
103 lines
3.3 KiB
Groff
.\"
|
|
.\" Copyright (c) 2016-2017 Alexander Motin <mav@FreeBSD.org>
|
|
.\" 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 THE 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 THE 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 August 30, 2017
|
|
.Dt NTB_TRANSPORT 4
|
|
.Os
|
|
.Sh NAME
|
|
.Nm ntb_transport
|
|
.Nd Packet-oriented transport for Non-Transparent Bridges
|
|
.Sh SYNOPSIS
|
|
To compile this driver into your kernel,
|
|
place the following lines in your kernel configuration file:
|
|
.Bd -ragged -offset indent
|
|
.Cd "device ntb"
|
|
.Cd "device ntb_transport"
|
|
.Ed
|
|
.Pp
|
|
Or, to load the driver as a module at boot, place the following line in
|
|
.Xr loader.conf 5 :
|
|
.Bd -literal -offset indent
|
|
ntb_transport_load="YES"
|
|
.Ed
|
|
.Pp
|
|
The following tunables are settable from the
|
|
.Xr loader 8 :
|
|
.Bl -ohang
|
|
.It Va hw.ntb_transport.debug_level
|
|
Driver debug level.
|
|
The default value is 0, higher means more verbose.
|
|
.It Va hint.ntb_transport. Ns Ar X Ns Va .config
|
|
Configures queues allocation for consumer devices, separated by commas.
|
|
Each device can be configured as: "[<name>][:<queues>]", where:
|
|
.Va name
|
|
is a name of the driver which should attach the device (empty means any),
|
|
.Va queues
|
|
is a number of queues to allocate (empty means automatic).
|
|
The default configuration is empty string, which means single device
|
|
with one queue per memory window allowing any driver attachment.
|
|
.El
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
driver attaches on top of the
|
|
.Nm ntb
|
|
driver to utilize its resources to create set of bidirectional queues,
|
|
delivering packets between the systems.
|
|
The primary purpose of this is to be used by
|
|
.Nm if_ntb
|
|
network interface, but other consumers may also be developed using KPI.
|
|
.Pp
|
|
Each
|
|
.Nm
|
|
require from underlying
|
|
.Nm ntb
|
|
instance:
|
|
.Bl -bullet -compact
|
|
.It
|
|
1 or more memory windows;
|
|
.It
|
|
6 scratchpads, plus 2 more for each additional memory window;
|
|
.It
|
|
1 doorbell for each memory window or configured queue.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr if_ntb 4 ,
|
|
.Xr ntb 4 ,
|
|
.Xr ntb_hw_intel 4 ,
|
|
.Xr ntb_hw_plx 4
|
|
.Sh AUTHORS
|
|
.An -nosplit
|
|
The
|
|
.Nm
|
|
driver was developed by Intel and originally written by
|
|
.An Carl Delsey Aq Mt carl@FreeBSD.org .
|
|
Later improvements were done by
|
|
.An Conrad E. Meyer Aq Mt cem@FreeBSD.org
|
|
and
|
|
.An Alexander Motin Aq Mt mav@FreeBSD.org .
|