From 523d1f66453e9b92835ecc661085e4575426e661 Mon Sep 17 00:00:00 2001
From: Fredrik Thulin <fredrik@thulin.net>
Date: Wed, 18 May 2016 21:14:52 +0200
Subject: Add FPGA bitstream upload command to cli-test.

This code needs more error checking etc. but together with the Python
script 'filetransfer', a new bitstream may be loaded into the FPGA
config memory like this:

filetransfer --fpga /path/to/bitstream

The bitstream is identified by 'file' e.g. like this:

alpha_test_top.bit: Xilinx BIT data - from
alpha_test_top.ncd;UserID=0xFFFFFFFF - for 7a200tfbg484 - built
2016/05/12(13:59:24) - data length 0xe0164
---
 projects/cli-test/filetransfer | 126 ++++++++++++++++++++++++++++++++---------
 1 file changed, 98 insertions(+), 28 deletions(-)

(limited to 'projects/cli-test/filetransfer')

diff --git a/projects/cli-test/filetransfer b/projects/cli-test/filetransfer
index 674a7f1..2b74570 100755
--- a/projects/cli-test/filetransfer
+++ b/projects/cli-test/filetransfer
@@ -1,13 +1,74 @@
 #!/usr/bin/python
-
+#
+# Copyright (c) 2016, NORDUnet A/S All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# - Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# - Neither the name of the NORDUnet nor the names of its contributors may
+#   be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+Utility to test file upload (or FPGA bitstream upload.
+"""
 import os
 import sys
 import time
 import struct
 import serial
+import argparse
 
 from binascii import crc32
 
+CHUNK_SIZE = 256
+FPGA_CHUNK_SIZE = 4096
+
+
+def parse_args():
+    """
+    Parse the command line arguments
+    """
+    parser = argparse.ArgumentParser(description = "File uploader",
+                                     add_help = True,
+                                     formatter_class = argparse.ArgumentDefaultsHelpFormatter,
+                                     )
+
+    parser.add_argument('--fpga',
+                        dest='fpga',
+                        action='store_true', default=False,
+                        help='Perform FPGA bitstream upload',
+                        )
+
+    parser.add_argument('--device',
+                        dest='device',
+                        default='/dev/ttyUSB0',
+                        help='Name of management port USB serial device',
+                        )
+
+    # positional argument(s)
+    parser.add_argument('filename')
+
+    return parser.parse_args()
+
 
 def _write(dst, data):
     for i in range(len(data)):
@@ -46,41 +107,45 @@ def _execute(dst, cmd):
     response = _read(dst)
     return response
 
-def send_file(filename, device='/dev/ttyUSB0', initiate=True):
+def send_file(filename, args, dst):
     s = os.stat(filename)
     size = s.st_size
     src = open(filename, 'rb')
-
-    dst = serial.Serial(device, 921600, timeout=0.1)
-
-    if initiate:
+    if args.fpga:
+        # Skip header in FPGA bitstream file
+        size -= 0x64
+        src.read(0x64)
+        chunk_size = FPGA_CHUNK_SIZE
+        response = _execute(dst, 'fpga bitstream upload')
+    else:
+        chunk_size = CHUNK_SIZE
         response = _execute(dst, 'filetransfer')
-        if 'OK' not in response:
-            sys.stderr.write('Device did not accept the filetransfer command (got {!r})\n'.format(response))
-            return False
+    if 'OK' not in response:
+        sys.stderr.write('Device did not accept the upload command (got {!r})\n'.format(response))
+        return False
 
+    crc = 0
+    counter = 0
     # 1. Write size of file (4 bytes)
     _write(dst, struct.pack('<I', size))
     _read(dst)
     # 2. Write file contents while calculating CRC-32
-    crc = 0
-    counter = 0
     while True:
-        data = src.read(4096)
+        data = src.read(chunk_size)
         if not data:
             break
         dst.write(data)
-        print("Wrote {!s} bytes".format(len(data)))
+        print("Wrote {!s} bytes (chunk {!s}/{!s})".format(len(data), counter, int(size / chunk_size)))
         # read ACK (a counter of number of 4k chunks received)
         while True:
-            ack = dst.read(4)
-            if len(ack) == 4:
+            ack_bytes = dst.read(4)
+            if len(ack_bytes) == 4:
                 break
-            print('ERROR: Did not receive an ACK, got {!r}'.format(ack))
-            dst.write('\r')
-        new_counter = struct.unpack('<I', ack)[0]
-        if new_counter != counter + 1:
-            print('ERROR: Did not receive the expected counter as ACK (got {!r}/{!r}, not {!r})'.format(new_counter, ack, counter))
+            print('ERROR: Did not receive an ACK, got {!r}'.format(ack_bytes))
+            dst.write('\r')  # eventually get back to the CLI prompt
+        ack = struct.unpack('<I', ack_bytes)[0]
+        if ack != counter + 1:
+            print('ERROR: Did not receive the expected counter as ACK (got {!r}/{!r}, not {!r})'.format(ack, ack_bytes, counter))
             flush = dst.read(100)
             print('FLUSH data: {!r}'.format(flush))
             return False
@@ -95,16 +160,21 @@ def send_file(filename, device='/dev/ttyUSB0', initiate=True):
     _read(dst)
 
     src.close()
-    dst.close()
     return True
 
 
-if len(sys.argv) != 2:
-    sys.stderr.write('Syntax: {!s} filename\n'.format(sys.argv[0]))
-    sys.exit(1)
-
-if send_file(sys.argv[1]):
-    sys.exit(0)
+def main(args):
+    dst = serial.Serial(args.device, 921600, timeout=2)
+    send_file(args.filename, args, dst)
+    dst.close()
+    return True
 
-sys.exit(1)
+if __name__ == '__main__':
+    try:
+        args = parse_args()
+        if main(args):
+            sys.exit(0)
+        sys.exit(1)
+    except KeyboardInterrupt:
+        pass
 
-- 
cgit v1.2.3