improved Spi for STM and AVR

Author: TomSaw

src/modm/architecture/interface/spi.hpp

@@ -12,13 +12,24 @@
  */
 // ----------------------------------------------------------------------------
 
-#ifndef MODM_INTERFACE_SPI_HPP
-#define MODM_INTERFACE_SPI_HPP
+#pragma once
 
 #include <modm/architecture/interface/peripheral.hpp>
 
 namespace modm
 {
+namespace spi
+{
+
+template<class Spi>
+concept Support_DataSize_Bit16 = requires
+{ Spi::DataSize::Bit16; };
+
+template<class Spi>
+concept Support_DataSize_Bit32 = requires
+{ Spi::DataSize::Bit32; };
+
+}  // namespace spi
 
 /// @ingroup modm_architecture_spi
 struct Spi
@@ -43,8 +54,7 @@ struct Spi
 		MsbFirst = 0b0,
 		LsbFirst = 0b1,
 	};
+
 };
 
 } // namespace modm
-
-#endif // MODM_INTERFACE_SPI_HPP

src/modm/architecture/interface/spi_master.hpp

@@ -12,8 +12,7 @@
  */
 // ----------------------------------------------------------------------------
 
-#ifndef MODM_INTERFACE_SPI_MASTER_HPP
-#define MODM_INTERFACE_SPI_MASTER_HPP
+#pragma once
 
 #include <modm/processing/resumable.hpp>
 #include "spi.hpp"
@@ -156,8 +155,22 @@ class SpiMaster : public ::modm::PeripheralDriver, public Spi
 	static modm::ResumableResult<void>
 	transfer(const uint8_t *tx, uint8_t *rx, std::size_t length);
 #endif
+
+public:
+	enum State : uint8_t {
+		Idle = Bit6,	// Transaction is running
+		Repeat = Bit7,	// Send same tx multiple times
+	};
+	MODM_FLAGS8(State);
+
+	enum DataType : uint8_t {
+		Byte = 0,			// 1 byte
+		HalfWord = 1,		// 2 bytes
+		Word = 2,			// 4 bytes
+		// WordWord = 3		// 8 bytes
+	};
+	typedef Value<State_t, 2> DataType_t;
+	
 };
 
 } // namespace modm
-
-#endif // MODM_INTERFACE_SPI_MASTER_HPP

src/modm/math/utils/binary.hpp

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2021, Thomas Sommer
+ *
+ * This file is part of the modm project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#pragma once
+
+#include <limits>
+#include <concepts>
+
+// TODO I'm not sure about this :/
+
+namespace modm {
+	template<typename T>
+	concept unsigned_integral_max8 = std::unsigned_integral<T> and std::numeric_limits<T>::digits <= 8;
+	
+	template<typename T>
+	concept unsigned_integral_max16 = std::unsigned_integral<T> and std::numeric_limits<T>::digits <= 16;
+
+	template<typename T>
+	concept unsigned_integral_max32 = std::unsigned_integral<T> and std::numeric_limits<T>::digits <= 32;
+
+	template<typename T>
+	concept unsigned_integral_max64 = std::unsigned_integral<T> and std::numeric_limits<T>::digits <= 64;
+}

src/modm/platform/dma/stm32/dma.hpp.in

@@ -190,6 +190,18 @@ public:
 			ChannelHal::setPeripheralAddress(address);
 		}
 
+				static void
+		setMemoryDataSize(MemoryDataSize memoryDataSize)
+		{
+			ChannelHal::setMemoryDataSize(memoryDataSize);
+		}
+
+		static void
+		setPeripheralDataSize(PeripheralDataSize peripheralDataSize)
+		{
+			ChannelHal::setPeripheralDataSize(peripheralDataSize);
+		}
+
 		/**
 		 * Enable/disable memory increment
 		 *

src/modm/platform/dma/stm32/dma_base.hpp.in

@@ -155,6 +155,7 @@ public:
 		Bit16 		= HalfWord,
 		Word 		= {{ reg_prefix }}_MSIZE_1,
 		Bit32 		= Word,
+		All			= DMA_CCR_MSIZE_0 | DMA_CCR_MSIZE_1
 	};
 
 	enum class
@@ -166,6 +167,7 @@ public:
 		Bit16 		= HalfWord,
 		Word 		= {{ reg_prefix }}_PSIZE_1,
 		Bit32 		= Word,
+		All			= DMA_CCR_PSIZE_0 | DMA_CCR_PSIZE_1
 	};
 
 	enum class

src/modm/platform/dma/stm32/dma_hal.hpp.in

@@ -250,6 +250,22 @@ public:
 %% endif
 	}
 
+	static void
+	setMemoryDataSize(MemoryDataSize memoryDataSize)
+	{
+		DMA_Channel_TypeDef *Base = (DMA_Channel_TypeDef *) CHANNEL_BASE;
+		Base->CCR &= ~uint32_t(MemoryDataSize::All);
+		Base->CCR |= uint32_t(memoryDataSize);
+	}
+
+	static void
+	setPeripheralDataSize(PeripheralDataSize peripheralDataSize)
+	{
+		DMA_Channel_TypeDef *Base = (DMA_Channel_TypeDef *) CHANNEL_BASE;
+		Base->CCR &= ~uint32_t(PeripheralDataSize::All);
+		Base->CCR |= uint32_t(peripheralDataSize);
+	}
+
 	/**
 	 * Enable/disable memory increment
 	 *
@@ -290,9 +306,11 @@ public:
 
 	/**
 	 * Set length of data to transfer
+	 *
+	 * @param lenght	range: 0-65535
 	 */
 	static void
