aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/spec/dma_types.h
AgeCommit message (Collapse)Author
2024-04-29api: clarify maximum string length textsJere Leppänen
Make mentions of maximum string lengths clear and consistent. Specifically, always state that the null character is included. Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
2023-09-01api: update copyright formatMatias Elo
Update all API files to use the new shorter copyright format: /* SPDX-License-Identifier: BSD-3-Clause * Copyright (c) <YEAR> <COPYRIGHT HOLDER> */ Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2023-07-12api: dma: pack DMA segment data structurePetri Savolainen
Move odp_dma_seg_t structure fields so that addr/packet field is directly followed by length and offset fields. After this change all commonly used fields are located in the first 16 bytes of the structure, which may improve performance. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
2023-07-11api: pool: add user area initialization parametersTuomas Taipale
New `uarea_init` pool parameters `init_fn` and `args` can be used to initialize event user areas of a pool at pool creation time. This enables straightforward user area initialization in case implementation supports the new `uarea_persistence` pool capability. Signed-off-by: Tuomas Taipale <tuomas.taipale@nokia.com> Acked-by: Ashwin Sekhar T K <asekhar@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2023-07-11api: pool: add user area content persistence capabilityTuomas Taipale
New `uarea_persistence` pool capability signals if implementation is able to maintain the content of pool user areas across frees and allocations. In case the content can be maintained, applications could initialize all user areas only once after pool creation and trust that the content remains valid after freeing an event. Otherwise, user areas need re-initialization after every allocation. Signed-off-by: Tuomas Taipale <tuomas.taipale@nokia.com> Acked-by: Ashwin Sekhar T K <asekhar@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
2023-06-09api: dma: add completion event user areaTuomas Taipale
Add completion event pool user area capability and parameter definitions as well as a function to query pointer to the area. Signed-off-by: Tuomas Taipale <tuomas.taipale@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Vamsi Attunuru <vattunuru@marvell.com>
2023-06-01api: fix doxygen see command usageMatias Elo
Using @see command starts a new "See also" paragraph in Doxygen output, which is not intended in several API specifications. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Tuomas Taipale <tuomas.taipale@nokia.com>
2023-04-13api: pool: clarify odp_pool_capability_t.max_pools specificationMatias Elo
Clarify that odp_pool_capability_t.max_pools is used for all pool types defined in odp_pool_type_t. Also, added reference to DMA pool capability (odp_dma_pool_capability_t.max_pools) to make this clearer. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.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: 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>
2021-12-09api: dma: add new DMA offload APIPetri Savolainen
DMA API allows application to offload memory transfers (copies) to DMA hardware. Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Matias Elo <matias.elo@nokia.com>