hal: renesas: ra: Add support FSP LVD driver for RA

Add FSP LVD module hal support for RA MCUs

Signed-off-by: Minh Tang <[email protected]>

Author: Minh Tang

drivers/ra/CMakeLists.txt

@@ -85,6 +85,8 @@ zephyr_library_sources_ifdef(CONFIG_USE_RA_FSP_WDT
 	fsp/src/r_wdt/r_wdt.c)
 zephyr_library_sources_ifdef(CONFIG_USE_RA_FSP_ACMPHS
 	fsp/src/r_acmphs/r_acmphs.c)
+zephyr_library_sources_ifdef(CONFIG_USE_RA_FSP_LVD
+	fsp/src/r_lvd/r_lvd.c)
 zephyr_library_sources_ifdef(CONFIG_USE_RA_FSP_ELC
 	fsp/src/r_elc/r_elc.c)
 zephyr_library_sources_ifdef(CONFIG_USE_RA_FSP_I3C

drivers/ra/fsp/inc/api/r_lvd_api.h

@@ -0,0 +1,279 @@
+/*
+* Copyright (c) 2020 - 2025 Renesas Electronics Corporation and/or its affiliates
+*
+* SPDX-License-Identifier: BSD-3-Clause
+*/
+
+/*******************************************************************************************************************//**
+ * @ingroup RENESAS_MONITORING_INTERFACES
+ * @defgroup LVD_API Low Voltage Detection Interface
+ * @brief Interface for Low Voltage Detection
+ *
+ * @section LVD_API_SUMMARY Summary
+ * The LVD driver provides functions for configuring the LVD voltage monitors and detectors.
+ *
+ *
+ * @{
+ **********************************************************************************************************************/
+#ifndef R_LVD_API_H
+#define R_LVD_API_H
+
+/***********************************************************************************************************************
+ * Includes
+ **********************************************************************************************************************/
+
+/** Register definitions, common services, and error codes. */
+#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
+ **********************************************************************************************************************/
+
+#ifndef BSP_OVERRIDE_LVD_PERIPHERAL_T
+
+/** Voltage detection level */
+
+/** The thresholds supported by each MCU are in the MCU User's Manual as well as
+ *  in the r_lvd module description on the stack tab of the RA project. */
+typedef enum
+{
+    LVD_THRESHOLD_MONITOR_1_LEVEL_4_29V = 0x00UL, ///< 4.29V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_4_16V = 0x01UL, ///< 4.16V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_4_14V = 0x01UL, ///< 4.14V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_4_03V = 0x02UL, ///< 4.03V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_4_02V = 0x02UL, ///< 4.02V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_3_86V = 0x03UL, ///< 3.86V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_3_84V = 0x03UL, ///< 3.84V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_3_10V = 0x04UL, ///< 3.10V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_3_00V = 0x05UL, ///< 3.00V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_90V = 0x06UL, ///< 2.90V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_79V = 0x07UL, ///< 2.79V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_68V = 0x08UL, ///< 2.68V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_58V = 0x09UL, ///< 2.58V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_48V = 0x0AUL, ///< 2.48V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_20V = 0x0BUL, ///< 2.20V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_1_96V = 0x0CUL, ///< 1.96V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_1_86V = 0x0DUL, ///< 1.86V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_1_75V = 0x0EUL, ///< 1.75V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_1_65V = 0x0FUL, ///< 1.65V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_99V = 0x11UL, ///< 2.99V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_92V = 0x12UL, ///< 2.92V
+    LVD_THRESHOLD_MONITOR_1_LEVEL_2_85V = 0x13UL, ///< 2.85V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_4_31V = 0x00UL, ///< 4.31V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_4_29V = 0x00UL, ///< 4.29V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_4_17V = 0x01UL, ///< 4.17V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_4_14V = 0x01UL, ///< 4.14V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_4_03V = 0x02UL, ///< 4.03V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_4_02V = 0x02UL, ///< 4.02V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_3_84V = 0x03UL, ///< 3.84V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_2_99V = 0x05UL, ///< 2.99V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_2_92V = 0x06UL, ///< 2.92V
+    LVD_THRESHOLD_MONITOR_2_LEVEL_2_85V = 0x07UL, ///< 2.85V
+
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_3_1V = 0x06UL,  ///< 3.1V
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_2_9V = 0x05UL,  ///< 2.9V
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_2_8V = 0x04UL,  ///< 2.8V
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_2_7V = 0x03UL,  ///< 2.7V
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_2_6V = 0x02UL,  ///< 2.6V
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_2_4V = 0x01UL,  ///< 2.4V
+    LVD_THRESHOLD_EXLVDVBAT_LEVEL_2_2V = 0x00UL,  ///< 2.2V
+
+    LVD_THRESHOLD_LVDVRTC_LEVEL_2_8V = 0x03UL,    ///< 2.8V
+    LVD_THRESHOLD_LVDVRTC_LEVEL_2_6V = 0x02UL,    ///< 2.6V
+    LVD_THRESHOLD_LVDVRTC_LEVEL_2_4V = 0x01UL,    ///< 2.4V
+    LVD_THRESHOLD_LVDVRTC_LEVEL_2_2V = 0x00UL,    ///< 2.2V
+    LVD_THRESHOLD_NOT_AVAILABLE      = 0xFFUL,    ///< Not Used
+} lvd_threshold_t;
+#endif
+
+/** Response types for handling threshold crossing event. */
+typedef enum e_lvd_response
+{
+    LVD_RESPONSE_NMI,                  ///< Non-maskable interrupt
+    LVD_RESPONSE_INTERRUPT,            ///< Maskable interrupt
+    LVD_RESPONSE_RESET,                ///< Reset on VCC-fall
+    LVD_RESPONSE_RESET_ON_RISING,      ///< Reset on VCC-rise
+    LVD_RESPONSE_NONE,                 ///< No response, status must be requested via statusGet function
+} lvd_response_t;
+
+/** The direction from which VCC must cross the threshold to trigger a detection (rising, falling, or both). */
+typedef enum e_lvd_voltage_slope
+{
+    LVD_VOLTAGE_SLOPE_RISING  = 0,     ///< When VCC >= Vdet2 (rise) is detected
+    LVD_VOLTAGE_SLOPE_FALLING = 1,     ///< When VCC < Vdet2 (drop) is detected
+    LVD_VOLTAGE_SLOPE_BOTH    = 2,     ///< When drop and rise are detected
+} lvd_voltage_slope_t;
+
+/** Sample clock divider, use LVD_SAMPLE_CLOCK_DISABLED to disable digital filtering */
+typedef enum e_lvd_sample_clock
+{
+    LVD_SAMPLE_CLOCK_LOCO_DIV_2  = 0,  ///< Digital filter sample clock is LOCO divided by 2
+    LVD_SAMPLE_CLOCK_LOCO_DIV_4  = 1,  ///< Digital filter sample clock is LOCO divided by 4
+    LVD_SAMPLE_CLOCK_LOCO_DIV_8  = 2,  ///< Digital filter sample clock is LOCO divided by 8
+    LVD_SAMPLE_CLOCK_LOCO_DIV_16 = 3,  ///< Digital filter sample clock is LOCO divided by 16
+    LVD_SAMPLE_CLOCK_DISABLED    = -1, ///< Digital filter is disabled
+} lvd_sample_clock_t;
+
+/** Negation delay of LVD reset signal follows reset or voltage in range */
+typedef enum e_lvd_negation_delay
+{
+    /**
+     *  Negation follows a stabilization time (tLVDn)
+     *  after VCC > Vdet1 is detected.
+     *  If a transition to software standby or deep software
+     *  standby is to be made, the only possible value for
+     *  the RN bit is LVD_NEGATION_DELAY_FROM_VOLTAGE
+     */
+    LVD_NEGATION_DELAY_FROM_VOLTAGE = 0,
+
+    /**
+     *  Negation follows a stabilization time (tLVDn) after
+     *  assertion of the LVDn reset.
+     *  If a transition to software standby or deep software
+     *  standby is to be made, the only possible value for
+     *  the RN bit is LVD_NEGATION_DELAY_FROM_VOLTAGE
+     */
+    LVD_NEGATION_DELAY_FROM_RESET = 1,
+} lvd_negation_delay_t;
+
+/** Threshold crossing detection (latched) */
+typedef enum e_lvd_threshold_crossing
+{
+    LVD_THRESHOLD_CROSSING_NOT_DETECTED = 0, ///< Threshold crossing has not been detected.
+    LVD_THRESHOLD_CROSSING_DETECTED     = 1, ///< Threshold crossing has been detected.
+} lvd_threshold_crossing_t;
+
+/** Instantaneous status of VCC (above or below threshold) */
+typedef enum e_lvd_current_state
+{
+    LVD_CURRENT_STATE_BELOW_THRESHOLD = 0, ///< VCC <  threshold
+    LVD_CURRENT_STATE_ABOVE_THRESHOLD = 1, ///< VCC >= threshold or monitor is disabled
+} lvd_current_state_t;
+
+/**
+ * Current state of a voltage monitor.
+ */
+typedef struct st_lvd_status
+{
+    /** Threshold crossing detection (latched) */
+    lvd_threshold_crossing_t crossing_detected;
+
+    /** Instantaneous status of monitored voltage (above or below threshold) */
+    lvd_current_state_t current_state;
+} lvd_status_t;
+
+/** LVD callback parameter definition */
+typedef struct st_lvd_callback_args
+{
+    uint32_t            monitor_number; ///< Monitor number
+    lvd_current_state_t current_state;  ///< Current state of the voltage monitor
+    void              * p_context;      ///< Placeholder for user data
+} lvd_callback_args_t;
+
+/** LVD configuration structure */
+typedef struct st_lvd_cfg
+{
+    /** Monitor number, 1, 2, ... */
+    uint32_t monitor_number;
+
+    /** Threshold for out of range voltage detection */
+    lvd_threshold_t voltage_threshold;
+
+    /** Response on detecting a threshold crossing */
+    lvd_response_t detection_response;
+
+    /** Direction of voltage crossing that will trigger a detection (Rising Edge, Falling Edge, Both). */
+    lvd_voltage_slope_t voltage_slope;
+
+    /** Negation of LVD signal follows reset or voltage in range */
+    lvd_negation_delay_t negation_delay;
+
+    /** Sample clock divider, use LVD_SAMPLE_CLOCK_DISABLED to disable digital filtering */
+    lvd_sample_clock_t sample_clock_divisor;
+
+    /** Interrupt number. */
+    IRQn_Type irq;
+
+    /** Interrupt priority level. */
+    uint8_t monitor_ipl;
+
+    /** User function to be called from interrupt */
+    void (* p_callback)(lvd_callback_args_t * p_args);
+
+    /** Placeholder for user data. Passed to the user callback in  */
+    void * p_context;
+
+    /** Extension parameter for hardware specific settings */
+    void const * p_extend;
+} lvd_cfg_t;
+
+/** LVD control block.  Allocate an instance specific control block to pass into the LVD API calls.
+ */
+typedef void lvd_ctrl_t;
+
+/** LVD driver API structure.
+ *  LVD driver functions implemented at the HAL layer will adhere to this API.
+ */
+typedef struct st_lvd_api
+{
+    /** Initializes a low voltage detection driver according to the passed-in configuration structure.
+     * @param[in]       p_ctrl      Pointer to control structure for the driver instance
+     * @param[in]       p_cfg       Pointer to the configuration structure for the driver instance
+     **/
+    fsp_err_t (* open)(lvd_ctrl_t * const p_ctrl, lvd_cfg_t const * const p_cfg);
+
+    /** Get the current state of the monitor, (threshold crossing detected, voltage currently above or below threshold).
+     * Must be used if the peripheral was initialized with lvd_response_t set to LVD_RESPONSE_NONE.
+     * @param[in]       p_ctrl          Pointer to the control structure for the driver instance
+     * @param[in,out]   p_lvd_status    Pointer to a lvd_status_t structure
+     **/
+    fsp_err_t (* statusGet)(lvd_ctrl_t * const p_ctrl, lvd_status_t * p_lvd_status);
+
+    /** Clears the latched status of the monitor.
+     * Must be used if the peripheral was initialized with lvd_response_t set to LVD_RESPONSE_NONE.
+     * @param[in]       p_ctrl      Pointer to the control structure for the driver instance
+     **/
+    fsp_err_t (* statusClear)(lvd_ctrl_t * const p_ctrl);
+
+    /**
+     * Specify callback function and optional context pointer and working memory pointer.
+     *
+     * @param[in]   p_ctrl                   Pointer to the LVD 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)(lvd_ctrl_t * const p_ctrl, void (* p_callback)(lvd_callback_args_t *),
+                              void * const p_context, lvd_callback_args_t * const p_callback_memory);
+
+    /** Disables the LVD peripheral.
+     * Closes the driver instance.
+     * @param[in]   p_ctrl      Pointer to the control structure for the driver instance
+     **/
+    fsp_err_t (* close)(lvd_ctrl_t * const p_ctrl);
+} lvd_api_t;
+
+/** This structure encompasses everything that is needed to use an instance of this interface. */
+typedef struct st_lvd_instance
+{
+    lvd_ctrl_t      * p_ctrl;          ///< Pointer to the control structure for this instance
+    lvd_cfg_t const * p_cfg;           ///< Pointer to the configuration structure for this interface instance
+    lvd_api_t const * p_api;           ///< Pointer to the API structure for this interface instance
+} lvd_instance_t;
+
+/* Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
+FSP_FOOTER
+
+#endif
+
+/*******************************************************************************************************************//**
+ * @} (end defgroup LVD_API)
+ **********************************************************************************************************************/

drivers/ra/fsp/inc/instances/r_lvd.h

@@ -0,0 +1,75 @@
+/*
+* Copyright (c) 2020 - 2025 Renesas Electronics Corporation and/or its affiliates
+*
+* SPDX-License-Identifier: BSD-3-Clause
+*/
+
+/*******************************************************************************************************************//**
+ * @addtogroup LVD-PVD
+ * @{
+ **********************************************************************************************************************/
+
+#ifndef R_LVD_H
+#define R_LVD_H
+
+/***********************************************************************************************************************
+ * Includes
+ **********************************************************************************************************************/
+#include "bsp_api.h"
+#include "r_lvd_cfg.h"
+#include "r_lvd_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
+ **********************************************************************************************************************/
+
+/** LVD instance control structure */
+typedef struct st_lvd_instance_ctrl
+{
+    uint32_t          open;
+    lvd_cfg_t const * p_cfg;
+
+    void (* p_callback)(lvd_callback_args_t *); // Pointer to callback that is called when lvd_current_state_t changes.
+    lvd_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.
+
+    /* Pointer to context to be passed into callback function */
+    void * p_context;
+} lvd_instance_ctrl_t;
+
+/**********************************************************************************************************************
+ * Exported global variables
+ **********************************************************************************************************************/
+
+/** @cond INC_HEADER_DEFS_SEC */
+/** Filled in Interface API structure for this Instance. */
+extern const lvd_api_t g_lvd_on_lvd;
+
+/** @endcond */
+
+/***********************************************************************************************************************
+ * Public APIs
+ **********************************************************************************************************************/
+fsp_err_t R_LVD_Open(lvd_ctrl_t * const p_api_ctrl, lvd_cfg_t const * const p_cfg);
+fsp_err_t R_LVD_Close(lvd_ctrl_t * const p_api_ctrl);
+fsp_err_t R_LVD_StatusGet(lvd_ctrl_t * const p_api_ctrl, lvd_status_t * p_lvd_status);
+fsp_err_t R_LVD_StatusClear(lvd_ctrl_t * const p_api_ctrl);
+fsp_err_t R_LVD_CallbackSet(lvd_ctrl_t * const          p_api_ctrl,
+                            void (                    * p_callback)(lvd_callback_args_t *),
+                            void * const                p_context,
+                            lvd_callback_args_t * const p_callback_memory);
+
+/* Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
+FSP_FOOTER
+
+#endif
+
+/*******************************************************************************************************************//**
+ * @} (end defgroup LVD-PVD)
+ **********************************************************************************************************************/