DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Gregory Etelson <getelson@nvidia.com>
Cc: dev@dpdk.org, viacheslavo@nvidia.com, matan@nvidia.com,
	rasland@nvidia.com
Subject: Re: [PATCH] doc: add mlx5 PMD flex item documentation
Date: Tue, 16 Nov 2021 16:05:36 +0100	[thread overview]
Message-ID: <2173190.Li0gZhyFnm@thomas> (raw)
In-Reply-To: <20211116145139.837-1-getelson@nvidia.com>

16/11/2021 15:51, Gregory Etelson:
> Describe firmware configuration requirements.
> List mlx5 hardware and PMD limitations.

That's a pity we missed documentation when adding the feature.
Please a line "Fixes".

[...]
> +- Flex item API:
> +
> +  - Firmware configuration: ``FLEX_PARSER_PROFILE_ENABLE=4 PROG_PARSE_GRAPH=1``.

This is not a limitation and it is redundant with the last part of this patch.

> +  - Hardware support: BlueField-2.

I think it should be a space: BlueField 2

> +  - Flex item is supported on PF only.
> +  - Hardware limits ``header_length_mask_width`` up to 6 bits.
> +  - Firmware supports 8 global sample fields. Each flex item allocates non-shared sample fields from that pool.

Please break lines after a dot.

> +  - Supported flex item can have 1 IN arc - ``eth`` or ``udp`` and up to 2 OUT arcs - ``ipv4`` or ``ipv6``.

Is "arc" defined somewhere?

> +  - Flex item fields (next_header, next_protocol, samples) do not participate in RSS hash functions.

Fields should be enclosed with quotes.

> +  - In RTE flex item configuration, ``next_header.field_base`` value must be byte aligned (multiple of 8).

Please don't say "RTE".

[...]
> +- enable dynamic flex parser for RTE flex item::

Again, please stop using "RTE". I really wonder why I see this in a lot of patches.
In user doc, it doesn't make sense at all.
If you really want to distinguish API and driver implementation, use "API".

> +
> +   FLEX_PARSER_PROFILE_ENABLE=4
> +   PROG_PARSE_GRAPH=1




  reply	other threads:[~2021-11-16 15:05 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-16 14:51 Gregory Etelson
2021-11-16 15:05 ` Thomas Monjalon [this message]
2021-11-16 15:45 ` [PATCH v2] " Gregory Etelson
2021-11-22 10:42   ` Slava Ovsiienko
2021-11-23  9:29   ` [PATCH v3] " Gregory Etelson
2021-11-23 17:35     ` 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=2173190.Li0gZhyFnm@thomas \
    --to=thomas@monjalon.net \
    --cc=dev@dpdk.org \
    --cc=getelson@nvidia.com \
    --cc=matan@nvidia.com \
    --cc=rasland@nvidia.com \
    --cc=viacheslavo@nvidia.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).