BELLBOARD HAL

group nrf_bellboard_hal

Hardware access layer for managing the BELLBOARD peripheral.

Defines

NRF_BELLBOARD_EVENTS_TRIGGERED_COUNT

Symbol specifying maximum number of available events triggered.

Enums

enum nrf_bellboard_event_t

BELLBOARD events.

Values:

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_0

Triggered 0 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_1

Triggered 1 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_2

Triggered 2 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_3

Triggered 3 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_4

Triggered 4 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_5

Triggered 5 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_6

Triggered 6 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_7

Triggered 7 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_8

Triggered 8 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_9

Triggered 9 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_10

Triggered 10 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_11

Triggered 11 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_12

Triggered 12 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_13

Triggered 13 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_14

Triggered 14 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_15

Triggered 15 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_16

Triggered 16 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_17

Triggered 17 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_18

Triggered 18 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_19

Triggered 19 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_20

Triggered 20 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_21

Triggered 21 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_22

Triggered 22 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_23

Triggered 23 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_24

Triggered 24 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_25

Triggered 25 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_26

Triggered 26 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_27

Triggered 27 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_28

Triggered 28 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_29

Triggered 29 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_30

Triggered 30 event.

enumerator NRF_BELLBOARD_EVENT_TRIGGERED_31

Triggered 31 event.

enum nrf_bellboard_int_mask_t

BELLBOARD interrupts.

Values:

enumerator NRF_BELLBOARD_INT_TRIGGERED_0_MASK

Triggered 0 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_1_MASK

Triggered 1 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_2_MASK

Triggered 2 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_3_MASK

Triggered 3 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_4_MASK

Triggered 4 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_5_MASK

Triggered 5 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_6_MASK

Triggered 6 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_7_MASK

Triggered 7 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_8_MASK

Triggered 8 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_9_MASK

Triggered 9 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_10_MASK

Triggered 10 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_11_MASK

Triggered 11 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_12_MASK

Triggered 12 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_13_MASK

Triggered 13 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_14_MASK

Triggered 14 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_15_MASK

Triggered 15 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_16_MASK

Triggered 16 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_17_MASK

Triggered 17 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_18_MASK

Triggered 18 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_19_MASK

Triggered 19 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_20_MASK

Triggered 20 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_21_MASK

Triggered 21 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_22_MASK

Triggered 22 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_23_MASK

Triggered 23 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_24_MASK

Triggered 24 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_25_MASK

Triggered 25 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_26_MASK

Triggered 26 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_27_MASK

Triggered 27 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_28_MASK

Triggered 28 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_29_MASK

Triggered 29 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_30_MASK

Triggered 30 interrupt mask.

enumerator NRF_BELLBOARD_INT_TRIGGERED_31_MASK

Triggered 31 interrupt mask.

enum nrf_bellboard_task_t

BELLBOARD tasks.

Values:

enumerator NRF_BELLBOARD_TASK_TRIGGER_0

Trigger 0 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_1

Trigger 1 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_2

Trigger 2 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_3

Trigger 3 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_4

Trigger 4 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_5

Trigger 5 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_6

Trigger 6 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_7

Trigger 7 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_8

Trigger 8 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_9

Trigger 9 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_10

Trigger 10 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_11

Trigger 11 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_12

Trigger 12 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_13

Trigger 13 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_14

Trigger 14 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_15

Trigger 15 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_16

Trigger 16 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_17

Trigger 17 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_18

Trigger 18 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_19

Trigger 19 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_20

Trigger 20 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_21

Trigger 21 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_22

Trigger 22 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_23

Trigger 23 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_24

Trigger 24 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_25

Trigger 25 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_26

Trigger 26 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_27

Trigger 27 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_28

Trigger 28 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_29

Trigger 29 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_30

Trigger 30 task.

enumerator NRF_BELLBOARD_TASK_TRIGGER_31

Trigger 31 task.

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.

Parameters:

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

• task – [in] Task to be triggered.

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:

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

• task – [in] Specified task.

Returns:

Address of the specified 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.

Parameters:

• index – [in] Event index.

Returns:

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.

Parameters:

• index – [in] Task index.

Returns:

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.

Parameters:

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

• event – [in] Event to clear.

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:

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

• event – [in] Event to be checked.

Return values:

• true – The event has been generated.

• false – The event has not been generated.

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:

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

• event – [in] Specified event.

Returns:

Address of the specified 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.

Parameters:

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

• group_idx – [in] Index of interrupt group to be enabled.

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

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:

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

• group_idx – [in] Index of interrupt group to be disabled.

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

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:

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

• group_idx – [in] Index of interrupt group to be checked.

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

Returns:

Mask of enabled interrupts.

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:

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

• group_idx – [in] Index of interrupt group to be retrieved.

Returns:

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