litex/tools/litex_term.py

   1 #!/usr/bin/env python3
   2
   3 # This file is Copyright (c) 2015-2019 Florent Kermarrec <florent@enjoy-digital.fr>
   4 # This file is Copyright (c) 2015 Sebastien Bourdeauducq <sb@m-labs.hk>
   5 # This file is Copyright (c) 2016 whitequark <whitequark@whitequark.org>
   6 # License: BSD
   7
   8 import sys
   9 import signal
  10 import os
  11 import time
  12 import serial
  13 import threading
  14 import argparse
  15 import json
  16
  17
  18 if sys.platform == "win32":
  19     import msvcrt
  20     class Console:
  21         def configure(self):
  22             pass
  23
  24         def unconfigure(self):
  25             pass
  26
  27         def getkey(self):
  28             return msvcrt.getch()
  29 else:
  30     import termios
  31     class Console:
  32         def __init__(self):
  33             self.fd = sys.stdin.fileno()
  34             self.default_settings = termios.tcgetattr(self.fd)
  35
  36         def configure(self):
  37             settings = termios.tcgetattr(self.fd)
  38             settings[3] = settings[3] & ~termios.ICANON & ~termios.ECHO
  39             settings[6][termios.VMIN] = 1
  40             settings[6][termios.VTIME] = 0
  41             termios.tcsetattr(self.fd, termios.TCSANOW, settings)
  42
  43         def unconfigure(self):
  44             termios.tcsetattr(self.fd, termios.TCSAFLUSH, self.default_settings)
  45
  46         def getkey(self):
  47             return os.read(self.fd, 1)
  48
  49 sfl_prompt_req = b"F7:    boot from serial\n"
  50 sfl_prompt_ack = b"\x06"
  51
  52 sfl_magic_req = b"sL5DdSMmkekro\n"
  53 sfl_magic_ack = b"z6IHG7cYDID6o\n"
  54
  55 sfl_payload_length = 251
  56
  57 # General commands
  58 sfl_cmd_abort       = b"\x00"
  59 sfl_cmd_load        = b"\x01"
  60 sfl_cmd_load_no_crc = b"\x03"
  61 sfl_cmd_jump        = b"\x02"
  62
  63 # Replies
  64 sfl_ack_success  = b"K"
  65 sfl_ack_crcerror = b"C"
  66 sfl_ack_unknown  = b"U"
  67 sfl_ack_error    = b"E"
  68
  69
  70 crc16_table = [
  71     0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
  72     0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
  73     0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
  74     0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
  75     0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
  76     0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
  77     0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
  78     0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
  79     0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
  80     0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
  81     0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
  82     0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
  83     0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
  84     0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
  85     0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
  86     0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
  87     0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
  88     0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
  89     0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
  90     0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
  91     0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
  92     0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
  93     0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
  94     0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
  95     0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
  96     0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
  97     0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
  98     0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
  99     0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
 100     0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
 101     0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
 102     0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
 103 ]
 104
 105
 106 def crc16(l):
 107     crc = 0
 108     for d in l:
 109         crc = crc16_table[((crc >> 8) ^ d) & 0xff] ^ (crc << 8)
 110     return crc & 0xffff
 111
 112
 113 class SFLFrame:
 114     def __init__(self):
 115         self.cmd = bytes()
 116         self.payload = bytes()
 117
 118     def compute_crc(self):
 119         return crc16(self.cmd + self.payload)
 120
 121     def encode(self):
 122         packet = bytes([len(self.payload)])
 123         packet += self.compute_crc().to_bytes(2, "big")
 124         packet += self.cmd
 125         packet += self.payload
 126         return packet
 127
 128
 129 class LiteXTerm:
 130     def __init__(self, serial_boot, kernel_image, kernel_address, json_images, no_crc):
 131         self.serial_boot = serial_boot
 132         assert not (kernel_image is not None and json_images is not None)
 133         self.mem_regions = {}
 134         if kernel_image is not None:
 135             self.mem_regions = {kernel_image: kernel_address}
 136             self.boot_address = kernel_address
 137         if json_images is not None:
 138             f = open(json_images, "r")
 139             self.mem_regions.update(json.load(f))
 140             self.boot_address = self.mem_regions[list(self.mem_regions.keys())[-1]]
 141             f.close()
 142         self.no_crc = no_crc
 143
 144         self.reader_alive = False
 145         self.writer_alive = False
 146
 147         self.prompt_detect_buffer = bytes(len(sfl_prompt_req))
 148         self.magic_detect_buffer = bytes(len(sfl_magic_req))
 149
 150         self.console = Console()
 151
 152         signal.signal(signal.SIGINT, self.sigint)
 153         self.sigint_time_last = 0
 154
 155         self.lf_insert = True
 156
 157     def open(self, port, baudrate):
 158         if hasattr(self, "port"):
 159             return
 160         self.port = serial.serial_for_url(port, baudrate)
 161
 162     def close(self):
 163         if not hasattr(self, "port"):
 164             return
 165         self.port.close()
 166         del self.port
 167
 168     def sigint(self, sig, frame):
 169         self.port.write(b"\x03")
 170         sigint_time_current = time.time()
 171         # Exit term if 2 CTRL-C pressed in less than 0.5s.
 172         if (sigint_time_current - self.sigint_time_last < 0.5):
 173             self.console.unconfigure()
 174             self.close()
 175             sys.exit()
 176         else:
 177             self.sigint_time_last = sigint_time_current
 178
 179     def send_frame(self, frame):
 180         retry = 1
 181         while retry:
 182             self.port.write(frame.encode())
 183             if not self.no_crc:
 184                 # Get the reply from the device
 185                 reply = self.port.read()
 186                 if reply == sfl_ack_success:
 187                     retry = 0
 188                 elif reply == sfl_ack_crcerror:
 189                     retry = 1
 190                 else:
 191                     print("[LXTERM] Got unknown reply '{}' from the device, aborting.".format(reply))
 192                     return 0
 193             else:
 194                 retry = 0
 195         return 1
 196
 197     def upload(self, filename, address):
 198         with open(filename, "rb") as f:
 199             data = f.read()
 200         print("[LXTERM] Uploading {} to 0x{:08x} ({} bytes)...".format(filename, address, len(data)))
 201         current_address = address
 202         position = 0
 203         length = len(data)
 204         start = time.time()
 205         while len(data):
 206             sys.stdout.write("|{}>{}| {}%\r".format('=' * (20*position//length),
 207                                                     ' ' * (20-20*position//length),
 208                                                     100*position//length))
 209             sys.stdout.flush()
 210             frame = SFLFrame()
 211             frame_data = data[:sfl_payload_length]
 212             frame.cmd = sfl_cmd_load if not self.no_crc else sfl_cmd_load_no_crc
 213             frame.payload = current_address.to_bytes(4, "big")
 214             frame.payload += frame_data
 215             if self.send_frame(frame) == 0:
 216                 return
 217             current_address += len(frame_data)
 218             position += len(frame_data)
 219             try:
 220                 data = data[sfl_payload_length:]
 221             except:
 222                 data = []
 223         end = time.time()
 224         elapsed = end - start
 225         print("[LXTERM] Upload complete ({0:.1f}KB/s).".format(length/(elapsed*1024)))
 226         return length
 227
 228     def boot(self):
 229         print("[LXTERM] Booting the device.")
 230         frame = SFLFrame()
 231         frame.cmd = sfl_cmd_jump
 232         frame.payload = int(self.boot_address, 16).to_bytes(4, "big")
 233         self.send_frame(frame)
 234
 235     def detect_prompt(self, data):
 236         if len(data):
 237             self.prompt_detect_buffer = self.prompt_detect_buffer[1:] + data
 238             return self.prompt_detect_buffer == sfl_prompt_req
 239         else:
 240             return False
 241
 242     def answer_prompt(self):
 243         print("[LXTERM] Received serial boot prompt from the device.")
 244         self.port.write(sfl_prompt_ack)
 245
 246     def detect_magic(self, data):
 247         if len(data):
 248             self.magic_detect_buffer = self.magic_detect_buffer[1:] + data
 249             return self.magic_detect_buffer == sfl_magic_req
 250         else:
 251             return False
 252
 253     def answer_magic(self):
 254         print("[LXTERM] Received firmware download request from the device.")
 255         if(len(self.mem_regions)):
 256             self.port.write(sfl_magic_ack)
 257         for filename, base in self.mem_regions.items():
 258             self.upload(filename, int(base, 16))
 259         self.boot()
 260         print("[LXTERM] Done.");
 261
 262     def reader(self):
 263         try:
 264             c_last = 0
 265             while self.reader_alive:
 266                 c = self.port.read()
 267                 if c_last == b"\r":
 268                     if c == b"\n":
 269                         self.lf_insert = False
 270                     else:
 271                         self.lf_insert = True
 272                 c_last = c
 273                 if self.lf_insert and c == b"\r":
 274                     sys.stdout.buffer.write(b"\n")
 275                 else:
 276                     sys.stdout.buffer.write(c)
 277                 sys.stdout.flush()
 278
 279                 if len(self.mem_regions):
 280                     if self.serial_boot and self.detect_prompt(c):
 281                         self.answer_prompt()
 282                     if self.detect_magic(c):
 283                         self.answer_magic()
 284
 285         except serial.SerialException:
 286             self.reader_alive = False
 287             self.console.unconfigure()
 288             raise
 289
 290     def start_reader(self):
 291         self.reader_alive = True
 292         self.reader_thread = threading.Thread(target=self.reader)
 293         self.reader_thread.setDaemon(True)
 294         self.reader_thread.start()
 295
 296     def stop_reader(self):
 297         self.reader_alive = False
 298         self.reader_thread.join()
 299
 300     def writer(self):
 301         try:
 302             while self.writer_alive:
 303                 b = self.console.getkey()
 304                 if b == b"\x03":
 305                     self.stop()
 306                 elif b == b"\n":
 307                     self.port.write(b"\x0a")
 308                 else:
 309                     self.port.write(b)
 310         except:
 311             self.writer_alive = False
 312             self.console.unconfigure()
 313             raise
 314
 315     def start_writer(self):
 316         self.writer_alive = True
 317         self.writer_thread = threading.Thread(target=self.writer)
 318         self.writer_thread.setDaemon(True)
 319         self.writer_thread.start()
 320
 321     def stop_writer(self):
 322         self.writer_alive = False
 323         self.writer_thread.join()
 324
 325     def start(self):
 326         print("[LXTERM] Starting....")
 327         self.start_reader()
 328         self.start_writer()
 329
 330     def stop(self):
 331         self.reader_alive = False
 332         self.writer_alive = False
 333
 334     def join(self, writer_only=False):
 335         self.writer_thread.join()
 336         if not writer_only:
 337             self.reader_thread.join()
 338
 339
 340 def _get_args():
 341     parser = argparse.ArgumentParser()
 342     parser.add_argument("port", help="serial port")
 343     parser.add_argument("--speed", default=115200, help="serial baudrate")
 344     parser.add_argument("--serial-boot", default=False, action='store_true',
 345                         help="automatically initiate serial boot")
 346     parser.add_argument("--kernel", default=None, help="kernel image")
 347     parser.add_argument("--kernel-adr", default="0x40000000", help="kernel address")
 348     parser.add_argument("--images", default=None, help="json description of the images to load to memory")
 349     parser.add_argument("--no-crc", default=False, action='store_true', help="disable CRC check (speedup serialboot)")
 350     return parser.parse_args()
 351
 352
 353 def main():
 354     args = _get_args()
 355     term = LiteXTerm(args.serial_boot, args.kernel, args.kernel_adr, args.images, args.no_crc)
 356     term.open(args.port, int(float(args.speed)))
 357     term.console.configure()
 358     term.start()
 359     term.join(True)
 360
 361 if __name__ == "__main__":
 362     main()