litex/soc/misoc/tools/flterm.py

   1 #!/usr/bin/env python3
   2
   3 import sys
   4 import os
   5 import time
   6 import serial
   7 import threading
   8 import argparse
   9
  10 from serial.tools.miniterm import console, character, LF
  11
  12 sfl_magic_len = 14
  13 sfl_magic_req = "sL5DdSMmkekro\n"
  14 sfl_magic_ack = "z6IHG7cYDID6o\n"
  15
  16 # General commands
  17 sfl_cmd_abort = 0x00
  18 sfl_cmd_load  = 0x01
  19 sfl_cmd_jump  = 0x02
  20
  21
  22 # Replies
  23 sfl_ack_success  = 'K'
  24 sfl_ack_crcerror = 'C'
  25 sfl_ack_unknown  = 'U'
  26 sfl_ack_error    = 'E'
  27
  28
  29 crc16_table = [
  30     0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
  31     0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
  32     0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
  33     0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
  34     0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
  35     0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
  36     0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
  37     0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
  38     0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
  39     0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
  40     0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
  41     0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
  42     0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
  43     0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
  44     0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
  45     0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
  46     0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
  47     0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
  48     0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
  49     0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
  50     0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
  51     0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
  52     0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
  53     0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
  54     0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
  55     0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
  56     0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
  57     0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
  58     0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
  59     0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
  60     0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
  61     0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
  62 ]
  63
  64
  65 def crc16(l):
  66     crc = 0
  67     for d in l:
  68         crc = crc16_table[((crc >> 8) ^ d) & 0xff] ^ (crc << 8)
  69     return crc & 0xffff
  70
  71
  72 class SFLFrame:
  73     def __init__(self):
  74         self.length = None
  75         self.cmd = None
  76         self.payload = []
  77         self.crc = None
  78         self.raw = []
  79
  80     def compute_crc(self):
  81         crc_data = []
  82         crc_data.append(self.cmd)
  83         for d in self.payload:
  84             crc_data.append(d)
  85         self.crc = crc16(crc_data)
  86         return self.crc
  87
  88     def encode(self):
  89         self.raw = []
  90         self.raw.append(self.length)
  91         self.compute_crc()
  92         for d in self.crc.to_bytes(2, "big"):
  93             self.raw.append(d)
  94         self.raw.append(self.cmd)
  95         for d in self.payload:
  96             self.raw.append(d)
  97
  98
  99 def get_file_data(filename):
 100     with open(filename, "rb") as f:
 101         data = []
 102         while True:
 103             w = f.read(1)
 104             if not w:
 105                 break
 106             data.append(int.from_bytes(w, "big"))
 107     return data
 108
 109
 110 class Flterm:
 111     def __init__(self, kernel_image, kernel_address):
 112         self.kernel_image = kernel_image
 113         self.kernel_address = kernel_address
 114
 115         self.reader_alive = False
 116         self.writer_alive = False
 117
 118         self.detect_magic_str = " "*len(sfl_magic_req)
 119
 120     def open(self, port, speed):
 121         self.serial = serial.serial_for_url(
 122             port,
 123             baudrate=speed,
 124             bytesize=8,
 125             parity="N",
 126             stopbits=1,
 127             xonxoff=0,
 128             timeout=0.25)
 129         self.serial.flushOutput()
 130         self.serial.flushInput()
 131         self.serial.close()  # in case port was not correctly closed
 132         self.serial.open()
 133
 134     def close(self):
 135         self.serial.close()
 136
 137     def write_exact(self, data):
 138         if isinstance(data, str):
 139             self.serial.write(bytes(data, "utf-8"))
 140         else:
 141             self.serial.write(serial.to_bytes(data))
 142
 143     def send_frame(self, frame):
 144         frame.encode()
 145         retry = 1
 146         while retry:
 147             self.write_exact(frame.raw)
 148             # Get the reply from the device
 149             reply = character(self.serial.read())
 150             if reply == sfl_ack_success:
 151                 retry = 0
 152             elif reply == sfl_ack_crcerror:
 153                 retry = 1
 154             else:
 155                 print("[FLTERM] Got unknown reply '{}' from the device, aborting.".format(reply))
 156                 return 0
 157         return 1
 158
 159     def upload(self, filename, address):
 160         data = get_file_data(filename)
 161         print("[FLTERM] Uploading {} ({} bytes)...".format(filename, len(data)))
 162         current_address = address
 163         position = 0
 164         length = len(data)
 165         start = time.time()
 166         while len(data) != 0:
 167             print("{}%\r".format(100*position//length), end="")
 168             frame = SFLFrame()
 169             frame_data = data[:251]
 170             frame.length = len(frame_data) + 4
 171             frame.cmd = sfl_cmd_load
 172             for d in current_address.to_bytes(4, "big"):
 173                 frame.payload.append(d)
 174             for d in frame_data:
 175                 frame.payload.append(d)
 176             if self.send_frame(frame) == 0:
 177                 return
 178             current_address += len(frame_data)
 179             position += len(frame_data)
 180             try:
 181                 data = data[251:]
 182             except:
 183                 data = []
 184         end = time.time()
 185         elapsed = end - start
 186         print("[FLTERM] Upload complete ({0:.1f}KB/s).".format(length/(elapsed*1024)))
 187         return length
 188
 189     def boot(self):
 190         print("[FLTERM] Booting the device.")
 191         frame = SFLFrame()
 192         frame.length = 4
 193         frame.cmd = sfl_cmd_jump
 194         for d in self.kernel_address.to_bytes(4, "big"):
 195             frame.payload.append(d)
 196         self.send_frame(frame)
 197
 198     def detect_magic(self, data):
 199         if data is not "":
 200             self.detect_magic_str = self.detect_magic_str[1:] + data
 201             return self.detect_magic_str == sfl_magic_req
 202         else:
 203             return False
 204
 205     def answer_magic(self):
 206         print("[FLTERM] Received firmware download request from the device.")
 207         if os.path.exists(self.kernel_image):
 208             self.write_exact(sfl_magic_ack)
 209             self.upload(self.kernel_image, self.kernel_address)
 210             self.boot()
 211         print("[FLTERM] Done.");
 212
 213     def reader(self):
 214         try:
 215             while self.reader_alive:
 216                 c = character(self.serial.read())
 217                 if c == '\r':
 218                     sys.stdout.write('\n')
 219                 else:
 220                     sys.stdout.write(c)
 221                 sys.stdout.flush()
 222
 223                 if self.kernel_image is not None:
 224                     if self.detect_magic(c):
 225                         self.answer_magic()
 226
 227         except serial.SerialException:
 228             self.reader_alive = False
 229             raise
 230
 231     def start_reader(self):
 232         self.reader_alive = True
 233         self.reader_thread = threading.Thread(target=self.reader)
 234         self.reader_thread.setDaemon(True)
 235         self.reader_thread.start()
 236
 237     def stop_reader(self):
 238         self.reader_alive = False
 239         self.reader_thread.join()
 240
 241     def writer(self):
 242         try:
 243             while self.writer_alive:
 244                 try:
 245                     b = console.getkey()
 246                 except KeyboardInterrupt:
 247                     b = serial.to_bytes([3])
 248                 c = character(b)
 249                 if c == chr(0x03):
 250                     self.stop()
 251                 elif c == '\n':
 252                     self.serial.write(LF)
 253                 else:
 254                     self.serial.write(b)
 255         except:
 256             self.writer_alive = False
 257             raise
 258
 259     def start_writer(self):
 260         self.writer_alive = True
 261         self.writer_thread = threading.Thread(target=self.writer)
 262         self.writer_thread.setDaemon(True)
 263         self.writer_thread.start()
 264
 265     def stop_writer(self):
 266         self.writer_alive = False
 267         self.writer_thread.join()
 268
 269     def start(self):
 270         print("[FLTERM] Starting....")
 271         self.start_reader()
 272         self.start_writer()
 273
 274     def stop(self):
 275         self.reader_alive = False
 276         self.writer_alive = False
 277
 278     def join(self, writer_only=False):
 279         self.writer_thread.join()
 280         if not writer_only:
 281             self.reader_thread.join()
 282
 283
 284 def _get_args():
 285     parser = argparse.ArgumentParser()
 286     parser.add_argument("port", help="serial port")
 287     parser.add_argument("--speed", default=115200, help="serial baudrate")
 288     parser.add_argument("--kernel", default=None, help="kernel image")
 289     parser.add_argument("--kernel-adr", type=lambda a: int(a, 0), default=0x40000000, help="kernel address")
 290     return parser.parse_args()
 291
 292
 293 def main():
 294     args = _get_args()
 295     flterm = Flterm(args.kernel, args.kernel_adr)
 296     flterm.open(args.port, args.speed)
 297     flterm.start()
 298     try:
 299         flterm.join(True)
 300     except KeyboardInterrupt:
 301         pass
 302     flterm.join()
 303
 304
 305 if __name__ == "__main__":
 306     main()