summaryrefslogtreecommitdiff
path: root/apps/examples/flash_test
diff options
context:
space:
mode:
Diffstat (limited to 'apps/examples/flash_test')
-rw-r--r--apps/examples/flash_test/.gitignore13
-rw-r--r--apps/examples/flash_test/Kconfig20
-rw-r--r--apps/examples/flash_test/Makefile116
-rw-r--r--apps/examples/flash_test/README.txt18
-rw-r--r--apps/examples/flash_test/flash_test.c307
5 files changed, 474 insertions, 0 deletions
diff --git a/apps/examples/flash_test/.gitignore b/apps/examples/flash_test/.gitignore
new file mode 100644
index 000000000..b3c606091
--- /dev/null
+++ b/apps/examples/flash_test/.gitignore
@@ -0,0 +1,13 @@
+Make.dep
+.depend
+.built
+*.swp
+*.asm
+*.obj
+*.rel
+*.lst
+*.sym
+*.adb
+*.lib
+*.src
+
diff --git a/apps/examples/flash_test/Kconfig b/apps/examples/flash_test/Kconfig
new file mode 100644
index 000000000..49b56dccc
--- /dev/null
+++ b/apps/examples/flash_test/Kconfig
@@ -0,0 +1,20 @@
+#
+# For a description of the syntax of this configuration file,
+# see misc/tools/kconfig-language.txt.
+#
+
+config EXAMPLES_FLASH_TEST
+ bool "SMART FLASH block device test"
+ default n
+ depends on !NUTTX_KERNEL && MTD_SMART && NSH_BUILTIN_APPS
+ ---help---
+ This logic performs a SMART flash block device test. This test
+ performs a sector allocate, read, write, free and garbage collection
+ test on a SMART MTD block device. This test can be built only as an
+ NSH command
+
+ NOTE: This test uses internal OS interfaces and so is not available
+ in the NUTTX kernel build
+
+if EXAMPLES_FLASH_TEST
+endif
diff --git a/apps/examples/flash_test/Makefile b/apps/examples/flash_test/Makefile
new file mode 100644
index 000000000..d8c9e5c74
--- /dev/null
+++ b/apps/examples/flash_test/Makefile
@@ -0,0 +1,116 @@
+############################################################################
+# apps/system/flash_test/Makefile
+#
+# Copyright (C) 2013 Ken Pettit. All rights reserved.
+# Author: Ken Pettit <pettitkd@gmail.com>
+# Greg Nutt
+#
+# 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.
+# 3. Neither the name NuttX nor the names of its contributors may be
+# used to endorse or promote products derived from this software
+# without specific prior written permission.
+#
+# 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.
+#
+############################################################################
+
+-include $(TOPDIR)/.config
+-include $(TOPDIR)/Make.defs
+include $(APPDIR)/Make.defs
+
+ifeq ($(WINTOOL),y)
+INCDIROPT = -w
+endif
+
+# SMART FLASH block device test
+
+APPNAME = flash_test
+PRIORITY = SCHED_PRIORITY_DEFAULT
+STACKSIZE = 2048
+
+ASRCS =
+CSRCS = flash_test.c
+
+AOBJS = $(ASRCS:.S=$(OBJEXT))
+COBJS = $(CSRCS:.c=$(OBJEXT))
+
+SRCS = $(ASRCS) $(CSRCS)
+OBJS = $(AOBJS) $(COBJS)
+
+ifeq ($(CONFIG_WINDOWS_NATIVE),y)
+ BIN = ..\..\libapps$(LIBEXT)
+else
+ifeq ($(WINTOOL),y)
+ BIN = ..\\..\\libapps$(LIBEXT)
+else
+ BIN = ../../libapps$(LIBEXT)
+endif
+endif
+
+ROOTDEPPATH = --dep-path .
+
+# Common build
+
+VPATH =
+
+all: .built
+.PHONY: context depend clean distclean
+
+$(AOBJS): %$(OBJEXT): %.S
+ $(call ASSEMBLE, $<, $@)
+
+$(COBJS): %$(OBJEXT): %.c
+ $(call COMPILE, $<, $@)
+
+.built: $(OBJS)
+ $(call ARCHIVE, $(BIN), $(OBJS))
+ $(Q) touch .built
+
+# Register application
+
+ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
+$(BUILTIN_REGISTRY)$(DELIM)$(APPNAME)_main.bdat: $(DEPCONFIG) Makefile
+ $(call REGISTER,$(APPNAME),$(PRIORITY),$(STACKSIZE),$(APPNAME)_main)
+
+context: $(BUILTIN_REGISTRY)$(DELIM)$(APPNAME)_main.bdat
+else
+context:
+endif
+
+# Create dependencies
+
+.depend: Makefile $(SRCS)
+ $(Q) $(MKDEP) $(ROOTDEPPATH) "$(CC)" -- $(CFLAGS) -- $(SRCS) >Make.dep
+ $(Q) touch $@
+
+depend: .depend
+
+clean:
+ $(call DELFILE, .built)
+ $(call CLEAN)
+
+distclean: clean
+ $(call DELFILE, Make.dep)
+ $(call DELFILE, .depend)
+
+-include Make.dep
diff --git a/apps/examples/flash_test/README.txt b/apps/examples/flash_test/README.txt
new file mode 100644
index 000000000..60fcc4ebb
--- /dev/null
+++ b/apps/examples/flash_test/README.txt
@@ -0,0 +1,18 @@
+
+Install Program
+===============
+
+ Source: NuttX
+ Author: Ken Pettit
+ Date: April 24, 2013
+
+This application performs a SMART flash block device test. This test performs a sector allocate, read, write, free and garbage collection test on a SMART MTD block device. This test can be built only as an NSH command
+
+NOTE: This test uses internal OS interfaces and so is not available in the NUTTX kernel build
+
+Usage:
+ flash_test mtdblock_device
+
+Additional options:
+
+ --force to replace existing installation
diff --git a/apps/examples/flash_test/flash_test.c b/apps/examples/flash_test/flash_test.c
new file mode 100644
index 000000000..105950557
--- /dev/null
+++ b/apps/examples/flash_test/flash_test.c
@@ -0,0 +1,307 @@
+/****************************************************************************
+ * apps/system/flash_test/flash_test.c
+ *
+ * Copyright (C) 2013 Ken Pettit. All rights reserved.
+ * Author: Ken Pettit <pettitkd@gmail.com>
+ *
+ * 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.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ * used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <nuttx/progmem.h>
+#include <sys/stat.h>
+
+#include <unistd.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <nuttx/mtd.h>
+#include <nuttx/smart.h>
+#include <nuttx/fs/ioctl.h>
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+int flash_test_main(int argc, char *argv[])
+{
+ struct inode* inode;
+ int ret;
+ int x;
+ int logsector;
+ uint16_t seq;
+ struct smart_format_s fmt;
+ uint16_t *sectors;
+ uint16_t *seqs;
+ char *buffer;
+ struct smart_read_write_s readwrite;
+
+ /* Argument given? */
+
+ if (argc < 2)
+ {
+ fprintf(stderr, "usage: flash_test flash_block_device\n");
+ return -1;
+ }
+
+ /* Find the inode of the block driver indentified by 'source' */
+
+ ret = open_blockdriver(argv[1], 0, &inode);
+ if (ret < 0)
+ {
+ fprintf(stderr, "Failed to open %s\n", argv[1]);
+ goto errout;
+ }
+
+ /* Get the low-level format from the device. */
+
+ ret = inode->u.i_bops->ioctl(inode, BIOC_GETFORMAT, (unsigned long) &fmt);
+ if (ret != OK)
+ {
+ fprintf(stderr, "Device is not a SMART block device\n");
+ goto errout_with_driver;
+ }
+
+ /* Test if the device is formatted. If not, then we must do a
+ * low-level format first */
+
+ if (!(fmt.flags & SMART_FMT_ISFORMATTED))
+ {
+ /* Perform a low-level format */
+
+ ret = inode->u.i_bops->ioctl(inode, BIOC_LLFORMAT, 0);
+ ret = inode->u.i_bops->ioctl(inode, BIOC_GETFORMAT, (unsigned long) &fmt);
+ }
+
+ if (!(fmt.flags & SMART_FMT_ISFORMATTED))
+ {
+ fprintf(stderr, "Unable to get device format\n");
+ goto errout_with_driver;
+ }
+
+ /* Report the device structure */
+
+ printf("FLASH Test on device with:\n");
+ printf(" Sector size: %10d\n", fmt.sectorsize);
+ printf(" Sector count: %10d\n", fmt.nsectors);
+ printf(" Avail bytes: %10d\n", fmt.availbytes);
+ printf(" Total size: %10d\n", fmt.sectorsize * fmt.nsectors);
+
+ /* Allocate buffers to use */
+
+ buffer = (char *) malloc(fmt.availbytes);
+ if (buffer == NULL)
+ {
+ fprintf(stderr, "Error allocating buffer\n");
+ goto errout_with_driver;
+ }
+
+ seqs = (uint16_t *) malloc(fmt.nsectors << 1);
+ if (seqs == NULL)
+ {
+ (void) free(buffer);
+ fprintf(stderr, "Error allocating seqs buffer\n");
+ goto errout_with_driver;
+ }
+
+ sectors = (uint16_t *) malloc(fmt.nsectors << 1);
+ if (sectors == NULL)
+ {
+ (void) free(seqs);
+ (void) free(buffer);
+ fprintf(stderr, "Error allocating sectors buffer\n");
+ goto errout_with_driver;
+ }
+
+ /* Write a bunch of data to the flash */
+
+ printf("\nAllocating and writing to logical sectors\n");
+
+ seq = 0;
+ for (x = 0; x < fmt.nsectors >> 1; x++)
+ {
+ /* Allocate a new sector */
+
+ logsector = inode->u.i_bops->ioctl(inode, BIOC_ALLOCSECT,
+ (unsigned long) -1);
+ if (logsector < 0)
+ {
+ fprintf(stderr, "Error allocating sector: %d\n", logsector);
+ goto errout_with_driver;
+ }
+
+ /* Save the sector in our array */
+
+ sectors[x] = (uint16_t) logsector;
+ seqs[x] = seq++;
+
+ /* Now write some data to the sector */
+
+ sprintf(buffer, "Logical sector %d sequence %d\n",
+ sectors[x], seqs[x]);
+
+ readwrite.logsector = sectors[x];
+ readwrite.offset = 0;
+ readwrite.count = strlen(buffer) + 1;
+ readwrite.buffer = (uint8_t *) buffer;
+ ret = inode->u.i_bops->ioctl(inode, BIOC_WRITESECT, (unsigned long)
+ &readwrite);
+
+ /* Print the logical sector number */
+
+ printf("\r%d ", sectors[x]);
+ }
+
+ /* Now read the data back to validate everything was written and can
+ * be read. */
+
+ printf("\nDoing read verify test\n");
+ for (x = 0; x < fmt.nsectors >> 1; x++)
+ {
+ /* Read from the logical sector */
+
+ readwrite.logsector = sectors[x];
+ readwrite.offset = 0;
+ readwrite.count = fmt.availbytes;
+ readwrite.buffer = (uint8_t *) buffer;
+ ret = inode->u.i_bops->ioctl(inode, BIOC_READSECT, (unsigned long)
+ &readwrite);
+
+ if (ret != fmt.availbytes)
+ {
+ fprintf(stderr, "Error reading sector %d\n", sectors[x]);
+ goto errout_with_buffers;
+ }
+
+ /* Generate compare string and do the comapre */
+
+ printf("\r%d ", sectors[x]);
+
+ sprintf(&buffer[100], "Logical sector %d sequence %d\n",
+ sectors[x], seqs[x]);
+
+ if (strcmp(buffer, &buffer[100]) != 0)
+ {
+ printf("Sector %d read verify failed\n", sectors[x]);
+ }
+ }
+
+ printf("\nPeforming sector re-write\n");
+
+ /* Overwrite data on the sectors to cause relocation */
+
+ for (x = 0; x < fmt.nsectors >> 1; x++)
+ {
+ /* Save a new sequence number for the sector */
+
+ seqs[x] = seq++;
+
+ /* Now write over the sector data with new data, causing a relocation. */
+
+ sprintf(buffer, "Logical sector %d sequence %d\n", sectors[x], seqs[x]);
+ readwrite.logsector = sectors[x];
+ readwrite.offset = 0;
+ readwrite.count = strlen(buffer) + 1;
+ readwrite.buffer = (uint8_t *) buffer;
+ ret = inode->u.i_bops->ioctl(inode, BIOC_WRITESECT, (unsigned long)
+ &readwrite);
+
+ /* Print the logical sector number */
+
+ printf("\r%d ", sectors[x]);
+ }
+
+ /* Now append data to empty region of sector */
+
+ printf("\nAppending data to empty region of sector\n");
+
+ for (x = 0; x < fmt.nsectors >> 1; x++)
+ {
+ /* Save a new sequence number for the sector */
+
+ seqs[x] = seq++;
+
+ /* Now write over the sector data with new data, causing a relocation. */
+
+ sprintf(buffer, "Appended data in sector %d\n", sectors[x]);
+ readwrite.logsector = sectors[x];
+ readwrite.offset = 64;
+ readwrite.count = strlen(buffer) + 1;
+ readwrite.buffer = (uint8_t *) buffer;
+ ret = inode->u.i_bops->ioctl(inode, BIOC_WRITESECT, (unsigned long)
+ &readwrite);
+
+ /* Print the logical sector number */
+
+ printf("\r%d ", sectors[x]);
+ }
+
+ printf("\nDone\n");
+
+ /* Free all the allocated sectors */
+
+ for (x = 0; x < fmt.nsectors >> 1; x++)
+ {
+ /* Only free the sector if it is still valid */
+
+ if (sectors[x] != 0xFFFF)
+ {
+ ret = inode->u.i_bops->ioctl(inode, BIOC_FREESECT, (unsigned long)
+ sectors[x]);
+ }
+ }
+
+errout_with_buffers:
+ /* Free the allocated buffers */
+
+ (void) free(seqs);
+ (void) free(sectors);
+ (void) free(buffer);
+
+errout_with_driver:
+ /* Now close the block device and exit */
+
+ (void)close_blockdriver(inode);
+
+errout:
+
+ return 0;
+}