artiq_coremgmt: improve logging when flashing

artiq/coredevice/comm_mgmt.py

@@ -79,7 +79,11 @@ def close(self):
     # Protocol elements
 
     def _write(self, data):
-        self.socket.sendall(data)
+        total_sent = 0
+        while total_sent < len(data):
+            sent = self.socket.send(data[total_sent:])
+            total_sent += sent
+            logger.debug("sent %d bytes", sent)
 
     def _write_header(self, ty):
         self.open()
@@ -206,6 +210,7 @@ def flash(self, bin_paths):
 
         with io.BytesIO() as image_buf:
             for filename in bin_paths:
+                logger.debug("writing %s to byte buffer", filename)
                 with open(filename, "rb") as fi:
                     bin_ = fi.read()
                     if (len(bin_paths) > 1):
@@ -216,6 +221,7 @@ def flash(self, bin_paths):
             crc = binascii.crc32(image_buf.getvalue())
             image_buf.write(struct.pack(self.endian + "I", crc))
 
+            logger.debug("sending byte buffer to core device")
             self._write_bytes(image_buf.getvalue())
 
         self._read_expect(Reply.RebootImminent)

artiq/frontend/artiq_coremgmt.py

@@ -5,6 +5,7 @@
 import struct
 import tempfile
 import atexit
+import logging
 
 from sipyco import common_args
 
@@ -14,6 +15,8 @@
 from artiq.coredevice.comm_mgmt import CommMgmt
 from artiq.frontend.flash_tools import bit2bin, fetch_bin
 
+logger = logging.getLogger(__name__)
+
 
 def get_argparser():
     parser = argparse.ArgumentParser(description="ARTIQ core device "
@@ -147,7 +150,7 @@ def main():
         if args.action == "read":
             value = mgmt.config_read(args.key)
             if not value:
-                print("Key {} does not exist".format(args.key))
+                logger.error("Key {} does not exist".format(args.key))
             else:
                 print(value)
         if args.action == "write":
@@ -175,6 +178,8 @@ def main():
             ],
         }
 
+        logger.info("Retrieving binaries...")
+
         for bin_list in bin_dict.values():
             try:
                 bins = []
@@ -192,9 +197,13 @@ def main():
             raise ValueError("both risc-v and zynq binaries were found, "
                              "please clean up your build directory. ")
 
+        logger.info("Flashing core device...")
+
         bins = retrieved_bins[0]
         mgmt.flash(bins)
 
+        logger.info("Rebooting core device.")
+
     if args.tool == "reboot":
         mgmt.reboot()
 

artiq/frontend/flash_tools.py

@@ -1,8 +1,11 @@
 import atexit
+import logging
 import os
 import tempfile
 import struct
 
+logger = logging.getLogger(__name__)
+
 
 def artifact_path(this_binary_dir, *path_filename, srcbuild=False):
     if srcbuild:
@@ -99,14 +102,14 @@ def bit2bin(bit, bin, flip=False):
                     "c": "Date",
                     "d": "Time"
                     }[key]
-            print("{}: {}".format(name, d))
+            logger.debug("{}: {}".format(name, d))
         elif key == "e":
             l, = struct.unpack(">I", bit.read(4))
-            print("Bitstream payload length: {:#x}".format(l))
+            logger.debug("Bitstream payload length: {:#x}".format(l))
             d = bit.read(l)
             if flip:
                 d = flip32(d)
             bin.write(d)
         else:
             d = bit.read(*struct.unpack(">H", bit.read(2)))
-            print("Unexpected key: {}: {}".format(key, d))
+            logger.error("Unexpected key: {}: {}".format(key, d))