ra8_poeg.h

Go to the documentation of this file.

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

typedef enum : uint32_t {
  k_ra8_poeg_status_none = 0x00000000UL, 
  k_ra8_poeg_status_pidf = 0x00000001UL, 
  k_ra8_poeg_status_iocf = 0x00000002UL, 
  k_ra8_poeg_status_ovrf = 0x00000004UL, 
  k_ra8_poeg_status_ssf  = 0x00000008UL, 
  k_ra8_poeg_status_st   = 0x00010000UL, 
} ra8_poeg_status_mask_t;

typedef enum : uint32_t {
  k_ra8_poeg_en_pide  = 0x00000100UL, 
  k_ra8_poeg_en_iocen = 0x00000200UL, 
  k_ra8_poeg_en_osten = 0x00000400UL, 
  k_ra8_poeg_en_inv   = 0x00001000UL, 
} ra8_poeg_enable_mask_t;

typedef struct {
  bool enable_pin;      
  bool enable_ioc;      
  bool enable_osc_stop; 
  bool invert_input;    
} ra8_poeg_cfg_t;

typedef void (*ra8_poeg_event_fn_t)(void* ctx, uint32_t status_mask);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_poeg_init(uint8_t group, const ra8_poeg_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_poeg_deinit(uint8_t group);
 
/* =============================================================================
 * Runtime controls
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_poeg_trigger_stop(uint8_t group);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_poeg_get_status(uint8_t group, uint32_t* out_mask);

[[nodiscard]] ra8_err_t ra8_poeg_clear_status(uint8_t group, uint32_t mask);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_poeg_attach_handler(uint8_t group, ra8_poeg_event_fn_t fn, void* ctx);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_poeg_enter_stop(uint8_t group);

[[nodiscard]] ra8_err_t ra8_poeg_exit_stop(uint8_t group);
 
/* =============================================================================
 * ISR dispatch
 * =============================================================================
 */

void ra8_poeg_dispatch(uint8_t group);
 
#ifdef __cplusplus
}
#endif