[RFC PATCH 22/22] NTB: Describe ntb_virtio and ntb_vhost client in the documentation
From: Kishon Vijay Abraham I
Date: Thu Jul 02 2020 - 04:24:37 EST
Add a blurb in Documentation/ntb.txt to describe the ntb_virtio and
ntb_vhost client
Signed-off-by: Kishon Vijay Abraham I <kishon@xxxxxx>
---
Documentation/driver-api/ntb.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/Documentation/driver-api/ntb.rst b/Documentation/driver-api/ntb.rst
index 87d1372da879..f84b81625397 100644
--- a/Documentation/driver-api/ntb.rst
+++ b/Documentation/driver-api/ntb.rst
@@ -227,6 +227,17 @@ test client is interacted with through the debugfs filesystem:
specified peer. That peer's interrupt's occurrence file
should be incremented.
+NTB Vhost Client (ntb\_vhost) and NTB Virtio Client (ntb\_virtio)
+------------------------------------------------------------------
+
+When two hosts are connected via NTB, one of the hosts should use NTB Vhost
+Client and the other host should use NTB Virtio Client. The NTB Vhost client
+interfaces with the Linux Vhost Framework and lets it to be used with any
+vhost client driver. The NTB Virtio client interfaces with the Linux Virtio
+Framework and lets it to be used with any virtio client driver. The Vhost
+client driver and Virtio client driver creates a logic cink to exchange data
+with each other.
+
NTB Hardware Drivers
====================
--
2.17.1