From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Andrew Rybchenko <arybchenko@solarflare.com>,
John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org, Olivier Matz <olivier.matz@6wind.com>
Subject: Re: [dpdk-dev] [PATCH v4] doc: document NIC features
Date: Thu, 20 Jul 2017 10:10:04 +0100 [thread overview]
Message-ID: <c44be27c-8c70-1ba8-3971-fe8ef73b0bc5@intel.com> (raw)
In-Reply-To: <0bb9d8dc-35a9-2284-a811-d6a45efc7570@solarflare.com>
On 7/8/2017 10:47 AM, Andrew Rybchenko wrote:
> On 07/07/2017 08:21 PM, Ferruh Yigit wrote:
>> Document NIC features, add more information about them and add more
>> implementation related support.
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> Signed-off-by: John McNamara <john.mcnamara@intel.com>
>
> Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>
>
> Few minor questions/notes below.
>
>> ---
>> Cc: Olivier Matz <olivier.matz@6wind.com>
>>
>> v4:
>> * Apply review comments from Andrew Rybchenko
>> * Add tags to the information, to clarify in, out, related data.
>>
>> v3:
>> * received updates from John, Thanks!
>>
>> v2:
>> * Add more details, mbuf and API fields
>> * Formatting added
>>
>> TODO:
>> - Not all features all fully documented, need help from community
>>
>> - Instead of having a new file, it would be nice to auto generate this
>> file from defaults.ini, and perhaps add extra information as comment to
>> that file.
>>
>> - Some features are implementing eth_dev_ops and some are updates in
>> Rx/Tx path. These features can be grouped together.
>>
>> - A link from overview file per feature would be nice.
>> ---
>> doc/guides/nics/overview.rst | 4 +
>> doc/guides/nics/overview_features.rst | 858 ++++++++++++++++++++++++++++++++++
>> 2 files changed, 862 insertions(+)
>> create mode 100644 doc/guides/nics/overview_features.rst
>
> <...>
>
>> +.. _nic_features_rss_hash:
>> +
>> +RSS hash
>> +--------
>> +
>> +Supports RSS hashing on RX.
>> +
>> +* **[uses] user config**: ``dev_conf.rxmode.mq_mode`` = ``ETH_MQ_RX_RSS_FLAG``.
>> +* **[provides] mbuf**: ``mbuf.ol_flags:PKT_RX_RSS_H()ASH``, ``mbuf.rss``.
>
> Is it indented that dev_info.flow_type_rss_offloads not mentioned here?
I will add it.
>
> <...>
>
>> +
>> +.. _nic_features_inner_l3_checksum:
>> +
>> +Inner L3 checksum
>> +-----------------
>> +
>> +Supports inner packet L3 checksum.
>> +
>> +
>> +.. _nic_features_inner_l4_checksum:
>> +
>> +Inner L4 checksum
>> +-----------------
>> +
>> +Supports inner packet L4 checksum.
>> +
>
> As I understand outer checksum (PKT_RX_EIP_CKSUM_BAD for Rx) and
> IPv4/IPv6 flags and
> offload capabilities should be mentioned here. If ourter flags are set,
> it means that usual checksum
> flags corresponds to inner packet.
I am not sure about these two, that is why I tend to left empty for now,
will update later.
>
> <...>
>
>> +
>> +.. _nic_features_rx_descriptor_status:
>> +
>> +Rx descriptor status
>> +--------------------
>> +
>> +Supports check the status of a Rx descriptor. When ``rx_descriptor_status`` is
>> +used, status can be "Available", "Done" or "Unavailable". When
>> +``rx_descriptor_done`` is used, status can be "DD bit is set" or "DD bit is
>> +not set".
>> +
>> +* **[implements] eth_dev_ops**: ``rx_descriptor_status``.
>> +* **[related] API**: ``rte_eth_rx_descriptor_status()``.
>> +* **[implements] eth_dev_ops**: ``rx_descriptor_done``.
>> +* **[related] API**: ``rte_eth_rx_descriptor_done()``.
>
> I'm not sure if _done API should be mentioned here. If yes, may be
> status of the _done
> API should be highlighted (as far as I remember it was ideas to remove it).
Both looks like valid APIs right now, there is no deprecation note
(__rte_deprecated) on _done API.
Description of feature briefly mentions status values.
>
> <...>
>
>> +
>> +.. _nic_features_bsd_nic_uio:
>> +
>> +BSD nic_uio
>> +-----------
>> +
>> +BSD ``nic_uio`` module supported.
>> +
>> +
>> +.. _nic_features_linux_uio:
>> +
>> +Linux UIO
>> +---------
>> +
>> +Works with ``igb_uio`` kernel module.
>> +
>> +
>> +.. _nic_features_linux_vfio:
>> +
>> +Linux VFIO
>> +----------
>> +
>> +Works with ``vfio-pci`` kernel module.
>
> Should we mention that PMD provides RTE_PMD_REGISTER_KMOD_DEP with
> corresponding kernel module listed.
Agreed, good to mention about it.
I will send a new version.
>
> <...>
>
next prev parent reply other threads:[~2017-07-20 9:10 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-15 16:37 [dpdk-dev] [RFC] " Ferruh Yigit
2017-06-21 13:25 ` [dpdk-dev] [PATCH] " Ferruh Yigit
2017-06-22 19:02 ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
2017-07-02 20:20 ` Mcnamara, John
2017-07-05 13:20 ` [dpdk-dev] [PATCH v3] " Ferruh Yigit
2017-07-05 16:03 ` Mcnamara, John
2017-07-07 10:55 ` Andrew Rybchenko
2017-07-07 13:37 ` Ferruh Yigit
2017-07-07 13:53 ` Thomas Monjalon
2017-07-07 13:57 ` Ferruh Yigit
2017-07-07 14:02 ` Thomas Monjalon
2017-07-07 14:13 ` Ferruh Yigit
2017-07-07 14:20 ` Wiles, Keith
2017-07-07 20:37 ` Thomas Monjalon
2017-07-07 23:54 ` Wiles, Keith
2017-07-07 15:06 ` Ferruh Yigit
2017-07-07 15:38 ` Andrew Rybchenko
2017-07-07 17:21 ` [dpdk-dev] [PATCH v4] " Ferruh Yigit
2017-07-08 9:47 ` Andrew Rybchenko
2017-07-20 9:10 ` Ferruh Yigit [this message]
2017-07-20 9:23 ` [dpdk-dev] [PATCH v5] " Ferruh Yigit
2017-07-26 5:08 ` Shreyansh Jain
2017-08-01 10:15 ` Ferruh Yigit
2017-08-01 15:23 ` [dpdk-dev] [PATCH v6] " Ferruh Yigit
2017-08-03 8:56 ` Shreyansh Jain
2017-08-03 8:57 ` Shreyansh Jain
2017-08-03 10:42 ` Mcnamara, John
2017-08-03 22:57 ` Thomas Monjalon
2017-08-04 8:56 ` Ferruh Yigit
2017-08-04 9:32 ` Thomas Monjalon
2017-08-04 10:04 ` Ferruh Yigit
2017-08-04 10:10 ` Thomas Monjalon
2017-08-04 11:11 ` Mcnamara, John
2017-08-04 11:40 ` Ferruh Yigit
2017-08-04 13:06 ` [dpdk-dev] [PATCH v7] " Ferruh Yigit
2017-08-04 13:34 ` Mcnamara, John
2017-08-05 9:34 ` Thomas Monjalon
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=c44be27c-8c70-1ba8-3971-fe8ef73b0bc5@intel.com \
--to=ferruh.yigit@intel.com \
--cc=arybchenko@solarflare.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=olivier.matz@6wind.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).