TBM HAL

Hardware access layer for managing the Trace Buffer Monitor (TBM) peripheral. More...

Enumerations
enum	nrf_tbm_task_t {   NRF_TBM_TASK_START = offsetof(NRF_TBM_Type, TASKS_START) ,   NRF_TBM_TASK_STOP = offsetof(NRF_TBM_Type, TASKS_STOP) ,   NRF_TBM_TASK_FLUSH = offsetof(NRF_TBM_Type, TASKS_FLUSH) }
	TBM tasks. More...
enum	nrf_tbm_event_t {   NRF_TBM_EVENT_HALFFULL = offsetof(NRF_TBM_Type, EVENTS_HALFFULL) ,   NRF_TBM_EVENT_FULL = offsetof(NRF_TBM_Type, EVENTS_FULL) ,   NRF_TBM_EVENT_FLUSH = offsetof(NRF_TBM_Type, EVENTS_FLUSH) }
	TBM events. More...
enum	nrf_tbm_int_mask_t {   NRF_TBM_INT_HALFFULL_MASK = TBM_INTENSET_HALFFULL_Msk ,   NRF_TBM_INT_FULL_MASK = TBM_INTENSET_FULL_Msk ,   NRF_TBM_INT_FLUSH_MASK = TBM_INTENSET_FLUSH_Msk }
	TBM interrupts. More...

Functions
NRF_STATIC_INLINE void	nrf_tbm_task_trigger (NRF_TBM_Type *p_reg, nrf_tbm_task_t task)
	Function for activating the specified TBM task.
NRF_STATIC_INLINE void	nrf_tbm_event_clear (NRF_TBM_Type *p_reg, nrf_tbm_event_t event)
	Function for clearing the specified TBM event.
NRF_STATIC_INLINE bool	nrf_tbm_event_check (NRF_TBM_Type const *p_reg, nrf_tbm_event_t event)
	Function for retrieving the state of the TBM event.
NRF_STATIC_INLINE void	nrf_tbm_int_enable (NRF_TBM_Type *p_reg, uint32_t mask)
	Function for enabling the specified interrupts.
NRF_STATIC_INLINE void	nrf_tbm_int_set (NRF_TBM_Type *p_reg, uint32_t mask)
	Function for setting the configuration of interrupts.
NRF_STATIC_INLINE void	nrf_tbm_int_disable (NRF_TBM_Type *p_reg, uint32_t mask)
	Function for disabling the specified interrupts.
NRF_STATIC_INLINE uint32_t	nrf_tbm_int_enable_check (NRF_TBM_Type const *p_reg, uint32_t mask)
	Function for checking if the specified interrupts are enabled.
NRF_STATIC_INLINE uint32_t	nrf_tbm_int_pending_get (NRF_TBM_Type const *p_reg)
	Function for retrieving the state of pending interrupts.
NRF_STATIC_INLINE void	nrf_tbm_buffersize_set (NRF_TBM_Type *p_reg, uint32_t size)
	Function for setting the buffer size.
NRF_STATIC_INLINE uint32_t	nrf_tbm_count_get (NRF_TBM_Type *p_reg)
	Function for getting current count value.

Detailed Description

Hardware access layer for managing the Trace Buffer Monitor (TBM) peripheral.

Enumeration Type Documentation

nrf_tbm_event_t

enum nrf_tbm_event_t

TBM events.

Enumerator
NRF_TBM_EVENT_HALFFULL	Buffer half-full.
NRF_TBM_EVENT_FULL	Buffer full.
NRF_TBM_EVENT_FLUSH	Stopped due to flush.

nrf_tbm_int_mask_t

enum nrf_tbm_int_mask_t

TBM interrupts.

Enumerator
NRF_TBM_INT_HALFFULL_MASK	Interrupt on HALFFULL event.
NRF_TBM_INT_FULL_MASK	Interrupt on FULL event.
NRF_TBM_INT_FLUSH_MASK	Interrupt on FLUSH event.

nrf_tbm_task_t

enum nrf_tbm_task_t

TBM tasks.

Enumerator
NRF_TBM_TASK_START	Start counter.
NRF_TBM_TASK_STOP	Stop counter.
NRF_TBM_TASK_FLUSH	Stop counter, keep counter value.

Function Documentation

nrf_tbm_buffersize_set()

NRF_STATIC_INLINE void nrf_tbm_buffersize_set	(	NRF_TBM_Type *	p_reg,
		uint32_t	size
	)

Function for setting the buffer size.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	size	Size in 32 bit words.

nrf_tbm_count_get()

NRF_STATIC_INLINE uint32_t nrf_tbm_count_get

(

NRF_TBM_Type *

p_reg

)

Function for getting current count value.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

Current count value.

nrf_tbm_event_check()

NRF_STATIC_INLINE bool nrf_tbm_event_check	(	NRF_TBM_Type const *	p_reg,
		nrf_tbm_event_t	event
	)

Function for retrieving the state of the TBM event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be checked.

Return values

true	The event has been generated.
false	The event has not been generated.

nrf_tbm_event_clear()

NRF_STATIC_INLINE void nrf_tbm_event_clear	(	NRF_TBM_Type *	p_reg,
		nrf_tbm_event_t	event
	)

Function for clearing the specified TBM event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be cleared.

nrf_tbm_int_disable()

NRF_STATIC_INLINE void nrf_tbm_int_disable	(	NRF_TBM_Type *	p_reg,
		uint32_t	mask
	)

Function for disabling the specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be disabled. Use nrf_tbm_int_mask_t values for bit masking.

nrf_tbm_int_enable()

NRF_STATIC_INLINE void nrf_tbm_int_enable	(	NRF_TBM_Type *	p_reg,
		uint32_t	mask
	)

Function for enabling the specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be enabled. Use nrf_tbm_int_mask_t values for bit masking.

nrf_tbm_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_tbm_int_enable_check	(	NRF_TBM_Type const *	p_reg,
		uint32_t	mask
	)

Function for checking if the specified interrupts are enabled.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be checked. Use nrf_tbm_int_mask_t values for bit masking.

Returns

Mask of enabled interrupts.

nrf_tbm_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_tbm_int_pending_get

(

NRF_TBM_Type const *

p_reg

)

Function for retrieving the state of pending interrupts.

Note

States of pending interrupt are saved as a bitmask. One set at particular position means that interrupt for event is pending.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

Bitmask with information about pending interrupts. Use nrf_tbm_int_mask_t values for bit masking.

nrf_tbm_int_set()

NRF_STATIC_INLINE void nrf_tbm_int_set	(	NRF_TBM_Type *	p_reg,
		uint32_t	mask
	)

Function for setting the configuration of interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be set. Use nrf_tbm_int_mask_t values for bit masking.

nrf_tbm_task_trigger()

NRF_STATIC_INLINE void nrf_tbm_task_trigger	(	NRF_TBM_Type *	p_reg,
		nrf_tbm_task_t	task
	)

Function for activating the specified TBM task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task to be activated.