hex2bin: Add alternative interface layers to illustrate how to load programs

include/hex2bin.h

@@ -173,6 +173,60 @@ int hex2bin(FAR struct lib_instream_s *instream,
             FAR struct lib_sostream_s *outstream, uint32_t baseaddr,
             uint32_t endpaddr, enum hex2bin_swap_e swap);
 
+/****************************************************************************
+ * Name hex2mem
+ *
+ * Description:
+ *   Read the Intel HEX ASCII data provided on the file descriptor 'fd' and
+ *   write the binary to memory.
+ *
+ *   If, for example, fd is zero (corresponding to stdin), then the HEX
+ *   ASCII data would be taken from the console and written to memory.
+ *
+ * Input Parameters:
+ *   fd        - The file descriptor from which Intel HEX data will be
+ *               received.
+ *   baseaddr  - The base address of the memory region stream.
+ *   endpaddr  - The end address (plus 1) of the memory region.
+ *   swap      - Controls byte ordering.  See enum hex2bin_swap_e for
+ *               description of the values.
+ *
+ * Returned Value
+ *   Zero (OK) is returned on success; a negated errno value is returned on
+ *   failure.
+ *
+ ****************************************************************************/
+
+int hex2mem(int fd, uint32_t baseaddr, uint32_t endpaddr,
+            enum hex2bin_swap_e swap);
+
+/****************************************************************************
+ * Name fhex2mem
+ *
+ * Description:
+ *   Read the Intel HEX ASCII data provided on the standard stream
+ *   'instream' and write the binary to memory.
+ *
+ *   If, for example, instream is stdin, then the HEX ASCII data would be
+ *   taken from the console and written to memory.
+ *
+ * Input Parameters:
+ *   instream  - The incoming standard stream from which Intel HEX data
+ *               will be received.
+ *   baseaddr  - The base address of the memory region stream.
+ *   endpaddr  - The end address (plus 1) of the memory region.
+ *   swap      - Controls byte ordering.  See enum hex2bin_swap_e for
+ *               description of the values.
+ *
+ * Returned Value
+ *   Zero (OK) is returned on success; a negated errno value is returned on
+ *   failure.
+ *
+ ****************************************************************************/
+
+int fhex2mem(FAR FILE *instream, uint32_t baseaddr, uint32_t endpaddr,
+             enum hex2bin_swap_e swap);
+
 /****************************************************************************
  * Name: hex2bin_main
  *
@@ -188,11 +242,27 @@ int hex2bin(FAR struct lib_instream_s *instream,
  ****************************************************************************/
 
 #ifdef CONFIG_SYSTEM_HEX2BIN_BUILTIN
-
 int hex2bin_main(int argc, char **argv);
-
 #endif /* CONFIG_SYSTEM_HEX2BIN_BUILTIN */
 
+/****************************************************************************
+ * Name: hex2mem_main
+ *
+ * Description:
+ *   Main entry point when hex2mem is built as an NSH built-in task.
+ *
+ * Input Parameters:
+ *   Standard task inputs
+ *
+ * Returned Value
+ *   EXIT_SUCESS on success; EXIT_FAILURE on failure
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_SYSTEM_HEX2MEM_BUILTIN
+int hex2mem_main(int argc, char **argv);
+#endif /* CONFIG_SYSTEM_HEX2MEM_BUILTIN */
+
 #undef EXTERN
 #ifdef __cplusplus
 }

system/hex2bin/Makefile

@@ -40,7 +40,7 @@ include $(APPDIR)/Make.defs
 # I2C tool
 
 ASRCS =
-CSRCS = hex2bin.c
+CSRCS = hex2bin.c hex2mem.c fhex2mem.c
 
 ifeq ($(CONFIG_SYSTEM_HEX2BIN_BUILTIN),y)
 CSRCS += hex2bin_main.c

system/hex2bin/fhex2mem.c

@@ -0,0 +1,115 @@
+/****************************************************************************
+ * apps/system/fhex2mem.c
+ *
+ *   Copyright (C) 2014 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * 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 <stdio.h>
+#include <assert.h>
+
+#include <nuttx/streams.h>
+#include <apps/hex2bin.h>
+
+#ifdef CONFIG_SYSTEM_HEX2BIN
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name fhex2mem
+ *
+ * Description:
+ *   Read the Intel HEX ASCII data provided on the standard stream
+ *   'instream' and write the binary to memory.
+ *
+ *   If, for example, instream is stdin, then the HEX ASCII data would be
+ *   taken from the console and written to memory.
+ *
+ * Input Parameters:
+ *   instream  - The incoming standard stream from which Intel HEX data
+ *               will be received.
+ *   baseaddr  - The base address of the memory region stream.
+ *   endpaddr  - The end address (plus 1) of the memory region.
+ *   swap      - Controls byte ordering.  See enum hex2bin_swap_e for
+ *               description of the values.
+ *
+ * Returned Value
+ *   Zero (OK) is returned on success; a negated errno value is returned on
+ *   failure.
+ *
+ ****************************************************************************/
+
+int fhex2mem(FAR FILE *instream, uint32_t baseaddr, uint32_t endpaddr,
+             enum hex2bin_swap_e swap)
+{
+  struct lib_stdinstream_s stdinstream;
+  struct lib_memsostream_s memoutstream;
+
+  /* Check memory addresses */
+
+  DEBUGASSERT(instream && endpaddr > baseaddr);
+
+  /* Wrap the file descriptor as raw stream; wrap the memory as a memory
+   * stream.
+   */
+
+  lib_stdinstream(&stdinstream, instream);
+  lib_memsostream(&memoutstream, (FAR char *)baseaddr,
+                  (int)(endpaddr - baseaddr));
+
+  /* And do the deed */
+
+  return hex2bin(&stdinstream.public, &memoutstream.public,
+                 (uint32_t)baseaddr, (uint32_t)endpaddr,
+                 (enum hex2bin_swap_e)swap);
+}
+
+#endif /* CONFIG_SYSTEM_HEX2BIN */

