Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/8222/?format=api
{ "id": 8222, "url": "http://patches.dpdk.org/api/patches/8222/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1446128065-22477-3-git-send-email-remy.horton@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": "<1446128065-22477-3-git-send-email-remy.horton@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1446128065-22477-3-git-send-email-remy.horton@intel.com", "date": "2015-10-29T14:14:25", "name": "[dpdk-dev,v5,2/2] doc: add user-space ethtool sample app guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "cffb53e55fb80bf061fd8074c70c886abee719a2", "submitter": { "id": 326, "url": "http://patches.dpdk.org/api/people/326/?format=api", "name": "Remy Horton", "email": "remy.horton@intel.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1446128065-22477-3-git-send-email-remy.horton@intel.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/8222/comments/", "check": "pending", "checks": "http://patches.dpdk.org/api/patches/8222/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 [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id 63BFA91AB;\n\tThu, 29 Oct 2015 15:14:33 +0100 (CET)", "from mga02.intel.com (mga02.intel.com [134.134.136.20])\n\tby dpdk.org (Postfix) with ESMTP id C60C98E9D\n\tfor <dev@dpdk.org>; Thu, 29 Oct 2015 15:14:29 +0100 (CET)", "from fmsmga003.fm.intel.com ([10.253.24.29])\n\tby orsmga101.jf.intel.com with ESMTP; 29 Oct 2015 07:14:28 -0700", "from rhorton-mobl.ger.corp.intel.com (HELO localhost.ir.intel.com)\n\t([163.33.229.162])\n\tby FMSMGA003.fm.intel.com with ESMTP; 29 Oct 2015 07:14:28 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.20,214,1444719600\"; d=\"scan'208\";a=\"590353662\"", "From": "Remy Horton <remy.horton@intel.com>", "To": "dev@dpdk.org", "Date": "Thu, 29 Oct 2015 14:14:25 +0000", "Message-Id": "<1446128065-22477-3-git-send-email-remy.horton@intel.com>", "X-Mailer": "git-send-email 1.9.3", "In-Reply-To": "<1446128065-22477-1-git-send-email-remy.horton@intel.com>", "References": "<1446128065-22477-1-git-send-email-remy.horton@intel.com>", "Subject": "[dpdk-dev] [PATCH v5 2/2] doc: add user-space ethtool sample app\n\tguide", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Signed-off-by: Remy Horton <remy.horton@intel.com>\n---\n doc/guides/sample_app_ug/ethtool.rst | 173 +++++++++++++++++++++++++++++++++++\n doc/guides/sample_app_ug/index.rst | 1 +\n 2 files changed, 174 insertions(+)\n create mode 100644 doc/guides/sample_app_ug/ethtool.rst", "diff": "diff --git a/doc/guides/sample_app_ug/ethtool.rst b/doc/guides/sample_app_ug/ethtool.rst\nnew file mode 100644\nindex 0000000..36d8dfc\n--- /dev/null\n+++ b/doc/guides/sample_app_ug/ethtool.rst\n@@ -0,0 +1,173 @@\n+\n+.. BSD LICENSE\n+ Copyright(c) 2015 Intel Corporation. All rights reserved.\n+ All rights reserved.\n+\n+ Redistribution and use in source and binary forms, with or without\n+ modification, are permitted provided that the following conditions\n+ are met:\n+\n+ * Redistributions of source code must retain the above copyright\n+ notice, this list of conditions and the following disclaimer.\n+ * Redistributions in binary form must reproduce the above copyright\n+ notice, this list of conditions and the following disclaimer in\n+ the documentation and/or other materials provided with the\n+ distribution.\n+ * Neither the name of Intel Corporation nor the names of its\n+ contributors may be used to endorse or promote products derived\n+ from this software without specific prior written permission.\n+\n+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+EthTool Sample Application\n+==========================\n+\n+The Ethtool sample application shows an implementation of an\n+EthTool-like API and provides a console environment that allows\n+its use to query and change Ethernet card parameters. The sample\n+is based upon a simple L2 frame reflector.\n+\n+Compiling the Application\n+-------------------------\n+\n+To compile the application:\n+\n+#. Go to the sample application directory:\n+\n+ .. code-block:: console\n+\n+ export RTE_SDK=/path/to/rte_sdk cd ${RTE_SD}/examples/ethtool\n+\n+#. Set the target (a default target is used if not specified). For example:\n+\n+ .. code-block:: console\n+\n+ export RTE_TARGET=x86_64-native-linuxapp-gcc\n+\n+ See the *DPDK Getting Started Guide* for possible RTE_TARGET values.\n+\n+#. Build the application:\n+\n+ .. code-block:: console\n+\n+ make\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+ ./ethtool-app/ethtool-app/${RTE_TARGET}/ethtool [EAL options]\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+ EthApp>\n+\n+From this interface the available commands and descriptions of what\n+they do as as follows:\n+\n+drvinfo\n+ Print driver info\n+eeprom\n+ Dump EEPROM to file\n+link\n+ Print port link states\n+macaddr\n+ Gets/sets MAC address\n+mtu\n+ Set NIC MTU\n+open\n+ Open port\n+pause\n+ Get/set port pause state\n+portstats\n+ Print port statistics\n+regs\n+ Dump port register(s) to file\n+ringparam\n+ Get/set ring parameters\n+rxmode\n+ Toggle port Rx mode\n+stop\n+ Stop port\n+validate\n+ Check that given MAC address is valid unicast address\n+vlan\n+ Add/remove VLAN id\n+quit\n+ Exit program\n+\n+Explaination\n+------------\n+\n+The sample program has two parts: A background `packet reflector`_\n+that runs on a slave core, and a foreground `EthTool Shell`_ that\n+runs on the master core. These are described below.\n+\n+Packet Reflector\n+~~~~~~~~~~~~~~~~\n+\n+The background packet reflector is intended to demonstrate basic\n+packet processing on NIC ports controlled by the EthTool shim.\n+Each incoming MAC frame is rewritten so that it is returned to\n+the sender, using the port in question's own MAC address as the\n+source address, and is then sent out on the same port.\n+\n+EthTool Shell\n+~~~~~~~~~~~~~\n+\n+The foreground part of the EthTool sample is a console-based\n+interface that accepts commands as described in `using the\n+application`_. Individual call-back functions handle the detail\n+associated with each command, which make use of the functions\n+defined in the `EthTool interface`_ to the DPDK functions.\n+\n+EthTool interface\n+-----------------\n+\n+The EthTool interface is built as a separate library, and implements\n+the following functions:\n+\n+- rte_ethtool_get_drvinfo\n+- rte_ethtool_get_regs_len\n+- rte_ethtool_get_regs\n+- rte_ethtool_get_link\n+- rte_ethtool_get_eeprom_len\n+- rte_ethtool_get_eeprom\n+- rte_ethtool_set_eeprom\n+- rte_ethtool_get_pauseparam\n+- rte_ethtool_set_pauseparam\n+- rte_ethtool_net_open\n+- rte_ethtool_net_stop\n+- rte_ethtool_net_get_mac_addr\n+- rte_ethtool_net_set_mac_addr\n+- rte_ethtool_net_validate_addr\n+- rte_ethtool_net_change_mtu\n+- rte_ethtool_net_get_stats64\n+- rte_ethtool_net_vlan_rx_add_vid\n+- rte_ethtool_net_vlan_rx_kill_vid\n+- rte_ethtool_net_set_rx_mode\n+- rte_ethtool_get_ringparam\n+- rte_ethtool_set_ringparam\ndiff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst\nindex 9beedd9..086d3f2 100644\n--- a/doc/guides/sample_app_ug/index.rst\n+++ b/doc/guides/sample_app_ug/index.rst\n@@ -41,6 +41,7 @@ Sample Applications User Guide\n \n intro\n cmd_line\n+ ethtool\n exception_path\n hello_world\n skeleton\n", "prefixes": [ "dpdk-dev", "v5", "2/2" ] }