Add quiet mode

Author: patrislav1

bin2hpm/bitfile.py

@@ -40,35 +40,39 @@ def read_str(self):
         return self.read_n(n)
 
 
-def check_info(bs, section_expected, title):
+def check_info(bs, section_expected, title, quiet_mode=False):
     section_name = bs.read_u8()
     if section_name != ord(section_expected):
         raise ValueError(f'Bitstream section {section_expected} missing')
 
     section_info = bs.read_str()
     section_info = section_info.decode('utf-8')
-    print(f'{title}: {section_info}')
 
+    if not quiet_mode:
+        print(f'{title}: {section_info}')
 
-def parse_bitfile(inp):
-    print('Parsing bitfile...')
+
+def parse_bitfile(inp, quiet_mode=False):
+    if not quiet_mode:
+        print('Parsing bitfile...')
     bs = BitfileReader(inp)
     prologue = bs.read_str()
     one = bs.read_u16()
     if len(prologue) != 9 or one != 1:
         raise ValueError('Bitstream header invalid')
 
-    check_info(bs, 'a', ' Design info')
-    check_info(bs, 'b', '   Part name')
-    check_info(bs, 'c', '   File date')
-    check_info(bs, 'd', '        time')
+    check_info(bs, 'a', ' Design info', quiet_mode)
+    check_info(bs, 'b', '   Part name', quiet_mode)
+    check_info(bs, 'c', '   File date', quiet_mode)
+    check_info(bs, 'd', '        time', quiet_mode)
 
     section_e = bs.read_u8()
     if section_e != ord('e'):
         raise ValueError('Bitstream section e missing')
 
     payload_size = bs.read_u32()
-    print(
-        f'  Image size: 0x{payload_size:08x} ({int(payload_size/1024)}KiB)\n')
+    if not quiet_mode:
+        print(
+            f'  Image size: 0x{payload_size:08x} ({int(payload_size/1024)}KiB)\n')
 
     return bs.read_n(payload_size)

bin2hpm/cli.py

@@ -76,6 +76,10 @@ def main():
                         type=str,
                         help='Additional description string (max. 21 chars)'
                         )
+    parser.add_argument('-q', '--quiet',
+                        action='store_true',
+                        help='Quiet mode'
+                        )
 
     force_fmt = parser.add_mutually_exclusive_group(required=False)
     force_fmt.add_argument('-b', '--bitfile',
@@ -108,14 +112,15 @@ def main():
         print(f'Input file {args.infile} not found', file=sys.stderr)
         sys.exit(-1)
 
-    # Print general information
-    print(f'bin2hpm v{__version__} (C) 2021 DESY\n')
-    print(
-        f'Input file {args.infile}, length {os.path.getsize(args.infile)} bytes\n')
-    print(
-        f'IANA Manuf., Product 0x{args.manufacturer:06x}, 0x{args.product:04x}')
-    print(f'Component {args.component}, Device {args.device}')
-    print(f'FW version {v_maj}.{v_min:02d} / 0x{args.auxillary:08x}\n')
+    if not args.quiet:
+        # Print general information
+        print(f'bin2hpm v{__version__} (C) 2021 DESY\n')
+        print(
+            f'Input file {args.infile}, length {os.path.getsize(args.infile)} bytes\n')
+        print(
+            f'IANA Manuf., Product 0x{args.manufacturer:06x}, 0x{args.product:04x}')
+        print(f'Component {args.component}, Device {args.device}')
+        print(f'FW version {v_maj}.{v_min:02d} / 0x{args.auxillary:08x}\n')
 
     # Determine outfile name
     outfile = args.outfile
@@ -128,12 +133,13 @@ def main():
 
     # Parse bitfile if bitmode enabled
     if bitmode:
-        img_data = bitfile.parse_bitfile(img_data)
+        img_data = bitfile.parse_bitfile(img_data, args.quiet)
 
     # Do the actual conversion
     result = hpm_conv.hpm_conv(
         img_data,
         args.compress,
+        quiet_mode=args.quiet,
         device_id=args.device,
         manufacturer_id=args.manufacturer,
         product_id=args.product,
@@ -147,4 +153,5 @@ def main():
     with open(outfile, 'wb') as f:
         f.write(result)
 
-    print(f'Output file {outfile}, length {len(result)} bytes')
+    if not args.quiet:
+        print(f'Output file {outfile}, length {len(result)} bytes')

bin2hpm/hpm_conv.py

@@ -17,7 +17,7 @@
 # device_id, manufacturer_id, product_id, components, version_major, version_minor, version_aux
 
 
-def hpm_conv(img_data, compression_enable, **kwargs):
+def hpm_conv(img_data, compression_enable, quiet_mode=False, **kwargs):
     # Build HPM upgrade image header
     result = hpm.upg_image_hdr(**kwargs)
 
@@ -29,12 +29,14 @@ def hpm_conv(img_data, compression_enable, **kwargs):
 
     # Compress data if compression enabled
     if compression_enable:
-        enc_data = rle.encode(img_data)
-        print('Verifying compressed data...')
+        enc_data = rle.encode(img_data, quiet_mode)
+        if not quiet_mode:
+            print('Verifying compressed data...')
         if rle.decode(enc_data) != img_data:
             print(f'RLE compression verify mismatch', file=sys.stderr)
             sys.exit(-1)
-        print('RLE compression verify OK\n')
+        if not quiet_mode:
+            print('RLE compression verify OK\n')
 
         img_comp_hdr = b'COMPRESSED\x00'
         img_comp_hdr += int.to_bytes(len(img_data), length=4, byteorder='big')

bin2hpm/rle.py

@@ -19,14 +19,15 @@ def to_byte(b):
     return bytes([b])
 
 
-def encode(data):
+def encode(data, quiet_mode=False):
     def check_block(data, k):
         n = 1
         while (len(data) - k) > n and data[k+n] == data[k] and n < RLE_MAX_BLKSIZE:
             n += 1
         return n, data[k]
 
-    print('Performing RLE compression ...')
+    if not quiet_mode:
+        print('Performing RLE compression ...')
     orig_len = len(data)
 
     result = b''
@@ -58,7 +59,8 @@ def check_block(data, k):
     comp_len = len(result)
     comp_ratio = 100 * comp_len / orig_len
 
-    print(f'Compressed size {comp_len} bytes, ratio {comp_ratio:.1f}%')
+    if not quiet_mode:
+        print(f'Compressed size {comp_len} bytes, ratio {comp_ratio:.1f}%')
     return result