system/hex2bin/hex2bin_main.c

@@ -100,11 +100,7 @@ static void show_usage(FAR const char *progname, int exitcode)
 }
 
 /****************************************************************************
- * Private Functions
+ * Public Functions
- ****************************************************************************/
-
-/****************************************************************************
- * Name: 
  ****************************************************************************/
 
 /****************************************************************************
@@ -146,9 +142,11 @@ int hex2bin_main(int argc, char **argv)
     {
       switch (option)
         {
+#ifdef CONFIG_SYSTEM_HEX2BIN_USAGE
         case 'h':
           show_usage(argv[0], EXIT_SUCCESS);
           break;
+#endif
 
         case 's':
           baseaddr = strtoul(optarg, &endptr, 16);
@@ -261,6 +259,7 @@ int hex2bin_main(int argc, char **argv)
 
   /* Clean up and return */
 
+  fflush(outstream);
   fclose(instream);
   fclose(outstream);
   return ret < 0 ? EXIT_FAILURE : EXIT_SUCCESS;

system/hex2bin/hex2mem.c

@@ -0,0 +1,115 @@
+/****************************************************************************
+ * apps/system/hex2mem.c
+ *
+ *   Copyright (C) 2014 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * 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 <stdio.h>
+#include <assert.h>
+
+#include <nuttx/streams.h>
+#include <apps/hex2bin.h>
+
+#ifdef CONFIG_SYSTEM_HEX2BIN
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name hex2mem
+ *
+ * Description:
+ *   Read the Intel HEX ASCII data provided on the file descriptor 'fd' and
+ *   write the binary to memory.
+ *
+ *   If, for example, fd is zero (stdin), then the HEX ASCII data would be
+ *   taken from the console and written to memory.
+ *
+ * Input Parameters:
+ *   fd        - The file descriptor from which Intel HEX data will be
+ *               received.
+ *   baseaddr  - The base address of the memory region stream.
+ *   endpaddr  - The end address (plus 1) of the memory region.
+ *   swap      - Controls byte ordering.  See enum hex2bin_swap_e for
+ *               description of the values.
+ *
+ * Returned Value
+ *   Zero (OK) is returned on success; a negated errno value is returned on
+ *   failure.
+ *
+ ****************************************************************************/
+
+int hex2mem(int fd, uint32_t baseaddr, uint32_t endpaddr,
+            enum hex2bin_swap_e swap)
+{
+  struct lib_rawinstream_s rawinstream;
+  struct lib_memsostream_s memoutstream;
+
+  /* Check memory addresses */
+
+  DEBUGASSERT(fd >= 0 && endpaddr > baseaddr);
+
+  /* Wrap the file descriptor as raw stream; wrap the memory as a memory
+   * stream.
+   */
+
+  lib_rawinstream(&rawinstream, fd);
+  lib_memsostream(&memoutstream, (FAR char *)baseaddr,
+                  (int)(endpaddr - baseaddr));
+
+  /* And do the deed */
+
+  return hex2bin(&rawinstream.public, &memoutstream.public,
+                 (uint32_t)baseaddr, (uint32_t)endpaddr,
+                 (enum hex2bin_swap_e)swap);
+}
+
+#endif /* CONFIG_SYSTEM_HEX2BIN */

system/hex2bin/hex2mem_main.c

@@ -95,11 +95,7 @@ static void show_usage(FAR const char *progname, int exitcode)
 }
 
 /****************************************************************************
- * Private Functions
+ * Public Functions
- ****************************************************************************/
-
-/****************************************************************************
- * Name: 
  ****************************************************************************/
 
 /****************************************************************************
@@ -139,9 +135,11 @@ int hex2mem_main(int argc, char **argv)
     {
       switch (option)
         {
+#ifdef CONFIG_SYSTEM_HEX2MEM_USAGE
         case 'h':
           show_usage(argv[0], EXIT_SUCCESS);
           break;
+#endif
 
         case 's':
           baseaddr = strtoul(optarg, &endptr, 16);
@@ -221,12 +219,13 @@ int hex2mem_main(int argc, char **argv)
       return -errcode;
     }
 
-  /* Wrap the FILE stream as standard streams; wrap the memory as a memory
+  /* Wrap the FILE stream as a standard stream; wrap the memory as a memory
    * stream.
    */
 
   lib_stdinstream(&stdinstream, instream);
-  lib_memsostream(&memoutstream, (FAR char *)baseaddr, (int)(endpaddr - baseaddr));
+  lib_memsostream(&memoutstream, (FAR char *)baseaddr,
+                  (int)(endpaddr - baseaddr));
 
   /* And do the deed */