stm32_uart_gpdma.hpp

#pragma once
 
#include <cstddef>
#include <cstdint>
 
#include "main.h"
 
#if defined(STM32H5)
#define LIBXR_STM32_UART_GPDMA 1
#endif
 
#if (defined(LIBXR_STM32_UART_GPDMA) && defined(HAL_UART_MODULE_ENABLED)) || \
    defined(__DOXYGEN__)
 
#if !defined(HAL_DMA_MODULE_ENABLED) || !defined(DMA_LINKEDLIST_CIRCULAR) || \
    !defined(DMA_GPDMA_LINEAR_NODE) || !defined(IS_GPDMA_INSTANCE)
#error "STM32H5 UART requires the HAL GPDMA linked-list API"
#endif
 
#if (defined(STM32H503xx) || defined(STM32H523xx) || defined(STM32H533xx) || \
     defined(STM32H543xx) || defined(STM32H553xx) || defined(STM32H562xx) || \
     defined(STM32H563xx) || defined(STM32H573xx)) &&                        \
    !defined(USART_DMAREQUESTS_SW_WA)
#error "STM32H5 UART requires the HAL USART DMA-request workaround"
#endif
 
namespace LibXR
{
class STM32GpdmaUartAdapter
{
 public:
  static constexpr size_t RX_NODE_COUNT = 4U;
  using AbortCallback = void (*)(DMA_HandleTypeDef*);
 
  explicit STM32GpdmaUartAdapter(UART_HandleTypeDef* uart_handle);
 
  HAL_StatusTypeDef StartLinkedListDmaRx(uint8_t* buffer, size_t total_size, bool in_isr);
  [[nodiscard]] uint8_t* GetLinkedListDmaRxProducer() const;
  void CloseTxTerminalSource() const;
  [[nodiscard]] bool LaunchStop(DMA_HandleTypeDef* dma_handle, AbortCallback callback,
                                bool in_isr);
  [[nodiscard]] static bool StopComplete(DMA_HandleTypeDef* dma_handle);
  [[nodiscard]] bool AllStopsComplete() const;
  static void FinalizeStopped(DMA_HandleTypeDef* dma_handle, bool in_isr);
 
 private:
  // 节点保持在同一 64 KiB 链表地址窗口内。
  // Keep all nodes within one 64 KiB linked-list address window.
  struct alignas(256) StateBlock
  {
    DMA_NodeTypeDef nodes_[RX_NODE_COUNT];
    DMA_QListTypeDef rx_queue_{};
    UART_HandleTypeDef* uart_handle_ = nullptr;
    uint8_t* rx_buffer_ = nullptr;
    size_t rx_total_size_ = 0U;
    size_t rx_node_size_ = 0U;
    bool rx_queue_built_ = false;
  };
  static_assert(offsetof(StateBlock, nodes_) == 0U);
  static_assert(sizeof(StateBlock) == 256U);
 
  [[nodiscard]] static bool IsStopped(DMA_HandleTypeDef* dma_handle);
  static void DisableInterrupts(DMA_HandleTypeDef* dma_handle);
  static void ClearFlags(DMA_HandleTypeDef* dma_handle);
  void BuildRxQueue(uint8_t* buffer, size_t total_size, bool in_isr);
  StateBlock state_{};
};
static_assert(sizeof(STM32GpdmaUartAdapter) == 256U);
}  // namespace LibXR
#endif