aboutsummaryrefslogtreecommitdiff
path: root/nuttx/fs/nxffs/nxffs_reformat.c
diff options
context:
space:
mode:
Diffstat (limited to 'nuttx/fs/nxffs/nxffs_reformat.c')
-rw-r--r--nuttx/fs/nxffs/nxffs_reformat.c267
1 files changed, 267 insertions, 0 deletions
diff --git a/nuttx/fs/nxffs/nxffs_reformat.c b/nuttx/fs/nxffs/nxffs_reformat.c
new file mode 100644
index 000000000..cb10862ff
--- /dev/null
+++ b/nuttx/fs/nxffs/nxffs_reformat.c
@@ -0,0 +1,267 @@
+/****************************************************************************
+ * fs/nxffs/nxffs_reformat.c
+ *
+ * Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ * Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *
+ * References: Linux/Documentation/filesystems/romfs.txt
+ *
+ * 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 <string.h>
+#include <errno.h>
+#include <debug.h>
+
+#include <nuttx/mtd.h>
+
+#include "nxffs.h"
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Variables
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: nxffs_format
+ *
+ * Description:
+ * Erase and reformat the entire volume.
+ *
+ * Input Parameters:
+ * volume - Describes the NXFFS volume to be reformatted.
+ *
+ * Returned Value:
+ * Zero on success or a negated errno on a failure. Failures will be
+ * returned n the case of MTD reported failures o.
+ * Nothing in the volume data itself will generate errors.
+ *
+ ****************************************************************************/
+
+static int nxffs_format(FAR struct nxffs_volume_s *volume)
+{
+ FAR uint8_t *blkptr; /* Pointer to next block data */
+ off_t eblock; /* Erase block number */
+ off_t lblock; /* Logical block number */
+ ssize_t nxfrd; /* Number of blocks transferred */
+ int i;
+ int ret;
+
+ /* Create an image of one properly formatted erase sector */
+
+ memset(volume->pack, CONFIG_NXFFS_ERASEDSTATE, volume->geo.erasesize);
+ for (blkptr = volume->pack, i = 0;
+ i < volume->blkper;
+ blkptr += volume->geo.blocksize, i++)
+ {
+ FAR struct nxffs_block_s *blkhdr = (FAR struct nxffs_block_s*)blkptr;
+ memcpy(blkhdr->magic, g_blockmagic, NXFFS_MAGICSIZE);
+ blkhdr->state = BLOCK_STATE_GOOD;
+ }
+
+ /* Erase and format each erase block */
+
+ for (eblock = 0; eblock < volume->geo.neraseblocks; eblock++)
+ {
+ /* Erase the block */
+
+ ret = MTD_ERASE(volume->mtd, eblock, 1);
+ if (ret < 0)
+ {
+ fdbg("Erase block %d failed: %d\n", eblock, ret);
+ return ret;
+ }
+
+ /* Write the formatted image to the erase block */
+
+ lblock = eblock * volume->blkper;
+ nxfrd = MTD_BWRITE(volume->mtd, lblock, volume->blkper, volume->pack);
+ if (nxfrd != volume->blkper)
+ {
+ fdbg("Write erase block %d failed: %d\n", lblock, nxfrd);
+ return -EIO;
+ }
+ }
+
+ return OK;
+}
+
+/****************************************************************************
+ * Name: nxffs_badblocks
+ *
+ * Description:
+ * Verify each block and mark improperly erased blocks as bad.
+ *
+ * Input Parameters:
+ * volume - Describes the NXFFS volume to be reformatted.
+ *
+ * Returned Value:
+ * Zero on success or a negated errno on a failure. Failures will be
+ * returned n the case of MTD reported failures o.
+ * Nothing in the volume data itself will generate errors.
+ *
+ ****************************************************************************/
+
+static int nxffs_badblocks(FAR struct nxffs_volume_s *volume)
+{
+ FAR uint8_t *blkptr; /* Pointer to next block data */
+ off_t eblock; /* Erase block number */
+ off_t lblock; /* Logical block number */
+ ssize_t nxfrd; /* Number of blocks transferred */
+ bool good; /* TRUE: block is good */
+ bool modified; /* TRUE: The erase block has been modified */
+ int i;
+
+ /* Read and verify each erase block */
+
+ for (eblock = 0; eblock < volume->geo.neraseblocks; eblock++)
+ {
+ /* Read the entire erase block */
+
+ lblock = eblock * volume->blkper;
+ nxfrd = MTD_BREAD(volume->mtd, lblock, volume->blkper, volume->pack);
+ if (nxfrd != volume->blkper)
+ {
+ fdbg("Read erase block %d failed: %d\n", lblock, nxfrd);
+ return -EIO;
+ }
+
+ /* Process each logical block */
+
+ modified = false;
+ for (blkptr = volume->pack, i = 0;
+ i < volume->blkper;
+ blkptr += volume->geo.blocksize, i++)
+ {
+ FAR struct nxffs_block_s *blkhdr = (FAR struct nxffs_block_s*)blkptr;
+
+ /* Check block header */
+
+ good = true;
+ if (memcmp(blkhdr->magic, g_blockmagic, NXFFS_MAGICSIZE) != 0 ||
+ blkhdr->state != BLOCK_STATE_GOOD)
+ {
+ good = false;
+ }
+
+ /* Check that block data is erased */
+
+ else
+ {
+ size_t blocksize = volume->geo.blocksize - SIZEOF_NXFFS_BLOCK_HDR;
+ size_t erasesize = nxffs_erased(&blkptr[SIZEOF_NXFFS_BLOCK_HDR], blocksize);
+ good = (blocksize == erasesize);
+ }
+
+ /* If the block is bad, attempt to re-write the block header indicating
+ * a bad block (of course, if the block has failed, this may not be
+ * possible, depending upon failure modes.
+ */
+
+ if (!good)
+ {
+ memcpy(blkhdr->magic, g_blockmagic, NXFFS_MAGICSIZE);
+ blkhdr->state = BLOCK_STATE_BAD;
+ modified = true;
+ }
+ }
+
+ /* If the erase block was modified, then re-write it */
+
+ nxfrd = MTD_BWRITE(volume->mtd, lblock, volume->blkper, volume->pack);
+ if (nxfrd != volume->blkper)
+ {
+ fdbg("Write erase block %d failed: %d\n", lblock, nxfrd);
+ return -EIO;
+ }
+ }
+
+ return OK;
+}
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: nxffs_reformat
+ *
+ * Description:
+ * Erase and reformat the entire volume. Verify each block and mark
+ * improperly erased blocks as bad.
+ *
+ * Input Parameters:
+ * volume - Describes the NXFFS volume to be reformatted.
+ *
+ * Returned Value:
+ * Zero on success or a negated errno on a failure. Failures will be
+ * returned n the case of MTD reported failures o.
+ * Nothing in the volume data itself will generate errors.
+ *
+ ****************************************************************************/
+
+int nxffs_reformat(FAR struct nxffs_volume_s *volume)
+{
+ int ret;
+
+ /* Erase and reformat the entire volume */
+
+ ret = nxffs_format(volume);
+ if (ret < 0)
+ {
+ fdbg("Failed to reformat the volume: %d\n", -ret);
+ return ret;
+ }
+
+ /* Check for bad blocks */
+
+ ret = nxffs_badblocks(volume);
+ if (ret < 0)
+ {
+ fdbg("Bad block check failed: %d\n", -ret);
+ }
+ return ret;
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-08-31 06:25:00 +0000