Hardware access layer for managing the Control Access Port (CTRL-AP) peripheral. More...

Data Structures
struct	nrf_ctrlap_info_t
	CTRLAP device information. More...

Enumerations
enum	nrf_ctrlap_event_t { NRF_CTRLAP_EVENT_RXREADY = offsetof(NRF_CTRLAPPERI_Type, EVENTS_RXREADY) , NRF_CTRLAP_EVENT_TXDONE = offsetof(NRF_CTRLAPPERI_Type, EVENTS_TXDONE) }
	CTRLAP events. More...

enum	nrf_ctrlap_int_mask_t { NRF_CTRLAP_INT_RXREADY_MASK = CTRLAPPERI_INTENSET_RXREADY_Msk , NRF_CTRLAP_INT_TXDONE_MASK = CTRLAPPERI_INTENSET_TXDONE_Msk }
	CTRLAP interrupts. More...

enum	nrf_ctrlap_bootmode_t { NRF_CTRLAP_MODE_NORMAL = CTRLAPPERI_MAILBOX_BOOTMODE_MODE_Normal , NRF_CTRLAP_MODE_ROM_OPERATION = CTRLAPPERI_MAILBOX_BOOTMODE_MODE_ROMOperation }
	CTRLAP secure domain boot mode. More...

Functions
NRF_STATIC_INLINE void	nrf_ctrlap_event_clear (NRF_CTRLAPPERI_Type *p_reg, nrf_ctrlap_event_t event)
	Function for clearing the specified CTRLAP event.

NRF_STATIC_INLINE bool	nrf_ctrlap_event_check (NRF_CTRLAPPERI_Type const *p_reg, nrf_ctrlap_event_t event)
	Function for retrieving the state of the CTRLAP event.

NRF_STATIC_INLINE uint32_t	nrf_ctrlap_event_address_get (NRF_CTRLAPPERI_Type const *p_reg, nrf_ctrlap_event_t event)
	Function for getting the address of the specified CTRLAP event register.

NRF_STATIC_INLINE void	nrf_ctrlap_int_enable (NRF_CTRLAPPERI_Type *p_reg, uint32_t mask)
	Function for enabling the specified interrupts.

NRF_STATIC_INLINE void	nrf_ctrlap_int_disable (NRF_CTRLAPPERI_Type *p_reg, uint32_t mask)
	Function for disabling the specified interrupts.

NRF_STATIC_INLINE uint32_t	nrf_ctrlap_int_enable_check (NRF_CTRLAPPERI_Type const *p_reg, uint32_t mask)
	Function for checking if the specified interrupts are enabled.

NRF_STATIC_INLINE uint32_t	nrf_ctrlap_int_pending_get (NRF_CTRLAPPERI_Type const *p_reg)
	Function for retrieving the state of pending interrupts.

NRF_STATIC_INLINE uint32_t	nrf_ctrlap_mailbox_rxdata_get (NRF_CTRLAPPERI_Type const *p_reg)
	Function for reading data sent from the debugger to the CPU.

NRF_STATIC_INLINE bool	nrf_ctrlap_mailbox_rxstatus_pending_check (NRF_CTRLAPPERI_Type const *p_reg)
	Function for checking if data sent from the debugger to the CPU has been read.

NRF_STATIC_INLINE uint32_t	nrf_ctrlap_mailbox_txdata_get (NRF_CTRLAPPERI_Type const *p_reg)
	Function for reading data sent from CPU to debugger.

NRF_STATIC_INLINE void	nrf_ctrlap_mailbox_txdata_set (NRF_CTRLAPPERI_Type *p_reg, uint32_t data)
	Function for writing data sent from CPU to debugger.

NRF_STATIC_INLINE bool	nrf_ctrlap_mailbox_txstatus_pending_check (NRF_CTRLAPPERI_Type const *p_reg)
	Function for checking if data sent from the CPU to the debugger has been read.

