Modules
	Low Power Callback
	The driver supports SysPm callback for Deep Sleep transition.

Functions
cy_en_lpcomp_status_t	Cy_LPComp_Init (LPCOMP_Type base, cy_en_lpcomp_channel_t channel, const cy_stc_lpcomp_config_t config, cy_stc_lpcomp_context_t *context)
	Initializes the low-power comparator. More...

void	Cy_LPComp_Enable (LPCOMP_Type base, cy_en_lpcomp_channel_t channel, cy_stc_lpcomp_context_t context)
	Enables the low-power comparator and sets the interrupt mode. More...

void	Cy_LPComp_Disable (LPCOMP_Type base, cy_en_lpcomp_channel_t channel, cy_stc_lpcomp_context_t context)
	Disables the low-power comparator and sets the interrupt mode to disabled. More...

__STATIC_INLINE uint32_t	Cy_LPComp_GetCompare (LPCOMP_Type const *base, cy_en_lpcomp_channel_t channel)
	Returns a non-zero value when the voltage connected to the positive input is greater than the negative input voltage. More...

void	Cy_LPComp_SetPower (LPCOMP_Type *base, cy_en_lpcomp_channel_t channel, cy_en_lpcomp_pwr_t power)
	Sets Drive power mode and speed configuration. More...

void	Cy_LPComp_SetHysteresis (LPCOMP_Type *base, cy_en_lpcomp_channel_t channel, cy_en_lpcomp_hyst_t hysteresis)
	Configures the 10 mV hysteresis level. More...

void	Cy_LPComp_SetOutputMode (LPCOMP_Type *base, cy_en_lpcomp_channel_t channel, cy_en_lpcomp_out_t outType)
	Sets the comparator Output mode. More...

void	Cy_LPComp_SetInterruptTriggerMode (LPCOMP_Type base, cy_en_lpcomp_channel_t channel, cy_en_lpcomp_int_t intType, cy_stc_lpcomp_context_t context)
	Sets the interrupt Edge-detect mode. More...

uint32_t	Cy_LPComp_ZeroCal (LPCOMP_Type const *base, cy_en_lpcomp_channel_t channel)
	Performs custom calibration of the input offset to minimize the error for a specific set of conditions: the comparator reference voltage, supply voltage, and operating temperature. More...

void	Cy_LPComp_LoadTrim (LPCOMP_Type const *base, cy_en_lpcomp_channel_t channel, uint32_t trimVal)
	Writes a value into the comparator offset trim register. More...

__STATIC_INLINE uint32_t	Cy_LPComp_GetInterruptStatus (LPCOMP_Type const *base)
	Returns the status of 2 different LPCOMP interrupt requests. More...

__STATIC_INLINE void	Cy_LPComp_ClearInterrupt (LPCOMP_Type *base, uint32_t interrupt)
	Clears LPCOMP interrupts by setting each bit. More...

__STATIC_INLINE void	Cy_LPComp_SetInterrupt (LPCOMP_Type *base, uint32_t interrupt)
	Sets a software interrupt request. More...

__STATIC_INLINE uint32_t	Cy_LPComp_GetInterruptMask (LPCOMP_Type const *base)
	Returns an interrupt mask. More...

__STATIC_INLINE void	Cy_LPComp_SetInterruptMask (LPCOMP_Type *base, uint32_t interrupt)
	Configures which bits of the interrupt request register trigger an interrupt event. More...

__STATIC_INLINE uint32_t	Cy_LPComp_GetInterruptStatusMasked (LPCOMP_Type const *base)
	Returns an interrupt request register masked by an interrupt mask. More...

Detailed Description

Function Documentation

◆ Cy_LPComp_Init()

cy_en_lpcomp_status_t Cy_LPComp_Init	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		const cy_stc_lpcomp_config_t *	config,
		cy_stc_lpcomp_context_t *	context
	)

Initializes the low-power comparator.

Note: The interrupt mode configuration is not written to the register during the execution of the function. This can result in unexpected interrupts when the comparator is enabled. Instead the configuration is saved to the context and applied in the Cy_LPComp_Enable() function.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
*config	The pointer to the configuration structure.
*context	The pointer to the context structure cy_stc_lpcomp_context_t allocated by the user. The structure is used during the low-power comparator operation for internal configuration and data retention. The user must not modify anything in this structure.

Returns: cy_en_lpcomp_status_t

◆ Cy_LPComp_Enable()

void Cy_LPComp_Enable	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		cy_stc_lpcomp_context_t *	context
	)

Enables the low-power comparator and sets the interrupt mode.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
*context	The pointer to the context structure cy_stc_lpcomp_context_t allocated by the user. The structure is used during the low-power comparator operation for internal configuration and data retention. The user must not modify anything in this structure.

