Runtime operations functions

General Description

Functions
__STATIC_INLINE uint32_t	Cy_HPPASS_GetInterruptStatus (void)
	Returns the interrupt register status. More...
__STATIC_INLINE void	Cy_HPPASS_ClearInterrupt (uint32_t interrupt)
	Clears the interrupt for High Performance Programmable Analog Sub-System. More...
__STATIC_INLINE void	Cy_HPPASS_SetInterrupt (uint32_t interrupt)
	Sets a software interrupt request for the High Performance Programmable Analog Sub-System. More...
__STATIC_INLINE void	Cy_HPPASS_SetInterruptMask (uint32_t interrupt)
	Configures which bits of the interrupt request register will trigger an interrupt event in the High Performance Programmable Analog Sub-System. More...
__STATIC_INLINE uint32_t	Cy_HPPASS_GetInterruptMask (void)
	Returns the interrupt mask. More...
__STATIC_INLINE uint32_t	Cy_HPPASS_GetInterruptStatusMasked (void)
	Returns the result of the bitwise AND operation between the corresponding interrupt request and mask bits. More...
__STATIC_INLINE void	Cy_HPPASS_SetFwTriggerPulse (uint8_t mask)
	Generates FW Pulse trigger if according configuration done in Cy_HPPASS_TriggerInConfig(). More...
__STATIC_INLINE void	Cy_HPPASS_SetFwTriggerLevel (uint8_t mask)
	Generates FW Level trigger if according configuration done in Cy_HPPASS_TriggerInConfig(). More...
cy_en_hppass_status_t	Cy_HPPASS_SetFwTrigger (uint8_t mask)
	Generates FW trigger, Pulse or Level, depends on configuration in Cy_HPPASS_TriggerInConfig(). More...
__STATIC_INLINE void	Cy_HPPASS_ClearFwTriggerLevel (uint8_t mask)
	Clears the firmware Level trigger. More...
cy_en_hppass_status_t	Cy_HPPASS_ClearFwTrigger (uint8_t mask)
	Clears the firmware trigger. More...
__STATIC_INLINE bool	Cy_HPPASS_IsVddaOk (void)
	Returns the VDDA voltage status. More...

Function Documentation

Cy_HPPASS_GetInterruptStatus()

__STATIC_INLINE uint32_t Cy_HPPASS_GetInterruptStatus

(

void

)

Returns the interrupt register status.

Returns

The status of combined interrupt requests Interrupt Masks.

Function Usage

void Cy_HPPASS_AcIsr()
{
    intStatusMsk = Cy_HPPASS_GetInterruptStatusMasked();

    Cy_HPPASS_ClearInterrupt(intStatusMsk);

    if (0UL != (CY_HPPASS_INTR_AC_INT & intStatusMsk))
    {
        acIntFlag = true;

        /* do something useful here */
    }
}

Cy_HPPASS_ClearInterrupt()

__STATIC_INLINE void Cy_HPPASS_ClearInterrupt

(

uint32_t

interrupt

)

Clears the interrupt for High Performance Programmable Analog Sub-System.

Parameters

interrupt

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

Function Usage

void Cy_HPPASS_AcIsr()
{
    intStatusMsk = Cy_HPPASS_GetInterruptStatusMasked();

    Cy_HPPASS_ClearInterrupt(intStatusMsk);

    if (0UL != (CY_HPPASS_INTR_AC_INT & intStatusMsk))
    {
        acIntFlag = true;

        /* do something useful here */
    }
}

Cy_HPPASS_SetInterrupt()

__STATIC_INLINE void Cy_HPPASS_SetInterrupt

(

uint32_t

interrupt

)

Sets a software interrupt request for the High Performance Programmable Analog Sub-System.

Parameters

interrupt

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

Function Usage

    /* Scenario: AC interrupt needs to be initiated be FW request */
    Cy_HPPASS_SetInterrupt(CY_HPPASS_INTR_AC_INT);

Cy_HPPASS_SetInterruptMask()

__STATIC_INLINE void Cy_HPPASS_SetInterruptMask

(

uint32_t

interrupt

)

Configures which bits of the interrupt request register will trigger an interrupt event in the High Performance Programmable Analog Sub-System.

Parameters

