diff options
| author | Balakrishna Garapati <balakrishna.garapati@linaro.org> | 2016-11-01 13:34:41 +0100 |
|---|---|---|
| committer | Balakrishna Garapati <balakrishna.garapati@linaro.org> | 2016-11-02 15:20:36 +0100 |
| commit | 92de3423117cffe90b20cbfd0945eada88edfeed (patch) | |
| tree | 903097e1ca48e16fecd3e8574104c3a351358c52 | |
| parent | fddc98f84e9aa44bc43d3797c24868d58d1de715 (diff) | |
linux-dpdk: doc: defining the ODP thread
porting linux-gen: doc: defining the ODP thread
Signed-off-by: Balakrishna Garapati <balakrishna.garapati@linaro.org>
Reviewed-and-tested-by: Matias Elo <matias.elo@nokia.com>
| -rw-r--r-- | platform/linux-dpdk/doc/platform_specific.dox | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/platform/linux-dpdk/doc/platform_specific.dox b/platform/linux-dpdk/doc/platform_specific.dox new file mode 100644 index 000000000..bdab65640 --- /dev/null +++ b/platform/linux-dpdk/doc/platform_specific.dox @@ -0,0 +1,32 @@ +/* Copyright (c) 2016, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +* @file platform_specific.dox +* extra linux-dpdk documentation +*/ + +/** @addtogroup odp_thread + * @par ODP thread + * In this ODP implementation an odp thread is either: + * - a linux process descendant (or same as) the odp instantiation process. + * - a pthread 'member' of a linux process descendant (or same as) the odp + * instantiation process. + */ + +/** + * @fn odp_init_local(odp_instance_t instance, odp_thread_type_t thr_type) + * @note In this ODP implementation odpthreads have to be + * processes descendants of (or same as) the ODP + * instantiation process, or pthreads 'members' of such + * processes. + * @note As ODP instantiation processes cannot be descendants + * of each others, the instance parameter provided + * to odp_init_local() is actually fully defined by these + * requirements: It has to be the value returned by the + * unique call to odp_init_global() made by one single + * ascendant of the current process. + */ |