ra8_acmphs.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_acmphs_regs.h"
#include "ra8_err.h"
#include "ra8_port_constants.h"

typedef enum : uint8_t {
  k_ra8_acmphs_edge_none = 0U, 
  k_ra8_acmphs_edge_rise = 1U, 
  k_ra8_acmphs_edge_fall = 2U, 
  k_ra8_acmphs_edge_both = 3U, 
} ra8_acmphs_edge_t;

typedef struct {
  uint8_t           ivpsel;     
  uint8_t           ivrefsel;   
  ra8_acmphs_edge_t edge;       
  bool              filter_en;  
  bool              invert_out; 
} ra8_acmphs_cfg_t;

typedef void (*ra8_acmphs_event_fn_t)(void* ctx, uint8_t channel);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_acmphs_init(void);

[[nodiscard]] ra8_err_t ra8_acmphs_channel_init(uint8_t channel, const ra8_acmphs_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_acmphs_channel_deinit(uint8_t channel);
 
/* =============================================================================
 * Legacy polling API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_acmphs_channel_enable(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_acmphs_read_output(uint8_t channel, ra8_level_t* out);
 
/* =============================================================================
 * Runtime reconfigure
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_acmphs_set_inputs(uint8_t channel, uint8_t ivpsel, uint8_t ivrefsel);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_acmphs_get_status(uint8_t channel, uint8_t* out_mask);

[[nodiscard]] ra8_err_t ra8_acmphs_clear_status(uint8_t channel);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_acmphs_attach_handler(ra8_acmphs_event_fn_t fn, void* ctx);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_acmphs_enter_stop(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_acmphs_exit_stop(uint8_t channel);
 
/* =============================================================================
 * ISR dispatch
 * =============================================================================
 */

void ra8_acmphs_dispatch(uint8_t channel);
 
#ifdef __cplusplus
}
#endif