summaryrefslogtreecommitdiff
path: root/nuttx/examples/nsh
diff options
context:
space:
mode:
Diffstat (limited to 'nuttx/examples/nsh')
-rw-r--r--nuttx/examples/nsh/README.txt25
-rwxr-xr-xnuttx/examples/nsh/mkromfsimg.sh261
-rw-r--r--nuttx/examples/nsh/nsh_romfsetc.c12
3 files changed, 28 insertions, 270 deletions
diff --git a/nuttx/examples/nsh/README.txt b/nuttx/examples/nsh/README.txt
index ee3a42de2..ab44cbaeb 100644
--- a/nuttx/examples/nsh/README.txt
+++ b/nuttx/examples/nsh/README.txt
@@ -159,15 +159,16 @@ Modifying the ROMFS Image
-------------------------
The contents of the /etc directory are retained in the file
-examples/nsh/nsh_romfsimg.h. In order to modify the start-up
-behavior, there are three things to study:
+examples/nsh/nsh_romfsimg.h (OR, if CONFIG_EXAMPLES_NSH_ARCHROMFS
+is defined, include/arch/board/rcs.template). In order to modify
+the start-up behavior, there are three things to study:
1. Configuration Options.
The additional CONFIG_EXAMPLES_NSH_ROMFSETC configuration options
discussed in the final section of this README.
-2. mkromfsimg.sh Script.
- The script examples/nsh/mkromfsimg.sh creates nsh_romfsimg.h.
+2. tools/mkromfsimg.sh Script.
+ The script tools/mkromfsimg.sh creates nsh_romfsimg.h.
It is not automatically executed. If you want to change the
configuration settings associated with creating and mounting
the /tmp directory, then it will be necessary to re-generate
@@ -175,15 +176,25 @@ behavior, there are three things to study:
The behavior of this script depends upon three things:
- - The configuration settings then installed configuration.
+ - The configuration settings of the installed NuttX configuration.
- The genromfs tool (available from http://romfs.sourceforge.net).
- - The file examples/nsh/rcS.template.
+ - The file examples/nsh/rcS.template (OR, if
+ CONFIG_EXAMPLES_NSH_ARCHROMFS is defined, include/arch/board/rcs.template)
3. rcS.template.
The file examples/nsh/rcS.template contains the general form
- of the rcS file; configurated values are plugged into this
+ of the rcS file; configured values are plugged into this
template file to produce the final rcS file.
+NOTE:
+
+ examples/nsh/rcS.template generates the standard, default
+ nsh_romfsimg.h file. If CONFIG_EXAMPLES_NSH_ARCHROMFS is defined
+ in the NuttX configuration file, then a custom, board-specific
+ nsh_romfsimg.h file residing in configs/<board>/include will be
+ used. NOTE when the OS is configured, include/arch/board will
+ be linked to configs/<board>/include.
+
All of the startup-behavior is contained in rcS.template. The
role of mkromfsimg.sh is to (1) apply the specific configuration
settings to rcS.template to create the final rcS, and (2) to
diff --git a/nuttx/examples/nsh/mkromfsimg.sh b/nuttx/examples/nsh/mkromfsimg.sh
deleted file mode 100755
index 53f573179..000000000
--- a/nuttx/examples/nsh/mkromfsimg.sh
+++ /dev/null
@@ -1,261 +0,0 @@
-#!/bin/bash
-############################################################################
-# examples/nsh/mkromfsimg.sh
-#
-# Copyright (C) 2008 Gregory Nutt. All rights reserved.
-# Author: Gregory Nutt <spudmonkey@racsa.co.cr>
-#
-# 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.
-#
-############################################################################
-
-# Environmental stuff
-
-wd=`pwd`
-workingdir=$wd/img
-rcsfile=rcS
-rcstemplate=$rcsfile.template
-romfsimg=romfs.img
-headerfile=nsh_romfsimg.h
-
-# Get the input parameters
-
-topdir=$1
-usage="USAGE: $0 <topdir>"
-
-if [ -z "$topdir" -o ! -d "$topdir" ]; then
- echo "The full path to the NuttX base directory must be provided on the command line"
- echo $usage
- exit 1
-fi
-
-# Extract all values from the .config in the $topdir that contains all of the NuttX
-# configuration settings. The .config file was intended to be include-able by makefiles
-# and source-able by scripts. Unfortunately,there are too many syntactic differents
-# to make that practical
-
-if [ ! -r $topdir/.config ]; then
- echo "No readable file at $topdir/.config"
- echo "Has NuttX been configured?"
- exit 1
-fi
-
-romfsetc=`grep CONFIG_EXAMPLES_NSH_ROMFSETC= $topdir/.config | cut -d'=' -f2`
-disablempt=`grep CONFIG_DISABLE_MOUNTPOINT= $topdir/.config | cut -d'=' -f2`
-disablescript=`grep CONFIG_EXAMPLES_NSH_DISABLESCRIPT= $topdir/.config | cut -d'=' -f2`
-ndescriptors=`grep CONFIG_NFILE_DESCRIPTORS= $topdir/.config | cut -d'=' -f2`
-devconsole=`grep CONFIG_DEV_CONSOLE= $topdir/.config | cut -d'=' -f2`
-romfs=`grep CONFIG_FS_ROMFS= $topdir/.config | cut -d'=' -f2`
-romfsmpt=`grep CONFIG_EXAMPLES_NSH_ROMFSMOUNTPT= $topdir/.config | cut -d'=' -f2`
-initscript=`grep CONFIG_EXAMPLES_NSH_INITSCRIPT= $topdir/.config | cut -d'=' -f2`
-romfsdevno=`grep CONFIG_EXAMPLES_NSH_ROMFSDEVNO= $topdir/.config | cut -d'=' -f2`
-romfssectsize=`grep CONFIG_EXAMPLES_NSH_ROMFSSECTSIZE= $topdir/.config | cut -d'=' -f2`
-fatfs=`grep CONFIG_FS_FAT= $topdir/.config | cut -d'=' -f2`
-fatdevno=`grep CONFIG_EXAMPLES_NSH_FATDEVNO= $topdir/.config | cut -d'=' -f2`
-fatsectsize=`grep CONFIG_EXAMPLES_NSH_FATSECTSIZE= $topdir/.config | cut -d'=' -f2`
-fatnsectors=`grep CONFIG_EXAMPLES_NSH_FATNSECTORS= $topdir/.config | cut -d'=' -f2`
-fatmpt=`grep CONFIG_EXAMPLES_NSH_FATMOUNTPT= $topdir/.config | cut -d'=' -f2`
-
-# The following settings are required for general ROMFS support
-#
-# Mountpoint support must be enabled
-
-if [ "X$disablempt" = "Xy" ]; then
- echo "Mountpoint support is required for this feature"
- echo "Set CONFIG_DISABLE_MOUNTPOINT=n to continue"
- exit 1
-fi
-
-# Scripting support must be enabled
-
-if [ "X$disablescript" = "Xy" ]; then
- echo "NSH scripting support is required for this feature"
- echo "Set CONFIG_EXAMPLES_NSH_DISABLESCRIPT=n to continue"
- exit 1
-fi
-
-# We need at least 2 file descriptors 1 for the ROMFS mount and one for
-# FAT mount performed in rcS. That still wouldn't be enough to to do much
-# with NSH
-
-if [ -z "$ndescriptors" -o "$ndescriptors" -lt 2 ]; then
- echo "No file descriptors have been allocated"
- if [ "X$devconsole" = "Xy" ]; then
- echo "Set CONFIG_NFILE_DESCRIPTORS to value greater than 4"
- else
- echo "Set CONFIG_NFILE_DESCRIPTORS to value greater than 1"
- fi
- exit 1
-fi
-
-# If a console is enabled, then three more file descriptors are required
-# for stdin, stdout, and stderr
-
-if [ "X$devconsole" = "Xy" -a "$ndescriptors" -lt 5 ]; then
- echo "Insufficient file descriptors have been allocated"
- echo "Set CONFIG_NFILE_DESCRIPTORS to value greater than 4"
-fi
-
-# ROMFS support is required, of course
-
-if [ "X$romfs" != "Xy" ]; then
- echo "ROMFS support is disabled in the NuttX configuration"
- echo "Set CONFIG_FS_ROMFS=y to continue"
- exit 0
-fi
-
-# The options in the default rcS.template also require FAT FS support
-
-if [ "X$fatfs" != "Xy" ]; then
- echo "FAT FS support is disabled in the NuttX configuration"
- echo "Set CONFIG_FS_FAT=y to continue"
- exit 0
-fi
-
-# Verify that genromfs has been installed
-
-genromfs -h 1>/dev/null 2>&1 || { \
- echo "Host executable genromfs not available in PATH"; \
- echo "You may need to download in from http://romfs.sourceforge.net/"; \
- exit 1; \
-}
-
-# Supply defaults for all un-defined ROMFS settings
-
-if [ -z "$romfsmpt" ]; then
- romfsmpt="/etc"
-fi
-if [ -z "$initscript" ]; then
- initscript="init.d/rcS"
-fi
-if [ -z "$romfsdevno" ]; then
- romfsdevno=0
-fi
-if [ -z "$romfssectsize" ]; then
- romfssectsize=64
-fi
-
-# Supply defaults for all un-defined FAT FS settings
-
-if [ -z "$fatdevno" ]; then
- fatdevno=1
-fi
-if [ -z "$fatsectsize" ]; then
- fatsectsize=512
-fi
-if [ -z "$fatnsectors" ]; then
- fatnsectors=1024
-fi
-if [ -z "$fatmpt" ]; then
- fatmpt="/tmp"
-fi
-
-# Verify the mountpoint. Verify that it is an absolute path but not /, /dev,
-# /., /./*, /.., or /../*
-
-if [ ${romfsmpt:0:1} != "\"" ]; then
- echo "CONFIG_EXAMPLES_NSH_ROMFSMOUNTPT must be a string"
- echo "Change it so that it is enclosed in quotes."
- exit 1
-fi
-
-uromfsmpt=`echo $romfsmpt | sed -e "s/\"//g"`
-
-if [ ${uromfsmpt:0:1} != "/" ]; then
- echo "CONFIG_EXAMPLES_NSH_ROMFSMOUNTPT must be an absolute path in the target FS"
- echo "Change it so that it begins with the character '/'. Eg. /etc"
- exit 1
-fi
-
-tmpdir=$uromfsmpt
-while [ ${tmpdir:0:1} == "/" ]; do
- tmpdir=${tmpdir:1}
-done
-
-if [ -z "$tmpdir" -o "X$tmpdir" = "Xdev" -o "X$tmpdir" = "." -o \
- ${tmpdir:0:2} = "./" -o "X$tmpdir" = ".." -o ${tmpdir:0:3} = "../" ]; then
- echo "Invalid CONFIG_EXAMPLES_NSH_ROMFSMOUNTPT selection."
- exit 1
-fi
-
-# Verify that the path to the init file is a relative path and not ., ./*, .., or ../*
-
-if [ ${initscript:0:1} != "\"" ]; then
- echo "CONFIG_EXAMPLES_NSH_INITSCRIPT must be a string"
- echo "Change it so that it is enclosed in quotes."
- exit 1
-fi
-
-uinitscript=`echo $initscript | sed -e "s/\"//g"`
-
-if [ ${uinitscript:0:1} == "/" ]; then
- echo "CONFIG_EXAMPLES_NSH_INITSCRIPT must be an relative path in under $romfsmpt"
- echo "Change it so that it begins with the character '/'. Eg. init.d/rcS. "
- exit 1
-fi
-
-if [ "X$uinitscript" = "." -o ${uinitscript:0:2} = "./" -o \
- "X$uinitscript" = ".." -o ${uinitscript:0:3} = "../" ]; then
- echo "Invalid CONFIG_EXAMPLES_NSH_INITSCRIPT selection. Must not begin with . or .."
- exit 1
-fi
-
-# Create a working directory
-
-rm -rf $workingdir || { echo "Failed to remove the old $workingdir"; exit 1; }
-mkdir -p $workingdir || { echo "Failed to created the new $workingdir"; exit 1; }
-
-# Create the rcS file from the rcS.template
-
-if [ ! -r $rcstemplate ]; then
- echo "$rcstemplete does not exist"
- rmdir $workingdir
- exit 1
-fi
-
-cat $rcstemplate | \
- sed -e "s,XXXMKRDMINORXXX,$fatdevno,g" | \
- sed -e "s,XXMKRDSECTORSIZEXXX,$fatsectsize,g" | \
- sed -e "s,XXMKRDBLOCKSXXX,$fatnsectors,g" | \
- sed -e "s,XXXRDMOUNTPOUNTXXX,$fatmpt,g" >$rcsfile
-
-# And install it at the specified relative location
-
-install -D --mode=0755 $rcsfile $workingdir/$uinitscript || \
- { echo "Failed to install $rcsfile at $workingdir/$uinitscript"; rm -f $rcsfile; exit 1; }
-rm -f $rcsfile
-
-# Now we are ready to make the ROMFS image
-
-genromfs -f $romfsimg -d $workingdir -V "NSHInitVol" || { echo "genromfs failed" ; exit 1 ; }
-rm -rf $workingdir || { echo "Failed to remove the old $workingdir"; exit 1; }
-
-# And, finally, create the header file
-
-xxd -i $romfsimg >$headerfile || { echo "xxd of $< failed" ; rm -f $romfsimg; exit 1 ; }
-rm -f $romfsimg
diff --git a/nuttx/examples/nsh/nsh_romfsetc.c b/nuttx/examples/nsh/nsh_romfsetc.c
index d16da0a7a..482a3618c 100644
--- a/nuttx/examples/nsh/nsh_romfsetc.c
+++ b/nuttx/examples/nsh/nsh_romfsetc.c
@@ -1,7 +1,7 @@
/****************************************************************************
* examples/nsh/nsh_romfsetc.c
*
- * Copyright (C) 2008-2010 Gregory Nutt. All rights reserved.
+ * Copyright (C) 2008-2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
@@ -49,7 +49,15 @@
#ifdef CONFIG_EXAMPLES_NSH_ROMFSETC
-#include "nsh_romfsimg.h"
+/* Should we use the default ROMFS image? Or a custom, board-specific
+ * ROMFS image?
+ */
+
+#ifdef CONFIG_EXAMPLES_NSH_ARCHROMFS
+# include <arch/board/nsh_romfsimg.h>
+#else
+# include "nsh_romfsimg.h"
+#endif
/****************************************************************************
* Definitions