From patchwork Thu Jul 2 08:21:43 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kishon Vijay Abraham I X-Patchwork-Id: 192203 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp1231343ilg; Thu, 2 Jul 2020 01:24:36 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxNauTdjo6oIIteTcnzR4WkTYAvWDWz35zEGOszO04EcY6ZETaWvnqSwChHUTqvOFOhIEOX X-Received: by 2002:a17:906:1db1:: with SMTP id u17mr20408992ejh.72.1593678276078; Thu, 02 Jul 2020 01:24:36 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593678276; cv=none; d=google.com; s=arc-20160816; b=qOASHENu9n7F9RFfS48XULmv79l23syBJeoowYemrvkJ4JHpBkoK0vVWZ8gflVSPGr dumWbKyCcMJ/SNRfgHsfBY3UdOZSJ/YEM2f25UCqNUmsriFaGhrySjT0z2DxMp1elwJV UfQwN/wkoA3GOHR3NHjQ67kTGDykIiNQPLh3V5QBO9g+MRIG4wUXk4RtBv6Wc3G2hc0T VChQGyVMUn6NxBOW537ajrkgNRek4XwNCJtLjYKoVB40X/+I/MAQJH3j3gOjOcp9TGT2 OzuuPAvvxGLtBOrMpgmiIy+gItLBe5XYILKmCqmGUXyHXoBf0w4UI3U6zdn2jLONGSg1 ib3A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=2Ps3sR9VF/LqByb34nV2fM7x0C723HV4lrdTJSaPtuA=; b=Ge/Rkaaq67PvOXUnxTTs6zhBOMHNf/YpqDu71OFjG0aNbXkbaWM1GdrMYyztmIX7cU Gvg7Ga90pdP+9vpEepsNx5Q/zzPeXcfSqA+nr3AUV2j3wJyjuIBJmiNaTfu9XjyKtpph s/qZjlNTuxTmltEYaf0iPRD/r7NQU0tXiREWFB1XuechBn/9cWJ1tlP7UwcykAdHsas6 K3fFaYWcXLMkO+PNDtVQsL0W+1ks7H6L3N+3SBfLRI68pO5G+FeVncnCZs5PMsoUxWf+ VuDbd5ODaNQ4/Omd5neJkAGN8g1q1OglptGtuIEW2c+i6JPUIJqszbUi+dC/+zr0BArJ 5rsA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=iCY0E9W7; spf=pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=netdev-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id a9si4682930ejx.271.2020.07.02.01.24.35; Thu, 02 Jul 2020 01:24:36 -0700 (PDT) Received-SPF: pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@ti.com header.s=ti-com-17Q1 header.b=iCY0E9W7; spf=pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=netdev-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=NONE dis=NONE) header.from=ti.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727820AbgGBIYe (ORCPT + 9 others); Thu, 2 Jul 2020 04:24:34 -0400 Received: from lelv0142.ext.ti.com ([198.47.23.249]:59768 "EHLO lelv0142.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728755AbgGBIYF (ORCPT ); Thu, 2 Jul 2020 04:24:05 -0400 Received: from fllv0035.itg.ti.com ([10.64.41.0]) by lelv0142.ext.ti.com (8.15.2/8.15.2) with ESMTP id 0628Nt6b082238; Thu, 2 Jul 2020 03:23:55 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=ti-com-17Q1; t=1593678235; bh=2Ps3sR9VF/LqByb34nV2fM7x0C723HV4lrdTJSaPtuA=; h=From:To:CC:Subject:Date:In-Reply-To:References; b=iCY0E9W7YtWImyjACut0NGZBKOpaf22G78SdPYYg8vG5CI0IfbPCrAZ/V5/Wqr0ek 8lX40jte/wRY2JN8ardU2oSSftFNtSPIesQSJizfY8pkyhecWg5VidgZWPsuJ9vn10 7CU7+V1dA0D5K+DoWGKlSxkziCwP9B9jOImc4hIc= Received: from DFLE103.ent.ti.com (dfle103.ent.ti.com [10.64.6.24]) by fllv0035.itg.ti.com (8.15.2/8.15.2) with ESMTP id 0628NtLg087605; Thu, 2 Jul 2020 03:23:55 -0500 Received: from DFLE111.ent.ti.com (10.64.6.32) by DFLE103.ent.ti.com (10.64.6.24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1979.3; Thu, 2 Jul 2020 03:23:54 -0500 Received: from lelv0327.itg.ti.com (10.180.67.183) by DFLE111.ent.ti.com (10.64.6.32) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1979.3 via Frontend Transport; Thu, 2 Jul 2020 03:23:54 -0500 Received: from a0393678ub.india.ti.com (ileax41-snat.itg.ti.com [10.172.224.153]) by lelv0327.itg.ti.com (8.15.2/8.15.2) with ESMTP id 0628LiYY006145; Thu, 2 Jul 2020 03:23:49 -0500 From: Kishon Vijay Abraham I To: Ohad Ben-Cohen , Bjorn Andersson , Jon Mason , Dave Jiang , Allen Hubbe , Lorenzo Pieralisi , Bjorn Helgaas , "Michael S. Tsirkin" , Jason Wang , Paolo Bonzini , Stefan Hajnoczi , Stefano Garzarella CC: , , , , , , , Subject: [RFC PATCH 22/22] NTB: Describe ntb_virtio and ntb_vhost client in the documentation Date: Thu, 2 Jul 2020 13:51:43 +0530 Message-ID: <20200702082143.25259-23-kishon@ti.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200702082143.25259-1-kishon@ti.com> References: <20200702082143.25259-1-kishon@ti.com> MIME-Version: 1.0 X-EXCLAIMER-MD-CONFIG: e1e8a2fd-e40a-4ac6-ac9b-f7e9cc9ee180 Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Add a blurb in Documentation/ntb.txt to describe the ntb_virtio and ntb_vhost client Signed-off-by: Kishon Vijay Abraham I --- Documentation/driver-api/ntb.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) -- 2.17.1 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 ====================