From d6150bfdd20e3b7be385fa8529a04204b4fc1416 Mon Sep 17 00:00:00 2001
From: Ville Juven <ville.juven@unikie.com>
Date: Fri, 15 Sep 2023 12:15:54 +0300
Subject: [PATCH] risc-v/mpfs: Add DMA buffer allocator for eMMC access

The MPFS eMMC DMA has some requirements that are only fulfilled by
enabling separate DMA access buffers (FAT DMA buffers) and by forcing
indirect access to the media via FAT_FORCE_INDIRECT.

Why? Direct access to user buffers violates two things:
- Buffer alignment is not ensured
- Buffers are user memory (problematic in BUILD_KERNEL)
---
 arch/risc-v/src/mpfs/Kconfig          |  3 +
 arch/risc-v/src/mpfs/Make.defs        |  4 ++
 arch/risc-v/src/mpfs/mpfs_dma_alloc.c | 94 +++++++++++++++++++++++++++
 3 files changed, 101 insertions(+)
 create mode 100644 arch/risc-v/src/mpfs/mpfs_dma_alloc.c

diff --git a/arch/risc-v/src/mpfs/Kconfig b/arch/risc-v/src/mpfs/Kconfig
index 75b2e5dc3a4d9..59d28920f5808 100644
--- a/arch/risc-v/src/mpfs/Kconfig
+++ b/arch/risc-v/src/mpfs/Kconfig
@@ -391,6 +391,9 @@ config MPFS_EMMCSD
 	select ARCH_HAVE_SDIO
 	select SDIO_BLOCKSETUP
 	select SDIO_DMA
+	select FAT_DMAMEMORY
+	select FAT_FORCE_INDIRECT
+	select GRAN
 	default n
 	---help---
 		Selects the MPFS eMMCSD driver.
diff --git a/arch/risc-v/src/mpfs/Make.defs b/arch/risc-v/src/mpfs/Make.defs
index 2692647db7a59..925e4467619a8 100644
--- a/arch/risc-v/src/mpfs/Make.defs
+++ b/arch/risc-v/src/mpfs/Make.defs
@@ -62,6 +62,10 @@ ifeq ($(CONFIG_MPFS_EMMCSD),y)
 CHIP_CSRCS += mpfs_emmcsd.c
 endif
 
+ifeq ($(CONFIG_FAT_DMAMEMORY),y)
+CHIP_CSRCS += mpfs_dma_alloc.c
+endif
+
 ifeq ($(CONFIG_MPFS_COREMMC),y)
 CHIP_CSRCS += mpfs_coremmc.c
 endif
diff --git a/arch/risc-v/src/mpfs/mpfs_dma_alloc.c b/arch/risc-v/src/mpfs/mpfs_dma_alloc.c
new file mode 100644
index 0000000000000..fdf364bb3e312
--- /dev/null
+++ b/arch/risc-v/src/mpfs/mpfs_dma_alloc.c
@@ -0,0 +1,94 @@
+/****************************************************************************
+ * arch/risc-v/src/mpfs/mpfs_dma_alloc.c
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.  The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <syslog.h>
+#include <stdint.h>
+#include <errno.h>
+#include <nuttx/mm/gran.h>
+
+#if defined(CONFIG_FAT_DMAMEMORY) && defined(CONFIG_GRAN)
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+#define BOARD_DMA_ALLOC_POOL_SIZE (8*512)
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+static GRAN_HANDLE dma_allocator;
+
+/* The DMA heap size constrains the total number of things that can be
+ * ready to do DMA at a time.
+ *
+ * For example, FAT DMA depends on one sector-sized buffer per filesystem
+ * plus one sector-sized buffer per file.
+ *
+ * We use a fundamental alignment / granule size of 64B; it fulfills the
+ * requirement for any DMA engine.
+ */
+
+static uint8_t g_dma_heap[BOARD_DMA_ALLOC_POOL_SIZE] aligned_data(64);
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: mpfs_dma_alloc
+ *
+ * Description:
+ *   All boards may optionally provide this API to instantiate a pool of
+ *   memory for uses with FAST FS DMA operations.
+ *
+ ****************************************************************************/
+
+int mpfs_dma_alloc_init(void)
+{
+  /* Allocate 128B granules with 64B alignment */
+
+  dma_allocator = gran_initialize(g_dma_heap, sizeof(g_dma_heap), 7, 6);
+
+  if (dma_allocator == NULL)
+    {
+      return -ENOMEM;
+    }
+
+  return OK;
+}
+
+void *fat_dma_alloc(size_t size)
+{
+  return gran_alloc(dma_allocator, size);
+}
+
+void fat_dma_free(void *memory, size_t size)
+{
+  gran_free(dma_allocator, memory, size);
+}
+
+#endif /* CONFIG_FAT_DMAMEMORY && CONFIG_GRAN */