S32 SDK
FTM Quadrature Decoder Driver

Detailed Description

FlexTimer Peripheral Driver.

Data Structures

struct  ftm_phase_params_t
 FlexTimer quadrature decoder channel parameters. More...
 
struct  ftm_quad_decode_config_t
 FTM quadrature configure structure. More...
 
struct  ftm_quad_decoder_state_t
 FTM quadrature state(counter value and flags) More...
 

Functions

status_t FTM_DRV_QuadDecodeStart (uint32_t instance, const ftm_quad_decode_config_t *config)
 Configures the quadrature mode and starts measurement. More...
 
status_t FTM_DRV_QuadDecodeStop (uint32_t instance)
 De-activates the quadrature decode mode. More...
 
ftm_quad_decoder_state_t FTM_DRV_QuadGetState (uint32_t instance)
 Return the current quadrature decoder state (counter value, overflow flag and overflow direction) More...
 

Function Documentation

status_t FTM_DRV_QuadDecodeStart ( uint32_t  instance,
const ftm_quad_decode_config_t config 
)

Configures the quadrature mode and starts measurement.

Parameters
[in]instanceInstance number of the FTM module.
[in]configConfiguration structure(quadrature decode mode, polarity for both phases, initial and maximum value for the counter, filter configuration).
Returns
success
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 50 of file ftm_qd_driver.c.

status_t FTM_DRV_QuadDecodeStop ( uint32_t  instance)

De-activates the quadrature decode mode.

Parameters
[in]instanceInstance number of the FTM module.
Returns
success
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 109 of file ftm_qd_driver.c.

ftm_quad_decoder_state_t FTM_DRV_QuadGetState ( uint32_t  instance)

Return the current quadrature decoder state (counter value, overflow flag and overflow direction)

Parameters
[in]instanceInstance number of the FTM module.
Returns
The current state of quadrature decoder

Definition at line 130 of file ftm_qd_driver.c.