Common module

Common module. More...

Macros
#define	NRFX_CHECK(module_enabled)   NRFX_IS_ENABLED(module_enabled)
	Macro for checking if the specified identifier is defined and it has a non-zero value.
#define	NRFX_API_VER_AT_LEAST(major, minor, micro)
	Macro for checking if the configured API version is greater than or equal to the specified API version.
#define	NRFX_BIT(x)   (1UL << (x))
	Macro for creating unsigned integer with bit position x set.
#define	NRFX_BIT_MASK(x)   (((x) == 32) ? UINT32_MAX : ((1UL << (x)) - 1))
	Macro for returning bit mask or 0 if x is 0.
#define	NRFX_BIT_SIZE(x)   ((x) << 3)
	Macro for returning size in bits for given size in bytes.
#define	NRFX_CONCAT_2(p1, p2)   NRFX_CONCAT_2_(p1, p2)
	Macro for concatenating two tokens in macro expansion.
#define	NRFX_CONCAT_2_(p1, p2)   p1 ## p2
	Internal macro used by NRFX_CONCAT_2 to perform the expansion in two steps.
#define	NRFX_CONCAT_3(p1, p2, p3)   NRFX_CONCAT_3_(p1, p2, p3)
	Macro for concatenating three tokens in macro expansion.
#define	NRFX_CONCAT_3_(p1, p2, p3)   p1 ## p2 ## p3
	Internal macro used by NRFX_CONCAT_3 to perform the expansion in two steps.
#define	NRFX_ABS(a)   ((a) < (0) ? -(a) : (a))
	Macro for computing the absolute value of an integer number.
#define	NRFX_FEATURE_PRESENT(periph_name, feature_name)
	Macro for checking whether any of the instance of the specified peripheral supports a given feature.
#define	NRFX_FOREACH_ENABLED(periph_name, macro, sep, off_code, ...)
	Macro for resolving provided user macro for enabled instances of a driver.
#define	NRFX_FOREACH_PRESENT(periph_name, macro, sep, off_code, ...)
	Macro for resolving provided user macro for present instances of a peripheral.
#define	NRFX_INSTANCE_CONCAT(periph_name, prefix, i, macro, ...)    macro(NRFX_CONCAT(periph_name, prefix, i), __VA_ARGS__)
	Macro for resolving provided user macro on concatenated peripheral name and instance index.
#define	NRFX_INSTANCE_ENUM_LIST(periph_name)    NRFX_FOREACH_ENABLED(periph_name, _NRFX_INST_ENUM, (), ())
	Macro for creating a content for enum which is listing enabled driver instances.
#define	NRFX_INSTANCE_IRQ_HANDLERS(periph_name, periph_name_small)    NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER, (), (), periph_name_small)
	Macro for creating an interrupt handler for all enabled driver instances.
#define	NRFX_INSTANCE_IRQ_HANDLERS_EXT(periph_name, periph_name_small, ext_macro)    NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER_EXT, (), (), periph_name_small, ext_macro)
	Macro for creating an interrupt handler for all enabled driver instances with the specified extra parameter.
#define	NRFX_INSTANCE_IRQ_HANDLERS_DECLARE(periph_name, periph_name_small)    NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER_DECLARE, (), (), periph_name_small)
	Macro for declaring an interrupt handler for all enabled driver instances.
#define	NRFX_INSTANCE_IRQ_HANDLERS_LIST(periph_name, periph_name_small)    NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER_LIST, (), (), periph_name_small)
	Macro for generating comma-separated list of interrupt handlers for all enabled driver instances.
#define	NRFX_INSTANCE_PRESENT(_inst)   NRFX_ARG_HAS_PARENTHESIS(NRFX_CONCAT(NRF_, _inst))
	Macro for checking if given peripheral instance is present on the target.
#define	NRFX_MIN(a, b)   ((a) < (b) ? (a) : (b))
	Macro for getting the smaller value between two arguments.
#define	NRFX_MAX(a, b)   ((a) > (b) ? (a) : (b))
	Macro for getting the larger value between two arguments.
#define	NRFX_IN_RANGE(val, min, max)   ((val) >= (min) && (val) <= (max))
	Macro for checking if a given value is in a given range.
#define	NRFX_ROUNDED_DIV(a, b)    ((((a) < 0) ^ ((b) < 0)) ? (((a) - (b) / 2) / (b)) : (((a) + (b) / 2) / (b)))
	Macro for performing rounded integer division (as opposed to truncating the result).
#define	NRFX_CEIL_DIV(a, b)   ((((a) - 1) / (b)) + 1)
	Macro for performing integer division, making sure the result is rounded up.
#define	NRFX_ARRAY_SIZE(array)   (sizeof(array) / sizeof((array)[0]))
	Macro for getting the number of elements in an array.
#define	NRFX_OFFSETOF(type, member)   ((size_t) & (((type *)0)->member))
	Macro for getting the offset (in bytes) from the beginning of a structure of the specified type to its specified member.
#define	NRFX_IS_POWER_OF_TWO(val)   (((val) != 0) && ((val) & ((val) - 1)) == 0)
	Macro for checking whether given number is power of 2.
#define	NRFX_IS_EVEN(val)   (((val) % 2) == 0)
	Macro for checking whether a given number is even.
#define	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.
#define	NRFX_WAIT_FOR(condition, attempts, delay_us, result)
	Macro for waiting until condition is met.
#define	NRFX_PERIPHERAL_ID_GET(base_addr)   (uint16_t)(((uint32_t)(base_addr) >> 12) & 0x000001FF)
	Macro for getting the ID number of the specified peripheral.
#define	NRFX_IRQ_NUMBER_GET(base_addr)   NRFX_PERIPHERAL_ID_GET(base_addr)
	Macro for getting the interrupt number assigned to a specific peripheral.
#define	NRFX_KHZ_TO_HZ(freq)   ((freq) * 1000)
	Macro for converting frequency in kHz to Hz.
#define	NRFX_MHZ_TO_HZ(freq)   ((freq) * 1000 * 1000)
	Macro for converting frequency in MHz to Hz.

Typedefs
typedef void(*	nrfx_irq_handler_t) (void)
	IRQ handler type.

Enumerations
enum	nrfx_drv_state_t {   NRFX_DRV_STATE_UNINITIALIZED ,   NRFX_DRV_STATE_INITIALIZED ,   NRFX_DRV_STATE_POWERED_ON }
	Driver state. More...

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.
__STATIC_INLINE bool	nrfx_is_word_aligned (void const *p_object)
	Function for checking if an object is 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.
__STATIC_INLINE uint32_t	nrfx_bitpos_to_event (uint32_t bit)
	Function for converting an INTEN register bit position to the corresponding 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.

Detailed Description

Common module.

Macro Definition Documentation

NRFX_ABS

#define NRFX_ABS

(

a

)

((a) < (0) ? -(a) : (a))

Macro for computing the absolute value of an integer number.

Parameters

[in]

a

Input value.

Returns

Absolute value.

NRFX_API_VER_AT_LEAST

#define NRFX_API_VER_AT_LEAST	(		major,
			minor,
			micro
	)

Value:

 ((NRFX_CONFIG_API_VER_MAJOR >= (major)) && \
 (NRFX_CONFIG_API_VER_MINOR >= (minor)) && \
 (NRFX_CONFIG_API_VER_MICRO >= (micro)))

Macro for checking if the configured API version is greater than or equal to the specified API version.

Note

API version to be used is configured using following symbols:

• NRFX_CONFIG_API_VER_MAJOR
• NRFX_CONFIG_API_VER_MINOR
• NRFX_CONFIG_API_VER_MICRO

Parameters

[in]	major	Major API version.
[in]	minor	Minor API version.
[in]	micro	Micro API version.

Return values

true	Configured API version is greater than or equal to the specified API version.
false	Configured API version is smaller than the specified API version.

NRFX_ARRAY_SIZE

#define NRFX_ARRAY_SIZE

(

array

)

(sizeof(array) / sizeof((array)[0]))

Macro for getting the number of elements in an array.

Parameters

[in]

array

Name of the array.

Returns

Array element count.

NRFX_BIT

#define NRFX_BIT

(

x

)

(1UL << (x))

Macro for creating unsigned integer with bit position x set.

Parameters

[in]

x

Bit position to be set.

Returns

Unsigned integer with requested bit position set.

NRFX_BIT_MASK

