General Description

API Reference
	Channel functions

	FIR functions

	FIFO functions

Functions
cy_en_hppass_status_t	Cy_HPPASS_SAR_Init (const cy_stc_hppass_sar_t *sarCfg)
	Loads the SAR ADC configuration. More...

void	Cy_HPPASS_SAR_DeInit (void)
	Resets all the SAR registers to their default state.

__STATIC_INLINE bool	Cy_HPPASS_SAR_IsBusy (void)
	Returns the SAR ADC busy status. More...

__STATIC_INLINE cy_en_hppass_status_t	Cy_HPPASS_SAR_Limit_Config (uint8_t limIdx, const cy_stc_hppass_sar_limit_t *limCfg)
	Configures the ADC limit crossing detection block. More...

void	Cy_HPPASS_SAR_CrossTalkAdjust (uint8_t groupMsk)
	Adjusts the sampler offset trimming according to the number of simultaneously triggered (sampled and held) samplers, specified by groupMask (for single or multiple simultaneously triggered groups with same timing settings) More...

__STATIC_INLINE cy_en_hppass_status_t	Cy_HPPASS_SAR_GroupConfig (uint8_t grpIdx, const cy_stc_hppass_sar_grp_t *grpCfg)
	Configures a single Sequencer Group. More...

__STATIC_INLINE cy_en_hppass_status_t	Cy_HPPASS_SAR_DisableGroupContConvert (uint8_t grpIdx)
	Disables continuous conversion for the specified SAR group. More...

__STATIC_INLINE uint8_t	Cy_HPPASS_SAR_GetTriggerCollisionStatus (void)
	Returns the Sequencer Group Trigger Collision Status for all the Groups. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_ClearTriggerCollisionStatus (uint8_t trigCollision)
	Clears the Sequencer Group Trigger Collision Status for the specified Sequences. More...

__STATIC_INLINE uint8_t	Cy_HPPASS_SAR_GetHoldViolationStatus (void)
	Returns the Sequencer Group Hold Violation Status for all the Sequences. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_ClearHoldViolationStatus (uint8_t holdViolation)
	Clears the Sequencer Group Hold Violation Status for the specified Sequences. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_SetHoldViolationCnt (uint16_t cnt)
	Sets the common maximum hold count value for all the Sequencer Groups. More...

__STATIC_INLINE uint16_t	Cy_HPPASS_SAR_GetHoldViolationCnt (void)
	Returns the common maximum hold count value for all the Sequencer Groups. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_SetTempSensorCurrent (cy_en_hppass_sar_temp_sensor_current_t curr)
	Selects low or high current for temperature sensor. More...

__STATIC_INLINE int16_t	Cy_HPPASS_TEMP_Calc (int16_t tempHi, int16_t tempLo)
	Calculates the temperature based on two ADC reading results of temperature sensor. More...

void	Cy_HPPASS_SAR_TempAdjust (int16_t temp, uint16_t vRef)
	BWC. More...

__STATIC_INLINE uint32_t	Cy_HPPASS_SAR_Limit_GetInterruptStatus (void)
	Returns the limit crossing interrupt register status. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_Limit_ClearInterrupt (uint32_t interrupt)
	Clears the limit crossing interrupt for SAR. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_Limit_SetInterrupt (uint32_t interrupt)
	Sets a software interrupt request for the specified limit crossing detection block. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_Limit_SetInterruptMask (uint32_t interrupt)
	Enables the interrupt for the specified limit crossing detection block. More...

__STATIC_INLINE uint32_t	Cy_HPPASS_SAR_Limit_GetInterruptMask (void)
	Returns the interrupt mask for the specified limit crossing detection block. More...

__STATIC_INLINE uint32_t	Cy_HPPASS_SAR_Limit_GetInterruptStatusMasked (void)
	Gets limit crossing interrupt masked status. More...

__STATIC_INLINE uint32_t	Cy_HPPASS_SAR_Result_GetInterruptStatus (void)
	Gets the SAR result interrupt status (ENTRY done, FIR done). More...

__STATIC_INLINE void	Cy_HPPASS_SAR_Result_ClearInterrupt (uint32_t interrupt)
	Clears SAR result interrupt. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_Result_SetInterrupt (uint32_t interrupt)
	Sets a software SAR result interrupt request. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_Result_SetInterruptMask (uint32_t interrupt)
	Enables the SAR result interrupt. More...

__STATIC_INLINE uint32_t	Cy_HPPASS_SAR_Result_GetInterruptMask (void)
	Gets the SAR result interrupt mask. More...

__STATIC_INLINE uint32_t	Cy_HPPASS_SAR_Result_GetInterruptStatusMasked (void)
	Gets the SAR result interrupt masked status. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_SetSwitch (uint16_t muxMask)
	Sets selected AROUTE switch closed. More...