◆ Cy_LPComp_Disable()

void Cy_LPComp_Disable	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		cy_stc_lpcomp_context_t *	context
	)

Disables the low-power comparator and sets the interrupt mode to disabled.

Note: The interrupt is disabled by this function because when the comparator is disabled its output stops working and the interrupt triggers. The actual configuration is restored from the context in: Cy_LPComp_Enable().

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
*context	The pointer to the context structure cy_stc_lpcomp_context_t allocated by the user. The structure is used during the low-power comparator operation for internal configuration and data retention. The user must not modify anything in this structure.

◆ Cy_LPComp_GetCompare()

__STATIC_INLINE uint32_t Cy_LPComp_GetCompare	(	LPCOMP_Type const *	base,
		cy_en_lpcomp_channel_t	channel
	)

Returns a non-zero value when the voltage connected to the positive input is greater than the negative input voltage.

Parameters

*base	The LPComp register structure-pointer.
channel	The LPComp channel index.

Returns: LPComp compare result. The value is a non-zero value when the voltage connected to the positive input is greater than the negative input voltage.

◆ Cy_LPComp_SetPower()

void Cy_LPComp_SetPower	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		cy_en_lpcomp_pwr_t	power
	)

Sets Drive power mode and speed configuration.

The power consumption and response time vary depending on the selected power mode; power consumption is the highest in Fast mode and the lowest in Ultra-low-power mode, response time is fastest in fast mode and slowest in ultra-low-power mode. Refer to the device datasheet for specifications for the response time and power consumption for various power settings.

Note: The output of the comparator may stop working when Power mode is changed while the comparator is enabled. To avoid this, disable the comparator before changing Power mode.

Parameters

*base	The low-power comparator registers structure pointer.
channel	The low-power comparator channel number.
power	cy_en_lpcomp_pwr_t

◆ Cy_LPComp_SetHysteresis()

void Cy_LPComp_SetHysteresis	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		cy_en_lpcomp_hyst_t	hysteresis
	)

Configures the 10 mV hysteresis level.

Enabling the hysteresis helps ensure that slowly moving voltages or slightly noisy voltages will not cause the output of the comparator to oscillate when the two input voltages are nearly equal.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
hysteresis	cy_en_lpcomp_hyst_t

◆ Cy_LPComp_SetOutputMode()

void Cy_LPComp_SetOutputMode	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		cy_en_lpcomp_out_t	outType
	)

Sets the comparator Output mode.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
outType	Comparator output mode cy_en_lpcomp_out_t

◆ Cy_LPComp_SetInterruptTriggerMode()

void Cy_LPComp_SetInterruptTriggerMode	(	LPCOMP_Type *	base,
		cy_en_lpcomp_channel_t	channel,
		cy_en_lpcomp_int_t	intType,
		cy_stc_lpcomp_context_t *	context
	)

Sets the interrupt Edge-detect mode.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
intType	Interrupt edge trigger selection cy_en_lpcomp_int_t
*context	The pointer to the context structure cy_stc_lpcomp_context_t allocated by the user. The structure is used during the low-power comparator operation for internal configuration and data retention. The user must not modify anything in this structure.

◆ Cy_LPComp_ZeroCal()

uint32_t Cy_LPComp_ZeroCal	(	LPCOMP_Type const *	base,
		cy_en_lpcomp_channel_t	channel
	)

Performs custom calibration of the input offset to minimize the error for a specific set of conditions: the comparator reference voltage, supply voltage, and operating temperature.

Refer to technical reference manual (TRM) and the device datasheet for more details.

Note: The comparator offset is trimmed at the factory. For normal operation, further adjustment of trim values is not recommended.; A reference voltage in the range at which the comparator will be used, must be applied to one of the inputs. The two inputs will be shorted internally to perform the offset calibration.; Before calibration the comparator should be in the slow mode with the hysteresis be turned off.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.

Returns: The value from the comparator trim register after the offset calibration is complete. This value has the same format as the input parameter for the Cy_LPComp_LoadTrim() API routine.

Function Usage: cy_stc_lpcomp_context_t lpcomp_context;
uint32_t trim;
Cy_LPComp_Init(LPCOMP, CY_LPCOMP_CHANNEL_0, &lpcomp_cfg, &lpcomp_context);
Cy_LPComp_SetPower(LPCOMP, CY_LPCOMP_CHANNEL_0, CY_LPCOMP_MODE_SLOW);
Cy_LPComp_SetHysteresis(LPCOMP, CY_LPCOMP_CHANNEL_0, CY_LPCOMP_HYST_DISABLE);
Cy_LPComp_Enable(LPCOMP, CY_LPCOMP_CHANNEL_0, &lpcomp_context);
trim = Cy_LPComp_ZeroCal(LPCOMP, CY_LPCOMP_CHANNEL_0);
Cy_LPComp_LoadTrim(LPCOMP, CY_LPCOMP_CHANNEL_0, trim);

