[stm32] Add DMA capabilities to F0/G0 ADC

Co-authored-by: Christopher Durand <[email protected]>

Author: 2 people

src/modm/platform/adc/stm32f0/adc.hpp.in

@@ -3,6 +3,8 @@
  * Copyright (c) 2018, Álan Crístoffer
  * Copyright (c) 2018, Carl Treudler
  * Copyright (c) 2018-2019, Niklas Hauser
+ * Copyright (c) 2023, Daniel Waldhaeusl (Zuehlke Engineering)
+ * Copyright (c) 2024, Christopher Durand
  *
  * This file is part of the modm project.
  *
@@ -15,7 +17,10 @@
 #ifndef MODM_STM32{{ target.family | upper }}_ADC{{ id }}_HPP
 #define MODM_STM32{{ target.family | upper }}_ADC{{ id }}_HPP
 
-#include <stdint.h>
+#include <array>
+#include <cstdint>
+#include <span>
+#include <utility>
 #include "../device.hpp"
 #include <modm/architecture/interface/adc.hpp>
 #include <modm/architecture/interface/register.hpp>
@@ -48,6 +53,14 @@ public:
 %% endfor
 	};
 
+	enum class ChannelMask : uint32_t
+	{
+%% for channel, name in channels.items() | sort
+		{{ name }} = (1u << {{ channel }}),
+%% endfor
+	};
+	MODM_FLAGS32(ChannelMask);
+
 	enum class ClockMode
 	{
 		Synchronous,
@@ -140,6 +153,41 @@ public:
 	};
 	MODM_FLAGS32(InterruptFlag);
 
+	enum class DmaMode : uint32_t
+	{
+		Disabled = 0,
+		OneShot = ADC_CFGR1_DMAEN,
+		Circular = ADC_CFGR1_DMACFG | ADC_CFGR1_DMAEN,
+		Mask = Circular
+	};
+
+	enum class ExternalTriggerPolarity
+	{
+		NoTriggerDetection = 0x0u,
+		RisingEdge = 0x1u,
+		FallingEdge = 0x2u,
+		RisingAndFallingEdge = 0x3u,
+	};
+
+	/**
+	 * Regular conversion external trigger sources
+	 *
+	 * The source mapped to each event varies per controller family,
+	 * refer to the ADC external trigger section in the reference manual
+	 * of your controller for more information
+	 */
+	enum class RegularConversionExternalTrigger
+	{
+		Event0 = 0x0u,
+		Event1 = 0x1u,
+		Event2 = 0x2u,
+		Event3 = 0x3u,
+		Event4 = 0x4u,
+		Event5 = 0x5u,
+		Event6 = 0x6u,
+		Event7 = 0x7u,
+	};
+
 public:
 	// start inherited documentation
 	template< class... Signals >
@@ -169,6 +217,9 @@ public:
 	static void
 	initialize();
 
+	static inline void
+	enable();
+
 	static inline void
 	disable();
 
@@ -198,6 +249,9 @@ public:
 	static inline void
 	startConversion();
 
+	static inline void
+	stopConversion();
+
 	static inline bool
 	isConversionFinished();
 
@@ -251,6 +305,37 @@ public:
 	setChannel(Channel channel);
 %% endif
 
+	/**
+	 * Set channel scan sequence mask. All selected channels will be converted
+	 * sequentially starting from the lowest.
+	 *
+	 * @param channels Mask of channels to convert
+	 */
+	static inline void
+	setChannels(ChannelMask_t channels);
+
+	template<typename... Gpios>
+	static consteval ChannelMask_t
+	channelMaskFromPins();
+
+%% if target.family in ["g0"]
+	/**
+	 * Set channel scan sequence to convert up to 8 channels in arbitrary order.
+	 *
+	 * @warning The sequence provided must contain at least one but no more than 8 channels.
+	 * 			Channels above 15 are not supported due to hardware limitations. If channels
+	 * 			16 to 18 should be sampled the in-order conversion sequence must be used instead.
+	 * @param channels Flag mask of channels to convert
+	 * @return true if provided channel sequence is valid, false otherwise.
+	 */
+	static inline bool
+	setChannels(std::span<const Channel> channels);
+
+	template<typename... Gpios>
+	static consteval std::array<Channel, sizeof...(Gpios)>
+	channelSequenceFromPins();
+%% endif
+
 	static inline void
 	clearChannel(Channel channel);
 
@@ -287,6 +372,9 @@ public:
 %% if target.family in ["g0"]
 	static inline void
 	setSampleTime(SampleTime sampleTime, SampleTimeGroup group = SampleTimeGroup::Group1);
+
+	static inline void
+	setSampleTimeGroup(Channel channel, SampleTimeGroup group = SampleTimeGroup::Group1);
 %% else
 	static inline void
 	setSampleTime(SampleTime sampleTime);
@@ -314,6 +402,47 @@ public:
 	static inline void
 	acknowledgeInterruptFlags(InterruptFlag_t flags);
 
+	static inline uintptr_t
+	getDataRegisterAddress();
+
+	static inline void
+	enableRegularConversionExternalTrigger(
+		ExternalTriggerPolarity externalTriggerPolarity,
+		RegularConversionExternalTrigger regularConversionExternalTrigger);
+
+	/**
+	 * Configure DMA mode (disabled, one-shot or circular)
+	 *
+	 * In one-shot mode DMA requests are disabled at the end of the DMA transfer.
+	 * If circular mode is selected request are being generated as long as
+	 * conversions are performed.
+	 *
+	 * @warning May only be called while no conversion is ongoing
+	 */
+	static inline void
+	setDmaMode(DmaMode mode);
+
+	static inline bool
+	getAdcEnabled();
+
+	static inline void
+	enableInternalChannel(Channel channel);
+
+private:
+%% if target.family in ["g0"]
+	static inline void
+	waitChannelConfigReady();
+
+	static inline void
+	resetChannelConfigReady();
+
+	static inline void
+	enableOrderedSequenceMode();
+
+	static inline void
+	disableOrderedSequenceMode();
+%% endif
+
 public:
 	static constexpr uint8_t TS_CAL1_TEMP{30};
 %% if target.family in ["f0"]