[dpdk-dev] [PATCH v5 1/4] doc: add skeleton for eventdevs feature matrices

[Jerin Jacob]

On Fri, Oct 22, 2021 at 1:18 PM <skori at marvell.com> wrote:
>
> From: Sunil Kumar Kori <skori at marvell.com>
>
> Patch adds skeleton for feature matrices for event dev
> and Rx/Tx adapters.
>
> Along with, .ini files are added for all supported PMDs.
>
> Signed-off-by: Sunil Kumar Kori <skori at marvell.com>


+  Tree maintainers and eventdev adapter maintainers

1) Please rebase to dpdk-next-eventdev
2) Please update devtools/check-doc-vs-code.sh
You can use search _CAP_ and != CAP_REQUIRES_ to detect the capability
change or so.
3) Update the .ini for all the eventdev drivers, not just Marvell ones.

>
>  # Maximum feature description string length
> -feature_str_len = 30
> +feature_str_len = 45

I hope this OK. I understand that without this it gives errors and
feature-length is not enough

> diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini
> new file mode 100644
> index 0000000000..d007d7a69e
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/default.ini
> @@ -0,0 +1,30 @@
> +;
> +; Features of a default eventdev 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.
> +;
> +[Features]
> +Event queue priority based scheduling =
> +Event priority based scheduling       =
> +Event device distributed scheduling   =
> +Event device non sequential mode      =
> +Event queue all types                 =
> +Burst mode enqueue/dequeue            =
> +Event port implicit release disable   =
> +Runtime event queue/port linking      =
> +Multi queue linking per port          =

1) Please sync the doc order with flag definition order in header file[1]
2) You can remove RTE_EVENT_DEV_CAP_REQUIRES_MAINT from the
list(*CAP_REQUIRES*) as this
is limitation.


[1]
RTE_EVENT_DEV_CAP_QUEUE_QOS
RTE_EVENT_DEV_CAP_EVENT_QOS
RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED
RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES
RTE_EVENT_DEV_CAP_BURST_MODE
RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE
RTE_EVENT_DEV_CAP_NONSEQ_MODE
RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK
RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT
RTE_EVENT_DEV_CAP_CARRY_FLOW_ID



> +
> +;
> +; Features of a default adapter.
> +;
> +[Adapter Features]

Please make this as [Eth Rx adapter Features]

> +Eth Rx/Tx adapter on internal port         =
You can remove Eth Rx/Tx adapter as new subject has [Eth Rx adapter]

> +Multiple event queues per ethdev           =
> +Override flow ID                           =

Missing RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR


Add new section for Tx adapter
and add
RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
RTE_EVENT_ETH_TX_ADAPTER_CAP_EVENT_VECTOR


Add new section for Crypto adapter

> +Crypto adapter new event enqueue           =
> +Crypto adapter forwarded event enqueue     =
> +Crypto queue pair mapping to event queue   =
> +Crypto adapter session data store/retrieve =


Add new section for timer adapter

> +Timer adapter support in H/W               =

Missing RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC