AN230370 Precision analog channel subsystem in PSoC 4 HV PA family

The current sensor line uses the RSH/RSL and RSH2/RSL2 terminals of the PSoC™ 4 HV PA MCU (See Figure 3). The RSH/RSL terminals are for the main line, and the RSH2/RSL2 terminals are for diagnostics. In the circuit example below, the sense output of one shunt resistor is routed to both RSH/RSL and RSH2/RSL2 terminals.

The external resistor and capacitor are optional low-pass filter components to attenuate any external noise for your application.

Table 1 shows an example of external components.

Figure 4 shows an example of current sensor line layout. Note that RSH2/RSL2 components are placed on bottom layer which are same position as RSH/RSL. This figure only shows top layer.

Follow these guidelines for the design of the current sensor line circuit on the PSoC™ 4 HV PA MCU:

• Match the length of each pair of RSHx and RSLx traces by routing on top or bottom layers of the PCB
• Keep the width of RSHx/RSLx traces as the same as the IC Pad width
• Do not use through-hole vias on the RSH/RSL trace if possible
• Connect shunt resistor tracks from the inner edges of its solder pad to the IC as a differential pair
• Keep the distance between RSHx and RSLx traces as the same as the IC terminal pitch if possible
• Guard the entire pattern with GND
• Place the GND layer under the sensor lines

The voltage sense line uses the VSENSE and VDIAG terminals of the PSoC™ 4 HV PA MCU (See Figure 5). The VSENSE terminal is for the main line, while the VDIAG terminal is for diagnostic. In the circuit example below, the battery voltage input (VBAT) is divided into two and input to each terminal.

VSENSE and VDIAG inputs are normally connected directly to the battery with a series 2.2-kΩ resistor to measure the battery voltage; the capacitors are for low-pass filtering. The external transient voltage suppressors (TVS) diodes are to protect ESD noise. The TVS diodes are optional components.

Table 2 shows an example of external components.

Figure 6 shows an example of the voltage sensor line layout.

Follow these guidelines for the design of voltage sensor line circuit on the PSoC™ 4 HV PA MCU:

• Length match the VSENSE and VDIAG traces as close as possible
• Wire the VSENSE and VDIAG sensor lines from each VBAT point
• Keep the trace width in the range of "0.127 mm" to the "IC terminal width"
• Guard the entire pattern with GND
• Place the GND layer under the sensor line

The temperature sensor line uses the VTEMP_SUP, VTEMP, and VTEMP_RET terminals of the PSoC™ 4 HV PA MCU (See Figure 7). VTEMP_SUP terminal is the power supply for the external temperature sensor, VTEMP is the temperature voltage input from the external sensor, and VTEMP_RET is the ground signal. In the circuit example below, the capacitors are added for decoupling the temperature sensor line.

The external voltage divider is selected to optimize temperature accuracy and will typically be comprised of a 33-kΩ and 16.9-kΩ fixed resistors (R) and a 10-kΩ nominal NTC thermistor RT (nominal NTC resistance is typically specified at 25°C).

Table 3 shows an example of external components.

Figure 8 shows an example of temperature sensor line layout.

Follow these guidelines for the design of temperature sensor line circuit on the PSoC™ 4 HV PA MCU:

• Place the thermistor (R10) as close to hot spot as possible
• Keep the VTEMP_SUP, VTEMP, and VTEMP_RET at the same length as possible
• Place the filter capacitor (C24) near the VTEMP and VTEMP_RET terminal
• Keep the trace width in the range of "0.127 mm" to "IC terminal width"
• Guard the entire pattern with GND
• Place the GND layer under the sensor line

The calibration data requires analog channel usage of ACHAN0: Current and ACHAN1: Voltage and diagnostic. See "21.2.7.1 Channel OFFSET and GAIN calibration" in the architecture TRM [5] for more details.

This example uses the multi convert design, and focuses on the calibration function. Figure 16 shows the flowchart for channel OFFSET and GAIN calibration, and Code Listing 4 shows the code example of the main function.

001	int main(void)
002	{
003	
004	    ~~~~~~ omitted ~~~~~~
005	
006	    /* Calibrate the ADC channels */
007	    Cy_Adc_CalibrateOffsetScalar(PACSS_DCHAN0);
008	    Cy_Adc_CalibrateOffsetScalar(PACSS_DCHAN1);
009	    Cy_Adc_CalibrateOffsetScalar(PACSS_DCHAN2);
010	    Adc_Calibrate(g_previousTemperature);
011	
012	    /* Start the conversion process */
013	    Cy_Adc_StartConversion(PACSS_MMIO);
014	
015	    ~~~~~~ omitted ~~~~~~
016	
017	    while (1)
018	    {
019	
020	    ~~~~~~ omitted ~~~~~~
021	
022	        // Re-calibrate if temperature changes by 5C
023	        if (g_nextTemperature > ( g_previousTemperature + CY_ADC_5_DEGREES_C_FIXED)
024	            || (g_nextTemperature < ( g_previousTemperature - 
                                                CY_ADC_5_DEGREES_C_FIXED)))
025	        {
026	            g_previousTemperature = g_nextTemperature;
027	
028	            //Re-calibrate
029	            Example_UartPrintf("Re-calibrating\r\n");
030	            Adc_Calibrate(g_nextTemperature);
031	        }
032	    }
033	}
034	
035	/******************************************************************************
036	* Adc_Calibrate
037	*******************************************************************************
038	* Calibrate the AGC, the VSENSE, and Diagnostic channels to the temperature
039	* \param temperature The temperature in fixed point 12.20 format
040	******************************************************************************/
041	void Adc_Calibrate(int32_t temperature)
042	{
043	    uint16_t gcor;
044	    int16_t ocor;
045	
046	    Cy_Adc_CalibrateAchan1_3TempTrim(
047	            PACSS_DCHAN1,
048	            CY_ADC_ACHAN1_3TEMP_VSENSE_16,
049	            temperature);
050	    Cy_Adc_CalibrateAchan1_2TempTrim(
051	            PACSS_DCHAN2,
052	            CY_ADC_ACHAN1_2TEMP_GAIN_1X,
053	            temperature);
054	
055	    /* Calibrate the AGC Gain levels */
056	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 0, temperature,
057	        CY_ADC_ACHAN0_2TEMP_GAIN_2X);
058	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 1, temperature,
059	        CY_ADC_ACHAN0_2TEMP_GAIN_4X);
060	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 2, temperature,
061	        CY_ADC_ACHAN0_2TEMP_GAIN_8X);
062	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 3, temperature,
063	        CY_ADC_ACHAN0_2TEMP_GAIN_16X);
064	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 4, temperature,
065	        CY_ADC_ACHAN0_2TEMP_GAIN_32X);
066	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 5, temperature,
067	        CY_ADC_ACHAN0_2TEMP_GAIN_64X);
068	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 6, temperature,
069	        CY_ADC_ACHAN0_2TEMP_GAIN_128X);
070	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 7, temperature,
071	        CY_ADC_ACHAN0_2TEMP_GAIN_256X);
072	    Cy_Adc_CalibrateAgcGainLevel(PACSS_MMIO, 8, temperature,
073	        CY_ADC_ACHAN0_2TEMP_GAIN_512X);
074	
075	    /* Calibrate the current channel for static gain, AGC disabled
076	       This assumes the static gain comes from the cy_stc_adc_gain_level_config
077	       array which includes the left shift to keep the number scale the same*/
078	    Cy_Adc_GetGcorOcorAchan0_2TempTrim(&gcor, &ocor,
079	        CY_ADC_ACHAN0_2TEMP_GAIN_512X, temperature);
080	    Cy_Adc_DchanPostProcessing_SetGainCorrection(PACSS_DCHAN0, gcor);
081	    Cy_Adc_DchanPostProcessing_SetOffsetCorrection(PACSS_DCHAN0, ocor);
082	}

On-die temperature measurements are made with an internal temperature sensor by measuring bipolar VBE at different current densities and calculating temperature. Two independent current references are used for diagnosis and redundancy. In addition to temperature, die stress also causes VBE shifts but NPN and PNP bipolars respond differently to stress; therefore, arrays of both transistor types are included. See "21.2.6.2 On-die temperature sensor" in the architecture TRM for more details.

On-die temperature measurements convert the delta between two die temp measurements to degrees (celsius in fixed point 12.20 format). The following is formula of the internal temperature calculation. See "21.2.7.2 Internal temperature calculation" in the architecture TRM [5].

T = α2 * x2/234 + α1 * x/29 + α0 * 214

Where:

x = dVBE + dVBE * (A * ratio + B)

dVBE = ADC(UNIT) - ADC(1) with 29 bit signed result

ratio = ADC(UNIT) / ADC(1) with LOAD_MODE set to “resistor”

A = -0.0534, B = 0.4804

where (A * ratio + B) is a linear approximation of LN(9)/LN(ratio).

ADC(UNIT) is the measurement with UNIT_MODE and IREF_BIPOLAR_UNIT_MASK applied.

a2, a1, and a0 coefficients are read from either SFlash (two circuits, primary and alternate, are available for diagnostic)

Figure 17 shows the flow chart for internal temperature calculation, and Code Listing 5 shows the code example of main function.

