| 1 |
|
################################################################################
|
| 2 |
|
# AMiRo-BLT is an bootloader and toolchain designed for the Autonomous Mini #
|
| 3 |
|
# Robot (AMiRo) platform. #
|
| 4 |
|
# Copyright (C) 2016..2018 Thomas Schöpping et al. #
|
| 5 |
|
# #
|
| 6 |
|
# This program is free software: you can redistribute it and/or modify #
|
| 7 |
|
# it under the terms of the GNU General Public License as published by #
|
| 8 |
|
# the Free Software Foundation, either version 3 of the License, or #
|
| 9 |
|
# (at your option) any later version. #
|
| 10 |
|
# #
|
| 11 |
|
# This program is distributed in the hope that it will be useful, #
|
| 12 |
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
|
| 13 |
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
|
| 14 |
|
# GNU General Public License for more details. #
|
| 15 |
|
# #
|
| 16 |
|
# You should have received a copy of the GNU General Public License #
|
| 17 |
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
|
| 18 |
|
# #
|
| 19 |
|
# This research/work was supported by the Cluster of Excellence Cognitive #
|
| 20 |
|
# Interaction Technology 'CITEC' (EXC 277) at Bielefeld University, which is #
|
| 21 |
|
# funded by the German Research Foundation (DFG). #
|
| 22 |
|
################################################################################
|
| 23 |
|
|
| 24 |
|
#!/bin/bash
|
| 25 |
|
|
| 26 |
|
################################################################################
|
| 27 |
|
# GENERIC FUNCTIONS #
|
| 28 |
|
################################################################################
|
| 29 |
|
|
| 30 |
|
### print an error message #####################################################
|
| 31 |
|
# Prints a error <message> to standard output.
|
| 32 |
|
#If variable 'LOG_FILE' is specified, the message is also appended to the given file.
|
| 33 |
|
#
|
| 34 |
|
# usage: printError <message>
|
| 35 |
|
# arguments: <message>
|
| 36 |
|
# Message string to print.
|
| 37 |
|
# return: n/a
|
| 38 |
|
#
|
| 39 |
|
function printError {
|
| 40 |
|
local string="ERROR: $1"
|
| 41 |
|
# if a log file is specified
|
| 42 |
|
if [ -n "$LOG_FILE" ]; then
|
| 43 |
|
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE
|
| 44 |
|
fi
|
| 45 |
|
printf "$(tput setaf 1)>>> $string$(tput sgr 0)" 1>&2
|
| 46 |
|
}
|
| 47 |
|
|
| 48 |
|
### print a warning message ####################################################
|
| 49 |
|
# Prints a warning <message> to standard output.
|
| 50 |
|
#If variable 'LOG_FILE' is specified, the message is also appended to the given file.
|
| 51 |
|
#
|
| 52 |
|
# usage: printMessage <message>
|
| 53 |
|
# arguments: <message>
|
| 54 |
|
# Message string to print.
|
| 55 |
|
# return: n/a
|
| 56 |
|
#
|
| 57 |
|
function printWarning {
|
| 58 |
|
local string="WARNING: $1"
|
| 59 |
|
# if a log file is specified
|
| 60 |
|
if [ -n "$LOG_FILE" ]; then
|
| 61 |
|
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE
|
| 62 |
|
fi
|
| 63 |
|
printf "$(tput setaf 3)>>> $string$(tput sgr 0)"
|
| 64 |
|
}
|
| 65 |
|
|
| 66 |
|
### print an information message ###############################################
|
| 67 |
|
# Prints an information <message> to standard output.
|
| 68 |
|
#If variable 'LOG_FILE' is specified, the message is also appended to the given file.
|
| 69 |
|
#
|
| 70 |
|
# usage: printInfo <message>
|
| 71 |
|
# arguments: <message>
|
| 72 |
|
# Message string to print.
|
| 73 |
|
# return: n/a
|
| 74 |
|
#
|
| 75 |
|
function printInfo {
|
| 76 |
|
local string="INFO: $1"
|
| 77 |
|
# if a log file is specified
|
| 78 |
|
if [ -n "$LOG_FILE" ]; then
|
| 79 |
|
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE
|
| 80 |
|
fi
|
| 81 |
|
printf "$(tput setaf 2)>>> $string$(tput sgr 0)"
|
| 82 |
|
}
|
| 83 |
|
|
| 84 |
|
### print a message to file ####################################################
|
| 85 |
|
# Appends a <message> to a log file, specified by the variable 'LOG_FILE'.
|
| 86 |
|
#
|
| 87 |
|
# usage printLog <message>
|
| 88 |
|
# arguments: <message>
|
| 89 |
|
# Message string to print.
|
| 90 |
|
# return: n/a
|
| 91 |
|
#
|
| 92 |
|
function printLog {
|
| 93 |
|
local string="LOG: $1"
|
| 94 |
|
# if a log file is specified
|
| 95 |
|
if [ -n "$LOG_FILE" ]; then
|
| 96 |
|
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE
|
| 97 |
|
fi
|
| 98 |
|
}
|
| 99 |
|
|
| 100 |
|
### exit the script normally ###################################################
|
| 101 |
|
# Prints a delimiter and exits the script normally (returns 0).
|
| 102 |
|
#
|
| 103 |
|
# usage: quitScript
|
| 104 |
|
# arguments: n/a
|
| 105 |
|
# return: 0
|
| 106 |
|
# No error or warning occurred.
|
| 107 |
|
#
|
| 108 |
|
function quitScript {
|
| 109 |
|
printInfo "exiting $(realpath ${BASH_SOURCE[0]})\n"
|
| 110 |
|
printf "\n"
|
| 111 |
|
printf "######################################################################\n"
|
| 112 |
|
exit 0
|
| 113 |
|
}
|
| 114 |
|
|
| 115 |
|
### read a user input ##########################################################
|
| 116 |
|
# Reads a single character user input from a set up <options> and stores it in
|
| 117 |
|
# a given <return> variable.
|
| 118 |
|
#
|
| 119 |
|
# usage: readUserInput <options> <return>
|
| 120 |
|
# arguments: <options>
|
| 121 |
|
# String definiing the set of valid characters.
|
| 122 |
|
# If the string is empty, the user can input any character.
|
| 123 |
|
# <return>
|
| 124 |
|
# Variable to store the selected character to.
|
| 125 |
|
# return: n/a
|
| 126 |
|
#
|
| 127 |
|
function readUserInput {
|
| 128 |
|
local input=""
|
| 129 |
|
# read user input
|
| 130 |
|
while [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); do
|
| 131 |
|
read -p "your selection: " -n 1 -e input
|
| 132 |
|
if [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); then
|
| 133 |
|
printWarning "[$input] is no valid action\n"
|
| 134 |
|
fi
|
| 135 |
|
done
|
| 136 |
|
printLog "[$input] has been selected\n"
|
| 137 |
|
eval $2="$input"
|
| 138 |
|
}
|
| 139 |
|
|
| 140 |
|
### check whether argument is an option ########################################
|
| 141 |
|
# Checks a <string> whether it is an option.
|
| 142 |
|
# Options are defined to either start with '--' followed by any string, or
|
| 143 |
|
# to start with a single '-' followed by a single character, or
|
| 144 |
|
# to start with a single '-' followed by a single character, a '=' and any string.
|
| 145 |
|
# Examples: '--option', '--option=arg', '-o', '-o=arg', '--'
|
| 146 |
|
#
|
| 147 |
|
# usage: parseIsOption <string>
|
| 148 |
|
# arguments: <string>
|
| 149 |
|
# A string to check whether it is an option.
|
| 150 |
|
# return: 0
|
| 151 |
|
# <string> is an option.
|
| 152 |
|
# -1
|
| 153 |
|
# <string> is not an option.
|
| 154 |
|
#
|
| 155 |
|
function parseIsOption {
|
| 156 |
|
if [[ "$1" =~ ^-(.$|.=.*) ]] || [[ "$1" =~ ^--.* ]]; then
|
| 157 |
|
return 0
|
| 158 |
|
else
|
| 159 |
|
return -1
|
| 160 |
|
fi
|
| 161 |
|
}
|
| 162 |
|
|
| 163 |
|
### set the log file ###########################################################
|
| 164 |
|
# Sets a specified <infile> as log file and checks whether it already exists.
|
| 165 |
|
# If so, the log may either be appended to the file, its content can be cleared,
|
| 166 |
|
# or no log is generated at all.
|
| 167 |
|
# The resulting path is stored in <outvar>.
|
| 168 |
|
#
|
| 169 |
|
# usage: setLogFile [--option=<option>] [--quiet] <infile> <outvar>
|
| 170 |
|
# arguments: --option=<option>
|
| 171 |
|
# Select what to do if <file> already exists.
|
| 172 |
|
# Possible values are 'a', 'c', 'r' and 'n'.
|
| 173 |
|
# - a: append (starts with a separator)
|
| 174 |
|
# - c: continue (does not insert a seperator)
|
| 175 |
|
# - r: delete and restart
|
| 176 |
|
# - n: no log
|
| 177 |
|
# If no option is secified but <file> exists, an interactive selection is provided.
|
| 178 |
|
# --quiet
|
| 179 |
|
# Suppress all messages.
|
| 180 |
|
# <infile>
|
| 181 |
|
# Path of the wanted log file.
|
| 182 |
|
# <outvar>
|
| 183 |
|
# Variable to store the path of the log file to.
|
| 184 |
|
# return: 0
|
| 185 |
|
# No error or warning occurred.
|
| 186 |
|
# -1
|
| 187 |
|
# Error: invalid input
|
| 188 |
|
#
|
| 189 |
|
function setLogFile {
|
| 190 |
|
local filepath=""
|
| 191 |
|
local option=""
|
| 192 |
|
local quiet=false
|
| 193 |
|
|
| 194 |
|
# parse arguments
|
| 195 |
|
local otherargs=()
|
| 196 |
|
while [ $# -gt 0 ]; do
|
| 197 |
|
if ( parseIsOption $1 ); then
|
| 198 |
|
case "$1" in
|
| 199 |
|
-o=*|--option=*)
|
| 200 |
|
option=${1#*=}; shift 1;;
|
| 201 |
|
-o*|--option*)
|
| 202 |
|
option="$2"; shift 2;;
|
| 203 |
|
-q|--quiet)
|
| 204 |
|
quiet=true; shift 1;;
|
| 205 |
|
*)
|
| 206 |
|
printError "invalid option: $1\n"; shift 1;;
|
| 207 |
|
esac
|
| 208 |
|
else
|
| 209 |
|
otherargs+=("$1")
|
| 210 |
|
shift 1
|
| 211 |
|
fi
|
| 212 |
|
done
|
| 213 |
|
filepath=$(realpath ${otherargs[0]})
|
| 214 |
|
|
| 215 |
|
# if file already exists
|
| 216 |
|
if [ -e $filepath ]; then
|
| 217 |
|
# if no option was specified, ask what to do
|
| 218 |
|
if [ -z "$option" ]; then
|
| 219 |
|
printWarning "log file $filepath already esists\n"
|
| 220 |
|
local userinput=""
|
| 221 |
|
printf "Select what to do:\n"
|
| 222 |
|
printf " [A] - append log\n"
|
| 223 |
|
printf " [R] - restart log (delete existing file)\n"
|
| 224 |
|
printf " [N] - no log\n"
|
| 225 |
|
readUserInput "AaRrNn" userinput
|
| 226 |
|
option=${userinput,,}
|
| 227 |
|
fi
|
| 228 |
|
# evaluate option
|
| 229 |
|
case "$option" in
|
| 230 |
|
a|c)
|
| 231 |
|
if [ $quiet = false ]; then
|
| 232 |
|
printInfo "appending log to $filepath\n"
|
| 233 |
|
fi
|
| 234 |
|
if [ $option != c ]; then
|
| 235 |
|
printf "\n" >> $filepath
|
| 236 |
|
printf "######################################################################\n" >> $filepath
|
| 237 |
|
printf "\n" >> $filepath
|
| 238 |
|
fi
|
| 239 |
|
;;
|
| 240 |
|
r)
|
| 241 |
|
echo -n "" > $filepath
|
| 242 |
|
if [ $quiet = false ]; then
|
| 243 |
|
printInfo "content of $filepath wiped\n"
|
| 244 |
|
fi
|
| 245 |
|
;;
|
| 246 |
|
n)
|
| 247 |
|
if [ $quiet = false ]; then
|
| 248 |
|
printInfo "no log file will be generated\n"
|
| 249 |
|
fi
|
| 250 |
|
filepath=""
|
| 251 |
|
;;
|
| 252 |
|
*) # sanity check (return error)
|
| 253 |
|
printError "unexpected argument: $option\n"; return -1;;
|
| 254 |
|
esac
|
| 255 |
|
else
|
| 256 |
|
if [ $quiet = false ]; then
|
| 257 |
|
printInfo "log file set to $filepath\n"
|
| 258 |
|
fi
|
| 259 |
|
fi
|
| 260 |
|
|
| 261 |
|
eval ${otherargs[1]}="$filepath"
|
| 262 |
|
|
| 263 |
|
return 0
|
| 264 |
|
}
|
| 265 |
|
|
| 266 |
|
################################################################################
|
| 267 |
|
# SPECIFIC FUNCTIONS #
|
| 268 |
|
################################################################################
|
| 269 |
|
|
| 270 |
|
### print welcome text #########################################################
|
| 271 |
|
# Prints a welcome message to standard out.
|
| 272 |
|
#
|
| 273 |
|
# usage: printWelcomeText
|
| 274 |
|
# arguments: n/a
|
| 275 |
|
# return: n/a
|
| 276 |
|
#
|
| 277 |
|
function printWelcomeText {
|
| 278 |
|
printf "######################################################################\n"
|
| 279 |
|
printf "# #\n"
|
| 280 |
|
printf "# Welcome to the GCC setup! #\n"
|
| 281 |
|
printf "# #\n"
|
| 282 |
|
printf "######################################################################\n"
|
| 283 |
|
printf "# #\n"
|
| 284 |
|
printf "# Copyright (c) 2016..2018 Thomas Schöpping #\n"
|
| 285 |
|
printf "# #\n"
|
| 286 |
|
printf "# This is free software; see the source for copying conditions. #\n"
|
| 287 |
|
printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR #\n"
|
| 288 |
|
printf "# A PARTICULAR PURPOSE. The development of this software was #\n"
|
| 289 |
|
printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction #\n"
|
| 290 |
|
printf "# Technology. The Excellence Cluster EXC 227 is a grant of the #\n"
|
| 291 |
|
printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n"
|
| 292 |
|
printf "# Excellence Initiative. #\n"
|
| 293 |
|
printf "# #\n"
|
| 294 |
|
printf "######################################################################\n"
|
| 295 |
|
}
|
| 296 |
|
|
| 297 |
|
### print help #################################################################
|
| 298 |
|
# Prints a help text to standard out.
|
| 299 |
|
#
|
| 300 |
|
# usage: printHelp
|
| 301 |
|
# arguments: n/a
|
| 302 |
|
# return: n/a
|
| 303 |
|
#
|
| 304 |
|
function printHelp {
|
| 305 |
|
printInfo "printing help text\n"
|
| 306 |
|
printf "usage: $(basename ${BASH_SOURCE[0]}) [-h|--help] [-i|--install] [-c|--change] [-q|--quit] [--log=<file>]\n"
|
| 307 |
|
printf "\n"
|
| 308 |
|
printf "options: -h, --help\n"
|
| 309 |
|
printf " Print this help text.\n"
|
| 310 |
|
printf " -i, --install\n"
|
| 311 |
|
printf " Install another version.\n"
|
| 312 |
|
printf " -u, --uninstall\n"
|
| 313 |
|
printf " Unistall a version.\n"
|
| 314 |
|
printf " -c, --change\n"
|
| 315 |
|
printf " Change the default version.\n"
|
| 316 |
|
printf " -q, --quit\n"
|
| 317 |
|
printf " Quit the script.\n"
|
| 318 |
|
printf " --log=<file>\n"
|
| 319 |
|
printf " Specify a log file.\n"
|
| 320 |
|
}
|
| 321 |
|
|
| 322 |
|
### detect installed versions ##################################################
|
| 323 |
|
# Detect all installed version of arm-none-eabi-gcc, if any.
|
| 324 |
|
#
|
| 325 |
|
# usage: detectInstalledVersions <binarray> <current> [<current_idx>]
|
| 326 |
|
# arguments: <binarray>
|
| 327 |
|
# Array variable to store all detected binary paths to.
|
| 328 |
|
# <current>
|
| 329 |
|
# Variable to store the currently active binary to.
|
| 330 |
|
# <current_idx>
|
| 331 |
|
# Index of the curretly selected version in the output array (<binarray>).
|
| 332 |
|
# return: n/a
|
| 333 |
|
#
|
| 334 |
|
function detectInstalledVersions {
|
| 335 |
|
local armgcc_command=$(command -v arm-none-eabi-gcc)
|
| 336 |
|
local armgcc_commanddir=${HOME}/gcc-none-eabi
|
| 337 |
|
local armgcc_currentbin=""
|
| 338 |
|
local armgcc_installdir=${HOME}/gcc-none-eabi
|
| 339 |
|
local armgcc_bins=()
|
| 340 |
|
local armgcc_bincnt=0
|
| 341 |
|
|
| 342 |
|
# check for already installed versions
|
| 343 |
|
if [ -n "$armgcc_command" ]; then
|
| 344 |
|
# follow the link to the actual binary
|
| 345 |
|
armgcc_commanddir=$(dirname $armgcc_command)
|
| 346 |
|
armgcc_currentbin=$armgcc_command
|
| 347 |
|
while [ -L $armgcc_currentbin ]; do
|
| 348 |
|
# differentiate between relative and absolute paths
|
| 349 |
|
if [[ $(readlink $armgcc_currentbin) = /* ]]; then
|
| 350 |
|
armgcc_currentbin=$(readlink $armgcc_currentbin)
|
| 351 |
|
else
|
| 352 |
|
armgcc_currentbin=$(realpath $(dirname $armgcc_currentbin)/$(readlink $armgcc_currentbin))
|
| 353 |
|
fi
|
| 354 |
|
done
|
| 355 |
|
# the installation location is assumed to be two directories up
|
| 356 |
|
armgcc_installdir=$(realpath $(dirname ${armgcc_currentbin})/../..)
|
| 357 |
|
# list all detected instalations
|
| 358 |
|
for dir in $(ls -d ${armgcc_installdir}/*/); do
|
| 359 |
|
if [ -f ${dir}/bin/arm-none-eabi-gcc ]; then
|
| 360 |
|
armgcc_bins[$armgcc_bincnt]=${dir}bin/arm-none-eabi-gcc
|
| 361 |
|
armgcc_bincnt=$((armgcc_bincnt + 1))
|
| 362 |
|
fi
|
| 363 |
|
done
|
| 364 |
|
|
| 365 |
|
# set the output variables
|
| 366 |
|
eval "$1=(${armgcc_bins[*]})"
|
| 367 |
|
eval $2="$armgcc_currentbin"
|
| 368 |
|
if [ -n "$3" ]; then
|
| 369 |
|
for (( bin=0; bin<${#armgcc_bins[@]}; ++bin )); do
|
| 370 |
|
if [ ${armgcc_bins[bin]} = "$armgcc_currentbin" ]; then
|
| 371 |
|
eval $3=$bin
|
| 372 |
|
fi
|
| 373 |
|
done
|
| 374 |
|
fi
|
| 375 |
|
else
|
| 376 |
|
eval "$1=()"
|
| 377 |
|
eval $2=""
|
| 378 |
|
if [ -n "$3" ]; then
|
| 379 |
|
eval $3=""
|
| 380 |
|
fi
|
| 381 |
|
fi
|
| 382 |
|
}
|
| 383 |
|
|
| 384 |
|
### install new version ########################################################
|
| 385 |
|
# Fetches an installation package from the internet, installs it and expands
|
| 386 |
|
# the $PATH environment variable (via .bashrc) if required.
|
| 387 |
|
#
|
| 388 |
|
# usage: installNewVersion [-i|--install=<path>] [-l|--link=<path>]
|
| 389 |
|
# argumenst: -i, --install <path>
|
| 390 |
|
# Path where to install the new version to.
|
| 391 |
|
# -l, --link <path>
|
| 392 |
|
# Path where to create according links.
|
| 393 |
|
# return: 0
|
| 394 |
|
# No error or warnign occurred.
|
| 395 |
|
# 1
|
| 396 |
|
# Warning: Installation aborted by user.
|
| 397 |
|
#
|
| 398 |
|
function installNewVersion {
|
| 399 |
|
local installbasedir=${HOME}/gcc-arm-embedded
|
| 400 |
|
local linkdir="/usr/bin"
|
| 401 |
|
|
| 402 |
|
# parse arguments
|
| 403 |
|
local otherargs=()
|
| 404 |
|
while [ $# -gt 0 ]; do
|
| 405 |
|
if ( parseIsOption $1 ); then
|
| 406 |
|
case "$1" in
|
| 407 |
|
-i=*|--install=*)
|
| 408 |
|
installbasedir=$(realpath "${1#*=}"); shift 1;;
|
| 409 |
|
-i|--install)
|
| 410 |
|
installbasedir="$2"; shift 2;;
|
| 411 |
|
-l=*|--link=*)
|
| 412 |
|
linkdir=$(realpath "${1#*=}"); shift 1;;
|
| 413 |
|
-l|--link)
|
| 414 |
|
linkdir="$2"; shift 2;;
|
| 415 |
|
*) # sanity check (exit with error)
|
| 416 |
|
printError "invalid option: $1\n"; shift 1;;
|
| 417 |
|
esac
|
| 418 |
|
else
|
| 419 |
|
otherargs+=("$1")
|
| 420 |
|
shift 1
|
| 421 |
|
fi
|
| 422 |
|
done
|
| 423 |
|
|
| 424 |
|
# read download URL form user
|
| 425 |
|
printLog "read installation url from user\n"
|
| 426 |
|
local armgcc_downloadurl=""
|
| 427 |
|
while [ -z "$armgcc_downloadurl" ]; do
|
| 428 |
|
read -p "Download link for the installation file: " -e armgcc_downloadurl
|
| 429 |
|
if [ -z "$armgcc_downloadurl" ]; then
|
| 430 |
|
printWarning "installation aborted by user\n"
|
| 431 |
|
return 1
|
| 432 |
|
fi
|
| 433 |
|
if [[ $armgcc_downloadurl != *".tar.bz2" ]]; then
|
| 434 |
|
printWarning "please specify a .tar.bz2 file\n"
|
| 435 |
|
armgcc_downloadurl=""
|
| 436 |
|
fi
|
| 437 |
|
if [ ! wget --spider $armgcc_downloadurl 2>/dev/null ]; then
|
| 438 |
|
printWarning "$armgcc_downloadurl can not be reached\n"
|
| 439 |
|
armgcc_downloadurl=""
|
| 440 |
|
fi
|
| 441 |
|
done
|
| 442 |
|
printLog "user selected $armgcc_downloadurl\n"
|
| 443 |
|
|
| 444 |
|
# if the file already exists, ask the user if it should be downloaded again
|
| 445 |
|
local armgcc_tarball=$(basename "$armgcc_downloadurl")
|
| 446 |
|
if [ -e "$armgcc_tarball" ]; then
|
| 447 |
|
printWarning "$armgcc_tarball already exists. Delete and redownload? [y/n]\n"
|
| 448 |
|
local userinput=""
|
| 449 |
|
readUserInput "YyNn" userinput
|
| 450 |
|
case "$userinput" |