doc: fix event timer adapter guide
Checks
Commit Message
From: Pavan Nikhilesh <pbhagavatula@marvell.com>
Remove incorrect spec definition from programmers guide, it is
applications responsibility to set ev.event_ptr to a valid value.
Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
doc/guides/prog_guide/event_timer_adapter.rst | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
Comments
> -----Original Message-----
> From: pbhagavatula@marvell.com <pbhagavatula@marvell.com>
> Sent: Friday, April 7, 2023 3:14 AM
> To: jerinj@marvell.com; Carrillo, Erik G <erik.g.carrillo@intel.com>
> Cc: dev@dpdk.org; Pavan Nikhilesh <pbhagavatula@marvell.com>
> Subject: [PATCH] doc: fix event timer adapter guide
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
>
> Remove incorrect spec definition from programmers guide, it is applications
> responsibility to set ev.event_ptr to a valid value.
>
> Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
On Thu, Apr 13, 2023 at 1:32 AM Carrillo, Erik G
<erik.g.carrillo@intel.com> wrote:
>
> > -----Original Message-----
> > From: pbhagavatula@marvell.com <pbhagavatula@marvell.com>
> > Sent: Friday, April 7, 2023 3:14 AM
> > To: jerinj@marvell.com; Carrillo, Erik G <erik.g.carrillo@intel.com>
> > Cc: dev@dpdk.org; Pavan Nikhilesh <pbhagavatula@marvell.com>
> > Subject: [PATCH] doc: fix event timer adapter guide
> >
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > Remove incorrect spec definition from programmers guide, it is applications
> > responsibility to set ev.event_ptr to a valid value.
> >
> > Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Applied to dpdk-next-net-eventdev/for-main. Thanks
@@ -247,9 +247,7 @@ Note that it is necessary to initialize the event timer state to
RTE_EVENT_TIMER_NOT_ARMED. Also note that we have saved a pointer to the
``conn`` object in the timer's event payload. This will allow us to locate
the connection object again once we dequeue the timer expiry event from the
-event device later. As a convenience, the application may specify no value for
-ev.event_ptr, and the adapter will by default set it to point at the event
-timer itself.
+event device later.
Now we can arm the event timer with ``rte_event_timer_arm_burst()``: