-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcy_capsense_structure.h
1425 lines (1276 loc) · 104 KB
/
cy_capsense_structure.h
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.h
* \version 3.0
*
* \brief
* This file provides the top-level declarations of the CapSense data
* structure. Also, the file declares the functions for data access.
*
********************************************************************************
* \copyright
* Copyright 2018-2020, 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.
*******************************************************************************/
#if !defined(CY_CAPSENSE_STRUCTURE_H)
#define CY_CAPSENSE_STRUCTURE_H
#include "cy_syslib.h"
#include "cy_device_headers.h"
#include "cy_capsense_lib.h"
#include "cy_capsense_gesture_lib.h"
#include "cy_capsense_common.h"
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
#include "cy_csd.h"
#else /* (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3) */
#include "cy_msc.h"
#endif
#if (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2) || defined(CY_IP_M0S8MSCV3))
#if defined(__cplusplus)
extern "C" {
#endif
/*******************************************************************************
* CapSense Enumerated Types
*******************************************************************************/
/******************************************************************************/
/** \addtogroup group_capsense_enums *//** \{ */
/******************************************************************************/
/** Defines MW Tuner module states */
typedef enum
{
CY_CAPSENSE_TU_FSM_RUNNING = 0x00u, /**< Running state is a state when CapSense middleware is not
* blocked by the CapSense Tuner tool and application program continuously scans */
CY_CAPSENSE_TU_FSM_SUSPENDED = 0x01u, /**< Scanning is suspended */
CY_CAPSENSE_TU_FSM_ONE_SCAN = 0x03u, /**< Scanning is suspended after one scan cycle */
} cy_en_capsense_tuner_state_t;
/** Defines the Tuner command codes */
typedef enum
{
CY_CAPSENSE_TU_CMD_NONE_E = 0u, /**< No command */
CY_CAPSENSE_TU_CMD_SUSPEND_E = 1u, /**< Suspend command */
CY_CAPSENSE_TU_CMD_RESUME_E = 2u, /**< Resume command switches state from suspend to running */
CY_CAPSENSE_TU_CMD_RESTART_E = 3u, /**< Restart command requests to perform CapSense re-initialization */
CY_CAPSENSE_TU_CMD_RUN_SNR_TEST_E = 4u, /**< Reserved */
CY_CAPSENSE_TU_CMD_PING_E = 5u, /**< Ping command to check whether application program calls Cy_CapSense_RunTuner() */
CY_CAPSENSE_TU_CMD_ONE_SCAN_E = 6u, /**< Execute one scan cycle and then switch to suspend state */
CY_CAPSENSE_TU_CMD_WRITE_E = 7u, /**< Writes specified data with offset into cy_capsense_tuner */
} cy_en_capsense_tuner_cmd_t;
/** Defines widget types */
typedef enum
{
CY_CAPSENSE_WD_BUTTON_E = 0x01u, /**< Button widget */
CY_CAPSENSE_WD_LINEAR_SLIDER_E = 0x02u, /**< Linear Slider widget */
CY_CAPSENSE_WD_RADIAL_SLIDER_E = 0x03u, /**< Radial Slider widget */
CY_CAPSENSE_WD_MATRIX_BUTTON_E = 0x04u, /**< Matrix Buttons widget */
CY_CAPSENSE_WD_TOUCHPAD_E = 0x05u, /**< Touchpad widget */
CY_CAPSENSE_WD_PROXIMITY_E = 0x06u, /**< Proximity widget */
} cy_en_capsense_widget_type_t;
/** Defines sensing methods types */
typedef enum
{
CY_CAPSENSE_UNDEFINED_E = 0x00u, /**< Undefined method used at initialization or releasing the CSD HW block */
CY_CAPSENSE_SENSE_METHOD_CSD_E = 0x01u, /**< CSD sensing method */
CY_CAPSENSE_SENSE_METHOD_CSX_E = 0x02u, /**< CSX sensing method */
CY_CAPSENSE_SENSE_METHOD_BIST_E = 0x03u, /**< BIST sensing method */
} cy_en_capsense_sensing_method_t;
/** Defines CapSense return statuses types */
typedef enum
{
CY_CAPSENSE_SUCCESS_E = 0x00u, /**< The success return status */
CY_CAPSENSE_BAD_PARAM_E = 0x01u, /**< One or more invalid input parameters */
CY_CAPSENSE_HW_LOCKED_E = 0x02u, /**< The CSD HW block is captured by another middleware */
CY_CAPSENSE_HW_BUSY_E = 0x03u, /**< The CSD HW block is busy by previous operation */
CY_CAPSENSE_TIMEOUT_E = 0x04u, /**< The CSD HW block operation was not finished correctly */
} cy_en_capsense_return_status_t;
/** Defines types of electrode */
typedef enum
{
CY_CAPSENSE_ELTD_TYPE_SELF_E = 0x01u, /**< Electrode used as a sensor in CSD sensing method */
CY_CAPSENSE_ELTD_TYPE_MUT_TX_E = 0x02u, /**< Electrode used as a TX in CSX sensing method */
CY_CAPSENSE_ELTD_TYPE_MUT_RX_E = 0x03u, /**< Electrode used as a RX in CSX sensing method */
} cy_en_capsense_eltd_t;
/** Defines connections of sensing capacitors */
typedef enum
{
CY_CAPSENSE_CMODPAD_E = 0x01u, /**< External capacitor is connected to dedicated CMOD pad */
CY_CAPSENSE_CTANKPAD_E = 0x02u, /**< External capacitor is connected to dedicated CSH pad */
CY_CAPSENSE_CSHIELDPAD_E = 0x03u, /**< External capacitor is connected to dedicated SHIELD pad */
CY_CAPSENSE_VREFEXTPAD_E = 0x04u, /**< External capacitor is connected to dedicated VREF pad */
} cy_en_capsense_cap_connection_t;
/** Defines CapSense middleware execution events
* when the CapSense callback can be executed. */
typedef enum
{
CY_CAPSENSE_START_SAMPLE_E = 0x01u, /**< Start Sample Callback. The callback will be executed before each sensor
*scan triggering */
CY_CAPSENSE_END_OF_SCAN_E = 0x02u, /**< End Of Scan Callback. The callback will be executed when sensor scan
* is finished and there is no other sensors in the queue to be scanned. */
} cy_en_capsense_callback_event_t;
/** Defines HW configurations types for BIST operations */
typedef enum
{
CY_CAPSENSE_BIST_HW_UNDEFINED_E = 0x00u, /**< Initialization or releasing the CSD HW block */
CY_CAPSENSE_BIST_HW_SHORT_E = 0x01u, /**< Short tests */
CY_CAPSENSE_BIST_HW_ELTD_CAP_E = 0x02u, /**< Sensor and shield electrodes capacitance measurements with disabled shield */
CY_CAPSENSE_BIST_HW_EXTERNAL_CAP_E = 0x03u, /**< External capacitors capacitance measurements */
CY_CAPSENSE_BIST_HW_VDDA_E = 0x04u, /**< VDDA measurement */
CY_CAPSENSE_BIST_HW_ELTD_CAP_SH_E = 0x05u, /**< Sensor electrodes capacitance measurements with configured shield */
} cy_en_capsense_bist_hw_config_t;
/** Defines BIST IO Configuration */
typedef enum
{
CY_CAPSENSE_BIST_IO_UNDEFINED_E = 0x00u, /**< The undefined state. Pins are disconnected from AMuxBus */
CY_CAPSENSE_BIST_IO_STRONG_E = 0x01u, /**< The drive mode is set to Strong in off - Low.
* The HSIOM is set to GPIO */
CY_CAPSENSE_BIST_IO_HIGHZA_E = 0x02u, /**< The drive mode is set to High-Z.
* The HSIOM is set to GPIO */
CY_CAPSENSE_BIST_IO_SENSE_E = 0x03u, /**< The drive mode is set to High-Z/Strong in off (depending on the device platform).
* The HSIOM is set to CSD sense connection. */
CY_CAPSENSE_BIST_IO_SHIELD_E = 0x04u, /**< The drive mode is set to High-Z/Strong in off (depending on the device platform).
* The HSIOM is set to CSD shield connection. */
CY_CAPSENSE_BIST_IO_STRONG_HIGH_E = 0x05u, /**< The drive mode is set to Strong in off - High.
* The HSIOM is set to GPIO */
} cy_en_capsense_bist_io_state_t;
/** Defines BIST result statuses */
typedef enum
{
CY_CAPSENSE_BIST_SUCCESS_E = 0x00u, /**< The success test status */
CY_CAPSENSE_BIST_BAD_PARAM_E = 0x01u, /**< The bad input parameters test status */
CY_CAPSENSE_BIST_HW_BUSY_E = 0x02u, /**< The CSD HW block is busy by previous operation */
CY_CAPSENSE_BIST_LOW_LIMIT_E = 0x03u, /**< The status for a low limit reached during the test */
CY_CAPSENSE_BIST_HIGH_LIMIT_E = 0x04u, /**< The status for a high limit reached during the test */
CY_CAPSENSE_BIST_ERROR_E = 0x05u, /**< The status for an error occurred during the test.
The test is not completed */
CY_CAPSENSE_BIST_FEATURE_DISABLED_E = 0x06u, /**< The BIST feature is disabled. */
CY_CAPSENSE_BIST_TIMEOUT_E = 0x07u, /**< The status for a timeout occurred during the test */
CY_CAPSENSE_BIST_FAIL_E = 0x0Fu, /**< The failed test status */
} cy_en_capsense_bist_status_t;
/** Defines the raw count accumulation mode for MSC HW block */
typedef enum
{
CY_CAPSENSE_MSC_RAW_SATURATE_E = 0x00u, /**< In this scenario, RAW_COUNT is clamped at 0xFFFF and RESULT_FIFO_RD.OVERFLOW is set. */
CY_CAPSENSE_MSC_RAW_OVERFLOW_E = 0x01u, /**< In this scenario, RAW_COUNT rolls over and RESULT_FIFO_RD.OVERFLOW is set. This mode allows more sensitive tuning if measuring baseline capacitance */
} cy_en_capsense_msc_raw_mode_t;
/** \} */
/*******************************************************************************
* CapSense Data Structures
*******************************************************************************/
/******************************************************************************/
/** \addtogroup group_capsense_structures *//** \{ */
/******************************************************************************/
/** Unified return status of CapSense operation:
* * CY_CAPSENSE_STATUS_SUCCESS
* * CY_CAPSENSE_STATUS_BAD_PARAM
* * CY_CAPSENSE_STATUS_BAD_DATA
* * CY_CAPSENSE_STATUS_TIMEOUT
* * CY_CAPSENSE_STATUS_INVALID_STATE
* * CY_CAPSENSE_STATUS_BAD_CONFIG
* * CY_CAPSENSE_STATUS_CONFIG_OVERFLOW
* * CY_CAPSENSE_STATUS_HW_BUSY
* * CY_CAPSENSE_STATUS_UNKNOWN
*/
typedef uint32_t cy_capsense_status_t;
/** Sensor context structure */
typedef struct
{
uint16_t raw; /**< Sensor raw count */
uint16_t bsln; /**< Sensor baseline */
uint16_t diff; /**< Sensor difference count */
uint8_t status; /**< Sensor status */
uint8_t negBslnRstCnt; /**< Negative baseline reset counter */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t idacComp; /**< Compensation IDAC of CSD or IDAC in CSX */
#endif
uint8_t bslnExt; /**< Sensor baseline fractional */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
uint8_t cdacComp; /**< Compensation CDAC */
#endif
} cy_stc_capsense_sensor_context_t;
/** CSX Touchpad touch tracking history */
typedef struct
{
uint32_t velocity; /**< The square of the "speed" (maximum distance change per refresh interval) threshold
* distinguishing a fast finger movement from separate finger touches
* (in [pixels/refresh interval]).
* Squared speeds exceeding this value indicate separate finger touches.
* Squared speeds below this value indicate fast single finger movement. */
cy_stc_capsense_position_t oldPeak[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS];
/**< Touch Positions */
uint8_t oldPeakNumber; /**< Number of detected peaks */
uint8_t oldActiveIdsMask; /**< Mask of used IDs */
} cy_stc_capsense_csx_touch_history_t;
/** Internal CSX Touchpad buffer structure for CSX for Touchpads' processing */
typedef struct
{
int32_t distanceMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS * CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS];
/**< Buffer for distance map data */
int32_t colMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS]; /**< Buffer for column map data */
int32_t rowMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS]; /**< Buffer for row map data */
int32_t minsMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS]; /**< Buffer for minimums map data */
cy_stc_capsense_position_t newPeak[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS];
/**< Touch Positions */
int8_t fingerPosIndexMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS + 3u];
/**< Buffer for index map data */
int8_t linksMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS]; /**< Buffer for linked map data */
int8_t visitedMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS]; /**< Buffer for visited map data */
int8_t markIndicesMap[CY_CAPSENSE_CSX_TOUCHPAD_MAX_PEAKS]; /**< Buffer for mark map data */
uint8_t newPeakNumber; /**< Number of detected peaks */
uint8_t newActiveIdsMask; /**< Mask of used IDs */
} cy_stc_capsense_csx_touch_buffer_t;
/** Widget context structure */
typedef struct
{
uint16_t fingerCap; /**< Widget finger capacitance parameter used for the CSD
* widgets only when SmartSense is enabled */
uint16_t sigPFC; /**< The 75% of signal per user-defined finger capacitance */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint16_t resolution; /**< Provides scan resolution for the CSD Widgets.
* Provides number of sub-conversions for the CSX Widgets */
#endif
uint16_t maxRawCount; /**< Calculated maximum raw count of widget */
uint16_t fingerTh; /**< Widget Finger Threshold */
uint16_t proxTh; /**< Widget Proximity Threshold */
uint16_t lowBslnRst; /**< The widget low baseline reset count. Specifies the number
* of samples the sensor signal must be below the Negative
* Noise Threshold \ref nNoiseTh to trigger a baseline reset */
uint16_t snsClk; /**< Sense Clock Divider. For the Matrix Buttons and Touchpad widgets
* specifies the column sense clock divider */
uint16_t rowSnsClk; /**< Row Sense Clock Divider for the Matrix Buttons and Touchpad widgets */
uint16_t gestureDetected; /**< Mask of detected gestures */
uint16_t gestureDirection; /**< Mask of directions of detected gestures */
int16_t xDelta; /**< The filtered by Ballistic Multiplier X-displacement */
int16_t yDelta; /**< The filtered by Ballistic Multiplier Y-displacement */
uint8_t noiseTh; /**< Widget Noise Threshold */
uint8_t nNoiseTh; /**< Widget Negative Noise Threshold */
uint8_t hysteresis; /**< Widget Hysteresis for the signal crossing finger threshold */
uint8_t onDebounce; /**< Widget Debounce for the signal above the finger threshold 1 to 255.
* * 1 - touch reported immediately as soon as detected
* * 2 - touch reported on the second consecutive detection
* * 3 - touch reported on the third consecutive detection */
uint8_t snsClkSource; /**< Widget clock source:
* * bit[7] - Indicates auto mode of clock source selection
* * bit[0:6] - Clock source:
* * 0 - Direct (CY_CAPSENSE_CLK_SOURCE_DIRECT)
* * 1 - SSC6 (CY_CAPSENSE_CLK_SOURCE_SSC6)
* * 2 - SSC7 (CY_CAPSENSE_CLK_SOURCE_SSC7)
* * 3 - SSC9 (CY_CAPSENSE_CLK_SOURCE_SSC9)
* * 4 - SSC10 (CY_CAPSENSE_CLK_SOURCE_SSC10)
* * 5 - PRS8 (CY_CAPSENSE_CLK_SOURCE_PRS8)
* * 6 - PRS12 (CY_CAPSENSE_CLK_SOURCE_PRS12) */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t idacMod[CY_CAPSENSE_FREQ_CHANNELS_NUM]; /**< Sets the current of the modulation IDAC for the CSD widgets.
* For the CSD Touchpad and Matrix Button widgets sets the current of the
* modulation IDAC for the column sensors. Not used for the CSX widgets. */
uint8_t idacGainIndex; /**< Index of IDAC gain in table \ref cy_stc_capsense_idac_gain_table_t */
uint8_t rowIdacMod[CY_CAPSENSE_FREQ_CHANNELS_NUM]; /**< Sets the current of the modulation IDAC for the row sensors
* for the CSD Touchpad and Matrix Button widgets. Not used for the CSX widgets. */
#endif
uint8_t bslnCoeff; /**< Baseline IIR filter coefficient. Lower value leads to higher filtering. */
uint8_t status; /**< Contains masks:
* * bit[0] - Widget Active (CY_CAPSENSE_WD_ACTIVE_MASK)
* * bit[1] - Widget Disabled (CY_CAPSENSE_WD_DISABLE_MASK)
* * bit[2] - Widget Working (CY_CAPSENSE_WD_WORKING_MASK) */
cy_stc_capsense_touch_t wdTouch; /**< Widget touch structure used for Matrix Buttons, Sliders, and Touchpads */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
uint16_t numSubConversions; /**< Number of sub-conversions in a scan */
uint8_t cdacRef[CY_CAPSENSE_FREQ_CHANNELS_NUM]; /**< Sets the capacitance of the reference CDAC */
uint8_t rowCdacRef[CY_CAPSENSE_FREQ_CHANNELS_NUM]; /**< Sets the capacitance of the reference CDAC for CSD
* Touchpad and CSD Matrix buttons widgets */
uint8_t cicRate; /**< Sets decimation rate when CIC2 is enabled */
uint8_t cdacDitherEn; /**< Enabled CDAC dithering */
uint8_t cdacDitherValue; /**< CDAC dither value in percentage */
uint8_t coarseInitBypassEn; /**< Skip Cmod coarse initialization sensors scan within widget */
uint16_t cdacCompDivider; /**< Number of time DAC switched in sense clock period */
#endif
} cy_stc_capsense_widget_context_t;
/** Legacy mode pin configuration structure */
typedef struct
{
GPIO_PRT_Type * pcPtr; /**< Pointer to the base port register of the IO */
uint8_t pinNumber; /**< Position of the IO in the port */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
uint8_t padNumber; /**< Control Mux pad number */
uint8_t chId; /**< Channel Id the pin belongs to */
#endif
} cy_stc_capsense_pin_config_t;
/** Electrode objects configuration structure */
typedef struct
{
const cy_stc_capsense_pin_config_t * ptrPin; /**< Pointer to pin configuration structure */
uint8_t type; /**< Electrode type \ref cy_en_capsense_eltd_t */
uint8_t numPins; /**< Total number of pins in this sensor */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
uint8_t chId; /**< Channel Id the electrode belongs to */
#endif
} cy_stc_capsense_electrode_config_t;
/** Configuration structure of advanced touchpad */
typedef struct
{
uint16_t penultimateTh; /**< Defines a threshold for determining arrival at edges. This
* value may have to be increased for small diamonds, so that the edge handling is
* initiated sooner. If this number is too high, there is jumping at the edge with
* a smaller finger. If this number is too low, there is jumping at the edge with a
* larger finger. */
uint16_t virtualSnsTh; /**< Defines a virtual sensor signal. This value should be set
* to the value of any sensor when a medium-sized finger is placed directly over
* it. If this value is too high, a position is reported nearer the edge than ideal
* position. If this value is too low, a position is reported nearer the middle of
* touchpad. */
uint8_t crossCouplingTh; /**< Defines cross coupling threshold. It is subtracted from
* sensor signals at centroid position calculation to improve the accuracy.
* The threshold should be equal to a sensor signal when your finger is near the
* sensor, but not touching the sensor. This can be determined by slowly dragging
* your finger across the panel and finding the inflection point of the difference
* counts at the base of the curve. The difference value at this point should be
* the Cross-coupling threshold. */
uint8_t reserved0; /**< Reserved field */
uint8_t reserved1; /**< Reserved field */
uint8_t reserved2; /**< Reserved field */
} cy_stc_capsense_advanced_touchpad_config_t;
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
/** Multi-phase TX table for de-convolution structure */
typedef struct
{
uint32_t vector; /**< TX vector / pattern */
int16_t deconvCoef[32u]; /**< De-convolution coefficients */
} cy_stc_capsense_mptx_table_t;
#endif
/** Widget configuration structure */
typedef struct
{
cy_stc_capsense_widget_context_t * ptrWdContext; /**< Pointer to context structure of this widget */
cy_stc_capsense_sensor_context_t * ptrSnsContext; /**< Pointer to the first object of sensor context structure that belongs to this widget */
const cy_stc_capsense_electrode_config_t * ptrEltdConfig; /**< Pointer to the first object of electrode configuration structure that belongs to this widget */
uint32_t * ptrEltdCapacitance; /**< Pointer to the first object in the electrode capacitance array that belongs to this widget */
uint16_t * ptrBslnInv; /**< Pointer to the first object in the sensor baseline inversion array that belongs to this widget */
cy_stc_capsense_smartsense_csd_noise_envelope_t * ptrNoiseEnvelope;
/**< Pointer to the noise envelope filter used by SmartSense */
uint16_t * ptrRawFilterHistory; /**< Pointer to the raw count filter history of the widget */
uint8_t * ptrRawFilterHistoryLow; /**< Pointer to the raw count filter history extended of the widget */
uint32_t iirCoeff; /**< Raw count IIR filter coefficient. Smaller value leads to higher filtering */
uint8_t * ptrDebounceArr; /**< Pointer to the debounce array of the widget */
const uint8_t * ptrDiplexTable; /**< Pointer to the diplex table used for Linear slider when Diplex option is enabled */
uint32_t centroidConfig; /**< Configuration of centroids */
uint16_t xResolution; /**< Keeps maximum position value. For Touchpads X-axis maximum position */
uint16_t yResolution; /**< For Touchpads Y-Axis maximum position */
uint16_t numSns; /**< The total number of sensors:
* For CSD widgets: WD_NUM_ROWS + WD_NUM_COLS.
* For CSX widgets: WD_NUM_ROWS * WD_NUM_COLS. */
uint8_t numCols; /**< For CSD Button and Proximity Widgets, the number of sensors.
* For CSD Slider Widget, the number of segments.
* For CSD Touchpad and Matrix Button, the number of the column sensors.
* For CSX Button, Touchpad, and Matrix Button, the number of the Rx electrodes. */
uint8_t numRows; /**< For CSD Touchpad and Matrix Buttons, the number of the row sensors.
* For the CSX Button, the number of the Tx electrodes (constant 1u).
* For CSX Touchpad and Matrix Button, the number of the Tx electrodes. */
cy_stc_capsense_touch_t * ptrPosFilterHistory; /**< Pointer to the position filter history */
cy_stc_capsense_csx_touch_history_t * ptrCsxTouchHistory; /**< Pointer to the CSX touchpad history */
cy_stc_capsense_csx_touch_buffer_t * ptrCsxTouchBuffer; /**< Pointer to the single CSX buffer needed for CSX touchpad processing */
uint16_t * ptrCsdTouchBuffer; /**< Pointer to the CSD buffer needed for advanced CSD touchpad processing */
cy_stc_capsense_gesture_config_t * ptrGestureConfig; /**< Pointer to Gesture configuration structure */
cy_stc_capsense_gesture_context_t * ptrGestureContext; /**< Pointer to Gesture context structure */
cy_stc_capsense_ballistic_config_t ballisticConfig; /**< The configuration data for position ballistic filter. */
cy_stc_capsense_ballistic_context_t * ptrBallisticContext; /**< Pointer to Ballistic filter context structure */
cy_stc_capsense_adaptive_filter_config_t aiirConfig; /**< The configuration of position adaptive filter. */
cy_stc_capsense_advanced_touchpad_config_t advConfig; /**< The configuration of CSD advanced touchpad */
uint32_t posFilterConfig; /**< Position filters configuration */
uint16_t rawFilterConfig; /**< Raw count filters configuration */
uint8_t senseMethod; /**< Specifies the widget sensing method:
* * 1 - CSD (CY_CAPSENSE_CSD_SENSING_METHOD)
* * 2 - CSX_RM (CY_CAPSENSE_CSX_RM_SENSING_METHOD)
* * 3 - CSD_RM (CY_CAPSENSE_CSD_RM_SENSING_METHOD) */
uint8_t wdType; /**< Specifies the widget type */
uint8_t senseGroup; /**< Specifies the widget group:
* * 1 - CSD (CY_CAPSENSE_CSD_GROUP)
* * 2 - CSX (CY_CAPSENSE_CSX_GROUP) */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
cy_stc_capsense_mptx_table_t * ptrMptxTable; /**< Pointer to the multi-phase TX vector and de-convolution coefficients */
uint16_t firstSlotId; /**< The slot ID in the widget to start scan from */
uint16_t numSlots; /**< The number of slots in the widget */
uint8_t numChopCycles; /**< Defines number of chopping cycles. One cycle means the feature is disabled */
uint8_t mptxOrder; /**< Multi-phase TX order */
#endif
} cy_stc_capsense_widget_config_t;
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
/** Declares the IDAC gain table */
typedef struct
{
uint32_t gainReg; /**< Register value of IDAC gain */
uint32_t gainValue; /**< Absolute gain value in pA */
} cy_stc_capsense_idac_gain_table_t;
#endif
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
/** Declares the scan order of widget and sensor */
typedef struct
{
uint16_t wdId; /**< Specifies the widget ID for the current scan slot */
uint16_t snsId; /**< Specifies the sensor ID for the current scan slot */
} cy_stc_capsense_scan_slot_t;
#endif
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
/** Declares MSC channel (HW block) configuration */
typedef struct
{
MSC_Type * ptrMscBase; /**< Pointer to the MSC HW block register */
cy_stc_msc_context_t * ptrMscContext; /**< Pointer to the MSC driver context */
GPIO_PRT_Type * portCmod1; /**< The pointer to the Cmod1 pin base port register */
uint8_t pinCmod1; /**< The Cmod1 pin position (bit number) in the port */
GPIO_PRT_Type * portCmod2; /**< The pointer to the Cmod2 pin base port register */
uint8_t pinCmod2; /**< The Cmod2 pin position (bit number) in the port */
uint8_t dmaWrChIndex; /**< Specifies the DMA Write channel index */
uint8_t dmaChainWrChIndex; /**< Specifies the DMA Chain Write channel index */
uint8_t dmaRdChIndex; /**< Specifies the DMA Read channel index */
uint8_t dmaChainRdChIndex; /**< Specifies the DMA Chain Read channel index */
} cy_stc_msc_channel_config_t;
#endif /* (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3) */
/** Common configuration structure */
typedef struct
{
uint32_t cpuClkHz; /**< CPU clock in Hz */
uint32_t periClkHz; /**< Peripheral clock in Hz */
uint16_t vdda; /**< VDDA in mV */
uint16_t numPin; /**< Total number of IOs. */
uint16_t numSns; /**< The total number of sensors. It is equal to the number of objects with raw count.
* * For CSD widgets: WD_NUM_ROWS + WD_NUM_COLS
* * For CSX widgets: WD_NUM_ROWS * WD_NUM_COLS */
uint8_t numWd; /**< Total number of widgets */
uint8_t csdEn; /**< CSD sensing method enabled, at least one CSD widget is configured */
uint8_t csxEn; /**< CSX sensing method enabled, at least one CSX widget is configured */
uint8_t mfsEn; /**< Multi-frequency Scan (MFS) enabled */
uint8_t positionFilterEn; /**< Position filtering enabled */
uint8_t bistEn; /**< Built-in Self-test (BIST) enabled */
uint8_t periDividerType; /**< Peripheral clock type (8- or 16-bit type) */
uint8_t periDividerIndex; /**< Peripheral divider index */
uint8_t analogWakeupDelay; /**< Time needed to establish correct operation of the CSD HW block after power up or System Deep Sleep. */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t ssIrefSource; /**< Iref source */
uint8_t ssVrefSource; /**< Vref source */
#endif
uint16_t proxTouchCoeff; /**< Proximity touch coefficient in percentage used in SmartSense */
uint8_t swSensorAutoResetEn; /**< Sensor auto reset enabled */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t portCmodPadNum; /**< Number of port of dedicated Cmod pad */
uint8_t pinCmodPad; /**< Position of the dedicated Cmod pad in the port */
uint8_t portCshPadNum; /**< Number of port of dedicated Csh pad */
uint8_t pinCshPad; /**< Position of the dedicated Csh pad in the port */
uint8_t portShieldPadNum; /**< Number of port of dedicated Shield pad */
uint8_t pinShieldPad; /**< Position of the dedicated Shield pad in the port */
uint8_t portVrefExtPadNum; /**< Number of port of dedicated VrefExt pad */
uint8_t pinVrefExtPad; /**< Position of the dedicated VrefExt pad in the port */
uint8_t portCmodNum; /**< Number of port of Cmod pin */
cy_stc_capsense_idac_gain_table_t idacGainTable[CY_CAPSENSE_IDAC_GAIN_NUMBER];
/**< Table with the supported IDAC gains and corresponding register values */
CSD_Type * ptrCsdBase; /**< Pointer to the CSD HW block register */
cy_stc_csd_context_t * ptrCsdContext; /**< Pointer to the CSD driver context */
GPIO_PRT_Type * portCmod; /**< Pointer to the base port register of the Cmod pin */
GPIO_PRT_Type * portCsh; /**< Pointer to the base port register of the Csh pin */
GPIO_PRT_Type * portCintA; /**< Pointer to the base port register of the CintA pin */
GPIO_PRT_Type * portCintB; /**< Pointer to the base port register of the CintB pin */
uint8_t pinCmod; /**< Position of the Cmod pin in the port */
uint8_t portCshNum; /**< Number of port of Csh pin */
uint8_t pinCsh; /**< Position of the Csh pin in the port */
uint8_t pinCintA; /**< Position of the CintA pin in the port */
uint8_t pinCintB; /**< Position of the CintB pin in the port */
uint8_t csdShieldEn; /**< Shield enabled */
#endif
uint8_t csdInactiveSnsConnection; /**< Inactive sensor connection state:
* * CY_CAPSENSE_SNS_CONNECTION_HIGHZ
* * CY_CAPSENSE_SNS_CONNECTION_SHIELD
* * CY_CAPSENSE_SNS_CONNECTION_GROUND */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csdShieldDelay; /**< Shield signal delay */
uint16_t csdVref; /**< Vref for CSD method */
#endif
uint16_t csdRConst; /**< Sensor resistance in series used by SmartSense */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csdCTankShieldEn; /**< Csh enabled */
#endif
uint8_t csdShieldNumPin; /**< Number of shield IOs */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csdShieldSwRes; /**< Shield switch resistance */
uint8_t csdInitSwRes; /**< Switch resistance at coarse initialization */
uint8_t csdChargeTransfer; /**< IDAC sensing configuration */
#endif
uint8_t csdRawTarget; /**< Raw count target in percentage for CSD calibration */
uint8_t csdAutotuneEn; /**< SmartSense enabled */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csdIdacAutocalEn; /**< CSD IDAC calibration enabled */
uint8_t csdIdacGainInitIndex; /**< IDAC gain index per \ref idacGainTable */
uint8_t csdIdacAutoGainEn; /**< IDAC gain auto-calibration enabled */
#endif
uint8_t csdCalibrationError; /**< Acceptable calibration error */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csdIdacMin; /**< Min acceptable IDAC value in CSD calibration */
uint8_t csdIdacCompEn; /**< Compensation IDAC enabled */
uint8_t csdFineInitTime; /**< Number of dummy SnsClk periods at fine initialization */
uint8_t csdIdacRowColAlignEn; /**< Row-Column alignment enabled. It adjusts modulator IDAC for rows
* and for columns to achieve the similar sensitivity */
#endif
uint8_t csdMfsDividerOffsetF1; /**< Frequency divider offset for channel 1. This value is added to
* base (channel 0) SnsClk divider to form channel 1 frequency */
uint8_t csdMfsDividerOffsetF2; /**< Frequency divider offset for channel 2. This value is added to
* base (channel 0) SnsClk divider to form channel 2 frequency */
uint8_t csxRawTarget; /**< Raw count target in percentage for CSX calibration */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csxIdacGainInitIndex; /**< IDAC gain for CSX method */
uint8_t csxRefGain; /**< Refgen gain for CSX method */
uint8_t csxIdacAutocalEn; /**< CSX IDAC calibration enabled */
#endif
uint8_t csxCalibrationError; /**< Acceptable calibration error */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csxFineInitTime; /**< Number of dummy TX periods at fine initialization */
uint8_t csxInitSwRes; /**< Switch resistance at fine initialization */
uint8_t csxScanSwRes; /**< Switch resistance at scanning */
uint8_t csxInitShieldSwRes; /**< Switch resistance at fine initialization */
uint8_t csxScanShieldSwRes; /**< Switch resistance at scanning */
#endif
uint8_t csxMfsDividerOffsetF1; /**< Frequency divider offset for channel 1. This value is added to
* base (channel 0) Tx divider to form channel 1 frequency */
uint8_t csxMfsDividerOffsetF2; /**< Frequency divider offset for channel 2. This value is added to
* base (channel 0) Tx divider to form channel 2 frequency */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
cy_stc_msc_channel_config_t * ptrMscChConfig; /**< The pointer to the CapSense enabled MSC channel (HW block) configuration */
DMAC_Type * ptrDmacBase; /**< Pointer to the DMAC HW block base register */
const uint32_t ** ptrDmaWrChSnsCfgAddr; /**< Pointer to the array containing the addresses of sensor configurations
* used as a source for the DMA Chain Write channel */
const uint16_t ** ptrDmaRdChSnsCfgAddr; /**< Pointer to the array containing the addresses of sensor configurations
* used as a source for the DMA Chain Read channel */
uint16_t numEpiCycles; /**< Number of clk_mod cycles to be run during EPILOGUE */
uint16_t numCoarseInitChargeCycles; /**< Configure duration of Cmod initialization, phase 1 */
uint16_t numCoarseInitSettleCycles; /**< Configure duration of Cmod initialization, phase 2 */
uint16_t numSlots; /**< Total number of slots */
uint8_t csdShieldMode; /**< Shield mode
* * CY_CAPSENSE_SHIELD_DISABLED
* * CY_CAPSENSE_SHIELD_ACTIVE
* * CY_CAPSENSE_SHIELD_PASSIVE */
uint8_t sensorConnection; /**< Sensor Connection. In CS-DMA mode, sensor connection set to CTRLMUX.
* * 0 - CY_CAPSENSE_AMUX_SENSOR_CONNECTION_METHOD:
* All AMUX capable GPIOs available as sensor.
* * 1 - CY_CAPSENSE_CTRLMUX_SENSOR_CONNECTION_METHOD:
* Only dedicated GPIO available as sensor.
*/
uint8_t csdCdacAutocalEn; /**< CSD CDAC calibration enabled */
uint8_t csdCdacCompEn; /**< CSD Compensation CDAC enabled */
uint8_t csxCdacAutocalEn; /**< CSX CDAC calibration enabled */
uint8_t csxCdacCompEn; /**< CSX Compensation CDAC enabled */
uint8_t csxAutotuneEn; /**< CSX SmartSense enabled */
uint8_t scanningMode; /**< Scanning Mode:
* * 0 - CY_CAPSENSE_SCAN_MODE_INT_DRIVEN
* * 1 - CY_CAPSENSE_SCAN_MODE_DMA_DRIVEN */
uint8_t mptxEn; /**< Mupti-phase TX enabled */
uint8_t chopPolarity; /**< Select polarity for system level chopping */
uint8_t cicFilterMode; /**< CIC filter mode:
* * 0 - CY_CAPSENSE_CIC_FILTER
* * 1 - CY_CAPSENSE_CIC2_FILTER */
uint8_t numBadScans; /**< 1 to 7, repeat scan upon "bad" scan. Disabled = 0. */
uint8_t counterMode; /**< Select overflow or saturate mode for raw count:
* * 0 - CY_CAPSENSE_COUNTER_MODE_SATURATE
* * 1 - CY_CAPSENSE_COUNTER_MODE_OVERFLOW */
uint8_t syncFrameStartEn; /**< Enable external synchronization signals */
uint8_t syncClockEn; /**< Enable external synchronization signals */
uint8_t syncMode; /**< Synchronization mode:
* * 0 - CY_CAPSENSE_SYNC_MODE_OFF
* * 1 - CY_CAPSENSE_SYNC_EXTERNAL
* * 2 - CY_CAPSENSE_SYNC_INTERNAL */
uint8_t masterChannelId; /**< The ID of the Master channel MULTI-CHIP solution.
* This channel will generate msc_ext_frm_start_out
* and msc_ext_sync_clk_out signals */
uint8_t numChips; /**< The chip number for MULTI-CHIP solution. For SINGLE-CHIP is equal to 1u */
uint8_t numChannels; /**< The number of CapSense enabled MSCv3 blocks in the current chip */
uint8_t channelOffset; /**< The ID of the first channel that belongs to the current chip */
#endif
} cy_stc_capsense_common_config_t;
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
/** Declares BIST Context Data Structure */
typedef struct
{
uint32_t testResultMask; /**< The bit mask of test results (PASS/FAIL) */
uint16_t wdgtCrcCalc; /**< A calculated by test CRC for a widget context structure */
uint8_t crcWdgtId; /**< The first CRC failed widget ID */
uint8_t shortedWdId; /**< The first shorted to GND/VDDA/ELTD widget ID */
uint8_t shortedSnsId; /**< The first shorted to GND/VDDA/ELTD sensor ID */
uint16_t * ptrWdgtCrc; /**< The pointer to the widget CRC array */
uint32_t shieldCap; /**< The shield capacitance measurement result in femtofarads */
uint16_t cModCap; /**< The Cmod capacitance measurement result in picofarads */
uint16_t cIntACap; /**< The CintA capacitance measurement result in picofarads */
uint16_t cIntBCap; /**< The CIntB capacitance measurement result in picofarads */
uint16_t cShieldCap; /**< The Cshield capacitance measurement result in picofarads */
uint16_t vddaVoltage; /**< The result of VDDA measurement in millivolts */
cy_en_capsense_bist_hw_config_t hwConfig; /**< A HW configuration for BIST operations */
cy_en_capsense_bist_io_state_t currentISC; /**< The current state of sensors when not being measured during the sensor capacitance measurement */
cy_en_capsense_bist_io_state_t shieldCapISC; /**< The state of sensors when not being measured during the shield capacitance measurement.
* * CY_CAPSENSE_SNS_CONNECTION_HIGHZ
* * CY_CAPSENSE_SNS_CONNECTION_SHIELD
* * CY_CAPSENSE_SNS_CONNECTION_GROUND */
cy_en_capsense_bist_io_state_t eltdCapCsdISC; /**< The state of sensors when not being measured during the CSD sensor capacitance measurement.
The states are the same as of the previous parameter */
cy_en_capsense_bist_io_state_t eltdCapCsxISC; /**< The state of sensors when not being measured during the CSX sensor capacitance measurement.
* * CY_CAPSENSE_SNS_CONNECTION_HIGHZ
* * CY_CAPSENSE_SNS_CONNECTION_GROUND */
uint16_t eltdCapModClk; /**< The ModClk divider for electrode capacitance measurement scans */
uint16_t eltdCapSnsClk; /**< The SnsClk divider for electrode capacitance measurement scans */
uint32_t eltdCapSnsClkFreqHz; /**< The value of the SnsClk frequency is Hz */
uint16_t eltdCapResolution; /**< The resolution for electrode capacitance measurement scans */
uint16_t eltdCapVrefMv; /**< The Vref value in mV for electrode capacitance measurement scans */
uint8_t eltdCapVrefGain; /**< The Vref gain for electrode capacitance measurement scans */
uint8_t fineInitTime; /**< Number of dummy SnsClk periods at fine initialization for BIST scans */
uint8_t snsIntgShortSettlingTime; /**< The sensor and shield short check time in microseconds */
uint16_t capacitorSettlingTime; /**< The maximum possible external capacitor charge/discharge time in microseconds */
uint16_t vddaModClk; /**< The ModClk divider for VDDA measurements */
uint16_t vddaVrefMv; /**< The Vref value in mV for VDDA measurements */
uint8_t vddaVrefGain; /**< The Vref gain for VDDA measurements */
uint8_t vddaIdacDefault; /**< The IDAC default code for Vdda measurements */
uint8_t vddaAzCycles; /**< The auto-zero time in Sns cycles for Vdda measurements */
uint8_t vddaAcqCycles; /**< The acquisition time in Sns cycles - 1 for Vdda measurements */
uint16_t extCapModClk; /**< The ModClk divider for external capacitor capacity measurements */
uint16_t extCapSnsClk; /**< The SnsClk divider for external capacitor capacity measurements */
uint16_t extCapVrefMv; /**< The Vref value in mV for external capacitor capacity measurements */
uint8_t extCapVrefGain; /**< The Vref gain for external capacitor capacitance measurements */
uint32_t extCapIdacPa; /**< The IDAC value in pA for external capacitor capacity measurements */
uint16_t extCapWDT; /**< The SW watchdog timeout used to prevent a hang in case of short */
uint32_t regSwHsPSelScan; /**< Internal pre-calculated data for faster operation */
uint32_t regSwHsPSelCmodInit; /**< Internal pre-calculated data for faster operation */
uint32_t regSwHsPSelCtankInit; /**< Internal pre-calculated data for faster operation */
uint32_t regSwDsiSel; /**< Internal pre-calculated data for faster operation */
uint32_t regSwShieldSelScan; /**< Internal pre-calculated data for faster operation */
uint32_t regSwResInit; /**< Internal pre-calculated data for faster operation */
uint32_t regSwResScan; /**< Internal pre-calculated data for faster operation */
uint32_t regSwBypSel; /**< Internal pre-calculated data for faster operation */
uint32_t regSwAmuxbufSel; /**< Internal pre-calculated data for faster operation */
uint32_t regAmbuf; /**< Internal pre-calculated data for faster operation */
uint32_t regHscmpScan; /**< Internal pre-calculated data for faster operation */
uint32_t regSwRefgenSel; /**< Internal pre-calculated data for faster operation */
uint32_t regConfig; /**< Internal pre-calculated data for faster operation */
uint32_t regIoSel; /**< Internal pre-calculated data for faster operation */
uint32_t regAmbufShield; /**< Internal pre-calculated data for faster operation */
uint32_t regHscmpScanShield; /**< Internal pre-calculated data for faster operation */
uint32_t regSwShieldSelScanShield; /**< Internal pre-calculated data for faster operation */
uint32_t regSwHsPSelScanShield; /**< Internal pre-calculated data for faster operation */
uint32_t regSwBypSelShield; /**< Internal pre-calculated data for faster operation */
uint32_t regSwAmuxbufSelShield; /**< Internal pre-calculated data for faster operation */
uint32_t regConfigShield; /**< Internal pre-calculated data for faster operation */
uint32_t regIoSelShield; /**< Internal pre-calculated data for faster operation */
}
cy_stc_capsense_bist_context_t;
/** Declares the BIST structure with custom scan parameters */
typedef struct
{
cy_en_capsense_bist_io_state_t customISC; /**< The inactive state of sensors during the custom scan */
uint16_t modClk; /**< The ModClk divider for a custom scan. The minimum value is 1 and the maximum depends on a divider type,
but for a reliable CSD HW block operation, it is recommended to provide
a modulation clock frequency in the range from 1 to 50 MHz */
uint16_t snsClk; /**< The SnsClk divider for a custom scan. The minimum value is 4 and the maximum is 4095,
but for a reliable CSD HW block operation, it is recommended to provide
an sensor clock frequency in the range from 100 to 6000 kHz */
uint16_t convNum; /**< The number of conversions for a custom scan. The maximum raw counts is equal (convNum * snsClkDivider - 1),
that corresponds to (2^Resolution - 1) in older notations. The minimum value is 4 and the maximum is 65535,
but as the maximum raw counts is 65535, the convNum value should be less than (65536 / snsClkDivider) */
uint8_t vrefGain; /**< The Vref gain for a custom scan */
uint8_t idacMod; /**< Sets the code of the modulation IDAC for a custom scan */
uint8_t idacGainIndex; /**< Index of IDAC gain in table \ref cy_stc_capsense_idac_gain_table_t */
uint8_t fineInitTime; /**< Number of dummy SnsClk periods at fine initialization for a custom scan */
}cy_stc_capsense_bist_custom_parameters_t;
#endif
/** Declares active sensor details */
typedef struct
{
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
void (* ptrISRCallback)(void * context); /**< Pointer to the interrupt handler of the active sensor */
#endif
const cy_stc_capsense_widget_config_t * ptrWdConfig; /**< Pointer to the widget configuration structure of the active sensor */
cy_stc_capsense_widget_context_t * ptrWdContext; /**< Pointer to the widget context structure of the active sensor */
const cy_stc_capsense_electrode_config_t * ptrEltdConfig; /**< Pointer to the electrode configuration structure of the active sensor */
const cy_stc_capsense_electrode_config_t * ptrRxConfig; /**< Pointer to the Rx electrode configuration structure of the active sensor */
const cy_stc_capsense_electrode_config_t * ptrTxConfig; /**< Pointer to the Tx electrode configuration structure of the active sensor */
cy_stc_capsense_sensor_context_t * ptrSnsContext; /**< Pointer to the sensor context structure */
uint16_t currentChannelSlotIndex; /**< Current slot Index for channel */
uint16_t sensorIndex; /**< Current sensor ID */
uint8_t widgetIndex; /**< Current widget ID */
uint8_t rxIndex; /**< Current Rx ID */
uint8_t txIndex; /**< Current Tx ID */
uint8_t connectedSnsState; /**< Shows if the current sensor is connected to analog bus */
uint8_t scanScopeAll; /**< Request of scanning all widgets */
uint8_t scanScopeSns; /**< Request of scanning a single sensor */
uint8_t mfsChannelIndex; /**< MFS channel index */
uint8_t currentSenseMethod; /**< Current sensing method */
uint8_t currentSenseGroup; /**< Current sensing group */
uint8_t currentHwMode; /**< Current hw mode */
} cy_stc_active_scan_sns_t;
/**
* Provides the typedef for the callback function that is intended to be called when
* the \ref cy_en_capsense_callback_event_t events occurs.
*/
typedef void (*cy_capsense_callback_t)(cy_stc_active_scan_sns_t * ptrActiveScan);
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
/**
* Provides the typedef for the callback function that is called by the
* Cy_CapSense_Enable() function to change the CapSense configuration from
* the default configuration to the user's specific use cases.
* Refer to \ref group_capsense_callbacks section.
*/
typedef void (*cy_capsense_ds_init_callback_t)(void * context);
#endif
/**
* Provides the typedef for the callback function that is called by the
* Cy_CapSense_RunTuner() function to establish communication with
* the CapSense Tuner tool to monitor CapSense operation.
* Refer to \ref group_capsense_callbacks section.
*/
typedef void (*cy_capsense_tuner_send_callback_t)(void * context);
/**
* Provides the typedef for the callback function that is called by the
* Cy_CapSense_RunTuner() function to establish communication with
* the CapSense Tuner tool to support life-time tunning.
* Refer to \ref group_capsense_callbacks section.
*/
typedef void (*cy_capsense_tuner_receive_callback_t)(uint8_t ** commandPacket, uint8_t ** tunerPacket, void * context);
/** Declares internal Context Data Structure */
typedef struct
{
uint32_t csdInactiveSnsDm; /**< Internal pre-calculated data for faster operation */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint32_t csdRegConfig; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwHsPSelScan; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwHsPSelCmodInit; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwHsPSelCtankInit; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwBypSel; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwResScan; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwResInit; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwDsiSel; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegAmuxbufInit; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwAmuxbufSel; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwShieldSelScan; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegHscmpInit; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegHscmpScan; /**< Internal pre-calculated data for faster operation */
uint32_t csdIdacAConfig; /**< Internal pre-calculated data for faster operation */
uint32_t csdIdacBConfig; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwCmpPSel; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwCmpNSel; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegIoSel; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegRefgen; /**< Internal pre-calculated data for faster operation */
uint32_t csdRegSwRefGenSel; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegConfigInit; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegConfigScan; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegSwResInit; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegSwResPrech; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegSwResScan; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegAMuxBuf; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegRefgen; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegRefgenSel; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegSwCmpNSel; /**< Internal pre-calculated data for faster operation */
uint32_t csxRegSwRefGenSel; /**< Internal pre-calculated data for faster operation */
uint8_t csdCmodConnection; /**< Internal pre-calculated data for faster operation */
uint8_t csdCshConnection; /**< Internal pre-calculated data for faster operation */
#endif
en_hsiom_sel_t csdInactiveSnsHsiom; /**< Internal pre-calculated data for faster operation */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t csdVrefGain; /**< Internal pre-calculated data for faster operation */
uint16_t csdVrefVoltageMv; /**< Internal pre-calculated data for faster operation */
#endif
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
uint8_t snsConfigSize; /**< The size of sensor configuration structure */
uint8_t numSenseMethod; /**< The number of sense methods, used in the project */
uint8_t numFunc; /**< The number of CTRLMUX pin functions, used in the project */
uint8_t mapSenseMethod[CY_CAPSENSE_REG_MODE_NUMBER]; /**< The map array of sense methods, used in the project */
uint8_t mapPinState[CY_CAPSENSE_PIN_STATE_NUMBER]; /**< The map array of CTRLMUX pin functions, used in the project */
uint16_t slotIndex; /**< Slot ID */
uint16_t currentSlotIndex; /**< Current slot ID */
uint16_t endSlotIndex; /**< The last slot ID for the current frame */
void (* ptrISRCallback)(void * context); /**< Pointer to the scan interrupt handler */
cy_capsense_callback_t ptrSSCallback; /**< Pointer to a user's Start Sample callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_callback_t ptrEOSCallback; /**< Pointer to a user's End Of Scan callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_tuner_send_callback_t ptrTunerSendCallback; /**< Pointer to a user's tuner callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_tuner_receive_callback_t ptrTunerReceiveCallback; /**< Pointer to a user's tuner callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_ds_init_callback_t ptrEODsInitCallback; /**< Pointer to a user's End Of Data Structure Initialization callback function. Refer to \ref group_capsense_callbacks section */
uint8_t filterBitFormat; /**< Internal pre-calculated data for faster operation */
#endif
}cy_stc_capsense_internal_context_t;
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
/** Declares the structure that is intended to store the \ref cy_stc_capsense_widget_context_t
data structure fields, the CRC checking should be applied for. */
typedef struct
{
uint16_t fingerThVal; /**< The value of the .fingerTh field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t proxThVal; /**< The value of the .proxTh field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t fingerCapVal; /**< The value of the .fingerCap field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t sigPFCVal; /**< The value of the .sigPFC field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t resolutionVal; /**< The value of the .resolution field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t lowBslnRstVal; /**< The value of the .lowBslnRst field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t snsClkVal; /**< The value of the .snsClk field of the \ref cy_stc_capsense_widget_context_t structure */
uint16_t rowSnsClkVal; /**< The value of the .rowSnsClk field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t onDebounceVal; /**< The value of the .onDebounce field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t snsClkSourceVal; /**< The value of the .snsClkSource field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t idacModVal[CY_CAPSENSE_FREQ_CHANNELS_NUM]; /**< The value of the .idacMod field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t idacGainIndexVal; /**< The value of the .idacGainIndex field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t rowIdacModVal[CY_CAPSENSE_FREQ_CHANNELS_NUM]; /**< The value of the .rowIdacMod field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t noiseThVal; /**< The value of the .noiseTh field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t nNoiseThVal; /**< The value of the .nNoiseTh field of the \ref cy_stc_capsense_widget_context_t structure */
uint8_t hysteresisVal; /**< The value of the .hysteresis field of the \ref cy_stc_capsense_widget_context_t structure */
}cy_stc_capsense_widget_crc_data_t;
#endif
/** \} */
/******************************************************************************/
/** \addtogroup group_capsense_structures *//** \{ */
/******************************************************************************/
/** Declares top-level Context Data Structure */
typedef struct
{
uint16_t configId; /**< 16-bit CRC calculated by the CapSense Configurator tool for the CapSense configuration.
* Used by the CapSense Tuner tool to identify if the FW corresponds to the specific user configuration. */
uint16_t tunerCmd; /**< Tuner Command Register \ref cy_en_capsense_tuner_cmd_t.
* Used for the communication between the CapSense Tuner tool and the middleware */
uint16_t scanCounter; /**< This counter increments after each scan. */
uint8_t tunerSt; /**< State of CapSense middleware tuner module. \ref cy_en_capsense_tuner_state_t */
uint8_t initDone; /**< Keep information whether initialization was done or not */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
cy_capsense_callback_t ptrSSCallback; /**< Pointer to a user's Start Sample callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_callback_t ptrEOSCallback; /**< Pointer to a user's End Of Scan callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_tuner_send_callback_t ptrTunerSendCallback; /**< Pointer to a user's tuner callback function. Refer to \ref group_capsense_callbacks section */
cy_capsense_tuner_receive_callback_t ptrTunerReceiveCallback; /**< Pointer to a user's tuner callback function. Refer to \ref group_capsense_callbacks section */
#endif
volatile uint32_t status; /**< Middleware status information, scan in progress (1) or not (0).
* For MSCv3 each bit shows the correspondent channel status */
uint32_t timestampInterval; /**< Timestamp interval used at increasing the timestamp by Cy_CapSense_IncrementGestureTimestamp() */
uint32_t timestamp; /**< Current timestamp should be kept updated and operational, which is vital for the
* operation of Gesture and Ballistic multiplier features */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
uint8_t modCsdClk; /**< The modulator clock divider for the CSD widgets */
uint8_t modCsxClk; /**< The modulator clock divider for the CSX widgets */
#endif
uint8_t tunerCnt; /**< Command counter of CapSense middleware tuner module */
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
uint8_t numFineInitCycles; /**< Number of ProDummy SubConversions */
uint16_t numFineInitWaitCycles; /**< Number of ProDummy Wait Cycles */
uint16_t lfsrPoly; /**< LFSR Polynomial */
uint8_t lfsrScale; /**< LFSR Scale value */
uint8_t cdacDitherSeed; /**< Dither CDAC Seed */
uint8_t cdacDitherPoly; /**< Dither CDAC Polynomial */
uint8_t modClk; /**< The modulator clock divider */
#endif
} cy_stc_capsense_common_context_t;
/** Declares top-level CapSense context data structure */
typedef struct
{
const cy_stc_capsense_common_config_t * ptrCommonConfig; /**< Pointer to the common configuration structure */
cy_stc_capsense_common_context_t * ptrCommonContext; /**< Pointer to the common context structure */
cy_stc_capsense_internal_context_t * ptrInternalContext; /**< Pointer to the internal context structure */
const cy_stc_capsense_widget_config_t * ptrWdConfig; /**< Pointer to the widget configuration structure */
cy_stc_capsense_widget_context_t * ptrWdContext; /**< Pointer to the widget context structure */
const cy_stc_capsense_pin_config_t * ptrPinConfig; /**< Pointer to the pin configuration structure */
const cy_stc_capsense_pin_config_t * ptrShieldPinConfig; /**< Pointer to the shield pin configuration structure */
cy_stc_active_scan_sns_t * ptrActiveScanSns; /**< Pointer to the current active sensor structure */
const void * ptrFptrConfig; /**< Pointer to the function pointers structure */
#if (CY_CAPSENSE_PLATFORM_BLOCK_CSDV2)
cy_stc_capsense_bist_context_t * ptrBistContext; /**< Pointer to the BIST context structure */
#endif
#if (CY_CAPSENSE_PLATFORM_BLOCK_MSCV3)
cy_stc_msc_base_config_t * ptrBaseFrameContext; /**< Pointer to the first member of the context structure of base configuration array */
uint32_t * ptrSensorFrameContext; /**< Pointer to the context structure of sensor configuration */
const cy_stc_capsense_scan_slot_t * ptrScanSlots; /**< Pointer to the scan order slot structure */
#endif
} cy_stc_capsense_context_t;
/** The type of a pointer to the Cy_CapSense_CSDSetupWidget() function */
typedef void (*cy_func_capsense_csd_setup_widget_ptr_t)
(uint32_t widgetId,
cy_stc_capsense_context_t * context);
/** The type of a pointer to the Cy_CapSense_CSDScan() function */