summaryrefslogtreecommitdiff
path: root/src/plugin-api/common/src/common.h
blob: 60178e28720d32c0071ac042602ebe07a684fb32 (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/**
 * MIT License
 *
 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __COMMON_H__
#define __COMMON_H__

#include <stdbool.h>

#include <system/syscommon-plugin-common.h>

#ifdef __cplusplus
extern "C" {
#endif

#define ARRAY_SIZE(name) (sizeof(name)/sizeof(name[0]))

enum plugin_license {
	PLUGIN_LICENSE_UNKNOWN = 0,
	PLUGIN_LICENSE_APACHE_2_0,
	PLUGIN_LICENSE_FLORA,
	PLUGIN_LICENSE_MIT,
	PLUGIN_LICENSE_END,
};

enum plugin_group {
	PLUGIN_GROUP_UNKNOWN = 0,
	PLUGIN_GROUP_RESOURCED,
	PLUGIN_GROUP_DEVICED,
	PLUGIN_GROUP_END,
};

static const char *const plugin_group_string[] = {
	[PLUGIN_GROUP_UNKNOWN]		= "PLUGIN_GROUP_UNKNOWN",
	[PLUGIN_GROUP_RESOURCED]	= "PLUGIN_GROUP_RESOURCED",
	[PLUGIN_GROUP_DEVICED]		= "PLUGIN_GROUP_DEVICED",
};

/**
 * syscommon-plugin-api-common provides the PLUGIN ABI * (Application Binary Interface)
 * version check feature which is used to check the ABI compatibility between
 * PLUGIN API package and PLUGIN backend package.
 * In order to compare ABI version between two binary, Tizen core platform
 * always must maintain the current PLUGIN ABI version.
 * So that, define the below global variable (g_platform_curr_abi_version).
 *
 * 'g_platform_curr_abi_version' will be used for all PLUGIN API modules,
 * to check whether PLUGIN backend ABI version of each module is supported
 * or not with current PLUGIN ABI version.
 *
 * 'g_platform_curr_abi_version' must be updated when Tizen platform will be
 * released officially.
 */
struct plugin_abi_version_match {
	enum syscommon_plugin_abi_version platform_abi_version;
	enum syscommon_plugin_abi_version backend_min_abi_version;
};

struct __plugin_module_info {
	int usage_count;

	enum plugin_group group;
	enum syscommon_plugin_module module;
	enum plugin_license license;
	char *module_name;
	char *backend_module_name;

	char *library_name;
	char *library_name_64bit;
	void *handle;
	syscommon_plugin_backend *backend;
	char *symbol_name;

	unsigned int num_abi_versions;
	struct plugin_abi_version_match *abi_versions;
};

static inline const char* get_backend_library_name(struct __plugin_module_info *info)
{
	if (!info)
		return NULL;

#if defined(__aarch64__) || defined(__x86_64__) || defined(__riscv)
	return info->library_name_64bit;
#else
	return info->library_name;
#endif
}

#ifdef __cplusplus
}
#endif
#endif /* __COMMON_H__ */