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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
#ifndef PERSISTENCE_CLIENT_LIBRARY_CUSTOM_LOADER_H
#define PERSISTENCE_CLIENT_LIBRARY_CUSTOM_LOADER_H
/******************************************************************************
* Project Persistency
* (c) copyright 2012
* Company XS Embedded GmbH
*****************************************************************************/
/******************************************************************************
* This Source Code Form is subject to the terms of the
* Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
* with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
******************************************************************************/
/**
* @file persistence_client_library_custom_loader.h
* @ingroup Persistence client library
* @author Ingo Huerner
* @brief Header of the persistence client library custom library_loader.
* @see
*/
/// enumerator used to identify the policy to manage the data
typedef enum _PersistenceCustomLibs_e
{
PersCustomLib_early = 0, /// predefined custom library for early persistence
PersCustomLib_secure = 1, /// predefined custom library for secure persistence
PersCustomLib_emergency = 2, /// predefined custom library for emengency persistence
PersCustomLib_HWinfo = 3, /// predefined custom library for hw information
PersCustomLib_Custom1 = 4, /// custom library 1
PersCustomLib_Custom2 = 5, /// custom library 2
PersCustomLib_Custom3 = 6, /// custom library 3
// insert new entries here ...
PersCustomLib_LastEntry /// last entry
} PersistenceCustomLibs_e;
/// enumerator fo custom library defines
enum _PersCustomLibDefines_e
{
PersCustomPathSize = 12
} PersCustomLibDefines_e;
/// callback definition for custom_plugin_get_status_notification_clbk function
typedef int (*plugin_callback_t) (int status, void* dataPtr);
/// structure definition for custom library functions
typedef struct _Pers_custom_functs_s
{
/// custom library handle
void* handle;
/// create backup
int (*custom_plugin_create_backup)(const char* backup_id);
/// custom library deinit function
int (*custom_plugin_deinit)();
/// custom delete function
int (*custom_plugin_delete_data)(const char* path);
/// get backup
int (*custom_plugin_get_backup)(char* backup_id, int size);
// get the size
int (*custom_plugin_get_size)(const char* path);
/// custom get data function
int (*custom_plugin_get_data)(const char* path, char* buffer, int size);
/// custom close function
int (*custom_plugin_handle_close)(int handle);
/// custom get data function
int (*custom_plugin_handle_get_data)(int handle, char* buffer, int size);
/// custom open function
int (*custom_plugin_handle_open)(const char* path, int flag, int mode);
/// custom set data function
int (*custom_plugin_handle_set_data)(int handle, char* buffer, int size);
/// custom library init function
int (*custom_plugin_init)();
/// restore backup
int (*custom_plugin_restore_backup)(const char* backup_id);
/// custom set data function
int (*custom_plugin_set_data)(const char* path, char* buffer, int size);
/// custom status notification function
int (*custom_plugin_get_status_notification_clbk)(plugin_callback_t pFunct);
// get the size
int (*custom_plugin_handle_get_size)(int handle);
}Pers_custom_functs_s;
/// custom library functions array
Pers_custom_functs_s gPersCustomFuncs[PersCustomLib_LastEntry];
/**
* @brief Translate a client library name into a id
*
* @param lib_name the library name
* @param substring indicator if a substring search is neccessary
*
* @return the library id or PersCustomLib_LastEntry if nothing found
*/
PersistenceCustomLibs_e custom_client_name_to_id(const char* lib_name, int substring);
/**
* @brief get the names of the custom libraries to load
*
* @return 0 for success or a negative value with the following errors:
* EPERS_OUTOFBOUNDS
*/
int get_custom_libraries();
/**
* @brief get the names of the custom libraries to load
*
* @param customLib the enumerator id identifying the custom library
* @param customFuncts function pointer array of loaded custom library functions
*
* @return 0 for success or a negative value with one of the following errors:
* EPERS_NOPLUGINFCNT EPERS_DLOPENERROR
*
*/
int load_custom_library(PersistenceCustomLibs_e customLib, Pers_custom_functs_s *customFuncts);
/**
* @brief get the names of the custom libraries to load
*
* @return 0 for success orr a negative value with one of the following errors:
* EPERS_NOPLUGINFCNT EPERS_DLOPENERROR
*/
int load_all_custom_libraries();
/**
* @brief get the position in the array
*
* @param customLib the enumerator id identifying the custom library
*
* @return the array position or -1 if the position can't be found
*/
int check_valid_idx(int idx);
/**
* @brief get the custom library name form an index
*
* @return the name of the custom library ot NULL if invalid
*/
char* get_custom_client_lib_name(int idx);
#endif /* PERSISTENCE_CLIENT_LIBRARY_CUSTOM_LOADER_H */
|
