From: Xiaoyun Li <xiaoyun.li@intel.com>
To: junfeng.guo@intel.com, qi.z.zhang@intel.com,
awogbemila@google.com, bruce.richardson@intel.com
Cc: dev@dpdk.org, Xiaoyun Li <xiaoyun.li@intel.com>
Subject: [PATCH 10/10] doc: update documentation
Date: Fri, 29 Jul 2022 19:30:42 +0000 [thread overview]
Message-ID: <20220729193042.2764633-11-xiaoyun.li@intel.com> (raw)
In-Reply-To: <20220729193042.2764633-1-xiaoyun.li@intel.com>
Update documentation of GVE PMD and release note.
Add Junfeng Guo as GVE PMD maintainer since he'll work on GVE PMD
in the future and maintain it and I won't be available for maintaining.
Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
---
MAINTAINERS | 6 +++
doc/guides/nics/features/gve.ini | 18 +++++++
doc/guides/nics/gve.rst | 65 ++++++++++++++++++++++++++
doc/guides/rel_notes/release_22_11.rst | 4 ++
4 files changed, 93 insertions(+)
create mode 100644 doc/guides/nics/features/gve.ini
create mode 100644 doc/guides/nics/gve.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 32ffdd1a61..474f41f0de 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -697,6 +697,12 @@ F: drivers/net/enic/
F: doc/guides/nics/enic.rst
F: doc/guides/nics/features/enic.ini
+Google Virtual Ethernet
+M: Junfeng Guo <junfeng.guo@intel.com>
+F: drivers/net/gve/
+F: doc/guides/nics/gve.rst
+F: doc/guides/nics/features/gve.ini
+
Hisilicon hns3
M: Dongdong Liu <liudongdong3@huawei.com>
M: Yisen Zhuang <yisen.zhuang@huawei.com>
diff --git a/doc/guides/nics/features/gve.ini b/doc/guides/nics/features/gve.ini
new file mode 100644
index 0000000000..180408aa80
--- /dev/null
+++ b/doc/guides/nics/features/gve.ini
@@ -0,0 +1,18 @@
+;
+; Supported features of the Google Virtual Ethernet 'gve' poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Speed capabilities = Y
+Link status = Y
+MTU update = Y
+TSO = Y
+RSS hash = Y
+L4 checksum offload = Y
+Basic stats = Y
+Stats per queue = Y
+Linux = Y
+x86-32 = Y
+x86-64 = Y
+Usage doc = Y
diff --git a/doc/guides/nics/gve.rst b/doc/guides/nics/gve.rst
new file mode 100644
index 0000000000..310328c8ab
--- /dev/null
+++ b/doc/guides/nics/gve.rst
@@ -0,0 +1,65 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(C) 2022 Intel Corporation.
+
+GVE poll mode driver
+=======================
+
+The GVE PMD (**librte_net_i40e**) provides poll mode driver support for
+Google Virtual Ethernet device.
+
+The base code is under MIT license and based on GVE kernel driver v1.3.0.
+GVE base code files are:
+
+- gve_adminq.h
+- gve_adminq.c
+- gve_register.h
+- gve_desc.h
+- gve_desc_dqo.h
+
+Please refer to https://github.com/GoogleCloudPlatform/compute-virtual-ethernet-linux/tree/v1.3.0/google/gve
+to find the original base code.
+
+GVE has 3 queue formats:
+
+- GQI_QPL
+- GQI_RDA
+- DQO_RDA
+
+GQI_QPL queue format is queue page list mode. Driver needs to allocate
+memory and register this memory as a Queue Page List (QPL) in hardware
+(Google Hypervisor/GVE Backend) first. Each queue has its own QPL.
+Then Tx needs to copy packets to QPL memory and put this packet's offset
+in the QPL memory into hardware descriptors so that hardware can get the
+packets data. And Rx needs to read descriptors of offset in QPL to get
+QPL address and copy packets from the address to get real packets data.
+
+GQI_RDA queue format works like usual NICs that driver can put packets'
+physical address into hardware descriptors.
+
+DQO_RDA queue format has submission and completion queue pair for each
+Tx/Rx queue. And similar as GQI_RDA, driver can put packets' physical
+address into hardware descriptors.
+
+Please refer to https://www.kernel.org/doc/html/latest/networking/device_drivers/ethernet/google/gve.html
+to get more information about GVE queue formats.
+
+Features and Limitations
+------------------------
+
+In this release, the GVE PMD provides the basic functionality of packet
+reception and transmission.
+Supported features of the GVE PMD are:
+
+- Multiple queues for TX and RX
+- Receiver Side Scaling (RSS)
+- TSO offload
+- Port hardware statistics
+- Link state information
+- TX multi-segments (Scatter TX)
+- Tx UDP/TCP/SCTP Checksum
+
+Currently, only GQI_QPL and GQI_RDA queue format are supported in PMD.
+Jumbo Frame is not supported in PMD for now. It'll be added in the future
+DPDK release.
+Also, only GQI_QPL queue format is in use on GCP since GQI_RDA hasn't been
+released in production.
diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 8c021cf050..6674f4cf6f 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -55,6 +55,10 @@ New Features
Also, make sure to start the actual text at the margin.
=======================================================
+* **Added GVE net PMD**
+
+ Added the new ``gve`` net driver for Google Virtual Ethernet devices.
+ See the :doc:`../nics/gve` NIC guide for more details on this new driver.
Removed Items
-------------
--
2.25.1
prev parent reply other threads:[~2022-07-29 19:32 UTC|newest]
Thread overview: 192+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-29 19:30 [PATCH 00/10] introduce GVE PMD Xiaoyun Li
2022-07-29 19:30 ` [PATCH 01/10] net/gve: introduce GVE PMD base code Xiaoyun Li
2022-07-29 22:42 ` Stephen Hemminger
2022-07-29 22:45 ` Stephen Hemminger
2022-08-23 8:44 ` Guo, Junfeng
2022-08-29 8:41 ` [PATCH v2 00/10] introduce GVE PMD Junfeng Guo
2022-08-29 8:41 ` [PATCH v2 01/10] net/gve: introduce GVE PMD base code Junfeng Guo
2022-09-01 17:19 ` Ferruh Yigit
2022-09-01 18:23 ` Stephen Hemminger
2022-09-01 20:49 ` Thomas Monjalon
2022-09-06 9:31 ` Guo, Junfeng
2022-09-14 10:38 ` Thomas Monjalon
2022-08-29 8:41 ` [PATCH v2 02/10] net/gve: add logs and OS specific implementation Junfeng Guo
2022-09-01 17:20 ` Ferruh Yigit
2022-09-07 6:58 ` Guo, Junfeng
2022-09-07 11:16 ` Ferruh Yigit
2022-09-08 8:09 ` Guo, Junfeng
2022-08-29 8:41 ` [PATCH v2 03/10] net/gve: support device initialization Junfeng Guo
2022-09-01 17:21 ` Ferruh Yigit
2022-09-23 9:38 ` Guo, Junfeng
2022-09-01 17:22 ` Ferruh Yigit
2022-08-29 8:41 ` [PATCH v2 04/10] net/gve: add link update support Junfeng Guo
2022-09-01 17:23 ` Ferruh Yigit
2022-09-23 9:38 ` Guo, Junfeng
2022-08-29 8:41 ` [PATCH v2 05/10] net/gve: add MTU set support Junfeng Guo
2022-08-29 8:41 ` [PATCH v2 06/10] net/gve: add queue operations Junfeng Guo
2022-08-29 8:41 ` [PATCH v2 07/10] net/gve: add Rx/Tx support Junfeng Guo
2022-08-29 8:41 ` [PATCH v2 08/10] net/gve: add support to get dev info and configure dev Junfeng Guo
2022-09-01 17:23 ` Ferruh Yigit
2022-09-23 9:38 ` Guo, Junfeng
2022-08-29 8:41 ` [PATCH v2 09/10] net/gve: add stats support Junfeng Guo
2022-09-01 17:24 ` Ferruh Yigit
2022-09-23 9:38 ` Guo, Junfeng
2022-08-29 8:41 ` [PATCH v2 10/10] doc: update documentation Junfeng Guo
2022-09-01 17:20 ` Ferruh Yigit
2022-09-23 9:38 ` [PATCH v3 0/9] introduce GVE PMD Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 1/9] net/gve: introduce GVE PMD base code Junfeng Guo
2022-09-23 18:57 ` Stephen Hemminger
2022-09-27 7:27 ` Guo, Junfeng
2022-09-23 18:58 ` Stephen Hemminger
2022-09-27 7:27 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 0/9] introduce GVE PMD Junfeng Guo
2022-09-27 7:32 ` [PATCH v4 1/9] net/gve/base: introduce GVE PMD base code Junfeng Guo
2022-10-06 14:19 ` Ferruh Yigit
2022-10-09 9:14 ` Guo, Junfeng
2022-10-10 10:17 ` [PATCH v5 0/8] introduce GVE PMD Junfeng Guo
2022-10-10 10:17 ` [PATCH v5 1/8] net/gve/base: introduce GVE PMD base code Junfeng Guo
2022-10-19 13:45 ` Ferruh Yigit
2022-10-19 15:13 ` Hemant Agrawal
2022-10-19 15:18 ` Ferruh Yigit
2022-10-20 3:33 ` Hemant Agrawal
2022-10-19 15:48 ` Li, Xiaoyun
2022-10-19 20:52 ` Ferruh Yigit
2022-10-20 8:50 ` Li, Xiaoyun
2022-10-20 10:36 ` [PATCH v6 0/8] introduce GVE PMD Junfeng Guo
2022-10-20 10:36 ` [PATCH v6 1/8] net/gve/base: introduce GVE PMD base code Junfeng Guo
2022-10-20 14:39 ` Ferruh Yigit
2022-10-24 2:10 ` Guo, Junfeng
2022-10-20 14:40 ` Ferruh Yigit
2022-10-24 2:10 ` Guo, Junfeng
2022-10-20 10:36 ` [PATCH v6 2/8] net/gve/base: add OS specific implementation Junfeng Guo
2022-10-20 10:36 ` [PATCH v6 3/8] net/gve: add support for device initialization Junfeng Guo
2022-10-20 14:42 ` Ferruh Yigit
2022-10-24 2:10 ` Guo, Junfeng
2022-10-20 10:36 ` [PATCH v6 4/8] net/gve: add support for link update Junfeng Guo
2022-10-20 10:36 ` [PATCH v6 5/8] net/gve: add support for MTU setting Junfeng Guo
2022-10-20 14:45 ` Ferruh Yigit
2022-10-24 2:10 ` Guo, Junfeng
2022-10-20 10:36 ` [PATCH v6 6/8] net/gve: add support for dev info get and dev configure Junfeng Guo
2022-10-20 14:45 ` Ferruh Yigit
2022-10-24 2:10 ` Guo, Junfeng
2022-10-20 10:36 ` [PATCH v6 7/8] net/gve: add support for queue operations Junfeng Guo
2022-10-20 10:36 ` [PATCH v6 8/8] net/gve: add support for Rx/Tx Junfeng Guo
2022-10-20 14:47 ` Ferruh Yigit
2022-10-24 2:10 ` Guo, Junfeng
2022-10-21 9:19 ` [PATCH v7 0/8] introduce GVE PMD Junfeng Guo
2022-10-21 9:19 ` [PATCH v7 1/8] net/gve/base: introduce base code Junfeng Guo
2022-10-21 9:49 ` Ferruh Yigit
2022-10-24 5:04 ` Guo, Junfeng
2022-10-24 10:47 ` Ferruh Yigit
2022-10-24 13:23 ` Guo, Junfeng
2022-10-24 10:50 ` Ferruh Yigit
2022-10-24 13:26 ` Guo, Junfeng
2022-10-25 9:07 ` [PATCH v8 0/8] introduce GVE PMD Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 1/8] net/gve/base: introduce base code Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 2/8] net/gve/base: add OS specific implementation Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 3/8] net/gve: add support for device initialization Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 4/8] net/gve: add support for link update Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 5/8] net/gve: add support for MTU setting Junfeng Guo
2022-10-25 15:55 ` Stephen Hemminger
2022-10-26 2:15 ` Guo, Junfeng
2022-10-25 9:07 ` [PATCH v8 6/8] net/gve: add support for dev info get and dev configure Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 7/8] net/gve: add support for queue operations Junfeng Guo
2022-10-25 9:07 ` [PATCH v8 8/8] net/gve: add support for Rx/Tx Junfeng Guo
2022-10-25 12:33 ` [PATCH v8 0/8] introduce GVE PMD Ferruh Yigit
2022-10-26 2:05 ` Guo, Junfeng
2022-10-21 9:19 ` [PATCH v7 2/8] net/gve/base: add OS specific implementation Junfeng Guo
2022-10-21 9:19 ` [PATCH v7 3/8] net/gve: add support for device initialization Junfeng Guo
2022-10-21 9:49 ` Ferruh Yigit
2022-10-24 5:04 ` Guo, Junfeng
2022-10-24 10:47 ` Ferruh Yigit
2022-10-24 13:22 ` Guo, Junfeng
2022-10-21 9:19 ` [PATCH v7 4/8] net/gve: add support for link update Junfeng Guo
2022-10-21 9:19 ` [PATCH v7 5/8] net/gve: add support for MTU setting Junfeng Guo
2022-10-21 9:50 ` Ferruh Yigit
2022-10-24 5:04 ` Guo, Junfeng
2022-10-24 10:47 ` Ferruh Yigit
2022-10-24 13:23 ` Guo, Junfeng
2022-10-21 9:19 ` [PATCH v7 6/8] net/gve: add support for dev info get and dev configure Junfeng Guo
2022-10-21 9:51 ` Ferruh Yigit
2022-10-24 5:04 ` Guo, Junfeng
2022-10-24 10:48 ` Ferruh Yigit
2022-10-24 13:23 ` Guo, Junfeng
2022-10-21 9:19 ` [PATCH v7 7/8] net/gve: add support for queue operations Junfeng Guo
2022-10-21 9:19 ` [PATCH v7 8/8] net/gve: add support for Rx/Tx Junfeng Guo
2022-10-21 9:52 ` Ferruh Yigit
2022-10-24 5:04 ` Guo, Junfeng
2022-10-24 10:50 ` Ferruh Yigit
2022-10-24 13:25 ` Guo, Junfeng
2022-10-25 9:07 ` Guo, Junfeng
2022-10-21 13:12 ` [PATCH v7 0/8] introduce GVE PMD Ferruh Yigit
2022-10-24 10:50 ` Ferruh Yigit
2022-10-24 13:25 ` Guo, Junfeng
2022-10-10 10:17 ` [PATCH v5 2/8] net/gve/base: add OS specific implementation Junfeng Guo
2022-10-10 10:17 ` [PATCH v5 3/8] net/gve: add support for device initialization Junfeng Guo
2022-10-19 13:46 ` Ferruh Yigit
2022-10-19 15:59 ` Li, Xiaoyun
2022-10-19 21:00 ` Ferruh Yigit
2022-10-20 9:29 ` Guo, Junfeng
2022-10-20 11:15 ` Ferruh Yigit
2022-10-21 4:46 ` Guo, Junfeng
2022-10-19 13:47 ` Ferruh Yigit
2022-10-19 14:02 ` Xia, Chenbo
2022-10-19 14:24 ` Zhang, Helin
2022-10-19 21:16 ` Ferruh Yigit
2022-10-19 16:20 ` Li, Xiaoyun
2022-10-10 10:17 ` [PATCH v5 4/8] net/gve: add support for link update Junfeng Guo
2022-10-10 10:17 ` [PATCH v5 5/8] net/gve: add support for MTU setting Junfeng Guo
2022-10-19 13:47 ` Ferruh Yigit
2022-10-20 10:14 ` Guo, Junfeng
2022-10-10 10:17 ` [PATCH v5 6/8] net/gve: add support for dev info get and dev configure Junfeng Guo
2022-10-19 13:49 ` Ferruh Yigit
2022-10-20 9:29 ` Guo, Junfeng
2022-10-20 11:19 ` Ferruh Yigit
2022-10-21 5:22 ` Guo, Junfeng
2022-10-10 10:17 ` [PATCH v5 7/8] net/gve: add support for queue operations Junfeng Guo
2022-10-10 10:17 ` [PATCH v5 8/8] net/gve: add support for Rx/Tx Junfeng Guo
2022-10-19 13:47 ` Ferruh Yigit
2022-10-20 9:34 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 2/9] net/gve/base: add logs and OS specific implementation Junfeng Guo
2022-10-06 14:20 ` Ferruh Yigit
2022-10-09 9:14 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 3/9] net/gve: add support for device initialization Junfeng Guo
2022-10-06 14:22 ` Ferruh Yigit
2022-10-09 9:14 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 4/9] net/gve: add support for link update Junfeng Guo
2022-10-06 14:23 ` Ferruh Yigit
2022-10-09 9:14 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 5/9] net/gve: add support for MTU setting Junfeng Guo
2022-09-27 7:32 ` [PATCH v4 6/9] net/gve: add support for queue operations Junfeng Guo
2022-09-27 7:32 ` [PATCH v4 7/9] net/gve: add support for Rx/Tx Junfeng Guo
2022-10-06 14:24 ` Ferruh Yigit
2022-10-09 9:14 ` Guo, Junfeng
2022-10-10 9:39 ` Li, Xiaoyun
2022-10-10 10:18 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 8/9] net/gve: add support for dev info get and dev configure Junfeng Guo
2022-10-06 14:25 ` Ferruh Yigit
2022-10-09 9:14 ` Guo, Junfeng
2022-09-27 7:32 ` [PATCH v4 9/9] net/gve: add support for stats Junfeng Guo
2022-10-06 14:25 ` Ferruh Yigit
2022-10-09 9:15 ` Guo, Junfeng
2022-09-23 9:38 ` [PATCH v3 2/9] net/gve: add logs and OS specific implementation Junfeng Guo
2022-09-23 19:01 ` Stephen Hemminger
2022-09-27 7:27 ` Guo, Junfeng
2022-09-23 9:38 ` [PATCH v3 3/9] net/gve: support device initialization Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 4/9] net/gve: add link update support Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 5/9] net/gve: add MTU set support Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 6/9] net/gve: add queue operations Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 7/9] net/gve: add Rx/Tx support Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 8/9] net/gve: add support to get dev info and configure dev Junfeng Guo
2022-09-23 9:38 ` [PATCH v3 9/9] net/gve: add stats support Junfeng Guo
2022-09-01 17:19 ` [PATCH v2 00/10] introduce GVE PMD Ferruh Yigit
2022-09-07 2:09 ` Guo, Junfeng
2022-07-29 19:30 ` [PATCH 02/10] net/gve: add logs and OS specific implementation Xiaoyun Li
2022-07-29 19:30 ` [PATCH 03/10] net/gve: support device initialization Xiaoyun Li
2022-07-29 19:30 ` [PATCH 04/10] net/gve: add link update support Xiaoyun Li
2022-07-29 19:30 ` [PATCH 05/10] net/gve: add MTU set support Xiaoyun Li
2022-07-29 19:30 ` [PATCH 06/10] net/gve: add queue operations Xiaoyun Li
2022-07-29 19:30 ` [PATCH 07/10] net/gve: add Rx/Tx support Xiaoyun Li
2022-07-29 19:30 ` [PATCH 08/10] net/gve: add support to get dev info and configure dev Xiaoyun Li
2022-07-29 19:30 ` [PATCH 09/10] net/gve: add stats support Xiaoyun Li
2022-07-29 19:30 ` Xiaoyun Li [this message]
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=20220729193042.2764633-11-xiaoyun.li@intel.com \
--to=xiaoyun.li@intel.com \
--cc=awogbemila@google.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=junfeng.guo@intel.com \
--cc=qi.z.zhang@intel.com \
/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).