diff options
author | Matias Elo <matias.elo@nokia.com> | 2023-03-09 17:04:43 +0200 |
---|---|---|
committer | Matias Elo <matias.elo@nokia.com> | 2023-04-13 08:18:06 +0300 |
commit | c7ba353bc6300fce51bbe568837a165b927ae7cb (patch) | |
tree | 8e17982684e47cb88907bd7be46b70c608e1bf88 /include | |
parent | 06d7e9053777db219e5f322fdd12d0c01f922573 (diff) |
api: pool: clarify odp_pool_capability_t.max_pools specification
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>
Diffstat (limited to 'include')
-rw-r--r-- | include/odp/api/spec/dma_types.h | 4 | ||||
-rw-r--r-- | include/odp/api/spec/pool_types.h | 2 |
2 files changed, 4 insertions, 2 deletions
diff --git a/include/odp/api/spec/dma_types.h b/include/odp/api/spec/dma_types.h index ae3d05287..caa51700b 100644 --- a/include/odp/api/spec/dma_types.h +++ b/include/odp/api/spec/dma_types.h @@ -69,7 +69,9 @@ extern "C" { * Pool statistics are not supported with DMA completion event pools. */ typedef struct odp_dma_pool_capability_t { - /** Maximum number of DMA completion event pools */ + /** Maximum number of DMA completion event pools + * + * See odp_pool_capability_t::max_pools for total capability. */ uint32_t max_pools; /** Maximum number of DMA completion events in a pool */ diff --git a/include/odp/api/spec/pool_types.h b/include/odp/api/spec/pool_types.h index 9f433fba5..e9b1f9d52 100644 --- a/include/odp/api/spec/pool_types.h +++ b/include/odp/api/spec/pool_types.h @@ -151,7 +151,7 @@ typedef struct odp_pool_stats_t { * Pool capabilities */ typedef struct odp_pool_capability_t { - /** Maximum number of pools of any type */ + /** Maximum number of pools of any type (odp_pool_type_t) */ uint32_t max_pools; /** Buffer pool capabilities */ |