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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
/*------------------------------------------------------------------------------------------------*/
/* UNICENS V2.1.0-3491 */
/* Copyright (c) 2017 Microchip Technology Germany II GmbH & Co. KG. */
/* */
/* This program is free software: you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation, either version 2 of the License, or */
/* (at your option) any later version. */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/* You may also obtain this software under a propriety license from Microchip. */
/* Please contact Microchip for further information. */
/*------------------------------------------------------------------------------------------------*/
/*!
* \file
* \brief Implementation of the API locking manager.
*
* \cond UCS_INTERNAL_DOC
* \addtogroup G_ALM
* @{
*/
/*------------------------------------------------------------------------------------------------*/
/* Includes */
/*------------------------------------------------------------------------------------------------*/
#include "ucs_alm.h"
#include "ucs_misc.h"
/*------------------------------------------------------------------------------------------------*/
/* Internal constant */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Interval for garbage collection */
static const uint16_t ALM_GARBAGE_COLLECTOR_INTERVAL = 2600U; /* parasoft-suppress MISRA2004-8_7 "Value shall be part of the module, not part of a function." */
/*------------------------------------------------------------------------------------------------*/
/* Internal prototypes */
/*------------------------------------------------------------------------------------------------*/
static void Alm_HandleInternalErrors(void *self, void *error_code_ptr);
static void Alm_GarbageCollector(void *self);
static bool Alm_CheckRegisteredApi(void *current_alm_ptr, void *alm_inst_ptr);
static void Alm_StartTimeout(CApiLockingManager *self);
static void Alm_ClearTimeout(CApiLockingManager *self);
static bool Alm_SearchLockedApi(void *current_alm_ptr, void *alm_inst_ptr);
static void Alm_ResetRegisteredApis(CApiLockingManager *self);
static bool Alm_ResetApi(void *current_alm_ptr, void *alm_inst_ptr);
/*------------------------------------------------------------------------------------------------*/
/* Implementation of class CApiLockingManager */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Constructor of the API locking manager class.
* \param self Instance pointer
* \param tm_ptr Reference to timer management instance
* \param eh_ptr Reference to event handler instance
* \param ucs_user_ptr User reference that needs to be passed in every callback function
*/
void Alm_Ctor(CApiLockingManager *self,
CTimerManagement *tm_ptr,
CEventHandler *eh_ptr,
void * ucs_user_ptr)
{
MISC_MEM_SET(self, 0, sizeof(*self));
T_Ctor(&self->garbage_collector);
self->tm_ptr = tm_ptr;
self->eh_ptr = eh_ptr;
self->ucs_user_ptr = ucs_user_ptr;
/* Observe internal errors and events */
Mobs_Ctor(&self->internal_error_obs, self, EH_M_TERMINATION_EVENTS, &Alm_HandleInternalErrors);
Eh_AddObsrvInternalEvent(self->eh_ptr, &self->internal_error_obs);
}
/*! \brief Handles internal errors and events
* \param self Instance pointer
* \param error_code_ptr Reference to reported error code
*/
static void Alm_HandleInternalErrors(void *self, void *error_code_ptr)
{
CApiLockingManager *self_ = (CApiLockingManager *)self;
MISC_UNUSED(error_code_ptr);
Tm_ClearTimer(self_->tm_ptr, &self_->garbage_collector); /* Clear timeout */
Alm_ResetRegisteredApis(self_); /* Reset all registered APIs */
}
/*! \brief Checks for API locking timeouts. This method is the callback function of timer
* \c garbage_collector.
* \param self Instance pointer
*/
static void Alm_GarbageCollector(void *self)
{
CApiLockingManager *self_ = (CApiLockingManager *)self;
(void)Dl_Foreach(&self_->api_list, &Alm_CheckRegisteredApi, self_);
}
/*! \brief This method is used by Alm_GarbageCollector() to process each registered API.
* \param current_alm_ptr Reference to the current API
* \param alm_inst_ptr Instance of the API locking manager
* \return \c false to process all registered APIs
*/
static bool Alm_CheckRegisteredApi(void *current_alm_ptr, void *alm_inst_ptr)
{
CApiLockingManager *self = (CApiLockingManager *)alm_inst_ptr;
CApiLocking *alm_ptr_ = (CApiLocking *)current_alm_ptr;
MISC_UNUSED(self);
if(alm_ptr_->timeout_mask != 0U)
{
Alm_ModuleMask_t tmp_mask = 1U;
while(alm_ptr_->timeout_mask != 0U)
{
if(tmp_mask == (tmp_mask & alm_ptr_->timeout_mask))
{
Ssub_Notify(&alm_ptr_->subject, &tmp_mask, false);
alm_ptr_->method_mask &= ~tmp_mask;
alm_ptr_->timeout_mask &= ~tmp_mask;
}
tmp_mask <<= 1;
}
Alm_ClearTimeout(self);
}
if(alm_ptr_->method_mask != 0U)
{
alm_ptr_->timeout_mask = alm_ptr_->method_mask;
}
return false;
}
/*! \brief Registers a new API locking object.
* \param self Instance pointer
* \param al_ptr Reference to the API to register
*/
void Alm_RegisterApi(CApiLockingManager *self, CApiLocking *al_ptr)
{
Dl_InsertTail(&self->api_list, &al_ptr->node);
Dln_SetData(&al_ptr->node, al_ptr);
al_ptr->alm_ptr = self;
}
/*! \brief Starts the garbage collecting timer.
* \param self Instance pointer
*/
static void Alm_StartTimeout(CApiLockingManager *self)
{
if(T_IsTimerInUse(&self->garbage_collector) == false)
{
Tm_SetTimer(self->tm_ptr,
&self->garbage_collector,
&Alm_GarbageCollector,
self,
ALM_GARBAGE_COLLECTOR_INTERVAL,
ALM_GARBAGE_COLLECTOR_INTERVAL);
}
}
/*! \brief Clears the garbage collecting timer. The timer is clear if no API locking flag is
* currently pending.
* \param self Instance pointer
*/
static void Alm_ClearTimeout(CApiLockingManager *self)
{
if(Dl_Foreach(&self->api_list, &Alm_SearchLockedApi, self) == NULL)
{
Tm_ClearTimer(self->tm_ptr, &self->garbage_collector);
}
}
/*! \brief Used by Alm_ClearTimeout() to check if at least one registered API is locked.
* \param current_alm_ptr Reference to the current API locking object
* \param alm_inst_ptr Instance of the API locking manager
* \return \c true if a locked API was found, otherwise \c false
*/
static bool Alm_SearchLockedApi(void *current_alm_ptr, void *alm_inst_ptr)
{
CApiLocking *alm_ptr_ = (CApiLocking *)current_alm_ptr;
bool ret_val = false;
MISC_UNUSED(alm_inst_ptr);
if(alm_ptr_->method_mask != 0U)
{
ret_val = true;
}
return ret_val;
}
/*! \brief Resets all registered APIs. Called if an internal error has been occurred.
* \param self Instance pointer
*/
static void Alm_ResetRegisteredApis(CApiLockingManager *self)
{
(void)Dl_Foreach(&self->api_list, &Alm_ResetApi, self);
}
/*! \brief Used by Alm_ResetRegisteredApis() to reset all registered APIs.
* \param current_alm_ptr Reference to the current API locking object
* \param alm_inst_ptr Instance of the API locking manager
* \return \c false (process all registered APIs)
*/
static bool Alm_ResetApi(void *current_alm_ptr, void *alm_inst_ptr)
{
CApiLocking *alm_ptr_ = (CApiLocking *)current_alm_ptr;
MISC_UNUSED(alm_inst_ptr);
alm_ptr_->method_mask = 0U;
alm_ptr_->timeout_mask = 0U;
return false;
}
/*------------------------------------------------------------------------------------------------*/
/* Implementation of class CApiLocking */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Constructor of the API locking class.
* \param self Instance pointer
* \param obs_ptr Observer to signal locked API methods
* \param ucs_user_ptr User reference that needs to be passed in every callback function
*/
void Al_Ctor(CApiLocking *self, CSingleObserver *obs_ptr, void * ucs_user_ptr)
{
MISC_MEM_SET(self, 0, sizeof(*self));
self->ucs_user_ptr = ucs_user_ptr;
Dln_Ctor(&self->node, NULL);
if(obs_ptr != NULL)
{
Ssub_Ctor(&self->subject, self->ucs_user_ptr);
(void)Ssub_AddObserver(&self->subject, obs_ptr);
}
}
/*! \brief Locks the given API method.
* \param self Instance pointer
* \param method Bitmask of method to lock
* \return \c true if the API has been locked successfully
* \return \c false if the API was already locked
*/
bool Al_Lock(CApiLocking *self, Alm_ModuleMask_t method)
{
bool ret_val = false;
if((self->method_mask & method) == 0U)
{
ret_val = true;
self->method_mask |= method;
self->timeout_mask &= ~method;
Alm_StartTimeout(self->alm_ptr);
}
return ret_val;
}
/*! \brief Releases the lock of the given API method.
* \param self Instance pointer
* \param method Bitmask of method to lock
*/
void Al_Release(CApiLocking *self, Alm_ModuleMask_t method)
{
self->method_mask &= ~method;
self->timeout_mask &= ~method;
Alm_ClearTimeout(self->alm_ptr);
}
/*!
* @}
* \endcond
*/
/*------------------------------------------------------------------------------------------------*/
/* End of file */
/*------------------------------------------------------------------------------------------------*/
|
