Functions
fsp_err_t	R_POE3_Open (poe3_ctrl_t const p_ctrl, poe3_cfg_t const const p_cfg)

fsp_err_t	R_POE3_StatusGet (poe3_ctrl_t const p_ctrl, poe3_status_t const p_status)

fsp_err_t	R_POE3_OutputDisable (poe3_ctrl_t *const p_ctrl)

fsp_err_t	R_POE3_Reset (poe3_ctrl_t *const p_ctrl)

fsp_err_t	R_POE3_Close (poe3_ctrl_t *const p_ctrl)

fsp_err_t	R_POE3_CallbackSet (poe3_ctrl_t const p_ctrl, void(p_callback)(poe3_callback_args_t ), void const const p_context, poe3_callback_args_t *const p_callback_memory)

Detailed Description

Driver for the POE3 peripheral on RZ microprocessor. This module implements the POE3 Interface.

Overview

The POE3 module can be used to configure events to disable MTU3 output pins.

Features

The POE3 module has the following features:

Supports disabling the target pins when POE0#, POE4#, POE8#, POE10#, POE11# pins are the falling-edge or low-level sampling.
Supports disabling the target pins when main oscillator stop is detected.
Supports disabling MTU3 output pins by software API.
Supports notifying the application when target pin are disabled by POE3.
Supports resetting POE3 status.

Configuration

Build Time Configurations for r_poe3

The following build time configurations are defined in fsp_cfg/r_poe3_cfg.h:

Configuration	Options	Default	Description
Parameter Checking	Default (BSP) Enabled Disabled	Default (BSP)	If selected code for parameter checking is included in the build.
Multiplex Interrupt	Enabled Disabled	Disabled	Enable multiplex interrupt for a single driver.

Configurations for Timers > Port Output Enable 3 for MTU3 (r_poe3)

This module can be added to the Stacks tab via New Stack > Timers > Port Output Enable 3 for MTU3 (r_poe3).

