S32 SDK
Comparator Driver

Detailed Description

Comparator Peripheral Driver.

Definitions

Data Structures

struct  cmp_comparator_t
 Defines the block configuration. More...
 
struct  cmp_anmux_t
 Defines the analog mux. More...
 
struct  cmp_dac_t
 Defines the DAC block. More...
 
struct  cmp_trigger_mode_t
 Defines the trigger mode. More...
 
struct  cmp_module_t
 Defines the comparator module configuration. More...
 

cMP DRV.

status_t CMP_DRV_Reset (const uint32_t instance)
 Reset all registers. More...
 
status_t CMP_DRV_GetInitConfigAll (cmp_module_t *config)
 Get reset configuration for all registers. More...
 
status_t CMP_DRV_Init (const uint32_t instance, const cmp_module_t *const config)
 Configure all comparator features with the given configuration structure. More...
 
status_t CMP_DRV_GetConfigAll (const uint32_t instance, cmp_module_t *const config)
 Gets the current comparator configuration. More...
 
status_t CMP_DRV_GetInitConfigDAC (cmp_dac_t *config)
 Get reset configuration for registers related with DAC. More...
 
status_t CMP_DRV_ConfigDAC (const uint32_t instance, const cmp_dac_t *config)
 Configure only the DAC component. More...
 
status_t CMP_DRV_GetDACConfig (const uint32_t instance, cmp_dac_t *const config)
 Return current configuration for DAC. More...
 
status_t CMP_DRV_GetInitConfigMUX (cmp_anmux_t *config)
 Get reset configuration for registers related with MUX. More...
 
status_t CMP_DRV_ConfigMUX (const uint32_t instance, const cmp_anmux_t *config)
 Configure only the MUX component. More...
 
status_t CMP_DRV_GetMUXConfig (const uint32_t instance, cmp_anmux_t *const config)
 Return configuration only for the MUX component. More...
 
status_t CMP_DRV_GetInitTriggerMode (cmp_trigger_mode_t *config)
 Get reset configuration for registers related with Trigger Mode. More...
 
status_t CMP_DRV_ConfigTriggerMode (const uint32_t instance, const cmp_trigger_mode_t *config)
 Configure trigger mode. More...
 
status_t CMP_DRV_GetTriggerModeConfig (const uint32_t instance, cmp_trigger_mode_t *const config)
 Get current trigger mode configuration. More...
 
status_t CMP_DRV_GetOutputFlags (const uint32_t instance, cmp_output_trigger_t *flags)
 Get comparator output flags. More...
 
status_t CMP_DRV_ClearOutputFlags (const uint32_t instance)
 Clear comparator output flags. More...
 
status_t CMP_DRV_GetInputFlags (const uint32_t instance, cmp_ch_list_t *flags)
 Gets input channels change flags. More...
 
status_t CMP_DRV_ClearInputFlags (const uint32_t instance)
 Clear comparator input channels flags. More...
 
status_t CMP_DRV_GetInitConfigComparator (cmp_comparator_t *config)
 Get reset configuration for registers related with comparator features. More...
 
status_t CMP_DRV_ConfigComparator (const uint32_t instance, const cmp_comparator_t *config)
 Configure only comparator features. More...
 
status_t CMP_DRV_GetComparatorConfig (const uint32_t instance, cmp_comparator_t *config)
 Return configuration for comparator from CMP module. More...
 

Function Documentation

status_t CMP_DRV_ClearInputFlags ( const uint32_t  instance)

Clear comparator input channels flags.

This function clear comparator input channels flags.

Parameters
instance- instance number
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 414 of file cmp_driver.c.

status_t CMP_DRV_ClearOutputFlags ( const uint32_t  instance)

Clear comparator output flags.

This function clear comparator output flags(rising and falling edge).

Parameters
instance- instance number
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 381 of file cmp_driver.c.

status_t CMP_DRV_ConfigComparator ( const uint32_t  instance,
const cmp_comparator_t config 
)

Configure only comparator features.

This function configure only features related with comparator: DMA request, power mode, output select, interrupts enable, invert, offset, hysteresis.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 455 of file cmp_driver.c.

status_t CMP_DRV_ConfigDAC ( const uint32_t  instance,
const cmp_dac_t config 
)

Configure only the DAC component.

This function configures the DAC with the options provided in the config structure.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 203 of file cmp_driver.c.

status_t CMP_DRV_ConfigMUX ( const uint32_t  instance,
const cmp_anmux_t config 
)