#define NRFX_BIT_MASK

(

x

)

(((x) == 32) ? UINT32_MAX : ((1UL << (x)) - 1))

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

Parameters

[in]

x

Bit mask size. Bit mask has bits 0 through x-1 (inclusive) set.

Returns

Bit mask.

NRFX_BIT_SIZE

#define NRFX_BIT_SIZE

(

x

)

((x) << 3)

Macro for returning size in bits for given size in bytes.

Parameters

[in]

x

Size in bytes.

Returns

Size in bits.

NRFX_CEIL_DIV

#define NRFX_CEIL_DIV	(		a,
			b
	)		((((a) - 1) / (b)) + 1)

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

[in]	a	Numerator.
[in]	b	Denominator.

Returns

Integer result of dividing a by b, rounded up.

NRFX_CHECK

#define NRFX_CHECK

(

module_enabled

)

NRFX_IS_ENABLED(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_CONCAT_2

#define NRFX_CONCAT_2	(		p1,
			p2
	)		NRFX_CONCAT_2_(p1, p2)

Macro for concatenating two tokens in macro expansion.

Note

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

Parameters

[in]	p1	First token.
[in]	p2	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).

See also

NRFX_CONCAT_3

NRFX_CONCAT_3

#define NRFX_CONCAT_3	(		p1,
			p2,
			p3
	)		NRFX_CONCAT_3_(p1, p2, p3)

Macro for concatenating three tokens in macro expansion.

Note

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

Parameters

[in]	p1	First token.
[in]	p2	Second token.
[in]	p3	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).

See also

NRFX_CONCAT_2

NRFX_EASYDMA_LENGTH_VALIDATE

#define NRFX_EASYDMA_LENGTH_VALIDATE	(		peripheral,
			length1,
			length2
	)

Value:

 (((length1) < (1U << NRFX_CONCAT_2(peripheral, _EASYDMA_MAXCNT_SIZE))) && \
 ((length2) < (1U << NRFX_CONCAT_2(peripheral, _EASYDMA_MAXCNT_SIZE))))

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

Parameters

[in]	peripheral	Peripheral to check the lengths against.
[in]	length1	First length to be checked.
[in]	length2	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_FEATURE_PRESENT

#define NRFX_FEATURE_PRESENT	(		periph_name,
			feature_name
	)

Value:

 NRFX_COND_CODE_0(NRFX_CONCAT(0, \
 _NRFX_FEATURE_PRESENT(periph_name, feature_name, 256), \
 _NRFX_FEATURE_PRESENT(NRFX_CONCAT(periph_name, 0), feature_name, 100), \
 _NRFX_FEATURE_PRESENT(NRFX_CONCAT(periph_name, 00), feature_name, 10) \
 ), \
 (0), (1))

Macro for checking whether any of the instance of the specified peripheral supports a given feature.

Macro checks flags set in <device>_peripherals.h file.

Macro supports check on instances with following names:

• <periph_name>0 - <periph_name>255 - e.g. SPIM0, SPIM255
• <periph_name>00 - <periph_name>099 - e.g. SPIM00, SPIM099
• <periph_name>000 - <periph_name>009 - e.g. SPIM000, SPIM009

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	feature_name	Feature flag name suffix following an instance name, e.g. _FEATURE_HARDWARE_CSN_PRESENT.

Return values

1	At least one instance on current device supports a given feature.
0	None of peripheral instances supports a given feature.

NRFX_FOREACH_ENABLED

#define NRFX_FOREACH_ENABLED	(		periph_name,
			macro,
			sep,
			off_code,
			...
	)

Value:

 NRFX_LISTIFY(256, _NRFX_EVAL_IF_ENABLED, sep, \
 off_code, periph_name, , macro, __VA_ARGS__) NRFX_DEBRACKET sep \
 NRFX_LISTIFY(100, _NRFX_EVAL_IF_ENABLED, sep, \
 off_code, periph_name, 0, macro, __VA_ARGS__) NRFX_DEBRACKET sep \
 NRFX_LISTIFY(10, _NRFX_EVAL_IF_ENABLED, sep, \
 off_code, periph_name, 00, macro, __VA_ARGS__)

Macro for resolving provided user macro for enabled instances of a driver.