Configuration	Options	Default	Description
General > Name	Name must be a valid C symbol	g_poe30	Module name.
Input > POE0# > Mode Select(Trigger)	Falling edge Sampling 16 times with PCLK / 8 clock All low level. Sampling 16 times with PCLK / 16 clock All low level. Sampling 16 times with PCLK / 128 clock All low level.	Falling edge	Select the trigger that POE0# sets to high impedance.
Input > POE0# > Interrupts	Disabled Enabled	Disabled	Generates an interrupt when the POE0# matches the mode conditions.
Input > POE4# > Mode Select(Trigger)	Falling edge Sampling 16 times with PCLK / 8 clock All low level. Sampling 16 times with PCLK / 16 clock All low level. Sampling 16 times with PCLK / 128 clock All low level.	Falling edge	Select the trigger that POE4# sets to high impedance.
Input > POE4# > Interrupts	Disabled Enabled	Disabled	Generates an interrupt when the POE4# matches the mode conditions.
Input > POE8# > Mode Select(Trigger)	Falling edge Sampling 16 times with PCLK / 8 clock All low level. Sampling 16 times with PCLK / 16 clock All low level. Sampling 16 times with PCLK / 128 clock All low level.	Falling edge	Select the trigger that POE8# sets to high impedance.
Input > POE8# > Interrupts	Disabled Enabled	Disabled	Generates an interrupt when the POE8# matches the mode conditions.
Input > POE8# > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if POE8# is triggered.
Input > POE10# > Mode Select(Trigger)	Falling edge Sampling 16 times with PCLK / 8 clock All low level. Sampling 16 times with PCLK / 16 clock All low level. Sampling 16 times with PCLK / 128 clock All low level.	Falling edge	Select the trigger that POE10# sets to high impedance.
Input > POE10# > Interrupts	Disabled Enabled	Disabled	Generates an interrupt when the POE10# matches the mode conditions.
Input > POE10# > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if POE10# is triggered.
Input > POE11# > Mode Select(Trigger)	Falling edge Sampling 16 times with PCLK / 8 clock All low level. Sampling 16 times with PCLK / 16 clock All low level. Sampling 16 times with PCLK / 128 clock All low level.	Falling edge	Select the trigger that POE11# sets to high impedance.
Input > POE11# > Interrupts	Disabled Enabled	Disabled	Generates an interrupt when the POE11# matches the mode conditions.
Input > POE11# > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if POE11# is triggered.
Output > DSMIF Error Interrupt > Unit 0 > DSMIF0 Error 0 Interrupt Enable	Disabled Enabled	Disabled	Setting high impedance on DSMIF0 error0.
Output > DSMIF Error Interrupt > Unit 0 > DSMIF0 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF0 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 1 > DSMIF1 Error 0 Interrupt Enable	Disabled Enabled	Disabled	Setting high impedance on DSMIF1 error0.
Output > DSMIF Error Interrupt > Unit 1 > DSMIF1 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF1 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 2 > DSMIF2 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF2 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 2 > DSMIF2 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF2 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 3 > DSMIF3 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF3 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 3 > DSMIF3 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF3 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 4 > DSMIF4 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF4 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 4 > DSMIF4 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF4 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 5 > DSMIF5 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF5 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 5 > DSMIF5 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF5 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 6 > DSMIF6 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF6 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 6 > DSMIF6 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF6 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 7 > DSMIF7 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF7 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 7 > DSMIF7 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF7 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 8 > DSMIF8 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF8 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 8 > DSMIF8 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF8 error1. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 9 > DSMIF9 Error 0 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF9 error0. Unsupported devices show disabled.
Output > DSMIF Error Interrupt > Unit 9 > DSMIF9 Error 1 Interrupt Enable	MCU Specific Options		Setting high impedance on DSMIF9 error1. Unsupported devices show disabled.
Output > Output Short Circuit MTU3/4 > Interrupt Enable	Disabled Enabled	Disabled	Generates an interrupt when the output of MTU3 or MTU4 is short-circuited.
Output > Output Short Circuit MTU3/4 > High-Impedance Enable	Disabled Enabled	Disabled	Setting high impedance when the output of MTU3 or MTU4 is short-circuited.
Output > Output Short Circuit MTU6/7 > Interrupt Enable	Disabled Enabled	Disabled	Generates an interrupt when the output of MTU6 or MTU7 is short-circuited.
Output > Output Short Circuit MTU6/7 > High-Impedance Enable	Disabled Enabled	Disabled	Setting high impedance when the output of MTU6 or MTU7 is short-circuited.
Output > Oscillation Stop High-Impedance Enable	Disabled Enabled	Disabled	Setting high impedance when the oscillator is stopped.
MTU0 Pin Control > MTU0-A (MTIOC0A) > Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC0A.
MTU0 Pin Control > MTU0-A (MTIOC0A) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC0A matches the mode conditions.
MTU0 Pin Control > MTU0-B (MTIOC0B) > Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC0B.
MTU0 Pin Control > MTU0-B (MTIOC0B) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC0B matches the mode conditions.
MTU0 Pin Control > MTU0-C (MTIOC0C) > Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC0C.
MTU0 Pin Control > MTU0-C (MTIOC0C) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC0C matches the mode conditions.
MTU0 Pin Control > MTU0-D (MTIOC0D) > Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC0D.
MTU0 Pin Control > MTU0-D (MTIOC0D) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC0D matches the mode conditions.
MTU0 Pin Control > Additional MTU0 pin control request condition (Always enable POE8# Input)	MCU Specific Options		Select the additional pin control request for MTU0 (Always enable POE8# Input).
MTU0 Pin Control > Additional MTU0 pin control DSMIF Error 0 request condition	MCU Specific Options		Select the additional DSMIF error 0 request for MTU0.
MTU0 Pin Control > Additional MTU0 pin control DSMIF Error 1 request condition	MCU Specific Options		Select the additional DSMIF error 1 request for MTU0.
MTU3 and MTU4 Pin Control > MTU3-B (MTIOC3B) and MTU3-D (MTIOC3D) > MTIOC3B Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC3B.
MTU3 and MTU4 Pin Control > MTU3-B (MTIOC3B) and MTU3-D (MTIOC3D) > MTIOC3D Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC3D.
MTU3 and MTU4 Pin Control > MTU3-B (MTIOC3B) and MTU3-D (MTIOC3D) > MTIOC3B Active Level	Active High Active Low	Active High	Set the active level of the MTIOC3B output.
MTU3 and MTU4 Pin Control > MTU3-B (MTIOC3B) and MTU3-D (MTIOC3D) > MTIOC3D Active Level	Active High Active Low	Active High	Set the active level of the MTIOC3D output.
MTU3 and MTU4 Pin Control > MTU3-B (MTIOC3B) and MTU3-D (MTIOC3D) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC3B or MTIOC3D matches the mode conditions.
MTU3 and MTU4 Pin Control > MTU4-B (MTIOC4B) and MTU4-D (MTIOC4D) > MTIOC4B Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC4B.
MTU3 and MTU4 Pin Control > MTU4-B (MTIOC4B) and MTU4-D (MTIOC4D) > MTIOC4D Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC4D.
MTU3 and MTU4 Pin Control > MTU4-B (MTIOC4B) and MTU4-D (MTIOC4D) > MTIOC4B Active Level	Active High Active Low	Active High	Set the active level of the MTIOC4B output.
MTU3 and MTU4 Pin Control > MTU4-B (MTIOC4B) and MTU4-D (MTIOC4D) > MTIOC4D Active Level	Active High Active Low	Active High	Set the active level of the MTIOC4D output.
MTU3 and MTU4 Pin Control > MTU4-B (MTIOC4B) and MTU4-D (MTIOC4D) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC4B or MTIOC4D matches the mode conditions.
MTU3 and MTU4 Pin Control > MTU4-A (MTIOC4A) and MTU4-C (MTIOC4C) > MTIOC4A Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC4A.
MTU3 and MTU4 Pin Control > MTU4-A (MTIOC4A) and MTU4-C (MTIOC4C) > MTIOC4C Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC4C.
MTU3 and MTU4 Pin Control > MTU4-A (MTIOC4A) and MTU4-C (MTIOC4C) > MTIOC4A Active Level	Active High Active Low	Active High	Set the active level of the MTIOC4A output.
MTU3 and MTU4 Pin Control > MTU4-A (MTIOC4A) and MTU4-C (MTIOC4C) > MTIOC4C Active Level	Active High Active Low	Active High	Set the active level of the MTIOC4C output.
MTU3 and MTU4 Pin Control > MTU4-A (MTIOC4A) and MTU4-C (MTIOC4C) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC4A or MTIOC4C matches the mode conditions.
MTU3 and MTU4 Pin Control > Additional MTU3/4 pin control request condition (Always enable POE0# Input)	MCU Specific Options		Select the additional pin control request for MTU3/4 (Always enable POE0# Input).
MTU3 and MTU4 Pin Control > Additional MTU3/4 pin control DSMIF Error 0 request condition	MCU Specific Options		Select the additional DSMIF error 0 request for MTU3/4.
MTU3 and MTU4 Pin Control > Additional MTU3/4 pin control DSMIF Error 1 request condition	MCU Specific Options		Select the additional DSMIF error 1 request for MTU3/4.
MTU6 and MTU7 Pin Control > MTU6-B (MTIOC6B) and MTU6-D (MTIOC6D) > MTIOC6B Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC6B.
MTU6 and MTU7 Pin Control > MTU6-B (MTIOC6B) and MTU6-D (MTIOC6D) > MTIOC6D Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC6D.
MTU6 and MTU7 Pin Control > MTU6-B (MTIOC6B) and MTU6-D (MTIOC6D) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC6B or MTIOC6D matches the mode conditions.
MTU6 and MTU7 Pin Control > MTU7-B (MTIOC7B) and MTU7-D (MTIOC7D) > MTIOC7B Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC7B.
MTU6 and MTU7 Pin Control > MTU7-B (MTIOC7B) and MTU7-D (MTIOC7D) > MTIOC7D Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC7D.
MTU6 and MTU7 Pin Control > MTU7-B (MTIOC7B) and MTU7-D (MTIOC7D) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC7B or MTIOC7D matches the mode conditions.
MTU6 and MTU7 Pin Control > MTU7-A (MTIOC7A) and MTU7-C (MTIOC7C) > MTIOC7A Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC7A.
MTU6 and MTU7 Pin Control > MTU7-A (MTIOC7A) and MTU7-C (MTIOC7C) > MTIOC7C Pin Select	MCU Specific Options		Select the pin you want to use as MTIOC7C.
MTU6 and MTU7 Pin Control > MTU7-A (MTIOC7A) and MTU7-C (MTIOC7C) > High-Impedance Enable	Disabled Enabled	Disabled	Set the high impedance if the MTIOC7A or MTIOC7C matches the mode conditions.
MTU6 and MTU7 Pin Control > Additional MTU6/7 pin control request condition (Always enable POE4# Input)	MCU Specific Options		Select the additional pin control request for MTU6/7 (Always enable POE4# Input).
MTU6 and MTU7 Pin Control > Additional MTU6/7 pin control DSMIF Error 0 request condition	MCU Specific Options		Select the additional DSMIF error 0 request for MTU6/7.
MTU6 and MTU7 Pin Control > Additional MTU6/7 pin control DSMIF Error 1 request condition	MCU Specific Options		Select the additional DSMIF error 1 request for MTU6/7.
Interrupts > Callback	Name must be a valid C symbol	NULL	A user callback function can be provided. If this callback function is provided, it will be called from the interrupt service routine (ISR).
Interrupts > POE0# Input, Output Short Circuit MTU3/4 Interrupt Priority	MCU Specific Options		Set the POE0# Input, Output Short Circuit MTU3/4 Input interrupt priority.
Interrupts > POE4# Input, Output Short Circuit MTU6/7 Interrupt Priority	MCU Specific Options		Set the POE4# Input, Output Short Circuit MTU6/7 interrupt priority.
Interrupts > POE8# Input Interrupt Priority	MCU Specific Options		Set the POE8# Input interrupt priority.
Interrupts > POE10#/11# Input, DSMIF Error Interrupt Priority	MCU Specific Options		Set the POE10#/11# Input, DSMIF Error interrupt priority.

Clock Configuration

The POE3 clock is based on the PCLKH frequency.

Pin Configuration

This module can use POE0#, POE4#, POE8#, POE10# or POE11# as an input signal to disable MTU3 output pins.

Usage Notes

POE3 MTIOC Pin and Channel

POE0# as default or POE4#, POE8#, POE10#, POE11# as additional controls the output of MTU3 and MTU4. POE4# as default or POE0#, POE8#, POE10#, POE11# as additional controls the output of MTU6 and MTU7. POE8# as default or POE0#, POE4#, POE10#, POE11# as additional controls the output of MTU0.

Limitations

NOTE

The POE3 interrupt type is a level interrupt. Please do the following: When clearing the interrupt status in interrupt processing, Check the interrupt status is cleared before terminating interrupt processing.

Examples

POE3 Basic Example

This is a basic example of minimal use of the POE3 in an application.

void poe3_basic_example (void)
{
    fsp_err_t err = FSP_SUCCESS;
    /* Initializes the POE3. */
    err = R_POE3_Open(&g_poe30_ctrl, &g_poe30_cfg);
    /* Handle any errors. This function should be defined by the user. */
    handle_error(err);
}

POE3 Operation Check Example

This is an example of checking the status of POE3 after POE3 has disabled the MTU3 output pin.

/* An example,Check the status of POE3 after POE3 disables the MTU3 output pin. */
void poe3_operation_check_example (void)
{
    fsp_err_t err = FSP_SUCCESS;
    /* Initializes the POE3. */
    err = R_POE3_Open(&g_poe30_ctrl, &g_poe30_cfg);
    /* Handle any errors. This function should be defined by the user. */
    handle_error(err);
    /* (Optional) Determine the cause of the POE3 event. */
    poe3_status_t status;
    (void) R_POE3_StatusGet(&g_poe30_ctrl, &status);
    /* Correct the cause of the POE3 event before resetting POE3. */
    /* Reset the POE3 before exiting this routine. */
    (void) R_POE3_Reset(&g_poe30_ctrl);
    /* After performing the reset, verify that the status is cleared. */
    do
    {
        (void) R_POE3_StatusGet(&g_poe30_ctrl, &status);
    } while (POE3_STATE_NO_DISABLE_REQUEST != status.state);
}

POE3 Callback Example

This is an example of a using the POE3 callback check the status of POE3 and restore MTU3 output operation.

/* Example callback called when POE3 disables MTU3 output pins. */
void poe3_callback (poe3_callback_args_t * p_args)
{
    FSP_PARAMETER_NOT_USED(p_args);
    /* (Optional) Determine the cause of the POE3 event. */
    poe3_status_t status;
    (void) R_POE3_StatusGet(&g_poe30_ctrl, &status);
    /* Correct the cause of the POE3 event before resetting POE3. */
    /* Reset the POE3 before exiting the callback. */
    (void) R_POE3_Reset(&g_poe30_ctrl);
    /* Wait for the status to clear after reset before exiting the callback to ensure the interrupt does not fire
     * again. */
    do
    {
        (void) R_POE3_StatusGet(&g_poe30_ctrl, &status);
    } while (POE3_STATE_NO_DISABLE_REQUEST != status.state);
}

Data Structures
struct	poe3_poe_input_setting_t

struct	poe3_instance_ctrl_t

Enumerations
enum	poe3_hiz_mode_t

Data Structure Documentation

◆ poe3_poe_input_setting_t

struct poe3_poe_input_setting_t

POEn# input signal setting

Data Fields
poe3_hiz_mode_t	mode	High-impedance output mode.
bool	interrupt_enable	Interrupt enable.
bool	hiz_output_enable	High-impedance output enable for POE8, POE10, POE11.

◆ poe3_instance_ctrl_t

struct poe3_instance_ctrl_t

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

Enumeration Type Documentation

◆ poe3_hiz_mode_t

enum poe3_hiz_mode_t

High-impedance output mode

Enumerator
POE3_HIZ_MODE_FALLING_EDGE	Accepts a request on the falling edge of POE3 pin input.
POE3_HIZ_MODE_CLOCK_SOURCE_DIV_8_16_TIME_PULSE_LOW	Accepts a request when POE3 pin input has been sampled 16 times at clock source divided by 8 clock pulses and all are low level.
POE3_HIZ_MODE_CLOCK_SOURCE_DIV_16_16_TIME_PULSE_LOW	Accepts a request when POE3 pin input has been sampled 16 times at clock source divided by 16 clock pulses and all are low level.
POE3_HIZ_MODE_CLOCK_SOURCE_DIV_128_16_TIME_PULSE_LOW	Accepts a request when POE3 pin input has been sampled 16 times at clock source divided by 128 clock pulses and all are low level.

Function Documentation

◆ R_POE3_Open()

fsp_err_t R_POE3_Open	(	poe3_ctrl_t *const	p_ctrl,
		poe3_cfg_t const *const	p_cfg
	)

Initializes the POE3 module and applies configurations. Implements poe3_api_t::open.

Note: POE0, POE4 and POE8 Mode Select setting can only be configured once after reset. Reopening with a different mode configuration is not possible.

Return values

FSP_SUCCESS	Initialization was successful.
FSP_ERR_ASSERTION	A required input pointer is NULL.
FSP_ERR_ALREADY_OPEN	Module is already open.

◆ R_POE3_StatusGet()

fsp_err_t R_POE3_StatusGet	(	poe3_ctrl_t *const	p_ctrl,
		poe3_status_t *const	p_status
	)

Get current POE3 status and store it in provided pointer p_status. Implements poe3_api_t::statusGet.

Return values

FSP_SUCCESS	Current POE3 state stored successfully.
FSP_ERR_ASSERTION	p_ctrl or p_status was NULL.
FSP_ERR_NOT_OPEN	The instance is not opened.

◆ R_POE3_OutputDisable()

fsp_err_t R_POE3_OutputDisable ( poe3_ctrl_t *const p_ctrl )

Disables MTU3 output pins. Implements poe3_api_t::outputDisable.

Return values

FSP_SUCCESS	MTU3 output pins successfully disabled.
FSP_ERR_ASSERTION	p_ctrl was NULL.
FSP_ERR_NOT_OPEN	The instance is not opened.

◆ R_POE3_Reset()

fsp_err_t R_POE3_Reset ( poe3_ctrl_t *const p_ctrl )

Resets status flags. Implements poe3_api_t::reset.

Note: Status flags are only reset if the original POE3 trigger is resolved. Check the status using R_POE3_StatusGet after calling this function to verify the status is cleared.

Return values

FSP_SUCCESS	Function attempted to clear status flags.
FSP_ERR_ASSERTION	p_ctrl was NULL.
FSP_ERR_NOT_OPEN	The instance is not opened.

◆ R_POE3_Close()

fsp_err_t R_POE3_Close ( poe3_ctrl_t *const p_ctrl )

Disables POE3 interrupt. Implements poe3_api_t::close.

Note: This function does not disable the POE3.

Return values

FSP_SUCCESS	Successful close.
FSP_ERR_ASSERTION	p_ctrl was NULL.
FSP_ERR_NOT_OPEN	The instance is not opened.

◆ R_POE3_CallbackSet()

fsp_err_t R_POE3_CallbackSet	(	poe3_ctrl_t *const	p_ctrl,
		void()(poe3_callback_args_t )	p_callback,
		void const *const	p_context,
		poe3_callback_args_t *const	p_callback_memory
	)

Updates the user callback with the option to provide memory for the callback argument structure. Implements poe3_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.

Functions

Detailed Description

Overview

Features

Configuration

Build Time Configurations for r_poe3

Configurations for Timers > Port Output Enable 3 for MTU3 (r_poe3)

Clock Configuration

Pin Configuration

Usage Notes

POE3 MTIOC Pin and Channel

Limitations

NOTE

Examples

POE3 Basic Example

POE3 Operation Check Example

POE3 Callback Example

Data Structures

Enumerations

Data Structure Documentation

◆ poe3_poe_input_setting_t

◆ poe3_instance_ctrl_t

Enumeration Type Documentation

◆ poe3_hiz_mode_t

Function Documentation

◆ R_POE3_Open()

◆ R_POE3_StatusGet()

◆ R_POE3_OutputDisable()

◆ R_POE3_Reset()

◆ R_POE3_Close()

◆ R_POE3_CallbackSet()