This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx-apps.git
The following commit(s) were added to refs/heads/master by this push:
new f4092962d apps/testing/nand_sim: Adds NAND virtual device.
f4092962d is described below
commit f4092962df15ff1e4b7d385f8882d78e3e8bfcb7
Author: Saurav Pal <resyfer....@gmail.com>
AuthorDate: Sat Mar 16 04:28:37 2024 +0000
apps/testing/nand_sim: Adds NAND virtual device.
Adds a NAND virtual device daemon.
Signed-off-by: Saurav Pal <resyfer....@gmail.com>
---
.gitignore | 3 +
testing/nand_sim/Kconfig | 34 ++++++
testing/nand_sim/Make.defs | 23 ++++
testing/nand_sim/Makefile | 30 ++++++
testing/nand_sim/nand_sim_main.c | 224 +++++++++++++++++++++++++++++++++++++++
5 files changed, 314 insertions(+)
diff --git a/.gitignore b/.gitignore
index ffde0a56c..092c3d11f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -39,3 +39,6 @@ Make.dep
.dirlinks
.vscode
.DS_Store
+build
+.ccls-cache
+compile_commands.json
\ No newline at end of file
diff --git a/testing/nand_sim/Kconfig b/testing/nand_sim/Kconfig
new file mode 100644
index 000000000..a32f4d6dc
--- /dev/null
+++ b/testing/nand_sim/Kconfig
@@ -0,0 +1,34 @@
+#
+# For a description of the syntax of this configuration file,
+# see the file kconfig-language.txt in the NuttX tools repository.
+#
+
+config TESTING_NAND_SIM
+ boolean "NAND Flash Simulator"
+ default n
+ ---help---
+ Enable the NAND Flash Simulator device.
+
+if TESTING_NAND_SIM
+
+config TESTING_NAND_SIM_SIZE
+ int "Size of NAND Flash in MB"
+ default 2
+ ---help---
+ Size of NAND Flash in Megabytes.
+
+config TESTING_NAND_SIM_DEBUG
+ int "Debugging mode"
+ default 1
+ range 0 2
+ ---help---
+ 0 - Disable debugging mode
+ 1 - Enable debugging mode to standard I/O
+ 2 - Enable debugging mode to a special file
+
+config TESTING_NAND_SIM_STACK
+ int "Builtin task stack size"
+ default DEFAULT_TASK_STACKSIZE
+ ---help---
+ Size of the task to configure when started nand from NSH
+endif
diff --git a/testing/nand_sim/Make.defs b/testing/nand_sim/Make.defs
new file mode 100644
index 000000000..1330d5d5a
--- /dev/null
+++ b/testing/nand_sim/Make.defs
@@ -0,0 +1,23 @@
+############################################################################
+# apps/testing/nand_sim/Make.defs
+#
+# 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.
+#
+############################################################################
+
+ifneq ($(CONFIG_TESTING_NAND_SIM),)
+CONFIGURED_APPS += $(APPDIR)/testing/nand_sim
+endif
diff --git a/testing/nand_sim/Makefile b/testing/nand_sim/Makefile
new file mode 100644
index 000000000..f0b6f1c84
--- /dev/null
+++ b/testing/nand_sim/Makefile
@@ -0,0 +1,30 @@
+############################################################################
+# apps/testing/nand_sim/Makefile
+#
+# 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.
+#
+############################################################################
+
+include $(APPDIR)/Make.defs
+
+PROGNAME = nand
+PRIORITY = SCHED_PRIORITY_DEFAULT
+STACKSIZE = $(CONFIG_TESTING_NAND_SIM_STACK)
+MODULE = $(CONFIG_TESTING_NAND_SIM)
+
+MAINSRC = nand_sim_main.c
+
+include $(APPDIR)/Application.mk
diff --git a/testing/nand_sim/nand_sim_main.c b/testing/nand_sim/nand_sim_main.c
new file mode 100644
index 000000000..5e0893558
--- /dev/null
+++ b/testing/nand_sim/nand_sim_main.c
@@ -0,0 +1,224 @@
+/****************************************************************************
+ * apps/testing/nand_sim/nand_sim_main.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 <debug.h>
+#include <stdio.h>
+
+#include <nuttx/drivers/drivers.h>
+#include <nuttx/mtd/nand.h>
+#include <nuttx/mtd/nand_scheme.h>
+#include <nuttx/mtd/nand_ram.h>
+#include <nuttx/mtd/nand_wrapper.h>
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+#define NAND_SIM_NAME "nand"
+#define NAND_SIM_PATH "/dev/" NAND_SIM_NAME
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Data
+ ****************************************************************************/
+
+FAR struct mtd_dev_s *g_nand_sim_mtd_wrapper;
+FAR struct mtd_dev_s *g_nand_sim_mtd_under;
+FAR struct nand_raw_s *g_nand_mtd_raw;
+
+/****************************************************************************
+ * External Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: wrapper_init
+ *
+ * Description:
+ * Initializes the wrapper by allocating memory and assiging the methods.
+ *
+ * Returned Value:
+ * 0: Successful
+ * -ENOMEM: No memory left to allocate device
+ *
+ ****************************************************************************/
+
+int wrapper_init(void)
+{
+ struct nand_dev_s *under;
+ struct nand_dev_s *wrapper;
+
+ g_nand_sim_mtd_wrapper = kmm_zalloc(sizeof(struct nand_wrapper_dev_s));
+ if (g_nand_sim_mtd_wrapper == NULL)
+ {
+ return -ENOMEM;
+ }
+
+ under = &((struct nand_wrapper_dev_s *)g_nand_sim_mtd_wrapper)->under;
+ wrapper = &((struct nand_wrapper_dev_s *)g_nand_sim_mtd_wrapper)->wrapper;
+
+ memcpy(under, g_nand_sim_mtd_under, sizeof(struct nand_dev_s));
+ memcpy(wrapper, g_nand_sim_mtd_under, sizeof(struct nand_dev_s));
+
+ nand_wrapper_initialize();
+
+ ((struct mtd_dev_s *)wrapper)->name = NAND_SIM_NAME;
+ ((struct mtd_dev_s *)wrapper)->erase = nand_wrapper_erase;
+ ((struct mtd_dev_s *)wrapper)->bread = nand_wrapper_bread;
+ ((struct mtd_dev_s *)wrapper)->bwrite = nand_wrapper_bwrite;
+ ((struct mtd_dev_s *)wrapper)->ioctl = nand_wrapper_ioctl;
+ ((struct mtd_dev_s *)wrapper)->isbad = nand_wrapper_isbad;
+ ((struct mtd_dev_s *)wrapper)->markbad = nand_wrapper_markbad;
+
+ return OK;
+}
+
+/****************************************************************************
+ * Name: terminate
+ *
+ * Description:
+ * Handles the SIGTERM signal by exitting gracefully.
+ *
+ ****************************************************************************/
+
+void terminate(int sig)
+{
+ kmm_free(g_nand_sim_mtd_under);
+ kmm_free(g_nand_sim_mtd_wrapper);
+
+ unregister_mtddriver(NAND_SIM_PATH);
+ syslog(LOG_DEBUG, "Exited!\n");
+}
+
+/****************************************************************************
+ * Name: nand_sim_main
+ *
+ * Description:
+ * Entry point of the device emulator.
+ *
+ ****************************************************************************/
+
+int main(int argc, FAR char *argv[])
+{
+ int ret;
+ pid_t pid;
+
+ /* Daemon */
+
+ pid = fork();
+
+ if (pid > 0)
+ {
+ return OK;
+ }
+
+ if (daemon(0, 1) == -1)
+ {
+ ret = EXIT_FAILURE;
+ goto errout;
+ }
+
+ /* Signal Handlers */
+
+ signal(SIGTERM, terminate);
+
+ /* Initializers */
+
+ /* Raw NAND MTD Device */
+
+ g_nand_mtd_raw = kmm_zalloc(sizeof(struct nand_raw_s));
+ if (g_nand_mtd_raw == NULL)
+ {
+ ret = -ENOMEM;
+ goto errout_with_logs;
+ }
+
+ g_nand_sim_mtd_under = nand_ram_initialize(g_nand_mtd_raw);
+ if (g_nand_sim_mtd_under == NULL)
+ {
+ ret = -EINVAL;
+ goto errout_with_raw_s;
+ }
+
+ ret = wrapper_init();
+ if (ret < 0)
+ {
+ goto errout_with_mtd_under;
+ }
+
+ /* Under device driver is already copied to wrapper, so free. */
+
+ kmm_free(g_nand_sim_mtd_under);
+
+ ret = register_mtddriver(NAND_SIM_PATH,
+ g_nand_sim_mtd_wrapper,
+ 0777, NULL);
+ if (ret < 0)
+ {
+ goto errout_with_mtd_wrapper;
+ }
+
+ printf("Driver running!\n");
+
+ /* To keep the daemon still running. All events are handled by signals */
+
+ while (1)
+ {
+ sleep(1);
+ }
+
+ /* Won't reach this point */
+
+ return OK;
+
+errout_with_mtd_wrapper:
+ kmm_free(g_nand_sim_mtd_wrapper);
+
+errout_with_mtd_under:
+ kmm_free(g_nand_sim_mtd_under);
+
+errout_with_raw_s:
+ kmm_free(g_nand_mtd_raw);
+
+errout_with_logs:
+ unregister_mtddriver(NAND_SIM_PATH);
+
+errout:
+ return ret;
+}
