RZV Flexible Software Package Documentation  Release v2.0.0

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

Functions

fsp_err_t R_MHU_B_NS_SWINT_SET_Open (mhu_ns_swint_set_ctrl_t *p_ctrl, mhu_ns_swint_set_cfg_t const *const p_cfg)
 
fsp_err_t R_MHU_B_NS_SWINT_SET_InterruptSet (mhu_ns_swint_set_ctrl_t *const p_ctrl)
 
fsp_err_t R_MHU_B_NS_SWINT_SET_Close (mhu_ns_swint_set_ctrl_t *const p_ctrl)
 

Detailed Description

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

Overview

MHU is a function for message communication between:

Features

The MHU_B_NS_SWINT_SET module supports the following features:

Data Structures

struct  mhu_b_ns_swint_set_instance_ctrl_t
 

Data Structure Documentation

◆ mhu_b_ns_swint_set_instance_ctrl_t

struct mhu_b_ns_swint_set_instance_ctrl_t

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

Data Fields
uint32_t open Indicates whether the open() API has been successfully called.
mhu_ns_swint_set_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_SET_Open()

fsp_err_t R_MHU_B_NS_SWINT_SET_Open ( mhu_ns_swint_set_ctrl_t *const  p_ctrl,
mhu_ns_swint_set_cfg_t const *const  p_cfg 
)

Initializes the MHU_B_NS_SWINT_SET module instance. Implements mhu_ns_swint_set_api_t::open.

Return values
FSP_SUCCESSInitialization was successful.
FSP_ERR_ASSERTIONA required input pointer is NULL.
FSP_ERR_ALREADY_OPENR_MHU_B_NS_SWINT_SET_Open has already been called for this p_ctrl.
FSP_ERR_INVALID_CHANNELRequested channel number is not available on MHU_B_NS_SWINT_SET.

◆ R_MHU_B_NS_SWINT_SET_InterruptSet()

fsp_err_t R_MHU_B_NS_SWINT_SET_InterruptSet ( mhu_ns_swint_set_ctrl_t *const  p_ctrl)

Set Interrupt via MHU. Implements mhu_ns_swint_set_api_t::interruptSet.

Return values
FSP_SUCCESSSet interrupt successfully.
FSP_ERR_ASSERTIONA required pointer was NULL.
FSP_ERR_NOT_OPENThe instance control structure is not opened.

◆ R_MHU_B_NS_SWINT_SET_Close()

fsp_err_t R_MHU_B_NS_SWINT_SET_Close ( mhu_ns_swint_set_ctrl_t *const  p_ctrl)

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

Return values
FSP_SUCCESSMHU_B_NS_SWINT_SET closed.
FSP_ERR_ASSERTIONp_ctrl is NULL.
FSP_ERR_NOT_OPENThe instance control structure is not opened.