ra8_doc.h

Go to the documentation of this file.

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

[[nodiscard]] ra8_err_t ra8_doc_init(void);

[[nodiscard]] ra8_err_t ra8_doc_add16(uint16_t a, uint16_t b, uint16_t* out_sum);

[[nodiscard]] ra8_err_t ra8_doc_sub16(uint16_t a, uint16_t b, uint16_t* out_diff);
 
/* =============================================================================
 * Window comparison
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_doc_window_inside  = 0U, 
  k_ra8_doc_window_outside = 1U, 
} ra8_doc_window_polarity_t;

[[nodiscard]] ra8_err_t
ra8_doc_set_window(uint16_t lower, uint16_t upper, ra8_doc_window_polarity_t polarity);

[[nodiscard]] ra8_err_t ra8_doc_window_compare(uint16_t value, bool* out_flag);
 
#ifdef __cplusplus
}
#endif