◆ Cy_LPComp_LoadTrim()

void Cy_LPComp_LoadTrim	(	LPCOMP_Type const *	base,
		cy_en_lpcomp_channel_t	channel,
		uint32_t	trimVal
	)

Writes a value into the comparator offset trim register.

See Cy_LPComp_ZeroCal() description for the procedure of getting trim.

Parameters

*base	The low-power comparator registers structure-pointer.
channel	The low-power comparator channel number.
trimVal	The value to store into the comparator offset trim-register. This value has the same format as the parameter returned by the Cy_LPComp_ZeroCal() API routine.

◆ Cy_LPComp_GetInterruptStatus()

__STATIC_INLINE uint32_t Cy_LPComp_GetInterruptStatus ( LPCOMP_Type const * base )

Returns the status of 2 different LPCOMP interrupt requests.

Parameters

*base The LPCOMP register structure-pointer.

Returns: Interrupt mask: CY_LPCOMP_CHANNEL0_INTR and CY_LPCOMP_CHANNEL1_INTR.

◆ Cy_LPComp_ClearInterrupt()

__STATIC_INLINE void Cy_LPComp_ClearInterrupt	(	LPCOMP_Type *	base,
		uint32_t	interrupt
	)

Clears LPCOMP interrupts by setting each bit.

Parameters

*base	The LPCOMP register structure-pointer.
interrupt	status: CY_LPCOMP_CHANNEL0_INTR and CY_LPCOMP_CHANNEL1_INTR.

◆ Cy_LPComp_SetInterrupt()

__STATIC_INLINE void Cy_LPComp_SetInterrupt	(	LPCOMP_Type *	base,
		uint32_t	interrupt
	)

Sets a software interrupt request.

Used for a combined interrupt signal from the global signal reference. Also, can be used from either component instance to trigger either or both software interrupts. It sets the INTR_SET interrupt mask.

Parameters

*base	The LPCOMP register structure-pointer.
interrupt	Interrupt status: CY_LPCOMP_CHANNEL0_INTR and CY_LPCOMP_CHANNEL1_INTR.

◆ Cy_LPComp_GetInterruptMask()

__STATIC_INLINE uint32_t Cy_LPComp_GetInterruptMask ( LPCOMP_Type const * base )

Returns an interrupt mask.

Parameters

*base The LPCOMP register structure-pointer.

Returns: Interrupt mask: CY_LPCOMP_CHANNEL0_INTR and CY_LPCOMP_CHANNEL1_INTR.

◆ Cy_LPComp_SetInterruptMask()

__STATIC_INLINE void Cy_LPComp_SetInterruptMask	(	LPCOMP_Type *	base,
		uint32_t	interrupt
	)

Configures which bits of the interrupt request register trigger an interrupt event.

Parameters

*base	The LPCOMP register structure-pointer.
interrupt	Interrupt mask: CY_LPCOMP_CHANNEL0_INTR and CY_LPCOMP_CHANNEL1_INTR.

◆ Cy_LPComp_GetInterruptStatusMasked()

__STATIC_INLINE uint32_t Cy_LPComp_GetInterruptStatusMasked ( LPCOMP_Type const * base )

Returns an interrupt request register masked by an interrupt mask.

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

Parameters

*base The LPCOMP register structure-pointer.

Returns: Interrupt mask: CY_LPCOMP_CHANNEL0_INTR and CY_LPCOMP_CHANNEL1_INTR.

Modules

Functions

Detailed Description

Function Documentation

◆ Cy_LPComp_Init()

◆ Cy_LPComp_Enable()

◆ Cy_LPComp_Disable()

◆ Cy_LPComp_GetCompare()

◆ Cy_LPComp_SetPower()

◆ Cy_LPComp_SetHysteresis()

◆ Cy_LPComp_SetOutputMode()

◆ Cy_LPComp_SetInterruptTriggerMode()

◆ Cy_LPComp_ZeroCal()

◆ Cy_LPComp_LoadTrim()

◆ Cy_LPComp_GetInterruptStatus()

◆ Cy_LPComp_ClearInterrupt()

◆ Cy_LPComp_SetInterrupt()

◆ Cy_LPComp_GetInterruptMask()

◆ Cy_LPComp_SetInterruptMask()

◆ Cy_LPComp_GetInterruptStatusMasked()