-
Notifications
You must be signed in to change notification settings - Fork 4
/
cy_capsense_structure.c
1116 lines (1032 loc) · 45 KB
/
cy_capsense_structure.c
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
/***************************************************************************//**
* \file cy_capsense_structure.c
* \version 5.0
*
* \brief
* This file defines the data structure global variables and provides the
* implementation for the functions of the Data Structure module.
*
********************************************************************************
* \copyright
* Copyright 2018-2024, Cypress Semiconductor Corporation (an Infineon company)
* or an affiliate of Cypress Semiconductor Corporation. All rights reserved.
* You may use this file only in accordance with the license, terms, conditions,
* disclaimers, and limitations in the end user license agreement accompanying
* the software package with which this file was provided.
*******************************************************************************/
#include <stddef.h>
#include <string.h>
#include "cycfg_capsense_defines.h"
#include "cy_syslib.h"
#include "cy_utils.h"
#include "cy_capsense_common.h"
#include "cy_capsense_structure.h"
#include "cy_capsense_lib.h"
#include "cy_capsense_selftest.h"
#if (CY_CAPSENSE_PLATFORM_BLOCK_FOURTH_GEN)
#include "cy_csd.h"
#include "cy_capsense_sensing_v2.h"
#elif (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
#include "cy_msclp.h"
#include "cy_capsense_generator_lp.h"
#else /* (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) */
#include "cy_msc.h"
#include "cy_capsense_generator_v3.h"
#include "cy_capsense_sensing_v3.h"
#endif
#if (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2) || defined(CY_IP_M0S8MSCV3) || defined(CY_IP_M0S8MSCV3LP))
/*******************************************************************************
* Local definition
*******************************************************************************/
#define CY_CAPSENSE_DS_PARAM_TYPE_UINT8 (1u)
#define CY_CAPSENSE_DS_PARAM_TYPE_UINT16 (2u)
#define CY_CAPSENSE_DS_PARAM_TYPE_UINT32 (3u)
#define CY_CAPSENSE_UINT16_ALIGN_MASK (1u)
#define CY_CAPSENSE_UINT32_ALIGN_MASK (3u)
#define CY_CAPSENSE_PARAM_TYPE_OFFSET (24u)
#define CY_CAPSENSE_PARAM_TYPE_MASK (3uL << CY_CAPSENSE_PARAM_TYPE_OFFSET)
#define CY_CAPSENSE_PARAM_CRC_OFFSET (26u)
#define CY_CAPSENSE_PARAM_CRC_MASK (1uL << CY_CAPSENSE_PARAM_CRC_OFFSET)
#define CY_CAPSENSE_PARAM_WIDGET_OFFSET (16u)
#define CY_CAPSENSE_PARAM_WIDGET_MASK (0xFFuL << CY_CAPSENSE_PARAM_WIDGET_OFFSET)
#if (defined(CY_CAPSENSE_MULTI_PHASE_SELF_ENABLED))
#if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_MULTI_PHASE_SELF_ENABLED)
#define CY_CAPSENSE_MPSC_EN (CY_CAPSENSE_ENABLE)
#else
#define CY_CAPSENSE_MPSC_EN (CY_CAPSENSE_DISABLE)
#endif
#else
#define CY_CAPSENSE_MPSC_EN (CY_CAPSENSE_DISABLE)
#endif
/*******************************************************************************
* Function Name: Cy_CapSense_IsAnyWidgetActive
****************************************************************************//**
*
* Reports whether any widget has detected touch.
*
* This function reports whether any widget has detected a touch by extracting
* information from the widget status registers. This function does
* not process widget data but extracts previously processed results
* from the \ref group_capsense_structures.
*
* \note For the fifth-generation low power CAPSENSE™ widgets
* of the \ref CY_CAPSENSE_WD_LOW_POWER_E type are not processed,
* its status is not taken into account.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the touch detection status of all the widgets:
* - Zero - No touch is detected in any of the widgets or sensors.
* - Non-zero - At least one widget or sensor has detected a touch.
*
*******************************************************************************/
uint32_t Cy_CapSense_IsAnyWidgetActive(const cy_stc_capsense_context_t * context)
{
uint32_t capStatus = 0u;
uint32_t wdIndex;
for (wdIndex = CY_CAPSENSE_TOTAL_WIDGET_COUNT; wdIndex-- > 0u;)
{
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
if ((uint8_t)CY_CAPSENSE_WD_LOW_POWER_E != context->ptrWdConfig[wdIndex].wdType)
#endif /* CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP */
{
capStatus |= (uint32_t)context->ptrWdContext[wdIndex].status & CY_CAPSENSE_WD_ACTIVE_MASK;
}
}
return capStatus;
}
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
/*******************************************************************************
* Function Name: Cy_CapSense_IsAnyLpWidgetActive
****************************************************************************//**
*
* Reports whether any low power widget has detected a touch at the previous
* low power scan.
*
* This function reports whether any low power widget has detected a touch
* by extracting information from the common status register. The function does
* not process the widget data but extracts the result obtained at the previous
* low power widget scan. The result remains set up to the next low power widget
* scan and is reset with the low power scan start.
*
* \note
* This function is available only for the fifth-generation low power CAPSENSE™.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the touch detection status of all the widgets:
* - Zero - No touch is detected in any of the low power widgets or sensors
* - CY_CAPSENSE_MW_STATE_LP_ACTIVE_MASK - At least one low power widget or sensor
* has detected a touch at the previous scan
*
*******************************************************************************/
uint32_t Cy_CapSense_IsAnyLpWidgetActive(const cy_stc_capsense_context_t * context)
{
return ((uint32_t)context->ptrCommonContext->status & CY_CAPSENSE_MW_STATE_LP_ACTIVE_MASK);
}
#endif /* (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP) */
/*******************************************************************************
* Function Name: Cy_CapSense_IsWidgetActive
****************************************************************************//**
*
* Reports whether the specified widget detected touch on any of its sensors.
*
* This function reports whether the specified widget has detected a touch by
* extracting information from the widget status register.
* This function does not process widget data but extracts previously processed
* results from the \ref group_capsense_structures.
*
* \param widgetId
* Specifies the ID number of the widget. A macro for the widget ID can be found
* in the cycfg_capsense.h file defined as CY_CAPSENSE_<WIDGET_NAME>_WDGT_ID.
*
* \note For the fifth-generation low power CAPSENSE™ widgets
* of the \ref CY_CAPSENSE_WD_LOW_POWER_E type are not processed and a zero is returned.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the touch detection status of the specified widgets:
* - Zero - No touch is detected in the specified widget or a wrong widgetId
* is specified.
* - Non-zero if at least one sensor of the specified widget is active, i.e.
* a touch is detected.
*
*******************************************************************************/
uint32_t Cy_CapSense_IsWidgetActive(
uint32_t widgetId,
const cy_stc_capsense_context_t * context)
{
uint32_t capStatus = 0uL;
if (widgetId < CY_CAPSENSE_TOTAL_WIDGET_COUNT)
{
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
if ((uint8_t)CY_CAPSENSE_WD_LOW_POWER_E != context->ptrWdConfig[widgetId].wdType)
#endif /* CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP */
{
capStatus = (uint32_t)context->ptrWdContext[widgetId].status & CY_CAPSENSE_WD_ACTIVE_MASK;
}
}
return capStatus;
}
/*******************************************************************************
* Function Name: Cy_CapSense_IsSensorActive
****************************************************************************//**
*
* Reports whether the specified sensor in the widget is sensor detects a touch.
*
* This function reports whether the specified sensor in the widget has detected a
* touch by extracting information from the widget status register.
* This function does not process widget or sensor data but extracts previously
* processed results from the \ref group_capsense_structures.
*
* For proximity sensors, this function returns the proximity detection status.
* To get the touch status of proximity sensors, use the
* Cy_CapSense_IsProximitySensorActive() function.
*
* \param widgetId
* Specifies the ID number of the widget. A macro for the widget ID can be found
* in the cycfg_capsense.h file defined as CY_CAPSENSE_<WIDGET_NAME>_WDGT_ID.
*
* \note For the fifth-generation low power CAPSENSE™ widgets
* of the \ref CY_CAPSENSE_WD_LOW_POWER_E type are not processed and a zero is returned.
*
* \param sensorId
* Specifies the ID number of the sensor within the widget. A macro for the
* sensor ID within a specified widget can be found in the cycfg_capsense.h
* file defined as CY_CAPSENSE_<WIDGET_NAME>_SNS<SENSOR_NUMBER>_ID.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the touch detection status of the specified sensor/widget:
* - Zero if no touch is detected in the specified sensor/widget or a wrong
* widget ID/sensor ID is specified.
* - Non-zero if the specified sensor is active, i.e. touch is detected. If the
* specific sensor belongs to a proximity widget, the proximity detection
* status is returned.
*
*******************************************************************************/
uint32_t Cy_CapSense_IsSensorActive(
uint32_t widgetId,
uint32_t sensorId,
const cy_stc_capsense_context_t * context)
{
uint32_t capStatus = 0uL;
if ((widgetId < CY_CAPSENSE_TOTAL_WIDGET_COUNT) &&
(sensorId < context->ptrWdConfig[widgetId].numSns))
{
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
if ((uint8_t)CY_CAPSENSE_WD_LOW_POWER_E != context->ptrWdConfig[widgetId].wdType)
#endif /* CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP */
{
capStatus = context->ptrWdConfig[widgetId].ptrSnsContext[sensorId].status;
}
}
return capStatus;
}
#if (CY_CAPSENSE_DISABLE != CY_CAPSENSE_CSD_PROXIMITY_EN)
/*******************************************************************************
* Function Name: Cy_CapSense_IsProximitySensorActive
****************************************************************************//**
*
* Reports the status of the specified proximity widget/sensor.
*
* This function reports whether the specified proximity sensor has detected
* a touch or proximity event by extracting information from the widget
* status register. This function is used only with proximity widgets.
* This function does not process widget data but extracts previously processed
* results from the \ref group_capsense_structures.
*
* \param widgetId
* Specifies the ID number of the widget. A macro for the widget ID can be found
* in the cycfg_capsense.h file defined as CY_CAPSENSE_<WIDGET_NAME>_WDGT_ID.
*
* \param sensorId
* Specifies the ID number of the sensor within the widget. A macro for the
* sensor ID within a specified widget can be found in the cycfg_capsense.h
* file defined as CY_CAPSENSE_<WIDGET_NAME>_SNS<SENSOR_NUMBER>_ID.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the status of the specified sensor of the proximity widget. Zero
* indicates that no touch is detected in the specified sensor/widget or a
* wrong widgetId/proxId is specified.
* - Bits [31..2] are reserved.
* - Bit [1] indicates that a touch is detected.
* - Bit [0] indicates that a proximity is detected.
*
*******************************************************************************/
uint32_t Cy_CapSense_IsProximitySensorActive(
uint32_t widgetId,
uint32_t sensorId,
const cy_stc_capsense_context_t * context)
{
uint32_t capStatus = 0uL;
if (widgetId < CY_CAPSENSE_TOTAL_WIDGET_COUNT)
{
if ((uint8_t)CY_CAPSENSE_WD_PROXIMITY_E == context->ptrWdConfig[widgetId].wdType)
{
if (sensorId < context->ptrWdConfig[widgetId].numSns)
{
capStatus |= context->ptrWdConfig[widgetId].ptrSnsContext[sensorId].status;
}
}
}
return capStatus;
}
#endif /* (CY_CAPSENSE_DISABLE != CY_CAPSENSE_CSD_PROXIMITY_EN) */
#if ((CY_CAPSENSE_DISABLE != CY_CAPSENSE_TOUCHPAD_EN) ||\
(CY_CAPSENSE_DISABLE != CY_CAPSENSE_MATRIX_EN) ||\
(CY_CAPSENSE_DISABLE != CY_CAPSENSE_SLIDER_EN))
/*******************************************************************************
* Function Name: Cy_CapSense_GetTouchInfo
****************************************************************************//**
*
* Reports the details of touch position detected on the specified touchpad,
* matrix buttons or slider widgets.
*
* This function does not process widget data but extracts previously processed
* results from the \ref group_capsense_structures.
*
* \param widgetId
* Specifies the ID number of the widget. A macro for the widget ID can be found
* in the cycfg_capsense.h file defined as CY_CAPSENSE_<WIDGET_NAME>_WDGT_ID.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the pointer to widget cy_stc_capsense_touch_t structure that
* contains number of positions and data about each position.
*
*
*******************************************************************************/
cy_stc_capsense_touch_t * Cy_CapSense_GetTouchInfo(
uint32_t widgetId,
const cy_stc_capsense_context_t * context)
{
cy_stc_capsense_touch_t * ptrTouch = NULL;
const cy_stc_capsense_widget_config_t * ptrWdCfg;
if (widgetId < CY_CAPSENSE_TOTAL_WIDGET_COUNT)
{
ptrWdCfg = &context->ptrWdConfig[widgetId];
switch (ptrWdCfg->wdType)
{
case (uint8_t)CY_CAPSENSE_WD_TOUCHPAD_E:
case (uint8_t)CY_CAPSENSE_WD_MATRIX_BUTTON_E:
case (uint8_t)CY_CAPSENSE_WD_LINEAR_SLIDER_E:
case (uint8_t)CY_CAPSENSE_WD_RADIAL_SLIDER_E:
ptrTouch = &ptrWdCfg->ptrWdContext->wdTouch;
break;
default:
/* No action on other widget types */
break;
}
}
return ptrTouch;
}
#endif /* ((CY_CAPSENSE_DISABLE != CY_CAPSENSE_TOUCHPAD_EN) ||\
(CY_CAPSENSE_DISABLE != CY_CAPSENSE_MATRIX_EN) ||\
(CY_CAPSENSE_DISABLE != CY_CAPSENSE_SLIDER_EN)) */
/*******************************************************************************
* Function Name: Cy_CapSense_CheckConfigIntegrity
****************************************************************************//**
*
* Performs verification of CAPSENSE™ data structure initialization.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return status
* Returns status of operation:
* - Zero - Indicates successful initialization.
* - Non-zero - One or more errors occurred in the initialization process.
*
*******************************************************************************/
cy_capsense_status_t Cy_CapSense_CheckConfigIntegrity(const cy_stc_capsense_context_t * context)
{
cy_capsense_status_t capStatus = CY_CAPSENSE_STATUS_SUCCESS;
const cy_stc_capsense_common_config_t * ptrCommonCfg = context->ptrCommonConfig;
const cy_stc_capsense_common_context_t * ptrCommonCxt = context->ptrCommonContext;
const cy_stc_capsense_internal_context_t * ptrInternalCxt = context->ptrInternalContext;
const cy_stc_capsense_widget_config_t * ptrWdCfg = context->ptrWdConfig;
const cy_stc_capsense_widget_context_t * ptrWdCxt = context->ptrWdContext;
const cy_stc_capsense_pin_config_t * ptrPinCfg = context->ptrPinConfig;
const cy_stc_capsense_active_scan_sns_t * ptrActScanSns = context->ptrActiveScanSns;
if (ptrCommonCfg == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
if (ptrCommonCxt == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
if (ptrInternalCxt == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
if (ptrWdCfg == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
if (ptrWdCxt == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
if (ptrPinCfg == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
if (ptrActScanSns == NULL) {capStatus = CY_CAPSENSE_STATUS_BAD_DATA;}
return capStatus;
}
/*******************************************************************************
* Function Name: Cy_CapSense_GetCRC
****************************************************************************//**
*
* Calculates CRC for the specified buffer and length.
*
* This API is used for the CRC protection of a packet received from
* the CAPSENSE™ Tuner tool and for BIST operations.
* CRC polynomial is 0xAC9A. It has a Hamming distance 5 for data words
* up to 241 bits.
*
* Reference: "P. Koopman, T. Chakravarthy,
* "Cyclic Redundancy Code (CRC) Polynomial Selection for Embedded Networks",
* The International Conference on Dependable Systems and Networks, DSN-2004"
*
* \param ptrData
* The pointer to the data.
*
* \param len
* The length of the data in bytes.
*
* \return
* Returns a calculated CRC-16 value.
*
*******************************************************************************/
uint16_t Cy_CapSense_GetCRC(const uint8_t *ptrData, uint32_t len)
{
uint32_t idx;
uint32_t actualCrc = 0u;
uint32_t length = len;
const uint8_t * ptrDataLocal = ptrData;
const uint16_t crcTable[] =
{
0x0000u, 0xAC9Au, 0xF5AEu, 0x5934u, 0x47C6u, 0xEB5Cu, 0xB268u, 0x1EF2u,
0x8F8Cu, 0x2316u, 0x7A22u, 0xD6B8u, 0xC84Au, 0x64D0u, 0x3DE4u, 0x917Eu
};
for (;length-- > 0u;)
{
/* Process HI Nibble */
idx = ((actualCrc >> 12u) ^ (((uint32_t)*ptrDataLocal) >> 4u)) & 0xFLu;
actualCrc = crcTable[idx] ^ (actualCrc << 4u);
/* Process LO Nibble */
idx = ((actualCrc >> 12u) ^ (uint32_t)*ptrDataLocal) & 0xFLu;
actualCrc = crcTable[idx] ^ (actualCrc << 4u);
ptrDataLocal++;
}
return (uint16_t)actualCrc;
}
/*******************************************************************************
* Function Name: Cy_CapSense_GetCrcWidget
****************************************************************************//**
*
* Calculates CRC for the specified widget. This function implements the
* following functionality:
* - Fills the \ref cy_stc_capsense_widget_crc_data_t with 0.
* - Initializes fields of the \ref cy_stc_capsense_widget_crc_data_t with the
* data from corresponding fields of the \ref cy_stc_capsense_widget_context_t.
* - Executes the Cy_CapSense_GetCRC() routine for full
* \ref cy_stc_capsense_widget_crc_data_t, structure, including padding.
* If the CSD tuning mode is set to smart sensing algorithm (Full Auto-Tune)
* then the fields of the \ref cy_stc_capsense_widget_context_t that changing
* it's value in the run-time will be excluded from CRC calculation for the
* CSD widgets.
*
* \param widgetId
* Specifies the ID number of the widget.
* A macro for the widget ID can be found in the
* CAPSENSE™ Configuration header file (cycfg_capsense.h) defined as
* CY_CAPSENSE_<WidgetName>_WDGT_ID.
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns a calculated CRC-16 value.
*
*******************************************************************************/
uint16_t Cy_CapSense_GetCrcWidget(
uint32_t widgetId,
cy_stc_capsense_context_t * context)
{
uint16_t crcValue;
const cy_stc_capsense_widget_context_t * ptrWdCxt;
cy_stc_capsense_widget_crc_data_t crcDataVal;
#if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_SMARTSENSE_FULL_EN)
const cy_stc_capsense_widget_config_t * ptrWdCfg = &context->ptrWdConfig[widgetId];
#endif
/* Get a pointer to the specified widget context structure */
ptrWdCxt = &context->ptrWdContext[widgetId];
(void)memset((void*)&crcDataVal, 0, sizeof(crcDataVal));
crcDataVal.fingerCapVal = ptrWdCxt->fingerCap;
crcDataVal.sigPFCVal = ptrWdCxt->sigPFC;
crcDataVal.lowBslnRstVal = ptrWdCxt->lowBslnRst;
crcDataVal.snsClkVal = ptrWdCxt->snsClk;
crcDataVal.rowSnsClkVal = ptrWdCxt->rowSnsClk;
crcDataVal.onDebounceVal = ptrWdCxt->onDebounce;
crcDataVal.snsClkSourceVal = ptrWdCxt->snsClkSource;
crcDataVal.maxRawCountVal = ptrWdCxt->maxRawCount;
crcDataVal.maxRawCountRowVal = ptrWdCxt->maxRawCountRow;
crcDataVal.bslnCoeffVal = ptrWdCxt->bslnCoeff;
#if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_SMARTSENSE_FULL_EN)
#if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_MPSC_EN)
if ((CY_CAPSENSE_CSD_GROUP != ptrWdCfg->senseMethod) ||
((uint8_t)CY_CAPSENSE_WD_LOW_POWER_E == ptrWdCfg->wdType) ||
(ptrWdCfg->mpOrder >= CY_CAPSENSE_MPSC_MIN_ORDER))
#else
if ((CY_CAPSENSE_CSD_GROUP != ptrWdCfg->senseMethod) ||
((uint8_t)CY_CAPSENSE_WD_LOW_POWER_E == ptrWdCfg->wdType))
#endif
#endif
{
crcDataVal.fingerThVal = ptrWdCxt->fingerTh;
crcDataVal.proxThVal = ptrWdCxt->proxTh;
crcDataVal.noiseThVal = ptrWdCxt->noiseTh;
crcDataVal.nNoiseThVal = ptrWdCxt->nNoiseTh;
crcDataVal.hysteresisVal = ptrWdCxt->hysteresis;
}
#if (CY_CAPSENSE_PLATFORM_BLOCK_FOURTH_GEN)
crcDataVal.resolutionVal = ptrWdCxt->resolution;
crcDataVal.idacModVal[0u] = ptrWdCxt->idacMod[0u];
crcDataVal.idacModVal[1u] = ptrWdCxt->idacMod[1u];
crcDataVal.idacModVal[2u] = ptrWdCxt->idacMod[2u];
crcDataVal.idacGainIndexVal = ptrWdCxt->idacGainIndex;
crcDataVal.rowIdacModVal[0u] = ptrWdCxt->rowIdacMod[0u];
crcDataVal.rowIdacModVal[1u] = ptrWdCxt->rowIdacMod[1u];
crcDataVal.rowIdacModVal[2u] = ptrWdCxt->rowIdacMod[2u];
#endif /* (CY_CAPSENSE_PLATFORM_BLOCK_FOURTH_GEN) */
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN)
crcDataVal.cdacDitherEnVal = ptrWdCxt->cdacDitherEn;
#endif /* (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) */
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
crcDataVal.cicShiftVal = ptrWdCxt->cicShift;
crcDataVal.rowCicShiftVal = ptrWdCxt->rowCicShift;
#endif /* (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) */
#if ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) || (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP))
crcDataVal.resolutionVal = ptrWdCxt->numSubConversions;
crcDataVal.cdacRefVal = ptrWdCxt->cdacRef;
crcDataVal.rowCdacRefVal = ptrWdCxt->rowCdacRef;
crcDataVal.cdacCompDividerVal = ptrWdCxt->cdacCompDivider;
crcDataVal.cicRateVal = ptrWdCxt->cicRate;
crcDataVal.lfsrBitsVal = ptrWdCxt->lfsrBits;
crcDataVal.cdacDitherValueVal = ptrWdCxt->cdacDitherValue;
crcDataVal.coarseInitBypassEnVal = ptrWdCxt->coarseInitBypassEn;
#endif /* (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) */
#if ((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP) && \
((CY_CAPSENSE_ENABLE == CY_CAPSENSE_CSD_CDAC_FINE_EN) || \
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_CSX_CDAC_FINE_EN) || \
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_ISX_CDAC_FINE_EN)))
crcDataVal.cdacFineVal = ptrWdCxt->cdacFine;
crcDataVal.rowCdacFineVal = ptrWdCxt->rowCdacFine;
#endif
crcValue = Cy_CapSense_GetCRC((uint8_t *)(&crcDataVal), sizeof(crcDataVal));
return crcValue;
}
/*******************************************************************************
* Function Name: Cy_CapSense_GetParam
****************************************************************************//**
*
* Gets a value of the specified parameter from the cy_capsense_tuner structure.
*
* This function gets the value of the specified parameter by the paramId
* argument. The paramId for each register of cy_capsense_tuner is available
* in the cycfg_capsense.h file as CY_CAPSENSE_<ParameterName>_PARAM_ID.
* The paramId is a special enumerated value generated by the CAPSENSE™
* Configurator tool. The format of paramId is as follows:
* 1. [ byte 3 byte 2 byte 1 byte 0 ]
* 2. [ RRRRRUTT IIIIIIII MMMMMMMM LLLLLLLL ]
* 3. U - indicates if the parameter affects the RAM Widget Object CRC.
* 4. T - encodes the parameter type:
* * 01b: uint8_t
* * 10b: uint16_t
* * 11b: uint32_t
* 5. I - specifies that the widgetId parameter belongs to.
* 6. M,L - the parameter offset MSB and LSB accordingly in cy_capsense_tuner.
* 7. R - reserved
*
* \param paramId
* Specifies the ID of parameter to get its value.
* A macro for the parameter ID can be found in the cycfg_capsense.h file
* defined as CY_CAPSENSE_<ParameterName>_PARAM_ID.
*
* \param value
* The pointer to a variable to be updated with the obtained value.
*
* \param ptrTuner
* The pointer to the cy_capsense_tuner variable of cy_stc_capsense_tuner_t.
* The cy_capsense_tuner is declared in CAPSENSE™ Configurator tool generated files:
* * cycfg_capsense.c/h
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the status of the operation. If CY_CAPSENSE_STATUS_SUCCESS is not received,
* either paramId is invalid or ptrTuner is null.
*
*******************************************************************************/
cy_capsense_status_t Cy_CapSense_GetParam(
uint32_t paramId,
uint32_t * value,
const void * ptrTuner,
const cy_stc_capsense_context_t * context)
{
cy_capsense_status_t capStatus = CY_CAPSENSE_STATUS_BAD_PARAM;
uint32_t paramType;
uint32_t paramOffset;
const uint8_t * bytePtr;
const uint16_t * halfWordPtr;
const uint32_t * wordPtr;
(void)context;
if ((value != NULL) && (ptrTuner != NULL))
{
/* Check parameter type, offset alignment and read data */
paramType = (paramId & CY_CAPSENSE_PARAM_TYPE_MASK) >> CY_CAPSENSE_PARAM_TYPE_OFFSET;
paramOffset = (uint16_t)(paramId);
switch (paramType)
{
case CY_CAPSENSE_DS_PARAM_TYPE_UINT32:
if (0u == (paramOffset & CY_CAPSENSE_UINT32_ALIGN_MASK))
{
paramOffset >>= 2u;
wordPtr = (const uint32_t *)ptrTuner;
*value = (uint32_t)wordPtr[paramOffset];
capStatus = CY_CAPSENSE_STATUS_SUCCESS;
}
break;
case CY_CAPSENSE_DS_PARAM_TYPE_UINT16:
if (0u == (paramOffset & CY_CAPSENSE_UINT16_ALIGN_MASK))
{
paramOffset >>= 1u;
halfWordPtr = (const uint16_t *)ptrTuner;
*value = (uint32_t)halfWordPtr[paramOffset];
capStatus = CY_CAPSENSE_STATUS_SUCCESS;
}
break;
case CY_CAPSENSE_DS_PARAM_TYPE_UINT8:
bytePtr = (const uint8_t *)ptrTuner;
*value = (uint32_t)bytePtr[paramOffset];
capStatus = CY_CAPSENSE_STATUS_SUCCESS;
break;
default:
/* No action on other parameter types */
break;
}
}
return capStatus;
}
/*******************************************************************************
* Function Name: Cy_CapSense_SetParam
****************************************************************************//**
*
* Sets a new value for the specified parameter in cy_capsense_tuner structure.
*
* This function sets the value of the specified parameter by the paramId
* argument. The paramId for each register of cy_capsense_tuner is available
* in the cycfg_capsense.h file as CY_CAPSENSE_<ParameterName>_PARAM_ID.
* The paramId is a special enumerated value generated by the CAPSENSE™
* Configurator tool. The format of paramId is as follows:
* 1. [ byte 3 byte 2 byte 1 byte 0 ]
* 2. [ RRRRRUTT IIIIIIII MMMMMMMM LLLLLLLL ]
* 3. U - indicates if the parameter affects the RAM Widget Object CRC.
* 4. T - encodes the parameter type:
* * 01b: uint8_t
* * 10b: uint16_t
* * 11b: uint32_t
* 5. I - specifies that the widgetId parameter belongs to
* 6. M,L - the parameter offset MSB and LSB accordingly in cy_capsense_tuner.
* 7. R - reserved
*
* This function writes specified value into the desired register without
* other registers update. It is application layer responsibility to keep all
* the data structure registers aligned. Repeated call of
* Cy_CapSense_Enable() function helps aligning dependent register values.
*
* This function updates also the widget CRC field if Built-in Self-test
* is enabled and paramId requires that.
*
* \param paramId
* Specifies the ID of parameter to set its value.
* A macro for the parameter ID can be found in the cycfg_capsense.h file
* defined as CY_CAPSENSE_<ParameterName>_PARAM_ID.
*
* \param value
* Specifies the new parameter's value.
*
* \param ptrTuner
* The pointer to the cy_capsense_tuner variable of cy_stc_capsense_tuner_t.
* The cy_capsense_tuner is declared in CAPSENSE™ Configurator tool generated files:
* * cycfg_capsense.c/h
*
* \param context
* The pointer to the CAPSENSE™ context structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the status of the operation. If CY_CAPSENSE_STATUS_SUCCESS is not received,
* the parameter was not updated with the new value, either paramId is invalid
* or ptrTuner is null.
*
*******************************************************************************/
cy_capsense_status_t Cy_CapSense_SetParam(
uint32_t paramId,
uint32_t value,
void * ptrTuner,
cy_stc_capsense_context_t * context)
{
cy_capsense_status_t capStatus = CY_CAPSENSE_STATUS_SUCCESS;
uint32_t paramOffset;
uint32_t paramType;
#if ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_BIST_EN) &&\
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_TST_WDGT_CRC_EN))
uint32_t paramCrc;
uint32_t paramWidget;
#endif /* ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_BIST_EN) &&
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_TST_WDGT_CRC_EN)) */
uint8_t * bytePtr;
uint16_t * halfWordPtr;
uint32_t * wordPtr;
if ((context == NULL) || (ptrTuner == NULL))
{
capStatus = CY_CAPSENSE_STATUS_BAD_PARAM;
}
/* Parse paramId */
if (CY_CAPSENSE_STATUS_SUCCESS == capStatus)
{
paramOffset = (uint16_t)(paramId);
paramType = (paramId & CY_CAPSENSE_PARAM_TYPE_MASK) >> CY_CAPSENSE_PARAM_TYPE_OFFSET;
#if ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_BIST_EN) &&\
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_TST_WDGT_CRC_EN))
paramCrc = (paramId & CY_CAPSENSE_PARAM_CRC_MASK) >> CY_CAPSENSE_PARAM_CRC_OFFSET;
paramWidget = (paramId & CY_CAPSENSE_PARAM_WIDGET_MASK) >> CY_CAPSENSE_PARAM_WIDGET_OFFSET;
if ((paramWidget > context->ptrCommonConfig->numWd) && (0u != paramCrc))
{
capStatus = CY_CAPSENSE_STATUS_BAD_PARAM;
}
#endif /* ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_BIST_EN) &&
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_TST_WDGT_CRC_EN)) */
}
/* Check parameter type, offset alignment, write the specified parameter */
if (CY_CAPSENSE_STATUS_SUCCESS == capStatus)
{
switch (paramType)
{
case CY_CAPSENSE_DS_PARAM_TYPE_UINT32:
if (0u == (paramOffset & CY_CAPSENSE_UINT32_ALIGN_MASK))
{
paramOffset >>= 2u;
wordPtr = (uint32_t *)ptrTuner;
wordPtr[paramOffset] = value;
}
break;
case CY_CAPSENSE_DS_PARAM_TYPE_UINT16:
if (0u == (paramOffset & CY_CAPSENSE_UINT16_ALIGN_MASK))
{
paramOffset >>= 1u;
halfWordPtr = (uint16_t *)ptrTuner;
halfWordPtr[paramOffset] = (uint16_t)value;
}
break;
case CY_CAPSENSE_DS_PARAM_TYPE_UINT8:
bytePtr = (uint8_t *)ptrTuner;
bytePtr[paramOffset] = (uint8_t)value;
break;
default:
capStatus = CY_CAPSENSE_STATUS_BAD_PARAM;
break;
}
}
/* Update widget CRC if needed */
#if ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_BIST_EN) &&\
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_TST_WDGT_CRC_EN))
if ((CY_CAPSENSE_STATUS_SUCCESS == capStatus) &&
(0u != paramCrc))
{
Cy_CapSense_UpdateCrcWidget(paramWidget, context);
}
#endif /* ((CY_CAPSENSE_ENABLE == CY_CAPSENSE_BIST_EN) &&
(CY_CAPSENSE_ENABLE == CY_CAPSENSE_TST_WDGT_CRC_EN)) */
return capStatus;
}
/*******************************************************************************
* Function Name: Cy_CapSense_SetWidgetStatus
****************************************************************************//**
*
* Performs configuring of the selected widget.
*
* This function performs customized widget status configuration
* by the mode parameter. There are two general use cases for this function:
* 1. Make the specified widget Enabled/Disabled. This status is intended
* to define a set of widgets to be scanned/processed from the application
* layer.
* 2. Make the specified widget Working/Non-working. This status is
* integrated into the built-in self-test (BIST) library. If a test detects
* non-working widget, that widget status is set to non-working automatically
* by CAPSENSE™. BIST never resets a widget working mask and the user
* makes a decision what to do next with this non-working widget.
*
* Although other statuses can be changed by this function, this is not
* recommended to avoid impact on CAPSENSE™ operation and
* is needed to implement only specific use cases.
*
* By default, all widgets are enabled and working during CAPSENSE™
* initialization. All disabled or non-working widgets are excluded
* from scanning and processing.
*
* Excluding a widget from a scanning flow happens
* immediately by re-generation a new scanning frame. This function does it
* for optimization, which means that scanning functions save
* CPU time by checking if any widget status was changed.
*
* Excluding from processing flow happens inside the process functions since they
* perform processing by widgets and not by slots. Therefore, changing
* the widget status should happen before a new scan and/or after processing.
*
* The Cy_CapSense_ProcessWidgetExt() and Cy_CapSense_ProcessSensorExt()
* functions ignore widget disable and non-working statuses and perform
* processing based on specified mode provided to those functions.
*
* The function also checks if there is at least one enabled and working widget.
* If no valid widgets are left for scanning, the function returns
* CY_CAPSENSE_STATUS_BAD_CONFIG separately for active and low-power
* widgets due to these groups' independent scanning frames.
*
* \note
* For the fifth generation and fifth-generation low power CAPSENSE™,
* if the specified widget has the enabled multi-frequency scan feature,
* then the status configuration happens to all the joined widgets:
* * Sub-widget channel 2
* * Sub-widget channel 1
* * Main widget channel 0
*
* \param widgetId
* Specifies the widget ID number. A macro for the widget ID can be found
* in the cycfg_capsense.h file defined as CY_CAPSENSE_<WIDGET_NAME>_WDGT_ID.
*
* \param mode
* Specifies the bit mask of widget status to be configured. It is allowed
* to configure several bits simultaneously.
* 1. Bit [0] - CY_CAPSENSE_WD_ACTIVE_MASK
* 2. Bit [1] - CY_CAPSENSE_WD_ENABLE_MASK
* 3. Bit [2] - CY_CAPSENSE_WD_WORKING_MASK
* 4. Bit [3] - CY_CAPSENSE_WD_MAXCOUNT_CALC_MASK
* 5. Bit [4] - CY_CAPSENSE_WD_MAXCOUNT_ROW_CALC_MASK.
*
* \param mask
* Specifies the value of widget status field to be configured. All bit values
* not set by the mask passed as the mode parameter are ignored.
*
* \param context
* The pointer to the CAPSENSE™ context
* structure \ref cy_stc_capsense_context_t.
*
* \return
* Returns the status of the widget processing operation:
* - CY_CAPSENSE_STATUS_SUCCESS - The operation is successful.
* - CY_CAPSENSE_STATUS_BAD_PARAM - The input parameter is invalid.
*
*******************************************************************************/
cy_capsense_status_t Cy_CapSense_SetWidgetStatus(
uint32_t widgetId,
uint32_t mode,
uint32_t mask,
cy_stc_capsense_context_t * context)
{
cy_capsense_status_t capStatus = CY_CAPSENSE_STATUS_BAD_CONFIG;
#if (((CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN) || (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)) &&\
(CY_CAPSENSE_DISABLE != CY_CAPSENSE_MULTI_FREQUENCY_WIDGET_EN))
const cy_stc_capsense_widget_config_t * ptrWdCfg = context->ptrWdConfig;
uint32_t wdIndex;
#endif
/* Check parameter validity */
if (widgetId < CY_CAPSENSE_TOTAL_WIDGET_COUNT)
{
capStatus = CY_CAPSENSE_STATUS_SUCCESS;
#if (CY_CAPSENSE_PLATFORM_BLOCK_FOURTH_GEN)
context->ptrWdContext[widgetId].status &= (uint8_t)~(uint8_t)mode;
context->ptrWdContext[widgetId].status |= ((uint8_t)mask & (uint8_t)mode);
(void)Cy_CapSense_SwitchSensingMode(CY_CAPSENSE_UNDEFINED_GROUP, context);
#else
/* Update scan flags for MSC platforms */
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
context->ptrInternalContext->repeatScanEn = CY_CAPSENSE_DISABLE;
context->ptrCommonContext->status &= (uint32_t)~((uint32_t)CY_CAPSENSE_MW_STATE_WD_SCAN_MASK);
#endif
#if (CY_CAPSENSE_ENABLE == CY_CAPSENSE_MULTI_FREQUENCY_WIDGET_EN)
/* Checks if MFS is enabled for particular widget */
if (0u != (ptrWdCfg->mfsConfig & CY_CAPSENSE_MFS_EN_MASK))
{
wdIndex = widgetId - (((uint32_t)ptrWdCfg->mfsConfig & CY_CAPSENSE_MFS_WIDGET_FREQ_ALL_CH_MASK) >> CY_CAPSENSE_MFS_WIDGET_FREQ_ALL_CH_POS);
context->ptrWdContext[wdIndex].status &= (uint8_t)~(uint8_t)mode;
context->ptrWdContext[wdIndex].status |= ((uint8_t)mask & (uint8_t)mode);
context->ptrWdContext[wdIndex + CY_CAPSENSE_MFS_CH1_INDEX].status &= (uint8_t)~(uint8_t)mode;
context->ptrWdContext[wdIndex + CY_CAPSENSE_MFS_CH1_INDEX].status |= ((uint8_t)mask & (uint8_t)mode);
context->ptrWdContext[wdIndex + CY_CAPSENSE_MFS_CH2_INDEX].status &= (uint8_t)~(uint8_t)mode;
context->ptrWdContext[wdIndex + CY_CAPSENSE_MFS_CH2_INDEX].status |= ((uint8_t)mask & (uint8_t)mode);
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
Cy_CapSense_SetSnsFrameValidity(wdIndex, context);
Cy_CapSense_SetSnsFrameValidity(wdIndex + CY_CAPSENSE_MFS_CH1_INDEX, context);
Cy_CapSense_SetSnsFrameValidity(wdIndex + CY_CAPSENSE_MFS_CH2_INDEX, context);
#endif
}
else
{
context->ptrWdContext[widgetId].status &= (uint8_t)~(uint8_t)mode;
context->ptrWdContext[widgetId].status |= ((uint8_t)mask & (uint8_t)mode);
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
Cy_CapSense_SetSnsFrameValidity(widgetId, context);
#endif
}
#else
context->ptrWdContext[widgetId].status &= (uint8_t)~(uint8_t)mode;
context->ptrWdContext[widgetId].status |= ((uint8_t)mask & (uint8_t)mode);
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
Cy_CapSense_SetSnsFrameValidity(widgetId, context);
#endif
#endif
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN)
context->ptrInternalContext->scanSingleSlot = CY_CAPSENSE_SCAN_MULTIPLE_SLOT;
#if (CY_CAPSENSE_SCAN_MODE_DMA_DRIVEN == CY_CAPSENSE_SCAN_MODE)
(void)Cy_CapSense_ConfigureDmaArrays(context);
#endif
#endif
#endif
}
return capStatus;
}
#if (CY_CAPSENSE_PLATFORM_BLOCK_FIFTH_GEN_LP)
/*******************************************************************************
* Function Name: Cy_CapSense_SetSnsFrameValidity
****************************************************************************//**
*
* Performs sensor frame update for the specified widget.
*
* For the fifth generation and fifth-generation low power CAPSENSE™,
* if the specified widget has the enabled multi-frequency scan feature,
* then the frame update happens to the specified widget Id only.
*
* \param widgetId
* Specifies the widget ID number. A macro for the widget ID can be found
* in the cycfg_capsense.h file defined as CY_CAPSENSE_<WIDGET_NAME>_WDGT_ID.
*
* \param context
* The pointer to the CAPSENSE™ context
* structure \ref cy_stc_capsense_context_t.
*
*******************************************************************************/
void Cy_CapSense_SetSnsFrameValidity(
uint32_t widgetId,
cy_stc_capsense_context_t * context)
{
uint32_t wdStatus = 0u;
uint32_t * ptrSnsFrmCxt;
uint32_t snsIndex;
const cy_stc_capsense_widget_config_t * ptrWdCfg = &context->ptrWdConfig[widgetId];
uint32_t frameSize = CY_CAPSENSE_SENSOR_FRAME_SIZE;
ptrSnsFrmCxt = &context->ptrSensorFrameContext[
(ptrWdCfg->firstSlotId * frameSize) + CY_CAPSENSE_SNS_CTL_INDEX];