[PATCH v3 2/9] eventdev: clarify all-types flag documentation

[Mattias Rönnblom]

On 2023-12-12 12:32, Bruce Richardson wrote:
> Rather than requiring that any device advertising the
> RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES flag support all of atomic, ordered
> and parallel scheduling, we can redefine the field so that it basically
> means that you don't need to specify the queue scheduling type at config
> time. Instead all types of supported events can be sent to all queues.
> 
> Suggested-by: Mattias Rönnblom <hofors at lysator.liu.se>

Please use <mattias.ronnblom at ericsson.com>.

> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> Acked-by: Jerin Jacob <jerinj at marvell.com>
> ---
>   lib/eventdev/rte_eventdev.h | 17 ++++++++++++++---
>   1 file changed, 14 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
> index d48957362c..35865f017f 100644
> --- a/lib/eventdev/rte_eventdev.h
> +++ b/lib/eventdev/rte_eventdev.h
> @@ -250,11 +250,22 @@ struct rte_event;
>    * @see rte_event_dequeue_burst()
>    */
>   #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES     (1ULL << 3)
> -/**< Event device is capable of enqueuing events of any type to any queue.
> +/**< Event device is capable of accepting enqueued events, of any type
> + * advertised as supported by the device, to all destination queues.
> + *
> + * When this capability is set, the "schedule_type" field of the
> + * rte_event_queue_conf structure is ignored when a queue is being configured.
> + * Instead the the "sched_type" field of each event enqueued is used to

"The the" -> "the".

> + * select the scheduling to be performed on that event.
> + *
>    * If this capability is not set, the queue only supports events of the
> - *  *RTE_SCHED_TYPE_* type that it was created with.
> + *  *RTE_SCHED_TYPE_* type specified in the rte_event_queue_conf structure
> + *  at time of configuration.
>    *
> - * @see RTE_SCHED_TYPE_* values
> + * @see RTE_SCHED_TYPE_ATOMIC
> + * @see RTE_SCHED_TYPE_ORDERED
> + * @see RTE_SCHED_TYPE_PARALLEL
> + * @see rte_event_queue_conf.schedule_type
>    */
>   #define RTE_EVENT_DEV_CAP_BURST_MODE          (1ULL << 4)
>   /**< Event device is capable of operating in burst mode for enqueue(forward,