-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcy_capsense_selftest.h
153 lines (124 loc) · 6.22 KB
/
cy_capsense_selftest.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
/***************************************************************************//**
* \file cy_capsense_selftest.h
* \version 3.0
*
* \brief
* This file provides the function prototypes of the BIST module.
*
********************************************************************************
* \copyright
* Copyright 2019-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_SELFTEST_H)
#define CY_CAPSENSE_SELFTEST_H
#include "cy_syslib.h"
#include "cy_capsense_common.h"
#include "cy_capsense_structure.h"
#if (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2))
#if defined(__cplusplus)
extern "C" {
#endif
/* Sense Clock frequency in Hz for sensors capacitance measurement. */
#define CY_CAPSENSE_BIST_ELTD_CAP_SNSCLK_DEFAULT (375000uL)
/* The default maximum possible external capacitor charge/discharge time in microseconds */
#define CY_CAPSENSE_BIST_CAP_SETTLING_TIME_DEFAULT (2u)
/* The all available tests mask for the Cy_CapSense_RunSelfTest() function */
#define CY_CAPSENSE_BIST_RUN_AVAILABLE_SELF_TEST_MASK (CY_CAPSENSE_BIST_CRC_WDGT | \
CY_CAPSENSE_BIST_SNS_INTEGRITY | \
CY_CAPSENSE_BIST_SNS_CAP | \
CY_CAPSENSE_BIST_SHIELD_CAP | \
CY_CAPSENSE_BIST_EXTERNAL_CAP |\
CY_CAPSENSE_BIST_VDDA)
/*******************************************************************************
* CapSense BIST Enumerated Types
*******************************************************************************/
/******************************************************************************/
/** \addtogroup group_capsense_enums *//** \{ */
/******************************************************************************/
/** Defines IDs of the external capacitors */
typedef enum
{
CY_CAPSENSE_BIST_CMOD_ID_E = 0x00u, /**< ID for Cmod external capacitor */
CY_CAPSENSE_BIST_CINTA_ID_E = 0x01u, /**< ID for CintA external capacitor */
CY_CAPSENSE_BIST_CINTB_ID_E = 0x02u, /**< ID for CintB external capacitor */
CY_CAPSENSE_BIST_CSH_ID_E = 0x03u, /**< ID for Csh external capacitor */
} cy_en_capsense_bist_external_cap_id_t;
/** \} */
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
/******************************************************************************/
/** \addtogroup group_capsense_high_level *//** \{ */
/******************************************************************************/
cy_en_capsense_bist_status_t Cy_CapSense_RunSelfTest(
uint32_t testEnMask,
cy_stc_capsense_context_t * context);
/** \} */
/******************************************************************************/
/** \addtogroup group_capsense_low_level *//** \{ */
/******************************************************************************/
cy_en_capsense_bist_status_t Cy_CapSense_CheckCRCWidget(
uint32_t widgetId,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_CheckIntegritySensorRawcount(
uint32_t widgetId,
uint32_t sensorId,
uint16_t rawcountHighLimit,
uint16_t rawcountLowLimit,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_CheckIntegritySensorBaseline(
uint32_t widgetId,
uint32_t sensorId,
uint16_t baselineHighLimit,
uint16_t baselineLowLimit,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_CheckIntegritySensorPins(
uint32_t widgetId,
uint32_t sensorId,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_MeasureCapacitanceSensor(
uint32_t widgetId,
uint32_t sensorId,
uint32_t * ptrValue,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_MeasureCapacitanceShield(
uint32_t * ptrValue,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_MeasureCapacitanceCap(
cy_en_capsense_bist_external_cap_id_t integrationCapId,
uint32_t * ptrValue,
uint32_t maxCapacitance,
cy_stc_capsense_context_t * context);
cy_en_capsense_bist_status_t Cy_CapSense_MeasureVdda(
uint32_t * ptrValue,
cy_stc_capsense_context_t * context);
/** \} */
/******************************************************************************/
/** \cond SECTION_CAPSENSE_INTERNAL */
/** \addtogroup group_capsense_internal *//** \{ */
/******************************************************************************/
cy_en_capsense_bist_status_t Cy_CapSense_MeasureCapacitanceSensorExt(
uint32_t widgetId,
uint32_t sensorId,
cy_stc_capsense_bist_custom_parameters_t * ptrScanConfig,
uint32_t * ptrValue,
cy_stc_capsense_context_t * context);
void Cy_CapSense_BistInitialize(
cy_stc_capsense_context_t * context);
void Cy_CapSense_BistDisableMode(
cy_stc_capsense_context_t * context);
void Cy_CapSense_BistDsInitialize(
cy_stc_capsense_context_t * context);
void Cy_CapSense_UpdateCrcWidget(
uint32_t widgetId,
cy_stc_capsense_context_t * context);
/** \} \endcond */
#if defined(__cplusplus)
}
#endif
#endif /* (defined(CY_IP_MXCSDV2) || defined(CY_IP_M0S8CSDV2)) */
#endif /* CY_CAPSENSE_SELFTEST_H */
/* [] END OF FILE */