add tockloader tbf convert command

Author: bradjc

README.md

@@ -134,6 +134,10 @@ Interact with TLV structures within a TBF.
 
 Add and remove credentials in the TBF footer.
 
+#### `tockloader tbf convert [output format]`
+
+Convert a TBF to a different format.
+
 #### `tockloader tickv get|append|invalidate|dump|cleanup|reset [key] [value]`
 
 Interact with a TicKV key-value database.

tockloader/app_tab.py

@@ -407,6 +407,47 @@ def get_binary(self, address):
         else:
             raise ("Only valid for one TBF file.")
 
+    def convert(self, format):
+        """
+        Convert a TAB-based app to a different format. Valid formats:
+        - `cbinary`: Create a C struct with a binary representation of the app.
+
+        This is only valid if there is one TBF file.
+        """
+
+        def trim_trailing_zeroes(b):
+            for i in range(len(b) - 1, 0, -1):
+                if b[i] != 0x0:
+                    return b[0 : i + 1]
+
+        def format_data_strings(b):
+            def chunked(source, size):
+                for i in range(0, len(source), size):
+                    yield source[i : i + size]
+
+            out = "{"
+            rows = []
+            for chunk in chunked(b, 10):
+                row = ["0x{:02x}".format(c) for c in chunk]
+                rows.append(", ".join(row))
+            return "{{{}}}".format(",\n   ".join(rows))
+
+        if format == "cbinary":
+            output = """
+struct tock_app app = {{
+  "{name}",
+  {length},
+  {data},
+}};
+"""
+            name = self.get_name()
+            binary = self.get_binary(0)
+            length = len(binary)
+            trimmed = trim_trailing_zeroes(binary)
+            data = format_data_strings(trimmed)
+            out = output.format(name=name, length=length, data=data)
+            return out
+
     def get_names_and_binaries(self):
         """
         Return (filename, binary) tuples for each contained TBF. This is for

tockloader/main.py

@@ -557,6 +557,41 @@ def command_tbf_credential_delete(args):
                 tab.update_tbf(app)
 
 
+def command_tbf_convert(args):
+    tabs = collect_tabs(args)
+
+    if len(tabs) == 0:
+        raise TockLoaderException("No TABs found to inspect")
+
+    if len(tabs) > 1:
+        tab_names = [tab.get_app_name() for tab in tabs]
+        index = helpers.menu_new(
+            tab_names + ["None"],
+            return_type="index",
+            title="Which TAB to use to convert a TBF?",
+        )
+        if index >= len(tabs):
+            return
+        tab = tabs[index]
+    else:
+        tab = tabs[0]
+
+    # Ask the user if they want to see more detail about a certain TBF.
+    tbf_names = tab.get_tbf_names()
+    index = helpers.menu_new(
+        tbf_names + ["None"],
+        return_type="index",
+        title="Which TBF to convert?",
+    )
+    if index >= len(tbf_names):
+        return
+
+    app = tab.extract_tbf(tbf_names[index])
+
+    converted = app.convert(args.format)
+    print(converted)
+
+
 def command_dump_flash_page(args):
     tock_loader = TockLoader(args)
     tock_loader.open()
@@ -1343,6 +1378,26 @@ def main():
         "tab", help="The TAB or TABs to modify", nargs="*"
     )
 
+    #################
+    ## TBF CONVERT ##
+    #################
+
+    tbf_convert = tbf_subparser.add_parser(
+        "convert",
+        parents=[parent],
+        help="Commands for converting TBFs into different formats",
+    )
+
+    tbf_convert.set_defaults(func=command_tbf_convert)
+    tbf_convert.add_argument(
+        "format",
+        help="Output format",
+        choices=[
+            "cbinary",
+        ],
+    )
+    tbf_convert.add_argument("tab", help="The TAB or TABs to modify", nargs="*")
+
     ###########
     ## TICKV ##
     ###########