[dpdk-dev,v7,7/7] doc: add event timer adapter documentation
Checks
Commit Message
Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
---
MAINTAINERS | 7 +++++++
doc/api/doxy-api-index.md | 32 +++-----------------------------
doc/guides/rel_notes/release_18_05.rst | 5 +++++
3 files changed, 15 insertions(+), 29 deletions(-)
Comments
-----Original Message-----
> Date: Thu, 8 Mar 2018 15:54:06 -0600
> From: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> To: pbhagavatula@caviumnetworks.com
> CC: dev@dpdk.org, jerin.jacob@caviumnetworks.com, nipun.gupta@nxp.com,
> hemant.agrawal@nxp.com
> Subject: [PATCH v7 7/7] doc: add event timer adapter documentation
> X-Mailer: git-send-email 1.7.10
>
> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> ---
> MAINTAINERS | 7 +++++++
> doc/api/doxy-api-index.md | 32 +++-----------------------------
> doc/guides/rel_notes/release_18_05.rst | 5 +++++
> 3 files changed, 15 insertions(+), 29 deletions(-)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index a646ca3..abebf6d 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -317,6 +317,13 @@ F: lib/librte_eventdev/*eth_rx_adapter*
> F: test/test/test_event_eth_rx_adapter.c
> F: doc/guides/prog_guide/event_ethernet_rx_adapter.rst
>
> +Eventdev Timer Adapter API - EXPERIMENTAL
> +M: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> +T: git://dpdk.org/next/dpdk-next-eventdev
> +F: lib/librte_eventdev/*timer_adapter*
> +F: test/test/test_event_timer_adapter.c
> +F: doc/guides/prog_guide/event_timer_adapter.rst
> +
> The public API headers are grouped by topics:
> @@ -47,6 +20,7 @@ The public API headers are grouped by topics:
> [security] (@ref rte_security.h),
> [eventdev] (@ref rte_eventdev.h),
> [event_eth_rx_adapter] (@ref rte_event_eth_rx_adapter.h),
> + [event_timer_adapter] (@ref rte_event_timer_adapter.h),
> [rawdev] (@ref rte_rawdev.h),
> [metrics] (@ref rte_metrics.h),
> [bitrate] (@ref rte_bitrate.h),
> diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
> index 3923dc2..2b93a1e 100644
> --- a/doc/guides/rel_notes/release_18_05.rst
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -41,6 +41,11 @@ New Features
> Also, make sure to start the actual text at the margin.
> =========================================================
>
> +* **Added the Event Timer Adapter Library.**
> +
> + The Event Timer Adapter Library extends the event-based model by introducing
> + APIs that allow applications to generate timer expiry events that are
How about ?
API that allow applications to arm/cancel the timer expiry events that are
In any case,
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> + scheduled by an event device along with existing types of events.
>
> API Changes
> -----------
> --
> 2.6.4
>
@@ -317,6 +317,13 @@ F: lib/librte_eventdev/*eth_rx_adapter*
F: test/test/test_event_eth_rx_adapter.c
F: doc/guides/prog_guide/event_ethernet_rx_adapter.rst
+Eventdev Timer Adapter API - EXPERIMENTAL
+M: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
+T: git://dpdk.org/next/dpdk-next-eventdev
+F: lib/librte_eventdev/*timer_adapter*
+F: test/test/test_event_timer_adapter.c
+F: doc/guides/prog_guide/event_timer_adapter.rst
+
Raw device API - EXPERIMENTAL
M: Shreyansh Jain <shreyansh.jain@nxp.com>
M: Hemant Agrawal <hemant.agrawal@nxp.com>
@@ -2,35 +2,8 @@ API {#index}
===
<!--
- BSD LICENSE
-
- Copyright 2013-2017 6WIND S.A.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in
- the documentation and/or other materials provided with the
- distribution.
- * Neither the name of 6WIND S.A. nor the names of its
- contributors may be used to endorse or promote products derived
- from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2013-2017 6WIND S.A.
-->
The public API headers are grouped by topics:
@@ -47,6 +20,7 @@ The public API headers are grouped by topics:
[security] (@ref rte_security.h),
[eventdev] (@ref rte_eventdev.h),
[event_eth_rx_adapter] (@ref rte_event_eth_rx_adapter.h),
+ [event_timer_adapter] (@ref rte_event_timer_adapter.h),
[rawdev] (@ref rte_rawdev.h),
[metrics] (@ref rte_metrics.h),
[bitrate] (@ref rte_bitrate.h),
@@ -41,6 +41,11 @@ New Features
Also, make sure to start the actual text at the margin.
=========================================================
+* **Added the Event Timer Adapter Library.**
+
+ The Event Timer Adapter Library extends the event-based model by introducing
+ APIs that allow applications to generate timer expiry events that are
+ scheduled by an event device along with existing types of events.
API Changes
-----------