From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5CDD8A0032; Fri, 21 Oct 2022 11:43:18 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 461EA42BDE; Fri, 21 Oct 2022 11:43:18 +0200 (CEST) Received: from mail-qv1-f48.google.com (mail-qv1-f48.google.com [209.85.219.48]) by mails.dpdk.org (Postfix) with ESMTP id 19E5742BA4; Fri, 21 Oct 2022 11:43:17 +0200 (CEST) Received: by mail-qv1-f48.google.com with SMTP id f14so1471239qvo.3; Fri, 21 Oct 2022 02:43:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=zcGG8Nw/DGM58zGSmpccSYxIpYyE07VecPGsUyaGkYE=; b=n1xfUCaw5XsrW1K+Jih3hRkcDiXZWbhlrKM/bVyqFK6OXsMBOEL4bWF9ZW7+sVfdyK YMTjEZ0zVBSoZZb1ITvV9GtHSmaAnR7XRRoEEYPm+zmnql6tufwzHvuBUvgCQp5C1/6m fkgO4I+0MsK6tvC2K4nMIpjSp9bOlVIWBqiwM8lFaE5KQn2YOdhErBRbVHRZF1qPxmw9 FG8YbwFOSWc+fY4iHcYs+rkucDP1+YC4p86UsICBjwrIfLNtcveKg0BGnlm+hzGajEzc Iff20g4wLYs+kh7sI+0AGpILNijW4J0OTr/ZLDh4TKAEineyHFhgHoq0M36TwPKgrzUD 8XNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=zcGG8Nw/DGM58zGSmpccSYxIpYyE07VecPGsUyaGkYE=; b=KuIgpKQmIN6aUPQDluzrkid4PyALIdyFURJQVZqmqjJZ+3QyCv5NHGOtf8ARoyQuGw AvxvWdMvFA70R0rcqW3y/xHSkXDfZWygVTm+r4q3qcSNNJzsMT4f9rzX8Fn3uMDQ1oGw P44V9U2Xst3yUcPHDcoBLqpRj1PkkHKBHnAEu72w0sCFRBboRJZc0jeybIw2Ukd9qD3S IDQxk5ISAJ5BhYzBM4ljC6/9d+hkMt0gl8v/92lCpuLoGSAzKr8t+n5stbFFBCxxQ6J5 pXw+m0mIpdPhSvWnbLfisY63FnrA9hOYH3+iXCK7pBmB6HJHc9PZzEoV1CgNH6WYy3CD i4vw== X-Gm-Message-State: ACrzQf0gtFlK9SKvwUUeK67xWIzpvt55ISgCEaxshi2Nn3DIHptK6MKj L8l2ooUjEvNhCAn5kwA+xC2BtbTLFFOmt2c3znI= X-Google-Smtp-Source: AMsMyM5zUuSPD3qXluU8xZw40MlDEeCZpu84HqX4SL6qxTe+VPUKPZFrfgCSgOw95RnBFF8tctiXF+OiZOad+eKUJxI= X-Received: by 2002:ad4:5bc1:0:b0:4ad:34b2:d29c with SMTP id t1-20020ad45bc1000000b004ad34b2d29cmr15639671qvt.21.1666345396462; Fri, 21 Oct 2022 02:43:16 -0700 (PDT) MIME-Version: 1.0 References: <20221021081349.23296-1-mattias.ronnblom@ericsson.com> In-Reply-To: <20221021081349.23296-1-mattias.ronnblom@ericsson.com> From: Jerin Jacob Date: Fri, 21 Oct 2022 15:12:50 +0530 Message-ID: Subject: Re: [PATCH] eventdev: fix event vector documentation typo To: =?UTF-8?Q?Mattias_R=C3=B6nnblom?= Cc: Jerin Jacob , dev@dpdk.org, pbhagavatula@marvell.com, stable@dpdk.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Fri, Oct 21, 2022 at 1:48 PM Mattias R=C3=B6nnblom wrote: > > The Eventdev guide had got the type of the rte_event_vector struct's > u64s union field wrong. > > Fixes: 1cc44d409271 ("eventdev: introduce event vector capability") > Cc: pbhagavatula@marvell.com > Cc: stable@dpdk.org > > Signed-off-by: Mattias R=C3=B6nnblom Thanks, Squashed this change as doc: fix eventdev doc updates 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") Fixes: 1cc44d409271 ("eventdev: introduce event vector capability") Signed-off-by: Pavan Nikhilesh Signed-off-by: Mattias R=C3=B6nnblom Acked-by: Jerin Jacob 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 variab= le diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst index 1c3daf141d..0d45043271 100644 --- a/doc/guides/rel_notes/release_22_11.rst +++ b/doc/guides/rel_notes/release_22_11.rst @@ -478,6 +478,9 @@ API Changes * raw/ifgpa: The function ``rte_pmd_ifpga_get_pci_bus`` has been removed. +* eventdev: The function pointer definition ``eventdev_stop_flush_t`` is + renamed to ``rte_eventdev_stop_flush_t`` to avoid conflicts with applica= tion + symbols. ABI Changes ----------- @@ -520,6 +523,14 @@ 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 ne= w bit + field ``elem_offset:12`` the bits are taken from the bitfield ``rsvd:15`= `. + The element offset defines the offset into the vector array at + which valid elements start. + > --- > doc/guides/prog_guide/eventdev.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/e= ventdev.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 vari= able > -- > 2.34.1 >