nrfx_glue.h

This file contains macros that should be implemented according to the needs of the host environment into which nrfx is integrated. More...

Macros
#define	NRFX_ASSERT(expression)
	Macro for placing a runtime assertion.
#define	NRFX_STATIC_ASSERT(expression)
	Macro for placing a compile time assertion.
#define	NRFX_IRQ_PRIORITY_SET(irq_number, priority)
	Macro for setting the priority of a specific IRQ.
#define	NRFX_IRQ_ENABLE(irq_number)
	Macro for enabling a specific IRQ.
#define	NRFX_IRQ_IS_ENABLED(irq_number)
	Macro for checking if a specific IRQ is enabled.
#define	NRFX_IRQ_DISABLE(irq_number)
	Macro for disabling a specific IRQ.
#define	NRFX_IRQ_PENDING_SET(irq_number)
	Macro for setting a specific IRQ as pending.
#define	NRFX_IRQ_PENDING_CLEAR(irq_number)
	Macro for clearing the pending status of a specific IRQ.
#define	NRFX_IRQ_IS_PENDING(irq_number)
	Macro for checking the pending status of a specific IRQ.
#define	NRFX_CRITICAL_SECTION_ENTER()
	Macro for entering into a critical section.
#define	NRFX_CRITICAL_SECTION_EXIT()
	Macro for exiting from a critical section.
#define	NRFX_COREDEP_DELAY_DWT_BASED   0
	When set to a non-zero value, this macro specifies that nrfx_coredep_delay_us uses a precise DWT-based solution. A compilation error is generated if the DWT unit is not present in the SoC used.
#define	NRFX_DELAY_US(us_time)
	Macro for delaying the code execution for at least the specified time.
#define	nrfx_atomic_t
	Atomic 32-bit unsigned type.
#define	NRFX_ATOMIC_FETCH_STORE(p_data, value)
	Macro for storing a value to an atomic object and returning its previous value.
#define	NRFX_ATOMIC_FETCH_OR(p_data, value)
	Macro for running a bitwise OR operation on an atomic object and returning its previous value.
#define	NRFX_ATOMIC_FETCH_AND(p_data, value)
	Macro for running a bitwise AND operation on an atomic object and returning its previous value.
#define	NRFX_ATOMIC_FETCH_XOR(p_data, value)
	Macro for running a bitwise XOR operation on an atomic object and returning its previous value.
#define	NRFX_ATOMIC_FETCH_ADD(p_data, value)
	Macro for running an addition operation on an atomic object and returning its previous value.
#define	NRFX_ATOMIC_FETCH_SUB(p_data, value)
	Macro for running a subtraction operation on an atomic object and returning its previous value.
#define	NRFX_ATOMIC_CAS(p_data, old_value, new_value)
	Macro for running compare and swap on an atomic object.
#define	NRFX_CLZ(value)
	Macro for counting leading zeros.
#define	NRFX_CTZ(value)
	Macro for counting trailing zeros.
#define	NRFX_EVENT_READBACK_ENABLED   1
	When set to a non-zero value, this macro specifies that inside HALs the event registers are read back after clearing, on devices that otherwise could defer the actual register modification.
#define	NRFY_CACHE_WB(p_buffer, size)
	Macro for writing back cache lines associated with the specified buffer.
#define	NRFY_CACHE_INV(p_buffer, size)
	Macro for invalidating cache lines associated with the specified buffer.
#define	NRFY_CACHE_WBINV(p_buffer, size)
	Macro for writing back and invalidating cache lines associated with the specified buffer.
#define	NRFX_DPPI_CHANNELS_USED   0
	Bitmask that defines DPPI channels that are reserved for use outside of the nrfx library.
#define	NRFX_DPPI_GROUPS_USED   0
	Bitmask that defines DPPI groups that are reserved for use outside of the nrfx library.
#define	NRFX_PPI_CHANNELS_USED   0
	Bitmask that defines PPI channels that are reserved for use outside of the nrfx library.
#define	NRFX_PPI_GROUPS_USED   0
	Bitmask that defines PPI groups that are reserved for use outside of the nrfx library.
#define	NRFX_GPIOTE_CHANNELS_USED   0
	Bitmask that defines GPIOTE channels that are reserved for use outside of the nrfx library.
#define	NRFX_EGUS_USED   0
	Bitmask that defines EGU instances that are reserved for use outside of the nrfx library.
#define	NRFX_TIMERS_USED   0
	Bitmask that defines TIMER instances that are reserved for use outside of the nrfx library.

Detailed Description

This file contains macros that should be implemented according to the needs of the host environment into which nrfx is integrated.

Macro Definition Documentation

NRFX_ASSERT

#define NRFX_ASSERT

(

expression

)

Macro for placing a runtime assertion.

Parameters

expression

Expression to be evaluated.

NRFX_ATOMIC_CAS

#define NRFX_ATOMIC_CAS	(		p_data,
			old_value,
			new_value )

Macro for running compare and swap on an atomic object.

Value is updated to the new value only if it previously equaled old value.

Parameters

[in,out]	p_data	Atomic memory pointer.
[in]	old_value	Expected old value.
[in]	new_value	New value.

Return values

true	If value was updated.
false	If value was not updated because location was not equal to old_value.

NRFX_ATOMIC_FETCH_ADD

#define NRFX_ATOMIC_FETCH_ADD	(		p_data,
			value )

