adc.h

Go to the documentation of this file.

 
#ifndef ADC_H
#define ADC_H
 
/* -- Includes -- */
#include <stdint.h>
#include "stm32f4xx.h"
#include "defines.h"
 
/* -- Structs -- */
struct __attribute__((packed)) ADCRegs {
  REG32 SR;
  REG32 CR1;
  REG32 CR2;
  REG32 SMPR[2];
  REG32 JOFR[4];
  REG32 HTR;
  REG32 LTR;
  REG32 SQR[3];
  REG32 JSQR;
  REG32 JDR[4];
  REG32 DR;
};
 
_Static_assert((sizeof(struct ADCRegs)) == (sizeof(uint32_t) * 20U),
               "ADC register struct size mismatch. Is it aligned?");
 
struct __attribute__((packed)) ADCCommonRegs {
  REG32 CSR;
  REG32 CCR;
  REG32 CDR;
};
 
_Static_assert((sizeof(struct ADCCommonRegs)) == (sizeof(uint32_t) * 3U),
               "ADC Common register struct size mismatch. Is it aligned?");
 
#ifndef UTEST
#define ADC_(NUM)  (struct ADCRegs *)(ADC1_BASE + (0x100UL * ((uint8_t)NUM)))
#define ADC_COMMON (struct ADCCommonRegs *)(ADC123_COMMON_BASE)
#else
extern struct ADCRegs *ADC_(const uint8_t number);
extern struct ADCCommonRegs *ADC_COMMON;
#endif
 
struct __attribute__((packed)) ADCModes {
  volatile _Bool DMA  : 1;
  volatile _Bool DDS  : 1;
  volatile _Bool CONT : 1;
  volatile _Bool DISC : 1; // One stop per conversion
  volatile _Bool SCAN : 1;
};
 
_Static_assert((sizeof(struct ADCModes)) == (sizeof(uint8_t) * 1U),
               "ADC Configuration struct size mismatch. Is it aligned?");
 
/* -- Enums -- */
typedef enum adc_peripheral {
#ifdef ADC1_BASE
  ADC_PERIPH_1 = 0x00,
#endif
#ifdef ADC2_BASE
  ADC_PERIPH_2 = 0x01,
#endif
#ifdef ADC3_BASE
  ADC_PERIPH_3 = 0x02,
#endif
  ADC_PERIPH_LEN
} adc_peripheral_t;
 
typedef enum adc_res {
  ADC_RES_B12 = 0x00, // >= 15 ADCCLK cycles
  ADC_RES_B10 = 0x01, // >= 13 ADCCLK cycles
  ADC_RES_B08 = 0x02, // >= 11 ADCCLK cycles
  ADC_RES_B06 = 0x03  // >= 9 ADCCLK cycles
} adc_res_t;
 
typedef enum adc_trigger {
  ADC_TRIGGER_NONE = 0x00,
  ADC_TRIGGER_RISE = 0x01,
  ADC_TRIGGER_FALL = 0x02,
  ADC_TRIGGER_BOTH = 0x03
} adc_trigger_t;
 
typedef enum adc_samplerate {
  ADC_SAMPLERATE_C003 = 0x00,
  ADC_SAMPLERATE_C015 = 0x01,
  ADC_SAMPLERATE_C028 = 0x02,
  ADC_SAMPLERATE_C056 = 0x03,
  ADC_SAMPLERATE_C084 = 0x04,
  ADC_SAMPLERATE_C112 = 0x05,
  ADC_SAMPLERATE_C144 = 0x06,
  ADC_SAMPLERATE_C480 = 0x07
} adc_samplerate_t;
 
typedef enum adc_prescaler {
  ADC_PRESCALER_DIV2 = 0x00,
  ADC_PRESCALER_DIV4 = 0x01,
  ADC_PRESCALER_DIV6 = 0x02,
  ADC_PRESCALER_DIV8 = 0x03,
} adc_prescaler_t;
 
void adc_set_prescaler(const adc_prescaler_t value);
 
void adc_set_resolution(const adc_peripheral_t adc, const adc_res_t value);
 
void adc_set_samplerate(const adc_peripheral_t adc, const uint8_t channel,
                        const adc_samplerate_t value);
 
void adc_set_modes(const adc_peripheral_t adc, const struct ADCModes config);
 
void adc_set_seq(const adc_peripheral_t adc, const uint8_t *seq,
                 const uint8_t count);
 
void adc_on(const adc_peripheral_t adc);
 
void adc_off(const adc_peripheral_t adc);
 
uint16_t adc_read(const adc_peripheral_t adc);
 
#endif