From: "Mattias Rönnblom" <mattias.ronnblom@ericsson.com>
To: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Cc: "Jerin Jacob" <jerinj@marvell.com>,
dev@dpdk.org, stable@dpdk.org,
"Mattias Rönnblom" <mattias.ronnblom@ericsson.com>
Subject: [PATCH v2] doc: fix minor issues in the event timer adapter guide
Date: Tue, 1 Nov 2022 10:33:40 +0100 [thread overview]
Message-ID: <20221101093340.41134-1-mattias.ronnblom@ericsson.com> (raw)
In-Reply-To: <20221101074528.40898-1-mattias.ronnblom@ericsson.com>
In the example:
* Properly initialize the socket id field.
* Remove comments redundant and/or not consistent with the code. 180
seconds is not 2 minutes.
* Remove redundant pointer initialization.
* Access max_tmo_ns with the appropriate name.
In both the example and in one instance in the body text, the flags
field of the conf struct was erroneously referred to as
timer_adapter_flags.
v2: max_tmo_nsec -> max_tmo_ns fix.
Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
Cc: erik.g.carrillo@intel.com
Cc: stable@dpdk.org
Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
---
doc/guides/prog_guide/event_timer_adapter.rst | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 7547059a05..4cba5f1cd1 100644
--- a/doc/guides/prog_guide/event_timer_adapter.rst
+++ b/doc/guides/prog_guide/event_timer_adapter.rst
@@ -107,18 +107,19 @@ to ``rte_event_timer_adapter_create()``.
.. code-block:: c
- #define NSECPERSEC 1E9 // No of ns in 1 sec
+ #define NSECPERSEC 1E9
const struct rte_event_timer_adapter_conf adapter_config = {
.event_dev_id = event_dev_id,
.timer_adapter_id = 0,
+ .socket_id = rte_socket_id(),
.clk_src = RTE_EVENT_TIMER_ADAPTER_CPU_CLK,
- .timer_tick_ns = NSECPERSEC / 10, // 100 milliseconds
- .max_tmo_nsec = 180 * NSECPERSEC // 2 minutes
+ .timer_tick_ns = NSECPERSEC / 10,
+ .max_tmo_ns = 180 * NSECPERSEC,
.nb_timers = 40000,
- .timer_adapter_flags = 0,
+ .flags = 0,
};
- struct rte_event_timer_adapter *adapter = NULL;
+ struct rte_event_timer_adapter *adapter;
adapter = rte_event_timer_adapter_create(&adapter_config);
if (adapter == NULL) { ... };
@@ -145,7 +146,7 @@ to support timers of the respective type. A periodic timer expires at a fixed
time interval repeatedly till it is cancelled. A non-periodic timer expires only
once. The periodic capability flag, ``RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC``,
can be set for implementations that support periodic mode if desired. To
-configure an adapter in periodic mode, ``timer_adapter_flags`` of
+configure an adapter in periodic mode, ``flags`` of
``rte_event_timer_adapter_conf`` is set to include the periodic flag
``RTE_EVENT_TIMER_ADAPTER_F_PERIODIC``. Maximum timeout (``max_tmo_nsec``) does
not apply to periodic mode.
--
2.34.1
next prev parent reply other threads:[~2022-11-01 9:37 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-01 7:45 [PATCH] doc: fix various " Mattias Rönnblom
2022-11-01 9:33 ` Mattias Rönnblom [this message]
2022-11-01 22:20 ` [PATCH v2] doc: fix " Carrillo, Erik G
2022-11-04 6:52 ` [PATCH v3] " Mattias Rönnblom
2022-11-04 10:58 ` Jerin Jacob
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221101093340.41134-1-mattias.ronnblom@ericsson.com \
--to=mattias.ronnblom@ericsson.com \
--cc=dev@dpdk.org \
--cc=erik.g.carrillo@intel.com \
--cc=jerinj@marvell.com \
--cc=stable@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).