Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/24318/?format=api
{ "id": 24318, "url": "https://patches.dpdk.org/api/patches/24318/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20170515163711.8796-1-ferruh.yigit@intel.com/", "project": { "id": 1, "url": "https://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": "<20170515163711.8796-1-ferruh.yigit@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20170515163711.8796-1-ferruh.yigit@intel.com", "date": "2017-05-15T16:37:11", "name": "[dpdk-dev,RFC] doc: document NIC features", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "1fc2556654bade350d7f75dbbecdde41f882a9ef", "submitter": { "id": 324, "url": "https://patches.dpdk.org/api/people/324/?format=api", "name": "Ferruh Yigit", "email": "ferruh.yigit@intel.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20170515163711.8796-1-ferruh.yigit@intel.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/24318/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/24318/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 0460911D4;\n\tMon, 15 May 2017 18:37:19 +0200 (CEST)", "from mga03.intel.com (mga03.intel.com [134.134.136.65])\n\tby dpdk.org (Postfix) with ESMTP id 89904234\n\tfor <dev@dpdk.org>; Mon, 15 May 2017 18:37:16 +0200 (CEST)", "from fmsmga001.fm.intel.com ([10.253.24.23])\n\tby orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t15 May 2017 09:37:15 -0700", "from silpixa00372839.ir.intel.com (HELO\n\tsilpixa00372839.ger.corp.intel.com) ([10.237.222.154])\n\tby fmsmga001.fm.intel.com with ESMTP; 15 May 2017 09:37:13 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos; i=\"5.38,345,1491289200\"; d=\"scan'208\";\n\ta=\"1148024993\"", "From": "Ferruh Yigit <ferruh.yigit@intel.com>", "To": "Thomas Monjalon <thomas@monjalon.net>,\n\tJohn McNamara <john.mcnamara@intel.com>", "Cc": "dev@dpdk.org,\n\tFerruh Yigit <ferruh.yigit@intel.com>", "Date": "Mon, 15 May 2017 17:37:11 +0100", "Message-Id": "<20170515163711.8796-1-ferruh.yigit@intel.com>", "X-Mailer": "git-send-email 2.9.3", "Subject": "[dpdk-dev] [RFC] doc: document NIC features", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <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": "Document NIC features, add more information about them and add more\nimplementation related support.\n\nTODO:\n- Not all features all fully documented, need help from community\n\n- Instead of having a new file, it would be nice to auto generate this\nfile from defaults.ini, and perhaps add extra information as comment to\nthat file.\n\n- Some features are implementing eth_dev_ops and some are updates in\nRx/Tx path. These features can be grouped together.\n\n- A link from overview file per feature would be nice.\n\nSigned-off-by: Ferruh Yigit <ferruh.yigit@intel.com>\n---\n doc/guides/nics/overview_features.rst | 396 ++++++++++++++++++++++++++++++++++\n 1 file changed, 396 insertions(+)\n create mode 100644 doc/guides/nics/overview_features.rst", "diff": "diff --git a/doc/guides/nics/overview_features.rst b/doc/guides/nics/overview_features.rst\nnew file mode 100644\nindex 0000000..26c83b6\n--- /dev/null\n+++ b/doc/guides/nics/overview_features.rst\n@@ -0,0 +1,396 @@\n+.. BSD LICENSE\n+ Copyright(c) 2017 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+Overview features\n+=================\n+\n+Speed capabilities\n+------------------\n+eth_dev_ops: dev_infos_get:speed_capa\n+\n+Driver advertise the speed capabilities that the current device capable to offer.\n+\n+\n+Link status\n+-----------\n+eth_dev_ops: link_update\n+\n+\n+Link status event\n+-----------------\n+rte_pci_driver.drv_flags = RTE_PCI_DRV_INTR_LSC\n+\n+\n+Removal event\n+-------------\n+rte_pci_driver.drv_flags = RTE_PCI_DRV_INTR_RMV\n+\n+\n+Queue status event\n+------------------\n+eth_dev_ops: link_update\n+\n+\n+Rx interrupt\n+------------\n+eth_dev_ops: rx_queue_intr_enable, rx_queue_intr_disable\n+\n+\n+Free Tx mbuf on demand\n+----------------------\n+eth_dev_ops: tx_done_cleanup\n+\n+\n+Queue start/stop\n+----------------\n+eth_dev_ops: rx_queue_start, rx_queue_stop, tx_queue_start, tx_queue_stop\n+\n+\n+MTU update\n+----------\n+eth_dev_ops: mtu_set\n+\n+\n+Jumbo frame\n+-----------\n+\n+\n+Scattered Rx\n+------------\n+\n+\n+LRO\n+---\n+Large Receive Offload.\n+\n+\n+TSO\n+---\n+TCP Segmentation Offloading.\n+\n+\n+Promiscuous mode\n+----------------\n+eth_dev_ops: promiscuous_enable, promiscuous_disable\n+\n+\n+Allmulticast mode\n+-----------------\n+eth_dev_ops: allmulticast_enable, allmulticast_disable\n+\n+\n+Unicast MAC filter\n+------------------\n+eth_dev_ops: mac_addr_add, mac_addr_remove\n+\n+\n+Multicast MAC filter\n+--------------------\n+eth_dev_ops: set_mc_addr_list\n+\n+\n+RSS hash\n+--------\n+eth_dev_ops: rss_hash_update, rss_hash_conf_get\n+\n+\n+RSS key update\n+--------------\n+eth_dev_ops: rss_hash_update, rss_hash_conf_get\n+\n+\n+RSS reta update\n+---------------\n+eth_dev_ops: reta_update, reta_query\n+\n+\n+VMDq\n+----\n+\n+\n+SR-IOV\n+------\n+\n+\n+DCB\n+---\n+eth_dev_ops: get_dcb_info\n+\n+\n+VLAN filter\n+-----------\n+eth_dev_ops: vlan_filter_set\n+\n+\n+Ethertype filter\n+----------------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_ETHERTYPE\n+\n+\n+N-tuple filter\n+--------------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_NTUPLE\n+\n+\n+SYN filter\n+----------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_SYN\n+\n+\n+Tunnel filter\n+-------------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_TUNNEL\n+\n+\n+Flexible filter\n+---------------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_FLEXIBLE\n+\n+\n+Hash filter\n+-----------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_HASH\n+\n+\n+Flow director\n+-------------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_FDIR\n+\n+\n+Flow control\n+------------\n+eth_dev_ops: flow_ctrl_get, flow_ctrl_set, priority_flow_ctrl_set\n+\n+\n+Flow API\n+--------\n+eth_dev_ops: filter_ctrl:RTE_ETH_FILTER_GENERIC\n+rte_flow_ops: *\n+\n+\n+Rate limitation\n+---------------\n+eth_dev_ops: set_queue_rate_limit\n+\n+\n+Traffic mirroring\n+-----------------\n+eth_dev_ops: mirror_rule_set, mirror_rule_reset\n+\n+\n+CRC offload\n+-----------\n+\n+\n+VLAN offload\n+------------\n+eth_dev_ops: vlan_offload_set\n+\n+\n+QinQ offload\n+------------\n+\n+\n+L3 checksum offload\n+-------------------\n+\n+\n+L4 checksum offload\n+-------------------\n+\n+\n+MACsec offload\n+--------------\n+\n+\n+Inner L3 checksum\n+-----------------\n+\n+\n+Inner L4 checksum\n+-----------------\n+\n+\n+Packet type parsing\n+-------------------\n+eth_dev_ops: dev_supported_ptypes_get\n+\n+\n+Timesync\n+--------\n+eth_dev_ops: timesync_enable, timesync_disable\n+eth_dev_ops: timesync_read_rx_timestamp, timesync_read_tx_timestamp\n+eth_dev_ops: timesync_adjust_time, timesync_read_time, timesync_write_time\n+\n+\n+\n+Rx descriptor status\n+--------------------\n+eth_dev_ops: rx_descriptor_status\n+\n+Check the status of a Rx descriptor.\n+\n+\n+Tx descriptor status\n+--------------------\n+eth_dev_ops: tx_descriptor_status\n+\n+Check the status of a Tx descriptor.\n+\n+\n+Basic stats\n+-----------\n+eth_dev_ops: stats_get, stats_reset\n+\n+Basic statistics, same for all drivers.\n+\n+\n+Extended stats\n+--------------\n+eth_dev_ops: xstats_get, xstats_reset, xstats_get_names\n+eth_dev_ops: xstats_get_by_id, xstats_get_names_by_id\n+\n+Extended statistics, changes from driver to driver.\n+\n+\n+Stats per queue\n+---------------\n+eth_dev_ops: queue_stats_mapping_set\n+\n+\n+FW version\n+----------\n+eth_dev_ops: fw_version_get\n+\n+\n+EEPROM dump\n+-----------\n+eth_dev_ops: get_eeprom_length, get_eeprom, set_eeprom\n+\n+\n+Registers dump\n+--------------\n+eth_dev_ops: get_reg\n+\n+\n+Multiprocess aware\n+------------------\n+\n+\n+BSD nic_uio\n+-----------\n+\n+\n+Linux UIO\n+---------\n+Works with igb_uio kernel module.\n+\n+\n+Linux VFIO\n+----------\n+Works with vfio-pci kernel module.\n+\n+\n+Other kdrv\n+----------\n+\n+\n+ARMv7\n+-----\n+defconfig_arm-armv7a-\\*-\\*\n+\n+Support armv7 architecture.\n+\n+\n+ARMv8\n+-----\n+defconfig_arm64-armv8a-\\*-\\*\n+\n+Support armv7 architecture.\n+\n+\n+Power8\n+------\n+defconfig_ppc_64-power8-\\*-\\*\n+\n+Support PowerPC architecture.\n+\n+\n+x86-32\n+------\n+defconfig_x86_x32-native-\\*-\\*\n+defconfig_i686-native-\\*-\\*\n+\n+Support 32bits x86 architecture.\n+\n+\n+x86-64\n+------\n+defconfig_x86_64-native-\\*-\\*\n+\n+Support 64bits x86 architecture.\n+\n+\n+Usage doc\n+---------\n+doc/guides/nics/\\*.rst\n+\n+\n+Design doc\n+----------\n+\n+\n+Perf doc\n+--------\n+\n+Other dev ops not represented by a Feature\n+------------------------------------------\n+rxq_info_get\n+txq_info_get\n+vlan_tpid_set\n+vlan_strip_queue_set\n+vlan_pvid_set\n+rx_queue_setup\n+rx_queue_release\n+rx_queue_count\n+rx_descriptor_done\n+tx_queue_setup\n+tx_queue_release\n+dev_led_on\n+dev_led_off\n+l2_tunnel_offload_set\n+uc_hash_table_set\n+uc_all_hash_table_set\n+udp_tunnel_port_add\n+udp_tunnel_port_del\n+l2_tunnel_eth_type_conf\n+l2_tunnel_offload_set\n+bypass\\*\n+\n", "prefixes": [ "dpdk-dev", "RFC" ] }