001	int main(void)
002	{
003	    cy_en_adc_error_t   error                       = CY_ADC_ERROR;
004	    int32_t             dieTempOneCounts            = 0;
005	    int32_t             dieTempUnitCounts           = 0;
006	    int32_t             deltaVbe                    = 0;
007	    int32_t             deltaVbeNormalized          = 0;
008	    int32_t             tempFixed                   = 0;
009	    float32_t           tempFloat                   = 0.0;
010	    float32_t           currentRatio                = 0.0;
011	
012	    ~~~~~~ omitted ~~~~~~
013	
014	    /* Initialize the die temp configurations */
015	    Cy_Adc_InitializeDieTempConfigs(&cy_stc_die_temp_one_config,
016	        &cy_stc_die_temp_unit_config, CY_ADC_DIE_TEMP_PRIMARY);
017	
018	    Cy_Adc_InitTemperature(PACSS_MMIO, &cy_stc_die_temp_one_config);
019	    Cy_Adc_EnableTemperature(PACSS_MMIO);
020	
021	    /* Get the ratio of the resistor measurements to normalize the results */
022	    Cy_Adc_InitTemperature(PACSS_MMIO, &cy_stc_die_temp_one_config);
023	    Cy_Adc_PacssMmioTemperature_SetLoadMode(PACSS_MMIO,
024	        CY_ADC_TEMPERATURE_LOAD_MODE_RESISTOR);
025	    dieTempOneCounts = Adc_GetConversion();
026	
027	    /* Configure for the unit measurement */
028	    Cy_Adc_InitTemperature(PACSS_MMIO, &cy_stc_die_temp_unit_config);
029	    Cy_Adc_PacssMmioTemperature_SetLoadMode(PACSS_MMIO,
030	        CY_ADC_TEMPERATURE_LOAD_MODE_RESISTOR);
031	    dieTempUnitCounts = Adc_GetConversion();
032	
033	    currentRatio = (float32_t) dieTempUnitCounts / (float32_t) dieTempOneCounts;
034	
035	    ~~~~~~ omitted ~~~~~~
036	
037	    while (1)
038	    {
039	        /* Configure for the first measurement */
040	        Cy_Adc_InitTemperature(PACSS_MMIO, &cy_stc_die_temp_one_config);
041	        dieTempOneCounts = Adc_GetConversion();
042	
043	        /* Configure for the unit measurement */
044	        Cy_Adc_InitTemperature(PACSS_MMIO, &cy_stc_die_temp_unit_config);
045	        dieTempUnitCounts = Adc_GetConversion();
046	
047	        deltaVbe = dieTempUnitCounts - dieTempOneCounts;
048	        deltaVbe = deltaVbe << ADC_GET_DIE_TEMP_SHIFT;
049	        Example_UartPrintf("Diagnostic, Delta Vbe (counts): %d\r\n", deltaVbe);
050	        Cy_Adc_NormalizeDelta(&deltaVbeNormalized, deltaVbe, currentRatio);
051	        Example_UartPrintf("Diagnostic, Delta Vbe (counts): %d\r\n",
052	            deltaVbeNormalized);
053	
054	        Cy_Adc_GetDieTempFromDelta(&tempFixed, deltaVbeNormalized,
055	            CY_ADC_DIE_TEMP_PRIMARY);
056	        tempFloat = (float32_t) tempFixed / ADC_FIXED_TO_FLOAT;
057	        Example_UartPrintf("Diagnostic, Temp (C): %.02f\r\n", tempFloat);    }
058	}
059	
060	/*******************************************************************************
061	* Function Name: Cy_Adc_GetDieTempFromDelta
062	****************************************************************************//**
063	* \brief    Converts the delta between two die temp measurements to degrees
064	*           Centigrade in fixed point 12.20 format.
065	*
066	*           Uses the formula (a2 * x^2 * 2^-34 + a1 * x * 2^-9 + a0 * 2^14)/2^20
067	*           where x = Delta ADC = ADC(UNIT) - ADC(1)
068	*
069	*           The division by 2^20 is not performed, it is symbolic of the fixed
070	*           point 12.20 format of the result.
071	*
072	* \param   delta   32-bit delta between the two die temp measurements
073	* \param   result  Pointer for the conversion result in fixed point 12.20 format
074	* \param   setup   Selects the primary or alternate temperature measurement
075	*                  coefficients stored in sflash
076	*
077	* \return  #CY_ADC_ERROR_NONE if no errors occur
078	* \return  #CY_ADC_ERROR_BAD_PARAM if `delta` is invalid
079	* \return  #CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if `result` is NULL
080	*******************************************************************************/
081	cy_en_adc_error_t Cy_Adc_GetDieTempFromDelta(int32_t *result, int32_t delta,
082	    cy_en_adc_die_temp_setup_t setup)
083	{
084	    cy_en_adc_error_t status = CY_ADC_ERROR;
085	    int16_t a2 = 0;
086	    int16_t a1 = 0;
087	    int16_t a0 = 0;
088	    int64_t sqrdTerm;
089	    int64_t linearTerm;
090	    int64_t offset;
091	
092	    if (NULL == result)
093	    {
094	        status = CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL;
095	    }
096	    else
097	    {
098	        if (CY_ADC_DIE_TEMP_PRIMARY == setup)
099	        {
100	            a2 = SFLASH->unPACSS_DIAG_TEMP_P_CAL_A2.u16Register;
101	            a1 = SFLASH->unPACSS_DIAG_TEMP_P_CAL_A1.u16Register;
102	            a0 = SFLASH->unPACSS_DIAG_TEMP_P_CAL_A0.u16Register;
103	        }
104	        else
105	        {
106	            a2 = SFLASH->unPACSS_DIAG_TEMP_A_CAL_A2.u16Register;
107	            a1 = SFLASH->unPACSS_DIAG_TEMP_A_CAL_A1.u16Register;
108	            a0 = SFLASH->unPACSS_DIAG_TEMP_A_CAL_A0.u16Register;
109	        }
110	
111	        // a2 * x^2 * 2^-34
112	        sqrdTerm = delta;
113	        sqrdTerm = sqrdTerm * sqrdTerm;
114	        sqrdTerm = sqrdTerm >> DIE_TEMP_SQUARED_TERM_SHIFT;
115	        sqrdTerm = sqrdTerm * a2;
116	
117	        // a1 * x * 2^-9
118	        linearTerm = delta;
119	        linearTerm = linearTerm >> DIE_TEMP_LINEAR_TERM_SHIFT;
120	        linearTerm = linearTerm * a1;
121	
122	        // a0 * 2^14
123	        offset = a0 << DIE_TEMP_OFFSET_TERM_SHIFT;
124	
125	        *result = sqrdTerm + linearTerm + offset;
126	
127	        status = CY_ADC_ERROR_NONE;
128	    }
129	
130	    return status;
131	}

The current measurement channel detects disconnect shunt connections by switching internal pull-up resistors to the shunt pins. If the resistance between the RSHx or RSLx to ground is more than 1000 Ω, an open pin fault can be detected.

• Detection criteria:
  • Vadc_th must be defined to separate "good" (lower voltage) from "open" (higher voltage)
  • Rdet < 250 Ω should always return "good" status
  • Rdet > 1000 Ω should always return "open" status

This example uses the shunt resistor and pull-up resistor to determine if the shunt resistor is disconnected (open). The circuit is open if the measured voltage with the pull-up enabled (Vpu) is greater than 1-Volt or if Vpu > Vadc_th. Where Vadc_th is:

Vadc_th = Vsh + (Vdd - Vsh) * 600 / (600 + Rpu)

Vsh is the measured shunt voltage. Rpu is the value of the pull-up resistor, determined during manufacturing and stored in SFLASH. See "21.2.7.3 Shunt resistor open detection of RSx pins" in the architecture TRM for more details.

Figure 18 shows the flow chart for shunt resistor open detection of RSx pins, and Code Listing 6 shows the code example of main function.

