aboutsummaryrefslogtreecommitdiff
path: root/platform/linux-generic/doc/platform_specific.dox
blob: e116ec617d7181fa72833affe0c553d383503384 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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.
 */