__STATIC_INLINE void	Cy_HPPASS_SAR_ClearSwitch (uint16_t muxMask)
	Clears selected AROUTE switch open. More...

__STATIC_INLINE uint16_t	Cy_HPPASS_SAR_GetSwitchStatus (void)
	Reads the current state of the AROUTE switch. More...

float32_t	Cy_HPPASS_SAR_CountsTo_Volts (uint8_t chanIdx, uint16_t vRef, int16_t chanCounts)
	Converts the raw ADC result in counts into the analog pin voltage in volts. More...

int16_t	Cy_HPPASS_SAR_CountsTo_mVolts (uint8_t chanIdx, uint16_t vRef, int16_t chanCounts)
	Converts the raw ADC result in counts into the analog pin voltage in millivolts. More...

int32_t	Cy_HPPASS_SAR_CountsTo_uVolts (uint8_t chanIdx, uint16_t vRef, int16_t chanCounts)
	Converts the raw ADC result in counts into the analog pin voltage in microvolts. More...

Function Documentation

◆ Cy_HPPASS_SAR_Init()

cy_en_hppass_status_t Cy_HPPASS_SAR_Init ( const cy_stc_hppass_sar_t * sarCfg )

Loads the SAR ADC configuration.

Can be used after the Cy_HPPASS_Init function to update the SAR settings.

Note: If AC is running the initialization of SAR block is not allowed (CY_HPPASS_AC_INVALID_STATE will be returned).; If the SAR block is currently busy the initialization is not allowed (CY_HPPASS_SAR_INVALID_STATE will be returned).; Since the 'block ready' status is combined SAR and CSG, this particular SAR function cannot be protected from reinitialization during the 'block ready' == true condition, so it is on user's responsibility when and from where to call this function to reinitialize the SAR block.

Parameters

sarCfg Pointer to the SAR configuration structure cy_stc_hppass_sar_t. The pointer cannot be NULL.

Returns: Status of initialization, cy_en_hppass_status_t.

Function Usage

cy_stc_hppass_sar_t sarCfg =
{
    .vref        = CY_HPPASS_SAR_VREF_VDDA,
    .lowSupply   = false,
    .offsetCal   = false,
    .linearCal   = false,
    .gainCal     = false,
    .chanId      = false,
    .dirSampEnMsk   = CY_HPPASS_SAR_DIRECT_SAMP_0,
    .muxSampEnMsk   = CY_HPPASS_SAR_MUXED_SAMP_0 | CY_HPPASS_SAR_MUXED_SAMP_1 | CY_HPPASS_SAR_MUXED_SAMP_2 | CY_HPPASS_SAR_MUXED_SAMP_3,
    .holdCount   = 29, /* Optimal value */
    .aroute    = true,
    .dirSampGain = {CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1,
                    CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1,
                    CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1},
    .muxSampGain = {CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1, CY_HPPASS_SAR_SAMP_GAIN_1},
    .sampTime    = {100, 31, 31}, /* Optimal value */
    .chan        = {&chanCfg, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, &chanCfg, NULL,
                    NULL, NULL, &chanCfg, NULL, NULL, NULL, &chanCfg, NULL, NULL, NULL, &chanCfg, NULL, NULL, NULL},
    .grp         = {&grpCfg, NULL, NULL, NULL, NULL, NULL, NULL, NULL},
    .limit       = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL},    
    .muxMode     = {CY_HPPASS_SAR_MUX_SEQ, CY_HPPASS_SAR_MUX_SEQ, CY_HPPASS_SAR_MUX_SEQ, CY_HPPASS_SAR_MUX_SEQ},
    .fir         = {NULL, NULL},
    .fifo        = NULL
};

◆ Cy_HPPASS_SAR_IsBusy()

__STATIC_INLINE bool Cy_HPPASS_SAR_IsBusy ( void )

Returns the SAR ADC busy status.

Note: Do not use this function with continuous Sequencer Group mode cy_stc_hppass_sar_grp_t::continuous. See the Device Datasheet Errata section for more details.

Returns: Busy status: true - busy, false - idle.

Function Usage

/* Check that SAR is not busy */

if (!Cy_HPPASS_SAR_IsBusy())

◆ Cy_HPPASS_SAR_Limit_Config()

__STATIC_INLINE cy_en_hppass_status_t Cy_HPPASS_SAR_Limit_Config	(	uint8_t	limIdx,
		const cy_stc_hppass_sar_limit_t *	limCfg
	)

Configures the ADC limit crossing detection block.

Note: If AC is running this configuration is not allowed (CY_HPPASS_AC_INVALID_STATE will be returned).; If the SAR block is currently busy the initialization is not allowed (CY_HPPASS_SAR_INVALID_STATE will be returned).; Since the 'block ready' status is combined SAR and CSG, this particular SAR function cannot be protected from reinitialization during the 'block ready' == true condition, so it is on user's responsibility when and from where to call this function to reconfigure this SAR sub-block.

Parameters

