Hardware access layer for managing the BELLBOARD peripheral. More...

Macros
#define	NRF_BELLBOARD_EVENTS_TRIGGERED_COUNT BELLBOARD_EVENTS_TRIGGERED_MaxCount
	Symbol specifying maximum number of available events triggered.

Enumerations
enum	nrf_bellboard_event_t { NRF_BELLBOARD_EVENT_TRIGGERED_0 = offsetof(NRF_BELLBOARD_Type, EVENTS_TRIGGERED[0]) , NRF_BELLBOARD_EVENT_TRIGGERED_1 = offsetof(NRF_BELLBOARD_Type, EVENTS_TRIGGERED[1]) , NRF_BELLBOARD_EVENT_TRIGGERED_2 = offsetof(NRF_BELLBOARD_Type, EVENTS_TRIGGERED[2]) , NRF_BELLBOARD_EVENT_TRIGGERED_3 = offsetof(NRF_BELLBOARD_Type, EVENTS_TRIGGERED[3]) }
	BELLBOARD events. More...

enum	nrf_bellboard_int_mask_t { NRF_BELLBOARD_INT_TRIGGERED_0_MASK = BELLBOARD_INTENSET0_TRIGGERED0_Msk , NRF_BELLBOARD_INT_TRIGGERED_1_MASK = BELLBOARD_INTENSET0_TRIGGERED1_Msk , NRF_BELLBOARD_INT_TRIGGERED_2_MASK = BELLBOARD_INTENSET0_TRIGGERED2_Msk , NRF_BELLBOARD_INT_TRIGGERED_3_MASK = BELLBOARD_INTENSET0_TRIGGERED3_Msk }
	BELLBOARD interrupts. More...

enum	nrf_bellboard_task_t { NRF_BELLBOARD_TASK_TRIGGER_0 = offsetof(NRF_BELLBOARD_Type, TASKS_TRIGGER[0]) , NRF_BELLBOARD_TASK_TRIGGER_1 = offsetof(NRF_BELLBOARD_Type, TASKS_TRIGGER[1]) , NRF_BELLBOARD_TASK_TRIGGER_2 = offsetof(NRF_BELLBOARD_Type, TASKS_TRIGGER[2]) , NRF_BELLBOARD_TASK_TRIGGER_3 = offsetof(NRF_BELLBOARD_Type, TASKS_TRIGGER[3]) , NRF_BELLBOARD_TASK_TRIGGER_4 = offsetof(NRF_BELLBOARD_Type, TASKS_TRIGGER[4]) }
	BELLBOARD tasks. More...

Functions
NRF_STATIC_INLINE void	nrf_bellboard_task_trigger (NRF_BELLBOARD_Type *p_reg, nrf_bellboard_task_t task)
	Function for triggering the specified BELLBOARD task.

NRF_STATIC_INLINE uint32_t	nrf_bellboard_task_address_get (NRF_BELLBOARD_Type const *p_reg, nrf_bellboard_task_t task)
	Function for getting the address of the specified BELLBOARD task register.

NRF_STATIC_INLINE nrf_bellboard_event_t	nrf_bellboard_triggered_event_get (uint8_t index)
	Function for getting the specified BELLBOARD TRIGGERED event.

NRF_STATIC_INLINE nrf_bellboard_task_t	nrf_bellboard_trigger_task_get (uint8_t index)
	Function for getting the specified BELLBOARD TRIGGER task.

NRF_STATIC_INLINE void	nrf_bellboard_event_clear (NRF_BELLBOARD_Type *p_reg, nrf_bellboard_event_t event)
	Function for clearing the specified BELLBOARD event.

NRF_STATIC_INLINE bool	nrf_bellboard_event_check (NRF_BELLBOARD_Type const *p_reg, nrf_bellboard_event_t event)
	Function for retrieving the state of the BELLBOARD event.

NRF_STATIC_INLINE uint32_t	nrf_bellboard_event_address_get (NRF_BELLBOARD_Type const *p_reg, nrf_bellboard_event_t event)
	Function for getting the address of the specified BELLBOARD event register.

NRF_STATIC_INLINE void	nrf_bellboard_int_enable (NRF_BELLBOARD_Type *p_reg, uint8_t group_idx, uint32_t mask)
	Function for enabling specified interrupts.

NRF_STATIC_INLINE void	nrf_bellboard_int_disable (NRF_BELLBOARD_Type *p_reg, uint8_t group_idx, uint32_t mask)
	Function for disabling specified interrupts.

NRF_STATIC_INLINE uint32_t	nrf_bellboard_int_enable_check (NRF_BELLBOARD_Type const *p_reg, uint8_t group_idx, uint32_t mask)
	Function for checking if the specified interrupts are enabled.

NRF_STATIC_INLINE uint32_t	nrf_bellboard_int_pending_get (NRF_BELLBOARD_Type const *p_reg, uint8_t group_idx)
	Function for retrieving the state of pending interrupts.

Detailed Description

Hardware access layer for managing the BELLBOARD peripheral.

Enumeration Type Documentation

◆ nrf_bellboard_event_t

enum nrf_bellboard_event_t

BELLBOARD events.

Enumerator
NRF_BELLBOARD_EVENT_TRIGGERED_0	Triggered 0 event.
NRF_BELLBOARD_EVENT_TRIGGERED_1	Triggered 1 event.
NRF_BELLBOARD_EVENT_TRIGGERED_2	Triggered 2 event.
NRF_BELLBOARD_EVENT_TRIGGERED_3	Triggered 3 event.