001	int main(void)
002	{
003	    ~~~~~~ omitted ~~~~~~
004	
005	    while (1)
006	    {
007	
008	    ~~~~~~ omitted ~~~~~~
009	
010	        if (g_diagnosticDataValid)
011	        {
012	            g_diagnosticDataValid = false;
013	            Cy_Adc_GetResult(PACSS_DCHAN2, &diagnosticChannelResult);
014	            Adc_DiagnosticHandler(diagnosticConfigs[diagnosticState],
015	                    diagnosticChannelResult);
016	
017	            if (diagnosticState == totalDiagnostic)
018	            {
019	                diagnosticState = 0;
020	            }
021	            else
022	            {
023	                diagnosticState++;
024	            }
025	
026	            Adc_SetChannelConfig(PACSS_DCHAN2,
027	                diagnosticConfigs[diagnosticState]);
028	
029	            /* Initiate the second Die Temp measurement */
030	            if (DIAGNOSTIC_CHANNEL_CONFIG_DIE_TEMP_UNIT == diagnosticState)
031	            {
032	                Cy_Adc_PacssMmio_StartSecondaryConversion(PACSS_MMIO);
033	            }
034	        } 
035	    ~~~~~~ omitted ~~~~~~
036	}
037	/******************************************************************************
038	* Adc_DiagnosticHandler
039	*******************************************************************************
040	* Call the handler function for the specified diagnostic channel measurement:
041	* - External Temperature
042	* - Internal Die Temperature
043	* - VDIAG vs Ground
044	* - RSH2/RSL2
045	* - Shunt disconnection detect
046	* - SRSS VREF vs Ground
047	* - HPBGR VREF vs Ground
048	******************************************************************************/
049	void Adc_DiagnosticHandler(adc_diagnostic_config_t state, int32_t result)
050	{
051	    ~~~~~~ omitted ~~~~~~
052	
053	    case DIAGNOSTIC_CHANNEL_CONFIG_RS_OPEN_PULLUP:
054	        rshPullup = result;
055	        break;
056	
057	    case DIAGNOSTIC_CHANNEL_CONFIG_RS_OPEN_SHUNT:
058	        Adc_RshOpenhandler(rshPullup, result);
059	        break;
060	
061	    ~~~~~~ omitted ~~~~~~
062	} 
063	/******************************************************************************
064	* Adc_RshOpenhandler
065	*******************************************************************************
066	* Uses the pull-up and shunt measurements on rsh0 to determine whether or not
067	* the shunt is open
068	******************************************************************************/
069	void Adc_RshOpenhandler(int32_t vpu, int32_t vsh)
070	{
071	    if (Cy_Adc_IsRsOpen(vpu, vsh, ADC_ROOM_TEMPERATURE_CELSIUS))
072	    {
073	        Example_UartPrintf("RSH Open Detect Failed, RSH is open\r\n");
074	    }
075	    else
076	    {
077	        Example_UartPrintf("RSH Open Detect Passed, RSH is NOT open\r\n");
078	    }
079	}
080	/*******************************************************************************
081	* Function Name: Cy_Adc_IsRsOpen
082	****************************************************************************//**
083	* \brief    Uses samples of the shunt resistor and pull-up resistor to determine
084	*           if the shunt resistor is disconnected (open). The circuit is open if
085	*           the measured voltage with the pull-up enabled (Vpu) is greater than
086	*           1 Volt or if Vpu > Vadc_th where Vadc_th is:
087	*
088	*           Vadc_th = Vsh + (Vdd - Vsh) * 600 / (600 + Rpu)
089	*
090	*           Vsh is the measured shunt voltage
091	*           Rpu is the value of the pull-up resistor, determined using the
092	*           temperature, based on measured values stored in sflash
093	*
094	*           The diagnostic channel uses a gain of 0.5x for these samples. The
095	*           values input are multiplied by 2 in this function to correct for
096	*           that attenuation.
097	*
098	* \param   pullup  Result of measuring with the pull-up resistor enabled
099	* \param   shunt   Result of measuring the shunt without the pull-up
100	* \param   temperature Temperature of the die in 12.20 fixed point Celsius. Used
101	*            to determine the pull-up value
102	* \param   pin Selects which pin is being tested
103	*
104	* \return  true if RS open detected
105	* \return  false if RS open not detected
106	*******************************************************************************/
107	bool Cy_Adc_IsRsOpen(int32_t pullup, int32_t shunt, int32_t temperature,
108	    cy_en_adc_rs_pin_type_t pin)
109	{
110	    float pullupMillivolts, shuntMillivolts, adcThreshold, voltageDivider;
111	    float rpu;
112	    bool result = false;
113	
114	    pullup = pullup * RS_OPEN_DETECT_GAIN_CORRECTION;
115	
116	    pullupMillivolts = Cy_Adc_CountsToMillivolts(pullup,
117	        CY_ADC_DIAGNOSTIC_CHANNEL, CY_ADC_SAMPLE_RATE_48KSPS, 1.2);
118	
119	    if (RS_OPEN_DETECT_PULLUP_THRESHOLD_MV < pullupMillivolts)
120	    {
121	        result = true;
122	    }
123	    else
124	    {
125	        rpu = Cy_Adc_GetPullupResistance(pin, temperature);
126	
127	        shunt = shunt * RS_OPEN_DETECT_GAIN_CORRECTION;
128	        shuntMillivolts = Cy_Adc_CountsToMillivolts(shunt,
129	            CY_ADC_DIAGNOSTIC_CHANNEL, CY_ADC_SAMPLE_RATE_48KSPS, 1.2);
130	
131	
132	        voltageDivider = RS_OPEN_DETECT_RSH_MARGIN_OHMS + rpu;
133	        voltageDivider = RS_OPEN_DETECT_RSH_MARGIN_OHMS / voltageDivider;
134	
135	        adcThreshold = shuntMillivolts
136	                      + ((RS_OPEN_DETECT_VDDA_MV - shuntMillivolts)
137	                      * voltageDivider);
138	
139	        if (pullupMillivolts > adcThreshold)
140	        {
141	            result = true;
142	        }
143	        else
144	        {
145	            result = false;
146	        }
147	    }
148	
149	    return result;
150	}

Figure 19 shows an example of primary vs. secondary conversion. Each sequencer is assigned digital channels. If more than one digital channel is assigned to a sequencer, the sequencer will convert the next assigned channel immediately following the conversion of its previous channel. This is only true if both channels are in incremental conversion mode. In continuous mode, only the lowest channel number will convert.

For example, consider that dchan0 and dchan2 are assigned to sequencer 0 (seq0). When triggered, seq0 will first convert dchan0; on completion it will start the conversion on dchan2. If dchan2 is configured as a secondary channel, when seq0 is triggered (by a primary trigger) only dchan0 will convert.

When a secondary trigger occurs before primary, the secondary channels assigned with the sequencer will go into a pending state. On the following primary trigger, the primary channels will convert followed by the secondary channels.

Cy_Adc_StartConversion()

cy_en_adc_error_t Cy_Adc_StartConversion (volatile stc_PACSS_MMIO_t * base)  

Description:

Triggers a conversion on the enabled primary channels

In a system with two primary channels connected to two analog channels, both channels are started simultaneously.

In continuous sampling mode, each analog channel should have only one primary channel. If an analog channel has more than one primary channel, only the lowest indexed channel will be used. For example, if DCHAN [0] and DCHAN [1] are both set as the primary channel for ACHAN [0], only DCHAN [0] will be used in continuous sampling mode.

In Incremental sampling mode, each analog channel can have multiple primary channels and they will sample in their index order.

Parameters:

• base – The address of the PACSS MMIO memory

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_StartSecondaryConversion()

cy_en_adc_error_t Cy_Adc_StartSecondaryConversion (volatile stc_PACSS_MMIO_t * base)

Description:

Triggers a secondary conversion on the enabled secondary channels

Parameters:

• base – The address of the PACSS MMIO memory

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Each digital channel consists of a result and accumulated result register. The result register is updated when the digital channel completes an acquisition. This may be at the end of the decimator conversion, the end of FIR filtering, or the end of post processing depending on how the channel is configured.

The accumulated result register accumulates signed acquisitions until a configurable threshold is reached. When the threshold is reached the register resets to zero. The accumulated results register can also be written, so that its value can be reset at any time. The accumulated result occurs before the moving average calculation. To obtain an accumulated result the post processor must be enabled.

Cy_Adc_GetResult()

cy_en_adc_error_t Cy_Adc_GetResult (volatile stc_PACSS_DCHAN_t * base, int32_t * result) 

Description:

Reads the value in the result register of the specified channel

The value in the result register is updated after a conversion is completed, including all enabled post processing/filter/correction steps if enabled.

Parameters:

• base – Base address for the digital channel
• result – Output pointer for the result to be saved to

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base or result is NULL

Cy_Adc_GetAccumulatorResult()

cy_en_adc_error_t Cy_Adc_GetAccumulatorResult (volatile stc_PACSS_DCHAN_t * base, uint32_t * result)

Description:

Reads the value in the accumulated result register of the specified channel

The value in the accumulated result register is updated after a conversion completed, and does not include the processing from the averaging filter in the DCHAN.

The accumulated result values can be (if enabled):

• Gain corrected
• Offset corrected
• FIR Filtered
• Left/right shifted

Parameters:

• base – Base address for the digital channel
• result – Output pointer for the result to be saved to

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base or result is NULL

Cy_Adc_ResetAccumulator()

cy_en_adc_error_t Cy_Adc_ResetAccumulator (volatile stc_PACSS_DCHAN_t * base)

Description:

Resets the accumulator to zero

Parameters:

• base – Base address for the digital channel

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPU T_ADDRESS_IS_NULL if base is NULL

Cy_Adc_SetAccumulatorThreshold()

cy_en_adc_error_t Cy_Adc_SetAccumulatorThreshold (volatile stc_PACSS_DCHAN_t * base, uint32_t threshold)

Description:

Sets the accumulator threshold

When the accumulator reaches the specified threshold, the accumulator will reset to zero.

Parameters:

• base – Base address for the digital channel
• threshold – Accumulator threshold

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Figure 20 shows the block diagram of ground connection for the high-voltage divider (VDIVIDER). Because an accurate measurement of battery voltage is desired, and the device's analog ground may be at a different potential than the battery negative terminal, a ground reference multiplexer for the high-voltage divider. This multiplexer can select vssa, rsh, or rsl pins for measurement and voltage divider ground (vdiv_ret). If the negative pole of the battery is not connected to vssa or it is desired to avoid potential voltage drops across the vssa pin, rsh or rsl (whichever is connected to the battery negative pole) can be selected.

Cy_Adc_SetGroundReference()

cy_en_adc_error_t Cy_Adc_SetGroundReference (volatile stc_PACSS_MMIO_t * base, cy_en_adc_ground_reference_t select) 

Description:

Sets the ground connection for the high-voltage divider

Parameters:

• base – Base address for the PACSS MMIO
• select – Ground reference selection. Options are:
  • CY_ADC_PACSS_MMIO_GROUND_REFERENCE_VSSA for VSSA
  • CY_ADC_PACSS_MMIO_GROUND_REFERENCE_RSH for RSH
  • CY_ADC_PACSS_MMIO_GROUND_REFERENCE_RSL for RSL

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if select is invalid

The PACSS sequencer generates control signals for performing analog-to-digital conversion.

The PACSS has sequencer that is associated with the analog channel. When triggered, the sequencer loads the input pin selection of the first linked digital channel, then starts the decimator, which initializes the modulator to start the conversion. The modulator output data is transferred to the linked digital channel.

Cy_Adc_EnableSequencer()

cy_en_adc_error_t Cy_Adc_EnableSequencer (volatile stc_PACSS_MMIO_t * base)

Description:

Enables the ADC sequencer and AREF

Enables:

• AREF
• LDO (modulator voltage source)
• PACSS MMIO

Parameters:

• base – Base address for the PACSS MMIO

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_DisableSequencer()

cy_en_adc_error_t Cy_Adc_DisableSequencer (volatile stc_PACSS_MMIO_t * base)

Description:

Disables the ADC sequencer

Parameters:

• base – Base address for the PACSS MMIO

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

The PACSS has a high-precision bandgap reference (HPBGR) which generates a low-noise 1.2-V reference with ±0.1% accuracy over temperature. An external 470-nF (typ) capacitor is required for the HPBGR reference. This capacitor is connected between VREFH and VREFL pins.

Cy_Adc_EnableReference()

cy_en_adc_error_t Cy_Adc_EnableReference (volatile stc_PACSS_MMIO_t * base)

Description:

Configures and enables the high-precision band gap reference (HPBGR)

The HPBGR is configured to:

• Enable circuit chopping
• Chopping phase between the BGR core and the output buffer are reversed
• External capacitor compensation is enabled

About the BGR core and output buffer chopping: The HPBGR contains a "band gap reference core" (BGR core) and an output buffer, which are circuit-chopped to reduce offset error.

The offset is reduced most when the BGR core uses the opposite clock edge to chop when compared to the output buffer, which is referred to here as the reverse phase.

Optionally, the BGR core and the output buffer can use the same clock edge for circuit chopping, referred to here as the normal chopping phase.

Parameters:

• base – Base address for the PACSS MMIO

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base or result is NULL

Cy_Adc_DisableReference()

cy_en_adc_error_t Cy_Adc_DisableReference (volatile stc_PACSS_MMIO_t * base)

Description:

Disables the high-precision band gap reference (HPBGR)

Parameters:

• base – Base address for the PACSS MMIO

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base or result is NULL

Each digital channel contains the following interrupts:

• RANGE_INTR: Range detect Interrupt: hardware sets this interrupt if the conversion result of that channel met the condition specified by the RANGE_LOW and RANGE_HIGH registers. Write with '1' to clear bit
• ACC_THRESH_INTR: Accumulated threshold interrupt: hardware sets this interrupt when the accumulated threshold value has been surpassed
• SATURATE_INTR: Saturate interrupt: hardware sets this interrupt if a conversion result is prevented from overflowing in either the decimator or the post processor when PP_CTL.SAT_EN=1. Write with '1' to clear bit
• OVERLOAD_INTR: Overload interrupt: hardware sets this interrupt for each channel if the modulator output is all zeros or all ones. This is an indication that the modulator is overloaded. Write with '1' to clear bit
• HWT_COLLISION_INTR: Hardware trigger collision interrupt 0: hardware sets this interrupt when the HW trigger signal is asserted while the DSM is BUSY. Raising this interrupt is delayed to when the scan caused by the HW trigger has been completed, i.e., not when the preceding scan with which this trigger collided is completed. When this interrupt is set, it implies that the channels were sampled later than was intended (jitter). Write with '1' to clear bit
• FWT_COLLISION_INTR: Firmware trigger collision interrupt 0: hardware sets this interrupt when FW_TRIGGER is asserted while the DSM is BUSY. Raising this interrupt is delayed to when the scan caused by the FW_TRIGGER has been completed, i.e., not when the preceding scan with which this trigger collided is completed. When this interrupt is set, it implies that the channels were sampled later than was intended (jitter). Write with '1' to clear bit
• OVERFLOW_INTR: Overflow interrupt: hardware sets this interrupt when it sets a new DATA_VAL_INTR while that bit was not yet cleared by the firmware. Write with '1' to clear bit
• DATA_VAL_INTR: Data Valid Interrupt 0: hardware sets this interrupt after completing a scan of all the enabled channels. Write with '1' to clear bit

Cy_Adc_GetInterrupt()

cy_en_adc_error_t Cy_Adc_GetInterrupt (volatile stc_PACSS_DCHAN_t * base, uint32_t * result)

Description:

Gets the specified digital channel's interrupt status

Parameters:

• base – Base address for the DCHAN MMIO
• result – Output variable for the DCHAN interrupt status

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base or result is NULL

Cy_Adc_GetInterruptMasked()

cy_en_adc_error_t Cy_Adc_GetInterruptMasked (volatile stc_PACSS_DCHAN_t * base, uint32_t * result)

Description:

Gets the DCHAN interrupt status masked by the enabled interrupts

Parameters:

• base – Base address for the DCHAN MMIO
• result – Output variable for the DCHAN interrupt status

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base or result is NULL

Cy_Adc_SetInterruptMask()

cy_en_adc_error_t Cy_Adc_SetInterruptMask (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_dchan_interrupt_t interrupt)

Description:

Enables the specified interrupt type for the specified channel

Parameters:

• base – Base address for the DCHAN
• interrupt – Interrupt to enable. Options are:
  • CY_ADC_DCHAN_INTERRUPT_DATA_VAL
  • CY_ADC_DCHAN_INTERRUPT_OVERFLOW
  • CY_ADC_DCHAN_INTERRUPT_FIRMWARE_TRIGGER_COLLISION
  • CY_ADC_DCHAN_INTERRUPT_HARDWARE_TRIGGER_COLLISION
  • CY_ADC_DCHAN_INTERRUPT_OVERLOAD
  • CY_ADC_DCHAN_INTERRUPT_SATURATE
  • CY_ADC_DCHAN_INTERRUPT_ACCUMUlATION_THRESHOLD
  • CY_ADC_DCHAN_INTERRUPT_RANGE

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if interrupt is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_ClearInterrupt()

cy_en_adc_error_t Cy_Adc_ClearInterrupt (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_dchan_interrupt_t interrupt)

Description:

Clears the specified interrupt

Parameters:

• base – Base address for DCHAN
• interrupt – Interrupt to clear. Options are:
  • CY_ADC_DCHAN_INTERRUPT_DATA_VAL
  • CY_ADC_DCHAN_INTERRUPT_OVERFLOW
  • CY_ADC_DCHAN_INTERRUPT_FIRMWARE_TRIGGER_COLLISION
  • CY_ADC_DCHAN_INTERRUPT_HARDWARE_TRIGGER_COLLISION
  • CY_ADC_DCHAN_INTERRUPT_OVERLOAD
  • CY_ADC_DCHAN_INTERRUPT_SATURATE
  • CY_ADC_DCHAN_INTERRUPT_ACCUMUlATION_THRESHOLD
  • CY_ADC_DCHAN_INTERRUPT_RANGE

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if interrupt is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_GetInterruptCause()

cy_en_adc_error_t Cy_Adc_GetInterruptCause (volatile stc_PACSS_MMIO_t * base, cy_en_adc_interrupt_t source, cy_en_adc_interrupt_cause_t * cause)

Description:

Gets the interrupt cause

This function reads the PACSS_MMIO INTR_CAUSE register and stores the results in the cause parameter.

This interrupt is the logical OR of all available interrupts in the PACSS. Interrupts must have their interrupt mask enabled in their respective blocks.

Parameters:

• base – Address of the PACSS MMIO registers
• source – Interrupt Source. Valid inputs are:
  • CY_ADC_PACSS_MMIO_INTERRUPT_DCHAN0
  • CY_ADC_PACSS_MMIO_INTERRUPT_DCHAN1
  • CY_ADC_PACSS_MMIO_INTERRUPT_DCHAN2
  • CY_ADC_PACSS_MMIO_INTERRUPT_DCHAN3
• Cause: Pointer to the interrupt cause return parameter. Values returned are:
  • CY_ADC_PACSS_MMIO_INTERRUPT_CAUSE_IDLE
  • CY_ADC_PACSS_MMIO_INTERRUPT_CAUSE_ACTIVE

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

Offset and gain correction are enabled via the OCOR_EN and GCOR_EN bits. If offset correction is enabled, the 16-bit OCOR value is left shifted by the OCOR_SCLR value then added to the decimation result.

If gain correction is enabled, the decimated result is multiplied by the 16-bit GCOR value. The 4-bit GVAL field is used to determine how many bits of the GCOR value are valid in the calculation. If both offset and gain correction are enabled, the offset calculation is done before the gain multiplication.

If auto gain control is enabled, the offset and gain correction are taken from PACSS_MMIO_OFST_COR1 and PACSS_MMIO_GAIN_COR1 registers.

Cy_Adc_SetGainCorrection()

cy_en_adc_error_t Cy_Adc_SetGainCorrection (volatile stc_PACSS_DCHAN_t * base, uint16_t gain)

Description:

Sets the gain correction factor for the specified DCHAN

This function sets the GCOR value of the specified digital channel. It assumes 15 valid bits since that is what the calibration values stored in supervisory flash use.

Parameters:

• base – Address of the DCHAN registers
• gain – Gain correction factor

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

Cy_Adc_SetOffsetCorrection()

cy_en_adc_error_t Cy_Adc_SetOffsetCorrection (volatile stc_PACSS_DCHAN_t * base, int16_t offset)

Description:

Sets the offset correction factor for the specified DCHAN

This function sets the OCOR value of the specified digital channel.

Parameters:

• base – Address of the DCHAN registers
• gain – Gain correction factor

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

Cy_Adc_SetAGCGainCorrection()

cy_en_adc_error_t Cy_Adc_SetAgcGainCorrection (volatile stc_PACSS_MMIO_t * base, uint16_t index, uint16_t gain)

Description:

Sets the gain correction factor for the specified AGC gain level

This function sets the GCOR value of the specified AGC level. It assumes 15 valid bits since that is what the calibration values stored in supervisory flash use

Parameters:

• base – Address of the PACSS_MMIO registers
• index – AGC gain level
• gain – Gain correction factor

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

Cy_Adc_SetAgcOffsetCorrection()

cy_en_adc_error_t Cy_Adc_SetAgcOffsetCorrection (volatile stc_PACSS_MMIO_t * base, uint16_t index, uint16_t offset)

Description:

Sets the offset correction factor for the specified AGC gain level

This function sets the OCOR value of the specified AGC level

Parameters:

• base – Address of the PACSS_MMIO registers
• index – AGC gain level
• gain – Gain correction factor

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

Using PACSS_DCHANx_SMP_REF_CTL register is used to control VREFH and VREFL connection. VREF connections are recommended for each convert mode. Table 8 shows the reference selection by mode.

Cy_Adc_SetVrefLow()

cy_en_adc_error_t Cy_Adc_SetVrefLow (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_dchan_reference_vrefl_t vrefl)

Description:

Sets the selection of the low reference of DCHAN

This function sets the VREF low value of the specified DCHAN

Parameters:

• base – Address of the PACSS_DCHAN registers
• vrefl – Low reference selection

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

Cy_Adc_SetVrefHigh()

cy_en_adc_error_t Cy_Adc_SetVrefLow (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_dchan_reference_vrefh_t vrefh)

Description:

Sets the selection of the high reference of DCHAN

This function sets the VREF high value of the specified DCHAN and the reference buffer if necessary

Parameters:

• base – Address of the PACSS_DCHAN registers
• vrefh – High reference selection

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if source is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL or cause is NULL

The analog portion of the ADCs (see Figure 21) consists of a PGA, AAF, buffer, and a delta-sigma modulator.

The analog channel receives a differential signal selected through the analog multiplexer. This differential signal is received by a programmable gain amplifier (PGA). The output of the PGA feeds a low-pass anti-alias filter (AAF) with a bandwidth of ~30 kHz. A buffer amplifier drives the DSM modulator – this amplifier has high bandwidth to settle the modulator capacitors to better than 16 bits each time they are settled. The modulator uses capacitor dividers to set gain. The modulator is a third order with switched capacitor amplifier circuits. The modulator produces a multi-level digital bitstream sent to the digital channel (see the architecture TRM for more details).

Cy_Adc_EnableAchan()

cy_en_adc_error_t Cy_Adc_EnableAchan (volatile stc_PACSS_ACHAN_t * base)

Description:

Enables the analog channel

Parameters:

• base – Analog channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_DisableAchan()

cy_en_adc_error_t Cy_Adc_DisableAchan (volatile stc_PACSS_ACHAN_t * base)

Description:

Disables the analog channel

Parameters:

• base – Analog channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_InitAchan()

cy_en_adc_error_t Cy_Adc_InitAchan (volatile stc_PACSS_ACHAN_t * base, cy_stc_adc_achan_config_t * config)

Description:

Configures the analog channel

Parameters:

• base – Analog channel base address
• config – Configuration options for the analog channel

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter or if config is NULL

ConfigureBuffer()

cy_en_adc_error_t ConfigureBuffer (volatile stc_PACSS_ACHAN_t * base)

Description:

Configures the analog channel buffer

The ACHAN buffer is configured to:

• Enable the IDAC
• Enable circuit chopping
• Power level to CY_ADC_BUFFER_POWER_LEVEL_78_PERCENT

See:

• #Cy_Adc_AchanBuffer_EnableIdac
• #Cy_Adc_AchanBuffer_EnableChopping
• #Cy_Adc_AchanBuffer_SetPowerLevel
• #Cy_Adc_AchanBuffer_Enable

Parameters:

• base – Analog channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

ConfigurePga()

cy_en_adc_error_t ConfigurePga (volatile stc_PACSS_ACHAN_t * base)

Description:

Configures the analog channel programmable gain array

The ACHAN PGA is configured to:

• Enable the IDAC
• Enable circuit chopping
• Power level to CY_ADC_PGA_POWER_LEVEL_58_PERCENT

The PGA gain is set by DCHAN (or AGC).

See:

• #Cy_Adc_AchanPga_EnableIdac
• #Cy_Adc_AchanPga_EnableChopping
• #Cy_Adc_AchanPga_SetPowerLevel
• #Cy_Adc_AchanPga_Enable

Parameters:

• base – Analog channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

ConfigureReference()

cy_en_adc_error_t ConfigureReference (volatile stc_PACSS_ACHAN_t * base)

Description:

Configures the analog channel reference

The ACHAN reference is configured as:

• VCM to 0.8 V
• Quantizer VREF to CDAC
• VREF power level to CY_ADC_VREF_POWER_LEVEL_HIGH
• VCM power level to CY_ADC_VCM_POWER_LEVEL_HIGH
• Enable VCCA resistor
• Enable VDDA resistor
• Enable VCM buffer
• Enable VREF buffer
• Enable reference

See:

• #Cy_Adc_AchanReference_SetVcmSelect
• #Cy_Adc_AchanReference_SetQuantizerVrefSelect
• #Cy_Adc_AchanReference_SetVcmPower
• #Cy_Adc_AchanReference_EnableVccaResistor
• #Cy_Adc_AchanReference_EnableVddaResistor
• #Cy_Adc_AchanReference_EnableVcmBuffer
• #Cy_Adc_AchanReference_Enable

Parameters:

• base – Analog channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

ConfigureModulator()

cy_en_adc_error_t ConfigureModulator (volatile stc_PACSS_ACHAN_t * base)

Description:

The ACHAN modulator is configured as:

• First stage integrator power 88 percent
• Second/third stage integrator power 100 percent
• Comparator power to 100 percent
• Summer power 100 percent
• Modulator chopping clock to Fs/32 and enabled
• Modulator quantization level to '9'
• Low Non-overlap delay
• Datapath chopping clock to Fclock/32 and enabled

See:

• #Cy_Adc_AchanModulator_SetFirstStagePower
• #Cy_Adc_AchanModulator_SetSecondThirdStagePower
• #Cy_Adc_AchanModulator_SetCompPower
• #Cy_Adc_AchanModulator_SetSummerPower
• #Cy_Adc_AchanModulator_SetChoppingDivider
• #Cy_Adc_AchanModulator_EnableChopping
• #Cy_Adc_AchanModulator_SetQuantizationLevel
• #Cy_Adc_AchanModulator_SetNonOverlapDelay
• #Cy_Adc_AchanModulator_SetDatapathMode
• #Cy_Adc_AchanModulator_SetDataOut
• #Cy_Adc_AchanModulator_SetDatapathChoppingDivider
• #Cy_Adc_AchanModulator_EnableDatapathChopping
• #Cy_Adc_AchanChopping_DisableSecondIntegratorChopping
• #Cy_Adc_AchanModulator_SetAafDisconnectCount
• #Cy_Adc_AchanModulator_Enable

Parameters:

• base – Analog channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

ConfigureTrigger()

cy_en_adc_error_t ConfigureTrigger (volatile stc_PACSS_ACHAN_t * base, cy_en_adc_achan_trigger_priority_t priority, cy_en_adc_achan_trigger_t source)

Description:

Configures the analog channel primary/secondary trigger

Firmware (FW) triggering will work if hardware (HW) triggering is enabled. If the trigger is selected to be a 'FW' trigger, the hardware trigger is disabled.

If the trigger is selected to be one of the 'HW' triggers, the ACHAN is configured to use the selected hardware trigger source for the selected trigger priority.

See:

• #Cy_Adc_AchanTrigger_Disable
• #Cy_Adc_AchanTrigger_Enable
• #Cy_Adc_AchanTrigger_SetSync
• #Cy_Adc_AchanTrigger_SelectPrimary
• #Cy_Adc_AchanTrigger_SelectSecondary

Parameters:

• base – Analog channel base address
• priority – Trigger priority, not checked for validity

Will be either:

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if source is invalid

The AGC can automatically control the gain of either channel. AGC circuits typically monitor either the input voltage or output of the PGA and increase gain when the signal amplitude is below a certain threshold or reduce gain when above another threshold. The gain of the current channel ranges from 1 to 512. Automatic gain can be disabled and set to a fixed value. A scaler between the modulator and decimator adjusts the weight of modulator data based on the gain so the LSB of the data going into the decimator is always 0.715 mA.

The gain of other channels is static instead of dynamic. Static gain is typically set to '1' but any value from 0.5 to 512 in powers of 2 can be used. The HV input channels have resistor voltage dividers that attenuate the input voltage. The nominal divider ratio is 24x (28.8 V full-scale) with an optional value of 16x (19.2 V full scale).

The AGC can automatically control the gain of either channel. AGC circuits typically monitor either the input voltage or output of the PGA and increase the gain when the signal amplitude is below a certain threshold or reduce the gain when above another threshold. This function can also be achieved with a low-resolution A/D converter with digital comparison for gain selection.

Cy_Adc_EnableAgc()

cy_en_adc_error_t Cy_Adc_EnableAgc (volatile stc_PACSS_MMIO_t * base)

Description:

Enables automatic gain correction (AGC)

Parameters:

• base – Base address of the PACSS_MMIO

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter

Cy_Adc_DisableAgc()

cy_en_adc_error_t Cy_Adc_DisableAgc (volatile stc_PACSS_MMIO_t * base)

Description:

Disables automatic gain correction (AGC)

Parameters:

• base – Base address of the PACSS_MMIO

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter

Cy_Adc_InitAgc()

cy_en_adc_error_t Cy_Adc_InitAgc (volatile stc_PACSS_MMIO_t * base, cy_stc_adc_agc_config_t * config)

Description:

Configures automatic gain correction (AGC)

Parameters:

• base – Base address of the PACSS_MMIO
• config – Configuration options for the AGC

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter

ConfigureGainLevel()

cy_en_adc_error_t ConfigureGainLevel (volatile stc_PACSS_MMIO_t * base, uint32_t gainLevelIndex, cy_stc_adc_gain_level_config_t * gainLevel)

Description:

Configures the gain level in memory, given the input configuration

Parameters:

• base – Base address of the PACSS_MMIO
• gainLevelIndex – Gain Level to configure. Valid inputs are between 0 and 9 inclusive
• gainLevel – Gain Level configuration settings. Not all settings are used by the AGC. Because config->gainLevels is not NULL, the input here cannot be NULL

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if 'gainLevel' contains an invalid parameter of 'gainLevelIndex' is invalid

Chopping is used to reduce the offset and 1/f (flicker) noise. Various chopping schemes are implemented in the PACSS. See Table 9 for default values.

Cy_Adc_InitAchanChannelChopping()

cy_en_adc_error_t Cy_Adc_InitAchanChannelChopping (volatile stc_PACSS_ACHAN_t * base, cy_stc_adc_achan_channel_chopping_config_t * config)

Description:

Configures the selected analog channel to perform channel chopping

Parameters:

• base – Analog channel base address
• config – Configuration options for ACHAN channel chopping

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter or if config is NULL

The digital data system has four digital channels that include the scaler, decimator, rate control, FIR filter, accumulator, comparator, offset, and gain calibrations (see Figure 22 which is a simplified diagram of the digital channel path). The digital channels process outputs from either of the two analog channels. Two channels have an FIR filter and the other two do not have an FIR Filter. The digital channels without FIR filter have every other feature.

The channels are typically used for current, voltage, temperature, and diagnostic measurements although they can be associated with any inputs. The digital system of the PACSS is largely autonomous; it performs acquisitions, filtering, post-processing, and data storage without firmware intervention. This allows real-time measurements without loading the CPU (see the architecture TRM for more details).

Cy_Adc_EnableDchan()

cy_en_adc_error_t Cy_Adc_EnableDchan (volatile stc_PACSS_DCHAN_t * base)

Description:

Enables the digital channel

Parameters:

• base – Digital channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_DisableDchan()

cy_en_adc_error_t Cy_Adc_DisableDchan (volatile stc_PACSS_DCHAN_t * base)

Description:

Disables the digital channel

Parameters:

• base – Digital channel base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_InitDchan()

cy_en_adc_error_t Cy_Adc_InitDchan (volatile stc_PACSS_DCHAN_t * base, cy_stc_adc_dchan_config_t * config)

Description:

Configures the digital channel

Parameters:

• base – Digital channel base address
• config – Configuration options for the digital channel

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base of config is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter

Cy_Adc_ConfigureGainLevel()

cy_en_adc_error_t Cy_Adc_ConfigureGainLevel (volatile stc_PACSS_DCHAN_t * base, cy_stc_adc_gain_level_config_t * gain)

Description:

Configures the digital channel gain level settings

Parameters:

• base – Digital channel base address
• gain – Gain level configuration options for the digital channel

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base of config is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter or if config is NULL

Cy_Adc_ ConfigureFIRFilter()

cy_en_adc_error_t ConfigureFIRFilter (volatile stc_PACSS_DCHAN_t * base, cy_stc_adc_fir_config_t * config)

Description:

Configures the digital channel FIR filter coefficients

Parameters:

• base – Digital channel base address
• config – Non-null FIR Filter configuration, which contains:
  • Post process right shift (FIR right shift)
  • FIR number of taps
  • FIR coefficient definitions in an array

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if config->coefficients is NULL
• CY_ADC_ERROR_BAD_PARAM if a filter coefficient field is invalid

Cy_Adc_ConfigureAafMode()

cy_en_adc_error_t Cy_Adc_ConfigureAafMode (volatile stc_PACSS_DCHAN_t * base, cy_stc_adc_dchan_config_t * config)

Description:

Configures the anti-alias filter

Parameters:

• base – Base address
• config – Configuration options for the digital channel

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if 'base' of 'config' is NULL
• CY_ADC_ERROR_BAD_PARAM if 'config' contains an invalid parameter

PSoC™ 4 HV PA MCU has an on-die temperature sensor. The measurements are made with an internal temperature sensor by measuring bipolar VBE at different current densities and calculating temperature. Two independent current references are used for diagnosis and redundancy.

Cy_Adc_EnableTemperature()

cy_en_adc_error_t Cy_Adc_EnableTemperature (volatile stc_PACSS_MMIO_t * base)

Description:

Enables the temperature sensor

Parameters:

• base – PACSS MMIO base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_DisableTemperature()

cy_en_adc_error_t Cy_Adc_DisableTemperature (volatile stc_PACSS_MMIO_t * base)

Description:

Disables the temperature sensor

Parameters:

• base – PACSS MMIO base address

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_InitTemperature()

cy_en_adc_error_t Cy_Adc_InitTemperature (volatile stc_PACSS_MMIO_t * base, cy_stc_adc_temperature_config_t * config)

Description:

Configures the temperature sensor

Parameters:

• base – PACSS MMIO base address
• config – Configuration options for the temperature sensor

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL
• CY_ADC_ERROR_BAD_PARAM if config contains an invalid parameter

Provides APIs for applying temperature gain and offset correction factors to the DCHAN and AGC. These values are determined in the factory and stored in supervisory flash.

Cy_Adc_CalibrateAgcGainLevel()

cy_en_adc_error_t Cy_Adc_CalibrateAgcGainLevel (volatile stc_PACSS_MMIO_t * base, uint8_t gainLevel, int32_t temperature, cy_en_adc_achan0_2temp_trim_gain_type_t gain)

Description:

Loads the gain and offset correction values from the supervisory flash

This function calibrates the specified AGC level used in the example code based on the temperature. Calibration must be done after initializing the AGC. Gain and offset calibration values are stored in SFlash as documented in the PACSS calibration section of the TRM.

This function assumes that the gain levels are as configured in the ADC driver. Using a custom gain level setting may affect this function, and could cause the ADC to work improperly.

Parameters:

• base – Address of the PACSS_MMIO registers
• gainLevel – Which AGC Gain Level to calibrate. Ranges from 0 to 8
• temperature – Fixed point, 12.20, junction temperature in celsius
• gain – Gain Level of the selected PACSS_MMIO Gain Level. Options are:
  • CY_ADC_ACHAN0_2TEMP_GAIN_2X
  • CY_ADC_ACHAN0_2TEMP_GAIN_4X
  • CY_ADC_ACHAN0_2TEMP_GAIN_8X
  • CY_ADC_ACHAN0_2TEMP_GAIN_16X
  • CY_ADC_ACHAN0_2TEMP_GAIN_32X
  • CY_ADC_ACHAN0_2TEMP_GAIN_64X
  • CY_ADC_ACHAN0_2TEMP_GAIN_128X
  • CY_ADC_ACHAN0_2TEMP_GAIN_256X
  • CY_ADC_ACHAN0_2TEMP_GAIN_512X

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if gainLevel, gain, or sampleRate are invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_CalibrateAchan0_2TempTrim()

cy_en_adc_error_t Cy_Adc_CalibrateAchan0_2TempTrim (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_achan0_2temp_trim_gain_type_t gain, int32_t temperature)

Description:

Loads the gain and offset correction values from the supervisory flash

This function loads the gain and offset correction values for the specified DCHAN connected to ACHAN0.

The output of the DCHAN must have the same LSB at the application of OCOR as the configuration used to create the values stored in supervisory flash. This can be accomplished by adjusting either SHIFTL or DEC_SHIFTR.

The Cy_Adc_GetDieTempFromDelta API calculates the junction temperature in this fixed-point format from the difference between two die temperature measurements. This function uses the Cy_Adc_GetGcorOcorAchan0_2TempTrim API to perform a linear interpolation of the OCOR and GCOR values in the supervisory flash based on the provided temperature.

DCHAN connected to ACHAN0. This function uses the Cy_Adc_GetGcorOcorAchan0_2TempTrim API to perform a linear interpolation based on the provided temperature. 2Temp means the interpolation is done using a 2-point array.

Parameters:

• base – Address of the DCHAN registers
• gain – Gain value of the specified channel. Options are:
  • CY_ADC_ACHAN0_2TEMP_GAIN_1X
  • CY_ADC_ACHAN0_2TEMP_GAIN_2X
  • CY_ADC_ACHAN0_2TEMP_GAIN_4X
  • CY_ADC_ACHAN0_2TEMP_GAIN_8X
  • CY_ADC_ACHAN0_2TEMP_GAIN_16X
  • CY_ADC_ACHAN0_2TEMP_GAIN_32X
  • CY_ADC_ACHAN0_2TEMP_GAIN_64X
  • CY_ADC_ACHAN0_2TEMP_GAIN_128X
  • CY_ADC_ACHAN0_2TEMP_GAIN_256X
  • CY_ADC_ACHAN0_2TEMP_GAIN_512X
• temperature – Fixed point, 12.20, junction temperature in celsius

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if gain or sampleRate are invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_CalibrateAchan1_2TempTrim()

cy_en_adc_error_t Cy_Adc_CalibrateAchan1_2TempTrim (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_achan1_2temp_trim_gain_type_t gain, int32_t temperature)

Description:

Loads the gain and offset correction values from the supervisory flash

This function loads the gain and offset correction values for the specified DCHAN connected to ACHAN1.

The output of the DCHAN must have the same LSB at the application of OCOR as the configuration used to create the values stored in the supervisory flash. This can be accomplished by adjusting either SHIFTL or DEC_SHIFTR.

The Cy_Adc_GetDieTempFromDelta API calculates the junction temperature in this fixed point format from the difference between two die temperature measurements. This function uses the Cy_Adc_GetGcorOcorAchan1_2TempTrim API to perform a linear interpolation of the OCOR and GCOR values in supervisory flash based on the provided temperature.

DCHAN connected to ACHAN1. This function uses the Cy_Adc_GetGcorOcorAchan1_2TempTrim API to perform a linear interpolation based on the provided temperature. 2Temp means the interpolation is done using a 2-point array.

Parameters:

• base – Address of the DCHAN registers
• gain – Gain value of the specified channel. Options are:
  • CY_ADC_ACHAN1_2TEMP_GAIN_0P5X
  • CY_ADC_ACHAN1_2TEMP_GAIN_1X
  • CY_ADC_ACHAN1_2TEMP_GAIN_2X
  • CY_ADC_ACHAN1_2TEMP_GAIN_4X
  • CY_ADC_ACHAN1_2TEMP_GAIN_8X
  • CY_ADC_ACHAN1_2TEMP_GAIN_16X
  • CY_ADC_ACHAN1_2TEMP_GAIN_32X
  • CY_ADC_ACHAN1_2TEMP_GAIN_64X
  • CY_ADC_ACHAN1_2TEMP_GAIN_128X
  • CY_ADC_ACHAN1_2TEMP_GAIN_256X
  • CY_ADC_ACHAN1_2TEMP_GAIN_512X
• temperature – Fixed point, 12.20, junction temperature in celsius

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if gain or sampleRate are invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_CalibrateAchan1_3TempTrim()

cy_en_adc_error_t Cy_Adc_CalibrateAchan1_3TempTrim (volatile stc_PACSS_DCHAN_t * base, cy_en_adc_achan1_3temp_trim_divider_type_t divider, int32_t temperature)

Description:

Loads the gain and offset correction values from the supervisory flash

This function loads the gain and offset correction values for the specified DCHAN connected to ACHAN1. These values are for the high-voltage divider measurements.

The output of the DCHAN must have the same LSB at the application of OCOR as the configuration used to create the values stored in the supervisory flash. This can be accomplished by adjusting either SHIFTL or DEC_SHIFTR.

The Cy_Adc_GetDieTempFromDelta API calculates the junction temperature in this fixed-point format from the difference between two die temperature measurements. This function uses the Cy_Adc_GetGcorOcorAchan1_2TempTrim API to perform a linear interpolation of the OCOR and GCOR values in supervisory flash based on the provided temperature. measurements. This function uses the Cy_Adc_GetGcorOcorAchan1_2TempTrim API to perform a linear interpolation based on the provided temperature. 3Temp means the interpolation is done using a 3-point array.

Parameters:

• base – Address of the DCHAN registers
• divider – Which high-voltage divider is being sampled by the DCHAN. Options are:
  • CY_ADC_ACHAN1_3TEMP_VSENSE_16
  • CY_ADC_ACHAN1_3TEMP_VSENSE_24
  • CY_ADC_ACHAN1_3TEMP_VDIAG_16
  • CY_ADC_ACHAN1_3TEMP_VDIAG_24
• temperature – Fixed point, 12.20, junction temperature in celsius

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if divider or sampleRate are invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_GetGcorOcorAchan0_2TempTrim()

cy_en_adc_error_t Cy_Adc_GetGcorOcorAchan0_2TempTrim (uint16_t *gcor, int16_t *ocor, cy_en_adc_achan0_2temp_trim_gain_type_t gain, int32_t temperature)

Description:

Retrieves the gain and offset correction values from the supervisory flash

This function loads the gain and offset correction values for the specified gain level. This function performs a linear interpolation of the gain and offset correction values based on the values defined for -40°C and 150°C. 2Temp means the interpolation is done using a 2-point array.

Parameters:

• gcor – Pointer to the gain correction value
• ocor – Pointer to offset correction value
• gain – Gain value of the specified channel
• temperature – Fixed-point, 12.20, junction temperature in celsius

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if gain is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_GetGcorOcorAchan1_2TempTrim()

cy_en_adc_error_t Cy_Adc_GetGcorOcorAchan1_2TempTrim (uint16_t *gcor, int16_t *ocor, cy_en_adc_achan1_2temp_trim_gain_type_t gain, int32_t temperature)

Description:

Retrieves the gain and offset correction values from the supervisory flash

This function loads the gain and offset correction values for the specified gain level. This function performs a linear interpolation of the gain and offset correction values based on the values defined for -40°C and 150°C. 2Temp means the interpolation is done using a 2-point array.

Parameters:

• gcor – Pointer to the gain correction value
• ocor – Pointer to offset correction value
• gain – Gain value of the specified channel
• temperature – Fixed-point, 12.20, junction temperature in celsius

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if gain is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_GetGcorOcorAchan1_3TempTrim()

cy_en_adc_error_t Cy_Adc_GetGcorOcorAchan1_3TempTrim (uint16_t *gcor, int16_t *ocor, cy_en_adc_achan1_3temp_trim_divider_type_t divider, int32_t temperature)

Description:

Retrieves the gain and offset correction values from the supervisory flash

This function loads the gain and offset correction values for the specified gain level. 3Temp means the interpolation is done using a 3-point array.

Parameters:

• gcor – Pointer to the gain correction value
• ocor – Pointer to offset correction value
• gain – Gain value of the specified channel
• temperature – Fixed point, 12.20, junction temperature in celsius

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if gain is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Cy_Adc_CalibrateOffsetScalar()

cy_en_adc_error_t Cy_Adc_CalibrateOffsetScalar (volatile stc_PACSS_DCHAN_t * base)

Description:

Loads the offset correction scalar value from the supervisory flash

This function loads the offset correction scalar value for the specified DCHAN.

Parameters:

• base – Address of the DCHAN registers

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if base is NULL

Provides APIs for converting ADC counts to volts and millivolts. This is to show the basic functionality of the evaluation board with easily understood the results that would match a voltmeter measuring the board. Results are in floating-point format which will lose precision for large integer values. It is up to the user to prevent this in their application.

Cy_Adc_CountsToVolts()

float Cy_Adc_CountsToVolts (int32_t counts, cy_en_adc_channel_type_t channelType, cy_en_adc_sample_rate_t sampleRate, float vref)

Description:

Converts the input from raw ADC counts to volts

ADC counts are explained in the decimator result calculation section of the TRM. Some of that explanation is replicated here along with an example of how the results correlate to voltage.

The ADC result depends on the following parameters:

• M = modulator data, ranges from -4 to 4
• S = Scaler, left shift ranges from 0 to 9 (SHIFTL)
• N = Number of sinc stages, values of 3 or 4 (SINC_MODE)
• DR = Decimation ratio, typical values are: 32, 64 or 128
• U = Moving sum (disabled: disabled = 1, two taps: U=2, four taps: U=4)
• DR2 = Rate reducer decimation ratio; typical values: 2 or 6
• OF = Offset correction (OCOR)
• OFS = Offset scaler (OCOR_SCLR)
• G = Gain correction (GCOR)
• GV = Gain correction valid bits (GVAL)
• RSA = Decimator right shift (DEC_SHIFTR)
• RSB = Rate reducer right shift (RR_SHIFT)

To simplify the calculation, these steps assume that moving average is disabled, and the modulator data input is constant.

The result is calculated using the following calculations:

1. sinc3/sinc4 results = A = (M << S) * 2^(N*log2(DR)) * U
2. right shift result = B = A >> RSA
3. offset result = C = B + (OF << OFS)
4. gain result = D = (C * G) >> GV
5. sinc2 result = E = D * 2^(2*log2(DR2))
6. decimator output = F = E >> RSB

The left shift is most commonly used in AGC to keep all results on the same number scale regardless of gain level. Right shifts are used to prevent overflowing the 32-bit result register.

The equation for determining DEC_SHIFTR is:

log2(qlev) + max(SHIFTL) + N*log2(DR) - 30

Where qlev = 9, the quantization levels of the modulator -4 to 4, including 0.

The equation for determining RR_SHIFTR is:

log2(qlev) + max(SHIFTL) + N*log2(DR +1) +2*log2(DR2+1) - DEC_SHIFTR - 30

The maximum output value, MAX_COUNT below, is determined by using the maximum modulator output which is 4. Similarly, the minimum modulator output value is -4 so the MIN_COUNT == MAX_COUNT * -1. The LSB is the reference voltage divided by MAX_COUNT.

The code examples use three different configurations, and will walk through the MAX_COUNT calculation for the current channel and provide the parameters for the other channels. The current channel uses a SHIFTL of 8 at the lowest AGC gain setting with SHIFTL decreasing with each gain increase to keep the values on the same scale.

For this exercise, assume that offset and gain correction are used to keep the results along the ideal, linear curve between +/- VREF. Therefore, you can ignore the gain and offset calculations (steps 3 and 4 above).

1. Current channel
   • SHIFTL = 8
   • DR = 64
   • N = 3 (Sinc3, SINC_MODE=0)
   • DEC_SHIFTR = log2(qlev) + max(SHIFTL) + N*log2(DR) - 30

     = log2(9) + max(8) + 3*log2(64) - 30

     = 3.17 + 8 + 18 - 30

     = 29.17 - 30

     = -0.83, rounded to the nearest positive integer

     = 0

   • DR2 = 6
   • RR_SHIFTR = log2(9) + max(SHIFTL) + N*log2(DR) + 2*log2(DR2) - DEC_SHIFTR - 30

     = 3.17 + 8 + 18 + 2*log2(6) - 0 - 30

     = 29.17 + 5.17 - 30

     = 34.34 - 30

     4.34, rounded to the nearest positive integer

     = 5

   • MAX COUNT = (DECB * 2^(2*log2(DR2))) >> RR_SHIFTR, where:

     DECB = ((4 << SHIFTL)*2^(N*log2(DR)) * U >> DEC_SHIFTR)

     DECB = ((4 << 8)*2^(3*log2(64) * 4) >> 0)

     DECB = 1024 *2^18 * 4 >> 0

     DECB = 1073741824

     = (DECB) * 2^(2*log2(6)) >> 5

     = 1073741824 * 2^5.1699 >> 5

     = 1,207,959,552 (0x48000000)

The current channel uses AGC with gains of 0.5x to 128x as well as an accumulated average (U) of 4x. This means that the lowest AGC gain is effectively 2x (0.5x gain * 4x summed average). To compensate for this 2x gain in the equations below, subtract one from the RR_SHIFTR calculated above, making it 4.

2. Voltage channel
   • SHIFTL = 0
   • DR = 64
   • DEC_SHIFTR = 0
   • DR2 = 6
   • RR_SHIFTR = log2(9) + max(0) + 3*log2(64) + 2*log2(6) - 0 - 30

     = 3.17 + 18 + 5.17 -30

     = -3.66

     = 0

   • MAX COUNT = 37,748,736(0x02400000)

2. Diagnostic channel
   • SHIFTL = 0
   • DR = 64
   • DEC_SHIFTR = 0
   • DR2 = 1
   • RR_SHIFTR = 0
   • MAX COUNT = 1,048,576 (0x00100000)

Voltage output:

voltage = decimator_output * ((max_reference_voltage - min_reference_voltage) / (max_counts - min_counts))

Parameters:

• counts – ADC Results from the conversion to be converted to millivolts
• channelType – Channel type. Options are:
  • CY_ADC_CURRENT_CHANNEL
  • CY_ADC_VOLTAGE_CHANNEL
  • CY_ADC_DIAGNOSTIC_CHANNEL
• sampleRate – Channel sample rate. Options are:
  • CY_ADC_SAMPLE_RATE_48KSPS
  • CY_ADC_SAMPLE_RATE_8KSPS
  • CY_ADC_SAMPLE_RATE_4KSPS
  • CY_ADC_SAMPLE_RATE_3KSPS
  • CY_ADC_SAMPLE_RATE_2KSPS
  • CY_ADC_SAMPLE_RATE_1KSPS
• vref – Reference voltage in Volts

Returns:

• Floating-point value of the result in volts

Cy_Adc_CountsToMillivolts()

float Cy_Adc_CountsToMillivolts (int32_t counts, cy_en_adc_channel_type_t channelType, cy_en_adc_sample_rate_t sampleRate, float vref)

Description:

Converts the input from raw ADC counts to millivolts

Voltage output:

voltage = decimator_output * ((max_reference_voltage - min_reference_voltage) / (max_counts - min_counts))

Parameters:

• counts – ADC Results from the conversion to be converted to millivolts
• channelType – Channel type. Options are:
  • CY_ADC_CURRENT_CHANNEL
  • CY_ADC_VOLTAGE_CHANNEL
  • CY_ADC_DIAGNOSTIC_CHANNEL
• sampleRate – Channel sample rate. Options are:
  • CY_ADC_SAMPLE_RATE_48KSPS
  • CY_ADC_SAMPLE_RATE_8KSPS
  • CY_ADC_SAMPLE_RATE_4KSPS
  • CY_ADC_SAMPLE_RATE_3KSPS
  • CY_ADC_SAMPLE_RATE_2KSPS
  • CY_ADC_SAMPLE_RATE_1KSPS
• vref – Reference voltage in volts

Returns:

• Floating-point value of the result in millivolts

Provides APIs for converting an ADC count delta to a temperature value.

Cy_Adc_GetDieTempFromDelta()

cy_en_adc_error_t Cy_Adc_GetDieTempFromDelta(int32_t *result, int32_t delta, cy_en_adc_die_temp_setup_t setup)

Description:

Converts the delta between two die temp measurements to degrees celsius in fixed-point 12.20 format

Uses the formula (a2 * x^2 * 2^-34 + a1 * x * 2^-9 + a0 * 2^14)/2^20

where x = Delta ADC = ADC(UNIT) - ADC(1)

The division by 2^20 is not performed; it is symbolic of the fixed-point 12.20 format of the result.

Parameters:

• delta – 32-bit delta between the two die temp measurements
• result – Pointer for the conversion result in fixed-point 12.20 format
• setup – Selects the primary or alternate temperature measurement coefficients stored in SFlash

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if delta is invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if result is NULL

Cy_Adc_InitializeDieTempConfigs()

cy_en_adc_error_t Cy_Adc_InitializeDieTempConfigs (cy_stc_adc_temperature_config_t * one, cy_stc_adc_temperature_config_t * unit, cy_en_adc_die_temp_setup_t setup)

Description:

Initializes the two configurations used for temperature measurement with factory settings.

Die temperature measurements are made by taking two measurements, ADC(1) and ADC(UNIT). Each measurement uses a different number of either bipolar units or reference currents. The difference of these two measurements can be converted to a temperature using the Cy_Adc_GetDieTempFromDelta API.

Parameters:

• one – Address of the configuration for the (1) measurement
• unit – Address of the configuration for the (UNIT) measurement
• setup – Selects the primary or alternate temperature measurement parameters stored in SFlash

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if setup in invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if one or unit are NULL

Cy_Adc_NormalizeDelta()

cy_en_adc_error_t Cy_Adc_NormalizeDelta(int32_t *newDelta, int32_t delta, float ratio)

Description:

Normalizes the delta VBE measurement to the ratio of the current sources.

The delta VBE measurement is normalized to the ratio of the current sources by measuring the resistive load of the temperature sensor using the same bipolar transistors and current units.

The ratio of current sources or transistors is usually 9/1 so normalization can be done with the equation:

newDelta = delta*LN(9)/LN(ratio)

Natural logarithm is processor intensive so we instead use the linear approximation:

newDelta = delta + delta*(A*ratio + B)

where A = -0.0534 and B = 0.48

Parameters:

• newDelta – Address to store the normalized delta VBE
• delta – Delta VBE determined by two ADC measurements
• ratio – UNIT/1 ratio of the measured voltage across the resistor

Returns:

• CY_ADC_ERROR_NONE if no errors occur
• CY_ADC_ERROR_BAD_PARAM if setup in invalid
• CY_ADC_ERROR_INPUT_ADDRESS_IS_NULL if one or unit are NULL

Provides APIs for detecting disconnect shunt connections by switching internal pull-up resistors to the shunt pins. If the resistance between the RSHx or RSLx to ground is more than 1000 Ω, an open pin fault can be detected. Figure 23 shows the shunt resistor open detection diagram.

Cy_Adc_GetPullupResistance()

uint16_t Cy_Adc_GetPullupResistance (cy_en_adc_rs_pin_type_t pin, int32_t temperature)

Description:

Returns the linearly interpolated resistance of the pull-up resistor

Parameters:

• pullup – Selects which of the diagnostic pull-up resistors to choose
• temperature – Temperature of the die in 12.20 fixed-point celsius. Used for linear interpolation of the pull-up value along with the hot and cold values stored in the SFlash

Returns:

• uint16_t Pull-up resistance value in ohms; returns zero if pull-up is invalid

Cy_Adc_IsRsOpen()

bool Cy_Adc_IsRsOpen (int32_t pullup, int32_t shunt, int32_t temperature, cy_en_adc_rs_pin_type_t pin)

Description:

Uses samples of the shunt resistor and pull-up resistor to determine if the shunt resistor is disconnected (open). The circuit is open if the measured voltage with the pull-up enabled (Vpu) is greater than 1 volt or if Vpu > Vadc_th where Vadc_th is:

Vadc_th = Vsh + (Vdd - Vsh) * 600 / (600 + Rpu)

Vsh is the measured shunt voltage Rpu is the value of the pull-up resistor, determined using the temperature, based on measured values stored in SFlash.

The diagnostic channel uses a gain of 0.5x for these samples. The values input is multiplied by 2 in this function to correct for that attenuation.

Parameters:

• pullup – Result of measuring with the pull-up resistor enabled
• shunt – Result of measuring the shunt without the pull-up
• temperature – Temperature of the die in 12.20 fixed point celsius. Used to determine the pull-up value
• pin – Selects which pin is being tested

Returns:

• true if RS open detected
• false if RS open not detected