adc.h

#ifndef _adc_h_
#define _adc_h_

#include "chip.h"
#include "types.h"

#ifdef __cplusplus
extern "C"{
#endif // __cplusplus


#define ADC_TO_FLOAT(i) ((i)/((float)(1<<12)))

// Should be called by variant init once for each ADC

// Only does something for F4, not F3 std periph libs
void adcCommonInit();
// Should be called once per ADC
void adcInit(ADC_TypeDef *ADCx);


void analogReadSampleTime(uint8_t sampleTime);


uint16_t analogRead(uint8_t pin);


// const uint16_t *analogSyncRead(uint8_t pin1, uint8_t pin2, uint8_t pin3);
// const uint16_t *analogSyncRead2(uint8_t pin1, uint8_t pin2);
 // end of Analog


// Init DMA for ADC
// 
// numChannels must be smaller than or equal to 9 (ADC1 has 9 channels on the chip)
// void dmaInit(DMA_Channel_TypeDef *dmaYChannelX, uint16_t bufferSize, uint32_t periphalBaseAddr, uint32_t memoryBaseAddr);

// typedef enum ADCTriggerType {
//   CONTINUOUS, SOFTWARE_START
// } ADCTriggerType;


// Initialize ADC channels
// @numChannels number of ADC conversions needed
// @pins Array of pins of size `numChannels`
// 
// This function is a departure from the Arduino API and must be called at the moment. 
// 
// *NOTE:* This API may change to be more Arduino-compatible.
// 
// *FIXME:* Make it unnecessary to call adcInit Idea: just like with the timer system, create a data structure of all 9 or so ADC's, and calling analogRead or analogReadBatch once will add that ADC pin to the list of conversions?
// void adcInit(int numChannels, const uint8_t *pins);

// Read sequentially
// @numChannels Number of channels
// @pins Array of size numChannels, to convert sequentially
// @out Array to store converted values in
// 
// This function performs *numChannels* ADC conversions sequentially.
// 
// The STM32 only has 1 ADC, but with several channels, and consequently, triggering a regular conversion converts all the channels. So, it is more efficient to do the conversion in batch  (taking O(1) time) rather than sequentially (taking O(n) time).
// 
// To use,
// 
// * Call <adcSetMode> (or defaults to CONTINUOUS)
// * Call <adcInit> with all the pins required
// * Call <analogReadBatch> to sequentially sample all the inited ADC channels
// void analogReadBatch(int numChannels, const uint8_t *pins, uint16_t *out);


// Set ADC trigger type
// @mode CONTINUOUS (**default**) or SOFTWARE_START
// 
// Set the ADC trigger type.
// 
// * Must be called before <adcInit>
// * Calling <analogRead> or <analogReadBatch> should be faster in CONTINUOUS conversion mode, but if precise timing (or Arduino-like behavior) is required, select SOFTWARE_START. Then, the conversion is triggered by <analogRead> or <analogReadBatch>.
// void adcSetMode(ADCTriggerType mode);


#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus

#endif