limIdx	The index of the limit crossing detection block. Valid range 0..7.
limCfg	Pointer to the limit crossing detection configuration structure cy_stc_hppass_sar_limit_t. The pointer cannot be NULL.

Returns: Status, cy_en_hppass_status_t.

Function Usage

    /* Scenario: The SAR result should be in range between LIMIT_LOW and LIMIT_HIGH */
    const cy_stc_hppass_sar_limit_t lim0 =
    {
        .cond = CY_HPPASS_SAR_COND_INSIDE,
        .low = -300,
        .high = 500
    };
    /* Update limit configuration for crossing detection block #0 */
    status = Cy_HPPASS_SAR_Limit_Config(0U, &lim0);
    /* Process returned status */

◆ Cy_HPPASS_SAR_CrossTalkAdjust()

void Cy_HPPASS_SAR_CrossTalkAdjust ( uint8_t groupMsk )

Adjusts the sampler offset trimming according to the number of simultaneously triggered (sampled and held) samplers, specified by groupMask (for single or multiple simultaneously triggered groups with same timing settings)

Each sampler is compensated in relation to the other samplers that are sampled and held simultaneously.

Basic use case:

This function has to be called after the following functions calls: Cy_HPPASS_Init, Cy_HPPASS_SAR_Init, Cy_HPPASS_SAR_GroupConfig, or Cy_HPPASS_SAR_TempAdjust.

Note: The Device Configurator automatically generates a call to this function during startup if the appropriate parameter in HPPASS configurations is checked.

Advanced use cases:

If a sampler is involved in multiple groups, this function has to be called each time before another one of these groups is triggered, to re-compensate the sampler within the another group.
If multiple groups are triggered simultaneously (by the same trigger signal), and the sampling timer settings for these groups are identical, this function has to be called with combined mask of the simultaneously triggered groups.

Note: This function does not perform compensation for four or fewer simultaneously triggered samplers (within single or multiple groups), as the impact of compensation in these cases is negligible.

Warning: This function has not be used when VDDA is less than 2.7V, as this can cause over-compensation.

Parameters

groupMsk The mask of the simultaneously triggered groups

Function Usage

    /* Scenario: The Cy_HPPASS_SAR_CrossTalkAdjust() call follows the Cy_HPPASS_SAR_TempAdjust() call */
    /* The CY_CFG_PWR_VDDA_MV macro is defined by the Device Configurator */
    Cy_HPPASS_SAR_TempAdjust((int16_t)fltTemp, CY_CFG_PWR_VDDA_MV);
    Cy_HPPASS_SAR_CrossTalkAdjust(CY_HPPASS_SAR_GROUP_0_Msk);

◆ Cy_HPPASS_SAR_GroupConfig()

__STATIC_INLINE cy_en_hppass_status_t Cy_HPPASS_SAR_GroupConfig	(	uint8_t	grpIdx,
		const cy_stc_hppass_sar_grp_t *	grpCfg
	)

Configures a single Sequencer Group.

Note: If AC is running this configuration is not allowed (CY_HPPASS_AC_INVALID_STATE will be returned).; If the SAR block is currently busy the initialization is not allowed (CY_HPPASS_SAR_INVALID_STATE will be returned).; Since the 'block ready' status is combined SAR and CSG, this particular SAR function cannot be protected from reinitialization during the 'block ready' == true condition, so it is on user's responsibility when and from where to call this function to reconfigure this SAR sub-block.

Parameters

grpIdx	The index of the Sequencer Group. Valid range 0..7.
grpCfg	Pointer to the Sequencer Group configuration structure cy_stc_hppass_sar_grp_t. The pointer cannot be NULL.

Returns: Status, cy_en_hppass_status_t.

Function Usage

const cy_stc_hppass_sar_grp_t grpCfg =
{
    .dirSampMsk   = CY_HPPASS_SAR_DIRECT_SAMP_0,
    .muxSampMsk   = CY_HPPASS_SAR_MUXED_SAMP_0 | CY_HPPASS_SAR_MUXED_SAMP_1 | CY_HPPASS_SAR_MUXED_SAMP_2 | CY_HPPASS_SAR_MUXED_SAMP_3,
    .muxChanIdx      = {0, 0, 0, 0},
    .trig     = CY_HPPASS_SAR_TRIG_AC,
    .sampTime = CY_HPPASS_SAR_SAMP_TIME_0,
    .priority    = false,
    .continuous  = false
};

◆ Cy_HPPASS_SAR_DisableGroupContConvert()

__STATIC_INLINE cy_en_hppass_status_t Cy_HPPASS_SAR_DisableGroupContConvert ( uint8_t grpIdx )

Disables continuous conversion for the specified SAR group.

