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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
#ifndef PERSISTENCE_CLIENT_LIBRARY_CUSTOM_LOADER_H
#define PERSISTENCE_CLIENT_LIBRARY_CUSTOM_LOADER_H
/******************************************************************************
* Project Persistency
* (c) copyright 2012
* Company XS Embedded GmbH
*****************************************************************************/
/******************************************************************************
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.
******************************************************************************/
/**
* @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;
/// custom library init function
int (*custom_plugin_init)();
/// custom library deinit function
int (*custom_plugin_deinit)();
/// custom open function
long (*custom_plugin_open)(char* path, int flag, int mode);
/// custom close function
int (*custom_plugin_close)(int handle);
/// custom get data function
long (*custom_plugin_get_data_handle)(long handle, char* buffer, long size);
/// custom set data function
long (*custom_plugin_set_data_handle)(long handle, char* buffer, long size);
/// custom get data function
long (*custom_plugin_get_data)(char* buffer, long size);
/// custom set data function
long (*custom_plugin_set_data)(char* buffer, long size);
/// custom delete function
int (*custom_plugin_delete_data)(const char* path);
// get the size
int (*custom_plugin_get_size_handle)(int key_handle);
// get the size
int (*custom_plugin_get_size)(const char* path);
/// create backup
int (*custom_plugin_backup_create)(const char* src, const char* dst);
/// restore backup
int (*custom_plugin_backup_restore)(const char* srt, const char* dst);
/// custom status notification function
int (*custom_plugin_get_status_notification_clbk)(plugin_callback_t pFunct);
}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 get_custom_client_position_in_array(PersistenceCustomLibs_e customLib);
/**
* @brief gget the number of available custom client libraries
*
* @return the number of the client libraries
*/
int get_num_custom_client_libs();
/**
* @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 */
|
