aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/spec
AgeCommit message (Collapse)Author
2022-04-13api: cls: change capability types to uint32_tPetri Savolainen
Changed type of max_pmr_terms, available_pmr_terms, max_cos and max_hash_queues capabilities from 'unsigned int' to uint32_t. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-04-13api: pktio: change odp_pktin_recv_mq_tmo() params to uint32_tPetri Savolainen
Changed type of 'num_q' and 'from' parameters from 'unsigned int' to uint32_t. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-04-13api: pktio: change number of queues type to uint32_tPetri Savolainen
Changed type of number of queues parameters and capabilities from 'unsigned int' to uint32_t. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-04-13api: pool: change type of max_pools to uint32_tPetri Savolainen
Changed type of max_pools capability from 'unsigned int' to uint32_t. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-04-13api: shm: change type of max_blocks to uint32_tPetri Savolainen
Changed type of max_blocks capability from 'unsigned int' to uint32_t. In practice, those types have the same properties, but uint32_t is well-defined where as 'unsigned int' definition as somewhat ambiguous. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-04-13api: crypto: deprecate odp_crypto_operation()Janne Peltonen
Depracate odp_crypto_operation() and the associated data structures and the completion event. The odp_crypto_operation() function is a bit problematic since it can be synchronous or asynchronous on per-packet basis without application having control on it. Uncontrolled sync versus async behaviour can have adverse effects on packet ordering and application design in general. The function is also somewhat redundant with the newer odp_crypto_op() and odp_crypto_op_enq() functions that provide explicit control on the crypto operation completion behavior. Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Anoob Joseph <anoobj@marvell.com>
2022-04-13api: tm: clean odp_tm_queue_create() documentationMatias Elo
Clean up odp_tm_queue_create() documentation by moving parameter specific documentation into odp_tm_queue_params_t spec. Removed the note that allowed implementations to convert byte threshold limit to packets as there are now separate capabilities for byte and packet mode thresholds. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-04-13api: tm: split tm node threshold capability into byte and packet modesMatias Elo
Split odp_tm_level_capabilities_t.tm_node_threshold capability. This enables an implementation to support only byte or packet mode, and they don't have to be supported simultaneously. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-04-13api: tm: split tm queue threshold capability into byte and packet modesMatias Elo
Split odp_tm_capabilities_t.tm_queue_threshold capability. This enables an implementation to support only byte or packet mode, and they don't have to be supported simultaneously. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-04-13api: tm: remove question marksMatias Elo
Remove question marks from the API text. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-04-13api: tm: remove unused odp_tm_shaper_color_t enumMatias Elo
Remove unused TM shaper color enum odp_tm_shaper_color_t and ODP_NUM_SHAPER_COLORS define, and make them implementation internal. No other APIs were using these types. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-04-13api: tm: remove references to platform specific additionsMatias Elo
Remove references to vendor specific additions from the TM API documentation. Documentations of odp_tm_*_params_init() functions have been cleaned. No functional API changes. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-04-13api: cls: add cos specific statistics countersJere Leppänen
Add CoS specific statistics counters (odp_cls_cos_stats_t) and matching capabilities (in odp_cls_stats_capability_t). Statistics counters can be read with odp_cls_cos_stats(). Add capability for the maximum number of CoSes that can have statistics enabled at the same time. Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Kiran Kumar K <kirankumark@marvell.com>
2022-04-13api: cls: add action to cos parametersJere Leppänen
Add an action parameter to CoS parameters (odp_cls_cos_param_t). Action may be to enqueue or drop the packet classified to the CoS. Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Kiran Kumar K <kirankumark@marvell.com>
2022-03-18api: event: split header filePetri Savolainen
Split event.h API file into separate files for types and functions. This avoids circular dependency between event and packet headers. While updating dependencies from event.h to event_types.h, simplify API header file dependencies: - API files depend mostly on type headers of other APIs - move header includes from include/odp/api header files to spec files Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>
2022-03-03api: random: split random types into a separate headerMatias Elo
Split random types into a separate header file to enable easier function inlining. No API changes. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-03api: pktio: split packet io types into a separate headerMatias Elo
Split packet IO types into a separate header file to enable easier function inlining. No API changes. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-03api: pool: split pool types into a separate headerMatias Elo
Split pool types into a separate header file to enable easier function inlining. No API changes. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-03api: timer: add periodic timerPetri Savolainen
Added support for periodic timers. Timers are diveded into two types: single shot and periodic. Traditional timers are single shot. New capabilities, parameters and functions are added to create/start/ack periodic timers. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Shijith Thotton <sthotton@marvell.com>
2022-03-03api: timer: add timer start and restart functionsPetri Savolainen
Current timer set functions include both start and restart functionality, which complicates implementation. Introduce two new functions: timer start and restart. Those are used explicitly to start inactive timers and to restart active timers. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Shijith Thotton <sthotton@marvell.com>
2022-03-02api: sched: deprecate scheduling priority level definesMatias Elo
Deprecate scheduling priority level defines ODP_SCHED_PRIO_HIGHEST, ODP_SCHED_PRIO_NORMAL, ODP_SCHED_PRIO_LOWEST, and ODP_SCHED_PRIO_DEFAULT. The defines have been replaced by matching functions. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: packet: remove references to deprecated packet input ts functionsMatias Elo
Remove references to deprecated odp_pktin_ts_res() and odp_pktin_ts_from_ns() functions. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated odp_crypto_compl_status_t typeMatias Elo
Remove deprecated odp_crypto_compl_status_t type. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated odp_crypto_op_params_t typeMatias Elo
Remove deprecated odp_crypto_op_params_t type. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated override_iv_ptr field from packet op paramsMatias Elo
Remove deprecated 'override_iv_ptr' field from odp_crypto_packet_op_param_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated override_iv_ptr field from crypto op paramsMatias Elo
Remove deprecated 'override_iv_ptr' field from odp_crypto_op_param_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated odp_crypto_session_params_t typeMatias Elo
Remove deprecated odp_crypto_session_params_t type. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated iv field from session parametersMatias Elo
Remove deprecated 'iv' field from odp_crypto_session_param_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated odp_crypto_data_range_t specifierMatias Elo
Remove deprecated crypto API data range specifier odp_crypto_data_range_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated authentication algorithm fieldsMatias Elo
Remove deprecated fields 'md5_96', 'sha256_128', and 'aes128_gcm' from odp_crypto_auth_algos_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated cipher algorithm fieldsMatias Elo
Remove deprecated fields 'aes128_cbc' and 'aes128_gcm' from odp_crypto_cipher_algos_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated crypto authentication algorithmsMatias Elo
Remove deprecated crypto authentication algorithms ODP_AUTH_ALG_MD5_96, ODP_AUTH_ALG_SHA256_128, and ODP_AUTH_ALG_AES128_GCM. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: crypto: remove deprecated crypto cipher algorithmsMatias Elo
Remove deprecated crypto cipher algorithms ODP_CIPHER_ALG_AES128_CBC and ODP_CIPHER_ALG_AES128_GCM. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: pktio: remove deprecated odp_pktio_mtu() functionMatias Elo
Remove deprecated odp_pktio_mtu() function. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: pktio: remove deprecated loop_supported capabilityMatias Elo
Remove deprecated odp_pktio_capability_t.loop_supported capability. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: pktio: remove deprecated parser layer definesMatias Elo
Remove deprecated packet IO parser layer defines. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: queue: remove deprecated scheduled queue capabilitiesMatias Elo
Remove deprecated scheduled queue capabilities from odp_queue_capability_t. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: cls: remove deprecated ODP_PMR_INVAL defineMatias Elo
Remove deprecated ODP_PMR_INVAL define API. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: timer: add timer expiration modePetri Savolainen
Added new timer pool parameter (exp_mode), which application can use to select if timer expiration may happen before or only after the specified time. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-03-02api: timer: clarify timer tick propertiesPetri Savolainen
Clarify that timer tick properties and especially the it may run with a higher frequency than the resolution. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2022-03-02api: pktio: allow LSO usage with TMPetri Savolainen
LSO may be used also with TM (in ODP_PKTOUT_MODE_TM mode), when capabilities permit. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
2022-03-02api: tm: add odp_tm_enq_multi_lso()Petri Savolainen
Added new packet enqueue function which does also segmentation offload (LSO) as part of the TM output operation. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
2022-03-02api: tm: update odp_tm_enq_multi() return value of zeroPetri Savolainen
Move return value of zero from failure codes to part of normal operation. Implementation may return zero when queue or other resources are temporarily full. This is inline with other similar API calls and how the reference implementation works already. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
2022-03-02api: tm: remove doxygen comment from sub-headingsPetri Savolainen
Doxygen comment format (/**) cannot be used for headings as those are merged into the next Doxygen documented object (e.g. documentation of the next function in the file). Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
2022-03-02api: pktio: mention odp_pktio_config() in setup sequencePetri Savolainen
Clarify odp_pktio_config() usage in the interface setup sequence. This does not change how the call is used, just makes it easier to find it from API documentation. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
2022-03-02api: pktio: add packet output queue size configuration optionMatias Elo
Add new packet output queue size configuration option odp_pktout_queue_param_t.queue_size and matching capabilities odp_pktio_capability_t.min_output_queue_size and odp_pktio_capability_t.max_output_queue_size. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-03-02api: pktio: add ODP_PKTOUT_MAX_QUEUES defineMatias Elo
Add ODP_PKTOUT_MAX_QUEUES define for the maximum number of packet output queues. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2022-02-01api: tm: define default values for many parametersJanne Peltonen
Define the default values for many parameters to be set by various init functions. Current API validation tests already rely on certain defaults (at least packet_mode being false) which are set by the linux-gen implementation but which are not specified in the API. Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Satha Rao <skoteshwar@marvell.com> Reviewed-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
2022-01-28api: tm: ignore peak rate and peak burst when dual rate is falseNithin Dabilpuram
Clarify that peak rate and peak burst is ignored when dual rate is set to false, indicating that the single rate is commit rate. Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
2022-01-28api: tm: remove ODP_TM_MIN_SHAPER_BW and ODP_TM_MAX_SHAPER_BWNithin Dabilpuram
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 bandwidth can be read from TM per level capabilities. Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-18 23:12:44 +0000