scripts: template_setup_posix: Add web-based toolchain installation

This commit adds the feature to download and install individual
toolchains from the web release assets if not all toolchains are
locally installed (e.g. minimal web install distribution archive).

Signed-off-by: Stephanos Ioannidis <[email protected]>

Author: stephanosio

scripts/template_setup_posix

@@ -19,27 +19,65 @@ ask_yn()
   local reply
 
   while true; do
-    read -n 1 -r -p "$1 [y/n]? " reply && echo
+    read -r -p "$1 [y/n]? " reply
 
     case "${reply}" in
-      Y | y)  return 0 ;;
-      N | n)  return 1 ;;
-      *)      echo "Invalid choice '${reply}'" ;;
+      Y* | y*)  return 0 ;;
+      N* | n*)  return 1 ;;
+      *)        echo "Invalid choice '${reply}'" ;;
     esac
   done
 }
 
+assert_rc()
+{
+  if [[ $? != 0 ]]; then
+    echo "$1" 1>&2
+    exit $2
+  fi
+}
+
+# Check if command is available
+check_command()
+{
+  which $1 &> /dev/null
+  if [ $? != 0 ]; then
+    echo "Zephyr SDK setup requires '$1' to be installed and available in the PATH."
+    echo "Please install '$1 and run this script again."
+    exit $2
+  fi
+}
+
+# Check if the current installation is a full SDK with all toolchains
+check_full_sdk()
+{
+  for toolchain in ${toolchains[@]}; do
+    if [ ! -d "${toolchain}" ]; then
+      return 1
+    fi
+  done
+
+  return 0
+}
+
 # Display script usage
 usage()
 {
-  echo "Usage: $(basename $0) [-c] [-t]"
+  echo "Usage: $(basename $0) [-t <toolchain>] [-h] [-c]"
+  echo
+  echo "  -t <toolchain>   Install specified toolchain"
+  echo "     all           Install all toolchains"
+  echo "  -h               Install host tools"
+  echo "  -c               Register Zephyr SDK CMake package"
   echo
-  echo "  -c     Register Zephyr SDK CMake package"
-  echo "  -t     Install host tools"
+  echo "Supported Toolchains:"
+  echo
+  for toolchain in ${toolchains[@]}; do
+    echo "  ${toolchain}"
+  done
   echo
   echo "If no arguments are specified, the setup script runs in the interactive"
   echo "mode asking for user inputs."
-  exit 1
 }
 
 # Ask for user inputs (interactive mode)
@@ -50,29 +88,90 @@ user_prompt()
   echo "distribution bundle archive."
   echo
 
-  ask_yn "Register Zephyr SDK CMake package" && do_cmake_pkg="y"
+  # Toolchains
+  check_full_sdk
+  if [ $? != 0 ]; then
+    ask_yn "Install toolchains for all targets"
+    if [ $? == 0 ]; then
+      inst_toolchains=(${toolchains[*]})
+    else
+      for toolchain in ${toolchains[@]}; do
+        if [ ! -d "${toolchain}" ]; then
+          ask_yn "Install '${toolchain}' toolchain" && inst_toolchains+=("${toolchain}")
+        fi
+      done
+    fi
+  fi
+
+  # Host Tools
   ask_yn "Install host tools" && do_hosttools="y"
 
+  # Environment Configurations
+  ask_yn "Register Zephyr SDK CMake package" && do_cmake_pkg="y"
+
   echo
 }
 
 # Entry point
 pushd "$(dirname "${BASH_SOURCE[0]}")"
 
+# Initialise toolchain list
+toolchains=(
+  "aarch64-zephyr-elf"
+  "arc64-zephyr-elf"
+  "arc-zephyr-elf"
+  "arm-zephyr-eabi"
+  "mips-zephyr-elf"
+  "nios2-zephyr-elf"
+  "riscv64-zephyr-elf"
+  "sparc-zephyr-elf"
+  "x86_64-zephyr-elf"
+  "xtensa-espressif_esp32_zephyr-elf"
+  "xtensa-espressif_esp32s2_zephyr-elf"
+  "xtensa-intel_apl_adsp_zephyr-elf"
+  "xtensa-intel_bdw_adsp_zephyr-elf"
+  "xtensa-intel_byt_adsp_zephyr-elf"
+  "xtensa-intel_s1000_zephyr-elf"
+  "xtensa-nxp_imx_adsp_zephyr-elf"
+  "xtensa-nxp_imx8m_adsp_zephyr-elf"
+  "xtensa-sample_controller_zephyr-elf"
+  )
+
+# Initialise list of toolchains to install
+inst_toolchains=()
+
 # Parse arguments
 if [ $# == "0" ]; then
   interactive="y"
 else
   while [ "$1" != "" ]; do
     case $1 in
+      -t)
+        shift
+        if [[ "$1" = "all" ]]; then
+          inst_toolchains=(${toolchains[*]})
+        else
+          if [[ " ${toolchains[*]} " =~ " $1 " ]]; then
+            inst_toolchains+=("$1")
+          else
+            echo "ERROR: Unknown toolchain '$1'"
+            exit 2
+          fi
+        fi
+        ;;
+      -h)
+        do_hosttools="y"
+        ;;
       -c)
         do_cmake_pkg="y"
         ;;