Macro checks if driver instances are enabled for all potential instaces of a peripheral. It takes peripheral name and checks whether NRFX_<peripheral><id>_ENABLED is set to 1 and if yes then provided macro is evaluated for given instance.

Macro supports check on instances with following names:

• <periph_name>0 - <periph_name>255 - e.g. SPIM0, SPIM255
• <periph_name>00 - <periph_name>099 - e.g. SPIM00, SPIM099
• <periph_name>000 - <periph_name>009 - e.g. SPIM000, SPIM009

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	macro	Macro which is resolved if driver instance is enabled. Macro has following arguments: macro(periph_name, prefix, i, ...).
[in]	sep	Separator added between all evaluations, in parentheses.
[in]	off_code	Code injected for disabled instances, in parentheses.

NRFX_FOREACH_PRESENT

#define NRFX_FOREACH_PRESENT	(		periph_name,
			macro,
			sep,
			off_code,
			...
	)

Value:

 NRFX_LISTIFY(256, _NRFX_EVAL_IF_PRESENT, sep, \
 off_code, periph_name, , macro, __VA_ARGS__) NRFX_DEBRACKET sep \
 NRFX_LISTIFY(100, _NRFX_EVAL_IF_PRESENT, sep, \
 off_code, periph_name, 0, macro, __VA_ARGS__) NRFX_DEBRACKET sep \
 NRFX_LISTIFY(10, _NRFX_EVAL_IF_PRESENT, sep, \
 off_code, periph_name, 00, macro, __VA_ARGS__) NRFX_DEBRACKET sep \
 _NRFX_EVAL_IF_PRESENT(, off_code, periph_name, , macro, __VA_ARGS__)

Macro for resolving provided user macro for present instances of a peripheral.

Macro checks if peripheral instances are present by checking if there is a token NRF_<periph_name><id> defined with wrapped in parenthesis value.

Macro supports check on instances with following names:

• <periph_name>0 - <periph_name>255 - e.g. SPIM0, SPIM255
• <periph_name>00 - <periph_name>099 - e.g. SPIM00, SPIM099
• <periph_name>000 - <periph_name>009 - e.g. SPIM000, SPIM009
• <periph_name> - e.g. SPIM

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	macro	Macro which is resolved if peripheral instance is present. Macro has following arguments: macro(periph_name, prefix, i, ...).
[in]	sep	Separator added between all evaluations, in parentheses.
[in]	off_code	Code injected for disabled instances, in parentheses.

NRFX_IN_RANGE

#define NRFX_IN_RANGE	(		val,
			min,
			max
	)		((val) >= (min) && (val) <= (max))

Macro for checking if a given value is in a given range.

Note

val is evaluated twice.

Parameters

[in]	val	A value to be checked.
[in]	min	The lower bound (inclusive).
[in]	max	The upper bound (inclusive).

Return values

true	The value is in the given range.
false	The value is out of the given range.

NRFX_INSTANCE_CONCAT

#define NRFX_INSTANCE_CONCAT	(		periph_name,
			prefix,
			i,
			macro,
			...
	)		macro(NRFX_CONCAT(periph_name, prefix, i), __VA_ARGS__)

Macro for resolving provided user macro on concatenated peripheral name and instance index.

Execute provided macro with single argument <instance> that is the concatenation of periph_name, prefix and i.

Parameters

[in]	i	Instance index.
[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	prefix	Prefix added before instance index, e.g. some device has instances named like SPIM00. First 0 is passed here as prefix.
[in]	macro	Macro which is executed.
[in]	...	Variable length arguments passed to the macro. Macro has following arguments: macro(instance, ...).

NRFX_INSTANCE_ENUM_LIST

#define NRFX_INSTANCE_ENUM_LIST

(

periph_name

)

NRFX_FOREACH_ENABLED(periph_name, _NRFX_INST_ENUM, (), ())

Macro for creating a content for enum which is listing enabled driver instances.

It creates comma separated list of entries like NRFX_<instance_name>INST_IDX, e.g. (NRFX_SPIM0_INST_IDX) for all enabled instances (NRFX<instance_name>_ENABLED is set to 1). It should be called within enum declaration. Created enum is used by the driver to index all enabled instances of the driver.

Parameters

[in]

periph_name

Peripheral name (e.g. SPIM).

NRFX_INSTANCE_IRQ_HANDLERS

#define NRFX_INSTANCE_IRQ_HANDLERS	(		periph_name,
			periph_name_small
	)		NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER, (), (), periph_name_small)

