Generic inter-domain signalling layer.

Helper layer that provides the common functionality for the inter-domain signalling (IDS) mechanisms. More...

Data Structures
struct	nrfx_ids_t
	Structure for the IDS instance. More...

Macros
#define	NRFX_IDS_INSTANCE(id)
	Macro for creating a IDS instance.
#define	NRFX_IDS_CHANNEL(channel)
	Macro for creating channel bitmask associated with specified channel index.

Typedefs
typedef void(*	nrfx_ids_event_handler_t) (uint8_t event_idx, void *p_context)
	IDS event handler callback.

Enumerations
enum	nrfx_ids_domain_t {   NRFX_IDS_DOMAIN_SEC = 1 ,   NRFX_IDS_DOMAIN_APP = NRF_PROCESSOR_APPLICATION ,   NRFX_IDS_DOMAIN_SYSC = 12 ,   NRFX_IDS_DOMAIN_PPR = NRF_PROCESSOR_PPR ,   NRFX_IDS_DOMAIN_FLPR = NRF_PROCESSOR_FLPR }
	IDS domains. More...

Functions
__STATIC_INLINE int	nrfx_ids_init (nrfx_ids_t *p_instance, uint8_t interrupt_priority, nrfx_ids_event_handler_t event_handler, void *p_context, void const *p_config)
	Symbol specifying maximum number of available events triggered.
__STATIC_INLINE void	nrfx_ids_uninit (nrfx_ids_t *p_instance)
	Function for uninitializing the IDS instance.
__STATIC_INLINE void	nrfx_ids_int_enable (nrfx_ids_t const *p_instance, uint32_t mask)
	Function for enabling specified interrupts in the IDS instance.
__STATIC_INLINE void	nrfx_ids_int_disable (nrfx_ids_t const *p_instance, uint32_t mask)
	Function for disabling interrupt in the IDS instance.
__STATIC_INLINE void	nrfx_ids_signal (nrfx_ids_t *p_instance, nrfx_ids_domain_t domain, uint8_t channel)
	Function for conveying the inter-domain signal to the specified domain.

Detailed Description

Helper layer that provides the common functionality for the inter-domain signalling (IDS) mechanisms.

Macro Definition Documentation

NRFX_IDS_CHANNEL

#define NRFX_IDS_CHANNEL

(

channel

)

Value:

(0x1UL << (channel))

Macro for creating channel bitmask associated with specified channel index.

NRFX_IDS_INSTANCE

#define NRFX_IDS_INSTANCE

(

id

)

Value:

{                                                           \
    .drv_inst_idx = NRFX_CONCAT_3(NRFX_IDS, id, _INST_IDX), \
    .int_idx      = id,                                     \
}

Macro for creating a IDS instance.

Typedef Documentation

nrfx_ids_event_handler_t

typedef void(* nrfx_ids_event_handler_t) (uint8_t event_idx, void *p_context)

IDS event handler callback.

Parameters

[in]	event_idx	IDS event index.
[in]	p_context	User context.

Enumeration Type Documentation

nrfx_ids_domain_t

enum nrfx_ids_domain_t

IDS domains.

Enumerator
NRFX_IDS_DOMAIN_SEC	Reserved. *‍/.
NRFX_IDS_DOMAIN_APP	Application domain. *‍/.
NRFX_IDS_DOMAIN_SYSC	Reserved. *‍/.
NRFX_IDS_DOMAIN_PPR	Peripheral Processor *‍/.
NRFX_IDS_DOMAIN_FLPR	Fast Lightweight Processor *‍/.

Function Documentation

nrfx_ids_init()

__STATIC_INLINE int nrfx_ids_init	(	nrfx_ids_t *	p_instance,
		uint8_t	interrupt_priority,
		nrfx_ids_event_handler_t	event_handler,
		void *	p_context,
		void const *	p_config )

Symbol specifying maximum number of available events triggered.

Function for initializing the IDS instance.

Parameters

[in]	p_instance	Pointer to IDS instance.
[in]	interrupt_priority	Interrupt priority.
[in]	event_handler	Function to be called on interrupt.
[in]	p_context	Context passed to the event handler.
[in]	p_config	Pointer to the structure containing peripheral-specific configuration. Can be NULL.

Return values

0	Driver successfully initialized.
-EALREADY	Driver already initialized.

nrfx_ids_int_disable()

__STATIC_INLINE void nrfx_ids_int_disable	(	nrfx_ids_t const *	p_instance,
		uint32_t	mask )

Function for disabling interrupt in the IDS instance.

Parameters

[in]	p_instance	Pointer to IDS instance.
[in]	mask	Mask of interrupts to be disabled.

nrfx_ids_int_enable()

__STATIC_INLINE void nrfx_ids_int_enable	(	nrfx_ids_t const *	p_instance,
		uint32_t	mask )

Function for enabling specified interrupts in the IDS instance.

Parameters

[in]	p_instance	Pointer to IDS instance.
[in]	mask	Mask of interrupts to be enabled.

nrfx_ids_signal()

__STATIC_INLINE void nrfx_ids_signal	(	nrfx_ids_t *	p_instance,
		nrfx_ids_domain_t	domain,
		uint8_t	channel )

Function for conveying the inter-domain signal to the specified domain.

Parameters

[in]	p_instance	Pointer to IDS instance.
[in]	domain	Domain to be signalled. May be NULL for peripherals that have only one connection.
[in]	channel	Inter-domain channel for conveying the signal.

nrfx_ids_uninit()

__STATIC_INLINE void nrfx_ids_uninit

(

nrfx_ids_t *

p_instance

)

Function for uninitializing the IDS instance.

Parameters

[in]

p_instance

Pointer to IDS instance.