nrfx 3.3
Data Structures | Macros | Typedefs | Functions
TBM driver

Trace Buffer Monitor (TBM) driver. More...

Data Structures

struct  nrfx_tbm_config_t
 Structure for TBM configuration. More...
 

Macros

#define NRFX_TBM_DEFAULT_CONFIG
 tbm default configuration.
 

Typedefs

typedef void(* nrfx_tbm_event_handler_t) (nrf_tbm_event_t event)
 tbm driver data ready handler type.
 

Functions

nrfx_err_t nrfx_tbm_init (nrfx_tbm_config_t const *p_config, nrfx_tbm_event_handler_t handler)
 Function for initializing the TBM driver.
 
void nrfx_tbm_start (void)
 Function for starting the TBM.
 
void nrfx_tbm_stop (void)
 Function for stopping the TBM.
 
void nrfx_tbm_uninit (void)
 Function for uninitializing the TBM driver.
 
bool nrfx_tbm_init_check (void)
 Function for checking if the TBM driver is initialized.
 
uint32_t nrfx_tbm_count_get (void)
 Function for getting current counter value.
 

Detailed Description

Trace Buffer Monitor (TBM) driver.

Macro Definition Documentation

◆ NRFX_TBM_DEFAULT_CONFIG

#define NRFX_TBM_DEFAULT_CONFIG
Value:
{ \
.size = 128, \
.interrupt_priority = NRFX_TBM_DEFAULT_CONFIG_IRQ_PRIORITY, \
}

tbm default configuration.

Typedef Documentation

◆ nrfx_tbm_event_handler_t

typedef void(* nrfx_tbm_event_handler_t) (nrf_tbm_event_t event)

tbm driver data ready handler type.

Parameters
eventEvent.

Function Documentation

◆ nrfx_tbm_count_get()

uint32_t nrfx_tbm_count_get ( void  )

Function for getting current counter value.

Returns
Current counter value.

◆ nrfx_tbm_init()

nrfx_err_t nrfx_tbm_init ( nrfx_tbm_config_t const *  p_config,
nrfx_tbm_event_handler_t  handler 
)

Function for initializing the TBM driver.

Parameters
[in]p_configpointer to the structure with initial configuration.
[in]handlerdata handler provided by the user. if not provided, the driver is initialized in blocking mode.
Return values
NRFX_SUCCESSDriver was successfully initialized.
NRFX_ERROR_ALREADYDriver was already initialized.

◆ nrfx_tbm_init_check()

bool nrfx_tbm_init_check ( void  )

Function for checking if the TBM driver is initialized.

Return values
trueDriver is already initialized.
falseDriver is not initialized.

Documentation feedback | Developer Zone | Subscribe | Updated