From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Yanling Song <songyl@ramaxel.com>, <dev@dpdk.org>
Cc: <yanling.song@linux.dev>, <yanggan@ramaxel.com>,
<xuyun@ramaxel.com>, <stephen@networkplumber.org>,
<lihuisong@huawei.com>
Subject: Re: [PATCH v6 25/26] net/spnic: add doc infrastructure
Date: Wed, 19 Jan 2022 17:27:56 +0000 [thread overview]
Message-ID: <a0225a73-034d-c645-da38-24df62d503de@intel.com> (raw)
In-Reply-To: <3cb3441af22c2483cfbe1908ff8c26c721d7644a.1640838702.git.songyl@ramaxel.com>
On 12/30/2021 6:09 AM, Yanling Song wrote:
> This patch adds doc infrastructure for spnic PMD driver.
>
> Signed-off-by: Yanling Song <songyl@ramaxel.com>
<...>
> 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 <linux_gsg>` to setup the basic DPDK environment.
> +
> +
> +Driver compilation and testing
> +------------------------------
> +
> +Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
> +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.
next prev parent reply other threads:[~2022-01-19 17:28 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-30 6:08 [PATCH v6 00/26] Net/SPNIC: support SPNIC into DPDK 22.03 Yanling Song
2021-12-30 6:08 ` [PATCH v6 01/26] drivers/net: introduce a new PMD driver Yanling Song
2022-01-19 16:58 ` Ferruh Yigit
2021-12-30 6:08 ` [PATCH v6 02/26] net/spnic: initialize the HW interface Yanling Song
2022-01-19 17:05 ` Ferruh Yigit
2022-01-21 9:32 ` Yanling Song
2021-12-30 6:08 ` [PATCH v6 03/26] net/spnic: add mbox message channel Yanling Song
2021-12-30 6:08 ` [PATCH v6 04/26] net/spnic: introduce event queue Yanling Song
2021-12-30 6:08 ` [PATCH v6 05/26] net/spnic: add mgmt module Yanling Song
2022-01-19 17:22 ` Ferruh Yigit
2022-01-21 9:33 ` Yanling Song
2021-12-30 6:08 ` [PATCH v6 06/26] net/spnic: add cmdq and work queue Yanling Song
2021-12-30 6:08 ` [PATCH v6 07/26] net/spnic: add interface handling cmdq message Yanling Song
2021-12-30 6:08 ` [PATCH v6 08/26] net/spnic: add hardware info initialization Yanling Song
2021-12-30 6:08 ` [PATCH v6 09/26] net/spnic: support MAC and link event handling Yanling Song
2022-01-19 17:26 ` Ferruh Yigit
2022-01-21 9:36 ` Yanling Song
2021-12-30 6:08 ` [PATCH v6 10/26] net/spnic: add function info initialization Yanling Song
2021-12-30 6:08 ` [PATCH v6 11/26] net/spnic: add queue pairs context initialization Yanling Song
2021-12-30 6:08 ` [PATCH v6 12/26] net/spnic: support mbuf handling of Tx/Rx Yanling Song
2021-12-30 6:08 ` [PATCH v6 13/26] net/spnic: support Rx congfiguration Yanling Song
2021-12-30 6:08 ` [PATCH v6 14/26] net/spnic: add port/vport enable Yanling Song
2021-12-30 6:08 ` [PATCH v6 15/26] net/spnic: support IO packets handling Yanling Song
2021-12-30 6:08 ` [PATCH v6 16/26] net/spnic: add device configure/version/info Yanling Song
2021-12-30 6:08 ` [PATCH v6 17/26] net/spnic: support RSS configuration update and get Yanling Song
2021-12-30 6:08 ` [PATCH v6 18/26] net/spnic: support VLAN filtering and offloading Yanling Song
2021-12-30 6:08 ` [PATCH v6 19/26] net/spnic: support promiscuous and allmulticast Rx modes Yanling Song
2021-12-30 6:08 ` [PATCH v6 20/26] net/spnic: support flow control Yanling Song
2021-12-30 6:08 ` [PATCH v6 21/26] net/spnic: support getting Tx/Rx queues info Yanling Song
2021-12-30 6:09 ` [PATCH v6 22/26] net/spnic: net/spnic: support xstats statistics Yanling Song
2021-12-30 6:09 ` [PATCH v6 23/26] net/spnic: support VFIO interrupt Yanling Song
2021-12-30 6:09 ` [PATCH v6 24/26] net/spnic: support Tx/Rx queue start/stop Yanling Song
2021-12-30 6:09 ` [PATCH v6 25/26] net/spnic: add doc infrastructure Yanling Song
2022-01-19 17:27 ` Ferruh Yigit [this message]
2022-01-21 9:39 ` Yanling Song
2021-12-30 6:09 ` [PATCH v6 26/26] net/spnic: fixes unsafe C style code Yanling Song
2022-01-19 17:28 ` Ferruh Yigit
2022-01-21 9:40 ` Yanling Song
2022-01-19 16:56 ` [PATCH v6 00/26] Net/SPNIC: support SPNIC into DPDK 22.03 Ferruh Yigit
2022-01-21 9:27 ` Yanling Song
2022-01-21 10:22 ` Ferruh Yigit
2022-01-24 5:12 ` Hemant Agrawal
2022-02-12 14:01 ` Yanling Song
2022-02-13 18:07 ` Thomas Monjalon
2022-02-18 9:30 ` Yanling Song
2023-04-13 9:02 ` Ferruh Yigit
2023-07-31 14:08 ` Thomas Monjalon
2022-02-16 14:19 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a0225a73-034d-c645-da38-24df62d503de@intel.com \
--to=ferruh.yigit@intel.com \
--cc=dev@dpdk.org \
--cc=lihuisong@huawei.com \
--cc=songyl@ramaxel.com \
--cc=stephen@networkplumber.org \
--cc=xuyun@ramaxel.com \
--cc=yanggan@ramaxel.com \
--cc=yanling.song@linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).