xref: /freebsd/share/man/man4/ntb_transport.4 (revision 5dae51da3da0cc94d17bd67b308fad304ebec7e0)
1.\"
2.\" Copyright (c) 2016 Alexander Motin <mav@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
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.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd July 29, 2016
29.Dt NTB_TRANSPORT 4
30.Os
31.Sh NAME
32.Nm ntb_transport
33.Nd Packet-oriented transport for Non-Transparent Bridges
34.Sh SYNOPSIS
35To load the driver as a module at boot, place the following line in
36.Xr loader.conf 5 :
37.Bd -literal -offset indent
38ntb_transport_load="YES"
39.Ed
40.Pp
41The following tunables are settable from the
42.Xr loader 8 :
43.Bl -ohang
44.It Va hw.ntb_transport.debug_level
45Driver debug level.
46The default value is 0, higher means more verbose.
47.It Va hint.ntb_transport. Ns Ar X Ns Va .config
48Configures queues allocation for consumer devices, separated by commas.
49Each device can be configured as: "<name>[:<queues>]", where:
50.Va name
51is a name of the driver which should attach the device (empty means any),
52.Va queues
53is a number of queues to allocate (empty means automatic),
54The default configuration is empty string, which means single device
55with one queue per memory window allowing any driver attachment.
56.El
57.Sh DESCRIPTION
58The
59.Nm
60driver attaches on top of the
61.Nm ntb
62driver to utilize its resources to create set of bidirectional queues,
63delivering packets between the systems.
64The primary purpose of this is to be used by
65.Nm if_ntb
66network interface, but other consumers may also be developed using KPI.
67.Sh SEE ALSO
68.Xr if_ntb 4 ,
69.Xr ntb_hw 4
70.Sh AUTHORS
71.An -nosplit
72The
73.Nm
74driver was developed by Intel and originally written by
75.An Carl Delsey Aq Mt carl@FreeBSD.org .
76Later improvements were done by
77.An Conrad E. Meyer Aq Mt cem@FreeBSD.org
78and
79.An Alexander Motin Aq Mt mav@FreeBSD.org .
80