MHU Interface (Software Interrupt Set)

Detailed Description

Interface for Message Handling Unit (Software Interrupt Set)

Summary

The Message Handling Unit (Software Interrupt Set) interface provides a common API for MHU HAL drivers. The Message Handling Unit (Software Interrupt Set) interface supports:

• Generate software interrupt via MHU.

Implemented by:

• Message Handling Unit for non-secure software interrupt generation (r_mhu_ns_swint_set)
• Message Handling Unit for non-secure software interrupt generation (r_mhu_b_ns_swint_set)

Data Structures
struct	mhu_ns_swint_set_callback_args_t
struct	mhu_ns_swint_set_cfg_t
struct	mhu_ns_swint_set_api_t
struct	mhu_ns_swint_set_instance_t

Typedefs
typedef void	mhu_ns_swint_set_ctrl_t

---

Data Structure Documentation

mhu_ns_swint_set_callback_args_t

struct mhu_ns_swint_set_callback_args_t

MHU callback parameter definition

Data Fields
void const *	p_context	Placeholder for user data. Set in mhu_ns_swint_set_api_t::open function in mhu_ns_swint_set_cfg_t.
uint32_t	channel	Channel where the receive interrupt occurred.

mhu_ns_swint_set_cfg_t

struct mhu_ns_swint_set_cfg_t

MHU configuration block

Data Fields
uint32_t	channel	Identifier recognizable by implementation. Generic configuration
void const *	p_context	Placeholder for user data. Passed to the user callback in timer_callback_args_t.

mhu_ns_swint_set_api_t

struct mhu_ns_swint_set_api_t

Interface definition for MHU

Data Fields
fsp_err_t(*	open )(mhu_ns_swint_set_ctrl_t *const p_ctrl, mhu_ns_swint_set_cfg_t const *const p_cfg)
fsp_err_t(*	interruptSet )(mhu_ns_swint_set_ctrl_t *const p_ctrl)
fsp_err_t(*	close )(mhu_ns_swint_set_ctrl_t *const p_ctrl)

Field Documentation

open

fsp_err_t(* mhu_ns_swint_set_api_t::open) (mhu_ns_swint_set_ctrl_t *const p_ctrl, mhu_ns_swint_set_cfg_t const *const p_cfg)

Opens the MHU driver and initializes the hardware.

Implemented as

• R_MHU_NS_SWINT_SET_Open()
• R_MHU_B_NS_SWINT_SET_Open()

Parameters

[in]	p_ctrl	Pointer to control block. Must be declared by user. Elements are set here.
[in]	p_cfg	Pointer to configuration structure.

interruptSet

fsp_err_t(* mhu_ns_swint_set_api_t::interruptSet) (mhu_ns_swint_set_ctrl_t *const p_ctrl)

Performs a send operation on an MHU device.

Implemented as

• R_MHU_NS_SWINT_SET_InterruptSet()
• R_MHU_B_NS_SWINT_SET_InterruptSet()

Parameters

[in]

p_ctrl

Pointer to control block set in mhu_ns_swint_set_api_t::open call.

close

fsp_err_t(* mhu_ns_swint_set_api_t::close) (mhu_ns_swint_set_ctrl_t *const p_ctrl)

Closes the driver and releases the MHU device.

Implemented as

• R_MHU_NS_SWINT_SET_Close()
• R_MHU_B_NS_SWINT_SET_Close()

Parameters

[in]

p_ctrl

Pointer to control block set in mhu_ns_swint_set_api_t::open call.

mhu_ns_swint_set_instance_t

struct mhu_ns_swint_set_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
mhu_ns_swint_set_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
mhu_ns_swint_set_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
mhu_ns_swint_set_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

mhu_ns_swint_set_ctrl_t

typedef void mhu_ns_swint_set_ctrl_t

MHU control block. Allocate an instance specific control block to pass into the MHU API calls.

Implemented as

• mhu_ns_swint_set_instance_ctrl_t