Note: If AC is running this configuration is not allowed (CY_HPPASS_AC_INVALID_STATE will be returned).; to re-enable the continuous conversion, the restart of entire SAR block using Cy_HPPASS_AC_Start is needed.; Since the 'block ready' status is combined SAR and CSG, this particular SAR function cannot be protected from reinitialization during the 'block ready' == true condition, so it is on user's responsibility when and from where to call this function to reconfigure this SAR sub-block.

Parameters

grpIdx The index of the Sequencer Group. Valid range 0..7.

Returns: Status, cy_en_hppass_status_t.

Function Usage

    #define SAR_GROUP_IDX (5U)
    /* Disable continuous conversion for the specified SAR group */
    if (CY_HPPASS_SUCCESS != Cy_HPPASS_SAR_DisableGroupContConvert(SAR_GROUP_IDX))
    {
        /* Something went wrong, insert error handling here */
    }

◆ Cy_HPPASS_SAR_GetTriggerCollisionStatus()

__STATIC_INLINE uint8_t Cy_HPPASS_SAR_GetTriggerCollisionStatus ( void )

Returns the Sequencer Group Trigger Collision Status for all the Groups.

Returns: 8-bit Group mask (a bit per each Group). See Sequencer Group Trigger Collision Status Masks.

Function Usage

uint8_t trigCollision = Cy_HPPASS_SAR_GetTriggerCollisionStatus();

◆ Cy_HPPASS_SAR_ClearTriggerCollisionStatus()

__STATIC_INLINE void Cy_HPPASS_SAR_ClearTriggerCollisionStatus ( uint8_t trigCollision )

Clears the Sequencer Group Trigger Collision Status for the specified Sequences.

Parameters

trigCollision The 8-bit Group mask (a bit per each Group). See Sequencer Group Trigger Collision Status Masks.

Function Usage

Cy_HPPASS_SAR_ClearTriggerCollisionStatus(CY_HPPASS_SAR_GROUP_0_TRIG_COLLISION);

◆ Cy_HPPASS_SAR_GetHoldViolationStatus()

__STATIC_INLINE uint8_t Cy_HPPASS_SAR_GetHoldViolationStatus ( void )

Returns the Sequencer Group Hold Violation Status for all the Sequences.

Returns: 8-bit Group mask (a bit per each Group).

Function Usage

uint8_t holdViolation = Cy_HPPASS_SAR_GetHoldViolationStatus();

◆ Cy_HPPASS_SAR_ClearHoldViolationStatus()

__STATIC_INLINE void Cy_HPPASS_SAR_ClearHoldViolationStatus ( uint8_t holdViolation )

Clears the Sequencer Group Hold Violation Status for the specified Sequences.

Parameters

holdViolation The 8-bit Group mask (a bit per each Group).

Function Usage

Cy_HPPASS_SAR_ClearHoldViolationStatus(0U);

◆ Cy_HPPASS_SAR_SetHoldViolationCnt()

__STATIC_INLINE void Cy_HPPASS_SAR_SetHoldViolationCnt ( uint16_t cnt )

Sets the common maximum hold count value for all the Sequencer Groups.

Parameters

cnt	The hold count value.

Function Usage

Cy_HPPASS_SAR_SetHoldViolationCnt(0xFFU);

uint16_t holdCnt = Cy_HPPASS_SAR_GetHoldViolationCnt();

◆ Cy_HPPASS_SAR_GetHoldViolationCnt()

__STATIC_INLINE uint16_t Cy_HPPASS_SAR_GetHoldViolationCnt ( void )

Returns the common maximum hold count value for all the Sequencer Groups.

Returns: The hold count value.

Function Usage

Cy_HPPASS_SAR_SetHoldViolationCnt(0xFFU);

uint16_t holdCnt = Cy_HPPASS_SAR_GetHoldViolationCnt();

◆ Cy_HPPASS_SAR_SetTempSensorCurrent()

__STATIC_INLINE void Cy_HPPASS_SAR_SetTempSensorCurrent ( cy_en_hppass_sar_temp_sensor_current_t curr )

Selects low or high current for temperature sensor.

Parameters

curr	Current: false - BJT current is 1uA (default), true - Add 8uA to BJT current.

Function Usage

    if (flag)  /* The flag should be set periodically, e.g., using AC, Timer, or SAR event itself. */
    {
        flag = false; /* Clear the request */
        switch (tempMeasureSequence)
        {
            case TRIG_TEMP_HI:
                Cy_HPPASS_SAR_SetTempSensorCurrent(CY_HPPASS_SAR_TEMP_SENSOR_CURRENT_HI);
                Cy_HPPASS_SetFwTrigger(CY_HPPASS_TRIG_0_MSK); /* Triggering the temperature measurement */
                tempMeasureSequence = TRIG_TEMP_LO;
                break;
            case TRIG_TEMP_LO:
                tempHi = Cy_HPPASS_SAR_Result_ChannelRead(TEMPSENS_CHAN_IDX);
                Cy_HPPASS_SAR_SetTempSensorCurrent(CY_HPPASS_SAR_TEMP_SENSOR_CURRENT_LO);
                Cy_HPPASS_SetFwTrigger(CY_HPPASS_TRIG_0_MSK); /* Triggering the temperature measurement */
                tempMeasureSequence = CALC_TEMP;
                break;
            case CALC_TEMP:
                tempLo = Cy_HPPASS_SAR_Result_ChannelRead(TEMPSENS_CHAN_IDX);
                instTemp = Cy_HPPASS_TEMP_Calc(tempHi, tempLo);
                fltTemp = K * fltTemp + (1.f - K) * instTemp; /* One pole Low Pass Filter. K = Tf/(Tf + Ts).
                                                               * Tf: filter time constant, Ts: sample time. */
                tempMeasureSequence = TRIG_TEMP_HI; /* Go back to the start of the sequence */
                break;
            default:
                break;
        }
    }

