diff options
| author | Petri Savolainen <petri.savolainen@linaro.org> | 2017-12-11 14:22:16 +0200 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2017-12-27 21:41:47 +0300 |
| commit | 5ad45a67a5f68f0c805ee937a4f40573458928db (patch) | |
| tree | 63db28646d5ac38ac0b5628ce0fbfdd2c5a6104f /include/odp/api/spec/shared_memory.h | |
| parent | ad71c32dbb378adc15418bbad753d4d537fecb02 (diff) | |
api: shm: name is optional
Align shared memory name parameter specification with other
APIs. Name is optional and does not need to be unique, except
when it's used for lookups.
Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
Balasubramanian Manoharan <bala.manoharan@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include/odp/api/spec/shared_memory.h')
| -rw-r--r-- | include/odp/api/spec/shared_memory.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/include/odp/api/spec/shared_memory.h b/include/odp/api/spec/shared_memory.h index 60a0cdde3..38c82a106 100644 --- a/include/odp/api/spec/shared_memory.h +++ b/include/odp/api/spec/shared_memory.h @@ -127,7 +127,14 @@ int odp_shm_capability(odp_shm_capability_t *capa); /** * Reserve a contiguous block of shared memory * - * @param name Name of the block (maximum ODP_SHM_NAME_LEN - 1 chars) + * Reserve a contiguous block of shared memory that fulfills size, alignment + * and shareability (ODP_SHM_* flags) requirements. In general, a name is + * optional and does not need to be unique. However, if the block will be + * searched with odp_shm_lookup() or odp_shm_import(), a unique name is needed + * for correct match. + * + * @param name Name of the block or NULL. Maximum string length is + * ODP_SHM_NAME_LEN. * @param size Block size in bytes * @param align Block alignment in bytes * @param flags Shared memory parameter flags (ODP_SHM_*). Default value is 0. |