From 922e71b52dac5361f6393bf78ec87e6d9a65fb4c Mon Sep 17 00:00:00 2001 From: Pavan Nikhilesh Date: Thu, 13 Oct 2022 14:45:28 +0530 Subject: [PATCH] doc: fix eventdev guide and release notes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixed release notes for changes made in eventdev library. Also updated the eventdev guide had got the type of the rte_event_vector struct's u64s union field wrong. Fixes: 5fa63911e43b ("eventdev: replace padding type in event vector") Fixes: 0fbb55efa542 ("eventdev: add element offset to event vector") Fixes: d986276f9b72 ("eventdev: add prefix to public symbol") Signed-off-by: Pavan Nikhilesh Signed-off-by: Mattias Rönnblom Acked-by: Jerin Jacob --- doc/guides/prog_guide/eventdev.rst | 2 +- doc/guides/rel_notes/release_22_11.rst | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eventdev.rst index 8c13c5832c..2c83176846 100644 --- a/doc/guides/prog_guide/eventdev.rst +++ b/doc/guides/prog_guide/eventdev.rst @@ -85,7 +85,7 @@ flexibility in what the actual vector is. * ``struct rte_mbuf *mbufs[0]`` - An array of mbufs. * ``void *ptrs[0]`` - An array of pointers. -* ``uint64_t *u64s[0]`` - An array of uint64_t elements. +* ``uint64_t u64s[0]`` - An array of uint64_t elements. The size of the event vector is related to the total number of elements it is configured to hold, this is achieved by making `rte_event_vector` a variable diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst index 2da8bc9661..ad52872d49 100644 --- a/doc/guides/rel_notes/release_22_11.rst +++ b/doc/guides/rel_notes/release_22_11.rst @@ -441,6 +441,10 @@ API Changes Event will be one of the configuration fields, together with additional vector parameters. +* eventdev: The function pointer definition ``eventdev_stop_flush_t`` + is renamed to ``rte_eventdev_stop_flush_t`` + to avoid conflicts with application symbols. + * metrics: Updated ``rte_metrics_init`` so it returns an error code instead of calling ``rte_exit``. @@ -496,6 +500,12 @@ ABI Changes * eventdev: Added ``weight`` and ``affinity`` fields to ``rte_event_queue_conf`` structure. +* eventdev: The field ``*u64s`` in the structure ``rte_event_vector`` is replaced + with ``u64s`` as the field is supposed to hold array of uint64_t values. + +* eventdev: The structure ``rte_event_vector`` was updated to include a new bit + field ``elem_offset:12``. The bits are taken from the bitfield ``rsvd:15``. + Known Issues ------------