◆ Cy_HPPASS_TEMP_Calc()

__STATIC_INLINE int16_t Cy_HPPASS_TEMP_Calc	(	int16_t	tempHi,
		int16_t	tempLo
	)

Calculates the temperature based on two ADC reading results of temperature sensor.

See the device Architecture Technical Reference Manual for more detail.

Parameters

tempHi	ADC reading when the selected temp sensor is biased with a additional 8uA current.
tempLo	ADC reading when the selected temp sensor is biased with a 1uA current.

Returns: Temperature value.

Function Usage

    if (flag)  /* The flag should be set periodically, e.g., using AC, Timer, or SAR event itself. */
    {
        flag = false; /* Clear the request */
        switch (tempMeasureSequence)
        {
            case TRIG_TEMP_HI:
                Cy_HPPASS_SAR_SetTempSensorCurrent(CY_HPPASS_SAR_TEMP_SENSOR_CURRENT_HI);
                Cy_HPPASS_SetFwTrigger(CY_HPPASS_TRIG_0_MSK); /* Triggering the temperature measurement */
                tempMeasureSequence = TRIG_TEMP_LO;
                break;
            case TRIG_TEMP_LO:
                tempHi = Cy_HPPASS_SAR_Result_ChannelRead(TEMPSENS_CHAN_IDX);
                Cy_HPPASS_SAR_SetTempSensorCurrent(CY_HPPASS_SAR_TEMP_SENSOR_CURRENT_LO);
                Cy_HPPASS_SetFwTrigger(CY_HPPASS_TRIG_0_MSK); /* Triggering the temperature measurement */
                tempMeasureSequence = CALC_TEMP;
                break;
            case CALC_TEMP:
                tempLo = Cy_HPPASS_SAR_Result_ChannelRead(TEMPSENS_CHAN_IDX);
                instTemp = Cy_HPPASS_TEMP_Calc(tempHi, tempLo);
                fltTemp = K * fltTemp + (1.f - K) * instTemp; /* One pole Low Pass Filter. K = Tf/(Tf + Ts).
                                                               * Tf: filter time constant, Ts: sample time. */
                tempMeasureSequence = TRIG_TEMP_HI; /* Go back to the start of the sequence */
                break;
            default:
                break;
        }
    }

◆ Cy_HPPASS_SAR_TempAdjust()

void Cy_HPPASS_SAR_TempAdjust	(	int16_t	temp,
		uint16_t	vRef
	)

BWC.

Adjusts the offset calibration value according to input temperature value.

Parameters

temp	The temperature value.
vRef	The reference voltage in mV used by the system in the field.

Function Usage

    /* Scenario: Update offset calibration according to temperature and VREF in the field */
    #define TEMPERATURE_IN_CELSIUS  (60)
    #define VREF_IN_MV              (3400U)
    Cy_HPPASS_SAR_TempAdjust(TEMPERATURE_IN_CELSIUS, VREF_IN_MV);

◆ Cy_HPPASS_SAR_Limit_GetInterruptStatus()

__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Limit_GetInterruptStatus ( void )

Returns the limit crossing interrupt register status.

Returns: The status of combined interrupt requests for the SAR Group_hppass_sar_limit_interrupts.

Function Usage

    /* Scenario: Get the limit crossing interrupt register status */
    interrupt = Cy_HPPASS_SAR_Limit_GetInterruptStatus();
    /* Process returned status */

◆ Cy_HPPASS_SAR_Limit_ClearInterrupt()

__STATIC_INLINE void Cy_HPPASS_SAR_Limit_ClearInterrupt ( uint32_t interrupt )

Clears the limit crossing interrupt for SAR.

Parameters

interrupt The mask of interrupts to clear. Each bit of this mask is responsible for clearing of the particular interrupt in the SAR Group_hppass_sar_limit_interrupts.

Function Usage

/* Scenario: Clear limit interrupt for the SAR Sequencer Group #0 */

Cy_HPPASS_SAR_Limit_ClearInterrupt(CY_HPPASS_INTR_SAR_LIMIT_GROUP_0);