◆ nrf_bellboard_int_mask_t

enum nrf_bellboard_int_mask_t

BELLBOARD interrupts.

Enumerator
NRF_BELLBOARD_INT_TRIGGERED_0_MASK	Triggered 0 interrupt mask.
NRF_BELLBOARD_INT_TRIGGERED_1_MASK	Triggered 1 interrupt mask.
NRF_BELLBOARD_INT_TRIGGERED_2_MASK	Triggered 2 interrupt mask.
NRF_BELLBOARD_INT_TRIGGERED_3_MASK	Triggered 3 interrupt mask.

◆ nrf_bellboard_task_t

enum nrf_bellboard_task_t

BELLBOARD tasks.

Enumerator
NRF_BELLBOARD_TASK_TRIGGER_0	Trigger 0 task.
NRF_BELLBOARD_TASK_TRIGGER_1	Trigger 1 task.
NRF_BELLBOARD_TASK_TRIGGER_2	Trigger 2 task.
NRF_BELLBOARD_TASK_TRIGGER_3	Trigger 3 task.
NRF_BELLBOARD_TASK_TRIGGER_4	Trigger 4 task.

Function Documentation

◆ nrf_bellboard_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_bellboard_event_address_get	(	NRF_BELLBOARD_Type const *	p_reg,
		nrf_bellboard_event_t	event )

Function for getting the address of the specified BELLBOARD event register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Specified event.

Returns: Address of the specified event register.

◆ nrf_bellboard_event_check()

NRF_STATIC_INLINE bool nrf_bellboard_event_check	(	NRF_BELLBOARD_Type const *	p_reg,
		nrf_bellboard_event_t	event )

Function for retrieving the state of the BELLBOARD 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_bellboard_event_clear()

NRF_STATIC_INLINE void nrf_bellboard_event_clear	(	NRF_BELLBOARD_Type *	p_reg,
		nrf_bellboard_event_t	event )

Function for clearing the specified BELLBOARD event.

Parameters

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

◆ nrf_bellboard_int_disable()

NRF_STATIC_INLINE void nrf_bellboard_int_disable	(	NRF_BELLBOARD_Type *	p_reg,
		uint8_t	group_idx,
		uint32_t	mask )

Function for disabling specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	group_idx	Index of interrupt group to be disabled.
[in]	mask	Mask of interrupts to be disabled. Use nrf_bellboard_int_mask_t values for bit masking.

◆ nrf_bellboard_int_enable()

NRF_STATIC_INLINE void nrf_bellboard_int_enable	(	NRF_BELLBOARD_Type *	p_reg,
		uint8_t	group_idx,
		uint32_t	mask )

Function for enabling specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	group_idx	Index of interrupt group to be enabled.
[in]	mask	Mask of interrupts to be enabled. Use nrf_bellboard_int_mask_t values for bit masking.

◆ nrf_bellboard_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_bellboard_int_enable_check	(	NRF_BELLBOARD_Type const *	p_reg,
		uint8_t	group_idx,
		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]	group_idx	Index of interrupt group to be checked.
[in]	mask	Mask of interrupts to be checked. Use nrf_bellboard_int_mask_t values for bit masking.

Returns: Mask of enabled interrupts.

◆ nrf_bellboard_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_bellboard_int_pending_get	(	NRF_BELLBOARD_Type const *	p_reg,
		uint8_t	group_idx )

Function for retrieving the state of pending interrupts.

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.
[in]	group_idx	Index of interrupt group to be retrieved.

Returns: Bitmask with information about pending interrupts. Use nrf_bellboard_int_mask_t values for bit masking.

◆ nrf_bellboard_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_bellboard_task_address_get	(	NRF_BELLBOARD_Type const *	p_reg,
		nrf_bellboard_task_t	task )

Function for getting the address of the specified BELLBOARD task register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Specified task.

Returns: Address of the specified task register.

◆ nrf_bellboard_task_trigger()

NRF_STATIC_INLINE void nrf_bellboard_task_trigger	(	NRF_BELLBOARD_Type *	p_reg,
		nrf_bellboard_task_t	task )

Function for triggering the specified BELLBOARD task.

Parameters

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

◆ nrf_bellboard_trigger_task_get()

NRF_STATIC_INLINE nrf_bellboard_task_t nrf_bellboard_trigger_task_get ( uint8_t index )

Function for getting the specified BELLBOARD TRIGGER task.

Parameters

[in] index Task index.

Returns: The specified BELLBOARD TRIGGER task.

◆ nrf_bellboard_triggered_event_get()

NRF_STATIC_INLINE nrf_bellboard_event_t nrf_bellboard_triggered_event_get ( uint8_t index )

Function for getting the specified BELLBOARD TRIGGERED event.

Parameters

[in] index Event index.

Returns: The specified BELLBOARD TRIGGERED event.

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ nrf_bellboard_event_t

◆ nrf_bellboard_int_mask_t

◆ nrf_bellboard_task_t

Function Documentation

◆ nrf_bellboard_event_address_get()

◆ nrf_bellboard_event_check()

◆ nrf_bellboard_event_clear()

◆ nrf_bellboard_int_disable()

◆ nrf_bellboard_int_enable()

◆ nrf_bellboard_int_enable_check()

◆ nrf_bellboard_int_pending_get()

◆ nrf_bellboard_task_address_get()

◆ nrf_bellboard_task_trigger()

◆ nrf_bellboard_trigger_task_get()

◆ nrf_bellboard_triggered_event_get()