Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/1194/?format=api
{ "id": 1194, "url": "https://patches.dpdk.org/api/patches/1194/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1415390747-9532-8-git-send-email-ssujith@cisco.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": "<1415390747-9532-8-git-send-email-ssujith@cisco.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1415390747-9532-8-git-send-email-ssujith@cisco.com", "date": "2014-11-07T20:05:47", "name": "[dpdk-dev,7/7] Release notes for ENIC PMD 1.0.0.3", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "3804ce977cefcb9b0d41965cb376880730cacc6b", "submitter": { "id": 110, "url": "https://patches.dpdk.org/api/people/110/?format=api", "name": "Sujith Sankar", "email": "ssujith@cisco.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1415390747-9532-8-git-send-email-ssujith@cisco.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/1194/comments/", "check": "pending", "checks": "https://patches.dpdk.org/api/patches/1194/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 1BDB27F7C;\n\tFri, 7 Nov 2014 11:28:01 +0100 (CET)", "from bgl-iport-1.cisco.com (bgl-iport-1.cisco.com [72.163.197.25])\n\tby dpdk.org (Postfix) with ESMTP id 59A467F4C\n\tfor <dev@dpdk.org>; Fri, 7 Nov 2014 11:27:45 +0100 (CET)", "from vla196-nat.cisco.com (HELO bgl-core-3.cisco.com)\n\t([72.163.197.24])\n\tby bgl-iport-1.cisco.com with ESMTP; 07 Nov 2014 10:37:16 +0000", "from localhost ([10.106.186.117]) (authenticated bits=0)\n\tby bgl-core-3.cisco.com (8.14.5/8.14.5) with ESMTP id sA7AbDS1015330\n\t(version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NO);\n\tFri, 7 Nov 2014 10:37:16 GMT" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n\td=cisco.com; i=@cisco.com; l=7551; q=dns/txt; s=iport;\n\tt=1415356637; x=1416566237;\n\th=from:to:cc:subject:date:message-id:in-reply-to:\n\treferences:mime-version:content-transfer-encoding;\n\tbh=/Krdzsa2LHtVVbm6YqX6qSQu9Ar96rPAgiCnabUzuWU=;\n\tb=PRCPQQWjs8/rscPdmaX0/kbXuuhDcmh4Qb2S8avCvbOoZ64MzN/iuiiy\n\tSqWaHoKXquzeXdWx4eyZcFhQbPcqmT7Lr4ANMyBljxkAQmN3/pKLAhQ8X\n\txEZXDJPGk+DuOmQ5UjHU3OmMdV41tlvT8f0gxqCwoyRjDjOOptGJ+eICf E=;", "X-IronPort-AV": "E=Sophos;i=\"5.07,331,1413244800\"; d=\"scan'208\";a=\"47242412\"", "From": "Sujith Sankar <ssujith@cisco.com>", "To": "dev@dpdk.org", "Date": "Sat, 8 Nov 2014 01:35:47 +0530", "Message-Id": "<1415390747-9532-8-git-send-email-ssujith@cisco.com>", "X-Mailer": "git-send-email 1.9.1", "In-Reply-To": "<1415390747-9532-1-git-send-email-ssujith@cisco.com>", "References": "<1415390747-9532-1-git-send-email-ssujith@cisco.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-Authenticated-User": "ssujith@cisco.com", "Subject": "[dpdk-dev] [PATCH 7/7] Release notes for ENIC PMD 1.0.0.3", "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": "---\n lib/librte_pmd_enic/ReleaseNotes.txt | 196 +++++++++++++++++++++++++++++++++++\n 1 file changed, 196 insertions(+)\n create mode 100644 lib/librte_pmd_enic/ReleaseNotes.txt", "diff": "diff --git a/lib/librte_pmd_enic/ReleaseNotes.txt b/lib/librte_pmd_enic/ReleaseNotes.txt\nnew file mode 100644\nindex 0000000..9d9ef3b\n--- /dev/null\n+++ b/lib/librte_pmd_enic/ReleaseNotes.txt\n@@ -0,0 +1,196 @@\n+================================================================================\n+ DPDK Poll-mode Driver for Cisco Systems Inc. VIC Ethernet NIC\n+ Release Notes\n+ Version 1.0.0.3\n+================================================================================\n+ ENIC PMD is the poll-mode driver for the Cisco System Inc. VIC Ethernet NIC\n+ to be used with DPDK suite.\n+\n+ If you are running/would like to run your applications on Intel DPDK software \n+ suite on Cisco UCS servers that use Cisco VIC adapters, please read the \n+ information provided in this document.\n+\n+How to obtain ENIC PMD integrated DPDK?\n+---------------------------------------\n+ The source tarball of the whole DPDK suite, dpdk-<version>.tar.gz could be \n+ downloaded from www.dpdk.org\n+\n+ Alternatively, the same could be downloaded from www.cisco.com. \n+\n+\n+Software License\n+----------------\n+ Please read the file LICENSE in lib/librte_pmd_enic/ directory in DPDK \n+ source tree.\n+\n+ The License terms are also present at the top of the source files.\n+\n+\n+Configuration information\n+-------------------------\n+ In order to ensure that ENIC PMD will also be built by DPDK build scripts, \n+ ensure that CONFIG_RTE_LIBRTE_ENIC_PMD=y is there in the following file in \n+ DPDK suite.\n+\n+ - config/common_linuxapp\n+\n+ If CONFIG_RTE_EAL_VFIO is y in config/common/linuxapp in the DPDK source\n+ tree, ENIC PMD will try to get initialized using VFIO. If\n+ CONFIG_RTE_EAL_VFIO is n, it will try to use UIO framework.\n+\n+ No matter how many receive/transmit queues are configured in the service\n+ profile, only one interrupt per vNIC interface needs to be configured.\n+ ENIC PMD uses this interrupt to get information about errors in the fast path.\n+\n+\n+How to build the suite?\n+-----------------------\n+ The build instruction of DPDK suite should be followed and that would build\n+ ENIC PMD library as well.\n+\n+ Typically, a user would execute the following commands to build the suite\n+ - tar -xzf dpdk-<version>.tar.gz\n+ - cd dpdk-<version>\n+ - make install T=x86_64-native-linuxapp-gcc\n+\n+\n+Version Information\n+-------------------\n+ The version of ENIC driver will be printed by ENIC PMD during the \n+ intialization.\n+\n+ This release notes is a part of version number 1.0.0.3\n+\n+Directory Structure\n+-------------------\n+librte_pmd_enic\n+|-- LICENSE\n+| License terms\n+|\n+|-- Makefile\n+| Makefile to build ENIC PMD as a part of building DPDK\n+|\n+|-- scripts\n+| |-- bind_to_vfio\n+| | Script which binds a vNIC to VFIO\n+| |\n+| `-- unbind_from_vfio\n+| Script which unbinds a vNIC from VFIO\n+|\n+`-- src\n+ Source code of ENIC PMD\n+\n+\n+Dependencies\n+------------\n+ - If the user wants to use DPDK with VFIO, the Linux kernel used \n+ should have support for Linux VFIO. Linux kernels post 3.6.0 supports VFIO\n+\n+ The header file vfio.h should be present in /usr/include/linux/\n+\n+ For kernels post 3.6.0, this file should be present in \n+ <kernel_src_dir>/usr/include/linux/\n+\n+ In the case of Ubuntu, if the file is not present, install the \n+ package linux_libc_dev\n+\n+ - This version of ENIC PMD has been tested with DPDK suite version 1.7.1\n+\n+ - For using UIO framework, please refer the documentation that comes with\n+ DPDK suite\n+\n+\n+Supported Cisco VIC adapters \n+----------------------------\n+ - ENIC PMD could be used with all the generations of Cisco VIC adapters.\n+ - Flow director feature is not supported on generation 1 Cisco VIC adapters\n+ (M81KR and P81E)\n+\n+\n+Supported Operating Systems\n+---------------------------\n+Any Linux distribution fulfilling the conditions described in Dependencies \n+section of this document.\n+\n+Supported features in this release\n+------------------------------------\n+ - Unicast, multicast and broadcast transmission and reception\n+ - Receive queue polling\n+ - Statistics\n+ - Hardware VLAN acceleration\n+ - IP checksum offload\n+ - Receive side header-split\n+ - Receive side VLAN stripping\n+ - Multiple receive and transmit queues\n+ - Perfect filters for flow direction (supported on all adapters except M81KR\n+ and P81E)\n+ - Promiscuous mode\n+ - Setting RX VLAN (supported via UCSM/CIMC only)\n+ - VLAN filtering (supported via UCSM/CIMC only)\n+ - Execution of application by unprivileged system users\n+ \n+\n+Known bugs and Unsupported features in this release\n+---------------------------------------------------\n+ - Signature filters\n+ - Drop feature of perfect filters\n+ - VLAN based flow direction\n+ - Flexbytes based flow direction\n+ - Setting of extended VLAN\n+\n+\n+Prerequisites\n+-------------\n+ - Prepare the system as recommended by DPDK suite. This includes environment\n+ variables, hugepages configuration, tool-chains and configuration\n+ - Insert vfio-pci kernel module using the command 'modprobe vfio-pci' if the\n+ user wants to use VFIO framework\n+ - Insert uio kernel module using the command 'modprobe uio' if the user wants\n+ to use UIO framework\n+ - DPDK suite should be configured based on the user's decision to use VFIO or\n+ UIO framework\n+ - Bind the intended vNIC to vfio-pci using librte_pmd_enic/scripts/bind_to_vfio\n+ in case the user wants ENIC PMD to use VFIO framework\n+ - Bind the intended vNIC to igb_uio in case the user wants ENIC PMD to use\n+ UIO framework\n+\n+ Now, the system is ready to run the application. Once the application runs to \n+ completion, if it is required, the vNIC could be detached from vfio-pci or igb_uio.\n+ vNICs could be detached from vfio-pci using the script\n+ librte_pmd_enic/scripts/unbind_from_vfio\n+\n+ Root privilege is required to bind and unbind vNICs to/from VFIO/UIO.\n+\n+ VFIO framework helps an unprivileged user to run the applications.\n+\n+ For an unprivileged user to run the applications on DPDK and ENIC PMD,\n+ it might be required to increase the maximum locked memory of the user.\n+ The following command could be used to do this.\n+\n+ sudo sh -c \"ulimit -l <value in Kilo Bytes>\"\n+\n+ The value depends on the memory configuration of the application, DPDK and\n+ PMD. Typically, the limit has to be raised to higher than 2GB. \n+ e.g., 2621440\n+\n+ The compilation of any unused drivers could be turned off using the\n+ configuration file in config/ directory (e.g., config/common_linuxapp). \n+ This would help in bringing down the time taken for building the \n+ libraries and the initialization time of the application. \n+\n+Additional Reference\n+--------------------\n+ - www.dpdk.org\n+ - Intel® Data Plane Development Kit: Release Notes\n+ - Intel® Data Plane Development Kit: Programmer's Guide\n+ - Intel® Data Plane Development Kit Testpmd Application: Guide\n+\n+\n+Contact Information\n+-------------------\n+ Any questions or bugs should be reported to DPDK community or to the following\n+ email addresses.\n+\n+ Sujith Sankar <ssujith@cisco.com>\n+ Prasad Rao <prrao@cisco.com>\n+\n", "prefixes": [ "dpdk-dev", "7/7" ] }