From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-SN1-obe.outbound.protection.outlook.com (mail-sn1nam01on0084.outbound.protection.outlook.com [104.47.32.84]) by dpdk.org (Postfix) with ESMTP id 9F586374E for ; Thu, 14 Sep 2017 16:02:20 +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=Y1jxb5h8TdGFhuSS8f57VALJA5cA3YzpACQtvoJrqMY=; b=ATuLeKyr79O3gMYXQne4NCrlRLoYH6GLgp1DLMBEBgc4Y73TfUey/fKsOiZMvYm31py23x1oJ+S2wFr2Db0KVyS9qfKSQpZXCLEqkhYTYnvRkIPors/tYk/qtn3myJPS3uHCDtC6zaeXyZ+s36mPeegQUmwQXNsjVcBT2Nf31uE= Received: from DM5PR12MB1129.namprd12.prod.outlook.com (10.168.236.136) by DM5PR12MB1625.namprd12.prod.outlook.com (10.172.40.19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.56.11; Thu, 14 Sep 2017 14:02:19 +0000 Received: from DM5PR12MB1129.namprd12.prod.outlook.com ([10.168.236.136]) by DM5PR12MB1129.namprd12.prod.outlook.com ([10.168.236.136]) with mapi id 15.20.0035.021; Thu, 14 Sep 2017 14:02:18 +0000 From: "Kumar, Ravi1" To: Hemant Agrawal , "dev@dpdk.org" CC: "Shippen, Greg" Thread-Topic: [PATCH 3/4] doc: Add documents for AMD XGBE Ethernet Thread-Index: AQHTLVCxjmZ6kMtchkSLJDL4DrqyIaK0aRJA Date: Thu, 14 Sep 2017 14:02:18 +0000 Message-ID: References: <1505324838-25734-1-git-send-email-ravi1.kumar@amd.com> <1505324838-25734-3-git-send-email-ravi1.kumar@amd.com> <64885f61-1947-5e20-2922-9c8ed3ebcd91@nxp.com> In-Reply-To: <64885f61-1947-5e20-2922-9c8ed3ebcd91@nxp.com> Accept-Language: en-IN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: spf=none (sender IP is ) smtp.mailfrom=Ravi1.Kumar@amd.com; x-originating-ip: [202.56.249.162] x-ms-publictraffictype: Email x-microsoft-exchange-diagnostics: 1; DM5PR12MB1625; 20:6Obabb6xF3L/S4DewOM22eimgUYI8c4RXXITdVoJHoQqY1zzObgkbUoLURXm5u6YPqeBTd5tH8Bsb53pauwPu9lNOtqh2aL/nrml1gZcKHLzgXbrN/3ozbBPc8DSLRAEuhjs+OH4lFEftzvz0RA++ETbbkZRuGFUCImZEaYZJnpCtSdYHD1nanwP4Bf//rXaRk+vuM4j091QrGkYwpiNvkKP9HozHvVqnJ6mOiBCWDuXHSATPLS8hjXiAz7/0pZt x-ms-exchange-antispam-srfa-diagnostics: SSOS;SSOR; x-forefront-antispam-report: SFV:SKI; SCL:-1; SFV:NSPM; SFS:(10009020)(6009001)(39860400002)(346002)(376002)(199003)(24454002)(377454003)(13464003)(189002)(8656003)(7696004)(54356999)(101416001)(8936002)(8676002)(102836003)(5660300001)(76176999)(77096006)(6436002)(81156014)(86362001)(6116002)(6506006)(2501003)(3846002)(53946003)(229853002)(66066001)(14454004)(9686003)(50986999)(81166006)(2950100002)(55016002)(99286003)(6306002)(2900100001)(305945005)(25786009)(74316002)(2906002)(33656002)(97736004)(53936002)(6246003)(72206003)(3660700001)(7736002)(316002)(53546010)(478600001)(106356001)(68736007)(105586002)(3280700002)(189998001)(4326008)(2004002)(217873001)(579004); DIR:OUT; SFP:1101; SCL:1; SRVR:DM5PR12MB1625; H:DM5PR12MB1129.namprd12.prod.outlook.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:en; x-ms-office365-filtering-correlation-id: a2411f1f-b016-4f26-1879-08d4fb793605 x-ms-office365-filtering-ht: Tenant x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(300000500095)(300135000095)(300000501095)(300135300095)(22001)(300000502095)(300135100095)(2017030254152)(48565401081)(300000503095)(300135400095)(2017052603199)(201703131423075)(201703031133081)(201702281549075)(300000504095)(300135200095)(300000505095)(300135600095)(300000506095)(300135500095); SRVR:DM5PR12MB1625; x-ms-traffictypediagnostic: DM5PR12MB1625: x-exchange-antispam-report-test: UriScan:(250305191791016)(22074186197030)(185117386973197)(767451399110); x-microsoft-antispam-prvs: x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(2401047)(5005006)(8121501046)(3002001)(93006095)(93001095)(100000703101)(100105400095)(10201501046)(6055026)(6041248)(20161123558100)(20161123564025)(20161123562025)(20161123555025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:DM5PR12MB1625; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:DM5PR12MB1625; x-forefront-prvs: 0430FA5CB7 received-spf: None (protection.outlook.com: amd.com does not designate permitted sender hosts) spamdiagnosticoutput: 1:99 spamdiagnosticmetadata: NSPM Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-originalarrivaltime: 14 Sep 2017 14:02:18.0438 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR12MB1625 Subject: Re: [dpdk-dev] [PATCH 3/4] doc: Add documents for AMD XGBE Ethernet 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, 14 Sep 2017 14:02:21 -0000 >Hi Ravi, >' >On 9/13/2017 11:17 PM, Ravi Kumar wrote: >> Signed-off-by: Ravi Kumar >> --- >> doc/guides/nics/axgbe.rst | 214 ++++++++++++++++++++++++++++++= +++++++ >> doc/guides/nics/features/axgbe.ini | 18 ++++ >> doc/guides/nics/index.rst | 1 + >> 3 files changed, 233 insertions(+) >> create mode 100644 doc/guides/nics/axgbe.rst create mode 100644=20 >> doc/guides/nics/features/axgbe.ini >> >> diff --git a/doc/guides/nics/axgbe.rst b/doc/guides/nics/axgbe.rst new=20 >> file mode 100644 index 0000000..97056fa >> --- /dev/null >> +++ b/doc/guides/nics/axgbe.rst >> @@ -0,0 +1,214 @@ >> +.. Copyright (c) 2017 Advanced Micro Devices, Inc. >> + All rights reserved. >> + >> + AMD 10Gb Ethernet driver >> + >> + This file is available to you under your choice of the following tw= o >> + licenses: > >will it be possible for you make these consistent with other DPDK Dual lic= ense plate formats? >e.g. >./drivers/crypto/qat/qat_adf/qat_algs.h >or, >./drivers/crypto/dpaa2_sec/mc/dpseci.c Hi Hemant, By format do you mean wordings of the license have to change? Regards, Ravi > > >> + >> + License 1: GPLv2 >> + >> + Copyright (c) 2017 Advanced Micro Devices, Inc. >> + >> + This file is free software; you may copy, redistribute and/or modif= y >> + it under the terms of the GNU General Public License as published b= y >> + the Free Software Foundation, either version 2 of the License, or (= at >> + your option) any later version. >> + >> + This file is distributed in the hope that it will be useful, but >> + WITHOUT ANY WARRANTY; without even the implied warranty of >> + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU >> + General Public License for more details. >> + >> + You should have received a copy of the GNU General Public License >> + along with this program. If not, see = . >> + >> + This file incorporates work covered by the following copyright and >> + permission notice: >> + >> + Copyright (c) 2013 Synopsys, Inc. >> + >> + The Synopsys DWC ETHER XGMAC Software Driver and documentation >> + (hereinafter "Software") is an unsupported proprietary work of Syno= psys, >> + Inc. unless otherwise expressly agreed to in writing between Synops= ys >> + and you. >> + >> + The Software IS NOT an item of Licensed Software or Licensed Produc= t >> + under any End User Software License Agreement or Agreement for Lice= nsed >> + Product with Synopsys or any supplement thereto. Permission is here= by >> + granted, free of charge, to any person obtaining a copy of this sof= tware >> + annotated with this license and the Software, to deal in the Softwa= re >> + without restriction, including without limitation the rights to use= , >> + copy, modify, merge, publish, distribute, sublicense, and/or sell c= opies >> + of the Software, and to permit persons to whom the Software is furn= ished >> + to do so, subject to the following conditions: >> + >> + The above copyright notice and this permission notice shall be incl= uded >> + in all copies or substantial portions of the Software. >> + >> + THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS" >> + BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIM= ITED >> + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A >> + PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSY= S >> + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,= OR >> + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT O= F >> + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUS= INESS >> + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHE= R IN >> + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERW= ISE) >> + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED= OF >> + THE POSSIBILITY OF SUCH DAMAGE. >> + >> + License 2: Modified BSD >> + >> + Copyright (c) 2017 Advanced Micro Devices, Inc. >> + All rights reserved. >> + >> + Redistribution and use in source and binary forms, with or without >> + modification, are permitted provided that the following conditions >> + are met: >> + >> + * Redistributions of source code must retain the above copyright >> + notice, this list of conditions and the following disclaimer. >> + * Redistributions in binary form must reproduce the above copyright >> + notice, this list of conditions and the following disclaimer in the >> + documentation and/or other materials provided with the distribution= . >> + * Neither the name of Advanced Micro Devices, Inc. nor the >> + names of its contributors may be used to endorse or promote product= s >> + derived from this software without specific prior written permissio= n. >> + >> + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS= "AS IS" >> + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED T= O, THE >> + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR = PURPOSE >> + ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR = ANY >> + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL = DAMAGES >> + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR = SERVICES; >> + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CA= USED AND >> + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, = OR TORT >> + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE U= SE OF >> + THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. >> + >> + This file incorporates work covered by the following copyright and >> + permission notice: >> + >> + Copyright (c) 2013 Synopsys, Inc. >> + >> + The Synopsys DWC ETHER XGMAC Software Driver and documentation >> + (hereinafter "Software") is an unsupported proprietary work of Syno= psys, >> + Inc. unless otherwise expressly agreed to in writing between Synops= ys >> + and you. >> + >> + The Software IS NOT an item of Licensed Software or Licensed Produc= t >> + under any End User Software License Agreement or Agreement for Lice= nsed >> + Product with Synopsys or any supplement thereto. Permission is here= by >> + granted, free of charge, to any person obtaining a copy of this sof= tware >> + annotated with this license and the Software, to deal in the Softwa= re >> + without restriction, including without limitation the rights to use= , >> + copy, modify, merge, publish, distribute, sublicense, and/or sell c= opies >> + of the Software, and to permit persons to whom the Software is furn= ished >> + to do so, subject to the following conditions: >> + >> + The above copyright notice and this permission notice shall be incl= uded >> + in all copies or substantial portions of the Software. >> + >> + THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS" >> + BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIM= ITED >> + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A >> + PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSY= S >> + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,= OR >> + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT O= F >> + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUS= INESS >> + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHE= R IN >> + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERW= ISE) >> + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED= OF >> + THE POSSIBILITY OF SUCH DAMAGE. >> + >> +AXGBE Poll Mode Driver >> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >> + >> +The AXGBE poll mode driver library (**librte_pmd_axgbe**) implements su= pport >> +for AMD 10 Gbps family of adapters. It is compiled and tested in standa= rd linux distro like Ubuntu. >> + >> +Supported Features >> +------------------ >> + >> +AXGBE PMD has support for: >> + >> +- Base L2 features >> +- Unicast/multicast filtering >> +- Promiscuous mode >> +- Port statistics >> +- TSS (Transmit Side Scaling) >> +- RSS (Receive Side Scaling) >> +- Checksum offload >> +- Jumbo Frame upto 9K >> + >> + >> +Supported Chipsets and NICs >> +--------------------------- >> +- AMD 10 Gigabit Ethernet Controller >> + >> + >> +Configuration Information >> +------------------------- >> + >> +The following options can be modified in the ``.config`` file. Please n= ote that >> +enabling debugging options may affect system performance. >> + >> +- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **n**) >> + >> + Toggle compilation of axgbe driver. To use axgbe PMD set this config = parameter >> + to 'y'. >> + >> +- ``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, so load igb_uio module i= n legacy interrupt mode >> + using module params. >> + >> +- Bind the intented 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=3D171456, size= =3D2176, socket=3D0 >> + USER1: create a new mbuf pool : n=3D171456, size= =3D2176, socket=3D1 >> + USER1: create a new mbuf pool : n=3D171456, size= =3D2176, socket=3D2 >> + USER1: create a new mbuf pool : n=3D171456, size= =3D2176, socket=3D3 >> + 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/featur= es/axgbe.ini >> new file mode 100644 >> index 0000000..042ff1e >> --- /dev/null >> +++ b/doc/guides/nics/features/axgbe.ini >> @@ -0,0 +1,18 @@ >> +; >> +; Supported features of the 'axgbe' network poll mode driver. >> +; >> +; Refer to default.ini for the full list of available PMD features. >> +; >> +[Features] >> +Speed capabilities =3D Y >> +Link status =3D Y >> +Jumbo frame =3D Y >> +Promiscuous mode =3D Y >> +Allmulticast mode =3D Y >> +RSS hash =3D Y >> +CRC offload =3D Y >> +L3 checksum offload =3D Y >> +L4 checksum offload =3D Y >> +Basic stats =3D Y >> +Linux UIO =3D Y >> +x86-64 =3D Y >> diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst >> index 36f4f3f..8e39847 100644 >> --- a/doc/guides/nics/index.rst >> +++ b/doc/guides/nics/index.rst >> @@ -40,6 +40,7 @@ Network Interface Controller Drivers >> build_and_test >> ark >> avp >> + axgbe >> bnx2x >> bnxt >> cxgbe >> -----Original Message----- From: Hemant Agrawal [mailto:hemant.agrawal@nxp.com]=20 Sent: Thursday, September 14, 2017 5:28 PM To: Kumar, Ravi1 ; dev@dpdk.org Subject: Re: [PATCH 3/4] doc: Add documents for AMD XGBE Ethernet Hi Ravi, ' On 9/13/2017 11:17 PM, Ravi Kumar wrote: > Signed-off-by: Ravi Kumar > --- > doc/guides/nics/axgbe.rst | 214 +++++++++++++++++++++++++++++++= ++++++ > doc/guides/nics/features/axgbe.ini | 18 ++++ > doc/guides/nics/index.rst | 1 + > 3 files changed, 233 insertions(+) > create mode 100644 doc/guides/nics/axgbe.rst create mode 100644=20 > doc/guides/nics/features/axgbe.ini > > diff --git a/doc/guides/nics/axgbe.rst b/doc/guides/nics/axgbe.rst new=20 > file mode 100644 index 0000000..97056fa > --- /dev/null > +++ b/doc/guides/nics/axgbe.rst > @@ -0,0 +1,214 @@ > +.. Copyright (c) 2017 Advanced Micro Devices, Inc. > + All rights reserved. > + > + AMD 10Gb Ethernet driver > + > + This file is available to you under your choice of the following two > + licenses: will it be possible for you make these consistent with other DPDK Dual lice= nse plate formats? e.g. ./drivers/crypto/qat/qat_adf/qat_algs.h or, ./drivers/crypto/dpaa2_sec/mc/dpseci.c > + > + License 1: GPLv2 > + > + Copyright (c) 2017 Advanced Micro Devices, Inc. > + > + This file is free software; you may copy, redistribute and/or modify > + it under the terms of the GNU General Public License as published by > + the Free Software Foundation, either version 2 of the License, or (a= t > + your option) any later version. > + > + This file is distributed in the hope that it will be useful, but > + WITHOUT ANY WARRANTY; without even the implied warranty of > + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU > + General Public License for more details. > + > + You should have received a copy of the GNU General Public License > + along with this program. If not, see . > + > + This file incorporates work covered by the following copyright and > + permission notice: > + > + Copyright (c) 2013 Synopsys, Inc. > + > + The Synopsys DWC ETHER XGMAC Software Driver and documentation > + (hereinafter "Software") is an unsupported proprietary work of Synop= sys, > + Inc. unless otherwise expressly agreed to in writing between Synopsy= s > + and you. > + > + The Software IS NOT an item of Licensed Software or Licensed Product > + under any End User Software License Agreement or Agreement for Licen= sed > + Product with Synopsys or any supplement thereto. Permission is hereb= y > + granted, free of charge, to any person obtaining a copy of this soft= ware > + annotated with this license and the Software, to deal in the Softwar= e > + without restriction, including without limitation the rights to use, > + copy, modify, merge, publish, distribute, sublicense, and/or sell co= pies > + of the Software, and to permit persons to whom the Software is furni= shed > + to do so, subject to the following conditions: > + > + The above copyright notice and this permission notice shall be inclu= ded > + in all copies or substantial portions of the Software. > + > + THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS" > + BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMI= TED > + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A > + PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS > + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, = OR > + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSI= NESS > + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER= IN > + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWI= SE) > + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED = OF > + THE POSSIBILITY OF SUCH DAMAGE. > + > + License 2: Modified BSD > + > + Copyright (c) 2017 Advanced Micro Devices, Inc. > + All rights reserved. > + > + Redistribution and use in source and binary forms, with or without > + modification, are permitted provided that the following conditions > + are met: > + > + * Redistributions of source code must retain the above copyright > + notice, this list of conditions and the following disclaimer. > + * Redistributions in binary form must reproduce the above copyright > + notice, this list of conditions and the following disclaimer in the > + documentation and/or other materials provided with the distribution. > + * Neither the name of Advanced Micro Devices, Inc. nor the > + names of its contributors may be used to endorse or promote products > + derived from this software without specific prior written permission= . > + > + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS = "AS IS" > + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO= , THE > + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR P= URPOSE > + ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR A= NY > + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL D= AMAGES > + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR S= ERVICES; > + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAU= SED AND > + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, O= R TORT > + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE US= E OF > + THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. > + > + This file incorporates work covered by the following copyright and > + permission notice: > + > + Copyright (c) 2013 Synopsys, Inc. > + > + The Synopsys DWC ETHER XGMAC Software Driver and documentation > + (hereinafter "Software") is an unsupported proprietary work of Synop= sys, > + Inc. unless otherwise expressly agreed to in writing between Synopsy= s > + and you. > + > + The Software IS NOT an item of Licensed Software or Licensed Product > + under any End User Software License Agreement or Agreement for Licen= sed > + Product with Synopsys or any supplement thereto. Permission is hereb= y > + granted, free of charge, to any person obtaining a copy of this soft= ware > + annotated with this license and the Software, to deal in the Softwar= e > + without restriction, including without limitation the rights to use, > + copy, modify, merge, publish, distribute, sublicense, and/or sell co= pies > + of the Software, and to permit persons to whom the Software is furni= shed > + to do so, subject to the following conditions: > + > + The above copyright notice and this permission notice shall be inclu= ded > + in all copies or substantial portions of the Software. > + > + THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS" > + BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMI= TED > + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A > + PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS > + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, = OR > + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF > + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSI= NESS > + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER= IN > + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWI= SE) > + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED = OF > + THE POSSIBILITY OF SUCH DAMAGE. > + > +AXGBE Poll Mode Driver > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +The AXGBE poll mode driver library (**librte_pmd_axgbe**) implements sup= port > +for AMD 10 Gbps family of adapters. It is compiled and tested in standar= d linux distro like Ubuntu. > + > +Supported Features > +------------------ > + > +AXGBE PMD has support for: > + > +- Base L2 features > +- Unicast/multicast filtering > +- Promiscuous mode > +- Port statistics > +- TSS (Transmit Side Scaling) > +- RSS (Receive Side Scaling) > +- Checksum offload > +- Jumbo Frame upto 9K > + > + > +Supported Chipsets and NICs > +--------------------------- > +- AMD 10 Gigabit Ethernet Controller > + > + > +Configuration Information > +------------------------- > + > +The following options can be modified in the ``.config`` file. Please no= te that > +enabling debugging options may affect system performance. > + > +- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **n**) > + > + Toggle compilation of axgbe driver. To use axgbe PMD set this config p= arameter > + to 'y'. > + > +- ``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, so load igb_uio module in= legacy interrupt mode > + using module params. > + > +- Bind the intented 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=3D171456, size= =3D2176, socket=3D0 > + USER1: create a new mbuf pool : n=3D171456, size= =3D2176, socket=3D1 > + USER1: create a new mbuf pool : n=3D171456, size= =3D2176, socket=3D2 > + USER1: create a new mbuf pool : n=3D171456, size= =3D2176, socket=3D3 > + 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/feature= s/axgbe.ini > new file mode 100644 > index 0000000..042ff1e > --- /dev/null > +++ b/doc/guides/nics/features/axgbe.ini > @@ -0,0 +1,18 @@ > +; > +; Supported features of the 'axgbe' network poll mode driver. > +; > +; Refer to default.ini for the full list of available PMD features. > +; > +[Features] > +Speed capabilities =3D Y > +Link status =3D Y > +Jumbo frame =3D Y > +Promiscuous mode =3D Y > +Allmulticast mode =3D Y > +RSS hash =3D Y > +CRC offload =3D Y > +L3 checksum offload =3D Y > +L4 checksum offload =3D Y > +Basic stats =3D Y > +Linux UIO =3D Y > +x86-64 =3D Y > diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst > index 36f4f3f..8e39847 100644 > --- a/doc/guides/nics/index.rst > +++ b/doc/guides/nics/index.rst > @@ -40,6 +40,7 @@ Network Interface Controller Drivers > build_and_test > ark > avp > + axgbe > bnx2x > bnxt > cxgbe >