From 08d3aa2ab01c5fa25c78fb9cc0899c55185c1718 Mon Sep 17 00:00:00 2001 From: Matias Elo Date: Tue, 6 Jun 2023 16:06:34 +0300 Subject: [PATCH] api: increment ODP API version to 1.41.1 Increment API version number to reflect the following changes: Backward compatible: - dma: add odp_dma_compl_user_area() function for reading user area pointer - dma: clarify that DMA session names don't need to be unique - event: odp_event_user_area() function for reading user area pointer - init: add odp_term_abnormal() function that can be used to abnormally terminate an ODP application after a non-recoverable error - packet: extend packet transmit completion with poll mode - packet: add odp_packet_free_ctrl_set() function for controlling packet output interface to not free a packet after transmitting it - packet: add odp_packet_free_ctrl() function for reading packet's free control option value - pool: relax odp_pool_stats() specification to allow implementations to have some delay until pool statistics are updated - pool: add new function odp_pool_stats_selected() for reading only selected pool statistic(s) - timer: split odp_timer_cancel() failure reason into timing related and other failures - timer: rename odp_timer_set_t to odp_timer_retval_t - timer: add odp_timer_sample_ticks() function that samples tick value of multiple timer pools simultaneously - timer: allow implementation to place the first timer as close as it can to one period when starting a periodic timer with first_tick set to 0 - timer: clarify that periodic timer base frequency uses fractional numbers the same way as timer tick info - timer: clarify that odp_timer_periodic_capability() call does not overwrite the base frequency value when 1 is returned - timer: clarify that some implementations may support only certain periodic timer base frequencies and those depend on source clock frequency Signed-off-by: Matias Elo Reviewed-by: Petri Savolainen --- CHANGELOG | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++ configure.ac | 2 +- 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/CHANGELOG b/CHANGELOG index f61f80a2c3..76c28bb664 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,68 @@ +== OpenDataPlane (1.41.1.0) + +=== Backward compatible API changes +==== DMA +* Add `odp_dma_compl_user_area()` function which returns pointer to the user +area configured with DMA completion event pool parameters. +* Clarify that DMA session names don't need to be unique. + +==== Event +* Add `odp_event_user_area()` function which returns a pointer to the user area +associated with the event. + +==== Init +* Add `odp_term_abnormal()` function that can be used to abnormally terminate +an ODP application after a non-recoverable error. Depending on the +implementation, this function may attempt to dump stack and other memory areas, +clean up and stop HW operations and/or perform other actions helpful in +postmortem analysis. + +==== Packet +* Extend packet transmit completion (`odp_packet_tx_compl_request()`) with poll +mode. When enabled, packet transmit completion status can be checked with +`odp_packet_tx_compl_done()`. +* Add `odp_packet_free_ctrl_set()` function for controlling packet output +interface to not free a packet after transmitting it. +* Add `odp_packet_free_ctrl()` function for reading packet's free control +option value. + +==== Pool +* Relax `odp_pool_stats()` specification to allow implementations to have some +delay until pool statistics are updated. +* Add new function `odp_pool_stats_selected()` for reading only selected pool +statistic(s). + +==== Timer +* Split `odp_timer_cancel()` failure reason into timing related and other +failures. +* Rename `odp_timer_set_t` to `odp_timer_retval_t` as it is used now for start, +restart, and cancel operations. `odp_timer_set_t` remains as a typedef for +backward compatibility. +* Add `odp_timer_sample_ticks()` function that samples tick value of multiple +timer pools simultaneously. +* Allow implementation to place the first timer as close as it can to one period +when starting a periodic timer with `first_tick` set to 0. +* Clarify that periodic timer base frequency uses fractional numbers the same +way as timer tick info (`odp_timer_tick_info_t`). Integer part specifies full +hertz and fractional part specifies parts of a hertz. +* Clarify that `odp_timer_periodic_capability()` call does not overwrite the +base frequency value when 1 is returned. +* Clarify that some implementations may support only certain periodic timer base +frequencies and those depend on source clock frequency. + +=== Performance Tests +==== bench_timer +* Add new test application for measuring call latency of small functions in the +timer API. + +==== dma_perf +* Refactor DMA test application to support multiple worker threads. The number +of in-flight transfers can be configured and workers will always try to keep +that many transfers active through single or per-worker DMA session. + +==== ipsecfwd +* Add support for running the application in process mode. + == OpenDataPlane (1.41.0.0) === Backward incompatible API changes diff --git a/configure.ac b/configure.ac index 576001acdc..ae9967c762 100644 --- a/configure.ac +++ b/configure.ac @@ -4,7 +4,7 @@ AC_PREREQ([2.5]) ########################################################################## m4_define([odp_version_generation], [1]) m4_define([odp_version_major], [41]) -m4_define([odp_version_minor], [0]) +m4_define([odp_version_minor], [1]) m4_define([odp_version_patch], [0]) m4_define([odp_version_api],