npmx  1.0.0
 
Loading...
Searching...
No Matches
TIMER

TIMER peripheral driver. More...

Data Structures

struct  npmx_timer_t
 Data structure of the TIMER driver instance. More...
 
struct  npmx_timer_config_t
 Configuration structure for timer. More...
 
struct  npmx_timer_status_t
 Timer status structure. More...
 

Enumerations

enum  npmx_timer_task_t {
  NPMX_TIMER_TASK_ENABLE ,
  NPMX_TIMER_TASK_DISABLE ,
  NPMX_TIMER_TASK_STROBE ,
  NPMX_TIMER_TASK_KICK ,
  NPMX_TIMER_TASK_COUNT
}
 TIMER tasks. More...
 
enum  npmx_timer_mode_t {
  NPMX_TIMER_MODE_BOOT_MONITOR = TIMER_TIMERCONFIG_TIMERMODESEL_BOOTMONITOR ,
  NPMX_TIMER_MODE_WATCHDOG_WARNING = TIMER_TIMERCONFIG_TIMERMODESEL_WATCHDOGWARNING ,
  NPMX_TIMER_MODE_WATCHDOG_RESET = TIMER_TIMERCONFIG_TIMERMODESEL_WATCHDOGRESET ,
  NPMX_TIMER_MODE_GENERAL_PURPOSE = TIMER_TIMERCONFIG_TIMERMODESEL_GENPURPOSETIMER ,
  NPMX_TIMER_MODE_WAKEUP = TIMER_TIMERCONFIG_TIMERMODESEL_WAKEUPTIMER ,
  NPMX_TIMER_MODE_COUNT ,
  NPMX_TIMER_MODE_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Available modes of the timer. More...
 
enum  npmx_timer_prescaler_t {
  NPMX_TIMER_PRESCALER_SLOW = TIMER_TIMERCONFIG_TIMERPRESCALER_SLOW ,
  NPMX_TIMER_PRESCALER_FAST = TIMER_TIMERCONFIG_TIMERPRESCALER_FAST ,
  NPMX_TIMER_PRESCALER_COUNT ,
  NPMX_TIMER_PRESCALER_INVALID = NPMX_INVALID_ENUM_VALUE
}
 Switches between 64 Hz and 512 Hz timer clock . More...
 

Functions

npmx_timer_tnpmx_timer_get (npmx_instance_t *p_pmic, uint8_t idx)
 Function for returning TIMER instance based on index.
 
npmx_error_t npmx_timer_task_trigger (npmx_timer_t const *p_instance, npmx_timer_task_t task)
 Function for activating the specified TIMER task.
 
npmx_error_t npmx_timer_config_set (npmx_timer_t const *p_instance, npmx_timer_config_t const *p_config)
 Function for setting timer's configuration with mode, prescaler, and compare value.
 
npmx_error_t npmx_timer_config_get (npmx_timer_t const *p_instance, npmx_timer_config_t *p_config)
 Function for reading the ADC configuration.
 
npmx_error_t npmx_timer_status_get (npmx_timer_t const *p_instance, npmx_timer_status_t *p_status)
 Function for getting TIMER status.
 

Detailed Description

TIMER peripheral driver.

Enumeration Type Documentation

◆ npmx_timer_mode_t

Available modes of the timer.

Enumerator
NPMX_TIMER_MODE_BOOT_MONITOR 

Boot monitor.

NPMX_TIMER_MODE_WATCHDOG_WARNING 

Watchdog warning.

NPMX_TIMER_MODE_WATCHDOG_RESET 

Watchdog reset.

NPMX_TIMER_MODE_GENERAL_PURPOSE 

General purpose timer.

NPMX_TIMER_MODE_WAKEUP 

Wake-up timer.

NPMX_TIMER_MODE_COUNT 

Timer modes count.

NPMX_TIMER_MODE_INVALID 

Invalid timer mode.

◆ npmx_timer_prescaler_t

Switches between 64 Hz and 512 Hz timer clock .

Enumerator
NPMX_TIMER_PRESCALER_SLOW 

Timer clock set to 64 Hz.

NPMX_TIMER_PRESCALER_FAST 

Timer clock set to 512 Hz.

NPMX_TIMER_PRESCALER_COUNT 

Timer prescalers count.

NPMX_TIMER_PRESCALER_INVALID 

Invalid timer prescaler.

◆ npmx_timer_task_t

TIMER tasks.

Enumerator
NPMX_TIMER_TASK_ENABLE 

Start timer.

NPMX_TIMER_TASK_DISABLE 

Stop timer.

NPMX_TIMER_TASK_STROBE 

Load timer value from 24-bit timer's register.

NPMX_TIMER_TASK_KICK 

Kick watchdog.

NPMX_TIMER_TASK_COUNT 

Timer tasks count.

Function Documentation

◆ npmx_timer_config_get()

npmx_error_t npmx_timer_config_get ( npmx_timer_t const * p_instance,
npmx_timer_config_t * p_config )

Function for reading the ADC configuration.

Parameters
[in]p_instancePointer to the ADC instance.
[out]p_configPointer to the ADC configuration structure.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_timer_config_set()

npmx_error_t npmx_timer_config_set ( npmx_timer_t const * p_instance,
npmx_timer_config_t const * p_config )

Function for setting timer's configuration with mode, prescaler, and compare value.

Parameters
[in]p_instancePointer to the TIMER instance.
[in]p_configPointer to the configuration of the TIMER to apply.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_timer_get()

npmx_timer_t * npmx_timer_get ( npmx_instance_t * p_pmic,
uint8_t idx )

Function for returning TIMER instance based on index.

Parameters
[in]p_pmicPointer to the PMIC instance.
[in]idxIndex of the TIMER instance.
Returns
Pointer to the TIMER instance.

◆ npmx_timer_status_get()

npmx_error_t npmx_timer_status_get ( npmx_timer_t const * p_instance,
npmx_timer_status_t * p_status )

Function for getting TIMER status.

Parameters
[in]p_instancePointer to the TIMER instance.
[out]p_statusPointer to the structure to be filled with TIMER status.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.

◆ npmx_timer_task_trigger()

npmx_error_t npmx_timer_task_trigger ( npmx_timer_t const * p_instance,
npmx_timer_task_t task )

Function for activating the specified TIMER task.

Parameters
p_instancePointer to the TIMER instance.
taskTask to be activated.
Return values
NPMX_SUCCESSOperation performed successfully.
NPMX_ERROR_IOError using IO bus line.