Automate an524 application image update

The python script `Arm/MPS3_AN524/tools/flash.py` updates an
application image onto the Arm MPS3 FPGA Prototyping Board.

The build script `Arm/MPS3_AN524/tools/rebuild.sh` accepts the MCC
serial port to reboot the connected board.

Signed-off-by: Devaraj Ranganna <devaraj.ranganna@linaro.org>

Author: urutva

Arm/MPS3_AN524/readme.md

@@ -21,6 +21,10 @@ image that can be run on the MPS3 FPGA prototyping board or in QEMU.
 
     > * The [Arm MPS3 FPGA Prototyping Board](https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/mps3) (MPS3)
     > * The [AN524 SSE-200 FPGA image for MPS3](https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/download-fpga-images)
+* We've automated the process of [updating application image onto the Arm MPS3
+  FPGA Prototyping Board](#updating-application-image). If you wish to use this
+  , then `pyserial` python module should be installed:
+    > * pip3 install pyserial
 
 ## System Setup
 
@@ -77,6 +81,21 @@ and the `srec_cat` utility, which is commonly part of the `srecord` packace on l
 distributions. Build the sample with the provided `rebuild.sh` tool.
 
 ```bash
-$ cd ARM/MPS3_AN524
+$ cd Arm/MPS3_AN524
 $ tools/rebuild.sh
 ```
+
+## Updating application image
+> This has only been tested on OS X, some modifications might be needed to make
+  `Arm/MPS3_AN524/tools/flash.py` to work in Windows/Linux environments.
+
+The python script `Arm/MPS3_AN524/tools/flash.py` automates steps needed to
+update an application image onto the Arm MPS3 FPGA Prototyping Board. if you
+wish to use this, then add `-f` command line option while invoking `rebuild.sh`.
+If `-f` option is used then FPGA MCC serial port must be provided using `-p`
+option.
+
+```bash
+$ cd Arm/MPS3_AN524
+$ tools/rebuild.sh -f -p /dev/tty.usbserial-14543100
+```

Arm/MPS3_AN524/tools/flash.py

@@ -0,0 +1,55 @@
+# Copyright (c) 2021 Linaro Limited.
+
+import pathlib
+import serial
+import shutil
+import sys
+import time
+
+# Serial baudrate
+SERIAL_BAUDRATE = 115200
+
+# Path to image file
+BIN_FILE = pathlib.Path(__file__).parent.absolute().parent / "build" / "app" / "mps3_524.bin"
+# Path where image file should be copied
+BIN_DEST_PATH = "/Volumes/V2M-MPS3/SOFTWARE"
+
+def initiate_reboot(port):
+    try:
+        serial_port = serial.Serial(port, SERIAL_BAUDRATE, exclusive=False)
+    except serial.SerialException:
+        print("ERROR: Unable to update application image onto FPGA board")
+        print(f"ERROR: Unable to open serial port {port}")
+        sys.exit(1)
+    else:
+        # Send reboot command to mcc terminal
+        # Wring the string `reboot\n` is causing data loss. Therefore send
+        # individual characters and introduce 100ms delay between each
+        # character.
+        serial_port.write(b'r')
+        time.sleep(0.1)
+        serial_port.write(b'e')
+        time.sleep(0.1)
+        serial_port.write(b'b')
+        time.sleep(0.1)
+        serial_port.write(b'o')
+        time.sleep(0.1)
+        serial_port.write(b'o')
+        time.sleep(0.1)
+        serial_port.write(b't')
+        time.sleep(0.1)
+        serial_port.write(b'\n')
+
+def copy_application_image():
+    try:
+        shutil.copy2(BIN_FILE, BIN_DEST_PATH, follow_symlinks=False)
+    except OSError as e:
+        print("ERROR: Unable to update application image onto FPGA board")
+        print(f"ERROR: {e.strerror} : {e.filename}")
+        sys.exit(1)
+
+if __name__ == '__main__':
+    # Copy application image onto USB drive
+    copy_application_image()
+    # Initiate reboot
+    initiate_reboot(sys.argv[1])

Arm/MPS3_AN524/tools/rebuild.sh

@@ -3,6 +3,44 @@
 
 #!/bin/bash
 
+# Check if user wishes to auto update application image onto connected board
+# after successful build.
+HELP_STR="
+Usage: rebuild.sh [-f] [-p=serial port] \n \
+    Build Azure RTOS application image \n \
+    Optional: \n \
+    \t-f : Update generated image onto connected board \n \
+    \t-p=serial port : MCC Serial port name, mandatory with -f option
+"
+
+flash_option=false
+while getopts "hfp:" option; do
+    case ${option} in
+        f )
+            flash_option=true
+            ;;
+        p )
+            if [ "$flash_option" = false ]; then
+                echo "ERROR: -p option can only be used with -f option"
+                exit 1
+            fi
+            serial_port=$OPTARG
+            ;;
+        h )
+            echo $HELP_STR
+            exit 1
+            ;;
+        \? )
+            echo $HELP_STR
+            exit 1
+    esac
+done
+# shift $((OPTIND -1))
+if [ "$flash_option" = true ] && [ "$serial_port" = "" ]; then
+    echo "ERROR: -p option is mandatory when -f option is used"
+    exit 1
+fi
+
 # Use paths relative to this script's location
 SCRIPT=$(realpath "$0")
 SCRIPTDIR=$(dirname "$SCRIPT")
@@ -23,3 +61,8 @@ cmake -B"$BUILDDIR" -GNinja -DCMAKE_BUILD_TYPE=$BUILDTYPE $BASEDIR
 
 # And then do the build
 cmake --build $BUILDDIR
+
+# Check if build succeeded
+if [ $? -eq 0 ] && [ "$flash_option" = true ]; then
+    python3 $SCRIPTDIR/flash.py $serial_port
+fi