-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathDV_USART.c
More file actions
5417 lines (4683 loc) · 237 KB
/
DV_USART.c
File metadata and controls
5417 lines (4683 loc) · 237 KB
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
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2015-2024 Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*
* 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
*
* 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.
*
* -----------------------------------------------------------------------------
*
* Project: CMSIS-Driver Validation
* Title: Universal Synchronous Asynchronous Receiver/Transmitter (USART)
* Driver Validation tests
*
* -----------------------------------------------------------------------------
*/
#ifndef __DOXYGEN__ // Exclude form the documentation
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cmsis_dv.h"
#include "DV_USART_Config.h"
#include "DV_Framework.h"
#include "Driver_USART.h"
// Fixed settings for communication with USART Server (not available through DV_USART_Config.h)
#define USART_CFG_SRV_BAUDRATE 115200 // Baudrate
#define USART_CFG_SRV_DATA_BITS 8 // 8 data bits
#define USART_CFG_SRV_PARITY 0 // None
#define USART_CFG_SRV_STOP_BITS 0 // 1 stop bit
#define USART_CFG_SRV_FLOW_CONTROL 0 // None
// Check configuration
#if (USART_CFG_TEST_MODE == 1) // If USART Server is selected
#if (USART_CFG_DEF_MODE == 1) // If default mode is Asynchronous
#if (USART_CFG_SRV_MODE != 1) // If USART Server mode is not Asynchronous
#warning When USART Server Test Mode is used and Default settings for Tests Mode (USART_CFG_DEF_MODE) is Asynchronous then Mode for USART Server (USART_CFG_SRV_MODE) must also be Asynchronous!
#endif
#elif (USART_CFG_DEF_MODE == 2) // If default mode is Synchronous Master
#if (USART_CFG_SRV_MODE != 1) // If USART Server mode is not Asynchronous
#warning When USART Server Test Mode is used and Default settings for Tests Mode (USART_CFG_DEF_MODE) is Synchronous Master then Mode for USART Server (USART_CFG_SRV_MODE) must be Asynchronous!
#endif
#elif (USART_CFG_DEF_MODE == 3) // If default mode is Synchronous Slave
#if (USART_CFG_SRV_MODE != 1) // If USART Server mode is not Asynchronous
#warning When USART Server Test Mode is used and Default settings for Tests Mode (USART_CFG_DEF_MODE) is Synchronous Slave then Mode for USART Server (USART_CFG_SRV_MODE) must be Asynchronous!
#endif
#elif (USART_CFG_DEF_MODE == 4) // If default mode is Single-wire
#if (USART_CFG_SRV_MODE != 4) // If USART Server mode is not Single-wire
#warning When USART Server Test Mode is used and Default settings for Tests Mode (USART_CFG_DEF_MODE) is Single-wire then Mode for USART Server (USART_CFG_SRV_MODE) must also be Single-wire!
#endif
#elif (USART_CFG_DEF_MODE == 5) // If default mode is IrDA
#if (USART_CFG_SRV_MODE != 5) // If USART Server mode is not IrDA
#warning When USART Server Test Mode is used and Default settings for Tests Mode (USART_CFG_DEF_MODE) is Single-wire then Mode for USART Server (USART_CFG_SRV_MODE) must also be Single-wire!
#endif
#else
#warning Unknown Default settings for Tests Mode (USART_CFG_DEF_MODE)!
#endif
#else // If Loopback is selected
#if (USART_CFG_DEF_MODE != 1) // If default mode is not Asynchronous
#error For Loopback Test Mode only Default settings for Tests Mode (USART_CFG_DEF_MODE) Asynchronous setting is supported!
#endif
#endif
#define CMD_LEN 32UL // Length of command to USART Server
#define RESP_GET_VER_LEN 16UL // Length of response from USART Server to GET VER command
#define RESP_GET_CAP_LEN 32UL // Length of response from USART Server to GET CAP command
#define RESP_GET_CNT_LEN 16UL // Length of response from USART Server to GET CNT command
#define RESP_GET_BRK_LEN 1UL // Length of response from USART Server to GET BRK command
#define RESP_GET_MDM_LEN 1UL // Length of response from USART Server to GET MDM command
#define OP_SEND 0UL // Send operation
#define OP_RECEIVE 1UL // Receive operation
#define OP_TRANSFER 2UL // Transfer operation (in synchronous mode only)
#define OP_RECEIVE_SEND_LB 3UL // Loopback testing Receive and Send operation (in asynchronous mode only)
#define OP_ABORT_SEND 4UL // Abort send operation
#define OP_ABORT_RECEIVE 5UL // Abort receive operation
#define OP_ABORT_TRANSFER 6UL // Abort transfer operation
#define MODE_ASYNCHRONOUS 1UL // UART (Asynchronous)
#define MODE_SYNCHRONOUS_MASTER 2UL // Synchronous Master (generates clock signal)
#define MODE_SYNCHRONOUS_SLAVE 3UL // Synchronous Slave (external clock signal)
#define MODE_SINGLE_WIRE 4UL // UART Single-wire (half-duplex)
#define MODE_IRDA 5UL // UART IrDA
#define MODE_SMART_CARD 6UL // UART Smart Card
#define PARITY_NONE 0UL // No parity
#define PARITY_EVEN 1UL // Even Parity
#define PARITY_ODD 2UL // Odd Parity
#define STOP_BITS_1 0UL // 1 Stop bit
#define STOP_BITS_2 1UL // 2 Stop bits
#define STOP_BITS_1_5 2UL // 1.5 Stop bits
#define STOP_BITS_0_5 3UL // 0.5 Stop bits
#define FLOW_CONTROL_NONE 0UL // No flow control signal
#define FLOW_CONTROL_RTS 1UL // RTS flow control signal
#define FLOW_CONTROL_CTS 2UL // CTS flow control signal
#define FLOW_CONTROL_RTS_CTS 3UL // RTS and CTS flow control signal
#define CPOL0 0UL // Clock Polarity 0
#define CPOL1 1UL // Clock Polarity 1
#define CPHA0 0UL // Clock Phase 0
#define CPHA1 1UL // Clock Phase 1
#define RTS_AVAILABLE 1UL // Mask of RTS line available
#define CTS_AVAILABLE 2UL // Mask of CTS line available
#define DTR_AVAILABLE 4UL // Mask of DTR line available
#define DSR_AVAILABLE 8UL // Mask of DSR line available
#define DCD_AVAILABLE 16UL // Mask of DCD line available
#define RI_AVAILABLE 32UL // Mask of RI line available
#define RTS_ON 1UL // Set RTS to active state
#define DTR_ON 2UL // Set DTR to active state
#define TO_DCD_ON 4UL // Set line driving DCD on USART Client to active state
#define TO_RI_ON 8UL // Set line driving RI on USART Client to active state
#define DRIVER_DATA_BITS(x) ((x == 9U) ? ARM_USART_DATA_BITS_9 : ((x == 8U) ? ARM_USART_DATA_BITS_8 : (((x) << ARM_USART_DATA_BITS_Pos) & ARM_USART_DATA_BITS_Msk)))
// Testing Configuration definitions
#if (USART_CFG_TEST_MODE != 0)
#define USART_SERVER_USED 1
#else
#define USART_SERVER_USED 0
#endif
// Prepare values for default setting
#define USART_CFG_DEF_MODE_VAL ((USART_CFG_DEF_MODE << ARM_USART_CONTROL_Pos) & ARM_USART_CONTROL_Msk)
#if (USART_CFG_DEF_DATA_BITS == 5U)
#define USART_CFG_DEF_DATA_BITS_VAL (ARM_USART_DATA_BITS_5)
#elif (USART_CFG_DEF_DATA_BITS == 6U)
#define USART_CFG_DEF_DATA_BITS_VAL (ARM_USART_DATA_BITS_6)
#elif (USART_CFG_DEF_DATA_BITS == 7U)
#define USART_CFG_DEF_DATA_BITS_VAL (ARM_USART_DATA_BITS_7)
#elif (USART_CFG_DEF_DATA_BITS == 8U)
#define USART_CFG_DEF_DATA_BITS_VAL (ARM_USART_DATA_BITS_8)
#elif (USART_CFG_DEF_DATA_BITS == 9U)
#define USART_CFG_DEF_DATA_VAL (ARM_USART_DATA_BITS_9)
#endif
#define USART_CFG_DEF_PARITY_VAL ((USART_CFG_DEF_PARITY << ARM_USART_PARITY_Pos) & ARM_USART_PARITY_Msk)
#define USART_CFG_DEF_STOP_BITS_VAL ((USART_CFG_DEF_STOP_BITS << ARM_USART_STOP_BITS_Pos) & ARM_USART_STOP_BITS_Msk)
#define USART_CFG_DEF_FLOW_CONTROL_VAL ((USART_CFG_DEF_FLOW_CONTROL << ARM_USART_FLOW_CONTROL_Pos) & ARM_USART_FLOW_CONTROL_Msk)
#define USART_CFG_DEF_CPOL_VAL ((USART_CFG_DEF_CPOL << ARM_USART_CPOL_Pos) & ARM_USART_CPOL_Msk)
#define USART_CFG_DEF_CPHA_VAL ((USART_CFG_DEF_CPHA << ARM_USART_CPHA_Pos) & ARM_USART_CPHA_Msk)
// Check if timeout setting is valid
#if (USART_CFG_XFER_TIMEOUT <= 2U)
#error Transfer timeout must be longer than 2ms!
#endif
// Check if default number of items setting is valid
#if (USART_CFG_DEF_NUM == 0)
#error Default number of items to test must not be 0!
#endif
// Determine maximum number of items used for testing
#define USART_NUM_MAX USART_CFG_DEF_NUM
#if (USART_CFG_NUM1 > USART_NUM_MAX)
#undef USART_NUM_MAX
#define USART_NUM_MAX USART_CFG_NUM1
#endif
#if (USART_CFG_NUM2 > USART_NUM_MAX)
#undef USART_NUM_MAX
#define USART_NUM_MAX USART_CFG_NUM2
#endif
#if (USART_CFG_NUM3 > USART_NUM_MAX)
#undef USART_NUM_MAX
#define USART_NUM_MAX USART_CFG_NUM3
#endif
#if (USART_CFG_NUM4 > USART_NUM_MAX)
#undef USART_NUM_MAX
#define USART_NUM_MAX USART_CFG_NUM4
#endif
#if (USART_CFG_NUM5 > USART_NUM_MAX)
#undef USART_NUM_MAX
#define USART_NUM_MAX USART_CFG_NUM5
#endif
// Calculate maximum required buffer size
#if (USART_CFG_DEF_DATA_BITS > 8)
#define USART_BUF_MAX (USART_NUM_MAX * 2U)
#else
#define USART_BUF_MAX (USART_NUM_MAX)
#endif
typedef struct { // USART Server version structure
uint8_t major; // Version major number
uint8_t minor; // Version minor number
uint16_t patch; // Version patch (revision) number
} USART_SERV_VER_t;
typedef struct { // USART Server capabilities structure
uint32_t mode_mask; // Mode mask
uint32_t db_mask; // Data Bits mask
uint32_t parity_mask; // Parity mask
uint32_t sb_mask; // Stop Bits mask
uint32_t fc_mask; // Flow Control mask
uint32_t ml_mask; // Modem lines mask
uint32_t br_min; // Min baudrate
uint32_t br_max; // Max baudrate
} USART_SERV_CAP_t;
// Register Driver_USART#
#define _ARM_Driver_USART_(n) Driver_USART##n
#define ARM_Driver_USART_(n) _ARM_Driver_USART_(n)
extern ARM_DRIVER_USART ARM_Driver_USART_(DRV_USART);
static ARM_DRIVER_USART *drv = &ARM_Driver_USART_(DRV_USART);
// Local variables (used in this module only)
static int8_t buffers_ok;
static int8_t driver_ok;
static int8_t server_ok;
static USART_SERV_VER_t usart_serv_ver;
static USART_SERV_CAP_t usart_serv_cap;
static ARM_USART_CAPABILITIES drv_cap;
static volatile uint32_t event;
static volatile uint32_t duration;
static volatile uint32_t xfer_count;
static volatile uint32_t tx_count_sample, rx_count_sample;
static volatile uint8_t modem_status;
static volatile uint8_t break_status;
static uint32_t systick_freq;
static uint32_t ticks_per_ms;
static osEventFlagsId_t event_flags;
static char msg_buf[512];
// Allocated buffer pointers
static void *ptr_tx_buf_alloc;
static void *ptr_rx_buf_alloc;
static void *ptr_cmp_buf_alloc;
// Buffer pointers used for data transfers (must be aligned to 4 byte)
static uint8_t *ptr_tx_buf;
static uint8_t *ptr_rx_buf;
static uint8_t *ptr_cmp_buf;
// String representation of various codes
static const char *str_srv_status[] = {
"Ok",
"Failed"
};
static const char *str_test_mode[] = {
"Loopback",
"USART Server"
};
static const char *str_oper[] = {
"Send ",
"Receive ",
"Transfer",
"Receive/Send LB",
"Abort Send ",
"Abort Receive ",
"Abort Transfer"
};
static const char *str_mode[] = {
"None",
"Asynchronous",
"Synchronous Master",
"Synchronous Slave",
"Single-wire",
"IrDA",
"Smart Card"
};
static const char *str_parity[] = {
"None",
"Even",
"Odd"
};
static const char *str_stop_bits[] = {
"1",
"2",
"1.5",
"0.5"
};
static const char *str_flow_control[] = {
"None",
"CTS",
"RTS",
"RTS/CTS",
};
static const char *str_cpol[] = {
"CPOL0",
"CPOL1"
};
static const char *str_cpha[] = {
"CPHA0",
"CPHA1"
};
static const char *str_ret[] = {
"ARM_DRIVER_OK",
"ARM_DRIVER_ERROR",
"ARM_DRIVER_ERROR_BUSY",
"ARM_DRIVER_ERROR_TIMEOUT",
"ARM_DRIVER_ERROR_UNSUPPORTED",
"ARM_DRIVER_ERROR_PARAMETER",
"ARM_DRIVER_ERROR_SPECIFIC",
"ARM_USART_ERROR_MODE",
"ARM_USART_ERROR_BAUDRATE",
"ARM_USART_ERROR_DATA_BITS",
"ARM_USART_ERROR_PARITY",
"ARM_USART_ERROR_STOP_BITS",
"ARM_USART_ERROR_FLOW_CONTROL",
"ARM_USART_ERROR_CPOL",
"ARM_USART_ERROR_CPHA"
};
// Local functions
#if (USART_SERVER_USED == 1) // If Test Mode USART Server is selected
static int32_t ComConfigDefault (void);
static int32_t ComSendCommand (const void *data_out, uint32_t len);
static int32_t ComReceiveResponse ( void *data_in, uint32_t len);
static int32_t CmdGetVer (void);
static int32_t CmdGetCap (void);
static int32_t CmdSetBufTx (char pattern);
static int32_t CmdSetBufRx (char pattern);
static int32_t CmdGetBufRx (uint32_t len);
static int32_t CmdSetCom (uint32_t mode, uint32_t data_bits, uint32_t parity, uint32_t stop_bits, uint32_t flow_control, uint32_t cpol, uint32_t cpha, uint32_t baudrate);
static int32_t CmdXfer (uint32_t dir, uint32_t num, uint32_t delay, uint32_t timeout, uint32_t num_cts);
static int32_t CmdGetCnt (void);
static int32_t CmdSetBrk (uint32_t delay, uint32_t duration);
static int32_t CmdGetBrk (void);
static int32_t CmdSetMdm (uint32_t mdm_ctrl, uint32_t delay, uint32_t duration);
static int32_t CmdGetMdm (void);
static int32_t ServerInit (void);
static int32_t ServerCheck (uint32_t mode, uint32_t data_bits, uint32_t parity, uint32_t stop_bits, uint32_t flow_control, uint32_t modem_line, uint32_t baudrate);
#endif
static int32_t IsNotLoopback (void);
static int32_t IsNotSync (void);
static int32_t IsNotAsync (void);
static int32_t IsNotSyncMaster (void);
static int32_t IsNotSingleWire (void);
static uint32_t DataBitsToBytes (uint32_t data_bits);
static int32_t DriverInit (void);
static int32_t BuffersCheck (void);
static int32_t DriverCheck (uint32_t mode, uint32_t flow_control, uint32_t modem_line_mask);
static void USART_DataExchange_Operation (uint32_t operation, uint32_t mode, uint32_t data_bits, uint32_t parity, uint32_t stop_bits, uint32_t flow_control, uint32_t cpol, uint32_t cpha, uint32_t baudrate, uint32_t num);
// Helper functions
/*
\fn void USART_DrvEvent (uint32_t evt)
\brief Store event(s) into a global variable.
\detail This is a callback function called by the driver upon an event(s).
\param[in] evt USART event
\return none
*/
static void USART_DrvEvent (uint32_t evt) {
event |= evt;
(void)osEventFlagsSet(event_flags, evt);
}
/*
\fn static uint32_t DataBitsToBytes (uint32_t data_bits)
\brief Calculate number of bytes used for an item at required data bits.
\return number of bytes per item
*/
static uint32_t DataBitsToBytes (uint32_t data_bits) {
uint32_t ret;
ret = 1U;
if (data_bits > 8U) {
ret = 2U;
}
return ret;
}
/*
\fn static int32_t DriverInit (void)
\brief Initialize and power-on the driver.
\return execution status
- EXIT_SUCCESS: Driver initialized and powered-up successfully
- EXIT_FAILURE: Driver initialization or power-up failed
*/
static int32_t DriverInit (void) {
if (drv->Initialize (USART_DrvEvent) == ARM_DRIVER_OK) {
if (drv->PowerControl(ARM_POWER_FULL) == ARM_DRIVER_OK) {
return EXIT_SUCCESS;
}
}
TEST_FAIL_MESSAGE("[FAILED] USART driver initialize or power-up. Check driver Initialize and PowerControl functions! Test aborted!");
return EXIT_FAILURE;
}
/*
\fn static int32_t IsNotLoopback (void)
\brief Check if loopback is not selected.
\detail This function is used to skip executing a test if it is not supported
in Loopback mode.
\return execution status
- EXIT_SUCCESS: Loopback is not selected
- EXIT_FAILURE: Loopback is selected
*/
static int32_t IsNotLoopback (void) {
#if (USART_SERVER_USED == 1)
return EXIT_SUCCESS;
#else
TEST_MESSAGE("[WARNING] Test not supported in Loopback Test Mode! Test not executed!");
return EXIT_FAILURE;
#endif
}
/*
\fn static int32_t IsNotSync (void)
\brief Check if Synchronous Slave/Master mode is not selected as default mode.
\detail This function is used to skip executing a test if it is not supported
in Synchronous mode.
\return execution status
- EXIT_SUCCESS: Synchronous mode is not selected
- EXIT_FAILURE: Synchronous mode is selected
*/
static int32_t IsNotSync (void) {
#if ((USART_CFG_DEF_MODE != MODE_SYNCHRONOUS_MASTER) && (USART_CFG_DEF_MODE != MODE_SYNCHRONOUS_SLAVE))
return EXIT_SUCCESS;
#else
TEST_MESSAGE("[WARNING] Test not supported for Synchronous Mode! Test not executed!");
return EXIT_FAILURE;
#endif
}
/*
\fn static int32_t IsNotSyncMaster (void)
\brief Check if Synchronous Master mode is not selected as default mode.
\detail This function is used to skip executing a test if it is not supported
in Synchronous Master mode.
\return execution status
- EXIT_SUCCESS: Synchronous Master mode is not selected
- EXIT_FAILURE: Synchronous Master mode is selected
*/
static int32_t IsNotSyncMaster (void) {
#if (USART_CFG_DEF_MODE != MODE_SYNCHRONOUS_MASTER)
return EXIT_SUCCESS;
#else
TEST_MESSAGE("[WARNING] Test not supported for Synchronous Master Mode! Test not executed!");
return EXIT_FAILURE;
#endif
}
/*
\fn static int32_t IsNotAsync (void)
\brief Check if Asynchronous/Single-wire/IrDA modes are not selected as default mode.
\detail This function is used to skip executing a test if it is not supported
in Asynchronous/Single-wire/IrDA mode.
\return execution status
- EXIT_SUCCESS: Asynchronous/Single-wire/IrDA mode is not selected
- EXIT_FAILURE: Asynchronous/Single-wire/IrDA mode is selected
*/
static int32_t IsNotAsync (void) {
#if ((USART_CFG_DEF_MODE != MODE_ASYNCHRONOUS) && (USART_CFG_DEF_MODE != MODE_SINGLE_WIRE) && (USART_CFG_DEF_MODE != MODE_IRDA))
return EXIT_SUCCESS;
#else
TEST_MESSAGE("[WARNING] Test not supported for Asynchronous/Single-wire/IrDA Mode! Test not executed!");
return EXIT_FAILURE;
#endif
}
/*
\fn static int32_t IsNotSingleWire (void)
\brief Check if Single-wire mode is not selected as default mode.
\detail This function is used to skip executing a test if it is not supported
in Single-wire mode.
\return execution status
- EXIT_SUCCESS: Single-wire mode is not selected
- EXIT_FAILURE: Single-wire mode is selected
*/
static int32_t IsNotSingleWire (void) {
#if (USART_CFG_DEF_MODE != MODE_SINGLE_WIRE)
return EXIT_SUCCESS;
#else
TEST_MESSAGE("[WARNING] Test not supported for Single-wire Mode! Test not executed!");
return EXIT_FAILURE;
#endif
}
/*
\fn static int32_t BuffersCheck (void)
\brief Check if buffers are valid.
\return execution status
- EXIT_SUCCESS: Buffers are valid
- EXIT_FAILURE: Buffers are not valid
*/
static int32_t BuffersCheck (void) {
if ((ptr_tx_buf != NULL) &&
(ptr_rx_buf != NULL) &&
(ptr_cmp_buf != NULL)) {
return EXIT_SUCCESS;
}
TEST_FAIL_MESSAGE("[FAILED] Invalid data buffers! Increase heap memory! Test aborted!");
return EXIT_FAILURE;
}
/*
\fn static int32_t DriverCheck (uint32_t mode, uint32_t flow_control, uint32_t modem_line_mask, uint32_t baudrate)
\brief Check if USART Driver supports desired settings.
\param[in] mode mode:
- value 1 = Asynchronous
- value 2 = Synchronous Master
- value 3 = Synchronous Slave
- value 4 = Single Wire
- value 5 = IrDA
- value 6 = Smart Card
\param[in] flow_control flow control:
- value 0 = None
- value 1 = CTS
- value 2 = RTS
- value 3 = RTS/CTS
\param[in] modem_line_mask modem line mask:
- bit 0. = RTS
- bit 1. = CTS
- bit 2. = DTR
- bit 3. = DSR
- bit 4. = DCD
- bit 5. = RI
\return execution status
- EXIT_SUCCESS: USART Driver supports desired settings
- EXIT_FAILURE: USART Driver does not support desired settings
*/
static int32_t DriverCheck (uint32_t mode, uint32_t flow_control, uint32_t modem_line_mask) {
int32_t ret;
ret = EXIT_SUCCESS;
switch (mode) {
case 1: // Asynchronous
if (drv_cap.asynchronous == 0U) {
ret = EXIT_FAILURE;
}
break;
case 2: // Synchronous master
if (drv_cap.synchronous_master == 0U) {
ret = EXIT_FAILURE;
}
break;
case 3: // Synchronous slave
if (drv_cap.synchronous_slave == 0U) {
ret = EXIT_FAILURE;
}
break;
case 4: // Single-wire
if (drv_cap.single_wire == 0U) {
ret = EXIT_FAILURE;
}
break;
case 5: // IrDA
if (drv_cap.irda == 0U) {
ret = EXIT_FAILURE;
}
break;
case 6: // Samrt Card
if (drv_cap.irda == 0U) {
ret = EXIT_FAILURE;
}
break;
default:
ret = EXIT_FAILURE;
break;
}
if (ret != EXIT_SUCCESS) {
// If USART Driver does not support desired mode
if (mode <= 6U) {
(void)snprintf(msg_buf, sizeof(msg_buf), "[FAILED] USART Driver does not support %s mode! Test aborted!", str_mode[mode]);
} else {
(void)snprintf(msg_buf, sizeof(msg_buf), "[FAILED] USART Driver does not support unknown mode! Test aborted!");
}
TEST_MESSAGE(msg_buf);
return EXIT_FAILURE;
}
switch (flow_control) {
case 0: // None
break;
case 1: // CTS
if (drv_cap.flow_control_cts == 0U) {
ret = EXIT_FAILURE;
}
break;
case 2: // RTS
if (drv_cap.flow_control_rts == 0U) {
ret = EXIT_FAILURE;
}
break;
case 3: // RTS/CTS
if ((drv_cap.flow_control_cts == 0U) || (drv_cap.flow_control_rts == 0U)) {
ret = EXIT_FAILURE;
}
break;
default:
ret = EXIT_FAILURE;
break;
}
if (ret != EXIT_SUCCESS) {
// If USART Driver does not support desired flow control
if (mode <= 3U) {
(void)snprintf(msg_buf, sizeof(msg_buf), "[FAILED] USART Driver does not support %s flow control! Test aborted!", str_flow_control[flow_control]);
} else {
(void)snprintf(msg_buf, sizeof(msg_buf), "[FAILED] USART Driver does not support unknown flow control! Test aborted!");
}
TEST_MESSAGE(msg_buf);
return EXIT_FAILURE;
}
if ((modem_line_mask & 1U) != 0U) {
if (drv_cap.rts == 0U) {
TEST_MESSAGE("[FAILED] USART Driver does not support RTS modem line! Test aborted!");
return EXIT_FAILURE;
}
}
if ((modem_line_mask & (1U << 1)) != 0U) {
if (drv_cap.cts == 0U) {
TEST_MESSAGE("[FAILED] USART Driver does not support CTS modem line! Test aborted!");
return EXIT_FAILURE;
}
}
if ((modem_line_mask & (1U << 2)) != 0U) {
if (drv_cap.dtr == 0U) {
TEST_MESSAGE("[FAILED] USART Driver does not support DTR modem line! Test aborted!");
return EXIT_FAILURE;
}
}
if ((modem_line_mask & (1U << 3)) != 0U) {
if (drv_cap.dsr == 0U) {
TEST_MESSAGE("[FAILED] USART Driver does not support DSR modem line! Test aborted!");
return EXIT_FAILURE;
}
}
if ((modem_line_mask & (1U << 4)) != 0U) {
if (drv_cap.dcd == 0U) {
TEST_MESSAGE("[FAILED] USART Driver does not support DCD modem line! Test aborted!");
return EXIT_FAILURE;
}
}
if ((modem_line_mask & (1U << 5)) != 0U) {
if (drv_cap.ri == 0U) {
TEST_MESSAGE("[FAILED] USART Driver does not support RI modem line! Test aborted!");
return EXIT_FAILURE;
}
}
return ret;
}
#if (USART_SERVER_USED == 1) // If Test Mode USART Server is selected
/*
\fn static int32_t ComConfigDefault (void)
\brief Configure USART Communication Interface to USART Server default communication configuration.
\return execution status
- EXIT_SUCCESS: Default configuration set successfully
- EXIT_FAILURE: Default configuration failed
*/
static int32_t ComConfigDefault (void) {
int32_t ret;
ret = EXIT_SUCCESS;
if (drv->Control(((USART_CFG_SRV_MODE << ARM_USART_CONTROL_Pos) & ARM_USART_CONTROL_Msk) |
DRIVER_DATA_BITS(USART_CFG_SRV_DATA_BITS) |
((USART_CFG_SRV_PARITY << ARM_USART_PARITY_Pos) & ARM_USART_PARITY_Msk) |
((USART_CFG_SRV_STOP_BITS << ARM_USART_STOP_BITS_Pos) & ARM_USART_STOP_BITS_Msk) |
((USART_CFG_SRV_FLOW_CONTROL << ARM_USART_FLOW_CONTROL_Pos) & ARM_USART_FLOW_CONTROL_Msk) ,
USART_CFG_SRV_BAUDRATE) != ARM_DRIVER_OK) {
ret = EXIT_FAILURE;
}
if (drv->Control(ARM_USART_CONTROL_TX, 1U) != ARM_DRIVER_OK) {
ret = EXIT_FAILURE;
}
if (ret != EXIT_SUCCESS) {
TEST_FAIL_MESSAGE("[FAILED] Configure communication interface to USART Server default settings. Check driver Control function! Test aborted!");
}
return ret;
}
/**
\fn static int32_t ComSendCommand (const void *data_out, uint32_t num)
\brief Send command to USART Server.
\param[out] data_out Pointer to memory containing data to be sent
\param[in] len Number of bytes to be sent
\return execution status
- EXIT_SUCCESS: Command sent successfully
- EXIT_FAILURE: Command send failed
*/
static int32_t ComSendCommand (const void *data_out, uint32_t len) {
int32_t ret;
uint32_t flags, num, tout;
ret = EXIT_SUCCESS;
num = (len + DataBitsToBytes(USART_CFG_SRV_DATA_BITS) - 1U) / DataBitsToBytes(USART_CFG_SRV_DATA_BITS);
ret = ComConfigDefault();
if (ret == EXIT_SUCCESS) {
(void)osEventFlagsClear(event_flags, 0x7FFFFFFFU);
if (drv->Control(ARM_USART_CONTROL_TX, 1U) != ARM_DRIVER_OK) {
ret = EXIT_FAILURE;
}
if (ret == EXIT_SUCCESS) {
if (drv->Send(data_out, num) != ARM_DRIVER_OK) {
ret = EXIT_FAILURE;
}
if (ret == EXIT_SUCCESS) {
if (drv_cap.event_tx_complete != 0U) {
// If ARM_USART_EVENT_TX_COMPLETE is supported, wait for it
flags = osEventFlagsWait(event_flags, ARM_USART_EVENT_TX_COMPLETE, osFlagsWaitAny, USART_CFG_SRV_CMD_TOUT);
if (((flags & 0x80000000U) != 0U) ||
((flags & ARM_USART_EVENT_TX_COMPLETE) == 0U)) {
ret = EXIT_FAILURE;
}
} else {
// Otherwise wait for ARM_USART_EVENT_SEND_COMPLETE flag
flags = osEventFlagsWait(event_flags, ARM_USART_EVENT_SEND_COMPLETE, osFlagsWaitAny, USART_CFG_SRV_CMD_TOUT);
if (((flags & 0x80000000U) != 0U) ||
((flags & ARM_USART_EVENT_SEND_COMPLETE) == 0U)) {
ret = EXIT_FAILURE;
}
if (ret == EXIT_SUCCESS) {
// If completed event was signaled, wait for all data to be sent
for (tout = USART_CFG_SRV_CMD_TOUT; tout != 0U; tout--) {
if ((drv->GetTxCount() == len) && (drv->GetStatus().tx_busy == 0U)) {
break;
}
(void)osDelay(1U);
}
}
}
}
if (ret == EXIT_FAILURE) {
(void)drv->Control(ARM_USART_ABORT_SEND, 0U);
}
}
}
(void)drv->Control(ARM_USART_CONTROL_TX, 0U);
return ret;
}
/**
\fn static int32_t ComReceiveResponse (void *data_in, uint32_t num)
\brief Receive response from USART Server.
\param[out] data_in Pointer to memory where data will be received
\param[in] len Number of data bytes to be received
\return execution status
- EXIT_SUCCESS: Command received successfully
- EXIT_FAILURE: Command reception failed
*/
static int32_t ComReceiveResponse (void *data_in, uint32_t len) {
int32_t ret;
uint32_t flags, num;
ret = EXIT_SUCCESS;
num = (len + DataBitsToBytes(USART_CFG_SRV_DATA_BITS) - 1U) / DataBitsToBytes(USART_CFG_SRV_DATA_BITS);
ret = ComConfigDefault();
if (ret == EXIT_SUCCESS) {
(void)osEventFlagsClear(event_flags, 0x7FFFFFFFU);
if (drv->Control(ARM_USART_CONTROL_RX, 1U) != ARM_DRIVER_OK) {
ret = EXIT_FAILURE;
}
if (ret == EXIT_SUCCESS) {
if (drv->Receive(data_in, num) != ARM_DRIVER_OK) {
ret = EXIT_FAILURE;
}
if (ret == EXIT_SUCCESS) {
flags = osEventFlagsWait(event_flags, ARM_USART_EVENT_RECEIVE_COMPLETE, osFlagsWaitAny, USART_CFG_SRV_CMD_TOUT);
if (((flags & 0x80000000U) != 0U) ||
((flags & ARM_USART_EVENT_RECEIVE_COMPLETE) == 0U)) {
ret = EXIT_FAILURE;
}
}
if (ret == EXIT_FAILURE) {
drv->Control(ARM_USART_ABORT_RECEIVE, 0U);
}
}
}
(void)drv->Control(ARM_USART_CONTROL_RX, 0U);
return ret;
}
/**
\fn static int32_t CmdGetVer (void)
\brief Get version from USART Server and check that it is valid.
\return execution status
- EXIT_SUCCESS: Version retrieved successfully
- EXIT_FAILURE: Version retreival failed
*/
static int32_t CmdGetVer (void) {
int32_t ret;
const char *ptr_str;
uint16_t val16;
uint8_t val8;
ptr_str = NULL;
memset(&usart_serv_ver, 0, sizeof(usart_serv_ver));
// Send "GET VER" command to USART Server
memset(ptr_tx_buf, 0, CMD_LEN);
memcpy(ptr_tx_buf, "GET VER", 7);
ret = ComSendCommand(ptr_tx_buf, CMD_LEN);
if (ret == EXIT_SUCCESS) {
// Receive response to "GET VER" command from USART Server
memset(ptr_rx_buf, (int32_t)'?', RESP_GET_VER_LEN);
ret = ComReceiveResponse(ptr_rx_buf, RESP_GET_VER_LEN);
(void)osDelay(10U);
}
// Parse version
if (ret == EXIT_SUCCESS) {
// Parse major
ptr_str = (const char *)ptr_rx_buf;
if (sscanf(ptr_str, "%hhx", &val8) == 1) {
usart_serv_ver.major = val8;
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse minor
ptr_str = strstr(ptr_str, "."); // Find '.'
if (ptr_str != NULL) {
ptr_str++; // Skip '.'
if (sscanf(ptr_str, "%hhx", &val8) == 1) {
usart_serv_ver.minor = val8;
} else {
ret = EXIT_FAILURE;
}
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse patch (revision)
ptr_str = strstr(ptr_str, "."); // Find next '.'
if (ptr_str != NULL) {
ptr_str++; // Skip '.'
if (sscanf(ptr_str, "%hx", &val16) == 1) {
usart_serv_ver.patch = val16;
} else {
ret = EXIT_FAILURE;
}
} else {
ret = EXIT_FAILURE;
}
}
return ret;
}
/**
\fn static int32_t CmdGetCap (void)
\brief Get capabilities from USART Server.
\return execution status
- EXIT_SUCCESS: Capabilities retrieved successfully
- EXIT_FAILURE: Capabilities retreival failed
*/
static int32_t CmdGetCap (void) {
int32_t ret;
const char *ptr_str;
uint32_t val32;
uint8_t val8;
ptr_str = NULL;
memset(&usart_serv_cap, 0, sizeof(usart_serv_cap));
// Send "GET CAP" command to USART Server
memset(ptr_tx_buf, 0, CMD_LEN);
memcpy(ptr_tx_buf, "GET CAP", 7);
ret = ComSendCommand(ptr_tx_buf, CMD_LEN);
if (ret == EXIT_SUCCESS) {
(void)osDelay(20U); // Give USART Server 20 ms to auto-detect capabilities
// Receive response to "GET CAP" command from USART Server
memset(ptr_rx_buf, (int32_t)'?', RESP_GET_CAP_LEN);
ret = ComReceiveResponse(ptr_rx_buf, RESP_GET_CAP_LEN);
(void)osDelay(10U);
}
// Parse capabilities
if (ret == EXIT_SUCCESS) {
// Parse mode mask
ptr_str = (const char *)ptr_rx_buf;
if (sscanf(ptr_str, "%hhx", &val8) == 1) {
usart_serv_cap.mode_mask = val8;
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse data bit mask
ptr_str = strstr(ptr_str, ","); // Find ','
if (ptr_str != NULL) {
ptr_str++; // Skip ','
if (sscanf(ptr_str, "%x", &val32) == 1) {
usart_serv_cap.db_mask = val32;
} else {
ret = EXIT_FAILURE;
}
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse parity mask
ptr_str = strstr(ptr_str, ","); // Find next ','
if (ptr_str != NULL) {
ptr_str++; // Skip ','
if (sscanf(ptr_str, "%x", &val32) == 1) {
usart_serv_cap.parity_mask = val32;
} else {
ret = EXIT_FAILURE;
}
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse stop bit mask
ptr_str = strstr(ptr_str, ","); // Find next ','
if (ptr_str != NULL) {
ptr_str++; // Skip ','
if (sscanf(ptr_str, "%x", &val32) == 1) {
usart_serv_cap.sb_mask = val32;
} else {
ret = EXIT_FAILURE;
}
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse flow control mask
ptr_str = strstr(ptr_str, ","); // Find next ','
if (ptr_str != NULL) {
ptr_str++; // Skip ','
if (sscanf(ptr_str, "%x", &val32) == 1) {
usart_serv_cap.fc_mask = val32;
} else {
ret = EXIT_FAILURE;
}
} else {
ret = EXIT_FAILURE;
}
}
if ((ret == EXIT_SUCCESS) && (ptr_str != NULL)) {
// Parse modem lines mask
ptr_str = strstr(ptr_str, ","); // Find next ','
if (ptr_str != NULL) {
ptr_str++; // Skip ','
if (sscanf(ptr_str, "%x", &val32) == 1) {
usart_serv_cap.ml_mask = val32;
} else {
ret = EXIT_FAILURE;
}