Macro for creating an interrupt handler for all enabled driver instances.

Macro creates a set of functions which calls generic irq_handler function with two parameters:

• peripheral instance register pointer
• pointer to a control block structure associated with the given instance

Generic interrupt handler function with above mentioned parameters named irq_handler must be implemented in the driver.

Note

Handlers are using enum which should be generated using NRFX_INSTANCE_ENUM_LIST.

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	periph_name_small	Peripheral name written with small letters, e.g. spim.

NRFX_INSTANCE_IRQ_HANDLERS_DECLARE

#define NRFX_INSTANCE_IRQ_HANDLERS_DECLARE	(		periph_name,
			periph_name_small
	)		NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER_DECLARE, (), (), periph_name_small)

Macro for declaring an interrupt handler for all enabled driver instances.

Macro creates set of function declarations. It is intended to be used in the driver header.

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	periph_name_small	Peripheral name written with small letters, e.g. spim.

NRFX_INSTANCE_IRQ_HANDLERS_EXT

#define NRFX_INSTANCE_IRQ_HANDLERS_EXT	(		periph_name,
			periph_name_small,
			ext_macro
	)		NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER_EXT, (), (), periph_name_small, ext_macro)

Macro for creating an interrupt handler for all enabled driver instances with the specified extra parameter.

Macro creates set of function which calls generic irq_handler function with three parameters:

• peripheral instance register pointer
• pointer to a control block structure associated with the given instance
• provided ext_macro called with peripheral name suffix (e.g. 01 for TIMER01)

Generic interrupt handler function with above mentioned parameters named irq_handler must be implemented in the driver.

Note

Handlers are using enum which should be generated using NRFX_INSTANCE_ENUM_LIST.

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	periph_name_small	Peripheral name written with small letters, e.g. rtc.
[in]	ext_macro	External macro to be executed for each instance.

NRFX_INSTANCE_IRQ_HANDLERS_LIST

#define NRFX_INSTANCE_IRQ_HANDLERS_LIST	(		periph_name,
			periph_name_small
	)		NRFX_FOREACH_ENABLED(periph_name, _NRFX_IRQ_HANDLER_LIST, (), (), periph_name_small)

Macro for generating comma-separated list of interrupt handlers for all enabled driver instances.

Interrupt handlers are generated using NRFX_INSTANCE_IRQ_HANDLERS. It is intended to be used to create a list which is used for passing an interrupt handler function to the PRS driver.

Parameters

[in]	periph_name	Peripheral name, e.g. SPIM.
[in]	periph_name_small	Peripheral name written with small letters, e.g. spim.

NRFX_INSTANCE_PRESENT

#define NRFX_INSTANCE_PRESENT

(

_inst

)

NRFX_ARG_HAS_PARENTHESIS(NRFX_CONCAT(NRF_, _inst))

Macro for checking if given peripheral instance is present on the target.

Macro utilizes the fact that for each existing instance a define is created which points to the memory mapped register set casted to a register set structure. It is wrapped in parenthesis and existance of parethesis wrapping is used to determine if instance exists. It if does not exist then token (e.g. NRF_SPIM10) is undefined so it does not have parenthesis wrapping.

Since macro returns literal 1 it can be used by other macros.

Parameters

[in]

_inst

Instance, .e.g SPIM10.

Return values

1	If instance is present.
0	If instance is not present.

NRFX_IRQ_NUMBER_GET

#define NRFX_IRQ_NUMBER_GET

(

base_addr

)

NRFX_PERIPHERAL_ID_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

[in]

base_addr

Peripheral base address or pointer.

Returns

Interrupt number associated with the specified peripheral.

NRFX_IS_EVEN

#define NRFX_IS_EVEN

(

val

)

(((val) % 2) == 0)

Macro for checking whether a given number is even.

Parameters

[in]

val

Tested value.

Return values

true	The value is even.
false	The value is odd.

NRFX_IS_POWER_OF_TWO

#define NRFX_IS_POWER_OF_TWO

(

val

)

