diff options
| author | Christophe Milard <christophe.milard@linaro.org> | 2016-08-09 10:01:46 +0200 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-08-12 19:35:04 +0300 |
| commit | d5295a9c745e82fbf002d71d3fa8a32ebfb48047 (patch) | |
| tree | 8f113287c45339617426e8035db9971e2d725b41 | |
| parent | a5d7adea4b2487b020371ac554935972ec947385 (diff) | |
linux-gen: doc: defining the ODP thread
Signed-off-by: Christophe Milard <christophe.milard@linaro.org>
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
| -rw-r--r-- | doc/platform-api-guide/Doxyfile | 1 | ||||
| -rw-r--r-- | doc/platform-api-guide/Makefile.am | 8 | ||||
| -rw-r--r-- | platform/linux-generic/doc/platform_specific.dox | 46 |
3 files changed, 54 insertions, 1 deletions
diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/Doxyfile index b87b7b2ad..93f6edfe3 100644 --- a/doc/platform-api-guide/Doxyfile +++ b/doc/platform-api-guide/Doxyfile @@ -6,6 +6,7 @@ PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg INPUT = $(SRCDIR)/doc/application-api-guide \ $(SRCDIR)/doc/platform-api-guide \ $(SRCDIR)/include \ + $(SRCDIR)/platform/$(WITH_PLATFORM)/doc \ $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \ $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH) EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR) diff --git a/doc/platform-api-guide/Makefile.am b/doc/platform-api-guide/Makefile.am index a04c254df..27cd902ee 100644 --- a/doc/platform-api-guide/Makefile.am +++ b/doc/platform-api-guide/Makefile.am @@ -1,5 +1,11 @@ +#If additional documentation is added in the platform include directory but it +#is not in a .h file, it must be included here as an extra part of the +#distribution. + EXTRA_DIST = \ - Doxyfile + Doxyfile \ + $(top_srcdir)/platform/${with_platform}/doc/*.dox + clean-local: rm -rf output diff --git a/platform/linux-generic/doc/platform_specific.dox b/platform/linux-generic/doc/platform_specific.dox new file mode 100644 index 000000000..e116ec617 --- /dev/null +++ b/platform/linux-generic/doc/platform_specific.dox @@ -0,0 +1,46 @@ +/* Copyright (c) 2016, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +* @file platform_specific.dox +* extra linux-generic 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 descendant of (or same as) the ODP + * instantiation process, or pthreads 'member' 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 + * acsendant of the current process. + */ + +/** + * @fn odp_init_global(odp_instance_t *instance, + * const odp_init_t *params, + * const odp_platform_init_t *platform_params) + * @note This ODP implementation supports mupliple instances of ODP + * (i.e. multiple call to odp_init_global()) with the following + * restrictions: + * @note -Different ODP instances cannot share the same instantiation + * process. In other words, a single process may + * only call odp_init_global() once. + * @note -Different ODP instantiation processes cannot be descendant of + * each other. + */ |