NRF_STATIC_INLINE nrf_ctrlap_bootmode_t	nrf_ctrlap_mailbox_bootmode_get (NRF_CTRLAPPERI_Type const *p_reg)
	Function for checking boot mode.

NRF_STATIC_INLINE void	nrf_ctrlap_info_set (NRF_CTRLAPPERI_Type p_reg, nrf_ctrlap_info_t const p_data)
	Function for setting the CTRLAP device information.

NRF_STATIC_INLINE void	nrf_ctrlap_info_get (NRF_CTRLAPPERI_Type const p_reg, nrf_ctrlap_info_t p_data)
	Function for getting the CTRLAP device information.

Detailed Description

Hardware access layer for managing the Control Access Port (CTRL-AP) peripheral.

Enumeration Type Documentation

◆ nrf_ctrlap_bootmode_t

enum nrf_ctrlap_bootmode_t

CTRLAP secure domain boot mode.

Enumerator
NRF_CTRLAP_MODE_NORMAL	Normal mode of operation.
NRF_CTRLAP_MODE_ROM_OPERATION	ROM operation mode.

◆ nrf_ctrlap_event_t

enum nrf_ctrlap_event_t

CTRLAP events.

Enumerator
NRF_CTRLAP_EVENT_RXREADY	New data from the peer is available.
NRF_CTRLAP_EVENT_TXDONE	Data has been read by the peer.

◆ nrf_ctrlap_int_mask_t

enum nrf_ctrlap_int_mask_t

CTRLAP interrupts.

Enumerator
NRF_CTRLAP_INT_RXREADY_MASK	Interrupt on RXREADY event.
NRF_CTRLAP_INT_TXDONE_MASK	Interrupt on TXDONE event.

Function Documentation

◆ nrf_ctrlap_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_ctrlap_event_address_get	(	NRF_CTRLAPPERI_Type const *	p_reg,
		nrf_ctrlap_event_t	event
	)

Function for getting the address of the specified CTRLAP event register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Requested event.

Return values

Address of the specified event register.

◆ nrf_ctrlap_event_check()

NRF_STATIC_INLINE bool nrf_ctrlap_event_check	(	NRF_CTRLAPPERI_Type const *	p_reg,
		nrf_ctrlap_event_t	event
	)

Function for retrieving the state of the CTRLAP event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be checked.

Return values

true	The event has been generated.
false	The event has not been generated.

◆ nrf_ctrlap_event_clear()

NRF_STATIC_INLINE void nrf_ctrlap_event_clear	(	NRF_CTRLAPPERI_Type *	p_reg,
		nrf_ctrlap_event_t	event
	)

Function for clearing the specified CTRLAP event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to clear.

◆ nrf_ctrlap_info_get()

NRF_STATIC_INLINE void nrf_ctrlap_info_get	(	NRF_CTRLAPPERI_Type const *	p_reg,
		nrf_ctrlap_info_t *	p_data
	)

Function for getting the CTRLAP device information.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[out]	p_data	Pointer to the data structure to be filled with device information.

◆ nrf_ctrlap_info_set()

NRF_STATIC_INLINE void nrf_ctrlap_info_set	(	NRF_CTRLAPPERI_Type *	p_reg,
		nrf_ctrlap_info_t const *	p_data
	)

Function for setting the CTRLAP device information.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	p_data	Pointer to the device information structure.

◆ nrf_ctrlap_int_disable()

NRF_STATIC_INLINE void nrf_ctrlap_int_disable	(	NRF_CTRLAPPERI_Type *	p_reg,
		uint32_t	mask
	)

Function for disabling the specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be disabled. Use nrf_ctrlap_int_mask_t values for bit masking.

◆ nrf_ctrlap_int_enable()

NRF_STATIC_INLINE void nrf_ctrlap_int_enable	(	NRF_CTRLAPPERI_Type *	p_reg,
		uint32_t	mask
	)

Function for enabling the specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be enabled. Use nrf_ctrlap_int_mask_t values for bit masking.

