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