adc.h

#pragma once
 
/************************************************************************************************
 * @file   adc.h
 *
 * @brief  ADC Library Header file
 *
 * @date   2024-11-02
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "gpio.h"
#include "status.h"
 
#define NUM_ADC_CHANNELS 19U
#define NUM_ADC_RANKS 16U
#define ADC_TIMEOUT_MS 100U
 
#define ADC_INVALID_CHANNEL 0U
#define ADC_INVALID_RANK 0U
 
typedef enum {
  ADC_MODE_SINGLE = 0, 
  ADC_MODE_CONTINUOUS, 
  NUM_ADC_MODES,       
} AdcMode;
 
StatusCode adc_init(void);
 
StatusCode adc_add_channel(GpioAddress *address);
 
StatusCode adc_run(void);
 
StatusCode adc_read_raw(GpioAddress *address, uint16_t *reading);
 
StatusCode adc_read_converted(GpioAddress *address, uint16_t *reading);
 
void adc_deinit(void);
 
#ifdef MS_PLATFORM_X86
 
StatusCode adc_set_reading(GpioAddress *address, uint16_t reading);
#endif