From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 590B6235 for ; Fri, 30 Jun 2017 18:52:13 +0200 (CEST) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 30 Jun 2017 09:52:13 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,287,1496127600"; d="scan'208";a="103233408" Received: from silpixa00372839.ir.intel.com (HELO silpixa00372839.ger.corp.intel.com) ([10.237.222.154]) by orsmga004.jf.intel.com with ESMTP; 30 Jun 2017 09:52:11 -0700 From: Ferruh Yigit To: dev@dpdk.org Cc: Ferruh Yigit , Stephen Hemminger , Bruce Richardson , Anatoly Burakov Date: Fri, 30 Jun 2017 17:51:39 +0100 Message-Id: <20170630165140.59594-20-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.13.0 In-Reply-To: <20170630165140.59594-1-ferruh.yigit@intel.com> References: <20170621110651.75299-1-ferruh.yigit@intel.com> <20170630165140.59594-1-ferruh.yigit@intel.com> Subject: [dpdk-dev] [PATCH v9 19/20] doc: add control interface library documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 30 Jun 2017 16:52:14 -0000 Signed-off-by: Ferruh Yigit --- doc/api/doxy-api-index.md | 3 +- doc/api/doxy-api.conf | 1 + doc/guides/prog_guide/ctrl_if_lib.rst | 50 ++++++++++++++++++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + doc/guides/rel_notes/release_17_08.rst | 8 ++++++ 5 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 doc/guides/prog_guide/ctrl_if_lib.rst diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index 71350849f..ba45ff69a 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -162,4 +162,5 @@ There are many libraries, so their headers may be grouped by topics: [bitrate statistics] (@ref rte_bitrate.h), [latency statistics] (@ref rte_latencystats.h), [version] (@ref rte_version.h), - [ethtool] (@ref rte_ethtool.h) + [ethtool] (@ref rte_ethtool.h), + [control interface] (@ref rte_ctrl_if.h) diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf index b66e86541..896c2b247 100644 --- a/doc/api/doxy-api.conf +++ b/doc/api/doxy-api.conf @@ -42,6 +42,7 @@ INPUT = doc/api/doxy-api-index.md \ lib/librte_cmdline \ lib/librte_compat \ lib/librte_cryptodev \ + lib/librte_ctrl_if \ lib/librte_distributor \ lib/librte_efd \ lib/librte_ether \ diff --git a/doc/guides/prog_guide/ctrl_if_lib.rst b/doc/guides/prog_guide/ctrl_if_lib.rst new file mode 100644 index 000000000..7d60c2798 --- /dev/null +++ b/doc/guides/prog_guide/ctrl_if_lib.rst @@ -0,0 +1,50 @@ +.. BSD LICENSE + Copyright(c) 2016 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +.. _Ctrl_If_Library: + +Control Interface Library +========================= + +This Library is to create/destroy control interfaces and process messages +received by control interface. + +Control Interface is Linux network interface and it is possible to call +various Linux commands to this interface and commands will be forwarded +to the matching DPDK PMD, and response will be generated by PMD. + +Control interface required UNCI kernel module to be inserted to function. + +Control Interface APIS +---------------------- + + +- ``rte_eth_control_interface_create_one()`` +- ``rte_eth_control_interface_destroy_one()`` diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst index 54f9538ea..c7cb4b0f8 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -55,6 +55,7 @@ Programmer's Guide ip_fragment_reassembly_lib pdump_lib ethtool_lib + ctrl_if_lib multi_proc_support kernel_nic_interface thread_safety_dpdk_functions diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst index e21d4e17c..0598a9ec0 100644 --- a/doc/guides/rel_notes/release_17_08.rst +++ b/doc/guides/rel_notes/release_17_08.rst @@ -80,6 +80,14 @@ New Features Ethtool library is wrapper for ethdev library and provides APIs to get data similar to Linux ethtool provides. +* **Control interface support added.** + + To enable controlling DPDK ports by common Linux tools. + Following modules added to DPDK: + + * librte_ctrl_if library + * librte_eal/linuxapp/unci kernel module + Resolved Issues --------------- -- 2.13.0