diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 506eca0380c8bb31c661ffbf6e05b8e7ecf7de44..407b05e687a6634ef7ab0d79dbeaefa04ea3e985 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -14,25 +14,22 @@ build-job: # This job runs in the build stage, which runs first.
- if: $CI_PROJECT_ROOT_NAMESPACE == "beaglev-fire"
variables:
BUILD_OPTIONS_DIRECTORY: "build-options"
+ - if: $CI_PROJECT_ROOT_NAMESPACE != "beaglev-fire"
+ # Use the default variables' values.
script:
- - echo "Cloning the tester and gateware..."
- export
- source ~/Microchip/Microchip-FPGA-Tools-Setup/setup-microchip-tools.sh
- - git clone https://openbeagle.org/beaglev-fire/gateware-builds-tester.git
- - cd gateware-builds-tester
- - git clone $REPO_UNDER_TEST -b $BRANCH_UNDER_TEST
- echo "Building the gateware..."
- - python3 bitstream-builds-tester.py $REPO_UNDER_TEST $BUILD_OPTIONS_DIRECTORY
- - echo "$CI_MERGE_REQUEST_SOURCE_BRANCH_NAME"
- - echo "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"
+ - python3 create-release.py $BUILD_OPTIONS_DIRECTORY
- echo "Compile complete."
artifacts:
when: on_success
paths:
- - gateware-builds-tester/artifacts/
+ - artifacts/bitstreams
+ - artifacts/build_logs
reports:
- junit: gateware-builds-tester/artifacts/tests_report.xml
+ junit: artifacts/tests_report.xml
pages:
image: robertcnelson/beagle-devscripts-ubuntu-23.04-riscv64:latest
@@ -52,12 +49,14 @@ pages:
BUILD_OPTIONS_DIRECTORY: "build-options"
DEBIAN_CHANGELOG_PKG: "bbb.io-gateware"
DEBIAN_SRC: "debian"
+ - if: $CI_PROJECT_ROOT_NAMESPACE != "beaglev-fire"
+ # Use the default variables' values.
script:
- rm -rf ./src/ || true
- mkdir -p ./src/debian/ || true
- rsync -av ./$DEBIAN_SRC/* ./src/debian/
- mkdir -p ./src/gateware-builds-tester || true
- - rsync -av ./gateware-builds-tester/* ./src/gateware-builds-tester/
+ - rsync -av ./artifacts ./src/gateware-builds-tester/
- echo "$DEBIAN_CHANGELOG_PKG (1.$(LANG=C date +%Y%m%d).0-0~lunar) lunar; urgency=low" > ./src/debian/changelog
- echo "" >> ./src/debian/changelog
- echo " * ci build of $CI_PROJECT_URL" >> ./src/debian/changelog
diff --git a/build-bitstream.py b/build-bitstream.py
index be20d126a745512c2808c26895ffccbe3c4fd96d..a0d25ffbfc92e70156f967c206043c4badec9593 100644
--- a/build-bitstream.py
+++ b/build-bitstream.py
@@ -29,39 +29,18 @@
#
-
import argparse
-import io
import os
-import platform
-import shutil
-import zipfile
-
-import git
-import requests
-import yaml
import sys
-import subprocess
-import datetime
-
-from generate_gateware_overlays import generate_gateware_overlays
+import gateware_scripts
+from gateware_scripts.build_gateware import build_gateware
-def check_native_platform():
- if os.path.isfile('/.dockerenv'):
- return ""
- else:
- return " --native"
+global yaml_input_file
# Parse command line arguments and set tool locations
def parse_arguments():
- global libero
- global mss_configurator
- global softconsole_headless
- global programming
- global update
-
global yaml_input_file
# Initialize parser
@@ -83,322 +62,16 @@ def parse_arguments():
yaml_input_file = os.path.abspath(yaml_input_file_arg)
- # Tool call variables - these are the names of the tools to run which will be called from os.system.
- # Full paths could be used here instead of assuming tools are in PATH
- libero = "libero"
- mss_configurator = "pfsoc_mss"
- softconsole_headless = "softconsole-headless"
-
- update = False
- programming = False
-
-
-# Checks to see if all of the required tools are installed and present in path, if a needed tool isn't available the script will exit
-def check_tool_status():
- if shutil.which("libero") is None:
- print("Error: libero not found in path")
- exit()
-
- if shutil.which("pfsoc_mss") is None:
- print("Error: polarfire soc mss configurator not found in path")
- exit()
-
- if os.environ.get('SC_INSTALL_DIR') is None:
- print(
- "Error: SC_INSTALL_DIR environment variable not set, please set this variable and point it to the "
- "appropriate SoftConsole installation directory to run this script")
- exit()
-
- if os.environ.get('FPGENPROG') is None:
- print(
- "Error: FPGENPROG environment variable not set, please set this variable and point it to the appropriate "
- "FPGENPROG executable to run this script")
- exit()
-
- path = os.environ["PATH"]
-
- if "riscv-unknown-elf-gcc" not in path:
- print(
- "The path to the RISC-V toolchain needs to be set in PATH to run this script")
- exit()
-
- if platform.system() == "Linux" or platform.system() == "Linux2":
- if shutil.which("dtc") is None:
- print("Error: dtc (device-tree-compiler) not found in path")
- exit()
-
-
-# Creates required folders and removes artifacts before beginning
-def init_workspace():
- print("================================================================================")
- print(" Initialize workspace")
- print("================================================================================\r\n", flush=True)
-
- # Create the sources folder to clone into if it doesn't exist (any existing source folders are handled in the
- # clone_sources function)
-# if not os.path.exists("./sources"):
-# os.mkdir("./sources")
-
- # Delete the work folder and its content if it exists.
- if os.path.exists("./work"):
- shutil.rmtree('./work')
-
- # Create each output subdirectory
- os.mkdir("./work")
- os.mkdir("./work/MSS")
- os.mkdir("./work/HSS")
-
- # Delete the bitstream folder if it exists to remove previously created bitstreams.
- if os.path.exists("./bitstream"):
- shutil.rmtree('./bitstream')
-
- # Create the bitstream folder structure. This is where the created bitstreams will be generated. There might be
- # multiple subdirectories there to provided different programming options.
- os.mkdir("./bitstream")
- os.mkdir("./bitstream/FlashProExpress")
- os.mkdir("./bitstream/LinuxProgramming")
- print(" The FlashPro Express bitstream programming job files will be stored in")
- print(" directory: ./bitstream/FlashProExpress\r\n", flush=True)
-
-
-# clones the sources specified in the sources.yaml file
-def clone_sources(source_list):
- print("================================================================================")
- print(" Clone sources")
- print("================================================================================\r\n", flush=True)
-
- source_directories = {}
- with open(source_list) as f: # open the yaml file passed as an arg
- data = yaml.load(f, Loader=yaml.FullLoader)
-
- keys = data.keys()
- # each entry in the file is a source
- for source in keys:
-
- # Check if this is a git source
- if "git" in data.get(source).get("type"):
-
- # Check if we've already cloned the repo
- if os.path.exists(os.path.join("./sources", source)):
- repo = git.Repo.init(os.path.join("./sources", source)) # set up repo
- repo.git.checkout(data.get(source).get("branch")) # checkout the branch from the yaml file
- repo.remotes.origin.pull() # pull changes
-
- # We don't already have the repo, clone it
- else:
- repo = git.Repo.clone_from(data.get(source).get("link"), os.path.join("./sources", source),
- branch=data.get(source).get("branch"))
-
- # check if a specific commit from this branch is required
- if "commit" in data.get(source):
- repo.git.checkout(data.get(source).get("commit")) # check out a specific commit
-
- # Check if this is source is a url to a zip
- elif "zip" in data.get(source).get("type"):
-
- # if we already have a source of the same name delete it - can't check versions
- if os.path.exists(os.path.join("./sources", source)):
- shutil.rmtree(os.path.join("./sources", source))
- r = requests.get(data.get(source).get("link")) # download zip
- z = zipfile.ZipFile(io.BytesIO(r.content)) # extract zip
- z.extractall(os.path.join("./sources", source)) # save contents
- source_directories[source] = os.path.join("./sources",
- source) # Generate a dictionary of all of the sources that were cloned
-
- f.close()
-
- # return the dictionary of sources
- return source_directories
-
-
-# Calls the MSS Configurator and generate an MSS configuration in a directory based on a cfg file
-def make_mss_config(mss_configurator, config_file, output_dir):
- print("================================================================================")
- print(" Generating MSS configuration")
- print("================================================================================\r\n", flush=True)
- os.system(mss_configurator + ' -GENERATE -CONFIGURATION_FILE:' + config_file + ' -OUTPUT_DIR:' + output_dir)
-
-
-# Builds the HSS using a pre-defined config file using SoftConsole in headless mode
-def make_hss(hss_source, yaml_input_file):
- print("================================================================================")
- print(" Build Hart Software Services (HSS)")
- print("================================================================================\r\n", flush=True)
-
- # Retrieve build target info from YAML file
- with open(yaml_input_file) as f: # open the yaml file passed as an arg
- data = yaml.load(f, Loader=yaml.FullLoader)
- try:
- target_board = data.get("HSS").get("board")
- except:
- target_board = "bvf"
- f.close()
- print("Target board: " + target_board)
-
- # Update XML in HSS project
- XML_file = "boards/" + target_board + "/soc_fpga_design/xml/PF_SOC_MSS_mss_cfg.xml"
- XML_file_abs_path = os.path.join(hss_source, XML_file)
- try:
- os.remove(XML_file_abs_path)
- except:
- print("HSS target board does not have a default MSS XML configuration - not a problem.", flush=True)
-
- shutil.copyfile("./work/MSS/PF_SOC_MSS_mss_cfg.xml", XML_file_abs_path)
-
- # Select HSS configuration to build
- def_config_file = os.path.join(hss_source, "boards/" + target_board + "/def_config")
- shutil.copyfile(def_config_file, os.path.join(hss_source, "./.config"))
-
- # Call HSS makefile
- initial_directory = os.getcwd()
- os.chdir(hss_source)
- make_command = "make BOARD=" + target_board
- os.system(make_command)
- os.chdir(initial_directory)
-
- # Check build was successful and copy the build artifact to the output directory
- generated_hex_file = "./sources/HSS/Default/bootmode1/hss-envm-wrapper-bm1-p0.hex"
- if os.path.isfile(generated_hex_file):
- shutil.copyfile(generated_hex_file, "./work/HSS/hss-envm-wrapper-bm1-p0.hex")
- else:
- print("!!! Error: Hart Soft Service build failed !!!", flush=True)
- exit()
-
-
-def get_libero_script_args(source_list):
- libero_script_args = "NO_BUILD_ARGUMENT"
- with open(source_list) as f: # open the yaml file passed as an arg
- data = yaml.load(f, Loader=yaml.FullLoader)
-# try:
- libero_script_args = data.get("gateware").get("build-args")
-# except:
-# libero_script_args = "NO_BUILD_ARGUMENT"
- f.close()
-
- if libero_script_args is None:
- libero_script_args = "NONE"
- return libero_script_args
-
-
-#
-# Retrieve/generate the gateware's design version. This version number is stored in the PolarFire SoC device and used
-# as part of programming the PolarFire SoC FPGA using IAP (gateware programming from Linux).
-# Care must be taken to ensure this version number is different between programming attempts. Otherwise, the PolarFire
-# SoC System Controller will not attempt to program the FPGA with the new gateware if it finds the design versions are
-# identical.
-# The approach to managing design version numbers is to use a unique design version number for release gateware. This
-# unique design version number is specified as part of the yaml build option file. The version number is dd.vv.r where
-# dd identifies the design, vv is an incremental features identifier and r is a revision number.
-# For development, the design version number is generated based on the gateware generation date/time. This generated
-# version number loops back every 45 days given the design version number stored in PolarFire SoC is 16 bit long.
-#
-def get_design_version(source_list):
- with open(source_list) as f: # open the yaml file passed as an arg
- data = yaml.load(f, Loader=yaml.FullLoader)
- unique_design_version = data.get("gateware").get("unique-design-version")
- f.close()
-
- if unique_design_version is None:
- now = datetime.datetime.now()
- day_of_year = now.timetuple().tm_yday
- design_version = ((day_of_year %45) * 1440) + (now.hour * 60) + now.minute
- else:
- try:
- udv_sl = unique_design_version.split(".")
- design_version = (int(udv_sl[0]) * 1000) + (int(udv_sl[1]) * 10) + int(udv_sl[2])
- except (ValueError, AttributeError):
- print("Error: Invalid value for unique-design-version in ", source_list )
- print("unique-design-version must be in the form dd.vv.r")
- exit()
-
- # FPGA design version number stored in Polarfire SoC devices is 16 bits long.
- design_version = design_version % 65536
- print("Design version: ", design_version)
- return str(design_version)
-
-
-# The function below assumes the current working directory is the gateware's git repository.
-def get_git_hash():
- try:
- git_hash = subprocess.check_output(['git', 'log', "--pretty=format:'%H'", '-n', '1'])
- except subprocess.CalledProcessError as e:
- git_hash = 0
- return git_hash.decode('ascii').strip("'")
-
-
-# Build the gateware's top level name from the build option directory name and the git hassh of the gateware's
-# repository.
-def get_top_level_name():
- git_hash = get_git_hash()
- top_level_name = str(os.path.splitext(os.path.basename(yaml_input_file))[0])
- top_level_name = top_level_name.replace('-', '_')
- top_level_name = top_level_name + '_' + git_hash
- if len(top_level_name) > 30:
- top_level_name = top_level_name[:30]
- top_level_name = top_level_name.upper()
- return top_level_name
-
-
-# Calls Libero and runs a script
-def call_libero(libero, script, script_args, project_location, hss_image_location, prog_export_path, top_level_name, design_version):
- libero_cmd = libero + " SCRIPT:" + script + " \"SCRIPT_ARGS: " + script_args + " PROJECT_LOCATION:" + project_location + " TOP_LEVEL_NAME:" + top_level_name + " HSS_IMAGE_PATH:" + hss_image_location + " PROG_EXPORT_PATH:" + prog_export_path + " DESIGN_VERSION:" + design_version + "\""
- print("Libero command: " + libero_cmd, flush=True)
- os.system(libero_cmd)
-
-
-def generate_libero_project(libero, yaml_input_file):
- print("================================================================================")
- print(" Generate Libero project")
- print("================================================================================\r\n", flush=True)
- # Execute the Libero TCL script used to create the Libero design
- initial_directory = os.getcwd()
- os.chdir("./sources/FPGA-design")
- project_location = os.path.join("..", "..", "work", "libero")
- script = os.path.join("..", "..", "sources", "FPGA-design", "BUILD_BVF_GATEWARE.tcl")
-
- script_args = get_libero_script_args(yaml_input_file)
- design_version = get_design_version(yaml_input_file)
-
- hss_image_location = os.path.join("..", "..", "work", "HSS", "hss-envm-wrapper-bm1-p0.hex")
- prog_export_path = os.path.join("..", "..")
-
- top_level_name = get_top_level_name()
- print("top level name: ", top_level_name)
-
- call_libero(libero, script, script_args, project_location, hss_image_location, prog_export_path, top_level_name, design_version)
- os.chdir(initial_directory)
-
def main():
- global libero
- global mss_configurator
- global softconsole_headless
- global programming
+ global yaml_input_file
parse_arguments()
- # This function will check if all of the required tools are present and quit if they aren't
- check_tool_status()
-
- sources = {}
-
- # Bitstream building starts here - see individual functions for a description of their purpose
- init_workspace()
-
- sources = clone_sources(yaml_input_file)
-
- build_options_list = get_libero_script_args(yaml_input_file)
- generate_gateware_overlays(os.path.join(os.getcwd(), "bitstream", "LinuxProgramming"), build_options_list)
-
- mss_config_file_path = os.path.join(".", "sources", "MSS_Configuration", "MSS_Configuration.cfg")
- work_mss_dir = os.path.join("work", "MSS")
- make_mss_config(mss_configurator, mss_config_file_path, os.path.join(os.getcwd(), work_mss_dir))
-
- make_hss(sources["HSS"], yaml_input_file)
-
- generate_libero_project(libero, yaml_input_file)
+ build_dir = os.getcwd()
+ gateware_top_dir = build_dir
- print("Finished", flush=True)
+ build_gateware(yaml_input_file, build_dir, gateware_top_dir)
if __name__ == '__main__':
diff --git a/create-release.py b/create-release.py
new file mode 100644
index 0000000000000000000000000000000000000000..ef88743a03b4b4326e4b87ea083a4ffe745460c4
--- /dev/null
+++ b/create-release.py
@@ -0,0 +1,59 @@
+# The BeagleV Fire Bitstream Builder is released under the following software license:
+
+# Copyright 2021 Microchip Corporation.
+# SPDX-License-Identifier: MIT
+
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+
+# The BeagleV Fire Bitstream Builder is an evolution of the Microchip
+# Bitstream Builder available from:
+# https://github.com/polarfire-soc/icicle-kit-minimal-bring-up-design-bitstream-builder
+#
+
+
+import argparse
+
+from gateware_scripts.create_release import create_release
+
+
+def parse_arguments():
+ # Initialize parser
+ parser = argparse.ArgumentParser()
+
+ parser.add_argument('BuildOptionsDir',
+ type=str,
+ help="Directory containing the gateware build options to build.",
+ action="store",
+ default="build-options",
+ nargs='?')
+
+ # Read argument(s) from command line
+ args = parser.parse_args()
+ return args.BuildOptionsDir
+
+
+def main():
+ build_options_dir_name = parse_arguments()
+ create_release(build_options_dir_name)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/gateware_scripts/Logger.py b/gateware_scripts/Logger.py
new file mode 100644
index 0000000000000000000000000000000000000000..13b1dd6fba58dcbd510fb7230fae9c59152f81c3
--- /dev/null
+++ b/gateware_scripts/Logger.py
@@ -0,0 +1,20 @@
+import sys
+
+
+class Logger(object):
+ def __init__(self, log_file_path):
+ self.terminal = sys.stdout
+ self.log = open(log_file_path, "a")
+
+ def write(self, message):
+ self.terminal.write(message)
+ self.log.write(message)
+
+ def flush(self):
+ # this flush method is needed for python 3 compatibility.
+ # this handles the flush command by doing nothing.
+ # you might want to specify some extra behavior here.
+ self.terminal.flush()
+ self.log.flush()
+ pass
+
diff --git a/gateware_scripts/__init__.py b/gateware_scripts/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/gateware_scripts/build_gateware.py b/gateware_scripts/build_gateware.py
new file mode 100644
index 0000000000000000000000000000000000000000..08d6191193fd6870fc68bca343a61e1629d551b5
--- /dev/null
+++ b/gateware_scripts/build_gateware.py
@@ -0,0 +1,492 @@
+# The BeagleV Fire Bitstream Builder is released under the following software license:
+
+# Copyright 2021 Microchip Corporation.
+# SPDX-License-Identifier: MIT
+
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+
+# The BeagleV Fire Bitstream Builder is an evolution of the Microchip
+# Bitstream Builder available from:
+# https://github.com/polarfire-soc/icicle-kit-minimal-bring-up-design-bitstream-builder
+#
+
+
+
+import argparse
+import io
+import os
+import platform
+import shutil
+import zipfile
+
+import git
+import requests
+import yaml
+import sys
+import subprocess
+import datetime
+
+from gateware_scripts.generate_gateware_overlays import generate_gateware_overlays
+from gateware_scripts.Logger import Logger
+
+
+def exe_sys_cmd(cmd):
+ proc = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+ for line in proc.stdout:
+ ascii_line = line.decode('ascii')
+ sys.stdout.write(ascii_line)
+ proc.wait()
+
+
+def check_native_platform():
+ if os.path.isfile('/.dockerenv'):
+ return ""
+ else:
+ return " --native"
+
+
+def set_arguments(yaml_input_file_path):
+ global libero
+ global mss_configurator
+ global softconsole_headless
+ global programming
+ global update
+
+ global yaml_input_file
+
+ # Initialize parser
+# parser = argparse.ArgumentParser()
+
+# parser.add_argument('Path',
+# metavar='path',
+# type=str,
+# help='Path to the YAML file describing the list of sources used to build the bitstream.')
+
+ # Read arguments from command line
+# args = parser.parse_args()
+# yaml_input_file_arg = args.Path
+
+ if not os.path.isfile(yaml_input_file_path):
+ print("\r\n!!! The path specified for the YAML input file does not exist !!!\r\n")
+# parser.print_help()
+ sys.exit()
+
+ yaml_input_file = os.path.abspath(yaml_input_file_path)
+
+ # Tool call variables - these are the names of the tools to run which will be called from os.system.
+ # Full paths could be used here instead of assuming tools are in PATH
+ libero = "libero"
+ mss_configurator = "pfsoc_mss"
+ softconsole_headless = "softconsole-headless"
+
+ update = False
+ programming = False
+
+
+# Parse command line arguments and set tool locations
+def parse_arguments():
+ global libero
+ global mss_configurator
+ global softconsole_headless
+ global programming
+ global update
+
+ global yaml_input_file
+
+ # Initialize parser
+ parser = argparse.ArgumentParser()
+
+ parser.add_argument('Path',
+ metavar='path',
+ type=str,
+ help='Path to the YAML file describing the list of sources used to build the bitstream.')
+
+ # Read arguments from command line
+ args = parser.parse_args()
+ yaml_input_file_arg = args.Path
+
+ if not os.path.isfile(yaml_input_file_arg):
+ print("\r\n!!! The path specified for the YAML input file does not exist !!!\r\n")
+ parser.print_help()
+ sys.exit()
+
+ yaml_input_file = os.path.abspath(yaml_input_file_arg)
+
+ # Tool call variables - these are the names of the tools to run which will be called from os.system.
+ # Full paths could be used here instead of assuming tools are in PATH
+ libero = "libero"
+ mss_configurator = "pfsoc_mss"
+ softconsole_headless = "softconsole-headless"
+
+ update = False
+ programming = False
+
+
+# Checks to see if all of the required tools are installed and present in path, if a needed tool isn't available the script will exit
+def check_tool_status():
+ if shutil.which("libero") is None:
+ print("Error: libero not found in path")
+ exit()
+
+ if shutil.which("pfsoc_mss") is None:
+ print("Error: polarfire soc mss configurator not found in path")
+ exit()
+
+ if os.environ.get('SC_INSTALL_DIR') is None:
+ print(
+ "Error: SC_INSTALL_DIR environment variable not set, please set this variable and point it to the "
+ "appropriate SoftConsole installation directory to run this script")
+ exit()
+
+ if os.environ.get('FPGENPROG') is None:
+ print(
+ "Error: FPGENPROG environment variable not set, please set this variable and point it to the appropriate "
+ "FPGENPROG executable to run this script")
+ exit()
+
+ path = os.environ["PATH"]
+
+ if "riscv-unknown-elf-gcc" not in path:
+ print(
+ "The path to the RISC-V toolchain needs to be set in PATH to run this script")
+ exit()
+
+ if platform.system() == "Linux" or platform.system() == "Linux2":
+ if shutil.which("dtc") is None:
+ print("Error: dtc (device-tree-compiler) not found in path")
+ exit()
+
+
+# Creates required folders and removes artifacts before beginning
+def init_workspace():
+ print("================================================================================")
+ print(" Initialize workspace")
+ print("================================================================================\r\n", flush=True)
+
+ # Create the sources folder to clone into if it doesn't exist (any existing source folders are handled in the
+ # clone_sources function)
+# if not os.path.exists("./sources"):
+# os.mkdir("./sources")
+
+ # Delete the work folder and its content if it exists.
+ if os.path.exists("./work"):
+ shutil.rmtree('./work')
+
+ # Create each output subdirectory
+ os.mkdir("./work")
+ os.mkdir("./work/MSS")
+ os.mkdir("./work/HSS")
+
+ # Delete the bitstream folder if it exists to remove previously created bitstreams.
+ if os.path.exists("./bitstream"):
+ shutil.rmtree('./bitstream')
+
+ # Create the bitstream folder structure. This is where the created bitstreams will be generated. There might be
+ # multiple subdirectories there to provided different programming options.
+ os.mkdir("./bitstream")
+ os.mkdir("./bitstream/FlashProExpress")
+ os.mkdir("./bitstream/LinuxProgramming")
+ print(" The FlashPro Express bitstream programming job files will be stored in")
+ print(" directory: ./bitstream/FlashProExpress\r\n", flush=True)
+
+
+# clones the sources specified in the sources.yaml file
+def clone_sources(source_list):
+ print("================================================================================")
+ print(" Clone sources")
+ print("================================================================================\r\n", flush=True)
+
+ source_directories = {}
+ with open(source_list) as f: # open the yaml file passed as an arg
+ data = yaml.load(f, Loader=yaml.FullLoader)
+
+ keys = data.keys()
+ # each entry in the file is a source
+ for source in keys:
+
+ # Check if this is a git source
+ if "git" in data.get(source).get("type"):
+
+ # Check if we've already cloned the repo
+ if os.path.exists(os.path.join("./sources", source)):
+ repo = git.Repo.init(os.path.join("./sources", source)) # set up repo
+ repo.git.checkout(data.get(source).get("branch")) # checkout the branch from the yaml file
+ repo.remotes.origin.pull() # pull changes
+
+ # We don't already have the repo, clone it
+ else:
+ repo = git.Repo.clone_from(data.get(source).get("link"), os.path.join("./sources", source),
+ branch=data.get(source).get("branch"))
+
+ # check if a specific commit from this branch is required
+ if "commit" in data.get(source):
+ repo.git.checkout(data.get(source).get("commit")) # check out a specific commit
+
+ # Check if this is source is a url to a zip
+ elif "zip" in data.get(source).get("type"):
+
+ # if we already have a source of the same name delete it - can't check versions
+ if os.path.exists(os.path.join("./sources", source)):
+ shutil.rmtree(os.path.join("./sources", source))
+ r = requests.get(data.get(source).get("link")) # download zip
+ z = zipfile.ZipFile(io.BytesIO(r.content)) # extract zip
+ z.extractall(os.path.join("./sources", source)) # save contents
+ source_directories[source] = os.path.join("./sources",
+ source) # Generate a dictionary of all of the sources that were cloned
+
+ f.close()
+
+ # return the dictionary of sources
+ return source_directories
+
+
+# Calls the MSS Configurator and generate an MSS configuration in a directory based on a cfg file
+def make_mss_config(mss_configurator, config_file, output_dir):
+ print("================================================================================")
+ print(" Generating MSS configuration")
+ print("================================================================================\r\n", flush=True)
+ cmd = mss_configurator + ' -GENERATE -CONFIGURATION_FILE:' + config_file + ' -OUTPUT_DIR:' + output_dir
+ exe_sys_cmd(cmd)
+
+
+# Builds the HSS using a pre-defined config file using SoftConsole in headless mode
+def make_hss(hss_source, yaml_input_file):
+ print("================================================================================")
+ print(" Build Hart Software Services (HSS)")
+ print("================================================================================\r\n", flush=True)
+
+ cwd = os.getcwd()
+ print("debug: cwd : ", cwd)
+
+ # Retrieve build target info from YAML file
+ with open(yaml_input_file) as f: # open the yaml file passed as an arg
+ data = yaml.load(f, Loader=yaml.FullLoader)
+ try:
+ target_board = data.get("HSS").get("board")
+ except:
+ target_board = "bvf"
+ f.close()
+ print("Target board: " + target_board)
+
+ # Update XML in HSS project
+ XML_file = "boards/" + target_board + "/soc_fpga_design/xml/PF_SOC_MSS_mss_cfg.xml"
+ XML_file_abs_path = os.path.join(hss_source, XML_file)
+ try:
+ os.remove(XML_file_abs_path)
+ except:
+ print("HSS target board does not have a default MSS XML configuration - not a problem.", flush=True)
+
+ shutil.copyfile("./work/MSS/PF_SOC_MSS_mss_cfg.xml", XML_file_abs_path)
+
+ # Select HSS configuration to build
+ def_config_file = os.path.join(hss_source, "boards/" + target_board + "/def_config")
+ shutil.copyfile(def_config_file, os.path.join(hss_source, "./.config"))
+
+ # Call HSS makefile
+ initial_directory = os.getcwd()
+ os.chdir(hss_source)
+ make_command = "make BOARD=" + target_board
+ exe_sys_cmd(make_command)
+ os.chdir(initial_directory)
+
+ # Check build was successful and copy the build artifact to the output directory
+ generated_hex_file = "./sources/HSS/Default/bootmode1/hss-envm-wrapper-bm1-p0.hex"
+ if os.path.isfile(generated_hex_file):
+ shutil.copyfile(generated_hex_file, "./work/HSS/hss-envm-wrapper-bm1-p0.hex")
+ else:
+ print("!!! Error: Hart Soft Service build failed !!!", flush=True)
+ exit()
+
+
+def get_libero_script_args(source_list):
+ libero_script_args = "NO_BUILD_ARGUMENT"
+ with open(source_list) as f: # open the yaml file passed as an arg
+ data = yaml.load(f, Loader=yaml.FullLoader)
+ libero_script_args = data.get("gateware").get("build-args")
+ f.close()
+
+ if libero_script_args is None:
+ libero_script_args = "NONE"
+ return libero_script_args
+
+
+#
+# Retrieve/generate the gateware's design version. This version number is stored in the PolarFire SoC device and used
+# as part of programming the PolarFire SoC FPGA using IAP (gateware programming from Linux).
+# Care must be taken to ensure this version number is different between programming attempts. Otherwise, the PolarFire
+# SoC System Controller will not attempt to program the FPGA with the new gateware if it finds the design versions are
+# identical.
+# The approach to managing design version numbers is to use a unique design version number for release gateware. This
+# unique design version number is specified as part of the yaml build option file. The version number is dd.vv.r where
+# dd identifies the design, vv is an incremental features identifier and r is a revision number.
+# For development, the design version number is generated based on the gateware generation date/time. This generated
+# version number loops back every 45 days given the design version number stored in PolarFire SoC is 16 bit long.
+#
+def get_design_version(source_list):
+ with open(source_list) as f: # open the yaml file passed as an arg
+ data = yaml.load(f, Loader=yaml.FullLoader)
+ unique_design_version = data.get("gateware").get("unique-design-version")
+ f.close()
+
+ if unique_design_version is None:
+ now = datetime.datetime.now()
+ day_of_year = now.timetuple().tm_yday
+ design_version = ((day_of_year %45) * 1440) + (now.hour * 60) + now.minute
+ else:
+ try:
+ udv_sl = unique_design_version.split(".")
+ design_version = (int(udv_sl[0]) * 1000) + (int(udv_sl[1]) * 10) + int(udv_sl[2])
+ except (ValueError, AttributeError):
+ print("Error: Invalid value for unique-design-version in ", source_list )
+ print("unique-design-version must be in the form dd.vv.r")
+ exit()
+
+ # FPGA design version number stored in Polarfire SoC devices is 16 bits long.
+ design_version = design_version % 65536
+ print("Design version: ", design_version)
+ return str(design_version)
+
+
+# The function below assumes the current working directory is the gateware's git repository.
+def get_git_hash():
+ try:
+ git_hash = subprocess.check_output(['git', 'log', "--pretty=format:'%H'", '-n', '1'])
+ except subprocess.CalledProcessError as e:
+ git_hash = 0
+ return git_hash.decode('ascii').strip("'")
+
+
+# Build the gateware's top level name from the build option directory name and the git hassh of the gateware's
+# repository.
+def get_top_level_name():
+ git_hash = get_git_hash()
+ top_level_name = str(os.path.splitext(os.path.basename(yaml_input_file))[0])
+ top_level_name = top_level_name.replace('-', '_')
+ top_level_name = top_level_name + '_' + git_hash
+ if len(top_level_name) > 30:
+ top_level_name = top_level_name[:30]
+ top_level_name = top_level_name.upper()
+ return top_level_name
+
+
+# Calls Libero and runs a script
+def call_libero(libero, script, script_args, project_location, hss_image_location, prog_export_path, top_level_name, design_version):
+ libero_cmd = libero + " SCRIPT:" + script + " \"SCRIPT_ARGS: " + script_args + " PROJECT_LOCATION:" + project_location + " TOP_LEVEL_NAME:" + top_level_name + " HSS_IMAGE_PATH:" + hss_image_location + " PROG_EXPORT_PATH:" + prog_export_path + " DESIGN_VERSION:" + design_version + "\""
+ exe_sys_cmd(libero_cmd)
+
+
+def generate_libero_project(libero, yaml_input_file, fpga_design_sources_path, build_dir_path):
+ print("================================================================================")
+ print(" Generate Libero project")
+ print("================================================================================\r\n", flush=True)
+ # Execute the Libero TCL script used to create the Libero design
+ initial_directory = os.getcwd()
+ os.chdir(fpga_design_sources_path)
+ project_location = os.path.join(build_dir_path, "work", "libero")
+ script = os.path.join(fpga_design_sources_path, "BUILD_BVF_GATEWARE.tcl")
+
+ script_args = get_libero_script_args(yaml_input_file)
+ design_version = get_design_version(yaml_input_file)
+
+ hss_image_location = os.path.join(build_dir_path, "work", "HSS", "hss-envm-wrapper-bm1-p0.hex")
+ prog_export_path = build_dir_path
+
+ top_level_name = get_top_level_name()
+ print("top level name: ", top_level_name)
+
+ call_libero(libero, script, script_args, project_location, hss_image_location, prog_export_path, top_level_name, design_version)
+ os.chdir(initial_directory)
+
+
+def build_gateware(yaml_input_file_path, build_dir, gateware_top_dir):
+ global libero
+ global mss_configurator
+ global softconsole_headless
+ global programming
+
+ log_file_path = os.path.join(build_dir, "build_log.txt")
+ original_stdout = sys.stdout
+ sys.stdout = Logger(log_file_path)
+
+ set_arguments(yaml_input_file_path)
+
+ # This function will check if all of the required tools are present and quit if they aren't
+ check_tool_status()
+
+ sources = {}
+
+ # Bitstream building starts here - see individual functions for a description of their purpose
+ init_workspace()
+
+ sources = clone_sources(yaml_input_file)
+
+ build_options_list = get_libero_script_args(yaml_input_file)
+ generate_gateware_overlays(os.path.join(os.getcwd(), "bitstream", "LinuxProgramming"), build_options_list)
+
+ mss_config_file_path = os.path.join(gateware_top_dir, "sources", "MSS_Configuration", "MSS_Configuration.cfg")
+ work_mss_dir = os.path.join("work", "MSS")
+ make_mss_config(mss_configurator, mss_config_file_path, os.path.join(os.getcwd(), work_mss_dir))
+
+ make_hss(sources["HSS"], yaml_input_file)
+
+ fpga_design_sources_path = os.path.join(gateware_top_dir, "sources", "FPGA-design")
+ generate_libero_project(libero, yaml_input_file, fpga_design_sources_path, build_dir)
+
+ sys.stdout.flush()
+ sys.stdout = original_stdout
+
+ print("Finished", flush=True)
+
+
+def main():
+ global libero
+ global mss_configurator
+ global softconsole_headless
+ global programming
+
+ parse_arguments()
+
+ # This function will check if all of the required tools are present and quit if they aren't
+ check_tool_status()
+
+ sources = {}
+
+ # Bitstream building starts here - see individual functions for a description of their purpose
+ init_workspace()
+
+ sources = clone_sources(yaml_input_file)
+
+ build_options_list = get_libero_script_args(yaml_input_file)
+ generate_gateware_overlays(os.path.join(os.getcwd(), "bitstream", "LinuxProgramming"), build_options_list)
+
+ mss_config_file_path = os.path.join(".", "sources", "MSS_Configuration", "MSS_Configuration.cfg")
+ work_mss_dir = os.path.join("work", "MSS")
+ make_mss_config(mss_configurator, mss_config_file_path, os.path.join(os.getcwd(), work_mss_dir))
+
+ make_hss(sources["HSS"], yaml_input_file)
+
+ generate_libero_project(libero, yaml_input_file)
+
+ print("Finished", flush=True)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/gateware_scripts/create_release.py b/gateware_scripts/create_release.py
new file mode 100644
index 0000000000000000000000000000000000000000..daa721bb172bba6a54ff57522eebebb68576467d
--- /dev/null
+++ b/gateware_scripts/create_release.py
@@ -0,0 +1,184 @@
+# SPDX-License-Identifier: MIT
+import argparse
+import os
+import subprocess
+import shutil
+from junit_xml import TestSuite, TestCase
+import yaml
+
+from gateware_scripts.build_gateware import build_gateware
+
+
+def get_build_option_file_list(build_options_dir_name):
+ build_options_path = os.path.join(os. getcwd(), build_options_dir_name)
+ build_option_files = []
+ for file in os.listdir(build_options_path):
+ if file.endswith('.yaml'):
+ build_option_files.append(os.path.join(build_options_dir_name, file))
+ return build_option_files
+
+
+def build_bitstreams(build_option_files):
+ tester_top_dir = os.getcwd()
+ build_dir = "builds"
+ if not os.path.exists(build_dir):
+ os.makedirs(build_dir)
+ os.chdir(build_dir)
+
+ for build_option in build_option_files:
+ option_build_dir_name = os.path.splitext(os.path.basename(build_option))[0]
+ print("Build bistream configuration: ", option_build_dir_name)
+ cwd = os.getcwd()
+ dst_dir = os.path.join(cwd, option_build_dir_name)
+
+ if not os.path.exists(dst_dir):
+ os.makedirs(dst_dir)
+ os.chdir(dst_dir)
+
+ build_option_path = os.path.join(tester_top_dir, build_option)
+
+ build_gateware(build_option_path, dst_dir, tester_top_dir)
+ os.chdir('..')
+
+ os.chdir('..')
+
+
+def make_chdir(dir_name):
+ if not os.path.exists(dir_name):
+ os.makedirs(dir_name)
+ os.chdir(dir_name)
+ return os.getcwd()
+
+
+def gather_artifacts(build_option_files):
+ root_build_dir = os.path.join(os.getcwd(), "builds")
+ root_artifacts_dir = make_chdir("artifacts")
+
+ root_build_logs_dir = make_chdir("build_logs")
+ os.chdir('..')
+
+ root_bitstreams_dir = make_chdir("bitstreams")
+ os.chdir('..')
+
+ for build_option in build_option_files:
+ option_build_dir_name = os.path.splitext(os.path.basename(build_option))[0]
+ os.chdir(root_build_logs_dir)
+ cwd = make_chdir(option_build_dir_name)
+
+ # Build log:
+ src = os.path.join(root_build_dir, option_build_dir_name, "build_log.txt")
+ dst = os.path.join(cwd, "build_log.txt")
+ shutil.copy(src, dst)
+
+ # Synthesis logs:
+ src = os.path.join(root_build_dir, option_build_dir_name, "work", "libero", "synthesis")
+ dst = os.path.join(cwd, "synthesis")
+ if os.path.exists(src):
+ shutil.copytree(src, dst)
+
+ # Bitstreams:
+ os.chdir(root_bitstreams_dir)
+ cwd = make_chdir(option_build_dir_name)
+ src = os.path.join(root_build_dir, option_build_dir_name, "bitstream")
+ shutil.copytree(src, cwd, dirs_exist_ok=True)
+
+ os.chdir('..')
+
+ os.chdir('../..')
+
+
+def get_hss_build_testcase(build_name, log):
+ testcase = TestCase('HSS build', build_name, 123.345, '', '')
+ if log.find('INFO: Successfully generated MSS component') == -1:
+ testcase.add_error_info('MSS component not created.')
+ if log.find('INFO - mpfsBootmodeProgrammer completed successfully.') == -1:
+ testcase.add_error_info('HSS executable not created.')
+ return testcase
+
+
+def get_synthesis_test_case(build_name, log):
+ testcase = TestCase('Synthesis', build_name, 123.345, '', '')
+ if log.find('Synthesis completed.') == -1:
+ testcase.add_error_info('Synthesis failed.')
+ return testcase
+
+
+def get_place_route_test_case(build_name, log):
+ testcase = TestCase('Place and route', build_name, 123.345, '', '')
+ if log.find('Router completed successfully.') == -1:
+ testcase.add_error_info('Place and route failed.')
+ return testcase
+
+
+def get_timing_analysis_test_case(build_name, log):
+ testcase = TestCase('Timing analysis', build_name, 123.345, '', '')
+ testcase.add_skipped_info('Timing analysis not enabled')
+ return testcase
+
+
+def get_bitstream_test_case(build_name, log):
+ testcase = TestCase('Bitstream generation', build_name, 123.345, '', '')
+ if log.find('Successfully generated bitstream file') == -1:
+ testcase.add_error_info('Bitstream generation failed.')
+ return testcase
+
+
+def create_report(build_option_files):
+ os.chdir("artifacts")
+ os.chdir("build_logs")
+ tss = []
+ for build_option in build_option_files:
+ build_name = os.path.splitext(os.path.basename(build_option))[0]
+ with open(os.path.join(build_name, "build_log.txt"), 'rt') as f:
+ log = f.read()
+ test_cases = [get_hss_build_testcase(build_name, log), get_synthesis_test_case(build_name, log),
+ get_place_route_test_case(build_name, log), get_timing_analysis_test_case(build_name, log),
+ get_bitstream_test_case(build_name, log)]
+
+ ts = TestSuite(build_name, test_cases)
+ tss.append(ts)
+
+ os.chdir('..')
+ with open("tests_report.xml", "w") as f:
+ TestSuite.to_file(f, tss, prettyprint=True)
+ f.close()
+ os.chdir('..')
+
+
+def zip_artifacts():
+ dir_name = os.path.join(os.getcwd(), "artifacts")
+ shutil.make_archive("artifacts", 'zip', dir_name)
+
+
+def parse_arguments():
+ # Initialize parser
+ parser = argparse.ArgumentParser()
+
+ parser.add_argument('BuildOptionsDir',
+ type=str,
+ help="Directory containing the gateware build options to build.",
+ action="store",
+ default="build-options",
+ nargs='?')
+
+ # Read argument(s) from command line
+ args = parser.parse_args()
+ return args.BuildOptionsDir
+
+
+def create_release(build_options_dir_name):
+ print("Test gateware builds.")
+ build_option_files = get_build_option_file_list(build_options_dir_name)
+ print("Build bitstreams.")
+ build_bitstreams(build_option_files)
+ print("Gather up artifacts.")
+ gather_artifacts(build_option_files)
+ print("Create build test report.")
+ create_report(build_option_files)
+ zip_artifacts()
+ print("Gateware tests Complete")
+
+
+if __name__ == '__main__':
+ build_options_dir_name = parse_arguments()
+ create_release(build_options_dir_name)
diff --git a/gather_dtso.py b/gateware_scripts/gather_dtso.py
similarity index 100%
rename from gather_dtso.py
rename to gateware_scripts/gather_dtso.py
diff --git a/generate_gateware_overlays.py b/gateware_scripts/generate_gateware_overlays.py
similarity index 98%
rename from generate_gateware_overlays.py
rename to gateware_scripts/generate_gateware_overlays.py
index 7cd0f6afe4304ba8f21a874e55622a8f641470c2..415d79916e0f85aaa254caa0767577c50007ce6b 100644
--- a/generate_gateware_overlays.py
+++ b/gateware_scripts/generate_gateware_overlays.py
@@ -4,7 +4,7 @@ import ctypes
import sys
import subprocess
-from gather_dtso import gather_dtso
+from gateware_scripts.gather_dtso import gather_dtso
global dtbo_info