Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/55128/?format=api
{ "id": 55128, "url": "http://patches.dpdk.org/api/patches/55128/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20190620102147.41557-7-xiaoyun.li@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20190620102147.41557-7-xiaoyun.li@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20190620102147.41557-7-xiaoyun.li@intel.com", "date": "2019-06-20T10:21:47", "name": "[v7,6/6] doc: update docs for ntb driver", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "77ec43e7ed47a3a83455bd6af972b878ee174a54", "submitter": { "id": 798, "url": "http://patches.dpdk.org/api/people/798/?format=api", "name": "Li, Xiaoyun", "email": "xiaoyun.li@intel.com" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20190620102147.41557-7-xiaoyun.li@intel.com/mbox/", "series": [ { "id": 5099, "url": "http://patches.dpdk.org/api/series/5099/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=5099", "date": "2019-06-20T10:21:41", "name": "rawdev driver for ntb", "version": 7, "mbox": "http://patches.dpdk.org/series/5099/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/55128/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/55128/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 4DDF51D383;\n\tThu, 20 Jun 2019 12:23:08 +0200 (CEST)", "from mga01.intel.com (mga01.intel.com [192.55.52.88])\n\tby dpdk.org (Postfix) with ESMTP id 89BA31D2FC\n\tfor <dev@dpdk.org>; Thu, 20 Jun 2019 12:22:56 +0200 (CEST)", "from orsmga004.jf.intel.com ([10.7.209.38])\n\tby fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t20 Jun 2019 03:22:56 -0700", "from dpdk-xiaoyun3.sh.intel.com ([10.67.119.132])\n\tby orsmga004.jf.intel.com with ESMTP; 20 Jun 2019 03:22:54 -0700" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.63,396,1557212400\"; d=\"scan'208\";a=\"311617839\"", "From": "Xiaoyun Li <xiaoyun.li@intel.com>", "To": "jingjing.wu@intel.com, keith.wiles@intel.com, cunming.liang@intel.com,\n\tomkar.maslekar@intel.com", "Cc": "dev@dpdk.org,\n\tXiaoyun Li <xiaoyun.li@intel.com>", "Date": "Thu, 20 Jun 2019 18:21:47 +0800", "Message-Id": "<20190620102147.41557-7-xiaoyun.li@intel.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20190620102147.41557-1-xiaoyun.li@intel.com>", "References": "<20190618021055.12709-1-xiaoyun.li@intel.com>\n\t<20190620102147.41557-1-xiaoyun.li@intel.com>", "Subject": "[dpdk-dev] [PATCH v7 6/6] doc: update docs for ntb driver", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Update related documents for ntb pmd and example.\n\nSigned-off-by: Xiaoyun Li <xiaoyun.li@intel.com>\n---\n MAINTAINERS | 8 +++++\n doc/guides/rawdevs/index.rst | 1 +\n doc/guides/rawdevs/ntb_rawdev.rst | 41 ++++++++++++++++++++++\n doc/guides/rel_notes/release_19_08.rst | 15 ++++++++\n doc/guides/sample_app_ug/index.rst | 1 +\n doc/guides/sample_app_ug/ntb.rst | 47 ++++++++++++++++++++++++++\n 6 files changed, 113 insertions(+)\n create mode 100644 doc/guides/rawdevs/ntb_rawdev.rst\n create mode 100644 doc/guides/sample_app_ug/ntb.rst", "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex fdc083db9..8c919484d 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -1057,6 +1057,10 @@ M: Nipun Gupta <nipun.gupta@nxp.com>\n F: drivers/raw/dpaa2_cmdif/\n F: doc/guides/rawdevs/dpaa2_cmdif.rst\n \n+NTB Rawdev\n+M: Xiaoyun Li <xiaoyun.li@intel.com>\n+F: drivers/raw/ntb_rawdev/\n+F: doc/guides/rawdevs/ntb_rawdev.rst\n \n Packet processing\n -----------------\n@@ -1433,3 +1437,7 @@ F: examples/tep_termination/\n F: examples/vmdq/\n F: examples/vmdq_dcb/\n F: doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst\n+\n+M: Xiaoyun Li <xiaoyun.li@intel.com>\n+F: examples/ntb/\n+F: doc/guides/sample_app_ug/ntb.rst\ndiff --git a/doc/guides/rawdevs/index.rst b/doc/guides/rawdevs/index.rst\nindex 7c3bd9586..cf6fcb06b 100644\n--- a/doc/guides/rawdevs/index.rst\n+++ b/doc/guides/rawdevs/index.rst\n@@ -14,3 +14,4 @@ application through rawdev API.\n dpaa2_cmdif\n dpaa2_qdma\n ifpga_rawdev\n+ ntb_rawdev\ndiff --git a/doc/guides/rawdevs/ntb_rawdev.rst b/doc/guides/rawdevs/ntb_rawdev.rst\nnew file mode 100644\nindex 000000000..429e2af3e\n--- /dev/null\n+++ b/doc/guides/rawdevs/ntb_rawdev.rst\n@@ -0,0 +1,41 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2018 Intel Corporation.\n+\n+NTB Rawdev Driver\n+=================\n+\n+The ``ntb`` rawdev driver provides a non-transparent bridge between two\n+separate hosts so that they can communicate with each other. Thus, many\n+user cases can benefit from this, such as fault tolerance and visual\n+acceleration.\n+\n+This PMD allows two hosts to handshake for device start and stop, memory\n+allocation for the peer to access and read/write allocated memory from peer.\n+Also, the PMD allows to use doorbell registers to notify the peer and share\n+some information by using scratchpad registers.\n+\n+But the PMD hasn't implemented FIFO. The FIFO will come in 19.11 release.\n+And this PMD only supports intel skylake platform.\n+\n+BIOS setting on skylake platform\n+--------------------------------\n+\n+Intel non-transparent bridge needs special BIOS setting. Since the PMD only\n+supports intel skylake platform, introduce BIOS setting here. The referencce\n+is https://www.intel.com/content/dam/support/us/en/documents/server-products/Intel_Xeon_Processor_Scalable_Family_BIOS_User_Guide.pdf\n+\n+- Set the needed PCIe port as NTB to NTB mode on both hosts.\n+- Enable NTB bars and set bar size of bar 23 and bar 45 as 12-29 (2K-512M)\n+ on both hosts. Note that bar size on both hosts should be the same.\n+- Disable split bars for both hosts.\n+- Set crosslink control override as DSD/USP on one host, USD/DSP on\n+ another host.\n+- Disable PCIe PII SSC (Spread Spectrum Clocking) for both hosts. This\n+ is a hardware requirement.\n+\n+Build options\n+-------------\n+\n+- ``CONFIG_RTE_LIBRTE_IFPGA_RAWDEV`` (default ``y``)\n+\n+ Toggle compilation of the ``ntb_rawdev`` driver.\ndiff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst\nindex 563999d57..3a35ffbd7 100644\n--- a/doc/guides/rel_notes/release_19_08.rst\n+++ b/doc/guides/rel_notes/release_19_08.rst\n@@ -94,6 +94,21 @@ New Features\n \n * Enabled Tx outer/inner L3/L4 checksum offload.\n \n+* **Introduced NTB PMD.**\n+\n+ The PMD provided a non-transparent bridge between two separate hosts so\n+ that they can communicate with each other. Thus, many user cases can\n+ benefit from this, such as fault tolerance and visual acceleration.\n+\n+ This PMD implemented the following features:\n+ * Handshake for device start and stop between two hosts.\n+ * Memory allocation for the peer to access and read/write allocated\n+ memory from peer.\n+ * Use doorbell registers to notify the peer and share some information\n+ by using scratchpad registers.\n+\n+ But the PMD hasn't implemented FIFO. The FIFO will come in 19.11 release.\n+ And this PMD only supports intel skylake platform.\n \n Removed Items\n -------------\ndiff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst\nindex 2945be08f..f23f8f59e 100644\n--- a/doc/guides/sample_app_ug/index.rst\n+++ b/doc/guides/sample_app_ug/index.rst\n@@ -58,3 +58,4 @@ Sample Applications User Guides\n fips_validation\n ipsec_secgw\n bbdev_app\n+ ntb\ndiff --git a/doc/guides/sample_app_ug/ntb.rst b/doc/guides/sample_app_ug/ntb.rst\nnew file mode 100644\nindex 000000000..079242175\n--- /dev/null\n+++ b/doc/guides/sample_app_ug/ntb.rst\n@@ -0,0 +1,47 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2019 Intel Corporation.\n+\n+NTB Sample Application\n+======================\n+\n+The ntb sample application shows how to use ntb rawdev driver.\n+This sample provides interactive mode to transmit file between\n+two hosts.\n+\n+Compiling the Application\n+-------------------------\n+\n+To compile the sample application see :doc:`compiling`.\n+\n+The application is located in the ``ntb`` sub-directory.\n+\n+Running the Application\n+-----------------------\n+\n+The application requires an available core for each port, plus one.\n+The only available options are the standard ones for the EAL:\n+\n+.. code-block:: console\n+\n+ ./build/ntb_fwd -c 0xf -n 6 -- -i\n+\n+Refer to the *DPDK Getting Started Guide* for general information on\n+running applications and the Environment Abstraction Layer (EAL)\n+options.\n+\n+Using the application\n+---------------------\n+\n+The application is console-driven using the cmdline DPDK interface:\n+\n+.. code-block:: console\n+\n+ ntb>\n+\n+From this interface the available commands and descriptions of what\n+they do as as follows:\n+\n+* ``send [filepath]``: Send file to the peer host.\n+* ``receive [filepath]``: Receive file to [filepath]. Need the peer\n+ to send file successfully first.\n+* ``quit``: Exit program\n", "prefixes": [ "v7", "6/6" ] }