(((val) != 0) && ((val) & ((val) - 1)) == 0)

Macro for checking whether given number is power of 2.

Parameters

[in]

val

Tested value.

Return values

true	The value is power of 2.
false	The value is not power of 2.

NRFX_KHZ_TO_HZ

#define NRFX_KHZ_TO_HZ

(

freq

)

((freq) * 1000)

Macro for converting frequency in kHz to Hz.

Parameters

[in]

freq

Frequency value in kHz.

Returns

Number of Hz in freq kHz.

NRFX_MAX

#define NRFX_MAX	(		a,
			b
	)		((a) > (b) ? (a) : (b))

Macro for getting the larger value between two arguments.

Parameters

[in]	a	First argument.
[in]	b	Second argument.

Returns

Larger value between two arguments.

NRFX_MHZ_TO_HZ

#define NRFX_MHZ_TO_HZ

(

freq

)

((freq) * 1000 * 1000)

Macro for converting frequency in MHz to Hz.

Parameters

[in]

freq

Frequency value in MHz.

Returns

Number of Hz in freq MHz.

NRFX_MIN

#define NRFX_MIN	(		a,
			b
	)		((a) < (b) ? (a) : (b))

Macro for getting the smaller value between two arguments.

Parameters

[in]	a	First argument.
[in]	b	Second argument.

Returns

Smaller value between two arguments.

NRFX_OFFSETOF

#define NRFX_OFFSETOF	(		type,
			member
	)		((size_t) & (((type *)0)->member))

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

Parameters

[in]	type	Structure type.
[in]	member	Structure member whose offset is searched for.

Returns

Member offset in bytes.

NRFX_PERIPHERAL_ID_GET

#define NRFX_PERIPHERAL_ID_GET

(

base_addr

)

(uint16_t)(((uint32_t)(base_addr) >> 12) & 0x000001FF)

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

[in]

base_addr

Peripheral base address or pointer.

Returns

ID number associated with the specified peripheral.

NRFX_ROUNDED_DIV

#define NRFX_ROUNDED_DIV	(		a,
			b
	)		((((a) < 0) ^ ((b) < 0)) ? (((a) - (b) / 2) / (b)) : (((a) + (b) / 2) / (b)))

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

Parameters

[in]	a	Numerator.
[in]	b	Denominator.

Returns

Rounded (integer) result of dividing a by b.

NRFX_WAIT_FOR

#define NRFX_WAIT_FOR	(		condition,
			attempts,
			delay_us,
			result
	)

Value:

do { \
 result = false; \
 uint32_t remaining_attempts = (attempts); \
 do { \
 if (condition) \
 { \
 result = true; \
 break; \
 } \
 NRFX_DELAY_US(delay_us); \
 } while (--remaining_attempts); \
} while(0)

Macro for waiting until condition is met.

Parameters

[in]	condition	Condition to meet.
[in]	attempts	Maximum number of condition checks. Must not be 0.
[in]	delay_us	Delay between consecutive checks, in microseconds.
[out]	result	Boolean variable to store the result of the wait process. Set to true if the condition is met or false otherwise.

Enumeration Type Documentation

nrfx_drv_state_t

enum nrfx_drv_state_t

Driver state.

Enumerator
NRFX_DRV_STATE_UNINITIALIZED	Uninitialized.
NRFX_DRV_STATE_INITIALIZED	Initialized but powered off.
NRFX_DRV_STATE_POWERED_ON	Initialized and powered on.

Function Documentation

nrfx_bitpos_to_event()

__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).

Parameters

[in]

bit

INTEN register bit position.

Returns

Event identifier.

See also

nrfx_event_to_bitpos

nrfx_event_to_bitpos()

__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).

Parameters

[in]

event

Event identifier.

Returns

INTEN register bit position.

See also

nrfx_bitpos_to_event

nrfx_get_irq_number()

__STATIC_INLINE IRQn_Type nrfx_get_irq_number

(

void const *

p_reg

)

Function for getting the interrupt number for the specified peripheral.

Parameters

[in]

p_reg

Peripheral base pointer.

Returns

Interrupt number associated with the pointed peripheral.

nrfx_is_in_ram()

__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

[in]

p_object

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.

nrfx_is_word_aligned()

__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

[in]

p_object

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.