From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0083.outbound.protection.outlook.com [104.47.36.83]) by dpdk.org (Postfix) with ESMTP id 5FD451C94E for ; Thu, 5 Apr 2018 08:40:28 +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=9DwKIExhOjrWKG9iA6A6tUNCXHc1yC2IKBMgz+pE4oA=; b=ieg1xzxxv1YPh1Rn49UcSherRj+HswXMAT6BciLbf57iYyhC1Kni5Vvy1TOIiaZnxqz7hglTOValg4EVpxkemV0IijuOZol/XANohZwjoz4NIrjUpJ3e5T6FNY97kgBXi3E0K6iu/wUAYiyHs0/2DOaesD66PqDgS2EomHLTt80= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Ravi1.Kumar@amd.com; Received: from wallaby-smavila.amd.com (202.56.249.162) by BN6PR12MB1505.namprd12.prod.outlook.com (2603:10b6:405:11::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.653.12; Thu, 5 Apr 2018 06:40:26 +0000 From: Ravi Kumar To: dev@dpdk.org Cc: ferruh.yigit@intel.com Date: Thu, 5 Apr 2018 02:39:43 -0400 Message-Id: <1522910389-35530-11-git-send-email-Ravi1.kumar@amd.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1522910389-35530-1-git-send-email-Ravi1.kumar@amd.com> References: <1520584954-130575-1-git-send-email-Ravi1.kumar@amd.com> <1522910389-35530-1-git-send-email-Ravi1.kumar@amd.com> MIME-Version: 1.0 Content-Type: text/plain; charset=y Content-Transfer-Encoding: 8bit X-Originating-IP: [202.56.249.162] X-ClientProxiedBy: BMXPR01CA0040.INDPRD01.PROD.OUTLOOK.COM (2603:1096:b00:c::26) To BN6PR12MB1505.namprd12.prod.outlook.com (2603:10b6:405:11::18) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: baab9bdc-1366-4250-5206-08d59ac01e2c X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(5600026)(4604075)(48565401081)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020); SRVR:BN6PR12MB1505; X-Microsoft-Exchange-Diagnostics: 1; BN6PR12MB1505; 3:z8yO+kdrdCrwEkB215W7vm0qGiqlz0nPxtdVQkMNXKjxxu/KOO8x9KzGz52C49Uv82ULB6kLtH1pD4KqPTvRuSiiUxpLbz4oRsvrtFXUj+VWHZSwexq4elKlv65tDroMN6T/+ECwRE+OoKSjcVmLHxl/G+6VJZFBd139C9lEsQG2DPkrYzOJRudMLc7jDfnLff+uN8Q9wZr+MGG1zaaM1hlLYyxQ1S/NuG32SsTAJLJy7+hJoChZnWPMdjpsWIJ7; 25:nyHCR2QQx+zKuXATvxOzNpHFm+yLN+tga/s2zoAma1/dlJAuVXHsWUSNiqZbB9SIsXlMY/n7zxS3mGCYMrL3kjCznMQu7iL8lFgN8KJho5MfwMvNDwFUgl4jIhtNs0XVd8SKcx5Lgqj8ZTG3ax4pyBz3ye7oXcfRsWGpa6UPate+14J3sTvARmgFvQcA558hiScyzWixVUdWxAX94B70dOthQHXdsMMG4aKL7CPZlMfN85919BgUX0dCCaS2mn49Q3EAzG3Ic2rA/j77CiVs2EbB3M2/YTqNTA6Ar2d2cwYlON4TrtNC2odN4ZtAbGD+biJOzW6RM6n80GUGXFBLfA==; 31:I9JzD2k4zAojVIcAKvQlCUHorfp1+zbFAHgkbA4bgb/XpCUkIbiKZxjJP72zkC4MPogw3k+szvIG0Iaac7aqlj//X4fOKLagMaeKrOHqjLbEyZY4YePl0bU6XZEb/o+aTW4Tpw8YcR3xtP/X1t1XzRvE0cHwnNm7CFObkHWfQ7UxefL9FEjT7aIPeBHi6o04XsTtV1vRjepXebJn1OIN6p0QHRX/8iA3ApKcYqTA1+4= X-MS-TrafficTypeDiagnostic: BN6PR12MB1505: X-Microsoft-Exchange-Diagnostics: 1; BN6PR12MB1505; 20:ofBMAkfUntaI6Bijj50b+U1SkxjcQ1vD3phb6odcUg1Wk2gvdCYDJZQ1UcPmY/gfHmt/vO48ddLGKRKTnx6xlikDJ2QSlF78cw/UW5R0uzv+WdY8sVGNoq/xEWT1l/voUQmw+r2pyzQgNIVvvdnQ8y/3zY20Q6dF+WYD3ox6cPg012VJTJ9XBWjBHXsoAExTYhhYW1igZckMvivSMyezfBWEuJ0RPx9VSv6u/DGqewOqYNsTaJ7QI2AA8m9W+7szFsZQk/e9EiRk/DSn7G+wNeqgVWLUPc805+kvJ/LvJ/R0eVVnK7GvhAukfBFqnCrNduonsNpwDIfJ4/KsU8ATD6OeLTDUqFBYQNaE+pgCGhwe4lEWe2sLqSqkT17lCTihkCJsCnmxSxVOocvWClyOjheMwEff7WwJpP8mZzZdOKK5le7Zz+KkPq4KJXDsWVycOiGjaKsLa5v9dxG2nfR0TEBzFqHs040fWlfi0dZfuF1VEjOLIhqyBAwsq9MqsY6n; 4:ykwOMpj7cv0LhJRD8BepDVcklcoJoQLndaqm6Fjm4nhX1YAnjxjG42hua+F2guEc9tbAzogp/zZfR/dgiDFLf3ovPIUD6zXpu1tZn+IuGjVgOEmTE/xoKGRxL84yEXdPkdevLlNPN4wskAwlzy/Ipg2RTa+f7s8bUoSzBlAaIq19TnskriM1KWgZHi9yqkwIskhJBCAWrCK9oQ9yebwtOeq99Pzto3bO2sbsn6CjKWmIIc0N4yWGRr0o/ZRV5f8wS5DO4HfF52+ZZKCYgpFUMNl0f03zGfjPyq66ajCFLAZtfofK9Gt0triveZ7XDk5ViNXpNf5rpcM3typo5exvfA== 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)(8121501046)(5005006)(3002001)(3231221)(944501327)(52105095)(93006095)(93001095)(10201501046)(6055026)(6041310)(20161123564045)(20161123562045)(20161123558120)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(6072148)(201708071742011); SRVR:BN6PR12MB1505; BCL:0; PCL:0; RULEID:; SRVR:BN6PR12MB1505; X-Forefront-PRVS: 06339BAE63 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(366004)(346002)(376002)(396003)(39860400002)(39380400002)(199004)(189003)(3846002)(476003)(2616005)(316002)(446003)(956004)(305945005)(7736002)(478600001)(16526019)(6486002)(2870700001)(186003)(76176011)(5660300001)(97736004)(2906002)(6116002)(486006)(386003)(26005)(50466002)(11346002)(25786009)(575784001)(8936002)(86362001)(6306002)(50226002)(66066001)(47776003)(2351001)(6666003)(2361001)(6916009)(4326008)(81166006)(36756003)(53416004)(68736007)(7696005)(8676002)(106356001)(105586002)(52116002)(81156014)(53936002)(72206003); DIR:OUT; SFP:1101; SCL:1; SRVR:BN6PR12MB1505; 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; BN6PR12MB1505; 23:nBLSJL6nzGPx2SC8GH6AO3qdEqj3yTwRK0ObKYZKI?= =?us-ascii?Q?XREx37i/HMR1jsRp68LuI81vumXyCAvHJCAtRnBKbd4z/Os8Q7+tF2NURSmb?= =?us-ascii?Q?xGWzF/gOEpw5xqAOm1XEmg8IPkhpbKPrwZD8lgq8AWB7SVNDfeu5DBz8Ycpc?= =?us-ascii?Q?hxZvB/0PPepwDsyEiAF0b1eL5SHoeYJ+XhzNWgl+3TykIOELy6gU8ScONKSw?= =?us-ascii?Q?YA+nSD7sbBCFy7eTvIxhbARv6YMlMcHkuJKwxnig84wf8IDvA8rF/JBXztyL?= =?us-ascii?Q?OOCw+76ijc4GE1tGE9QiK8ymYCBjV4U9KTJ5bgcGflTGRiqHSlFAU2hDmLBL?= =?us-ascii?Q?jTUDI6MvlEto4ykraPyW2Y1x10azz0FY17LwN5kJVwlqApj2NdGZCGnHrJmW?= =?us-ascii?Q?mRDlnYUKC3hDQqw3pre7MyuH5APTyG8qDhUxs0k1VSy8YmekW2f32LE8k40c?= =?us-ascii?Q?Dp2nvIc+WUS/s1HmCCUpaxEjfFU7cSfmpmLK4PgPtHPpleFq8R2iIFlyGo2E?= =?us-ascii?Q?q/4siyncL+5lTdCWNGxSxcyiBkh5O4GIp+doOVojGWSbzwDqS/pcVUJtW5sm?= =?us-ascii?Q?B8ajJtm4IGOgFwia+0jF5mMMApIljvBJeml5ydOsjTgE0N6thhLnGJV0ZkwY?= =?us-ascii?Q?wPFSIFKcBJKT6CSe6ChbAARyn1XjhwuDa6cgKbrrbTTsAfdnUMLsbGsg1MVB?= =?us-ascii?Q?XgAVyVZaHvllwFUgK6IFVO8bTotRd6kxkc6Lt/e5Z3AkuujIk1I9k9EAmpxb?= =?us-ascii?Q?u/ThkOX+aejtX3mJsNmTkwWxxzt1rsGFv50VkDJaXvv8oni77rv7Xzu3BoI6?= =?us-ascii?Q?4GFeqlFPHpx1GkKIUQA0Y0bpSHirabQH1PqFz9jvz0gf9ByTAGtprR49G1NV?= =?us-ascii?Q?aY1UUOlxPKFiI70gKKlaP8/+0YvVzgPQ4JGcIrtIEjXYWpj6hCrs2duDiwGE?= =?us-ascii?Q?g3ttovPVDivtO9bsrBRVvNtgTAo9VLJ425Tls2ajo9DfoqedlQH4gHGFA71J?= =?us-ascii?Q?/ORCUw5mlXDyHowtZM3tL4UQhMPSNS65jwe+exOvr40piYE7zflyse2cnF92?= =?us-ascii?Q?ZQJB1y2EhQr6PVC5nptzJyxJx2YXGo8XN5N+NsdmEb7uQLuPxjyR75jb4+jk?= =?us-ascii?Q?KwoaVuscdIgSi3ZdfAKV0iJsZebF0g3a4jPXPbClC5+LEcsplcp1tQGx7fwC?= =?us-ascii?Q?IGdpz3XAV0Z6fmM1waEWGD3AHu/tIEuqjwGNHoI4b+ko6vXk9Ky63gp+8X42?= =?us-ascii?Q?4S1YXUAAVRqfEXpRrQ=3D?= X-Microsoft-Antispam-Message-Info: DHItlq9ogvAWHrYd75HQMr7pZWzqlb7dugZEgkoeaYWL5zIZCQaaus6M+YexvQK84GM8CWZMJzMY/t0uCmMU8SRb5tXQZ9eSTHc8AonR1zgUuPk1j8Vo/e+dwDeuDuB+RaJALrRHducjxSLVUQkb/3K5Vpi2oHD1ncYD6BQ/pWKl3OzYfvOt+gCUy2tU5dKt X-Microsoft-Exchange-Diagnostics: 1; BN6PR12MB1505; 6:bpzCxhAuvUj0JV4Fo9GPysYcyVxvOAZUu5NAQxvZXMG5pQ2Se3ZyefQBz/jc8myQL/XLGe2VUzqWvDeOPYQhtb6Mf57UFtPoERpX8fh+tOzsfOT4Luznq1trdOpSCc1QGHS8QfRMg7f7S1gVyTwW0jqAv3Z5Q1QMLx5yPfEvNa9ueX+k97jacNhUMNQ4whecawhEqLiDDeS0XZpJQndxFNy5V/0Q9MNWjKt1aTIc8WRx1TjWpFFJf978CdvKRWl7CoeZYeHMdr5jtNjWOKjV+qhP47kHVQHawBf537shL9C0g4C5XDiMpFTbkVPhZYQG8FgrACFBSqxumgoqSWFnxz7JIFOMcflnk0QdGS7h9ezCcsyx0NhxEf9fbQESg7mdooAwMTEhvtpf0LgPr0YWPVe0IQXV2DWVuYhtcC1t2NJBVz5r/cGTQUTsVeRNuTuWYqdOZvjgH8cnghFIzgv/ZQ==; 5:jeXFdIYs0aGAKkIEsHQ2QlcN+mk91w7hgfuriHRX0OXXMiSkJmpqEcclwtuiAtgcuFq8d4N8NWhxKuhjAR2JVKTvO8FBirFknEN7vhHJti6TfjmYesf/95qTM76Tx+lF17VnS4YTlHoqz+6hYC9v2ThDEULuOxZPPkxx7nohv2M=; 24:uA+SZKv5zukj6E9N4Dxu/d0pQ7utAYqVWkEjTM2qAL3tieqOUUbIlvidIk+gk/cbUG+0psVoNEecwtQN2Dub67Y48bhnh2xnhGRxQv1NYvY= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BN6PR12MB1505; 7:P+GacuHUloLhRXxqfC2y+nyZ/TQGU+UH2xNCB/Wc2L47S2yJkwegCl/J2pqVU+ipuOvkvzf97G46jN7i2CGjr28MaSN3jWRCTudFMAUJSQdlY4b42gc/ScpQia+K0QjB3+brIBVY4JNC+xy+EvlCVhTJNoJYGLOWxY56bY7EwIwXBi4zIxncrc29Sy0fs5jzyW+V8jLxEn9l1IVl0K4j+wMsLMDNVSVLUIYW3N0RvY1LW0emXBRR0tuHZMabplUP; 20:inT2SLShvPdxEV8d+j3JN4kIyyPRQPciHfVIcQ3n4Gvx57T5RVOV0Jp584ECQAlbcMHX4WfwvSvZk1tfr1s0OwW6ZaxEn5ZUpVfb/OGwEmxW86B3TYuyqqfaxGUgtrjggDVMrynM0sVHshj4I2rYHNgA7Q+bNb1geQ0l5pj3MNczS7CTj//Vk8aOf9tNUXgTP2RVXwUOlzY/t0yA/+a6SoeflRRs/WM49xbgMF0I9zclR9FedtzH11t4oIU0cDvw X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Apr 2018 06:40:26.4224 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: baab9bdc-1366-4250-5206-08d59ac01e2c X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR12MB1505 Subject: [dpdk-dev] [PATCH v4 11/17] 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: , X-List-Received-Date: Thu, 05 Apr 2018 06:40:29 -0000 Signed-off-by: Ravi Kumar --- doc/guides/nics/axgbe.rst | 89 ++++++++++++++++++++++++++++++++++++++ doc/guides/nics/features/axgbe.ini | 14 ++++++ doc/guides/nics/index.rst | 1 + 3 files changed, 104 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..f0b0ff6 --- /dev/null +++ b/doc/guides/nics/axgbe.rst @@ -0,0 +1,89 @@ +.. 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_DEBUG_INIT`` (default **n**) + + Toggle display of initialization 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. + +- AXGBE PMD works only with legacy interrupts. Load ``igb_uio`` module in legacy interrupt mode + using module params. + +- Bind the intended AMD device to igb_uio 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 -- 2.7.4