Hardware access layer for managing the Event Generator Unit (EGU) peripheral. More...

Macros
#define	NRF_EGU_INST_GET(idx)
	Macro getting pointer to the structure of registers of the EGU peripheral.

Enumerations
enum	nrf_egu_task_t { NRF_EGU_TASK_TRIGGER0 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[0]) , NRF_EGU_TASK_TRIGGER1 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[1]) , NRF_EGU_TASK_TRIGGER2 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[2]) , NRF_EGU_TASK_TRIGGER3 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[3]) , NRF_EGU_TASK_TRIGGER4 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[4]) , NRF_EGU_TASK_TRIGGER5 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[5]) , NRF_EGU_TASK_TRIGGER6 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[6]) , NRF_EGU_TASK_TRIGGER7 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[7]) , NRF_EGU_TASK_TRIGGER8 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[8]) , NRF_EGU_TASK_TRIGGER9 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[9]) , NRF_EGU_TASK_TRIGGER10 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[10]) , NRF_EGU_TASK_TRIGGER11 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[11]) , NRF_EGU_TASK_TRIGGER12 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[12]) , NRF_EGU_TASK_TRIGGER13 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[13]) , NRF_EGU_TASK_TRIGGER14 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[14]) , NRF_EGU_TASK_TRIGGER15 = offsetof(NRF_EGU_Type, TASKS_TRIGGER[15]) }
	EGU tasks. More...

enum	nrf_egu_event_t { NRF_EGU_EVENT_TRIGGERED0 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[0]) , NRF_EGU_EVENT_TRIGGERED1 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[1]) , NRF_EGU_EVENT_TRIGGERED2 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[2]) , NRF_EGU_EVENT_TRIGGERED3 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[3]) , NRF_EGU_EVENT_TRIGGERED4 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[4]) , NRF_EGU_EVENT_TRIGGERED5 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[5]) , NRF_EGU_EVENT_TRIGGERED6 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[6]) , NRF_EGU_EVENT_TRIGGERED7 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[7]) , NRF_EGU_EVENT_TRIGGERED8 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[8]) , NRF_EGU_EVENT_TRIGGERED9 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[9]) , NRF_EGU_EVENT_TRIGGERED10 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[10]) , NRF_EGU_EVENT_TRIGGERED11 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[11]) , NRF_EGU_EVENT_TRIGGERED12 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[12]) , NRF_EGU_EVENT_TRIGGERED13 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[13]) , NRF_EGU_EVENT_TRIGGERED14 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[14]) , NRF_EGU_EVENT_TRIGGERED15 = offsetof(NRF_EGU_Type, EVENTS_TRIGGERED[15]) }
	EGU events. More...

enum	nrf_egu_int_mask_t { NRF_EGU_INT_TRIGGERED0 = EGU_INTENSET0_TRIGGERED0_Msk , NRF_EGU_INT_TRIGGERED1 = EGU_INTENSET0_TRIGGERED1_Msk , NRF_EGU_INT_TRIGGERED2 = EGU_INTENSET0_TRIGGERED2_Msk , NRF_EGU_INT_TRIGGERED3 = EGU_INTENSET0_TRIGGERED3_Msk , NRF_EGU_INT_TRIGGERED4 = EGU_INTENSET0_TRIGGERED4_Msk , NRF_EGU_INT_TRIGGERED5 = EGU_INTENSET0_TRIGGERED5_Msk , NRF_EGU_INT_TRIGGERED6 = EGU_INTENSET0_TRIGGERED6_Msk , NRF_EGU_INT_TRIGGERED7 = EGU_INTENSET0_TRIGGERED7_Msk , NRF_EGU_INT_TRIGGERED8 = EGU_INTENSET0_TRIGGERED8_Msk , NRF_EGU_INT_TRIGGERED9 = EGU_INTENSET0_TRIGGERED9_Msk , NRF_EGU_INT_TRIGGERED10 = EGU_INTENSET0_TRIGGERED10_Msk , NRF_EGU_INT_TRIGGERED11 = EGU_INTENSET0_TRIGGERED11_Msk , NRF_EGU_INT_TRIGGERED12 = EGU_INTENSET0_TRIGGERED12_Msk , NRF_EGU_INT_TRIGGERED13 = EGU_INTENSET0_TRIGGERED13_Msk , NRF_EGU_INT_TRIGGERED14 = EGU_INTENSET0_TRIGGERED14_Msk , NRF_EGU_INT_TRIGGERED15 = EGU_INTENSET0_TRIGGERED15_Msk , NRF_EGU_INT_ALL = 0xFFFFuL }
	EGU interrupts. More...