-	setDataLength(std::size_t length)
+	setDataLength(uint16_t length)
 	{
 		DMA_Channel_TypeDef *Base = (DMA_Channel_TypeDef *) CHANNEL_BASE;
 %% if dmaType in ["stm32-channel-request", "stm32-channel", "stm32-mux"]

src/modm/platform/spi/at90_tiny_mega/module.lb

@@ -48,8 +48,9 @@ class Instance(Module):
         env.substitutions = properties
         env.outbasepath = "modm/src/modm/platform/spi"
 
-        env.template("spi.hpp.in", "spi{}.hpp".format(self.instance))
+        env.template("spi_base.hpp.in", "spi{}.hpp".format(self.instance))
         env.template("spi_master.hpp.in", "spi_master{}.hpp".format(self.instance))
+        env.template("spi_master_impl.hpp.in", "spi_master{}_impl.hpp".format(self.instance))
         env.template("spi_master.cpp.in", "spi_master{}.cpp".format(self.instance))
 
 def init(module):
@@ -87,6 +88,7 @@ def build(env):
     env.outbasepath = "modm/src/modm/platform/spi"
 
     if "instance" not in driver:
+        env.template("spi_base.hpp.in")
         env.template("spi_master.hpp.in")
+        env.template("spi_master_impl.hpp.in")
         env.template("spi_master.cpp.in")
-        env.template("spi.hpp.in")

src/modm/platform/spi/at90_tiny_mega/spi.hpp.in

@@ -9,16 +9,14 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 // ----------------------------------------------------------------------------
-
-#ifndef MODM_AVR_SPI_HPP
-#define MODM_AVR_SPI_HPP
+#pragma once
 
 #include <avr/io.h>
 
 /// @cond
 %% if partname in ["attiny40"]
 // The avr-libc Header files for the ATtiny40 is missing the following
-// defines although they are meantioned in the datasheet.
+// defines although they are mentioned in the datasheet.
 #define SPR0    0
 #define SPR1    1
 #define CPHA    2
@@ -51,10 +49,7 @@
 %% endif
 /// @endcond
 
-namespace modm
-{
-
-namespace platform
+namespace modm::platform
 {
 
 /// @ingroup	modm_platform_spi
@@ -71,10 +66,29 @@ struct Spi
 		Div64 = (1 << SPR1{{ id }}),
 		Div128 = (1 << SPR1{{ id }}) | (1 << SPR0{{ id }}),
 	};
-};
 
-} // namespace platform
+	enum State : uint8_t {
+		Idle = Bit6,	// Transaction is running
+		Repeat = Bit7,	// Send same tx multiple times
+	};
+	MODM_FLAGS8(State);
+
+	enum DataType : uint8_t {
+		Byte = 0,			// 1 byte
+		HalfWord = 1,		// 2 bytes
+		Word = 2,			// 4 bytes
+		// WordWord = 3		// 8 bytes
+	};
+	typedef Value<State_t, 2> DataType_t;
+};
 
-} // namespace modm
+	enum Type : uint8_t {
+		Byte = 0,			// 1 byte
+		HalfWord = 1,		// 2 bytes
+		Word = 2,			// 4 bytes
+		// WordWord = 3		// 8 bytes
+	};
+	typedef Value<State_t, 2> Type_t;
+};
 
-#endif	// MODM_AVR_SPI_HPP
+} // namespace modm::platform

src/modm/platform/spi/at90_tiny_mega/spi_base.hpp.in

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2013-2015, 2017, Niklas Hauser
+ * Copyright (c) 2017, Fabian Greif
+ *
+ * This file is part of the modm project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+// ----------------------------------------------------------------------------
+#pragma once
+
+#include <avr/io.h>
+
+/// @cond
+%% if partname in ["attiny40"]
+// The avr-libc Header files for the ATtiny40 is missing the following
+// defines although they are mentioned in the datasheet.
+#define SPR0    0
+#define SPR1    1
+#define CPHA    2
+#define CPOL    3
+#define MSTR    4
+#define DORD    5
+#define SPE     6
+#define SPIE    7
+
+#define SPI2X   0
+#define WCOL    6
+#define SPIF    7
+%% elif partname in ["atmega164pa", "atmega324pa"]
+// The avr-libc Header files for the ATmega{16,32}4pa are declaring the
+// following registers with a trailing zero. Why, Atmel, whyyyy?
+#define SPCR    SPCR0
+#define SPR0    SPR00
+#define SPR1    SPR10
+#define CPHA    CPHA0
+#define CPOL    CPOL0
+#define MSTR    MSTR0
+#define DORD    DORD0
+#define SPE     SPE0
+#define SPIE    SPIE0
+#define SPSR    SPSR0
+#define SPI2X   SPI2X0
+#define WCOL    WCOL0
+#define SPIF    SPIF0
+#define SPDR    SPDR0
+%% endif
+/// @endcond
+
+namespace modm::platform
+{
+
+/// @ingroup	modm_platform_spi
+struct SpiBase
+{
+	enum class
+	Prescaler : uint8_t
+	{
+		Div2 = 0x80 | 0,
+		Div4 = 0,
+		Div8 = 0x80 | (1 << SPR0{{ id }}),
+		Div16 = (1 << SPR0{{ id }}),
+		Div32 = 0x80 | (1 << SPR1{{ id }}),
+		Div64 = (1 << SPR1{{ id }}),
+		Div128 = (1 << SPR1{{ id }}) | (1 << SPR0{{ id }}),
+	};
+};
+
+} // namespace modm::platform