-      -t)
-        do_hosttools="y"
+      '-?')
+        usage
+        exit 0
         ;;
       *)
         echo "Invalid argument '$1'"
+        echo
         usage
         exit 1
         ;;
@@ -84,49 +183,87 @@ fi
 # Read bundle version from file
 version=$(<sdk_version)
 
+# Resolve host type
+case ${OSTYPE} in
+  linux-gnu*)  host="linux-${HOSTTYPE}" ;;
+  darwin*)     host="macos-${HOSTTYPE}" ;;
+  *)
+    echo "ERROR: Unsupported host operating system"
+    exit 5
+    ;;
+esac
+
+# Resolve release download base URI
+dl_rel_base="https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${version}"
+dl_toolchain_filename='toolchain_${host}_${toolchain}.tar.gz'
+
 # Print banner
 echo "Zephyr SDK ${version} Setup"
 echo
 
 # Check dependencies
-which cmake &> /dev/null
-if [ $? != 0 ]; then
-  echo "Zephyr SDK setup requires CMake to be installed and available in the PATH."
-  echo "Please install CMake and run this script again."
-  exit 90
-fi
+check_command cmake 90
+check_command wget 91
 
 # Ask for user inputs if no argument is specified
 if [ "${interactive}" = "y" ]; then
   interactive="y"
   user_prompt
 fi
 
-# Register Zephyr SDK CMake package
-if [ "${do_cmake_pkg}" = "y" ]; then
-  echo "Registering Zephyr SDK CMake package ..."
-  cmake -P cmake/zephyr_sdk_export.cmake
+# Install toolchains
+for toolchain in ${inst_toolchains[@]}; do
+  eval toolchain_filename="${dl_toolchain_filename}"
+  toolchain_uri="${dl_rel_base}/${toolchain_filename}"
+
+  # Skip if toolchain directory already exists
+  if [ -d "${toolchain}" ]; then
+    continue
+  fi
+
+  echo "Installing '${toolchain}' toolchain ..."
+
+  # Download toolchain archive
+  wget -q --show-progress -N -O "${toolchain_filename}" "${toolchain_uri}"
+  if [ $? != 0 ]; then
+    rm -f "${toolchain_filename}"
+    echo "ERROR: Toolchain download failed"
+    exit 20
+  fi
+
+  # Extract archive
+  tar xf "${toolchain_filename}"
+  assert_rc "ERROR: Toolchain archive extraction failed" 21
+
+  # Remove archive
+  rm -f "${toolchain_filename}"
+
   echo
-fi
+done
 
 # Install host tools
 if [ "${do_hosttools}" = "y" ]; then
   echo "Installing host tools ..."
-  case ${OSTYPE} in
-    linux-gnu*)
+  case ${host} in
+    linux-*)
       ./zephyr-sdk-${HOSTTYPE}-hosttools-standalone-0.9.sh -y -d .
+      assert_rc "ERROR: Host tools installation failed" 30
       ;;
-    darwin*)
+    macos-*)
       echo "SKIPPED: macOS host tools are not available yet."
       ;;
-    *)
-      echo "SKIPPED: Unsupported host operating system"
-      exit 2
-      ;;
   esac
   echo
 fi
 
+# Register Zephyr SDK CMake package
+if [ "${do_cmake_pkg}" = "y" ]; then
+  echo "Registering Zephyr SDK CMake package ..."
+  cmake -P cmake/zephyr_sdk_export.cmake
+  assert_rc "ERROR: CMake package registration failed" 40
+  echo
+fi
+
 echo "All done."
 if [ "${interactive}" = "y" ]; then
   read -n 1 -s -r -p "Press any key to exit ..."