ra8_adc.h

Go to the documentation of this file.

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

typedef enum : uint8_t {
  k_ra8_adc_res_16bit = 0U, 
  k_ra8_adc_res_14bit = 1U, 
  k_ra8_adc_res_12bit = 2U, 
  k_ra8_adc_res_10bit = 3U, 
} ra8_adc_resolution_t;

typedef enum : uint8_t {
  k_ra8_adc_trig_software = 0U, 
  k_ra8_adc_trig_external = 1U, 
  k_ra8_adc_trig_elc      = 2U, 
} ra8_adc_trigger_t;

typedef struct {
  ra8_adc_resolution_t resolution;    
  ra8_adc_trigger_t    trigger;       
  bool                 right_aligned; 
  bool                 scan_mode;     
} ra8_adc_cfg_t;

typedef enum : uint16_t {
  k_ra8_adc_status_none = 0x0000U, 
  k_ra8_adc_status_busy = 0x8000U, 
  k_ra8_adc_status_ie   = 0x1000U, 
} ra8_adc_status_mask_t;

typedef void (*ra8_adc_complete_fn_t)(void* ctx, uint16_t result);

typedef enum : uint8_t {
  k_ra8_adc_trig_src_software = 0U, 
  k_ra8_adc_trig_src_elc      = 1U, 
  k_ra8_adc_trig_src_gpt      = 2U, 
  k_ra8_adc_trig_src_pin      = 3U, 
} ra8_adc_trigger_src_t;

typedef enum : uint8_t {
  k_ra8_adc_priority_low  = 0U, 
  k_ra8_adc_priority_high = 1U, 
} ra8_adc_priority_t;

typedef enum : uint8_t {
  k_ra8_adc_oversample_off = 0U, 
  k_ra8_adc_oversample_4x  = 1U, 
  k_ra8_adc_oversample_16x = 2U, 
  k_ra8_adc_oversample_64x = 3U, 
} ra8_adc_oversample_t;

typedef enum : uint8_t {
  k_ra8_adc_scan_group_max_channels = 8U, 
} ra8_adc_scan_group_caps_t;

typedef struct {
  uint8_t               num_channels;                                
  uint8_t               channels[k_ra8_adc_scan_group_max_channels]; 
  ra8_adc_trigger_src_t trigger;                                     
  ra8_adc_priority_t    priority;                                    
} ra8_adc_scan_group_cfg_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_init(void);

[[nodiscard]] ra8_err_t ra8_adc_init_configured(const ra8_adc_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_adc_deinit(void);
 
/* =============================================================================
 * Legacy polling API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_read_channel(uint8_t channel, uint16_t* out_raw);
 
/* =============================================================================
 * Runtime reconfigure
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_set_resolution(ra8_adc_resolution_t resolution);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_get_status(uint16_t* out_mask);

[[nodiscard]] ra8_err_t ra8_adc_clear_status(void);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_adc_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_adc_exit_stop(void);
 
/* =============================================================================
 * ISR dispatch
 * =============================================================================
 */

void ra8_adc_dispatch_cnv_end(uint8_t channel);
 
/* =============================================================================
 * Scan groups (FSP r_adc_b parity, Sweep 3 Task 1)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_configure_scan_group(uint8_t                         group,
                                                     const ra8_adc_scan_group_cfg_t* cfg);

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

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

[[nodiscard]] ra8_err_t
ra8_adc_read_group_results(uint8_t group, uint16_t* out_buf, uint8_t* out_count);

[[nodiscard]] ra8_err_t ra8_adc_set_continuous_scan(uint8_t group, bool enable);
 
/* =============================================================================
 * Window comparator (FSP r_adc_b parity)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_set_compare_window(uint8_t channel, uint16_t low, uint16_t high);
 
/* =============================================================================
 * Oversampling
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_adc_set_oversampling(uint8_t channel, ra8_adc_oversample_t mode);
 
/* =============================================================================
 * Self-diagnosis + internal / extended-analog channels (HUM Ch 53)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_adc_selfdiag_mode_1 = 1U, 
  k_ra8_adc_selfdiag_mode_2 = 2U, 
  k_ra8_adc_selfdiag_mode_3 = 3U, 
} ra8_adc_selfdiag_mode_t;

typedef enum : uint8_t {
  k_ra8_adc_chan_temperature  = 0x64U, 
  k_ra8_adc_chan_int_ref_volt = 0x65U, 
} ra8_adc_internal_chan_t;

[[nodiscard]] ra8_err_t
ra8_adc_self_diagnose(ra8_adc_selfdiag_mode_t mode, uint16_t* out_code, bool* out_pass);

[[nodiscard]] ra8_err_t ra8_adc_read_internal_channel(ra8_adc_internal_chan_t chan,
                                                      uint16_t*               out_raw);
 
#ifdef __cplusplus
}
#endif