share/man/man4/ntb_transport.4

   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 10, 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
  35 To load the driver as a module at boot, place the following line in
  36 .Xr loader.conf 5 :
  37 .Bd -literal -offset indent
  38 ntb_transport_load="YES"
  39 .Ed
  40 .Pp
  41 The following tunables are settable from the
  42 .Xr loader 8 :
  43 .Bl -ohang
  44 .It Va hw.ntb_transport.debug_level
  45 Driver debug level.
  46 The default value is 0, higher means more verbose.
  47 .It Va hw.ntb_transport.max_num_clients
  48 Number of bidirectional queues to setup.
  49 The default value is 0, that means one queue per available memory window.
  50 Maximal number is limited by number of doorbells.
  51 .El
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver attaches on top of the
  56 .Nm ntb
  57 driver to utilize its resources to create set of bidirectional queues,
  58 delivering packets between the systems.
  59 The primary purpose of this is to be used by
  60 .Nm if_ntb
  61 network interface, but other consumers may also be developed using KPI.
  62 .Sh SEE ALSO
  63 .Xr if_ntb 4 ,
  64 .Xr ntb_hw 4
  65 .Sh AUTHORS
  66 .An -nosplit
  67 The
  68 .Nm
  69 driver was developed by Intel and originally written by
  70 .An Carl Delsey Aq Mt carl@FreeBSD.org .
  71 Later improvements were done by
  72 .An Conrad E. Meyer Aq Mt cem@FreeBSD.org
  73 and
  74 .An Alexander Motin Aq Mt mav@FreeBSD.org .