soc/add_sdcard: add with_emulator parameter to use SDCard emulator (from Google Proje...
[litex.git] / litex / tools / litex_term.py
index 8e68a7bbfb29f56e5a85ff6083a06a2cc5b71015..0ae2990d43af0bd89cf74cd148e83a3603b02a96 100755 (executable)
@@ -52,12 +52,15 @@ sfl_prompt_ack = b"\x06"
 sfl_magic_req = b"sL5DdSMmkekro\n"
 sfl_magic_ack = b"z6IHG7cYDID6o\n"
 
-sfl_payload_length = 251
+sfl_payload_length = 64
 
 # General commands
-sfl_cmd_abort = b"\x00"
-sfl_cmd_load  = b"\x01"
-sfl_cmd_jump  = b"\x02"
+sfl_cmd_abort       = b"\x00"
+sfl_cmd_load        = b"\x01"
+sfl_cmd_load_no_crc = b"\x03"
+sfl_cmd_jump        = b"\x02"
+sfl_cmd_flash       = b"\x04"
+sfl_cmd_reboot      = b"\x05"
 
 # Replies
 sfl_ack_success  = b"K"
@@ -126,7 +129,7 @@ class SFLFrame:
 
 
 class LiteXTerm:
-    def __init__(self, serial_boot, kernel_image, kernel_address, json_images):
+    def __init__(self, serial_boot, kernel_image, kernel_address, json_images, no_crc, flash):
         self.serial_boot = serial_boot
         assert not (kernel_image is not None and json_images is not None)
         self.mem_regions = {}
@@ -138,6 +141,8 @@ class LiteXTerm:
             self.mem_regions.update(json.load(f))
             self.boot_address = self.mem_regions[list(self.mem_regions.keys())[-1]]
             f.close()
+        self.no_crc = no_crc
+        self.flash = flash
 
         self.reader_alive = False
         self.writer_alive = False
@@ -176,45 +181,53 @@ class LiteXTerm:
         retry = 1
         while retry:
             self.port.write(frame.encode())
-            # Get the reply from the device
-            reply = self.port.read()
-            if reply == sfl_ack_success:
-                retry = 0
-            elif reply == sfl_ack_crcerror:
-                retry = 1
+            if not self.no_crc:
+                # Get the reply from the device
+                reply = self.port.read()
+                if reply == sfl_ack_success:
+                    retry = 0
+                elif reply == sfl_ack_crcerror:
+                    retry = 1
+                else:
+                    print("[LXTERM] Got unknown reply '{}' from the device, aborting.".format(reply))
+                    return 0
             else:
-                print("[LXTERM] Got unknown reply '{}' from the device, aborting.".format(reply))
-                return 0
+                retry = 0
         return 1
 
     def upload(self, filename, address):
-        with open(filename, "rb") as f:
-            data = f.read()
-        print("[LXTERM] Uploading {} to 0x{:08x} ({} bytes)...".format(filename, address, len(data)))
+        f = open(filename, "rb")
+        f.seek(0, 2)
+        length = f.tell()
+        f.seek(0, 0)
+        print("[LXTERM] {} {} to 0x{:08x} ({} bytes)...".format(
+            "Flashing" if self.flash else "Uploading", filename, address, length))
         current_address = address
         position = 0
-        length = len(data)
         start = time.time()
-        while len(data):
+        remaining = length
+        while remaining:
             sys.stdout.write("|{}>{}| {}%\r".format('=' * (20*position//length),
                                                     ' ' * (20-20*position//length),
                                                     100*position//length))
             sys.stdout.flush()
             frame = SFLFrame()
-            frame_data = data[:sfl_payload_length]
-            frame.cmd = sfl_cmd_load
+            frame_data = f.read(min(remaining, sfl_payload_length-4))
+            if self.flash:
+                frame.cmd = sfl_cmd_flash
+            else:
+                frame.cmd = sfl_cmd_load if not self.no_crc else sfl_cmd_load_no_crc
             frame.payload = current_address.to_bytes(4, "big")
             frame.payload += frame_data
             if self.send_frame(frame) == 0:
                 return
             current_address += len(frame_data)
             position += len(frame_data)
-            try:
-                data = data[sfl_payload_length:]
-            except:
-                data = []
+            remaining -= len(frame_data)
+            time.sleep(1e-4) # FIXME: small delay needed with FT245 FIFO ("usb_fifo"), understand why.
         end = time.time()
         elapsed = end - start
+        f.close()
         print("[LXTERM] Upload complete ({0:.1f}KB/s).".format(length/(elapsed*1024)))
         return length
 
@@ -225,6 +238,12 @@ class LiteXTerm:
         frame.payload = int(self.boot_address, 16).to_bytes(4, "big")
         self.send_frame(frame)
 
+    def reboot(self):
+        print("[LXTERM] Rebooting the device.")
+        frame = SFLFrame()
+        frame.cmd = sfl_cmd_reboot
+        self.send_frame(frame)
+
     def detect_prompt(self, data):
         if len(data):
             self.prompt_detect_buffer = self.prompt_detect_buffer[1:] + data
@@ -249,19 +268,19 @@ class LiteXTerm:
             self.port.write(sfl_magic_ack)
         for filename, base in self.mem_regions.items():
             self.upload(filename, int(base, 16))
-        self.boot()
+        if self.flash:
+            # clear mem_regions to avoid re-flashing on next reboot(s)
+            self.mem_regions = {}
+        else:
+            self.boot()
         print("[LXTERM] Done.");
 
     def reader(self):
         try:
             while self.reader_alive:
                 c = self.port.read()
-                if c == b"\r":
-                    sys.stdout.buffer.write(b"\n")
-                else:
-                    sys.stdout.buffer.write(c)
+                sys.stdout.buffer.write(c)
                 sys.stdout.flush()
-
                 if len(self.mem_regions):
                     if self.serial_boot and self.detect_prompt(c):
                         self.answer_prompt()
@@ -330,14 +349,16 @@ def _get_args():
     parser.add_argument("--serial-boot", default=False, action='store_true',
                         help="automatically initiate serial boot")
     parser.add_argument("--kernel", default=None, help="kernel image")
-    parser.add_argument("--kernel-adr", default="0x40000000", help="kernel address")
+    parser.add_argument("--kernel-adr", default="0x40000000", help="kernel address (or flash offset with --flash)")
     parser.add_argument("--images", default=None, help="json description of the images to load to memory")
+    parser.add_argument("--no-crc", default=False, action='store_true', help="disable CRC check (speedup serialboot)")
+    parser.add_argument("--flash", default=False, action='store_true', help="flash data with serialboot command")
     return parser.parse_args()
 
 
 def main():
     args = _get_args()
-    term = LiteXTerm(args.serial_boot, args.kernel, args.kernel_adr, args.images)
+    term = LiteXTerm(args.serial_boot, args.kernel, args.kernel_adr, args.images, args.no_crc, args.flash)
     term.open(args.port, int(float(args.speed)))
     term.console.configure()
     term.start()