From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id AC2AFA04F3; Tue, 7 Jan 2020 18:39:47 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6CDB51D674; Tue, 7 Jan 2020 18:39:47 +0100 (CET) Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) by dpdk.org (Postfix) with ESMTP id 2DE141D634 for ; Tue, 7 Jan 2020 18:39:46 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578418785; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:autocrypt:autocrypt; bh=BE0G5GjC66xc3IvpNWoLiDTKLQKAEkucHcmVhqeRUG0=; b=c6qZS3jUX6WnabSS0OO5GQBRzqzZBbr58miaL0cavW98LuB3p5twxvDFd1KsJ1Zwum6CDp uFgD0RcTX0TX+CBuCWaEvunzOLS3oOfZ7Vm470W5MjtdlFKLVnjBJ5MIpxDBPZ2+QQ1LOn iIUjxPOopEPCNIHAxUULT8t2pAmeeBA= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-383-toujx8t6MYOVkaixSLbRCQ-1; Tue, 07 Jan 2020 12:39:42 -0500 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id D2900801E77; Tue, 7 Jan 2020 17:39:40 +0000 (UTC) Received: from [10.36.112.49] (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 8750A271B5; Tue, 7 Jan 2020 17:39:38 +0000 (UTC) To: Matan Azrad , Tiwei Bie , Zhihong Wang , Xiao Wang Cc: Ferruh Yigit , dev@dpdk.org, Thomas Monjalon References: <1577287161-10321-1-git-send-email-matan@mellanox.com> <1577287161-10321-3-git-send-email-matan@mellanox.com> From: Maxime Coquelin Autocrypt: addr=maxime.coquelin@redhat.com; keydata= mQINBFOEQQIBEADjNLYZZqghYuWv1nlLisptPJp+TSxE/KuP7x47e1Gr5/oMDJ1OKNG8rlNg kLgBQUki3voWhUbMb69ybqdMUHOl21DGCj0BTU3lXwapYXOAnsh8q6RRM+deUpasyT+Jvf3a gU35dgZcomRh5HPmKMU4KfeA38cVUebsFec1HuJAWzOb/UdtQkYyZR4rbzw8SbsOemtMtwOx YdXodneQD7KuRU9IhJKiEfipwqk2pufm2VSGl570l5ANyWMA/XADNhcEXhpkZ1Iwj3TWO7XR uH4xfvPl8nBsLo/EbEI7fbuUULcAnHfowQslPUm6/yaGv6cT5160SPXT1t8U9QDO6aTSo59N jH519JS8oeKZB1n1eLDslCfBpIpWkW8ZElGkOGWAN0vmpLfdyiqBNNyS3eGAfMkJ6b1A24un /TKc6j2QxM0QK4yZGfAxDxtvDv9LFXec8ENJYsbiR6WHRHq7wXl/n8guyh5AuBNQ3LIK44x0 KjGXP1FJkUhUuruGyZsMrDLBRHYi+hhDAgRjqHgoXi5XGETA1PAiNBNnQwMf5aubt+mE2Q5r qLNTgwSo2dpTU3+mJ3y3KlsIfoaxYI7XNsPRXGnZi4hbxmeb2NSXgdCXhX3nELUNYm4ArKBP LugOIT/zRwk0H0+RVwL2zHdMO1Tht1UOFGfOZpvuBF60jhMzbQARAQABtCxNYXhpbWUgQ29x dWVsaW4gPG1heGltZS5jb3F1ZWxpbkByZWRoYXQuY29tPokCOAQTAQIAIgUCV3u/5QIbAwYL CQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQyjiNKEaHD4ma2g/+P+Hg9WkONPaY1J4AR7Uf kBneosS4NO3CRy0x4WYmUSLYMLx1I3VH6SVjqZ6uBoYy6Fs6TbF6SHNc7QbB6Qjo3neqnQR1 71Ua1MFvIob8vUEl3jAR/+oaE1UJKrxjWztpppQTukIk4oJOmXbL0nj3d8dA2QgHdTyttZ1H xzZJWWz6vqxCrUqHU7RSH9iWg9R2iuTzii4/vk1oi4Qz7y/q8ONOq6ffOy/t5xSZOMtZCspu Mll2Szzpc/trFO0pLH4LZZfz/nXh2uuUbk8qRIJBIjZH3ZQfACffgfNefLe2PxMqJZ8mFJXc RQO0ONZvwoOoHL6CcnFZp2i0P5ddduzwPdGsPq1bnIXnZqJSl3dUfh3xG5ArkliZ/++zGF1O wvpGvpIuOgLqjyCNNRoR7cP7y8F24gWE/HqJBXs1qzdj/5Hr68NVPV1Tu/l2D1KMOcL5sOrz 2jLXauqDWn1Okk9hkXAP7+0Cmi6QwAPuBT3i6t2e8UdtMtCE4sLesWS/XohnSFFscZR6Vaf3 gKdWiJ/fW64L6b9gjkWtHd4jAJBAIAx1JM6xcA1xMbAFsD8gA2oDBWogHGYcScY/4riDNKXi lw92d6IEHnSf6y7KJCKq8F+Jrj2BwRJiFKTJ6ChbOpyyR6nGTckzsLgday2KxBIyuh4w+hMq TGDSp2rmWGJjASq5Ag0EVPSbkwEQAMkaNc084Qvql+XW+wcUIY+Dn9A2D1gMr2BVwdSfVDN7 0ZYxo9PvSkzh6eQmnZNQtl8WSHl3VG3IEDQzsMQ2ftZn2sxjcCadexrQQv3Lu60Tgj7YVYRM H+fLYt9W5YuWduJ+FPLbjIKynBf6JCRMWr75QAOhhhaI0tsie3eDsKQBA0w7WCuPiZiheJaL 4MDe9hcH4rM3ybnRW7K2dLszWNhHVoYSFlZGYh+MGpuODeQKDS035+4H2rEWgg+iaOwqD7bg CQXwTZ1kSrm8NxIRVD3MBtzp9SZdUHLfmBl/tLVwDSZvHZhhvJHC6Lj6VL4jPXF5K2+Nn/Su CQmEBisOmwnXZhhu8ulAZ7S2tcl94DCo60ReheDoPBU8PR2TLg8rS5f9w6mLYarvQWL7cDtT d2eX3Z6TggfNINr/RTFrrAd7NHl5h3OnlXj7PQ1f0kfufduOeCQddJN4gsQfxo/qvWVB7PaE 1WTIggPmWS+Xxijk7xG6x9McTdmGhYaPZBpAxewK8ypl5+yubVsE9yOOhKMVo9DoVCjh5To5 aph7CQWfQsV7cd9PfSJjI2lXI0dhEXhQ7lRCFpf3V3mD6CyrhpcJpV6XVGjxJvGUale7+IOp sQIbPKUHpB2F+ZUPWds9yyVxGwDxD8WLqKKy0WLIjkkSsOb9UBNzgRyzrEC9lgQ/ABEBAAGJ Ah8EGAECAAkFAlT0m5MCGwwACgkQyjiNKEaHD4nU8hAAtt0xFJAy0sOWqSmyxTc7FUcX+pbD KVyPlpl6urKKMk1XtVMUPuae/+UwvIt0urk1mXi6DnrAN50TmQqvdjcPTQ6uoZ8zjgGeASZg jj0/bJGhgUr9U7oG7Hh2F8vzpOqZrdd65MRkxmc7bWj1k81tOU2woR/Gy8xLzi0k0KUa8ueB iYOcZcIGTcs9CssVwQjYaXRoeT65LJnTxYZif2pfNxfINFzCGw42s3EtZFteczClKcVSJ1+L +QUY/J24x0/ocQX/M1PwtZbB4c/2Pg/t5FS+s6UB1Ce08xsJDcwyOPIH6O3tccZuriHgvqKP yKz/Ble76+NFlTK1mpUlfM7PVhD5XzrDUEHWRTeTJSvJ8TIPL4uyfzhjHhlkCU0mw7Pscyxn DE8G0UYMEaNgaZap8dcGMYH/96EfE5s/nTX0M6MXV0yots7U2BDb4soLCxLOJz4tAFDtNFtA wLBhXRSvWhdBJZiig/9CG3dXmKfi2H+wdUCSvEFHRpgo7GK8/Kh3vGhgKmnnxhl8ACBaGy9n fxjSxjSO6rj4/MeenmlJw1yebzkX8ZmaSi8BHe+n6jTGEFNrbiOdWpJgc5yHIZZnwXaW54QT UhhSjDL1rV2B4F28w30jYmlRmm2RdN7iCZfbyP3dvFQTzQ4ySquuPkIGcOOHrvZzxbRjzMx1 Mwqu3GQ= Message-ID: Date: Tue, 7 Jan 2020 18:39:36 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.1.0 MIME-Version: 1.0 In-Reply-To: <1577287161-10321-3-git-send-email-matan@mellanox.com> Content-Language: en-US X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-MC-Unique: toujx8t6MYOVkaixSLbRCQ-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: quoted-printable Subject: Re: [dpdk-dev] [PATCH v1 2/3] doc: add vDPA feature table 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 12/25/19 4:19 PM, Matan Azrad wrote: > Add vDPA devices features table and explanation. >=20 > Any vDPA driver can add its own supported features by ading a new ini > file to the features directory in doc/guides/vdpadevs/features. >=20 > Signed-off-by: Matan Azrad > --- > doc/guides/conf.py | 5 +++ > doc/guides/vdpadevs/features/default.ini | 55 +++++++++++++++++++++++++= + > doc/guides/vdpadevs/features_overview.rst | 65 +++++++++++++++++++++++++= ++++++ > doc/guides/vdpadevs/index.rst | 1 + > 4 files changed, 126 insertions(+) > create mode 100644 doc/guides/vdpadevs/features/default.ini > create mode 100644 doc/guides/vdpadevs/features_overview.rst >=20 > diff --git a/doc/guides/conf.py b/doc/guides/conf.py > index 0892c06..c368fa5 100644 > --- a/doc/guides/conf.py > +++ b/doc/guides/conf.py > @@ -401,6 +401,11 @@ def setup(app): > 'Features', > 'Features availability in compression driver= s', > 'Feature') > + table_file =3D dirname(__file__) + '/vdpadevs/overview_feature_table= .txt' > + generate_overview_table(table_file, 1, > + 'Features', > + 'Features availability in vDPA drivers', > + 'Feature') > =20 > if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): > print('Upgrade sphinx to version >=3D 1.3.1 for ' > diff --git a/doc/guides/vdpadevs/features/default.ini b/doc/guides/vdpade= vs/features/default.ini > new file mode 100644 > index 0000000..a3e0bc7 > --- /dev/null > +++ b/doc/guides/vdpadevs/features/default.ini > @@ -0,0 +1,55 @@ > +; > +; Features of a default vDPA driver. > +; > +; This file defines the features that are valid for inclusion in > +; the other driver files and also the order that they appear in > +; the features table in the documentation. The feature description > +; string should not exceed feature_str_len defined in conf.py. > +; I think some entries below could be removed for vDPA. > +[Features] > +csum =3D > +guest csum =3D > +mac =3D > +gso =3D > +guest tso4 =3D > +guest tso6 =3D > +ecn =3D > +ufo =3D > +host tso4 =3D > +host tso6 =3D > +mrg rxbuf =3D > +ctrl vq =3D > +ctrl rx =3D > +any layout =3D > +guest announce =3D > +mq =3D > +version 1 =3D > +log all =3D > +protocol features =3D > +indirect desc =3D > +event idx =3D > +mtu =3D > +in_order =3D > +IOMMU platform =3D > +packed =3D > +proto mq =3D > +proto log shmfd =3D > +proto rarp =3D > +proto reply ack =3D > +proto slave req =3D > +proto crypto session =3D > +proto host notifier =3D > +proto pagefault =3D > +Multiprocess aware =3D > +BSD nic_uio =3D > +Linux UIO =3D E.g. UIO, which cannot be used since vDPA requires an IOMMU. > +Linux VFIO =3D > +Other kdrv =3D > +ARMv7 =3D > +ARMv8 =3D > +Power8 =3D > +x86-32 =3D > +x86-64 =3D > +Usage doc =3D > +Design doc =3D > +Perf doc =3D > \ No newline at end of file > diff --git a/doc/guides/vdpadevs/features_overview.rst b/doc/guides/vdpad= evs/features_overview.rst > new file mode 100644 > index 0000000..c7745b7 > --- /dev/null > +++ b/doc/guides/vdpadevs/features_overview.rst > @@ -0,0 +1,65 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright 2019 Mellanox Technologies, Ltd > + > +Overview of vDPA drivers features > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +This section explains the supported features that are listed in the tabl= e below. > + > + * csum - Device can handle packets with partial checksum. > + * guest csum - Guest can handle packets with partial checksum. > + * mac - Device has given MAC address. > + * gso - Device can handle packets with any GSO type. > + * guest tso4 - Guest can receive TSOv4. > + * guest tso6 - Guest can receive TSOv6. > + * ecn - Device can receive TSO with ECN. > + * ufo - Device can receive UFO. > + * host tso4 - Device can receive TSOv4. > + * host tso6 - Device can receive TSOv6. > + * mrg rxbuf - Guest can merge receive buffers. > + * ctrl vq - Control channel is available. > + * ctrl rx - Control channel RX mode support. > + * any layout - Device can handle any descriptor layout. > + * guest announce - Guest can send gratuitous packets. > + * mq - Device supports Receive Flow Steering. > + * version 1 - v1.0 compliant. > + * log all - Device can log all write descriptors (live migration). > + * protocol features - Protocol features negotiation support. > + * indirect desc - Indirect buffer descriptors support. > + * event idx - Support for avail_idx and used_idx fields. > + * mtu - Host can advise the guest with its maximum supported MTU. > + * in_order - Device can use descriptors in ring order. > + * IOMMU platform - Device support IOMMU addresses. > + * packed - Device support packed virtio queues. > + * proto mq - Support the number of queues query. > + * proto log shmfd - Guest support setting log base. > + * proto rarp - Host can broadcast a fake RARP after live migration. > + * proto reply ack - Host support requested operation status ack.=20 > + * proto slave req - Allow the slave to make requests to the master. > + * proto crypto session - Support crypto session creation. > + * proto host notifier - Host can register memory region based host not= ifiers. > + * proto pagefault - Slave expose page-fault FD for migration process. > + * Multiprocess aware - Driver can be used for primary-secondary proces= s model. > + * BSD nic_uio - BSD ``nic_uio`` module supported. > + * Linux UIO - Works with ``igb_uio`` kernel module. > + * Linux VFIO - Works with ``vfio-pci`` kernel module. > + * Other kdrv - Kernel module other than above ones supported. > + * ARMv7 - Support armv7 architecture. > + * ARMv8 - Support armv8a (64bit) architecture. > + * Power8 - Support PowerPC architecture. > + * x86-32 - Support 32bits x86 architecture. > + * x86-64 - Support 64bits x86 architecture. > + * Usage doc - Documentation describes usage, In ``doc/guides/vdpadevs/= ``. > + * Design doc - Documentation describes design. In ``doc/guides/vdpadev= s/``. > + * Perf doc - Documentation describes performance values, In ``doc/perf= /``. > + > + > + > +.. _table_vdpa_pmd_features: > + > +.. include:: overview_feature_table.txt > + > +.. Note:: > + > + Features marked with "P" are partially supported. Refer to the approp= riate > + driver guide in the following sections for details. > diff --git a/doc/guides/vdpadevs/index.rst b/doc/guides/vdpadevs/index.rs= t > index d69dc91..89e2b03 100644 > --- a/doc/guides/vdpadevs/index.rst > +++ b/doc/guides/vdpadevs/index.rst > @@ -11,3 +11,4 @@ which can be used from an application through vhost API= . > :maxdepth: 2 > :numbered: > =20 > + features_overview >=20