From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B0B26A034E; Wed, 19 Jan 2022 18:28:35 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A357641183; Wed, 19 Jan 2022 18:28:35 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 8195C41147 for ; Wed, 19 Jan 2022 18:28:33 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1642613313; x=1674149313; h=message-id:date:to:cc:references:from:subject: in-reply-to:content-transfer-encoding:mime-version; bh=hJukp6HXZO8Eo3kFEhddsx+F7LCZV0pcJhJpT0KrVJA=; b=NkHJEFAVk28LbgeAps7ZDu6zF1vH4nsD+rdwInrNv0gwJJ+tlFuyDLwe gNxMpunEQSjzG/D6aEsrfvqY67/UYwv2Hgw6/OLe2Ve5uEWizlSa0n8uk T7PQos8/plRFSANswO3aVakSgGCoy6nZCxz4mhUPrJjENLVBJQHaS66YO Ghw7Y5wgAIiqQYW/6SZi9Ty7PJcWvhLc1VjMfiWLsZDQ7wpSCMaQE13d6 dZD+f1CVQ6CjCl6YALGPpREA3xHvdiSDtlJ0PNGpiTgKVMhCCPoNY110Z J7m+W7KDgTJLMLraoh73VGU5SqM0Bpnx0aD1azJl4c1PVUwrTO12KQ5Pk w==; X-IronPort-AV: E=McAfee;i="6200,9189,10231"; a="308461983" X-IronPort-AV: E=Sophos;i="5.88,299,1635231600"; d="scan'208";a="308461983" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Jan 2022 09:28:06 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.88,299,1635231600"; d="scan'208";a="493102416" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by orsmga002.jf.intel.com with ESMTP; 19 Jan 2022 09:28:04 -0800 Received: from fmsmsx607.amr.corp.intel.com (10.18.126.87) by fmsmsx601.amr.corp.intel.com (10.18.126.81) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.20; Wed, 19 Jan 2022 09:28:04 -0800 Received: from fmsmsx603.amr.corp.intel.com (10.18.126.83) by fmsmsx607.amr.corp.intel.com (10.18.126.87) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.20; Wed, 19 Jan 2022 09:28:03 -0800 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx603.amr.corp.intel.com (10.18.126.83) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.20 via Frontend Transport; Wed, 19 Jan 2022 09:28:03 -0800 Received: from NAM11-CO1-obe.outbound.protection.outlook.com (104.47.56.176) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2308.20; Wed, 19 Jan 2022 09:28:03 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=a7SI1MWgdW6eNpdSbJSMxMPQ7h3HdsJGuvdzllZvVKkAbglA6UAUKuBEVN1DycxfA6ODT3JPDAWeW4EMCor/2his0AAiJqAStw2ppJrNhVUmbLnl2CyDOxIsFx/a5hxkoIpB1idb69/3tz5YuAW47plDKAHoeoZ2aGda9zeLoI5gSD+zOdfZf9o5uB+i3rOHsppciiXqLKKjFx4f+lLMEj3E9qRqdO7NeQPcNinis9rLegOovEly+78rh6NQ6d5klpl0Auyloz9QFMr81u9G0NrRWpt04urjYhyJr2uYQGnaq3KXIZgFQIcGSP7ectcmcdgXyVPrMG6kOw5k10jg4A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=iDpqXWgxKzKRE41TGdwnR3NfEdhe3Zi7Y7njV3G0cIc=; b=ef5TeWbxt5ROGq+YcusOEPNahZg2pV8CY0eXt5llfJOQYRLV6gc+XSuOkZLXPHLyEq8xkN+WVsktaempOdhTqNSAPd0echgc7HAwy32kHBlaPSEUsXZdornI453b5TGNfuovRnG1Bya8lk6eyzszLpcfz8r3ueFHMlqARC9veqhATiFoA1Eb/HEBPQf5yuujL1Zsl4bOLLvlJ37nAdbJW+4t+9ok3sQBbcghFg/TACPApjCSTaWSoRK/ISHlDf2lzBeBVtX9korMCVI6Aee4DsIldgqoFMLTZQWWeJmuqZqA3N97erdZH9m+3iQdwBq8xzoEnhnkjq7+0V8ZUew6Yw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from PH0PR11MB5000.namprd11.prod.outlook.com (2603:10b6:510:41::19) by DM6PR11MB3081.namprd11.prod.outlook.com (2603:10b6:5:6a::25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4888.11; Wed, 19 Jan 2022 17:28:02 +0000 Received: from PH0PR11MB5000.namprd11.prod.outlook.com ([fe80::5046:8550:928d:850e]) by PH0PR11MB5000.namprd11.prod.outlook.com ([fe80::5046:8550:928d:850e%7]) with mapi id 15.20.4909.008; Wed, 19 Jan 2022 17:28:02 +0000 Message-ID: Date: Wed, 19 Jan 2022 17:27:56 +0000 Content-Language: en-US To: Yanling Song , CC: , , , , References: <3cb3441af22c2483cfbe1908ff8c26c721d7644a.1640838702.git.songyl@ramaxel.com> From: Ferruh Yigit Subject: Re: [PATCH v6 25/26] net/spnic: add doc infrastructure X-User: ferruhy In-Reply-To: <3cb3441af22c2483cfbe1908ff8c26c721d7644a.1640838702.git.songyl@ramaxel.com> Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 8bit X-ClientProxiedBy: LO4P123CA0393.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:18f::20) To PH0PR11MB5000.namprd11.prod.outlook.com (2603:10b6:510:41::19) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: c374d8f9-7886-497b-e4e8-08d9db710b6d X-MS-TrafficTypeDiagnostic: DM6PR11MB3081:EE_ X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:6430; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: A1jpv5jaPQd7L/T+UmaVqVs9H4MQrYONP7QpBCenQKOxYCXbJN+Ny6aFU8U/BaqWpWCX966JxU6dbp8UZ5f5ht3FTYrMqWf7AYoCrUipg6GDXEJPJiwECx2wjg1SW6c7r5qFOzzzgoZ0ZGanworZpCKez5PuPY4rd1EiuwbgDrWlEtv9d1BQeQj6v0cmxkmPun6cY+HlYG4gL4xWM05x1LDK2GDjMDszKG7Nv44cY1bP5aUFFGFAevtVk0/qe2mKR0nU07Gd7T7di27TF3QCdOM8PS6/E+q1D2FfDt/0+xInvvH0SWY+bwupLIg8QOr1bNGmKoSVwkTSUlDX/AqV8rd1aqEg8KuyxHE2gjxJcCbjRbYqm8LNHdpr5PHLiOiZlEsDLrqI8VrpZPNEEGeeNHhxhD4Cd9st+giqebENMO3Sqg37DefWvxIIQ1JJyfstXpKVaTjATRBsX1A8rHTEHtlWx0e+06xsm8nsvYv9SM5Z+6DEuW8E3F43CVryknuOOrz2f95mfrUZ7GVvrFGxsgdCucoFL1kiaGj73PpkT+NMpGAy0/rOWLz0ZJVZ0M+eAnveqy13b8V2WamOUopLEX1D/avrXQuWWiYiK9YzECz4SUyJKDXOLWVPpNhZU9IFIGDzUALp3YwJYTt9xNQAY28qdpYP3Ip4XgDUQ0eyLbHYhfiK08F3g+CgyLSZCNwsZvaJuDmFQ7KYSU7vb5YXxQ== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PH0PR11MB5000.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(366004)(2906002)(508600001)(8936002)(82960400001)(6666004)(31696002)(66556008)(66946007)(83380400001)(36756003)(86362001)(4326008)(2616005)(26005)(66476007)(316002)(6486002)(5660300002)(31686004)(38100700002)(6512007)(44832011)(186003)(8676002)(6506007)(53546011)(45980500001); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Smh1RE4zMlY5ZU9YeG8vVHpzMlF1WUNicldWSCtxQ2FONXZ5SXp0NnZIR1c4?= =?utf-8?B?djMxaVdSSTE3WkM0by9KbVAzMkhqdW5ScldCRWhMcmdwc0cveHhFQWZGSmVT?= =?utf-8?B?aE52eTZXM1RMWDZQWjdmVWZpM1h3UExxUW1mdldmSWhXcWt0ZHBGUFpTckYv?= =?utf-8?B?V1NJQlgwVjFwemRDbmlURDdBVjhjMWJjZFNqQVJQT0licnlkRWN6Tm40OThh?= =?utf-8?B?eXUveEtsUDVPb09nS2M4T0FycTJXVzdoQndxdnBNcjU0UHdXdzEwQ3hySllk?= =?utf-8?B?cmhvam5yTmJNMkxXcWFwaUFCbXlYTTRiQk1IbmlROEw5dCtiS0t2RzNlSEpu?= =?utf-8?B?Rm11TmgrbEdFYkhmU2k4K1NrQVBhRXdmRVNvTTZranlrV0FyQUlHd3NVSVhT?= =?utf-8?B?YzZGY0hoYVM0ZTNzNmRFUXJDUVZra0VOaWZpckNoTzNiM3NvUlh2ZDJLakUy?= =?utf-8?B?Zkx3amk2M2hkdlErQkNzN2xnUm14VUNGMktMZ25ybWNHRm9VTSsxQWowSjRL?= =?utf-8?B?L2xMaGlFOUs3eG5SRWpxK3AyRXdDcEQ5djg1SDA5QlVyZ3lQaEFGZ2lLaFUz?= =?utf-8?B?VFNMYUlOV0w3cVgwZmRUWHN0L0JnK1ZrUE9PdTh6MURQb0ZWUGJWYTR1bGJk?= =?utf-8?B?aVFuWmJYU09sdG5pMTByTlBldThJWTdIMjR1cmJmeXVCWkFYM01EazdjVi9M?= =?utf-8?B?Nm85NXFsRno0NXVuZ3RGYmZCOHlYbGxWV3lta0I1b25iVlc0a2IrRDk5TGE2?= =?utf-8?B?L2NCSEpFYVJSQ3phNUp4MmhWOXNIZTYyNEYvMGRVaGNiZjN6OFRtaEZnR2k4?= =?utf-8?B?NXR5dW1kT0xtSlYyZXROek9mS29lbWFHQWtSSVdsckwvOHZnQTlkYUZTbWE5?= =?utf-8?B?VTByUm1LcmcrdFZya0VyY3FpWklCSDc1ckUybVIxL1pkbFN6YjZta2RXVGxv?= =?utf-8?B?OTZwb3ZXUXRRWE9aNW9QNndneHNnNm5PamtIOEQwWWp5bk9VazA2TllLbVRD?= =?utf-8?B?V1c3UkdzSG1sYmdjUnJzOHlGajQ2cnluZDV6QkpqKzlnb2lvTFFRZi95dzNU?= =?utf-8?B?TWp1VmluNlhkNUE5SDVLTTRKcnh6azJrZFRQZmZRbC94dG9HU1E2S0ZHRDlU?= =?utf-8?B?NGhUMjEvNVFrUlJ5b01DaXA1QXF3ZFFCZ3k5U3pLVmszYXNvSVFpdjc0blkw?= =?utf-8?B?RDdDbkZUYWs2ZDlaRHkvazRRUy9UN1Z3akdLayt3U1pjVXdjd3poSU1aQ2xn?= =?utf-8?B?Z3dFaFNoR1FBYmhIVFNwTTlnVStZOHBDWU80S2xBWXkxbm9va3ZzZDdVZkI5?= =?utf-8?B?M1l0bXY4eVlpZ2YzTFJoaHFmblJDZDZOOW4yNVBNb3R3NExWWU1HZVExazVl?= =?utf-8?B?OHdEcndrbHNoM05LN3A4d2VhOHpzTVRjRXpDNkZnWkdRWDdoa3V6bEZmazVC?= =?utf-8?B?NUExVkFSQ3MrUkxLVi8xSGdtajIxQmpiL3QzR3M3SzVuQk1DcnB1YWpuU2hz?= =?utf-8?B?NjJzNW1rS2FlSzdpRXYzY0dSUVRLS284MlhqVW1DYjFpeExYZlVqRXh1ckE5?= =?utf-8?B?MlN3akdjWWRZZDdzenhnOGd5NVVhYzE5NmRYOXBuZ2c0YVc0cUdoZWo3dmRB?= =?utf-8?B?M3RZSUpoZVgvdmova0U5bC84SXN0aGJtNVpsSGZZYVpxZDFlZlk1c0FiTFhM?= =?utf-8?B?ckl4MGlaeHJITGFTZGpTd0RhWXJXTUxKenhVa0lQUVl6OUNpdGV4U1REem1n?= =?utf-8?B?d2NoWG5lWEtEQ0ZuclgvSTdKSHR2WGh3UjkwK1hVemtqQVhHeTlVYjBLSW9R?= =?utf-8?B?MUJvTEE5emt3bytoSzZ2OGNuMVhHNWw2cjF5OWNlRWNscTVCblgvNlVSd2tL?= =?utf-8?B?MWd0OWlyOVFabks2S1dxK2VlenJQRGJVT2lQdDFjMjhHOVNPUnBCVnhZaWR6?= =?utf-8?B?TENYSzR1OVplUGhHcUFnVUJUTW5yV01yQTRidFhjUXJuSWU2QzlxMWlnUTdS?= =?utf-8?B?MW56UTdIcmhVT3drbzlpdDVmaWpab1Y0WHd0NDNFaXNIT3ZxTnN4SGRwdk10?= =?utf-8?B?QXBIZUhpN2gzQTJ3eWNKVmlPVzJpMDJTWDFiV0dwQ2s4eUJTckFyZEtkc3hK?= =?utf-8?B?dWw3ak84Z0Y1Y1RkOCtXM3AyWTdlK3JKVVlBQk8vVjlnSE5SZjR3RUpaay9v?= =?utf-8?Q?cxqXPUCexYOQnmDDwAwjwDc=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: c374d8f9-7886-497b-e4e8-08d9db710b6d X-MS-Exchange-CrossTenant-AuthSource: PH0PR11MB5000.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2022 17:28:02.1517 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: mdFGV/JBRQA4bnToE+mIEAod1XuVZMCt4wQpA6A/8UGL9BiCR4EhFV5C3M5vSCZkk4mQMGqDSLM7MqCkV/6QFg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR11MB3081 X-OriginatorOrg: intel.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 12/30/2021 6:09 AM, Yanling Song wrote: > This patch adds doc infrastructure for spnic PMD driver. > > Signed-off-by: Yanling Song <...> > diff --git a/doc/guides/nics/spnic.rst b/doc/guides/nics/spnic.rst > new file mode 100644 > index 0000000000..fd04178f8a > --- /dev/null > +++ b/doc/guides/nics/spnic.rst > @@ -0,0 +1,55 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2021 Ramaxel Memory Technology, Ltd > + > + > +SPNIC Poll Mode Driver > +====================== > + > +The spnic PMD (**librte_net_spnic**) provides poll mode driver support > +for 25Gbps/100Gbps SPNxxx Network Adapters. > + Can you please provide more information to the device, and add a link to the product page? > + > +Features > +-------- > + > +- Multiple queues for TX and RX > +- Receiver Side Scaling（RSS） > +- RSS supports IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6, use inner type for VXLAN as default > +- MAC/VLAN filtering > +- Checksum offload > +- TSO offload > +- LRO offload > +- Promiscuous mode > +- Port hardware statistics > +- Link state information > +- Link flow control(pause frame) > +- Scattered and gather for TX and RX > +- SR-IOV - Partially supported VFIO only > +- VLAN filter and VLAN offload > +- Allmulticast mode > +- MTU update > +- Unicast MAC filter > +- Multicast MAC filter > +- Set Link down or up > +- FW version > +- Multi arch support: x86_64, ARMv8. Please build this list in each patch as these features are added. So have the base documentation in first patch, later as above features added update this file in that patch. Same for above .ini file. > + > +Prerequisites > +------------- > + > +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. > + > + > +Driver compilation and testing > +------------------------------ > + > +Refer to the document :ref:`compiling and testing a PMD for a NIC ` > +for details. > + > +It is highly recommended to upgrade the spnic driver and firmware to avoid the compatibility issues, > +and check the work mode with the latest product documents. > + > +Limitations or Known issues > +--------------------------- > +Build with ICC is not supported yet. > +X86-32, Power8, ARMv7 and BSD are not supported yet.