◆ nrf_ctrlap_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_ctrlap_int_enable_check	(	NRF_CTRLAPPERI_Type const *	p_reg,
		uint32_t	mask
	)

Function for checking if the specified interrupts are enabled.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be checked. Use nrf_ctrlap_int_mask_t values for bit masking.

Return values

Mask	of enabled interrupts.

◆ nrf_ctrlap_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_ctrlap_int_pending_get ( NRF_CTRLAPPERI_Type const * p_reg )

Function for retrieving the state of pending interrupts.

Note: States of pending interrupt are saved as a bitmask. One set at particular position means that interrupt for event is pending.

Parameters

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

Return values

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

◆ nrf_ctrlap_mailbox_bootmode_get()

NRF_STATIC_INLINE nrf_ctrlap_bootmode_t nrf_ctrlap_mailbox_bootmode_get ( NRF_CTRLAPPERI_Type const * p_reg )

Function for checking boot mode.

Note: If ROM operation mode is set the MAILBOX is used to communicate the secure ROM operations.

Parameters

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

Returns: Boot mode.

◆ nrf_ctrlap_mailbox_rxdata_get()

NRF_STATIC_INLINE uint32_t nrf_ctrlap_mailbox_rxdata_get ( NRF_CTRLAPPERI_Type const * p_reg )

Function for reading data sent from the debugger to the CPU.

Note: Reading from this register will clear pending status of RX.

Parameters

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

Return values

Data	sent from the debugger to the CPU.

◆ nrf_ctrlap_mailbox_rxstatus_pending_check()

NRF_STATIC_INLINE bool nrf_ctrlap_mailbox_rxstatus_pending_check ( NRF_CTRLAPPERI_Type const * p_reg )

Function for checking if data sent from the debugger to the CPU has been read.

Parameters

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

Return values

true	Data pending in register RXDATA.
false	No data pending in register RXDATA.

◆ nrf_ctrlap_mailbox_txdata_get()

NRF_STATIC_INLINE uint32_t nrf_ctrlap_mailbox_txdata_get ( NRF_CTRLAPPERI_Type const * p_reg )

Function for reading data sent from CPU to debugger.

Parameters

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

Return values

Data	sent from the CPU to the debugger.

◆ nrf_ctrlap_mailbox_txdata_set()

NRF_STATIC_INLINE void nrf_ctrlap_mailbox_txdata_set	(	NRF_CTRLAPPERI_Type *	p_reg,
		uint32_t	data
	)

Function for writing data sent from CPU to debugger.

Writing to this register will automatically set field DataPending in register TXSTATUS.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	data	Data to send.

◆ nrf_ctrlap_mailbox_txstatus_pending_check()

NRF_STATIC_INLINE bool nrf_ctrlap_mailbox_txstatus_pending_check ( NRF_CTRLAPPERI_Type const * p_reg )

Function for checking if data sent from the CPU to the debugger has been read.

Parameters

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

Return values

true	Data pending in register TXDATA.
false	No data pending in register TXDATA.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ nrf_ctrlap_bootmode_t

◆ nrf_ctrlap_event_t

◆ nrf_ctrlap_int_mask_t

Function Documentation

◆ nrf_ctrlap_event_address_get()

◆ nrf_ctrlap_event_check()

◆ nrf_ctrlap_event_clear()

◆ nrf_ctrlap_info_get()

◆ nrf_ctrlap_info_set()

◆ nrf_ctrlap_int_disable()

◆ nrf_ctrlap_int_enable()

◆ nrf_ctrlap_int_enable_check()

◆ nrf_ctrlap_int_pending_get()

◆ nrf_ctrlap_mailbox_bootmode_get()

◆ nrf_ctrlap_mailbox_rxdata_get()

◆ nrf_ctrlap_mailbox_rxstatus_pending_check()

◆ nrf_ctrlap_mailbox_txdata_get()

◆ nrf_ctrlap_mailbox_txdata_set()

◆ nrf_ctrlap_mailbox_txstatus_pending_check()