[PATCH v2 1/2] bin2c: Import from RTEMS

Sebastian Huber sebastian.huber at embedded-brains.de
Thu Jun 14 05:28:52 UTC 2018


Corresponding RTEMS commit is 75933d5d25cd50f80162b7a0d2f66a5534e1763f.

Update #3380.
---
 misc/bin2c/compat.c      |  44 +++++++
 misc/bin2c/rtems-bin2c.c | 330 +++++++++++++++++++++++++++++++++++++++++++++++
 misc/wscript             |  71 ++++++++++
 wscript                  |   1 +
 4 files changed, 446 insertions(+)
 create mode 100644 misc/bin2c/compat.c
 create mode 100644 misc/bin2c/rtems-bin2c.c
 create mode 100644 misc/wscript

diff --git a/misc/bin2c/compat.c b/misc/bin2c/compat.c
new file mode 100644
index 0000000..9c6eb10
--- /dev/null
+++ b/misc/bin2c/compat.c
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
+ *
+ *  embedded brains GmbH
+ *  Dornierstr. 4
+ *  82178 Puchheim
+ *  Germany
+ *  <info at embedded-brains.de>
+ *
+ * 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.
+ *
+ * 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 "config.h"
+
+#include <string.h>
+
+#if !HAVE_STRNLEN
+size_t strnlen(const char *s, size_t maxlen)
+{
+  const char *n = memchr(s, '\0', maxlen);
+
+  return n != NULL ? n - s : maxlen;
+}
+#endif
diff --git a/misc/bin2c/rtems-bin2c.c b/misc/bin2c/rtems-bin2c.c
new file mode 100644
index 0000000..53caf27
--- /dev/null
+++ b/misc/bin2c/rtems-bin2c.c
@@ -0,0 +1,330 @@
+/*
+ * bin2c.c
+ *
+ * convert a binary file into a C source array.
+ *
+ * THE "BEER-WARE LICENSE" (Revision 3.1415):
+ * sandro AT sigala DOT it wrote this file. As long as you retain this
+ * notice you can do whatever you want with this stuff.  If we meet some
+ * day, and you think this stuff is worth it, you can buy me a beer in
+ * return.  Sandro Sigala
+ *
+ * Subsequently modified by Joel Sherrill <joel.sherrill at oarcorp.com>
+ * to add a number of capabilities not in the original.
+ *
+ * syntax:  bin2c [-c] [-z] <input_file> <output_file>
+ *
+ *    -c    do NOT add the "const" keyword to definition
+ *    -s    add the "static" keywork to definition
+ *    -v    verbose
+ *    -z    terminate the array with a zero (useful for embedded C strings)
+ *
+ * examples:
+ *     bin2c -c myimage.png myimage_png.cpp
+ *     bin2c -z sometext.txt sometext_txt.cpp
+ *
+ */
+
+#include <ctype.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libgen.h>
+
+#ifndef PATH_MAX
+#define PATH_MAX 1024
+#endif
+
+int useconst = 1;
+int usestatic = 0;
+int verbose = 0;
+int zeroterminated = 0;
+int createC = 1;
+int createH = 1;
+
+int myfgetc(FILE *f)
+{
+  int c = fgetc(f);
+  if (c == EOF && zeroterminated) {
+    zeroterminated = 0;
+    return 0;
+  }
+  return c;
+}
+
+void process(const char *ifname, const char *ofname, const char *forced_name)
+{
+  FILE *ifile, *ocfile, *ohfile;
+  char buf[PATH_MAX+1], *p;
+  char obasename[PATH_MAX+1];
+  char ocname[PATH_MAX+1];
+  char ohname[PATH_MAX+1];
+  const char *cp;
+  size_t len;
+
+  ocfile = NULL;
+  ohfile = NULL;
+
+  /* Error check */
+  if ( !ifname || !ofname ) {
+    fprintf(stderr, "process has NULL filename\n");
+    exit(1);
+  }
+
+  strncpy( obasename, ofname, PATH_MAX );
+  len = strnlen( obasename, PATH_MAX );
+  if ( len >= 2 ) {
+    if ( obasename[len-2] == '.' ) {
+      if ( (obasename[len-1] == 'c') || (obasename[len-1] == 'h') )
+        obasename[len-2] = '\0';
+    }
+  }
+
+  sprintf( ocname, "%s.c", obasename );
+  sprintf( ohname, "%s.h", obasename );
+
+  if ( verbose ) {
+    fprintf(
+      stderr,
+      "in file: %s\n"
+      "c file: %s\n"
+      "h file: %s\n",
+      ifname,
+      ocname,
+      ohname
+    );
+  }
+
+  /* Open input and output files */
+  ifile = fopen(ifname, "rb");
+  if (ifile == NULL) {
+    fprintf(stderr, "cannot open %s for reading\n", ifname);
+    exit(1);
+  }
+
+  if ( createC ) {
+    ocfile = fopen(ocname, "wb");
+    if (ocfile == NULL) {
+      fprintf(stderr, "cannot open %s for writing\n", ocname);
+      exit(1);
+    }
+  }
+
+  if ( createH ) {
+    ohfile = fopen(ohname, "wb");
+    if (ohfile == NULL) {
+      fprintf(stderr, "cannot open %s for writing\n", ohname);
+      exit(1);
+    }
+  }
+
+  /* find basename */
+  char *ifbasename_to_free =
+    forced_name != NULL ? strdup(forced_name) : strdup(ifname);
+  if ( ifbasename_to_free == NULL ) {
+    fprintf(stderr, "cannot allocate memory\n" );
+    fclose(ifile);
+    if ( createC ) { fclose(ocfile); }
+    if ( createH ) { fclose(ohfile); }
+    exit(1);
+  }
+
+  char *ifbasename;
+  ifbasename = basename(ifbasename_to_free);
+
+  strcpy(buf, ifbasename);
+  for (p = buf; *p != '\0'; ++p) {
+    if (!isalnum((unsigned char)*p)) /* cast to avoid negative indexing */
+      *p = '_';
+  }
+
+  if ( createC ) {
+    /* print C file header */
+    fprintf(
+      ocfile,
+      "/*\n"
+      " *  Declarations for C structure representing binary file %s\n"
+      " *\n"
+      " *  WARNING: Automatically generated -- do not edit!\n"
+      " */\n"
+      "\n"
+      "#include <sys/types.h>\n"
+      "\n",
+      ifbasename
+    );
+
+    /* print structure */
+    fprintf(
+      ocfile,
+      "%s%sunsigned char %s[] = {\n  ",
+      ((usestatic) ? "static " : ""),
+      ((useconst) ? "const " : ""),
+      buf
+    );
+    int c, col = 1;
+    while ((c = myfgetc(ifile)) != EOF) {
+      if (col >= 78 - 6) {
+        fprintf(ocfile, "\n  ");
+        col = 1;
+      }
+      fprintf(ocfile, "0x%.2x, ", c);
+      col += 6;
+
+    }
+    fprintf(ocfile, "\n};\n");
+
+    /* print sizeof */
+    fprintf(
+      ocfile,
+      "\n"
+      "%s%ssize_t %s_size = sizeof(%s);\n",
+      ((usestatic) ? "static " : ""),
+      ((useconst) ? "const " : ""),
+      buf,
+      buf
+    );
+  } /* createC */
+
+  /*****************************************************************/
+  /******                    END OF C FILE                     *****/
+  /*****************************************************************/
+
+  if ( createH ) {
+    /* print H file header */
+    char hbasename[PATH_MAX];
+    char* p;
+    /* Clean up the file name if it is an abs path */
+    strcpy(
+      hbasename,
+      obasename
+    );
+    p = hbasename;
+    while (*p != '\0') {
+      if (*p < '0' || *p > 'z')
+        *p = '_';
+      ++p;
+    }
+    fprintf(
+      ohfile,
+      "/*\n"
+      " *  Extern declarations for C structure representing binary file %s\n"
+      " *\n"
+      " *  WARNING: Automatically generated -- do not edit!\n"
+      " */\n"
+      "\n"
+      "#ifndef __%s_h\n"
+      "#define __%s_h\n"
+      "\n"
+      "#include <sys/types.h>\n"
+      "\n",
+      ifbasename,  /* header */
+      hbasename,  /* ifndef */
+      hbasename   /* define */
+    );
+
+    /* print structure */
+    fprintf(
+      ohfile,
+      "extern %s%sunsigned char %s[];",
+      ((usestatic) ? "static " : ""),
+      ((useconst) ? "const " : ""),
+      buf
+    );
+    /* print sizeof */
+    fprintf(
+      ohfile,
+      "\n"
+      "extern %s%ssize_t %s_size;\n",
+      ((usestatic) ? "static " : ""),
+      ((useconst) ? "const " : ""),
+      buf
+    );
+
+    fprintf(
+      ohfile,
+      "\n"
+      "#endif\n"
+    );
+  } /* createH */
+
+  /*****************************************************************/
+  /******                    END OF H FILE                     *****/
+  /*****************************************************************/
+
+  fclose(ifile);
+  if ( createC ) { fclose(ocfile); }
+  if ( createH ) { fclose(ohfile); }
+  free(ifbasename_to_free);
+}
+
+void usage(void)
+{
+  fprintf(
+     stderr,
+     "usage: bin2c [-csvzCH] [-N name] <input_file> <output_file>\n"
+     "  <input_file> is the binary file to convert\n"
+     "  <output_file> should not have a .c or .h extension\n"
+     "\n"
+     "  -c - do NOT use const in declaration\n"
+     "  -s - do use static in declaration\n"
+     "  -v - verbose\n"
+     "  -z - add zero terminator\n"
+     "  -H - create c-header only\n"
+     "  -C - create c-source file only\n"
+     "  -N - force name of data array\n"
+    );
+  exit(1);
+}
+
+int main(int argc, char **argv)
+{
+  const char *name = NULL;
+  while (argc > 3) {
+    if (!strcmp(argv[1], "-c")) {
+      useconst = 0;
+      --argc;
+      ++argv;
+    } else if (!strcmp(argv[1], "-s")) {
+      usestatic = 1;
+      --argc;
+      ++argv;
+    } else if (!strcmp(argv[1], "-v")) {
+      verbose = 1;
+      --argc;
+      ++argv;
+    } else if (!strcmp(argv[1], "-z")) {
+      zeroterminated = 1;
+      --argc;
+      ++argv;
+    } else if (!strcmp(argv[1], "-C")) {
+      createH = 0;
+      createC = 1;
+      --argc;
+      ++argv;
+    } else if (!strcmp(argv[1], "-H")) {
+      createC = 0;
+      createH = 1;
+      --argc;
+      ++argv;
+    } else if (!strcmp(argv[1], "-N")) {
+      --argc;
+      ++argv;
+      if (argc <= 1) {
+        fprintf(stderr, "error: -N needs a name\n");
+        usage();
+      }
+      name = argv[1];
+      --argc;
+      ++argv;
+    } else {
+      usage();
+    }
+  }
+  if (argc != 3) {
+    usage();
+  }
+
+  /* process( input_file, output_basename ) */
+  process(argv[1], argv[2], name);
+  return 0;
+}
diff --git a/misc/wscript b/misc/wscript
new file mode 100644
index 0000000..95c7bde
--- /dev/null
+++ b/misc/wscript
@@ -0,0 +1,71 @@
+#
+# RTEMS Tools Project (http://www.rtems.org/)
+# Copyright 2014-2016 Chris Johns (chrisj at rtems.org)
+# Copyright 2018 embedded brains GmbH
+# All rights reserved.
+#
+# This file is part of the RTEMS Tools package in 'rtems-tools'.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+#
+# RTEMS miscellaneous build script.
+#
+import sys
+
+def init(ctx):
+    pass
+
+def options(opt):
+    opt.load('compiler_c')
+
+def configure(conf):
+    conf.load('compiler_c')
+
+    conf.check_cc(function_name = 'strnlen', header_name="string.h",
+                  features = 'c', mandatory = False)
+    conf.write_config_header('config.h')
+
+def build(bld):
+    #
+    # The local configuration.
+    #
+    conf = {}
+
+    #
+    # Build flags.
+    #
+    conf['warningflags'] = ['-Wall', '-Wextra', '-pedantic']
+    conf['optflags'] = bld.env.C_OPTS
+    conf['cflags'] = ['-pipe', '-g'] + conf['optflags']
+    conf['linkflags'] = ['-g']
+
+    #
+    # The list of defines
+    #
+    defines = ['RTEMS_VERSION=\"%s\"' % (bld.env.RTEMS_VERSION),
+               'RTEMS_RELEASE=\"%s\"' % (bld.env.RTEMS_RELEASE)]
+
+    #
+    # Build the bin2c.
+    #
+    bld.program(target = 'rtems-bin2c',
+                source = ['bin2c/rtems-bin2c.c', 'bin2c/compat.c'],
+                includes = ['.'],
+                defines = defines,
+                cflags = conf['cflags'] + conf['warningflags'],
+                linkflags = conf['linkflags'])
+
+def tags(ctx):
+    ctx.exec_command('etags $(find . -name \*.[sSch])', shell = True)
diff --git a/wscript b/wscript
index 0f51f96..d4f841e 100644
--- a/wscript
+++ b/wscript
@@ -34,6 +34,7 @@ import wafwindows
 
 subdirs = ['rtemstoolkit',
            'linkers',
+           'misc',
            'tester',
            'tools/gdb/python']
 
-- 
2.13.7



More information about the devel mailing list