interrupt

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

Function Usage

    /* Scenario: The AC interrupt needs to be allowed */
    Cy_HPPASS_SetInterruptMask(CY_HPPASS_INTR_AC_INT);

Cy_HPPASS_GetInterruptMask()

__STATIC_INLINE uint32_t Cy_HPPASS_GetInterruptMask

(

void

)

Returns the interrupt mask.

Each bit of this mask allows triggering of the particular interrupt in the High Performance Programmable Analog Sub-System.

Returns

The mask of the interrupts allowable for activation Interrupt Masks.

Function Usage

    /* Scenario: Masked interrupts needs to be verified */
    uint32_t intMsk = Cy_HPPASS_GetInterruptMask();
    /* Verify intMsk */

Cy_HPPASS_GetInterruptStatusMasked()

__STATIC_INLINE uint32_t Cy_HPPASS_GetInterruptStatusMasked

(

void

)

Returns the result of the bitwise AND operation between the corresponding interrupt request and mask bits.

See Cy_HPPASS_GetInterruptStatus and Cy_HPPASS_SetInterruptMask.

Returns

The masked status of combined interrupt requests Interrupt Masks.

Function Usage

void Cy_HPPASS_AcIsr()
{
    intStatusMsk = Cy_HPPASS_GetInterruptStatusMasked();

    Cy_HPPASS_ClearInterrupt(intStatusMsk);

    if (0UL != (CY_HPPASS_INTR_AC_INT & intStatusMsk))
    {
        acIntFlag = true;

        /* do something useful here */
    }
}

Cy_HPPASS_SetFwTriggerPulse()

__STATIC_INLINE void Cy_HPPASS_SetFwTriggerPulse

(

uint8_t

mask

)

Generates FW Pulse trigger if according configuration done in Cy_HPPASS_TriggerInConfig().

Parameters

mask	Trigger mask. See Trigger Masks.

Cy_HPPASS_SetFwTriggerLevel()

__STATIC_INLINE void Cy_HPPASS_SetFwTriggerLevel

(

uint8_t

mask

)

Generates FW Level trigger if according configuration done in Cy_HPPASS_TriggerInConfig().

Parameters

mask	Trigger mask. See Trigger Masks.

Cy_HPPASS_SetFwTrigger()

cy_en_hppass_status_t Cy_HPPASS_SetFwTrigger

(

uint8_t

mask

)

Generates FW trigger, Pulse or Level, depends on configuration in Cy_HPPASS_TriggerInConfig().

Parameters

mask	Trigger mask. See Trigger Masks.

Returns

Status of operation, cy_en_hppass_status_t.

Function Usage

    /* Scenario: Trigger#0 needs to be initiated by FW request */
    if (CY_HPPASS_SUCCESS != Cy_HPPASS_SetFwTrigger(CY_HPPASS_TRIG_0_MSK))
    {
        /* Process the error */
        printf("Cy_HPPASS_SetFwTrigger returns error\r\n");
    }

Cy_HPPASS_ClearFwTriggerLevel()

__STATIC_INLINE void Cy_HPPASS_ClearFwTriggerLevel

(

uint8_t

mask

)

Clears the firmware Level trigger.

Parameters

mask	Trigger mask. See Trigger Masks.

Cy_HPPASS_ClearFwTrigger()

cy_en_hppass_status_t Cy_HPPASS_ClearFwTrigger

(

uint8_t

mask

)

Clears the firmware trigger.

Parameters

mask	Trigger mask. See Trigger Masks.

Returns

Status of operation, cy_en_hppass_status_t.

Function Usage

    /* Scenario: FW Trigger#0 needs to be cleared */
    status = Cy_HPPASS_ClearFwTrigger(CY_HPPASS_TRIG_0_MSK);
    /* Process returned status */

Cy_HPPASS_IsVddaOk()

__STATIC_INLINE bool Cy_HPPASS_IsVddaOk

(

void

)

Returns the VDDA voltage status.

Returns

VDDA status: true - VDDA is at or above minimum threshold, false - VDDA is below minimum threshold.

Function Usage

    /* Scenario: VDDA voltage needs to be checked */
    if (!Cy_HPPASS_IsVddaOk())
    {
        /* Process low VDDA case */
    }