ra8_lvd_api.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_lvd_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_channel_init(ra8_lvd_channel_t channel, const ra8_lvd_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_lvd_channel_deinit(ra8_lvd_channel_t channel);
 
/* =============================================================================
 * Runtime reconfiguration
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_set_threshold(ra8_lvd_channel_t channel,
                                              ra8_lvd_pvdlvl_t  threshold);

[[nodiscard]] ra8_err_t ra8_lvd_enable_irq(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_disable_irq(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_enable_reset(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_disable_reset(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_enable_cmpe(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_disable_cmpe(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t
ra8_lvd_set_filter(ra8_lvd_channel_t channel, ra8_lvd_loco_div_t filter_div, bool filter_en);

[[nodiscard]] ra8_err_t ra8_lvd_set_hysteresis_mode(ra8_lvd_channel_t    channel,
                                                    ra8_lvd_hysteresis_t hyst);

[[nodiscard]] ra8_err_t ra8_lvd_set_negate_mode(ra8_lvd_channel_t channel, ra8_lvd_negate_t negate);

[[nodiscard]] ra8_err_t ra8_lvd_set_irq_edge(ra8_lvd_channel_t channel, ra8_lvd_edge_t edge);

[[nodiscard]] ra8_err_t ra8_lvd_set_irq_kind(ra8_lvd_channel_t channel, ra8_lvd_irq_type_t kind);
 
/* =============================================================================
 * Security attribution
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_set_security(uint32_t mask);
 
/* =============================================================================
 * PVDLR (n-channel register lock)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_unlock_n_channels(void);

[[nodiscard]] ra8_err_t ra8_lvd_relock_n_channels(void);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_get_status(ra8_lvd_channel_t channel, ra8_lvd_status_t* out);

[[nodiscard]] ra8_err_t ra8_lvd_clear_status(ra8_lvd_channel_t channel);
 
/* =============================================================================
 * ELC + standby helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_enable_elc_event(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_disable_elc_event(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_configure_for_standby(ra8_lvd_channel_t channel);

[[nodiscard]] ra8_err_t ra8_lvd_cancel_deep_standby_path(void);
 
/* =============================================================================
 * Filter timing helper
 * =============================================================================
 */

[[nodiscard]] uint32_t ra8_lvd_filter_delay_us(ra8_lvd_loco_div_t div, uint32_t loco_hz);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_lvd_attach_handler(ra8_lvd_event_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t
ra8_lvd_attach_channel_handler(ra8_lvd_channel_t channel, ra8_lvd_event_fn_t fn, void* ctx);

void ra8_lvd_dispatch(ra8_lvd_channel_t channel);
 
#ifdef __cplusplus
}
#endif