Macro for running an addition operation on an atomic object and returning its previous value.

Parameters

[in]	p_data	Atomic memory pointer.
[in]	value	Value of the second operand in the ADD operation.

Returns

Previous value of the atomic object.

NRFX_ATOMIC_FETCH_AND

#define NRFX_ATOMIC_FETCH_AND	(		p_data,
			value )

Macro for running a bitwise AND operation on an atomic object and returning its previous value.

Parameters

[in]	p_data	Atomic memory pointer.
[in]	value	Value of the second operand in the AND operation.

Returns

Previous value of the atomic object.

NRFX_ATOMIC_FETCH_OR

#define NRFX_ATOMIC_FETCH_OR	(		p_data,
			value )

Macro for running a bitwise OR operation on an atomic object and returning its previous value.

Parameters

[in]	p_data	Atomic memory pointer.
[in]	value	Value of the second operand in the OR operation.

Returns

Previous value of the atomic object.

NRFX_ATOMIC_FETCH_STORE

#define NRFX_ATOMIC_FETCH_STORE	(		p_data,
			value )

Macro for storing a value to an atomic object and returning its previous value.

Parameters

[in]	p_data	Atomic memory pointer.
[in]	value	Value to store.

Returns

Previous value of the atomic object.

NRFX_ATOMIC_FETCH_SUB

#define NRFX_ATOMIC_FETCH_SUB	(		p_data,
			value )

Macro for running a subtraction operation on an atomic object and returning its previous value.

Parameters

[in]	p_data	Atomic memory pointer.
[in]	value	Value of the second operand in the SUB operation.

Returns

Previous value of the atomic object.

NRFX_ATOMIC_FETCH_XOR

#define NRFX_ATOMIC_FETCH_XOR	(		p_data,
			value )

Macro for running a bitwise XOR operation on an atomic object and returning its previous value.

Parameters

[in]	p_data	Atomic memory pointer.
[in]	value	Value of the second operand in the XOR operation.

Returns

Previous value of the atomic object.

NRFX_CLZ

#define NRFX_CLZ

(

value

)

Macro for counting leading zeros.

Parameters

[in]

value

A word value.

Returns

Number of leading 0-bits in value, starting at the most significant bit position. If x is 0, the result is undefined.

NRFX_CTZ

#define NRFX_CTZ

(

value

)

Macro for counting trailing zeros.

Parameters

[in]

value

A word value.

Returns

Number of trailing 0-bits in value, starting at the least significant bit position. If x is 0, the result is undefined.

NRFX_DELAY_US

#define NRFX_DELAY_US

(

us_time

)

Macro for delaying the code execution for at least the specified time.

Parameters

us_time

Number of microseconds to wait.

NRFX_IRQ_DISABLE

#define NRFX_IRQ_DISABLE

(

irq_number

)

Macro for disabling a specific IRQ.

Parameters

irq_number

IRQ number.

NRFX_IRQ_ENABLE

#define NRFX_IRQ_ENABLE

(

irq_number

)

Macro for enabling a specific IRQ.

Parameters

irq_number

IRQ number.

NRFX_IRQ_IS_ENABLED

#define NRFX_IRQ_IS_ENABLED

(

irq_number

)

Macro for checking if a specific IRQ is enabled.

Parameters

irq_number

IRQ number.

Return values

true	If the IRQ is enabled.
false	Otherwise.

NRFX_IRQ_IS_PENDING

#define NRFX_IRQ_IS_PENDING

(

irq_number

)

Macro for checking the pending status of a specific IRQ.

Return values

true	If the IRQ is pending.
false	Otherwise.

NRFX_IRQ_PENDING_CLEAR

#define NRFX_IRQ_PENDING_CLEAR

(

irq_number

)

Macro for clearing the pending status of a specific IRQ.

Parameters

irq_number

IRQ number.

NRFX_IRQ_PENDING_SET

#define NRFX_IRQ_PENDING_SET

(

irq_number

)

Macro for setting a specific IRQ as pending.

Parameters

irq_number

IRQ number.

NRFX_IRQ_PRIORITY_SET

#define NRFX_IRQ_PRIORITY_SET	(		irq_number,
			priority )

Macro for setting the priority of a specific IRQ.

Parameters

irq_number	IRQ number.
priority	Priority to be set.

NRFX_STATIC_ASSERT

#define NRFX_STATIC_ASSERT

(

expression

)

Macro for placing a compile time assertion.

Parameters

expression

Expression to be evaluated.

NRFY_CACHE_INV

#define NRFY_CACHE_INV	(		p_buffer,
			size )

Macro for invalidating cache lines associated with the specified buffer.

Note

Macro should be empty if data cache is disabled or not present.

Parameters

[in]	p_buffer	Pointer to the buffer.
[in]	size	Size of the buffer.

NRFY_CACHE_WB

#define NRFY_CACHE_WB	(		p_buffer,
			size )

Macro for writing back cache lines associated with the specified buffer.

Note

Macro should be empty if data cache is disabled or not present.

Parameters

[in]	p_buffer	Pointer to the buffer.
[in]	size	Size of the buffer.

NRFY_CACHE_WBINV

#define NRFY_CACHE_WBINV	(		p_buffer,
			size )

Macro for writing back and invalidating cache lines associated with the specified buffer.

Note

Macro should be empty if data cache is disabled or not present.

Parameters

[in]	p_buffer	Pointer to the buffer.
[in]	size	Size of the buffer.