Configure only the MUX component.

This function configures the MUX with the options provided in the config structure.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 258 of file cmp_driver.c.

status_t CMP_DRV_ConfigTriggerMode ( const uint32_t  instance,
const cmp_trigger_mode_t config 
)

Configure trigger mode.

This function configures the trigger mode with the options provided in the config structure.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 319 of file cmp_driver.c.

status_t CMP_DRV_GetComparatorConfig ( const uint32_t  instance,
cmp_comparator_t config 
)

Return configuration for comparator from CMP module.

This function return configuration for features related with comparator: DMA request, power mode, output select, interrupts enable, invert, offset, hysteresis.

Parameters
instance- instance number
config- the configuration structure returned
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 481 of file cmp_driver.c.

status_t CMP_DRV_GetConfigAll ( const uint32_t  instance,
cmp_module_t *const  config 
)

Gets the current comparator configuration.

This function returns the current configuration for comparator as a configuration structure.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 145 of file cmp_driver.c.

status_t CMP_DRV_GetDACConfig ( const uint32_t  instance,
cmp_dac_t *const  config 
)

Return current configuration for DAC.

This function returns current configuration only for DAC.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 221 of file cmp_driver.c.

status_t CMP_DRV_GetInitConfigAll ( cmp_module_t config)

Get reset configuration for all registers.

This function returns a configuration structure with reset values for all registers from comparator module.

Parameters
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 64 of file cmp_driver.c.

status_t CMP_DRV_GetInitConfigComparator ( cmp_comparator_t config)

Get reset configuration for registers related with comparator features.

This function return a configuration structure with reset values for features associated with comparator (DMA request, power mode, output select, interrupts enable, invert, offset, hysteresis).

Parameters
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 430 of file cmp_driver.c.

status_t CMP_DRV_GetInitConfigDAC ( cmp_dac_t config)

Get reset configuration for registers related with DAC.

This function returns a configuration structure with reset values for features associated with DAC.

Parameters
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 187 of file cmp_driver.c.

status_t CMP_DRV_GetInitConfigMUX ( cmp_anmux_t config)

Get reset configuration for registers related with MUX.

This function returns a configuration structure with reset values for features associated with MUX.

Parameters
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 240 of file cmp_driver.c.

status_t CMP_DRV_GetInitTriggerMode ( cmp_trigger_mode_t config)

Get reset configuration for registers related with Trigger Mode.

This function returns a configuration structure with reset values for features associated with Trigger Mode.

Parameters
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 298 of file cmp_driver.c.

status_t CMP_DRV_GetInputFlags ( const uint32_t  instance,
cmp_ch_list_t flags 
)

Gets input channels change flags.

This function return in <flags> all input channels flags as uint8_t(1 bite for each channel flag).

Parameters
instance- instance number
flags- pointer to input flags
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 398 of file cmp_driver.c.

status_t CMP_DRV_GetMUXConfig ( const uint32_t  instance,
cmp_anmux_t *const  config 
)

Return configuration only for the MUX component.

This function returns current configuration to determine which signals go to comparator ports.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 278 of file cmp_driver.c.

status_t CMP_DRV_GetOutputFlags ( const uint32_t  instance,
cmp_output_trigger_t flags 
)

Get comparator output flags.

This function returns in <flags> comparator output flags(rising and falling edge).

Parameters
instance- instance number
-flags - pointer to output flags NO_EVENT RISING_EDGE FALLING_EDGE BOTH_EDGE
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 365 of file cmp_driver.c.

status_t CMP_DRV_GetTriggerModeConfig ( const uint32_t  instance,
cmp_trigger_mode_t *const  config 
)

Get current trigger mode configuration.

This function returns the current trigger mode configuration for trigger mode.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 342 of file cmp_driver.c.

status_t CMP_DRV_Init ( const uint32_t  instance,
const cmp_module_t *const  config 
)

Configure all comparator features with the given configuration structure.

This function configures the comparator module with the options provided in the config structure.

Parameters
instance- instance number
config- the configuration structure
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 102 of file cmp_driver.c.

status_t CMP_DRV_Reset ( const uint32_t  instance)

Reset all registers.

This function set all CMP registers to reset values.

Parameters
instance- instance number
Returns
  • STATUS_SUCCESS : Completed successfully.
  • STATUS_ERROR : Error occurred.

Definition at line 48 of file cmp_driver.c.