◆ Cy_HPPASS_SAR_Limit_SetInterrupt()

__STATIC_INLINE void Cy_HPPASS_SAR_Limit_SetInterrupt ( uint32_t interrupt )

Sets a software interrupt request for the specified limit crossing detection block.

Parameters

interrupt The mask of interrupts to set. Each bit of this mask is responsible for triggering of the particular interrupt in the SAR Group_hppass_sar_limit_interrupts.

Function Usage

/* Scenario: Set limit interrupt for the SAR Sequencer Group #7 */

Cy_HPPASS_SAR_Limit_SetInterrupt(CY_HPPASS_INTR_SAR_LIMIT_GROUP_7);

◆ Cy_HPPASS_SAR_Limit_SetInterruptMask()

__STATIC_INLINE void Cy_HPPASS_SAR_Limit_SetInterruptMask ( uint32_t interrupt )

Enables the interrupt for the specified limit crossing detection block.

Parameters

interrupt The mask of interrupts allowable for activation. Each bit of this mask allows triggering of the particular interrupt in the SAR Group_hppass_sar_limit_interrupts.

Function Usage

/* Scenario: Enable the limit interrupt for the SAR Sequencer Group #3 */

Cy_HPPASS_SAR_Limit_SetInterruptMask(CY_HPPASS_INTR_SAR_LIMIT_GROUP_3);

◆ Cy_HPPASS_SAR_Limit_GetInterruptMask()

__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Limit_GetInterruptMask ( void )

Returns the interrupt mask for the specified limit crossing detection block.

Returns: The mask of the interrupts allowable for activation Group_hppass_sar_limit_interrupts.

Function Usage

     /* Scenario: Get limit crossing interrupt masked status */
    interrupt = Cy_HPPASS_SAR_Limit_GetInterruptMask();
    /* Process returned status */

◆ Cy_HPPASS_SAR_Limit_GetInterruptStatusMasked()

__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Limit_GetInterruptStatusMasked ( void )

Gets limit crossing interrupt masked status.

Returns: The masked status of combined interrupt requests for the SAR Group_hppass_sar_limit_interrupts.

Function Usage

    /* Scenario: Get limit crossing interrupt masked status */
    interrupt = Cy_HPPASS_SAR_Limit_GetInterruptStatusMasked();
    /* Process returned status */

◆ Cy_HPPASS_SAR_Result_GetInterruptStatus()

__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Result_GetInterruptStatus ( void )

Gets the SAR result interrupt status (ENTRY done, FIR done).

Returns: The status of combined interrupt requests for the SAR Result Interrupt Masks.

Function Usage

/* Polling SAR interrupt status register */

if (CY_HPPASS_INTR_SAR_RESULT_GROUP_0 == Cy_HPPASS_SAR_Result_GetInterruptStatus())

◆ Cy_HPPASS_SAR_Result_ClearInterrupt()

__STATIC_INLINE void Cy_HPPASS_SAR_Result_ClearInterrupt ( uint32_t interrupt )

Clears SAR result interrupt.

Parameters

interrupt The mask of interrupts to clear. Each bit of this mask is responsible for clearing of the particular interrupt in the SAR Result Interrupt Masks.

Function Usage

/* Clear interrupt for Result Group 0 */

Cy_HPPASS_SAR_Result_ClearInterrupt(CY_HPPASS_INTR_SAR_RESULT_GROUP_0);

◆ Cy_HPPASS_SAR_Result_SetInterrupt()

__STATIC_INLINE void Cy_HPPASS_SAR_Result_SetInterrupt ( uint32_t interrupt )

Sets a software SAR result interrupt request.

Parameters

interrupt The mask of interrupts to set. Each bit of this mask is responsible for triggering of the particular interrupt in the SAR Result Interrupt Masks.

Function Usage

Cy_HPPASS_SAR_Result_SetInterrupt(CY_HPPASS_INTR_SAR_RESULT_GROUP_0);

◆ Cy_HPPASS_SAR_Result_SetInterruptMask()

__STATIC_INLINE void Cy_HPPASS_SAR_Result_SetInterruptMask ( uint32_t interrupt )

Enables the SAR result interrupt.

Parameters

interrupt The mask of interrupts allowable for activation. Each bit of this mask allows triggering of the particular interrupt in the SAR Result Interrupt Masks.

Function Usage

Cy_HPPASS_SAR_Result_SetInterruptMask(CY_HPPASS_INTR_SAR_RESULT_FIR_0);

◆ Cy_HPPASS_SAR_Result_GetInterruptMask()

__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Result_GetInterruptMask ( void )

Gets the SAR result interrupt mask.

Returns: The mask of the interrupts allowable for activation Result Interrupt Masks.

Function Usage

interrupt = Cy_HPPASS_SAR_Result_GetInterruptMask();

◆ Cy_HPPASS_SAR_Result_GetInterruptStatusMasked()

