hal: renesas: rzg: Initial support for Interrupt Control

Initial HAL support for Interrupt Control

Signed-off-by: Hoang Nguyen <hoang.nguyen.jx@bp.renesas.com>
Signed-off-by: Nhut Nguyen <nhut.nguyen.kc@renesas.com>

drivers/rz/CMakeLists.txt

@@ -34,3 +34,7 @@ zephyr_library_sources_ifdef(CONFIG_USE_RZ_FSP_RIIC_MASTER
 
 zephyr_library_sources_ifdef(CONFIG_USE_RZ_FSP_GTM
 	fsp/src/${SOC_SERIES_PREFIX}/r_gtm/r_gtm.c)
+
+zephyr_library_sources_ifdef(CONFIG_USE_RZ_FSP_EXT_IRQ
+	fsp/src/${SOC_SERIES_PREFIX}/r_intc_irq/r_intc_irq.c
+	fsp/src/${SOC_SERIES_PREFIX}/r_intc_nmi/r_intc_nmi.c)

drivers/rz/fsp/inc/api/r_external_irq_api.h

@@ -0,0 +1,170 @@
+/*
+* Copyright (c) 2020 - 2024 Renesas Electronics Corporation and/or its affiliates
+*
+* SPDX-License-Identifier: BSD-3-Clause
+*/
+
+/*******************************************************************************************************************//**
+ * @ingroup RENESAS_INTERFACES
+ * @defgroup EXTERNAL_IRQ_API External IRQ Interface
+ * @brief Interface for detecting external interrupts.
+ *
+ * @section EXTERNAL_IRQ_API_Summary Summary
+ * The External IRQ Interface is for configuring interrupts to fire when a trigger condition is detected on an
+ * external IRQ pin.
+ *
+ * The  External IRQ Interface can be implemented by:
+ * - @ref INTC_NMI
+ * - @ref INTC_IRQ
+ *
+ * @{
+ **********************************************************************************************************************/
+
+#ifndef R_EXTERNAL_IRQ_API_H
+#define R_EXTERNAL_IRQ_API_H
+
+/***********************************************************************************************************************
+ * Includes
+ **********************************************************************************************************************/
+
+/* Includes board and MCU related header files. */
+#include "bsp_api.h"
+
+/* Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
+FSP_HEADER
+
+/**********************************************************************************************************************
+ * Macro definitions
+ *********************************************************************************************************************/
+
+/*********************************************************************************************************************
+ * Typedef definitions
+ *********************************************************************************************************************/
+
+/** Callback function parameter data */
+typedef struct st_external_irq_callback_args
+{
+    /** Placeholder for user data. Set in @ref external_irq_api_t::open function in @ref external_irq_cfg_t. */
+    void const * p_context;
+    uint32_t     channel;              ///< The physical hardware channel that caused the interrupt.
+} external_irq_callback_args_t;
+
+/** Condition that will trigger an interrupt when detected. */
+typedef enum e_external_irq_trigger
+{
+    EXTERNAL_IRQ_TRIG_FALLING   = 0,   ///< Falling edge trigger
+    EXTERNAL_IRQ_TRIG_RISING    = 1,   ///< Rising edge trigger
+    EXTERNAL_IRQ_TRIG_BOTH_EDGE = 2,   ///< Both edges trigger
+    EXTERNAL_IRQ_TRIG_LEVEL_LOW = 3,   ///< Low level trigger
+} external_irq_trigger_t;
+
+/** External IRQ input pin digital filtering sample clock divisor settings. The digital filter rejects trigger
+ * conditions that are shorter than 3 periods of the filter clock.
+ */
+typedef enum e_external_irq_pclk_div
+{
+    EXTERNAL_IRQ_PCLK_DIV_BY_1  = 0,   ///< Filter using PCLK divided by 1
+    EXTERNAL_IRQ_PCLK_DIV_BY_8  = 1,   ///< Filter using PCLK divided by 8
+    EXTERNAL_IRQ_PCLK_DIV_BY_32 = 2,   ///< Filter using PCLK divided by 32
+    EXTERNAL_IRQ_PCLK_DIV_BY_64 = 3,   ///< Filter using PCLK divided by 64
+} external_irq_pclk_div_t;
+
+/** User configuration structure, used in open function */
+typedef struct st_external_irq_cfg
+{
+    uint8_t                 channel;   ///< Hardware channel used.
+    uint8_t                 ipl;       ///< Interrupt priority
+    IRQn_Type               irq;       ///< NVIC interrupt number assigned to this instance
+    external_irq_trigger_t  trigger;   ///< Trigger setting.
+    external_irq_pclk_div_t pclk_div;  ///< Digital filter clock divisor setting.
+    bool filter_enable;                ///< Digital filter enable/disable setting.
+
+    /** Callback provided external input trigger occurs. */
+    void (* p_callback)(external_irq_callback_args_t * p_args);
+
+    /** Placeholder for user data.  Passed to the user callback in @ref external_irq_callback_args_t. */
+    void const * p_context;
+    void const * p_extend;             ///< External IRQ hardware dependent configuration.
+} external_irq_cfg_t;
+
+/** External IRQ control block.  Allocate an instance specific control block to pass into the external IRQ API calls.
+ * @par Implemented as
+ * - intc_nmi_instance_ctrl_t
+ * - intc_irq_instance_ctrl_t
+ */
+typedef void external_irq_ctrl_t;
+
+/** External interrupt driver structure. External interrupt functions implemented at the HAL layer will follow this API. */
+typedef struct st_external_irq_api
+{
+    /** Initial configuration.
+     * @par Implemented as
+     * - @ref R_INTC_NMI_ExternalIrqOpen()
+     * - @ref R_INTC_IRQ_ExternalIrqOpen()
+     *
+     * @param[out]  p_ctrl  Pointer to control block. Must be declared by user. Value set here.
+     * @param[in]   p_cfg   Pointer to configuration structure. All elements of the structure must be set by user.
+     */
+    fsp_err_t (* open)(external_irq_ctrl_t * const p_ctrl, external_irq_cfg_t const * const p_cfg);
+
+    /** Enable callback when an external trigger condition occurs.
+     * @par Implemented as
+     * - @ref R_INTC_NMI_ExternalIrqEnable()
+     * - @ref R_INTC_IRQ_ExternalIrqEnable()
+     *
+     * @param[in]  p_ctrl      Control block set in Open call for this external interrupt.
+     */
+    fsp_err_t (* enable)(external_irq_ctrl_t * const p_ctrl);
+
+    /** Disable callback when external trigger condition occurs.
+     * @par Implemented as
+     * - @ref R_INTC_NMI_ExternalIrqDisable()
+     * - @ref R_INTC_IRQ_ExternalIrqDisable()
+     *
+     * @param[in]  p_ctrl      Control block set in Open call for this external interrupt.
+     */
+    fsp_err_t (* disable)(external_irq_ctrl_t * const p_ctrl);
+
+    /**
+     * Specify callback function and optional context pointer and working memory pointer.
+     * @par Implemented as
+     * - R_INTC_NMI_ExternalIrqCallbackSet()
+     * - R_INTC_IRQ_ExternalIrqCallbackSet()
+     *
+     * @param[in]   p_ctrl                   Pointer to the Extneral IRQ control block.
+     * @param[in]   p_callback               Callback function
+     * @param[in]   p_context                Pointer to send to callback function
+     * @param[in]   p_working_memory         Pointer to volatile memory where callback structure can be allocated.
+     *                                       Callback arguments allocated here are only valid during the callback.
+     */
+    fsp_err_t (* callbackSet)(external_irq_ctrl_t * const          p_api_ctrl,
+                              void (                             * p_callback)(external_irq_callback_args_t *),
+                              void const * const                   p_context,
+                              external_irq_callback_args_t * const p_callback_memory);
+
+    /** Allow driver to be reconfigured. May reduce power consumption.
+     * @par Implemented as
+     * - @ref R_INTC_NMI_ExternalIrqClose()
+     * - @ref R_INTC_IRQ_ExternalIrqClose()
+     *
+     * @param[in]  p_ctrl      Control block set in Open call for this external interrupt.
+     */
+    fsp_err_t (* close)(external_irq_ctrl_t * const p_ctrl);
+} external_irq_api_t;
+
+/** This structure encompasses everything that is needed to use an instance of this interface. */
+typedef struct st_external_irq_instance
+{
+    external_irq_ctrl_t      * p_ctrl; ///< Pointer to the control structure for this instance
+    external_irq_cfg_t const * p_cfg;  ///< Pointer to the configuration structure for this instance
+    external_irq_api_t const * p_api;  ///< Pointer to the API structure for this instance
+} external_irq_instance_t;
+
+/* Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
+FSP_FOOTER
+
+/*******************************************************************************************************************//**
+ * @} (end defgroup EXTERNAL_IRQ_API)
+ **********************************************************************************************************************/
+
+#endif

drivers/rz/fsp/inc/instances/rzg/r_intc_irq.h

@@ -0,0 +1,82 @@
+/*
+* Copyright (c) 2020 - 2024 Renesas Electronics Corporation and/or its affiliates
+*
+* SPDX-License-Identifier: BSD-3-Clause
+*/
+
+/*******************************************************************************************************************//**
+ * @addtogroup INTC_IRQ
+ * @{
+ **********************************************************************************************************************/
+
+#ifndef R_INTC_IRQ_H
+#define R_INTC_IRQ_H
+
+/***********************************************************************************************************************
+ * Includes
+ **********************************************************************************************************************/
+#include "bsp_api.h"
+#include "r_external_irq_api.h"
+
+/* Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
+FSP_HEADER
+
+/***********************************************************************************************************************
+ * Macro definitions
+ **********************************************************************************************************************/
+
+/*********************************************************************************************************************
+ * Typedef definitions
+ *********************************************************************************************************************/
+
+/** INTC_IRQ private control block. DO NOT MODIFY.  Initialization occurs when R_INTC_IRQ_ExternalIrqOpen is called. */
+typedef struct st_intc_irq_instance_ctrl
+{
+    uint32_t  open;                                             ///< Used to determine if channel control block is in use
+    IRQn_Type irq;                                              ///< NVIC interrupt number
+    uint8_t   channel;                                          ///< Channel
+
+#if BSP_TZ_SECURE_BUILD
+    external_irq_callback_args_t * p_callback_memory;           // Pointer to non-secure memory that can be used to pass arguments to a callback in non-secure memory.
+#endif
+    void (* p_callback)(external_irq_callback_args_t * p_args); // Pointer to callback that is called when an edge is detected on the external irq pin.
+
+    /** Placeholder for user data.  Passed to the user callback in ::external_irq_callback_args_t. */
+    void const * p_context;
+} intc_irq_instance_ctrl_t;
+
+/**********************************************************************************************************************
+ * Exported global variables
+ **********************************************************************************************************************/
+
+/** @cond INC_HEADER_DEFS_SEC */
+/** Filled in Interface API structure for this Instance. */
+extern const external_irq_api_t g_external_irq_on_intc_irq;
+
+/** @endcond */
+
+/***********************************************************************************************************************
+ * Public APIs
+ **********************************************************************************************************************/
+fsp_err_t R_INTC_IRQ_ExternalIrqOpen(external_irq_ctrl_t * const p_api_ctrl, external_irq_cfg_t const * const p_cfg);
+
+fsp_err_t R_INTC_IRQ_ExternalIrqEnable(external_irq_ctrl_t * const p_api_ctrl);
+
+fsp_err_t R_INTC_IRQ_ExternalIrqDisable(external_irq_ctrl_t * const p_api_ctrl);
+
+fsp_err_t R_INTC_IRQ_ExternalIrqCallbackSet(external_irq_ctrl_t * const p_api_ctrl,
+                                            void (                    * p_callback)(
+                                                external_irq_callback_args_t *),
+                                            void const * const                   p_context,
+                                            external_irq_callback_args_t * const p_callback_memory);
+
+fsp_err_t R_INTC_IRQ_ExternalIrqClose(external_irq_ctrl_t * const p_api_ctrl);
+
+/*******************************************************************************************************************//**
+ * @} (end defgroup INTC_IRQ)
+ **********************************************************************************************************************/
+
+/* Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
+FSP_FOOTER
+
+#endif                                 // R_INTC_IRQ_H

drivers/rz/fsp/inc/instances/rzg/r_intc_nmi.h

@@ -0,0 +1,82 @@
+/*
+* Copyright (c) 2020 - 2024 Renesas Electronics Corporation and/or its affiliates
+*
+* SPDX-License-Identifier: BSD-3-Clause
+*/
+
+/*******************************************************************************************************************//**
+ * @addtogroup INTC_NMI
+ * @{
+ **********************************************************************************************************************/
+
+#ifndef R_INTC_NMI_H
+#define R_INTC_NMI_H
+
+/***********************************************************************************************************************
+ * Includes
+ **********************************************************************************************************************/
+#include "bsp_api.h"
+#include "r_external_irq_api.h"
+
+/* Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
+FSP_HEADER
+
+/***********************************************************************************************************************
+ * Macro definitions
+ **********************************************************************************************************************/
+
+/*********************************************************************************************************************
+ * Typedef definitions
+ *********************************************************************************************************************/
+
+/** INTC_NMI private control block. DO NOT MODIFY. Initialization occurs when R_INTC_NMI_ExternalIrqOpen is called. */
+typedef struct st_intc_nmi_instance_ctrl
+{
+    uint32_t  open;                                             ///< Used to determine if channel control block is in use
+    IRQn_Type irq;                                              ///< NVIC Interrupt number
+    uint8_t   channel;                                          ///< Channel
+
+#if BSP_TZ_SECURE_BUILD
+    external_irq_callback_args_t * p_callback_memory;           // Pointer to non-secure memory that can be used to pass arguments to a callback in non-secure memory.
+#endif
+    void (* p_callback)(external_irq_callback_args_t * p_args); // Pointer to callback that is called when an edge is detected on the external irq pin.
+
+    /** Placeholder for user data.  Passed to the user callback in ::external_irq_callback_args_t. */
+    void const * p_context;
+} intc_nmi_instance_ctrl_t;
+
+/**********************************************************************************************************************
+ * Exported global variables
+ **********************************************************************************************************************/
+
+/** @cond INC_HEADER_DEFS_SEC */
+/** Filled in Interface API structure for this Instance. */
+extern const external_irq_api_t g_external_irq_on_intc_nmi;
+
+/** @endcond */
+
+/***********************************************************************************************************************
+ * Public APIs
+ **********************************************************************************************************************/
+fsp_err_t R_INTC_NMI_ExternalIrqOpen(external_irq_ctrl_t * const p_api_ctrl, external_irq_cfg_t const * const p_cfg);
+
+fsp_err_t R_INTC_NMI_ExternalIrqEnable(external_irq_ctrl_t * const p_api_ctrl);
+
+fsp_err_t R_INTC_NMI_ExternalIrqDisable(external_irq_ctrl_t * const p_api_ctrl);
+
+fsp_err_t R_INTC_NMI_ExternalIrqCallbackSet(external_irq_ctrl_t * const p_api_ctrl,
+                                            void (                    * p_callback)(
+                                                external_irq_callback_args_t *),
+                                            void const * const                   p_context,
+                                            external_irq_callback_args_t * const p_callback_memory);
+
+fsp_err_t R_INTC_NMI_ExternalIrqClose(external_irq_ctrl_t * const p_api_ctrl);
+
+/*******************************************************************************************************************//**
+ * @} (end defgroup INTC_NMI)
+ **********************************************************************************************************************/
+
+/* Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
+FSP_FOOTER
+
+#endif                                 // R_INTC_NMI_H