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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
|
/*
* @copyright Copyright (c) 2016-2019 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "_pbSerial.h"
#include "WPF_STD_private.h"
#include "_pbInternalProc.h"
typedef struct SerialTable {
HANDLE h_handle; /* Registration handle */
DWORD dw_wait_mask; /* SetMask */
DWORD dw_read_timeout; /* milisec */
DWORD dw_write_timeout; /* milisec */
struct SerialTable *next;
} SERIAL_TABLE;
static SERIAL_TABLE *g_pst_serial_table = NULL;
static pthread_mutex_t g_func_lock_mutex = PTHREAD_MUTEX_INITIALIZER; /* Consider replacing it later */
/* Prototype declarations */
static BOOL FindList(SERIAL_TABLE **p_list, HANDLE h_obj);
static BOOL AddList(SERIAL_TABLE *p_add_list);
static BOOL DelList(SERIAL_TABLE *h_del_obj);
static BOOL FunctionLock(void);
static BOOL FunctionUnlock(void);
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* _sys internal public APIs
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/****************************************************************************
@brief SerialTableInit<BR>
Initialize each process
@outline SerialTableInit<BR>
Initialize each process
@type Completion return type
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialTableInit(void) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
/* do nothing at this time */
return TRUE;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief SerialTableTerm<BR>
termination processing for each process
@outline SerialTableTerm<BR>
termination processing for each process
@type Completion return type
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialTableTerm(void) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
if (NULL != g_pst_serial_table) {
/* delete the list? */
}
return TRUE;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief SerialObjectTimeoutAdd<BR>
Set read/write timeout
@outline SerialObjectTimeoutAdd<BR>
Set read/write timeout
@type Completion return type
@param[in] HANDLE h_obj : Handle to set the timeout
@param[in] DWORD dw_read_timeout : Timeout to read (Millisecond)
@param[in] DWORD dw_write_timeout : Timeout to write (Millisecond)
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialObjectTimeoutAdd(HANDLE h_obj, DWORD dw_read_timeout, DWORD dw_write_timeout) { // LCOV_EXCL_START 8:dead code // NOLINT(whitespace/line_length)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *p_list = NULL;
BOOL bret = FALSE;
if (NULL != h_obj) {
FunctionLock();
bret = FindList(&p_list, h_obj);
if (TRUE == bret) {
/* Already exists in the list */
if (NULL != p_list) {
p_list->dw_read_timeout = dw_read_timeout;
p_list->dw_write_timeout = dw_write_timeout;
bret = TRUE;
} else {
/* The list pointer is expected to be in the list but cannot be retrieved. */
bret = FALSE;
}
} else {
/* Not exist in the list */
p_list = reinterpret_cast<SERIAL_TABLE*>(malloc(sizeof(SERIAL_TABLE)));
if (NULL != p_list) {
p_list->next = NULL;
p_list->dw_wait_mask = 0;
p_list->h_handle = h_obj;
p_list->dw_read_timeout = dw_read_timeout;
p_list->dw_write_timeout = dw_write_timeout;
bret = AddList(p_list);
if (FALSE == bret) {
/* Registration failure */
free(p_list);
bret = FALSE;
} else {
/* Registration success */
bret = TRUE;
}
} else {
/* Falied to get memory */
bret = FALSE;
}
}
FunctionUnlock();
} else {
/* Parameter error */
bret = FALSE;
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief SerialObjectTimeoutGet<BR>
Get read/write timeout
@outline SerialObjectTimeoutGet<BR>
Get read/write timeout
@type Completion return type
@param[in] HANDLE h_obj : Handle for getting the timeout
@param[out] DWORD* dw_read_timeout : Timeout to read (Millisecond)
@param[out] DWORD* dw_write_timeout : Timeout to write (Millisecond)
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialObjectTimeoutGet(HANDLE h_obj, DWORD *dw_read_timeout, DWORD *dw_write_timeout) { // LCOV_EXCL_START 8:dead code // NOLINT(whitespace/line_length)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *p_list = NULL;
BOOL bret = FALSE;
if ((NULL != h_obj) && (NULL != dw_read_timeout) && (NULL != dw_write_timeout)) {
FunctionLock();
bret = FindList(&p_list, h_obj);
if (TRUE == bret) {
/* Exists in the list */
if (NULL != p_list) {
*dw_read_timeout = p_list->dw_read_timeout;
*dw_write_timeout = p_list->dw_write_timeout;
bret = TRUE;
} else {
/* The list pointer is expected to be in the list but cannot be retrieved. */
bret = FALSE;
}
} else {
/* Not exist in the list */
bret = FALSE;
}
FunctionUnlock();
} else {
/* Parameter error */
bret = FALSE;
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief SerialObjectWaitmaskAdd<BR>
Set the mask of event wait factor
@outline SerialObjectWaitmaskAdd<BR>
Set the mask of event wait factor
@type Completion return type
@param[in] HANDLE h_obj : Handle to set the mask
@param[in] DWORD dw_mask : Value of mask
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialObjectWaitmaskAdd(HANDLE h_obj, DWORD dw_mask) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *p_list = NULL;
BOOL bret = FALSE;
if (NULL != h_obj) {
FunctionLock();
bret = FindList(&p_list, h_obj);
if (TRUE == bret) {
/* already exists in the list */
if (NULL != p_list) {
/* Clear unused flags */
p_list->dw_wait_mask = (DWORD)((dw_mask) & (EV_RXCHAR | EV_ERROR | EV_DSR));
bret = TRUE;
} else {
/* The list pointer is expected to be in the list but cannot be retrieved. */
bret = FALSE;
}
} else {
/* Not exist in the list */
p_list = reinterpret_cast<SERIAL_TABLE*>(malloc(sizeof(SERIAL_TABLE)));
if (NULL != p_list) {
p_list->next = NULL;
p_list->h_handle = h_obj;
p_list->dw_read_timeout = INFINITE; /* Infinity wait as initial value */
p_list->dw_write_timeout = INFINITE; /* Infinity wait as initial value */
/* Clear unused flags */
p_list->dw_wait_mask = (DWORD)((dw_mask) & (EV_RXCHAR | EV_ERROR | EV_DSR));
bret = AddList(p_list);
if (FALSE == bret) {
/* Registration failure */
free(p_list);
bret = FALSE;
} else {
/* registration success */
bret = TRUE;
}
} else {
/* Failed to get memory */
bret = FALSE;
}
}
FunctionUnlock();
} else {
/* Parameter error */
bret = FALSE;
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief SerialObjectWaitmaskGet<BR>
Get the set mask value from a handle
@outline SerialObjectWaitmaskGet<BR>
Get the set mask value from a handle
@type Completion return type
@param[in] HANDLE h_obj : Handle from which the mask is to be acquired
@param[out] DWORD* dw_mask : mask value
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialObjectWaitmaskGet(HANDLE h_obj, DWORD *dw_mask) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *p_list = NULL;
BOOL bret = FALSE;
if ((NULL != h_obj) && (NULL != dw_mask)) {
*dw_mask = 0;
FunctionLock();
bret = FindList(&p_list, h_obj);
if (TRUE == bret) {
/* Exists in the list */
if (NULL != p_list) {
*dw_mask = p_list->dw_wait_mask;
bret = TRUE;
} else {
/* The list pointer is expected to be in the list but cannot be retrieved. */
bret = FALSE;
}
} else {
/* Not exist in the list */
bret = FALSE;
}
FunctionUnlock();
} else {
/* Parameter error */
bret = FALSE;
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief SerialObjectDel<BR>
Delete Timeout and Mask Setting
@outline SerialObjectDel<BR>
Delete Timeout and Mask Setting
@type Completion return type
@param[in] HANDLE h_obj : Handle from which the setting is to be deleted
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
BOOL SerialObjectDel(HANDLE h_obj) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *p_list = NULL;
BOOL bret = FALSE;
if (NULL != h_obj) {
FunctionLock();
bret = FindList(&p_list, h_obj);
if (TRUE == bret) {
/* Already exists in the list */
if (NULL != p_list) {
bret = DelList(p_list);
if (TRUE == bret) {
free(p_list);
} else {
/* Failed to delete */
}
} else {
/* The list pointer is expected to be in the list but cannot be retrieved. */
bret = FALSE;
}
} else {
/* Not exist in the list */
}
FunctionUnlock();
} else {
/* Parameter error */
}
return bret;
}
// LCOV_EXCL_STOP
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Private APIs
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/****************************************************************************
@brief FindList<BR>
Searching for a Handle in the List
@outline FindList<BR>
Searching for a Handle in the List
@type Completion return type
@param[out] SERIAL_TABLE** p_list : Found list pointer
@param[in] HANDLE h_obj : Handle to look for
@return BOOL
@retval TRUE : Normal (p_list != NULL)
@retval FALSE : Error (p_list == NULL)
*****************************************************************************/
static BOOL FindList(SERIAL_TABLE **p_list, HANDLE h_obj) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *pNow = NULL;
BOOL bret = FALSE;
if ((NULL != h_obj) && (NULL != p_list)) {
/* Search list */
pNow = g_pst_serial_table;
while (NULL != pNow) {
/* h_obj and pNow->h_handle are pointer type.*/
if ((int64_t)h_obj == (int64_t)pNow->h_handle) {
*p_list = pNow;
bret = TRUE;
break;
}
pNow = pNow->next;
}
} else {
bret = FALSE; /* Parameter error */
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief AddList<BR>
Append data to the end of the list
@outline AddList<BR>
Append data to the end of the list
@type Completion return type
@param[in] SERIAL_TABLE* p_list : Data to add
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
static BOOL AddList(SERIAL_TABLE *p_add_list) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *pNow = NULL;
BOOL bret = FALSE;
if (NULL != p_add_list) {
/* Add unregistered data */
if (NULL == g_pst_serial_table) {
g_pst_serial_table = p_add_list;
bret = TRUE;
} else {
/* Add to end of list */
pNow = g_pst_serial_table;
while (NULL != pNow) {
if (NULL == pNow->next) {
pNow->next = p_add_list;
bret = TRUE;
break;
}
pNow = pNow->next;
}
}
} else {
bret = FALSE; /* Parameter error */
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief DelList<BR>
Remove Specified Data from a List
@outline DelList<BR>
Remove Specified Data from a List
@type Completion return type
@param[in,out] SERIAL_TABLE* h_del_obj :
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
static BOOL DelList(SERIAL_TABLE *h_del_obj) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
SERIAL_TABLE *pNow = NULL;
SERIAL_TABLE *pBef = NULL;
BOOL bret = FALSE;
if (NULL != h_del_obj) {
/* Add to end of list */
pNow = g_pst_serial_table;
while (NULL != pNow) {
if (h_del_obj == pNow) {
if (NULL == pBef) {
/* Delete first data */
g_pst_serial_table = pNow->next;
} else {
/* Others */
pBef->next = h_del_obj->next;
}
bret = TRUE;
break;
}
pBef = pNow;
pNow = pNow->next;
}
} else {
bret = FALSE; /* Parameter error */
}
return bret;
}
// LCOV_EXCL_STOP
/****************************************************************************
@brief FunctionLock<BR>
Start locking g_pst_serial_table
@outline FunctionLock<BR>
Start locking g_pst_serial_table
@type Completion return type
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
static BOOL FunctionLock(void) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
BOOL bret = FALSE;
if (EOK == pthread_mutex_lock(&g_func_lock_mutex)) {
bret = TRUE;
}
return bret;
}
// LCOV_EXCL_STOP
/***************************************************************************
@brief FunctionUnlock<BR>
Terminate locking of g_pst_serial_table
@outline FunctionUnlock<BR>
Terminate locking of g_pst_serial_table
@type Completion return type
@return BOOL
@retval TRUE : Normal
@retval FALSE : Error
*****************************************************************************/
static BOOL FunctionUnlock(void) { // LCOV_EXCL_START 8:dead code
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
BOOL bret = FALSE;
if (EOK == pthread_mutex_unlock(&g_func_lock_mutex)) {
bret = TRUE;
}
return bret;
}
// LCOV_EXCL_STOP
|