Functions
NRF_STATIC_INLINE uint32_t	nrf_egu_channel_count (NRF_EGU_Type const *p_reg)
	Function for getting the maximum channel number of the given EGU.

NRF_STATIC_INLINE void	nrf_egu_task_trigger (NRF_EGU_Type *p_reg, nrf_egu_task_t egu_task)
	Function for triggering the specified EGU task.

NRF_STATIC_INLINE uint32_t	nrf_egu_task_address_get (NRF_EGU_Type const *p_reg, nrf_egu_task_t egu_task)
	Function for returning the address of the specified EGU task register.

NRF_STATIC_INLINE nrf_egu_task_t	nrf_egu_trigger_task_get (uint8_t channel)
	Function for returning the specified EGU TRIGGER task.

NRF_STATIC_INLINE bool	nrf_egu_event_check (NRF_EGU_Type const *p_reg, nrf_egu_event_t egu_event)
	Function for retrieving the state of the EGU event.

NRF_STATIC_INLINE void	nrf_egu_event_clear (NRF_EGU_Type *p_reg, nrf_egu_event_t egu_event)
	Function for clearing the specified EGU event.

NRF_STATIC_INLINE uint32_t	nrf_egu_event_address_get (NRF_EGU_Type const *p_reg, nrf_egu_event_t egu_event)
	Function for returning the address of the specified EGU event register.

NRF_STATIC_INLINE nrf_egu_event_t	nrf_egu_triggered_event_get (uint8_t channel)
	Function for returning the specified EGU TRIGGERED event.

NRF_STATIC_INLINE void	nrf_egu_int_enable (NRF_EGU_Type *p_reg, uint32_t mask)
	Function for enabling one or more of the EGU interrupts.

NRF_STATIC_INLINE uint32_t	nrf_egu_int_enable_check (NRF_EGU_Type const *p_reg, uint32_t mask)
	Function for retrieving the state of one or more of the EGU interrupts.

NRF_STATIC_INLINE void	nrf_egu_int_disable (NRF_EGU_Type *p_reg, uint32_t mask)
	Function for disabling one or more of the EGU interrupts.

NRF_STATIC_INLINE nrf_egu_int_mask_t	nrf_egu_channel_int_get (uint8_t channel)
	Function for retrieving the state of interrupt of the specified EGU channel.

NRF_STATIC_INLINE void	nrf_egu_subscribe_set (NRF_EGU_Type *p_reg, nrf_egu_task_t task, uint8_t channel)
	Function for setting the subscribe configuration for a given EGU task.

NRF_STATIC_INLINE void	nrf_egu_subscribe_clear (NRF_EGU_Type *p_reg, nrf_egu_task_t task)
	Function for clearing the subscribe configuration for a given EGU task.

NRF_STATIC_INLINE uint32_t	nrf_egu_subscribe_get (NRF_EGU_Type const *p_reg, nrf_egu_task_t task)
	Function for getting the subscribe configuration for a given EGU task.

NRF_STATIC_INLINE void	nrf_egu_publish_set (NRF_EGU_Type *p_reg, nrf_egu_event_t event, uint8_t channel)
	Function for setting the publish configuration for a given EGU event.

NRF_STATIC_INLINE void	nrf_egu_publish_clear (NRF_EGU_Type *p_reg, nrf_egu_event_t event)
	Function for clearing the publish configuration for a given EGU event.

NRF_STATIC_INLINE uint32_t	nrf_egu_publish_get (NRF_EGU_Type const *p_reg, nrf_egu_event_t event)
	Function for getting the publish configuration for a given EGU event.

Detailed Description

Hardware access layer for managing the Event Generator Unit (EGU) peripheral.

Macro Definition Documentation

◆ NRF_EGU_INST_GET

#define NRF_EGU_INST_GET ( idx )

Value:

NRFX_CONCAT(NRF_, EGU, idx)

