[sam] Add SAMx7x DMA driver

Author: chris-durand

README.md

@@ -245,7 +245,7 @@ Please [discover modm's peripheral drivers for your specific device][discover].
 <td align="center">○</td>
 <td align="center">○</td>
 <td align="center">○</td>
-<td align="center">○</td>
+<td align="center">✅</td>
 <td align="center">✕</td>
 <td align="center">✅</td>
 <td align="center">✕</td>

src/modm/platform/dma/samx7x/base.hpp.in

@@ -0,0 +1,298 @@
+/*
+ * Copyright (c) 2023, Christopher Durand
+ *
+ * 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/.
+ */
+// ----------------------------------------------------------------------------
+
+#ifndef MODM_SAMX7X_DMA_BASE_HPP
+#define MODM_SAMX7X_DMA_BASE_HPP
+
+#include <array>
+#include <cstdint>
+#include <modm/architecture/interface/register.hpp>
+#include <modm/platform/device.hpp>
+
+namespace modm::platform
+{
+
+/**
+ * Data type for peripheral hardware requests
+ *
+ * Use modm::platform::DmaRequests::<Peripheral>::<Signal> to obtain values.
+ *
+ * @ingroup modm_platform_dma
+ */
+enum class DmaRequest : uint32_t
+{};
+
+/// @ingroup modm_platform_dma
+struct DmaBase
+{
+	static constexpr std::size_t ChannelCount{24};
+
+	/// XDMAC interrupt flags
+	enum class Interrupt : uint32_t
+	{
+		EndOfBlock = Bit0,
+		EndOfLinkedList = Bit1,
+		EndOfDisable = Bit2,
+		EndOfFlush = Bit3,
+		ReadBusError = Bit4,
+		WriteBusError = Bit5,
+		RequestOverflowError = Bit6
+	};
+
+	MODM_FLAGS32(Interrupt);
+
+	enum class TransferType : uint32_t
+	{
+		MemoryToMemory = 0,
+		Peripheral = XDMAC_CC_TYPE
+	};
+
+	enum class PeripheralDirection : uint32_t
+	{
+		PeripheralToMemory = 0,
+		MemoryToPeripheral = XDMAC_CC_DSYNC
+	};
+
+	enum class RequestSource : uint32_t
+	{
+		Hardware = 0,
+		Software = XDMAC_CC_SWREQ
+	};
+
+	/// Transfer data width (8, 16, 32 bit)
+	enum class DataWidth : uint32_t
+	{
+		Byte = 0,
+		HalfWord = XDMAC_CC_DWIDTH_HALFWORD,
+		Word = XDMAC_CC_DWIDTH_WORD
+	};
+
+	/**
+	 * Select DMA AHB interface
+	 *
+	 * The right interface has to be selected for the transfer to succeed:
+	 * Flash: Bus 1
+	 * RAM: Bus 0 or 1
+	 * Peripherals: Bus 1
+	 * Core AHBS, TCM: Bus 0
+	 */
+	enum class BusInterface : uint32_t
+	{
+		Bus0 = 0,
+		Bus1 = 1
+	};
+
+	enum class AddressingMode : uint32_t
+	{
+		// Do not increment address after transfer
+		Fixed = 0,
+		// Increment address after transfer by one data width
+		Incrementing = 1,
+		// Increment address after transfer by one data width plus data stride
+		Strided = 3
+	};
+
+	enum class ChannelConfig : uint32_t
+	{};
+	MODM_FLAGS32(ChannelConfig);
+
+	using TransferType_t = Configuration<ChannelConfig_t, TransferType, XDMAC_CC_TYPE_Msk>;
+	using PeripheralDirection_t = Configuration<ChannelConfig_t, PeripheralDirection, XDMAC_CC_DSYNC_Msk>;
+	using RequestSource_t = Configuration<ChannelConfig_t, RequestSource, XDMAC_CC_SWREQ_Msk>;
+	using DataWidth_t = Configuration<ChannelConfig_t, DataWidth, XDMAC_CC_DWIDTH_Msk>;
+	using SourceBusInterface_t = Configuration<ChannelConfig_t, BusInterface, 0b1, XDMAC_CC_SIF_Pos>;
+	using DestinationBusInterface_t = Configuration<ChannelConfig_t, BusInterface, 0b1, XDMAC_CC_DIF_Pos>;
+	using SourceAddressingMode_t = Configuration<ChannelConfig_t, AddressingMode, 0b11, XDMAC_CC_SAM_Pos>;
+	using DestinationAddressingMode_t = Configuration<ChannelConfig_t, AddressingMode, 0b11, XDMAC_CC_DAM_Pos>;
+	using DmaRequest_t = Configuration<ChannelConfig_t, DmaRequest, 0x7f, XDMAC_CC_PERID_Pos>;
+
+	/// Type of linked list mode descriptor
+	enum class ViewType : uint8_t
+	{
+		View0 = XDMAC_CNDC_NDVIEW_NDV0,
+		View1 = XDMAC_CNDC_NDVIEW_NDV1,
+		View2 = XDMAC_CNDC_NDVIEW_NDV2,
+		View3 = XDMAC_CNDC_NDVIEW_NDV3
+	};
+
+	/// Base class for linked list transfer descriptors
+	class ViewBase
+	{
+	public:
+		constexpr ViewBase(uint32_t* data) : data_{data} {}
+
+		constexpr void
+		setDataLength(std::size_t length);
+
+		constexpr std::size_t
+		dataLength() const;
+
+	protected:
+		uint32_t* data_{};
+	};
+
+	/**
+	 * "View0" linked list transfer descriptor with destination address
+	 *
+	 * Set destination address and data length.
+	 * @warning Can only be used with peripheral-to-memory transfers.
+	 */
+	class View0Dst : public ViewBase
+	{
+	public:
+		using ViewBase::ViewBase;
+
+		using Data = std::array<uint32_t, 3>;
+		static constexpr auto Type = ViewType::View0;
+
+		constexpr void
+		setDestinationAddress(uintptr_t address);
+
+		constexpr void
+		setDestinationAddress(volatile void* data);
+
+		constexpr uintptr_t
+		destinationAddress() const;
+	};
+
+	/**
+	 * "View0" linked list transfer descriptor with source address
+	 *
+	 * Set source address and data length.
+	 * @warning Can only be used with memory-to-peripheral transfers.
+	 */
+	class View0Src : public ViewBase
+	{
+	public:
+		using ViewBase::ViewBase;
+
+		using Data = std::array<uint32_t, 3>;
+		static constexpr auto Type = ViewType::View0;
+
+		constexpr void
+		setSourceAddress(uintptr_t address);
+
+		constexpr void
+		setSourceAddress(const volatile void* data);
+
+		constexpr uintptr_t
+		sourceAddress() const;
+	};
+
+	/**
+	 * "View1" linked list transfer descriptor
+	 *
+	 * Set source address, destination address and data length.
+	 */
+	class View1 : public View0Src
+	{
+	public:
+		using View0Src::View0Src;
+
+		using Data = std::array<uint32_t, 4>;
+		static constexpr auto Type = ViewType::View1;
+
+		constexpr void
+		setDestinationAddress(uintptr_t address);
+
+		constexpr void
+		setDestinationAddress(volatile void* data);
+
+		constexpr uintptr_t
+		destinationAddress() const;
+	};
+
+	/**
+	 * "View2" linked list transfer descriptor
+	 *
+	 * Set source address, destination address, data length and transfer
+	 * configuration.
+	 */
+	class View2 : public View1
+	{
+	public:
+		using View1::View1;
+
+		using Data = std::array<uint32_t, 5>;
+		static constexpr auto Type = ViewType::View2;
+
+		constexpr void
+		setConfiguration(ChannelConfig_t configuration);
+
+		constexpr ChannelConfig_t
+		configuration() const;
+
+	};
+
+	/**
+	 * "View3" linked list transfer descriptor
+	 *
+	 * Set source address, destination address, data length, transfer
+	 * configuration and data stride offsets.
+	 */
+	class View3 : public View2
+	{
+	public:
+		using View2::View2;
+
+		using Data = std::array<uint32_t, 9>;
+		static constexpr auto Type = ViewType::View3;
+
+		constexpr int16_t
+		sourceDataStride() const;
+
+		constexpr void
+		setSourceDataStride(int16_t stride);
+
+		constexpr int16_t
+		destinationDataStride() const;
+
+		constexpr void
+		setDestinationDataStride(int16_t stride);
+	};
+};
+
+namespace DmaRequests
+{
+%% for peripheral, instances in requests.items()
+
+%% if none in instances
+	struct {{ peripheral | capitalize }}
+	{
+%% for s in instances[None]
+		static constexpr auto {{ s["signal"] }} = DmaRequest({{ s["id"] }});
+%% endfor
+	};
+
+%% else
+	template<std::size_t Instance>
+	struct {{ peripheral | capitalize }};
+
+%% for i, signals in instances.items()
+	template<>
+	struct {{ peripheral | capitalize }}<{{ i }}>
+	{
+%% for s in signals
+		static constexpr auto {{ s["signal"] }} = DmaRequest({{ s["id"] }});
+%% endfor
+	};
+
+%% endfor
+%% endif
+
+%% endfor
+}
+
+} // namespace modm::platform
+
+#include "base_impl.hpp"
+
+#endif // MODM_SAMX7X_DMA_BASE_HPP