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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
/*------------------------------------------------------------------------------------------------*/
/* 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 Port Message Channel
*
* \cond UCS_INTERNAL_DOC
* \addtogroup G_PMC
* @{
*/
/*------------------------------------------------------------------------------------------------*/
/* Includes */
/*------------------------------------------------------------------------------------------------*/
#include "ucs_pmchannel.h"
#include "ucs_pmp.h"
#include "ucs_pmcmd.h"
#include "ucs_misc.h"
/*------------------------------------------------------------------------------------------------*/
/* Internal Constants */
/*------------------------------------------------------------------------------------------------*/
/*------------------------------------------------------------------------------------------------*/
/* Internal typedefs */
/*------------------------------------------------------------------------------------------------*/
/*------------------------------------------------------------------------------------------------*/
/* Internal prototypes */
/*------------------------------------------------------------------------------------------------*/
/* LLD related interface functions */
static Ucs_Lld_RxMsg_t* Pmch_RxAllocate(void *self, uint16_t buffer_size);
static void Pmch_RxUnused(void *self, Ucs_Lld_RxMsg_t *msg_ptr);
static void Pmch_RxReceive(void *self, Ucs_Lld_RxMsg_t *msg_ptr);
static void Pmch_TxRelease(void *self, Ucs_Lld_TxMsg_t *msg_ptr);
/*------------------------------------------------------------------------------------------------*/
/* Implementation */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Constructor of class CPmChannel
* \param self The instance
* \param init_ptr Reference to initialization data structure
*/
void Pmch_Ctor(CPmChannel *self, const Pmch_InitData_t *init_ptr)
{
uint16_t cnt;
MISC_MEM_SET(self, 0, sizeof(*self));
self->init_data = *init_ptr;
self->lld_active = false;
self->ucs_iface.rx_allocate_fptr = &Pmch_RxAllocate;
self->ucs_iface.rx_receive_fptr = &Pmch_RxReceive;
self->ucs_iface.rx_free_unused_fptr = &Pmch_RxUnused;
self->ucs_iface.tx_release_fptr = &Pmch_TxRelease;
Pool_Ctor(&self->rx_msgs_pool, self->rx_msgs, /* initialize Rx message pool */
PMCH_POOL_SIZE_RX, self->init_data.ucs_user_ptr);
for (cnt = 0U; cnt < PMCH_POOL_SIZE_RX; cnt++) /* and assign LLD Rx handles */
{
Msg_SetLldHandle(&self->rx_msgs[cnt], &self->lld_rx_msgs[cnt]);
self->lld_rx_msgs[cnt].msg_ptr = &self->rx_msgs[cnt];
}
}
/*! \brief Registers an Rx callback function dedicated to one FIFO
* \param self The instance
* \param fifo_id The FIFO identifier
* \param rx_fptr The Rx callback function
* \param inst_ptr Reference to the instance required to invoke the callback
*/
void Pmch_RegisterReceiver(CPmChannel *self, Pmp_FifoId_t fifo_id, Pmch_OnRxMsg_t rx_fptr, void *inst_ptr)
{
TR_ASSERT(self->init_data.ucs_user_ptr, "[PMCH]", (((uint8_t)fifo_id == (uint8_t)PMP_FIFO_ID_ICM)||((uint8_t)fifo_id == (uint8_t)PMP_FIFO_ID_MCM)||((uint8_t)fifo_id == (uint8_t)PMP_FIFO_ID_RCM)));
self->receivers[fifo_id].rx_fptr = rx_fptr;
self->receivers[fifo_id].inst_ptr = inst_ptr;
}
/*! \brief Un-initializes the LLD interface of the channel
* \param self The instance
*/
void Pmch_Initialize(CPmChannel *self)
{
if (self->lld_active == false)
{
self->lld_active = true;
TR_INFO((self->init_data.ucs_user_ptr, "[PMCH]", "Pmch_Initialize(): LLD_START()", 0U));
self->init_data.lld_iface.start_fptr(&self->ucs_iface, self, self->init_data.lld_iface.lld_user_ptr);
}
}
/*! \brief Un-initializes the LLD interface of the channel
* \param self The instance
*/
extern void Pmch_Uninitialize(CPmChannel *self)
{
TR_INFO((self->init_data.ucs_user_ptr, "[PMCH]", "Pmch_Uninitialize(): Channel un-synchronization started", 0U));
if (self->lld_active != false)
{
self->lld_active = false;
TR_INFO((self->init_data.ucs_user_ptr, "[PMCH]", "Pmch_Uninitialize(): LLD_STOP()", 0U));
self->init_data.lld_iface.stop_fptr(self->init_data.lld_iface.lld_user_ptr);
}
}
/*! \brief Wrapper for LLD transmit
* \details This function which shall be used by all internal classes. No class shall
* invoke the LLD transmit function directly. Thus, it might be possible
* in future to handle transmission failures and retries.
* \param self The instance
* \param msg_ptr Reference to the public LLD message structure
*/
void Pmch_Transmit(CPmChannel *self, Ucs_Lld_TxMsg_t *msg_ptr)
{
if (self->lld_active != false)
{
self->init_data.lld_iface.tx_transmit_fptr(msg_ptr, self->init_data.lld_iface.lld_user_ptr);
}
else
{
Pmch_TxRelease(self, msg_ptr);
}
}
/*------------------------------------------------------------------------------------------------*/
/* The exposed low-level driver interface */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Allocates an Rx message object
* \param self The instance
* \param buffer_size Size of the memory chunk in bytes which is needed to
* copy the Rx message.
* \return Reference to an allocated Rx message object or \c NULL if no message object is available.
*/
static Ucs_Lld_RxMsg_t* Pmch_RxAllocate(void *self, uint16_t buffer_size)
{
CMessage *msg_ptr = NULL;
Ucs_Lld_RxMsg_t *handle = NULL;
CPmChannel *self_ = (CPmChannel*)self;
if (buffer_size <= MSG_SIZE_RSVD_BUFFER)
{
msg_ptr = Pool_GetMsg(&self_->rx_msgs_pool);
if (msg_ptr != NULL)
{
Msg_Cleanup(msg_ptr);
handle = &((Lld_IntRxMsg_t*)Msg_GetLldHandle(msg_ptr))->lld_msg;
TR_ASSERT(self_->init_data.ucs_user_ptr, "[PMCH]", (handle != NULL));
handle->data_size = buffer_size;
handle->data_ptr = Msg_GetHeader(msg_ptr);
}
else
{
self_->rx_trigger_available = true;
TR_INFO((self_->init_data.ucs_user_ptr, "[PMCH]", "Pmch_RxAllocate(): Allocation failed, size=%u", 1U, buffer_size));
}
}
else
{
self_->rx_trigger_available = true;
TR_FAILED_ASSERT(self_->init_data.ucs_user_ptr, "[PMCH]");
}
return handle;
}
/*! \brief Frees an unused Rx message object
* \param self The instance
* \param msg_ptr Reference to the unused Rx message object
*/
static void Pmch_RxUnused(void *self, Ucs_Lld_RxMsg_t *msg_ptr)
{
CPmChannel *self_ = (CPmChannel*)self;
CMessage *pb_handle = ((Lld_IntRxMsg_t*)(void*)msg_ptr)->msg_ptr;
TR_ASSERT(self_->init_data.ucs_user_ptr, "[PMCH]", (pb_handle != NULL));
Pmch_ReturnRxToPool(self_, pb_handle);
}
/*! \brief Pass an Rx message to UNICENS
* \param self The instance
* \param msg_ptr Reference to the Rx message object containing the received
* message.
*/
static void Pmch_RxReceive(void *self, Ucs_Lld_RxMsg_t *msg_ptr)
{
bool found = false;
CPmChannel *self_ = (CPmChannel*)self;
if (msg_ptr->data_ptr != NULL)
{
if (msg_ptr->data_size >= PMP_PM_MIN_SIZE_HEADER) /* ignore incomplete messages */
{
uint8_t fifo_no = (uint8_t)Pmp_GetFifoId(msg_ptr->data_ptr); /* get channel id (FIFO number) */
if ((fifo_no < PMP_MAX_NUM_FIFOS) && (self_->receivers[fifo_no].inst_ptr != NULL))
{
CMessage *handle = ((Lld_IntRxMsg_t*)(void*)msg_ptr)->msg_ptr;
/* forward message to the respective FIFO/channel */
self_->receivers[fifo_no].rx_fptr(self_->receivers[fifo_no].inst_ptr, handle);
found = true;
}
else
{
TR_ERROR((self_->init_data.ucs_user_ptr, "[PMCH]", "Pmch_RxReceive(): received message for unregistered FIFO no=%u", 1U, fifo_no));
}
}
else
{
TR_ERROR((self_->init_data.ucs_user_ptr, "[PMCH]", "Pmch_RxReceive(): received incomplete message of size=%u", 1U, msg_ptr->data_size));
}
}
else
{
TR_ERROR((self_->init_data.ucs_user_ptr, "[PMCH]", "Pmch_RxReceive(): message data is not valid", 0U));
}
if (found == false)
{
Pmch_RxUnused(self_, msg_ptr); /* Just return message to pool until PMC is implemented */
}
}
/*! \brief Notifies that the LLD no longer needs to access the Tx message object
* \param self The instance
* \param msg_ptr Reference to the Tx message object which is no longer accessed
* by the low-level driver
*/
static void Pmch_TxRelease(void *self, Ucs_Lld_TxMsg_t *msg_ptr)
{
CPmChannel *self_ = (CPmChannel*)self;
Lld_IntTxMsg_t *tx_ptr = (Lld_IntTxMsg_t*)(void*)msg_ptr;
if ((tx_ptr->owner_ptr == NULL) && (tx_ptr->msg_ptr == NULL)) /* tx_ptr is command */
{
Pmcmd_Release((CPmCommand*)(void*)tx_ptr);
}
else if (tx_ptr->owner_ptr != NULL) /* release message to FIFO */
{
self_->init_data.tx_release_fptr(tx_ptr->owner_ptr, msg_ptr);
}
else
{
TR_FAILED_ASSERT(self_->init_data.ucs_user_ptr, "[PMCH]"); /* unknown FIFO - invalid message object */
}
TR_ASSERT(self_->init_data.ucs_user_ptr, "[PMCH]", (msg_ptr->custom_next_msg_ptr == NULL) ); /* concatenation destroyed by the LLD */
}
/*------------------------------------------------------------------------------------------------*/
/* FIFO Related Callback Functions */
/*------------------------------------------------------------------------------------------------*/
/*! \brief Returns an unused Rx message object back to the pool
* \param self The instance
* \param msg_ptr The unused Rx message object
*/
void Pmch_ReturnRxToPool(void *self, CMessage *msg_ptr)
{
CPmChannel *self_ = (CPmChannel*)self;
Pool_ReturnMsg(msg_ptr);
if (self_->rx_trigger_available == true)
{
self_->rx_trigger_available = false;
if (self_->init_data.lld_iface.rx_available_fptr != NULL)
{
self_->init_data.lld_iface.rx_available_fptr(self_->init_data.lld_iface.lld_user_ptr);
}
}
}
/*!
* @}
* \endcond
*/
/*------------------------------------------------------------------------------------------------*/
/* End of file */
/*------------------------------------------------------------------------------------------------*/
|