__STATIC_INLINE uint32_t Cy_HPPASS_SAR_Result_GetInterruptStatusMasked ( void )

Gets the SAR result interrupt masked status.

Returns: The masked status of combined interrupt requests for the SAR Result Interrupt Masks.

Function Usage

interrupt = Cy_HPPASS_SAR_Result_GetInterruptStatusMasked();

◆ Cy_HPPASS_SAR_SetSwitch()

__STATIC_INLINE void Cy_HPPASS_SAR_SetSwitch ( uint16_t muxMask )

Sets selected AROUTE switch closed.

Used for FW control input connections of the muxed samplers.

Note: This function works only if cy_stc_hppass_sar_t::muxMode is set to CY_HPPASS_SAR_MUX_FW for selected mux. See TRM for details.

Parameters

muxMask The mask of AROUTE switch.

Function Usage

Cy_HPPASS_SAR_SetSwitch(sw);

◆ Cy_HPPASS_SAR_ClearSwitch()

__STATIC_INLINE void Cy_HPPASS_SAR_ClearSwitch ( uint16_t muxMask )

Clears selected AROUTE switch open.

Used for FW control input connections of the muxed samplers.

Note: This function works only if cy_stc_hppass_sar_t::muxMode is set to CY_HPPASS_SAR_MUX_FW for selected mux. See TRM for details.

Parameters

muxMask The mask of AROUTE switch.

Function Usage

Cy_HPPASS_SAR_ClearSwitch(sw);

◆ Cy_HPPASS_SAR_GetSwitchStatus()

__STATIC_INLINE uint16_t Cy_HPPASS_SAR_GetSwitchStatus ( void )

Reads the current state of the AROUTE switch.

Returns: Read back the current state of the associated switch control.

Function Usage

uint16_t sw = Cy_HPPASS_SAR_GetSwitchStatus();

◆ Cy_HPPASS_SAR_CountsTo_Volts()

float32_t Cy_HPPASS_SAR_CountsTo_Volts	(	uint8_t	chanIdx,
		uint16_t	vRef,
		int16_t	chanCounts
	)

Converts the raw ADC result in counts into the analog pin voltage in volts.

For example, for the 0.534-volt ADC, the return value is 0.534. Voltage calculation depends on ADC channel work modes: Averaging, Signed, Pseudo-Differential, and Sampler Gain.

The equation:

V = ((chanCounts + chanOffset * avgMultiplier) * vRef / 1000) / (4095 * avgMultiplier * samplerGain)

where,

chanCounts: the raw counts from the SAR 16-bit CHAN_RESULT register
avgMultiplier: the multiplier value based on Averaging mode (cy_stc_hppass_sar_chan_t) and the number of samples averaged (cy_en_hppass_sar_avg_t)
- CY_HPPASS_SAR_AVG_DISABLED : avgMultiplier is 1<<0
- CY_HPPASS_SAR_AVG_16 : avgMultiplier is 1<<4
chanOffset: the constant value based on Signed and Differential modes cy_stc_hppass_sar_chan_t
- for Signed mode - true and Differential mode - disabled, chanOffset is 2048
- for Signed mode - false and Differential mode - enabled, chanOffset is -2048
- for all other cases, chanOffset is 0
vRef: the SAR ADC reference voltage in millivolts (for example, 3300U).

Note: This function is valid only for the right-aligned result.

Parameters

chanIdx	The channel index . Valid range - 0..27.
vRef	The SAR ADC reference voltage in millivolts
chanCounts	Conversion result from Cy_HPPASS_SAR_Result_ChannelRead

Returns: The result in Volts.

Function Usage

◆ Cy_HPPASS_SAR_CountsTo_mVolts()

int16_t Cy_HPPASS_SAR_CountsTo_mVolts	(	uint8_t	chanIdx,
		uint16_t	vRef,
		int16_t	chanCounts
	)

Converts the raw ADC result in counts into the analog pin voltage in millivolts.

For example, for the 0.534-volts ADC, the return value is 534. Voltage calculation depends on ADC channel work modes: Averaging, Signed, Pseudo-Differential, and Sampler Gain.

The equation:

mV = ((chanCounts + chanOffset * avgMultiplier) * vRef) / (4095 * avgMultiplier * samplerGain)

where,

chanCounts: the raw counts from the SAR 16-bit CHAN_RESULT register
avgMultiplier: the multiplier value based on Averaging mode (cy_stc_hppass_sar_chan_t) and the number of samples averaged (cy_en_hppass_sar_avg_t)
- CY_HPPASS_SAR_AVG_DISABLED : avgMultiplier is 1<<0
- CY_HPPASS_SAR_AVG_16 : avgMultiplier is 1<<4
chanOffset: the constant value based on Signed and Differential modes cy_stc_hppass_sar_chan_t
- for Signed mode - true and Differential mode - disabled, chanOffset is 2048
- for Signed mode - false and Differential mode - enabled, chanOffset is -2048
- for all other cases, chanOffset is 0
vRef: the SAR ADC reference voltage in millivolts (for example, 3300U).

Note: This function is valid only for the right-aligned result.

Parameters

chanIdx	The channel index . Valid range - 0..27.
vRef	The SAR ADC reference voltage in millivolts
chanCounts	Conversion result from Cy_HPPASS_SAR_Result_ChannelRead

Returns: The result in millivolts.

Function Usage

◆ Cy_HPPASS_SAR_CountsTo_uVolts()

int32_t Cy_HPPASS_SAR_CountsTo_uVolts	(	uint8_t	chanIdx,
		uint16_t	vRef,
		int16_t	chanCounts
	)

Converts the raw ADC result in counts into the analog pin voltage in microvolts.

For example, for the 0.534-volts ADC, the return value is 534000. Voltage calculation depends on ADC channel work modes: Averaging, Signed, Pseudo-Differential, and Sampler Gain.

The equation:

uV = ((chanCounts + chanOffset * avgMultiplier) * vRef * 1000)/ (4095 * avgMultiplier * samplerGain)

where,

chanCounts: the raw counts from the SAR 16-bit CHAN_RESULT register
avgMultiplier: the multiplier value based on Averaging mode (cy_stc_hppass_sar_chan_t) and the number of samples averaged (cy_en_hppass_sar_avg_t)
- CY_HPPASS_SAR_AVG_DISABLED : avgMultiplier is 1<<0
- CY_HPPASS_SAR_AVG_16 : avgMultiplier is 1<<4
- CY_HPPASS_SAR_AVG_32 : avgMultiplier is 1<<4 in Signed mode and 1<<3 in Unsigned mode
chanOffset: the constant value based on Signed and Differential modes cy_stc_hppass_sar_chan_t
- for Signed mode - true and Differential mode - disabled, chanOffset is 2048
- for Signed mode - false and Differential mode - enabled, chanOffset is -2048
- for all other cases, chanOffset is 0
vRef: the SAR ADC reference voltage in millivolts (for example, 3300U).

Note: This function is valid only for the right-aligned result.

Parameters

chanIdx	The channel index . Valid range - 0..27.
vRef	The SAR ADC reference voltage in millivolts
chanCounts	Conversion result from Cy_HPPASS_SAR_Result_ChannelRead

Returns: The result in microvolts.

Function Usage

General Description

API Reference

Functions

Function Documentation

◆ Cy_HPPASS_SAR_Init()

◆ Cy_HPPASS_SAR_IsBusy()

◆ Cy_HPPASS_SAR_Limit_Config()

◆ Cy_HPPASS_SAR_CrossTalkAdjust()

◆ Cy_HPPASS_SAR_GroupConfig()

◆ Cy_HPPASS_SAR_DisableGroupContConvert()

◆ Cy_HPPASS_SAR_GetTriggerCollisionStatus()

◆ Cy_HPPASS_SAR_ClearTriggerCollisionStatus()

◆ Cy_HPPASS_SAR_GetHoldViolationStatus()

◆ Cy_HPPASS_SAR_ClearHoldViolationStatus()

◆ Cy_HPPASS_SAR_SetHoldViolationCnt()

◆ Cy_HPPASS_SAR_GetHoldViolationCnt()

◆ Cy_HPPASS_SAR_SetTempSensorCurrent()

◆ Cy_HPPASS_TEMP_Calc()

◆ Cy_HPPASS_SAR_TempAdjust()

◆ Cy_HPPASS_SAR_Limit_GetInterruptStatus()

◆ Cy_HPPASS_SAR_Limit_ClearInterrupt()

◆ Cy_HPPASS_SAR_Limit_SetInterrupt()

◆ Cy_HPPASS_SAR_Limit_SetInterruptMask()

◆ Cy_HPPASS_SAR_Limit_GetInterruptMask()

◆ Cy_HPPASS_SAR_Limit_GetInterruptStatusMasked()

◆ Cy_HPPASS_SAR_Result_GetInterruptStatus()

◆ Cy_HPPASS_SAR_Result_ClearInterrupt()

◆ Cy_HPPASS_SAR_Result_SetInterrupt()

◆ Cy_HPPASS_SAR_Result_SetInterruptMask()

◆ Cy_HPPASS_SAR_Result_GetInterruptMask()

◆ Cy_HPPASS_SAR_Result_GetInterruptStatusMasked()

◆ Cy_HPPASS_SAR_SetSwitch()

◆ Cy_HPPASS_SAR_ClearSwitch()

◆ Cy_HPPASS_SAR_GetSwitchStatus()

◆ Cy_HPPASS_SAR_CountsTo_Volts()

◆ Cy_HPPASS_SAR_CountsTo_mVolts()

◆ Cy_HPPASS_SAR_CountsTo_uVolts()