Message Handling Unit for non-secure software interrupt receive (r_mhu_b_ns_swint_get)

Functions
fsp_err_t	R_MHU_B_NS_SWINT_GET_Open (mhu_ns_swint_get_ctrl_t *p_ctrl, mhu_ns_swint_get_cfg_t const *const p_cfg)
fsp_err_t	R_MHU_B_NS_SWINT_GET_Close (mhu_ns_swint_get_ctrl_t *const p_ctrl)
fsp_err_t	R_MHU_B_NS_SWINT_GET_CallbackSet (mhu_ns_swint_get_ctrl_t *const p_api_ctrl, void(*p_callback)(mhu_ns_swint_get_callback_args_t *), void const *const p_context, mhu_ns_swint_get_callback_args_t *const p_callback_memory)
void	R_MHU_B_NS_SWINT_GET_IsrSub (uint32_t irq)

Detailed Description

Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (Software Interrupt Get).

Overview

MHU is a function for message communication between:

• Cortex-A55, Cortex-M33 and Cortex-R8 cores incorporated in RZ/V2H.

Features

The MHU_B_NS_SWINT_GET module supports the following features:

• Receive interrupt when the message/response is stored by each core of RZ MPUs in shared RAM.

Data Structures
struct	mhu_b_ns_swint_get_instance_ctrl_t

---

Data Structure Documentation

mhu_b_ns_swint_get_instance_ctrl_t

struct mhu_b_ns_swint_get_instance_ctrl_t

Channel control block. DO NOT INITIALIZE. Initialization occurs when mhu_ns_swint_get_api_t::open is called.

Data Fields
uint32_t	open
	Indicates whether the open() API has been successfully called.
mhu_ns_swint_get_cfg_t const *	p_cfg
	Pointer to instance configuration.
R_MHU_SWINT0_Type *	p_regs
	Base register for this channel.
uint32_t	channel
	channel

Function Documentation

R_MHU_B_NS_SWINT_GET_Open()

fsp_err_t R_MHU_B_NS_SWINT_GET_Open	(	mhu_ns_swint_get_ctrl_t *const	p_ctrl,
		mhu_ns_swint_get_cfg_t const *const	p_cfg
	)

Initializes the MHU_B_NS_SWINT_GET module instance. Implements mhu_ns_swint_get_api_t::open.

Return values

FSP_SUCCESS	Initialization was successful.
FSP_ERR_ASSERTION	A required input pointer is NULL.
FSP_ERR_ALREADY_OPEN	R_MHU_B_NS_SWINT_GET_Open has already been called for this p_ctrl.
FSP_ERR_INVALID_ARGUMENT	The specified IRQ number is invalid.
FSP_ERR_INVALID_CHANNEL	Requested channel number is not available on MHU_B_NS_SWINT_GET.

R_MHU_B_NS_SWINT_GET_Close()

fsp_err_t R_MHU_B_NS_SWINT_GET_Close

(

mhu_ns_swint_get_ctrl_t *const

p_ctrl

)

Disables interrupts, clears internal driver data. mhu_ns_swint_get_api_t::close.

Return values

FSP_SUCCESS	MHU_B_NS_SWINT_GET closed.
FSP_ERR_ASSERTION	p_ctrl is NULL.
FSP_ERR_NOT_OPEN	The instance control structure is not opened.

R_MHU_B_NS_SWINT_GET_CallbackSet()

fsp_err_t R_MHU_B_NS_SWINT_GET_CallbackSet	(	mhu_ns_swint_get_ctrl_t *const	p_api_ctrl,
		void(*)(mhu_ns_swint_get_callback_args_t *)	p_callback,
		void const *const	p_context,
		mhu_ns_swint_get_callback_args_t *const	p_callback_memory
	)

Updates the user callback with the option to provide memory for the callback argument structure. Implements mhu_ns_swint_get_api_t::callbackSet.

Return values

FSP_SUCCESS	Callback updated successfully.
FSP_ERR_ASSERTION	A required pointer is NULL.
FSP_ERR_NOT_OPEN	The control block has not been opened.
FSP_ERR_NO_CALLBACK_MEMORY	p_callback is non-secure and p_callback_memory is either secure or NULL.

R_MHU_B_NS_SWINT_GET_IsrSub()

void R_MHU_B_NS_SWINT_GET_IsrSub

(

uint32_t

irq

)

MHU_B_NS_SWINT_GET receive interrupt sub function (for OpenAMP)

Parameters

[in]

irq

Return values

none.