diff options
author | Matias Elo <matias.elo@nokia.com> | 2022-01-31 17:22:23 +0200 |
---|---|---|
committer | Petri Savolainen <petri.savolainen@nokia.com> | 2022-02-01 17:00:11 +0200 |
commit | 12f6bb62fc841962395a9949f2c7de7a74828e67 (patch) | |
tree | 8d151fc608201f16d242b74bca8c10dc698d912a | |
parent | faa88ba6dd34e2dd22d019ac97eda307a5107035 (diff) |
api: increment ODP API version to 1.34.0.0v1.34.0.0
Increment API version number to reflect the following changes:
Backward incompatible:
- crypto: specify that the hash result field is not cleared in hash
generation in encode sessions
- crypto: specify that the hash result field is left to an undefined value
after verification
- crypto: add a new session parameter
odp_crypto_session_param_t.hash_result_in_auth_range to indicate if the
hash result location may overlap the authenticated range
- crypto: define new fields for cipher and auth IV lengths in the session
parameter structure odp_crypto_session_param_t. Deprecate the old fields
for cipher and auth IV lengths.
- crypto: deprecate the mechanism of configuring initialization vectors in
sessions since reusing the same IV with the same key is almost always
wrong. Require that IV is provided for each packet in the operation
parameters.
- tm: add capabilities to odp_tm_level_capabilities_t for platforms to
express shaper rate and burst min and max limits
- tm: remove support for min and max shaper rate via platform defined
macros ODP_TM_MIN_SHAPER_BW and ODP_TM_MAX_SHAPER_BW
Backward compatible:
- crypto: clarify that in case of AEAD algorithms the
odp_crypto_op_param_t.auth_range parameter is not used, except with
AES-GMAC.
- crypto: clarify ODP_AUTH_ALG_AES_GMAC API text to not sound as if ODP did
not use AAD as defined in the GMAC algorithm specification
- crypto: make the names of session creation errors
(odp_crypto_ses_create_err_t) a bit shorter but retain the old names for
backward compatibility
- crypto: add crypto session creation error codes
(odp_crypto_ses_create_err_t) for cases where the requested combination
of algorithms, order of algorithms or other combination of creation
parameters is not supported.
- random: explicitly state that the same series of odp_random_test_data()
calls is required to generate the same data
- tm: clarify that peak rate and peak burst are ignored when dual rate is
set to false in odp_tm_shaper_params_t, indicating that the single rate
is commit rate.
- tm: define the default values for many parameters to be set by various
init functions
ABI:
- Removed mips64 architecture support. MIPS devices may still use ODP by
utilizing the generic default architecture.
Signed-off-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
-rw-r--r-- | CHANGELOG | 54 | ||||
-rw-r--r-- | configure.ac | 2 |
2 files changed, 55 insertions, 1 deletions
@@ -1,3 +1,57 @@ +== OpenDataPlane (1.34.0.0) + +=== Backward incompatible API changes +==== Crypto +* Specify that hash result field is not cleared in hash generation in encode +sessions. Applications can do the clearing if needed if the hash result lies +within the authenticated range. +* Specify that the hash result field is left to an undefined value after +verification. +* Add a new session parameter +`odp_crypto_session_param_t.hash_result_in_auth_range` to indicate if the hash +result location may overlap the authenticated range. Leaving the flag unset may +enable optimizations in the implementation. +* Define new fields for cipher and auth IV lengths in the session parameter +structure `odp_crypto_session_param_t`. Deprecated the old fields for cipher and +auth IV lengths. +* Deprecate the mechanism of configuring initialization vectors in sessions +since reusing the same IV with the same key is almost always wrong. Require that +IV is provided for each packet in the operation parameters. + +==== Traffic Manager +* Add capabilities to `odp_tm_level_capabilities_t` for platforms to express +shaper rate and burst min and max limits. +* Remove support for min and max shaper rate via platform defined macros +`ODP_TM_MIN_SHAPER_BW` and `ODP_TM_MAX_SHAPER_BW`. Min and Max shaper bandwidths +can be read from TM per level capabilities (`odp_tm_level_capabilities_t`). + +=== Backward compatible API changes +==== Crypto +* Clarify that in case of AEAD algorithms the `odp_crypto_op_param_t.auth_range` +parameter is not used, except with AES-GMAC. +* Clarify `ODP_AUTH_ALG_AES_GMAC` API text to not sound as if ODP did not use +AAD as defined in the GMAC algorithm specification. +* Make the names of session creation errors (`odp_crypto_ses_create_err_t`) a +bit shorter but retain the old names for backward compatibility. +* Add crypto session creation error codes (`odp_crypto_ses_create_err_t`) for +cases where the requested combination of algorithms, order of algorithms or +other combination of creation parameters is not supported. + +==== Random +* Explicitly state that the same series of `odp_random_test_data()` calls is +required to generate the same data. + +==== Traffic Manager +* Clarify that peak rate and peak burst are ignored when dual rate is set to +false in `odp_tm_shaper_params_t`, indicating that the single rate is commit +rate. +* Define the default values for many parameters to be set by various init +functions. + +=== ABI changes +* Removed mips64 architecture support. MIPS devices may still use ODP by +utilizing the generic default architecture. + == OpenDataPlane (1.33.0.0) === Backward incompatible API changes diff --git a/configure.ac b/configure.ac index 2df18424e..8e25a7159 100644 --- a/configure.ac +++ b/configure.ac @@ -3,7 +3,7 @@ AC_PREREQ([2.5]) # ODP API version ########################################################################## m4_define([odpapi_generation_version], [1]) -m4_define([odpapi_major_version], [33]) +m4_define([odpapi_major_version], [34]) m4_define([odpapi_minor_version], [0]) m4_define([odpapi_point_version], [0]) m4_define([odpapi_version], |