bsps/zynqmp: Add JFFS2 NAND adapter

This adds the glue code necessary to allow JFFS2 to operate on top of
NAND memory hosted by the XNandPsu peripheral/driver.

2 files changed, 382 insertions, 0 deletions

diff --git a/bsps/aarch64/xilinx-zynqmp/include/bsp/jffs2_xnandpsu.h b/bsps/aarch64/xilinx-zynqmp/include/bsp/jffs2_xnandpsu.h
new file mode 100644
index 0000000000..6b55e50b2b
--- /dev/null
+++ b/bsps/aarch64/xilinx-zynqmp/include/bsp/jffs2_xnandpsu.h
@@ -0,0 +1,56 @@
+/*
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (C) 2023 On-Line Applications Research Corporation (OAR)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef LIBBSP_XILINX_ZYNQMP_JFFS2_XNANDPSU_H
+#define LIBBSP_XILINX_ZYNQMP_JFFS2_XNANDPSU_H
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif /* __cplusplus */
+
+#include <dev/nand/xnandpsu.h>
+#include <rtems/jffs2.h>
+
+/**
+ * @brief Mount JFFS2 filesystem on NAND device.
+ *
+ * @param[in] mount_dir The directory to mount the filesystem at.
+ * @param[in] NandPsuInstancePtr A pointer to an initialized NAND instance.
+ *
+ * @retval 0 Successful operation. Negative number otherwise.
+ */
+int xilinx_zynqmp_nand_jffs2_initialize(
+  const char *mount_dir,
+  XNandPsu *NandPsuInstancePtr
+);
+
+#ifdef __cplusplus
+}
+#endif  /* __cplusplus */
+
+#endif  /* LIBBSP_XILINX_ZYNQMP_JFFS2_XNANDPSU_H */
diff --git a/bsps/aarch64/xilinx-zynqmp/jffs2_xnandpsu.c b/bsps/aarch64/xilinx-zynqmp/jffs2_xnandpsu.c
new file mode 100644
index 0000000000..a64be91058
--- /dev/null
+++ b/bsps/aarch64/xilinx-zynqmp/jffs2_xnandpsu.c
@@ -0,0 +1,326 @@
+/*
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (C) 2023 On-Line Applications Research Corporation (OAR)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * This file contains an implementation of a basic JFFS2 filesystem adapter for
+ * the NandPsu peripheral that uses the entirety of the available NAND chip(s)
+ * for a JFFS2 filesystem or up to the maximum size possible. If an
+ * implementation would prefer to only use a portion of the NAND flash chip,
+ * this template would need rework to account for a reduced size and possibly a
+ * start offset while also taking into account the driver's handling of bad
+ * blocks and how that might affect the offset.
+ */
+
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <string.h>
+#include <assert.h>
+#include <errno.h>
+#include <stdlib.h>
+
+#include <bsp/jffs2_xnandpsu.h>
+#include <rtems/libio.h>
+#include <rtems/libcsupport.h>
+#include <rtems/malloc.h>
+#include <dev/nand/xnandpsu_bbm.h>
+
+typedef struct {
+  rtems_jffs2_flash_control super;
+  XNandPsu *nandpsu;
+} flash_control;
+
+static flash_control *get_flash_control(rtems_jffs2_flash_control *super)
+{
+  return (flash_control *) super;
+}
+
+static int flash_read(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset,
+  unsigned char *buffer,
+  size_t size_of_buffer
+)
+{
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  rtems_status_code sc;
+
+  sc = XNandPsu_Read(nandpsu, offset, size_of_buffer, buffer);
+  if (sc) {
+    return -EIO;
+  }
+  return 0;
+}
+
+static int flash_write(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset,
+  const unsigned char *buffer,
+  size_t size_of_buffer
+)
+{
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  rtems_status_code sc;
+
+  sc = XNandPsu_Write(nandpsu, offset, size_of_buffer, (void *)buffer);
+  if (sc) {
+    return -EIO;
+  }
+  return 0;
+}
+
+static int flash_erase(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset
+)
+{
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  rtems_status_code sc;
+  uint32_t BlockSize = nandpsu->Geometry.BlockSize;
+  uint32_t DeviceSize = nandpsu->Geometry.DeviceSize;
+  uint32_t BlockIndex;
+  uint32_t DeviceIndex;
+
+  if (offset > nandpsu->Geometry.DeviceSize) {
+    return -EIO;
+  }
+
+  DeviceIndex = offset / DeviceSize;
+  BlockIndex = (offset % DeviceSize) / BlockSize;
+
+  /* Perform erase operation. */
+  sc = XNandPsu_EraseBlock(nandpsu, DeviceIndex, BlockIndex);
+  if (sc ) {
+    return -EIO;
+  }
+
+  return 0;
+}
+
+static int flash_block_is_bad(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset,
+  bool *bad
+)
+{
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  uint32_t BlockIndex;
+
+  assert(bad);
+
+  if (offset > nandpsu->Geometry.DeviceSize) {
+    return -EIO;
+  }
+
+  BlockIndex = offset / nandpsu->Geometry.BlockSize;
+
+  *bad = (XNandPsu_IsBlockBad(nandpsu, BlockIndex) == XST_SUCCESS);
+  return 0;
+}
+
+static int flash_block_mark_bad(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset
+)
+{
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  uint32_t BlockIndex;
+
+  if (offset > nandpsu->Geometry.DeviceSize) {
+    return -EIO;
+  }
+
+  BlockIndex = offset / nandpsu->Geometry.BlockSize;
+
+  if ( XNandPsu_MarkBlockBad(nandpsu, BlockIndex) != XST_SUCCESS ) {
+    return -EIO;
+  }
+  return RTEMS_SUCCESSFUL;
+}
+
+static int flash_read_oob(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset,
+  uint8_t *oobbuf,
+  uint32_t ooblen
+)
+{
+  uint8_t *spare_bytes;
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  uint32_t SpareBytesPerPage = nandpsu->Geometry.SpareBytesPerPage;
+
+  if (offset > nandpsu->Geometry.DeviceSize) {
+    return -EIO;
+  }
+
+  /* Can't request more spare bytes than exist */
+  if (ooblen > SpareBytesPerPage * nandpsu->Geometry.PagesPerBlock) {
+    return -EIO;
+  }
+
+  /* Get page index */
+  uint32_t PageIndex = offset / nandpsu->Geometry.BytesPerPage;
+
+  spare_bytes = rtems_malloc(SpareBytesPerPage);
+  if (spare_bytes == NULL) {
+    return -ENOMEM;
+  }
+
+  while (ooblen) {
+    int rv = XNandPsu_ReadSpareBytes(nandpsu, PageIndex, spare_bytes);
+    /* no guarantee oobbuf can hold all of spare bytes, so read and then copy */
+    uint32_t readlen = SpareBytesPerPage;
+    if (ooblen < readlen) {
+	    readlen = ooblen;
+    }
+
+    if (rv) {
+      free(spare_bytes);
+      return -EIO;
+    }
+
+    memcpy(oobbuf, spare_bytes, readlen);
+
+    PageIndex++;
+    ooblen -= readlen;
+    oobbuf += readlen;
+  }
+  free(spare_bytes);
+  return RTEMS_SUCCESSFUL;
+}
+
+static int flash_write_oob(
+  rtems_jffs2_flash_control *super,
+  uint32_t offset,
+  uint8_t *oobbuf,
+  uint32_t ooblen
+)
+{
+  uint8_t *spare_bytes;
+  uint8_t *buffer = oobbuf;
+  XNandPsu *nandpsu = get_flash_control(super)->nandpsu;
+  uint32_t SpareBytesPerPage = nandpsu->Geometry.SpareBytesPerPage;
+
+  if (offset > nandpsu->Geometry.DeviceSize) {
+    return -EIO;
+  }
+
+  /* Writing a page spare area to large will result in ignored data.  */
+  if (ooblen > SpareBytesPerPage) {
+    return -EIO;
+  }
+
+  spare_bytes = rtems_malloc(SpareBytesPerPage);
+  if (spare_bytes == NULL) {
+    return -ENOMEM;
+  }
+
+  /* Writing a page spare area to small will result in invalid accesses */
+  if (ooblen < SpareBytesPerPage) {
+    int rv = flash_read_oob(super, offset, spare_bytes, SpareBytesPerPage);
+    if (rv) {
+      free(spare_bytes);
+      return rv;
+    }
+    buffer = spare_bytes;
+    memcpy(buffer, oobbuf, ooblen);
+  }
+
+  /* Get page index */
+  uint32_t PageIndex = offset / nandpsu->Geometry.BytesPerPage;
+
+  if ( XNandPsu_WriteSpareBytes(nandpsu, PageIndex, buffer) != XST_SUCCESS ) {
+    free(spare_bytes);
+    return -EIO;
+  }
+  free(spare_bytes);
+  return RTEMS_SUCCESSFUL;
+}
+
+static uint32_t flash_get_oob_size(
+  rtems_jffs2_flash_control *super
+)
+{
+  flash_control *self = get_flash_control(super);
+
+  return self->nandpsu->Geometry.SpareBytesPerPage;
+}
+
+static flash_control flash_instance = {
+  .super = {
+    .read = flash_read,
+    .write = flash_write,
+    .erase = flash_erase,
+    .block_is_bad = flash_block_is_bad,
+    .block_mark_bad = flash_block_mark_bad,
+    .oob_read = flash_read_oob,
+    .oob_write = flash_write_oob,
+    .get_oob_size = flash_get_oob_size,
+  }
+};
+
+static rtems_jffs2_compressor_control compressor_instance = {
+  .compress = rtems_jffs2_compressor_rtime_compress,
+  .decompress = rtems_jffs2_compressor_rtime_decompress
+};
+
+static rtems_jffs2_mount_data mount_data;
+
+int xilinx_zynqmp_nand_jffs2_initialize(
+  const char *mount_dir,
+  XNandPsu *NandInstPtr
+)
+{
+  flash_instance.super.block_size = NandInstPtr->Geometry.BlockSize;
+
+  uint64_t max_size = 0x100000000LU - flash_instance.super.block_size;
+
+  /* JFFS2 maximum FS size is one block less than 4GB */
+  if (NandInstPtr->Geometry.DeviceSize > max_size) {
+    flash_instance.super.flash_size = max_size;
+  } else {
+    flash_instance.super.flash_size = NandInstPtr->Geometry.DeviceSize;
+  }
+
+  flash_instance.super.write_size = NandInstPtr->Geometry.BytesPerPage;
+  flash_instance.nandpsu = NandInstPtr;
+  mount_data.flash_control = &flash_instance.super;
+  mount_data.compressor_control = &compressor_instance;
+
+  int rv = 0;
+  rv = mount(
+    NULL,
+    mount_dir,
+    RTEMS_FILESYSTEM_TYPE_JFFS2,
+    RTEMS_FILESYSTEM_READ_WRITE,
+    &mount_data
+  );
+  if ( rv != 0 ) {
+    return rv;
+  }
+
+  return 0;
+}