MTB CAT1 Peripheral driver library

General Description

Functions

__STATIC_INLINE void Cy_TCPWM_MOTIF_Enable (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Enables the MOTIF module. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_Disable (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Disables the MOTIF Module. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_Start (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Modulation output from motif is started with existing values. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_Stop (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Modulation output from motif retains the existing values and MOTIF functionality Stops. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_DeInit (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 De initializes MOTIF block. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_Suspend (TCPWM_MOTIF_GRP_MOTIF_Type *base, cy_en_motif_suspend_config_t suspend_config)
 Configures the entering in suspend for the MOTIF module. More...
 
__STATIC_INLINE uint32_t Cy_TCPWM_MOTIF_GetInterruptStatus (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Reports the status of the interrupts. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_ClearInterrupt (TCPWM_MOTIF_GRP_MOTIF_Type *base, uint32_t mask)
 Clears the triggered interrupts. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_SetInterrupt (TCPWM_MOTIF_GRP_MOTIF_Type *base, uint32_t mask)
 Software option to set the required interrupts. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_SetInterruptMask (TCPWM_MOTIF_GRP_MOTIF_Type *base, uint32_t mask)
 Sets one or more MOTIF module interrupt factor bits (sets the INTR_MASK register). More...
 
__STATIC_INLINE uint32_t Cy_TCPWM_MOTIF_GetInterruptMask (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Reports the interrupt mask set. More...
 
__STATIC_INLINE uint8_t Cy_TCPWM_MOTIF_Get_LUT_Status (TCPWM_MOTIF_GRP_MOTIF_Type *base)
 Returns a value that points to the corresponding input Hall LUT values set. More...
 
__STATIC_INLINE void Cy_TCPWM_MOTIF_Set_LUT_Mode (TCPWM_MOTIF_GRP_MOTIF_Type *base, bool lut_enable)
 Enables/disables LUT mode. More...
 
uint16_t Cy_TCPWM_MOTIF_Get_Lowpass_Filter_Status (TCPWM_MOTIF_GRP_MOTIF_Type *base, cy_en_low_pass_filter_number_t lowpass_filter)
 Returns the status of the low pass filter. More...
 

Function Documentation

◆ Cy_TCPWM_MOTIF_Enable()

__STATIC_INLINE void Cy_TCPWM_MOTIF_Enable ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Enables the MOTIF module.

Modulation output from motif is started with it's default values

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.

◆ Cy_TCPWM_MOTIF_Disable()

__STATIC_INLINE void Cy_TCPWM_MOTIF_Disable ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Disables the MOTIF Module.

Modulation output from motif is reset to it's default value

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.

◆ Cy_TCPWM_MOTIF_Start()

__STATIC_INLINE void Cy_TCPWM_MOTIF_Start ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Modulation output from motif is started with existing values.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.

◆ Cy_TCPWM_MOTIF_Stop()

__STATIC_INLINE void Cy_TCPWM_MOTIF_Stop ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Modulation output from motif retains the existing values and MOTIF functionality Stops.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.

◆ Cy_TCPWM_MOTIF_DeInit()

__STATIC_INLINE void Cy_TCPWM_MOTIF_DeInit ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

De initializes MOTIF block.

param base The pointer to the TCPWM_MOTIF instance address.

◆ Cy_TCPWM_MOTIF_Suspend()

__STATIC_INLINE void Cy_TCPWM_MOTIF_Suspend ( TCPWM_MOTIF_GRP_MOTIF_Type *  base,
cy_en_motif_suspend_config_t  suspend_config 
)

Configures the entering in suspend for the MOTIF module.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
suspend_configcy_en_motif_suspend_config_t

◆ Cy_TCPWM_MOTIF_GetInterruptStatus()

__STATIC_INLINE uint32_t Cy_TCPWM_MOTIF_GetInterruptStatus ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Reports the status of the interrupts.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
Returns
returns the Status of the interrupts

◆ Cy_TCPWM_MOTIF_ClearInterrupt()

__STATIC_INLINE void Cy_TCPWM_MOTIF_ClearInterrupt ( TCPWM_MOTIF_GRP_MOTIF_Type *  base,
uint32_t  mask 
)

Clears the triggered interrupts.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
maskinterrupts to be cleared.

◆ Cy_TCPWM_MOTIF_SetInterrupt()

__STATIC_INLINE void Cy_TCPWM_MOTIF_SetInterrupt ( TCPWM_MOTIF_GRP_MOTIF_Type *  base,
uint32_t  mask 
)

Software option to set the required interrupts.

Interrupt handler will be called.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
maskinterrupts to be set.

◆ Cy_TCPWM_MOTIF_SetInterruptMask()

__STATIC_INLINE void Cy_TCPWM_MOTIF_SetInterruptMask ( TCPWM_MOTIF_GRP_MOTIF_Type *  base,
uint32_t  mask 
)

Sets one or more MOTIF module interrupt factor bits (sets the INTR_MASK register).

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
maskinterrupt Interrupt bit mask

◆ Cy_TCPWM_MOTIF_GetInterruptMask()

__STATIC_INLINE uint32_t Cy_TCPWM_MOTIF_GetInterruptMask ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Reports the interrupt mask set.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
Returns
returns the interrupt mask set

◆ Cy_TCPWM_MOTIF_Get_LUT_Status()

__STATIC_INLINE uint8_t Cy_TCPWM_MOTIF_Get_LUT_Status ( TCPWM_MOTIF_GRP_MOTIF_Type *  base)

Returns a value that points to the corresponding input Hall LUT values set.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
Returns
value that points to the corresponding input Hall LUT values set
Note
If LUT mode is not enabled this function returns always 0. In Lut mode the Valid values that this function return are 0,1,2,3,4,5. Each value points to the corresponding input Hall LUT values set. Invalid values are 6,7

◆ Cy_TCPWM_MOTIF_Set_LUT_Mode()

__STATIC_INLINE void Cy_TCPWM_MOTIF_Set_LUT_Mode ( TCPWM_MOTIF_GRP_MOTIF_Type *  base,
bool  lut_enable 
)

Enables/disables LUT mode.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
lut_enableLUT mode enable disable
Note
HALL Sensor works in LUT mode enabled and disabled. When LUT mode is enabled user provides look up table values and they will be compared with the actual output values. When motor changes direction, MOTIF is stopped and user need to populate the LUT again.
This function is used to enable disable LUT mode. Sam function for both HALL Sensor mode and Multi channel pattern mode

◆ Cy_TCPWM_MOTIF_Get_Lowpass_Filter_Status()

uint16_t Cy_TCPWM_MOTIF_Get_Lowpass_Filter_Status ( TCPWM_MOTIF_GRP_MOTIF_Type *  base,
cy_en_low_pass_filter_number_t  lowpass_filter 
)

Returns the status of the low pass filter.

Parameters
baseThe pointer to the TCPWM_MOTIF instance address.
lowpass_filterlow pass filter. cy_en_low_pass_filter_number_t
Returns
The status of the low pass filter