NRFX_CONCAT

#define NRFX_CONCAT(...)

Macro for concatenating multiple arguments.

Definition nrfx_utils.h:777

Macro getting pointer to the structure of registers of the EGU peripheral.

Parameters

[in] idx EGU instance index.

Returns: Pointer to the structure of registers of the EGU peripheral.

Enumeration Type Documentation

◆ nrf_egu_event_t

enum nrf_egu_event_t

EGU events.

Enumerator
NRF_EGU_EVENT_TRIGGERED0	Event number 0 generated by triggering the corresponding TRIGGER[0] task.
NRF_EGU_EVENT_TRIGGERED1	Event number 1 generated by triggering the corresponding TRIGGER[1] task.
NRF_EGU_EVENT_TRIGGERED2	Event number 2 generated by triggering the corresponding TRIGGER[2] task.
NRF_EGU_EVENT_TRIGGERED3	Event number 3 generated by triggering the corresponding TRIGGER[3] task.
NRF_EGU_EVENT_TRIGGERED4	Event number 4 generated by triggering the corresponding TRIGGER[4] task.
NRF_EGU_EVENT_TRIGGERED5	Event number 5 generated by triggering the corresponding TRIGGER[5] task.
NRF_EGU_EVENT_TRIGGERED6	Event number 6 generated by triggering the corresponding TRIGGER[6] task.
NRF_EGU_EVENT_TRIGGERED7	Event number 7 generated by triggering the corresponding TRIGGER[7] task.
NRF_EGU_EVENT_TRIGGERED8	Event number 8 generated by triggering the corresponding TRIGGER[8] task.
NRF_EGU_EVENT_TRIGGERED9	Event number 9 generated by triggering the corresponding TRIGGER[9] task.
NRF_EGU_EVENT_TRIGGERED10	Event number 10 generated by triggering the corresponding TRIGGER[10] task.
NRF_EGU_EVENT_TRIGGERED11	Event number 11 generated by triggering the corresponding TRIGGER[11] task.
NRF_EGU_EVENT_TRIGGERED12	Event number 12 generated by triggering the corresponding TRIGGER[12] task.
NRF_EGU_EVENT_TRIGGERED13	Event number 13 generated by triggering the corresponding TRIGGER[13] task.
NRF_EGU_EVENT_TRIGGERED14	Event number 14 generated by triggering the corresponding TRIGGER[14] task.
NRF_EGU_EVENT_TRIGGERED15	Event number 15 generated by triggering the corresponding TRIGGER[15] task.

◆ nrf_egu_int_mask_t

enum nrf_egu_int_mask_t

EGU interrupts.

Enumerator
NRF_EGU_INT_TRIGGERED0	Interrupt on EVENTS_TRIGGERED[0] event.
NRF_EGU_INT_TRIGGERED1	Interrupt on EVENTS_TRIGGERED[1] event.
NRF_EGU_INT_TRIGGERED2	Interrupt on EVENTS_TRIGGERED[2] event.
NRF_EGU_INT_TRIGGERED3	Interrupt on EVENTS_TRIGGERED[3] event.
NRF_EGU_INT_TRIGGERED4	Interrupt on EVENTS_TRIGGERED[4] event.
NRF_EGU_INT_TRIGGERED5	Interrupt on EVENTS_TRIGGERED[5] event.
NRF_EGU_INT_TRIGGERED6	Interrupt on EVENTS_TRIGGERED[6] event.
NRF_EGU_INT_TRIGGERED7	Interrupt on EVENTS_TRIGGERED[7] event.
NRF_EGU_INT_TRIGGERED8	Interrupt on EVENTS_TRIGGERED[8] event.
NRF_EGU_INT_TRIGGERED9	Interrupt on EVENTS_TRIGGERED[9] event.
NRF_EGU_INT_TRIGGERED10	Interrupt on EVENTS_TRIGGERED[10] event.
NRF_EGU_INT_TRIGGERED11	Interrupt on EVENTS_TRIGGERED[11] event.
NRF_EGU_INT_TRIGGERED12	Interrupt on EVENTS_TRIGGERED[12] event.
NRF_EGU_INT_TRIGGERED13	Interrupt on EVENTS_TRIGGERED[13] event.
NRF_EGU_INT_TRIGGERED14	Interrupt on EVENTS_TRIGGERED[14] event.
NRF_EGU_INT_TRIGGERED15	Interrupt on EVENTS_TRIGGERED[15] event.
NRF_EGU_INT_ALL	All EGU interrupt masks.

◆ nrf_egu_task_t

enum nrf_egu_task_t

EGU tasks.

Enumerator
NRF_EGU_TASK_TRIGGER0	Trigger 0 for triggering the corresponding TRIGGERED[0] event.
NRF_EGU_TASK_TRIGGER1	Trigger 1 for triggering the corresponding TRIGGERED[1] event.
NRF_EGU_TASK_TRIGGER2	Trigger 2 for triggering the corresponding TRIGGERED[2] event.
NRF_EGU_TASK_TRIGGER3	Trigger 3 for triggering the corresponding TRIGGERED[3] event.
NRF_EGU_TASK_TRIGGER4	Trigger 4 for triggering the corresponding TRIGGERED[4] event.
NRF_EGU_TASK_TRIGGER5	Trigger 5 for triggering the corresponding TRIGGERED[5] event.
NRF_EGU_TASK_TRIGGER6	Trigger 6 for triggering the corresponding TRIGGERED[6] event.
NRF_EGU_TASK_TRIGGER7	Trigger 7 for triggering the corresponding TRIGGERED[7] event.
NRF_EGU_TASK_TRIGGER8	Trigger 8 for triggering the corresponding TRIGGERED[8] event.
NRF_EGU_TASK_TRIGGER9	Trigger 9 for triggering the corresponding TRIGGERED[9] event.
NRF_EGU_TASK_TRIGGER10	Trigger 10 for triggering the corresponding TRIGGERED[10] event.
NRF_EGU_TASK_TRIGGER11	Trigger 11 for triggering the corresponding TRIGGERED[11] event.
NRF_EGU_TASK_TRIGGER12	Trigger 12 for triggering the corresponding TRIGGERED[12] event.
NRF_EGU_TASK_TRIGGER13	Trigger 13 for triggering the corresponding TRIGGERED[13] event.
NRF_EGU_TASK_TRIGGER14	Trigger 14 for triggering the corresponding TRIGGERED[14] event.
NRF_EGU_TASK_TRIGGER15	Trigger 15 for triggering the corresponding TRIGGERED[15] event.

Function Documentation

◆ nrf_egu_channel_count()

NRF_STATIC_INLINE uint32_t nrf_egu_channel_count ( NRF_EGU_Type const * p_reg )

Function for getting the maximum channel number of the given EGU.

Parameters

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

Returns: Number of available channels.

◆ nrf_egu_channel_int_get()

NRF_STATIC_INLINE nrf_egu_int_mask_t nrf_egu_channel_int_get ( uint8_t channel )

Function for retrieving the state of interrupt of the specified EGU channel.

Parameters

[in] channel Channel number.

Returns: EGU interrupt mask.

◆ nrf_egu_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_egu_event_address_get	(	NRF_EGU_Type const *	p_reg,
		nrf_egu_event_t	egu_event )

Function for returning the address of the specified EGU event register.

Parameters

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

Returns: Address of the specified EGU event register.

◆ nrf_egu_event_check()

NRF_STATIC_INLINE bool nrf_egu_event_check	(	NRF_EGU_Type const *	p_reg,
		nrf_egu_event_t	egu_event )

Function for retrieving the state of the EGU event.

Parameters

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

Return values

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

◆ nrf_egu_event_clear()

NRF_STATIC_INLINE void nrf_egu_event_clear	(	NRF_EGU_Type *	p_reg,
		nrf_egu_event_t	egu_event )

Function for clearing the specified EGU event.

Parameters

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

◆ nrf_egu_int_disable()

NRF_STATIC_INLINE void nrf_egu_int_disable	(	NRF_EGU_Type *	p_reg,
		uint32_t	mask )

Function for disabling one or more of the EGU interrupts.

Parameters

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

◆ nrf_egu_int_enable()

NRF_STATIC_INLINE void nrf_egu_int_enable	(	NRF_EGU_Type *	p_reg,
		uint32_t	mask )

Function for enabling one or more of the EGU interrupts.

Parameters

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

◆ nrf_egu_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_egu_int_enable_check	(	NRF_EGU_Type const *	p_reg,
		uint32_t	mask )

Function for retrieving the state of one or more of the EGU interrupts.

Parameters

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

Returns: Mask of enabled interrupts.

◆ nrf_egu_publish_clear()

NRF_STATIC_INLINE void nrf_egu_publish_clear	(	NRF_EGU_Type *	p_reg,
		nrf_egu_event_t	event )

Function for clearing the publish configuration for a given EGU event.

Parameters

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

◆ nrf_egu_publish_get()

NRF_STATIC_INLINE uint32_t nrf_egu_publish_get	(	NRF_EGU_Type const *	p_reg,
		nrf_egu_event_t	event )

Function for getting the publish configuration for a given EGU event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event for which to read the configuration.

Returns: EGU publish configuration.

◆ nrf_egu_publish_set()

NRF_STATIC_INLINE void nrf_egu_publish_set	(	NRF_EGU_Type *	p_reg,
		nrf_egu_event_t	event,
		uint8_t	channel )

Function for setting the publish configuration for a given EGU event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event for which to set the configuration.
[in]	channel	Channel through which to publish the event.

◆ nrf_egu_subscribe_clear()

NRF_STATIC_INLINE void nrf_egu_subscribe_clear	(	NRF_EGU_Type *	p_reg,
		nrf_egu_task_t	task )

Function for clearing the subscribe configuration for a given EGU task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to clear the configuration.

◆ nrf_egu_subscribe_get()

NRF_STATIC_INLINE uint32_t nrf_egu_subscribe_get	(	NRF_EGU_Type const *	p_reg,
		nrf_egu_task_t	task )

Function for getting the subscribe configuration for a given EGU task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to read the configuration.

Returns: EGU subscribe configuration.

◆ nrf_egu_subscribe_set()

NRF_STATIC_INLINE void nrf_egu_subscribe_set	(	NRF_EGU_Type *	p_reg,
		nrf_egu_task_t	task,
		uint8_t	channel )

Function for setting the subscribe configuration for a given EGU task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to set the configuration.
[in]	channel	Channel through which to subscribe events.

◆ nrf_egu_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_egu_task_address_get	(	NRF_EGU_Type const *	p_reg,
		nrf_egu_task_t	egu_task )

Function for returning the address of the specified EGU task register.

Parameters

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

Returns: Address of the specified EGU task register.

◆ nrf_egu_task_trigger()

NRF_STATIC_INLINE void nrf_egu_task_trigger	(	NRF_EGU_Type *	p_reg,
		nrf_egu_task_t	egu_task )

Function for triggering the specified EGU task.

Parameters

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

◆ nrf_egu_trigger_task_get()

NRF_STATIC_INLINE nrf_egu_task_t nrf_egu_trigger_task_get ( uint8_t channel )

Function for returning the specified EGU TRIGGER task.

Parameters

[in] channel Channel number.

Returns: The specified EGU TRIGGER task.

◆ nrf_egu_triggered_event_get()

NRF_STATIC_INLINE nrf_egu_event_t nrf_egu_triggered_event_get ( uint8_t channel )

Function for returning the specified EGU TRIGGERED event.

Parameters

[in] channel Channel number.

Returns: The specified EGU TRIGGERED event.

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ NRF_EGU_INST_GET

Enumeration Type Documentation

◆ nrf_egu_event_t

◆ nrf_egu_int_mask_t

◆ nrf_egu_task_t

Function Documentation

◆ nrf_egu_channel_count()

◆ nrf_egu_channel_int_get()

◆ nrf_egu_event_address_get()

◆ nrf_egu_event_check()

◆ nrf_egu_event_clear()

◆ nrf_egu_int_disable()

◆ nrf_egu_int_enable()

◆ nrf_egu_int_enable_check()

◆ nrf_egu_publish_clear()

◆ nrf_egu_publish_get()

◆ nrf_egu_publish_set()

◆ nrf_egu_subscribe_clear()

◆ nrf_egu_subscribe_get()

◆ nrf_egu_subscribe_set()

◆ nrf_egu_task_address_get()

◆ nrf_egu_task_trigger()

◆ nrf_egu_trigger_task_get()

◆ nrf_egu_triggered_event_get()