EGU HAL

group nrf_egu_hal

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

Defines

NRF_EGU_INST_GET(idx)

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

Parameters:

• idx – [in] EGU instance index.

Returns:

Pointer to the structure of registers of the EGU peripheral.

Enums

enum nrf_egu_task_t

EGU tasks.

Values:

enumerator NRF_EGU_TASK_TRIGGER0

Trigger 0 for triggering the corresponding TRIGGERED[0] event.

enumerator NRF_EGU_TASK_TRIGGER1

Trigger 1 for triggering the corresponding TRIGGERED[1] event.

enumerator NRF_EGU_TASK_TRIGGER2

Trigger 2 for triggering the corresponding TRIGGERED[2] event.

enumerator NRF_EGU_TASK_TRIGGER3

Trigger 3 for triggering the corresponding TRIGGERED[3] event.

enumerator NRF_EGU_TASK_TRIGGER4

Trigger 4 for triggering the corresponding TRIGGERED[4] event.

enumerator NRF_EGU_TASK_TRIGGER5

Trigger 5 for triggering the corresponding TRIGGERED[5] event.

enumerator NRF_EGU_TASK_TRIGGER6

Trigger 6 for triggering the corresponding TRIGGERED[6] event.

enumerator NRF_EGU_TASK_TRIGGER7

Trigger 7 for triggering the corresponding TRIGGERED[7] event.

enumerator NRF_EGU_TASK_TRIGGER8

Trigger 8 for triggering the corresponding TRIGGERED[8] event.

enumerator NRF_EGU_TASK_TRIGGER9

Trigger 9 for triggering the corresponding TRIGGERED[9] event.

enumerator NRF_EGU_TASK_TRIGGER10

Trigger 10 for triggering the corresponding TRIGGERED[10] event.

enumerator NRF_EGU_TASK_TRIGGER11

Trigger 11 for triggering the corresponding TRIGGERED[11] event.

enumerator NRF_EGU_TASK_TRIGGER12

Trigger 12 for triggering the corresponding TRIGGERED[12] event.

enumerator NRF_EGU_TASK_TRIGGER13

Trigger 13 for triggering the corresponding TRIGGERED[13] event.

enumerator NRF_EGU_TASK_TRIGGER14

Trigger 14 for triggering the corresponding TRIGGERED[14] event.

enumerator NRF_EGU_TASK_TRIGGER15

Trigger 15 for triggering the corresponding TRIGGERED[15] event.

enum nrf_egu_event_t

EGU events.

Values:

enumerator NRF_EGU_EVENT_TRIGGERED0

Event number 0 generated by triggering the corresponding TRIGGER[0] task.

enumerator NRF_EGU_EVENT_TRIGGERED1

Event number 1 generated by triggering the corresponding TRIGGER[1] task.

enumerator NRF_EGU_EVENT_TRIGGERED2

Event number 2 generated by triggering the corresponding TRIGGER[2] task.

enumerator NRF_EGU_EVENT_TRIGGERED3

Event number 3 generated by triggering the corresponding TRIGGER[3] task.

enumerator NRF_EGU_EVENT_TRIGGERED4

Event number 4 generated by triggering the corresponding TRIGGER[4] task.

enumerator NRF_EGU_EVENT_TRIGGERED5

Event number 5 generated by triggering the corresponding TRIGGER[5] task.

enumerator NRF_EGU_EVENT_TRIGGERED6

Event number 6 generated by triggering the corresponding TRIGGER[6] task.

enumerator NRF_EGU_EVENT_TRIGGERED7

Event number 7 generated by triggering the corresponding TRIGGER[7] task.

enumerator NRF_EGU_EVENT_TRIGGERED8

Event number 8 generated by triggering the corresponding TRIGGER[8] task.

enumerator NRF_EGU_EVENT_TRIGGERED9

Event number 9 generated by triggering the corresponding TRIGGER[9] task.

enumerator NRF_EGU_EVENT_TRIGGERED10

Event number 10 generated by triggering the corresponding TRIGGER[10] task.

enumerator NRF_EGU_EVENT_TRIGGERED11

Event number 11 generated by triggering the corresponding TRIGGER[11] task.

enumerator NRF_EGU_EVENT_TRIGGERED12

Event number 12 generated by triggering the corresponding TRIGGER[12] task.

enumerator NRF_EGU_EVENT_TRIGGERED13

Event number 13 generated by triggering the corresponding TRIGGER[13] task.

enumerator NRF_EGU_EVENT_TRIGGERED14

Event number 14 generated by triggering the corresponding TRIGGER[14] task.

enumerator NRF_EGU_EVENT_TRIGGERED15

Event number 15 generated by triggering the corresponding TRIGGER[15] task.

enum nrf_egu_int_mask_t

EGU interrupts.

Values:

enumerator NRF_EGU_INT_TRIGGERED0

Interrupt on EVENTS_TRIGGERED[0] event.

enumerator NRF_EGU_INT_TRIGGERED1

Interrupt on EVENTS_TRIGGERED[1] event.

enumerator NRF_EGU_INT_TRIGGERED2

Interrupt on EVENTS_TRIGGERED[2] event.

enumerator NRF_EGU_INT_TRIGGERED3

Interrupt on EVENTS_TRIGGERED[3] event.

enumerator NRF_EGU_INT_TRIGGERED4

Interrupt on EVENTS_TRIGGERED[4] event.

enumerator NRF_EGU_INT_TRIGGERED5

Interrupt on EVENTS_TRIGGERED[5] event.

enumerator NRF_EGU_INT_TRIGGERED6

Interrupt on EVENTS_TRIGGERED[6] event.

enumerator NRF_EGU_INT_TRIGGERED7

Interrupt on EVENTS_TRIGGERED[7] event.

enumerator NRF_EGU_INT_TRIGGERED8

Interrupt on EVENTS_TRIGGERED[8] event.

enumerator NRF_EGU_INT_TRIGGERED9

Interrupt on EVENTS_TRIGGERED[9] event.

enumerator NRF_EGU_INT_TRIGGERED10

Interrupt on EVENTS_TRIGGERED[10] event.

enumerator NRF_EGU_INT_TRIGGERED11

Interrupt on EVENTS_TRIGGERED[11] event.

enumerator NRF_EGU_INT_TRIGGERED12

Interrupt on EVENTS_TRIGGERED[12] event.

enumerator NRF_EGU_INT_TRIGGERED13

Interrupt on EVENTS_TRIGGERED[13] event.

enumerator NRF_EGU_INT_TRIGGERED14

Interrupt on EVENTS_TRIGGERED[14] event.

enumerator NRF_EGU_INT_TRIGGERED15

Interrupt on EVENTS_TRIGGERED[15] event.

enumerator NRF_EGU_INT_ALL

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.

Parameters:

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

Returns:

Number of available channels.

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:

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

• egu_task – [in] 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.

Parameters:

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

• egu_task – [in] EGU task.

Returns:

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.

Parameters:

• channel – [in] Channel number.

Returns:

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.

Parameters:

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

• egu_event – [in] EGU event to be checked.

Return values:

• true – The event has been generated.

• false – The event has not been generated.

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:

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

• egu_event – [in] EGU event to clear.

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:

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

• egu_event – [in] EGU event.

Returns:

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.

Parameters:

• channel – [in] Channel number.

Returns:

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.

Parameters:

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

• mask – [in] Mask of interrupts to be enabled. Use nrf_egu_int_mask_t values for bit masking.

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:

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

• mask – [in] Mask of interrupts to be checked. Use nrf_egu_int_mask_t values for bit masking.

Returns:

Mask of enabled 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.

Parameters:

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

• mask – [in] Mask of interrupts to be disabled. Use nrf_egu_int_mask_t values for bit masking.

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:

• channel – [in] Channel number.

Returns:

EGU interrupt mask.

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:

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

• task – [in] Task for which to set the configuration.

• channel – [in] Channel through which to subscribe events.

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:

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

• task – [in] Task for which to clear the configuration.

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:

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

• event – [in] Event for which to set the configuration.

• channel – [in] Channel through which to publish the 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.

Parameters:

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

• event – [in] Event for which to clear the configuration.