[PATCH] doc: fix various minor issues in the event timer adapter guide

[PATCH] doc: fix various minor issues in the event timer adapter guide

[Mattias Rönnblom]

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.

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.

Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
Cc: erik.g.carrillo@intel.com

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..b28375855e 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_nsec = 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

[PATCH v2] doc: fix minor issues in the event timer adapter guide

[Mattias Rönnblom]

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

RE: [PATCH v2] doc: fix minor issues in the event timer adapter guide

[Carrillo, Erik G]

> -----Original Message-----
> From: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
> Sent: Tuesday, November 1, 2022 4:34 AM
> To: Carrillo, Erik G <erik.g.carrillo@intel.com>
> Cc: Jerin Jacob <jerinj@marvell.com>; dev@dpdk.org; stable@dpdk.org;
> mattias.ronnblom <mattias.ronnblom@ericsson.com>
> Subject: [PATCH v2] doc: fix minor issues in the event timer adapter guide
> 
> 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.

Thanks for the corrections.  It looks like there's one more instance of the incorrect "max_tmo_nsec" string above.  With that last update:

Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>

> --
> 2.34.1

[PATCH v3] doc: fix minor issues in the event timer adapter guide

[Mattias Rönnblom]

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.

In both the example and text, the flags field of the conf struct was
erroneously referred to as timer_adapter_flags and the max_tmo_ns
field as max_tmo_nsec.

v2: max_tmo_nsec -> max_tmo_ns fix.
v3: Another 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

Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>
---
 doc/guides/prog_guide/event_timer_adapter.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 7547059a05..d7307a29bb 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,9 +146,9 @@ 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
+``RTE_EVENT_TIMER_ADAPTER_F_PERIODIC``. Maximum timeout (``max_tmo_ns``) does
 not apply to periodic mode.
 
 Retrieve Event Timer Adapter Contextual Information
-- 
2.34.1

Re: [PATCH v3] doc: fix minor issues in the event timer adapter guide

[Jerin Jacob]

On Fri, Nov 4, 2022 at 12:26 PM Mattias Rönnblom
<mattias.ronnblom@ericsson.com> wrote:
>
> 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.
>
> In both the example and text, the flags field of the conf struct was
> erroneously referred to as timer_adapter_flags and the max_tmo_ns
> field as max_tmo_nsec.
>
> v2: max_tmo_nsec -> max_tmo_ns fix.
> v3: Another 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
>
> Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> Signed-off-by: Mattias Rönnblom <mattias.ronnblom@ericsson.com>


Applied to dpdk-next-net-eventdev/for-main. Thanks


> ---
>  doc/guides/prog_guide/event_timer_adapter.rst | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
>
> diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
> index 7547059a05..d7307a29bb 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,9 +146,9 @@ 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
> +``RTE_EVENT_TIMER_ADAPTER_F_PERIODIC``. Maximum timeout (``max_tmo_ns``) does
>  not apply to periodic mode.
>
>  Retrieve Event Timer Adapter Contextual Information
> --
> 2.34.1
>