From patchwork Fri Apr 6 12:36:44 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "Kumar, Ravi1" X-Patchwork-Id: 37371 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 559501CFFD; Fri, 6 Apr 2018 14:37:54 +0200 (CEST) Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0079.outbound.protection.outlook.com [104.47.36.79]) by dpdk.org (Postfix) with ESMTP id CDF021CFDC for ; Fri, 6 Apr 2018 14:37:30 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amdcloud.onmicrosoft.com; s=selector1-amd-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=MpLVQN9Kak2y/Uz1QHnfuyZgtXdLw131HwpQzLk0O1U=; b=ysqz1AS5d+svKHHej8yDFDnisuz7O38gIy1vk1p3euFVTpWw2Gcmv3t24TuyekInW091/w4rmmbZk+zyFUCxp+iESUHyf48qzph/X6oxoZEYWHRQuZesJ8JJQQiS1I7N30Pg9lbNjVfmcEXhXpoCSY/fLZKG7G9hXfPuHlXhLWI= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Ravi1.Kumar@amd.com; Received: from wallaby-smavila.amd.com (202.56.249.162) by CY4PR12MB1509.namprd12.prod.outlook.com (2603:10b6:910:8::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.631.10; Fri, 6 Apr 2018 12:37:28 +0000 From: Ravi Kumar To: dev@dpdk.org Cc: ferruh.yigit@intel.com Date: Fri, 6 Apr 2018 08:36:44 -0400 Message-Id: <1523018211-65765-11-git-send-email-Ravi1.kumar@amd.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1523018211-65765-1-git-send-email-Ravi1.kumar@amd.com> References: <1522910389-35530-1-git-send-email-Ravi1.kumar@amd.com> <1523018211-65765-1-git-send-email-Ravi1.kumar@amd.com> MIME-Version: 1.0 X-Originating-IP: [202.56.249.162] X-ClientProxiedBy: MA1PR0101CA0013.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:21::23) To CY4PR12MB1509.namprd12.prod.outlook.com (2603:10b6:910:8::22) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-HT: Tenant X-MS-Office365-Filtering-Correlation-Id: 4f4f5f1d-ad43-4368-61c5-08d59bbb295e X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(48565401081)(5600026)(4604075)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020); SRVR:CY4PR12MB1509; X-Microsoft-Exchange-Diagnostics: 1; CY4PR12MB1509; 3:24X87g2OZ76IE5BcE8/MTK4CpfEtYWLRm1oZkEHZ67v/s5fHqUogn8REB+0htAtht1TGX8jS6c+/FGWknqYV+1BQinoNa+Dw8UjiFlb6Fyb/sUbJntpvp7cyEr7DQ4i1gl4+KCfw+qFEheHeoQ3ogMgMu1xslRJZJoVxQVEepoQmVavEVnrCs2oL3sPAm0Yxl9NmEOpi6Wy51CVfGjwuXr63oGEwbJgVS8j3Sf5oMOJMQ5v6PIfduDElEQrjaV52; 25:PBJ8i7BrzPSgwpBXA15+3TsBEGEoLRLasZ64Q8wmKIboESGi93BtNhE2D3JYzNJHrX4/0LHV02wZMhK8o3HHT2sVvNbqsHW24mWeyhTgHbDCg9C9DYWCYQN6gmhPmar4LRnHw++txdIgDg/yKhzIEM056dJmY5YJiBEf29XCKSNI3Dia5POa++5mDwGx4+rESIsmTdb7k3jUx3mBzLrUZZrAZytMxpeDkwoGeQIM2LtXv2ENIDJWcnNMrNHPtnMJ3ESNHZko3jrb4j/f4D+vasCQDL3mbgv6GhLhvgTQwGpiaqqZuxzDeeWK6L+pQ+axoJofuKo1hYENcC5Dr/scDg==; 31:ddIzGFRjYQWuU6AwQVDIEdUilLn5PiRBK/gMiRk+chwZjFGjOyQRntQ50TDu8BJQ2J8ShGi4KIhv+FbQxF6TKNU/vMYElP1L1vK1FxTCkpV5unzqdv+Fnhww/HPTy8Q+J01b1XgKYOPOBWHxSgbma2T2M8bHFWpn9PTaSyletO5LRhIHjfJCmK4+66uaeeMU6q8XW9ag5/qVTu3D7TFwhBHKYPAVfLlBTFdNqP41d6Y= X-MS-TrafficTypeDiagnostic: CY4PR12MB1509: X-Microsoft-Exchange-Diagnostics: 1; CY4PR12MB1509; 20:PhDYg/OCkzhrVbkqvPwJDkdbj5+qYhwU3Tg15YA5rZ3OL1gRQYTz/SIuxWvIQCIRNnZSkLIujzlSDAhnDq+AHjYLV9ocLFrxcYMFosilzfQKgr9pUZFXtsTORG16/lAkFvNlB6ssDCu9KnXhFWyHqZSOrryP4kB9CzgKogHLGOC3kHbJDM0MBe0sEdP4PbsvNtSZwfH7A3H3tVAY4SMfRxicDdqPZN3kVw21FcgLO/FXb0L62KnB7SPpkRJh1HBwZzbKpZhmiVH2obYy3/F/BviQuOq90N5csV3xv6UAbXnqRGYtTx9fqN/IXY/RIPe2zBAmh4mCf0ETgNetKWMHb3JU0OCS6+iDvvkOEjouRK5tW79gmW70j+iWcGhnr1qiJLdpMRSnWqJsV4E1rtZZNSIXz1wnxbarT1XGYAX3bw7v4AFFIZcoKBy79D+DoYdw7DYpjg6aNqF/9N0rofS7LydN8OojLL39mmB6icvdp3CXJ85/zYsj60KX9BdJRlc3; 4:s2YryFuYu6CJuh//RpFioK7LbGTW+X6IG8eWR4iQ9L/Yat6MbMpez97oeTR/obyynRWTu7i90aaWSV782jrzUi3p/DMe9utqh20cvRjgsORIalXlBnT6GPO2Rw8xItvrrHM5sfEHzw2heIRscPN+qBAVHRfo6ToZIci8OCg8hCmTxeSQjcUOv7asrDfec109w3nY+MgyOgRaj9dnJ7ovK3wJ7DQV5DLSjkANO66qohVCwwKCj7lSuc3m6ntoB1cNlWI898CjZ6HWz5jxhE8W3ppZOy0Mg4vNHoeuhC6sEjFpsy+N6OX5WSQ1FcP3FLcUdFn5LDkZTwHXcMMhmDOWtQ== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(95223839027130)(767451399110); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3002001)(10201501046)(93006095)(93001095)(3231221)(944501327)(52105095)(6055026)(6041310)(20161123558120)(20161123564045)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(6072148)(201708071742011); SRVR:CY4PR12MB1509; BCL:0; PCL:0; RULEID:; SRVR:CY4PR12MB1509; X-Forefront-PRVS: 0634F37BFF X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(39380400002)(39860400002)(346002)(366004)(376002)(199004)(189003)(72206003)(7696005)(105586002)(478600001)(6116002)(50466002)(3846002)(446003)(486006)(53936002)(11346002)(68736007)(2906002)(2616005)(386003)(16526019)(186003)(26005)(76176011)(956004)(50226002)(6306002)(476003)(316002)(97736004)(305945005)(2351001)(2361001)(25786009)(7736002)(36756003)(2870700001)(5660300001)(52116002)(8676002)(6916009)(6666003)(47776003)(4326008)(6486002)(86362001)(53416004)(8936002)(66066001)(81166006)(81156014)(106356001); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR12MB1509; H:wallaby-smavila.amd.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: amd.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; CY4PR12MB1509; 23:qrQqhaxYZRhDN78nwOctmS63Kd3O09Lu/rtzmpqoF?= F8v7In3GWhICMhImE8JOFEQ0MWqsyCkI6uQpAUW4ExURVWE/YeX5XrdL6bR0FNtdBfCYL4JUCzVsuXP25g9YpJVXB3jFvLT4XWqoQ/PxNNSUMp5uKnQHNvQm3heTL3NL7o/ecaegJaeH44viqW4qtur8OeSeYi9Pp0NqkvgYfHzliZOJGpoS/uZ5Yaj+F69QeajpSrXAUuTZo69miKChX9iAfpcv4YFj6IBF000fxz8xj099F/TbEGK8FW6iFAMXSU3lbfk2bS6hB10GHbcs+I/yyv5D81ayOKJ0VyZppB+LckYXATCD+4zdE6ws14D3q6uP17GcKegH4o/sRMrSxc1Rh2uUWGbuZz2l5CgNkea6ckVAhQCtNCusNGdSiwxbDWmlElirOoD/3tu9cQ/5fwmcjoYHQ88ln45GUkgQ0FhYSX0UbkPAvwVDQrcsmP78wJ8r6sku+WqM6+6+vEgcgBuRXNoTM6Y9WIq/6tCC09C9wrwsqEdeNFs6ZjdT+fAngHX8tPMsy7UDqJ+VMQhNkrzkI7cRkoNcdEimfua6Ft8al1NJU/dgQsMIfdACBZP3xBLPET0YNkwO59V3aLBgwkeGhGEimRvoxvzVrAH8fwGQ356fU9xGmeKiYIr9zAahCwaz10tmrM4ivG96ch7I0DQmwU3HC0JCsektMOMMAp1dBA9gkUxmlWl8JmaiZX66Vw3wozXOQuJnBKy78DRwqLyKBwO6Y8LX5wC84fGfmAkk8dlLS6FoO/Pex2LmkOJQph+AW0+GDDD8LH2taclx3wf4i6bGHpOhhbEZa2oy6BP+MoKNnpaA78KN5Vy4WQEueDYUxP/xvJXxkHgNBUlxYiHbRHDIHyH2eJmQSy04wy+646BgskbZSfvNAx/trQkKQe4BbxKuBiiB67piGxPOjM5WhH7DSYI/leFs385hBb08H6Yooa1CIBxNVUNco7oz6CZML4ZGWjfdC98bhdtAe3wPB7JV4NXGGKIKHiV+qJzKuxUWAz5A7ErouJID3iCq+tgI9zZkjH8Tra4nJNaBMDO2Wld4Nmg7w2FcFlGgp172XjE3Grar2F70OV35XZl2v9zeguaRVISmi6LXjJM9/PiCwEMBqe5dhDGQWNpI7yys2d4r4Bqi4vJ4i5nD3VEOXp9GTB+lP1EBdzw9HN0Wlt8g0+/IeogJadarfamZZUsiA== X-Microsoft-Antispam-Message-Info: a00wvV+y3Kd/F0eEFvplztskmfdhFPTFvNN6pX0qjv2nmYmLCYtn6xgvn8MR5zSYgiZf0LykqWil9DoiisHyzC6CnbhZP+f01YfFWvBl5nhighmR+9OOYoKokXys6+/wx7gB2nKNEWYBh/dFsiaR/hGsGcDORF97Zy2Dxiols8fAUIli/qlEbuIBSdNCCqre X-Microsoft-Exchange-Diagnostics: 1; CY4PR12MB1509; 6:dw3yZh9+SsnpPlF88KQV/X/t5Eri1tkxLxK6Q4toXuqJNf7tuUhYQBT/5v9BF/Cou+qMTQcMdVhW9OjBdubHuZr7WLOSkQoP3UzyAVP0LVbw/XJaZcHHkdOF2KeXCwneVrxOAOrigbnd8ztxU4GInBfsxgc9zbuk+/dr9EQ2NNLUPxMmKFOVk+zin8ObQRQguSF4C63sPQr8Ibecv05e+Sj0Pq0gQKP2BrNgNRm531OtfBYjShK0rBKYQdHevp1nh950w7NGKRg2Q9cRRuVjcFOwRdg2X0m9KT7ojpwd4C4AjnnWj0pkWSVj4s8SKSysoEXJUt6XkJyC9HNtTtLd8j903TkAxlYOfB3HzzKuPBHaE51QiVBgPRBsKgE6HIEI/djcPrHlNdiTtXg3Iz2rkZA0K1DVcJ9PXcUVFXDI6ta2Zop3YrpKi+I4/8B0EtkwP5ZaYKXBV5VLjClXXMLEKw==; 5:f+6tWz3pD/SsxEGjCJgXFGhnt0bcYCQIT7rMZzKxL+OGI3GZMnPRuoo+gX1yByC+nkHc0tBhsEhU1YzDaZn2V9Cp03iQjPQM+V67D1EvwiTuBE7iuMh005GKAkpGpA+DkKBwFVEZ4uMKBE5z1wQXUBcrDcTwkm9DidFFXu2v5q4=; 24:L1NjRHeXQiLZGFab/e+zHOBobfmujyy1gpeCmV/xwpU4H7n5AMIB074UqGMalu4SAzwxE8RdvPkkT8DXe3j52QNGQMAtZ8Xl4MJ5TKVFjuE= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY4PR12MB1509; 7:ylDqMWlggRyVInyWfkathOShmHLTsfEav7o6ucBzI/muJWswI+9cIhfwl0SL3YlquXvtikVAUuryDln6bJlSuWO+uL3d+Ol2COftzdloiERhL6oOqX9AnIUtYNEYOvR04JJqHIyx5tQbLZb5ycw+rRYZeWYmrpSU/PKkXt5RZuNFDZhhaVKTwZ+oY+3lRS/qAMmTz9uqP8EuGodbe4wqfAy7eg7koL3Pwcy2q3bYWj1mFnsIsXnUQSb9/NdaMdEQ; 20:dWz5l/GleasSlA8kanfDZKYMKOxKcp6AvKv+ZbFxdawE5L73FTkeGQ7Va4tYNDCmrdJvIL0BymVWNIifBPWO+XUeSyuUqWRBel46iVkS2/j35Zjn8gqYFk69iC/UqOhqLdE1U7iJdOvH6vMHOkQw+6S6ZL6bfFztLoxnq6tIBEiCQF74vSroMQAVwWF4nh3BsGs/qnuLZnXx4QHiJ/mhOR+EBj8sulseJwLQOZr734Ghahvbwg57b8/XDA2aMnQD X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Apr 2018 12:37:28.8502 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 4f4f5f1d-ad43-4368-61c5-08d59bbb295e X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR12MB1509 Subject: [dpdk-dev] [PATCH v5 11/18] doc: add documents for AMD axgbe Ethernet PMD 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Ravi Kumar --- doc/guides/nics/axgbe.rst | 86 ++++++++++++++++++++++++++++++++++++++ doc/guides/nics/features/axgbe.ini | 14 +++++++ doc/guides/nics/index.rst | 1 + 3 files changed, 101 insertions(+) create mode 100644 doc/guides/nics/axgbe.rst create mode 100644 doc/guides/nics/features/axgbe.ini diff --git a/doc/guides/nics/axgbe.rst b/doc/guides/nics/axgbe.rst new file mode 100644 index 0000000..b6812c2 --- /dev/null +++ b/doc/guides/nics/axgbe.rst @@ -0,0 +1,86 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright (c) 2018 Advanced Micro Devices, Inc. All rights reserved. + +AXGBE Poll Mode Driver +====================== + +The AXGBE poll mode driver library (**librte_pmd_axgbe**) implements support +for AMD 10 Gbps family of adapters. It is compiled and tested in standard linux distro like Ubuntu. + +Detailed information about SoCs that use these devices can be found here: + +- `AMD EPYC™ EMBEDDED 3000 family `_. + + +Supported Features +------------------ + +AXGBE PMD has support for: + +- Base L2 features +- TSS (Transmit Side Scaling) +- RSS (Receive Side Scaling) +- Checksum offload +- Jumbo Frame upto 9K + + +Configuration Information +------------------------- + +The following options can be modified in the ``.config`` file. Please note that +enabling debugging options may affect system performance. + +- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **y**) + + Toggle compilation of axgbe PMD. + +- ``CONFIG_RTE_LIBRTE_AXGBE_PMD_DEBUG`` (default **n**) + + Toggle display for PMD debug related messages. + + +Building DPDK +------------- + +See the :ref:`DPDK Getting Started Guide for Linux ` for +instructions on how to build DPDK. + +By default the AXGBE PMD library will be built into the DPDK library. + +For configuring and using UIO frameworks, please also refer :ref:`the +documentation that comes with DPDK suite `. + + +Prerequisites and Pre-conditions +-------------------------------- +- Prepare the system as recommended by DPDK suite. + +- Bind the intended AMD device to ``igb_uio`` or ``vfio-pci`` module. + +Now system is ready to run DPDK application. + + +Usage Example +------------- + +Refer to the document :ref:`compiling and testing a PMD for a NIC ` +for details. + +Example output: + +.. code-block:: console + + [...] + EAL: PCI device 0000:02:00.4 on NUMA socket 0 + EAL: probe driver: 1022:1458 net_axgbe + Interactive-mode selected + USER1: create a new mbuf pool : n=171456, size=2176, socket=0 + USER1: create a new mbuf pool : n=171456, size=2176, socket=1 + USER1: create a new mbuf pool : n=171456, size=2176, socket=2 + USER1: create a new mbuf pool : n=171456, size=2176, socket=3 + Configuring Port 0 (socket 0) + Port 0: 00:00:1A:1C:6A:17 + Checking link statuses... + Port 0 Link Up - speed 10000 Mbps - full-duplex + Done + testpmd> diff --git a/doc/guides/nics/features/axgbe.ini b/doc/guides/nics/features/axgbe.ini new file mode 100644 index 0000000..f644128 --- /dev/null +++ b/doc/guides/nics/features/axgbe.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'axgbe' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Speed capabilities = Y +Jumbo frame = Y +RSS hash = Y +CRC offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Linux UIO = Y +x86-64 = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 51c453d..ea9110c 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -13,6 +13,7 @@ Network Interface Controller Drivers build_and_test ark avp + axgbe bnx2x bnxt cxgbe