Common module

group nrfx_common

Common module.

Defines

NRFX_CHECK(module_enabled)

Macro for checking if the specified identifier is defined and it has a non-zero value.

Normally, preprocessors treat all undefined identifiers as having the value zero. However, some tools, like static code analyzers, can issue a warning when such identifier is evaluated. This macro gives the possibility to suppress such warnings only in places where this macro is used for evaluation, not in the whole analyzed code.

NRFX_BIT(x)

Macro for creating unsigned integer with bit position x set.

Parameters

  • x – [in] Bit position to be set.

Returns

Unsigned integer with requested bit position set.

NRFX_BIT_MASK(x)

Macro for returning bit mask or 0 if x is 0.

Parameters

  • x – [in] Bit mask size. Bit mask has bits 0 through x-1 (inclusive) set.

Returns

Bit mask.

NRFX_CONCAT_2(p1, p2)

Macro for concatenating two tokens in macro expansion.

See also

NRFX_CONCAT_3

Note

This macro is expanded in two steps so that tokens given as macros themselves are fully expanded before they are merged.

Parameters

  • p1 – [in] First token.

  • p2 – [in] Second token.

Returns

The two tokens merged into one, unless they cannot together form a valid token (in such case, the preprocessor issues a warning and does not perform the concatenation).

NRFX_CONCAT_2_(p1, p2)

Internal macro used by NRFX_CONCAT_2 to perform the expansion in two steps.

NRFX_CONCAT_3(p1, p2, p3)

Macro for concatenating three tokens in macro expansion.

See also

NRFX_CONCAT_2

Note

This macro is expanded in two steps so that tokens given as macros themselves are fully expanded before they are merged.

Parameters

  • p1 – [in] First token.

  • p2 – [in] Second token.

  • p3 – [in] Third token.

Returns

The three tokens merged into one, unless they cannot together form a valid token (in such case, the preprocessor issues a warning and does not perform the concatenation).

NRFX_CONCAT_3_(p1, p2, p3)

Internal macro used by NRFX_CONCAT_3 to perform the expansion in two steps.

NRFX_ROUNDED_DIV(a, b)

Macro for performing rounded integer division (as opposed to truncating the result).

Parameters

  • a – [in] Numerator.

  • b – [in] Denominator.

Returns

Rounded (integer) result of dividing a by b.

NRFX_CEIL_DIV(a, b)

Macro for performing integer division, making sure the result is rounded up.

A typical use case for this macro is to compute the number of objects with size b required to hold a number of bytes.

Parameters

  • a – [in] Numerator.

  • b – [in] Denominator.

Returns

Integer result of dividing a by b, rounded up.

NRFX_ARRAY_SIZE(array)

Macro for getting the number of elements in an array.

Parameters

  • array – [in] Name of the array.

Returns

Array element count.

NRFX_OFFSETOF(type, member)

Macro for getting the offset (in bytes) from the beginning of a structure of the specified type to its specified member.

Parameters

  • type – [in] Structure type.

  • member – [in] Structure member whose offset is searched for.

Returns

Member offset in bytes.

NRFX_EASYDMA_LENGTH_VALIDATE(peripheral, length1, length2)

Macro for checking if given lengths of EasyDMA transfers do not exceed the limit of the specified peripheral.

Parameters

  • peripheral – [in] Peripheral to check the lengths against.

  • length1 – [in] First length to be checked.

  • length2 – [in] Second length to be checked (pass 0 if not needed).

Return values

  • true – The length of buffers does not exceed the limit of the specified peripheral.

  • false – The length of buffers exceeds the limit of the specified peripheral.

NRFX_WAIT_FOR(condition, attempts, delay_us, result)

Macro for waiting until condition is met.

Parameters

  • condition – [in] Condition to meet.

  • attempts – [in] Maximum number of condition checks. Must not be 0.

  • delay_us – [in] Delay between consecutive checks, in microseconds.

  • result – [out] Boolean variable to store the result of the wait process. Set to true if the condition is met or false otherwise.

NRFX_PERIPHERAL_ID_GET(base_addr)

Macro for getting the ID number of the specified peripheral.

For peripherals in Nordic SoCs, there is a direct relationship between their ID numbers and their base addresses. See the chapter “Peripheral interface” (section “Peripheral ID”) in the Product Specification.

Parameters

  • base_addr – [in] Peripheral base address or pointer.

Returns

ID number associated with the specified peripheral.

NRFX_IRQ_NUMBER_GET(base_addr)

Macro for getting the interrupt number assigned to a specific peripheral.

For peripherals in Nordic SoCs, the IRQ number assigned to a peripheral is equal to its ID number. See the chapter “Peripheral interface” (sections “Peripheral ID” and “Interrupts”) in the Product Specification.

Parameters

  • base_addr – [in] Peripheral base address or pointer.

Returns

Interrupt number associated with the specified peripheral.

Typedefs

typedef void (*nrfx_irq_handler_t)(void)

IRQ handler type.

Enums

enum nrfx_drv_state_t

Driver state.

Values:

enumerator NRFX_DRV_STATE_UNINITIALIZED

Uninitialized.

enumerator NRFX_DRV_STATE_INITIALIZED

Initialized but powered off.

enumerator NRFX_DRV_STATE_POWERED_ON

Initialized and powered on.

Functions

__STATIC_INLINE bool nrfx_is_in_ram(void const *p_object)

Function for checking if an object is placed in the Data RAM region.

Several peripherals (the ones using EasyDMA) require the transfer buffers to be placed in the Data RAM region. This function can be used to check if this condition is met.

Parameters

  • p_object – [in] Pointer to an object whose location is to be checked.

Return values

  • true – The pointed object is located in the Data RAM region.

  • false – The pointed object is not located in the Data RAM region.

__STATIC_INLINE bool nrfx_is_word_aligned(void const *p_object)

Function for checking if an object is aligned to a 32-bit word.

Several peripherals (the ones using EasyDMA) require the transfer buffers to be aligned to a 32-bit word. This function can be used to check if this condition is met.

Parameters

  • p_object – [in] Pointer to an object whose location is to be checked.

Return values

  • true – The pointed object is aligned to a 32-bit word.

  • false – The pointed object is not aligned to a 32-bit word.

__STATIC_INLINE IRQn_Type nrfx_get_irq_number(void const *p_reg)

Function for getting the interrupt number for the specified peripheral.

Parameters

  • p_reg – [in] Peripheral base pointer.

Returns

Interrupt number associated with the pointed peripheral.

__STATIC_INLINE uint32_t nrfx_bitpos_to_event(uint32_t bit)

Function for converting an INTEN register bit position to the corresponding event identifier.

The event identifier is the offset between the event register address and the peripheral base address, and is equal (thus, can be directly cast) to the corresponding value of the enumerated type from HAL (nrf_*_event_t).

See also

nrfx_event_to_bitpos

Parameters

  • bit – [in] INTEN register bit position.

Returns

Event identifier.

__STATIC_INLINE uint32_t nrfx_event_to_bitpos(uint32_t event)

Function for converting an event identifier to the corresponding INTEN register bit position.

The event identifier is the offset between the event register address and the peripheral base address, and is equal (thus, can be directly cast) to the corresponding value of the enumerated type from HAL (nrf_*_event_t).

See also

nrfx_bitpos_to_event

Parameters

  • event – [in] Event identifier.

Returns

INTEN register bit position.