Statistics
| Branch: | Tag: | Revision:

amiro-blt / setup.sh @ 9bfc7c44

History | View | Annotate | Download (22.162 KB)

1
################################################################################
2
# AMiRo-BLT is an bootloader and toolchain designed for the Autonomous Mini    #
3
# Robot (AMiRo) platform.                                                      #
4
# Copyright (C) 2016..2019  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
### check whether commands are available #######################################
267
# Checks whether the specified commands are available and can be executed.
268
#
269
# usage:      checkCommands [<command> <command> ...]
270
# arguments:  <command>
271
#                 Name of the command to check.
272
# return:     0
273
#                 All requested commands are available.
274
#             >0
275
#                 Number of requested commands that were not found.
276
#             -1
277
#                 No argument given.
278
#
279
function checkCommands {
280
  local status=0
281

    
282
  # return if no argument was specified
283
  if [ $# -eq 0 ]; then
284
    return -1
285
  fi
286

    
287
  # check all specified commands
288
  while [ $# -gt 0 ]; do
289
    command -v $1 &>/dev/null
290
    if [ $? -ne 0 ]; then
291
      printWarning "Command '$1' not available.\n"
292
      status=$((status + 1))
293
    fi
294
    shift 1
295
  done
296

    
297
  return $status
298
}
299

    
300
################################################################################
301
# SPECIFIC FUNCTIONS                                                           #
302
################################################################################
303

    
304
### print welcome text #########################################################
305
# Prints a welcome message to standard out.
306
#
307
# usage:      printWelcomeText
308
# arguments:  n/a
309
# return:     n/a
310
#
311
function printWelcomeText {
312
  printf "######################################################################\n"
313
  printf "#                                                                    #\n"
314
  printf "#                  Welcome to the AMiRo-BLT setup!                   #\n"
315
  printf "#                                                                    #\n"
316
  printf "######################################################################\n"
317
  printf "#                                                                    #\n"
318
  printf "# Copyright (c) 2016..2019  Thomas Schöpping                         #\n"
319
  printf "#                                                                    #\n"
320
  printf "# This is free software; see the source for copying conditions.      #\n"
321
  printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR  #\n"
322
  printf "# A PARTICULAR PURPOSE. The development of this software was         #\n"
323
  printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction  #\n"
324
  printf "# Technology. The Excellence Cluster EXC 227 is a grant of the       #\n"
325
  printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n"
326
  printf "# Excellence Initiative.                                             #\n"
327
  printf "#                                                                    #\n"
328
  printf "######################################################################\n"
329
}
330

    
331
### print help #################################################################
332
# Prints a help text to standard out.
333
#
334
# usage:      printHelp
335
# arguments:  n/a
336
# return:     n/a
337
#
338
function printHelp {
339
  printInfo "printing help text\n"
340
  printf "usage:    $(basename ${BASH_SOURCE[0]}) [-h|--help] [-f|--stm32flash] [-s|--SerialBoot] [-e|--IDE] [-c|--compiler] [-q|--quit] [--log=<file>]\n"
341
  printf "\n"
342
  printf "options:  -h, --help\n"
343
  printf "              Print this help text.\n"
344
  printf "          -f, --stm32flash\n"
345
  printf "              Run st,32flash tool setup.\n"
346
  printf "          -s, --SerialBoot\n"
347
  printf "              Run SerialBoot tool setup.\n"
348
  printf "          -e, --IDE\n"
349
  printf "              Enter IDE setup.\n"
350
  printf "          -c, --compiler\n"
351
  printf "              Enter compiler setup.\n"
352
  printf "          -q, --quit\n"
353
  printf "              Quit the script.\n"
354
  printf "          --log=<file>\n"
355
  printf "              Specify a log file.\n"
356
}
357

    
358
### stm32flash tool setup ######################################################
359
# Fetches the source code for the stm32flash tool and builds the binary.
360
# If the tool was already initialized, it can be wiped and rebuilt.
361
#
362
# usage:      stm32flashSetup
363
# arguments:  n/a
364
# return:     0
365
#                 No error or warning occurred.
366
#             1
367
#                 Warning: Setup aborted by user.
368
#             -1
369
#                 Error: Unexpected user input.
370
#             -2
371
#                 Error: Missing dependecny.
372
#
373
function stm32flashSetup {
374
  local amirobltdir=$(dirname $(realpath ${BASH_SOURCE[0]}))
375
  local stm32flashdir=${amirobltdir}/Host/Source/stm32flash
376
  local userdir=$(pwd)
377

    
378
  # check dependencies
379
  checkCommands git make gcc g++
380
  if [ $? -ne 0 ]; then
381
    printError "Missing dependencies detected.\n"
382
    return -2
383
  fi
384

    
385
  # if the stm32flash folder is not empty
386
  if [ ! -z "$(ls -A $stm32flashdir)" ]; then
387
    printWarning "$stm32flashdir is not empty. Delete and reinitialize? [y/n]\n"
388
    local userinput=""
389
    readUserInput "YyNn" userinput
390
    case "$userinput" in
391
      Y|y)
392
        printInfo "wiping ${stm32flashdir}...\n"
393
        # checkout base commit and delete all local branches
394
        cd $amirobltdir
395
        git submodule update --force --checkout $stm32flashdir | tee -a $LOG_FILE
396
        cd $stm32flashdir
397
        local git_branches=($(git for-each-ref --format="%(refname)"))
398
        for branch in $git_branches ; do
399
          if [[ $branch = *"heads/"* ]]; then
400
            git branch -D ${branch##*/} | tee -a $LOG_FILE
401
          fi
402
        done
403
        cd $amirobltdir
404
        # deinit stm32flash submodule and delete any remaining files
405
        git submodule deinit -f $stm32flashdir 2>&1 | tee -a $LOG_FILE
406
        rm -rf $stm32flashdir/*
407
        cd $userdir
408
        ;;
409
      N|n)
410
        printWarning "stm32flash setup aborted by user\n"
411
        return 1
412
        ;;
413
      *) # sanity check (return error)
414
        printError "unexpected input: $userinput\n";
415
        return -1
416
        ;;
417
    esac
418
  fi
419

    
420
  # initialize submodule
421
  printInfo "initializing stm32flash submodule...\n"
422
  cd $amirobltdir
423
  git submodule update --init $stm32flashdir 2>&1 | tee -a $LOG_FILE
424
  while [ ${PIPESTATUS[0]} -ne 0 ]; do
425
    printWarning "initialitaion failed. Retry? [y/n]\n"
426
    local userinput=""
427
    readUserInput "YyNn" userinput
428
    case "$userinput" in
429
      Y|y)
430
        git submodule update --init $stm32flashdir 2>&1 | tee -a $LOG_FILE;;
431
      N|n)
432
        printWarning "stm32flash initialization aborted by user\n"
433
        cd $userdir
434
        return 1
435
        ;;
436
      *) # sanity check (return error)
437
        printError "unexpected input: $userinput\n"; return -1;;
438
    esac
439
  done
440
  cd $userdir
441

    
442
  # build the stm32flash tool
443
  printInfo "compiling stm32flash\n"
444
  cd $stm32flashdir
445
  make 2>&1 | tee -a $LOG_FILE
446
  cd $userdir
447

    
448
  # notify about udev rules
449
  printf "\n"
450
  printf "Using the AMiRo programming cable requires additional Linux udev rules (requires root).\n"
451
  printf "Please follow the instructions in ${amirobltdir}/README.txt file.\n"
452
  read -p "  Understood!"
453

    
454
  return 0
455
}
456

    
457
### SerialBoot tool setup ######################################################
458
# Builds the SerialBoot tool.
459
# If the tool was built before, it can be deleted and rebuilt.
460
#
461
# usage:      serialBootSetup
462
# arguments:  n/a
463
# return:     0
464
#                 No errort or warning occurred.
465
#             1
466
#                 Warning: Setup aborted by user.
467
#             -1
468
#                 Error: Unexpected user input.
469
#             -2
470
#                 Error: Missing dependecny.
471
#
472
function serialBootSetup {
473
  local amirobltdir=$(dirname $(realpath ${BASH_SOURCE[0]}))
474
  local serialbootdir=${amirobltdir}/Host/Source/SerialBoot
475
  local userdir=$(pwd)
476

    
477
  # check dependencies
478
  checkCommands make cmake gcc g++
479
  if [ $? -ne 0 ]; then
480
    printError "Missing dependencies detected.\n"
481
    return -2
482
  fi
483

    
484
  # if a build folder already exists
485
  if [ -d "${serialbootdir}/build/" ]; then
486
    printWarning "SerialBoot has been built before. Delete and rebuild? [y/n]\n"
487
    local userinput=""
488
    readUserInput "YyNn" userinput
489
    case "$userinput" in
490
      Y|y)
491
        printInfo "deleting ${serialbootdir}/build/...\n"
492
        rm -rf "${serialbootdir}/build/"
493
        ;;
494
      N|n)
495
        printWarning "SerialBoot setup aborted by user\n"
496
        return 1
497
        ;;
498
      *) # sanity check (return error)
499
        printError "unexpected input: $userinput\n";
500
        return -1
501
        ;;
502
    esac
503
  fi
504

    
505
  # build SerialBoot
506
  printInfo "compiling SerialBoot...\n"
507
  mkdir ${serialbootdir}/build
508
  cd ${serialbootdir}/build
509
  cmake .. 2>&1 | tee -a $LOG_FILE
510
  make 2>&1 | tee -a $LOG_FILE
511
  cd $userdir
512

    
513
  # notify about udev rules
514
  printf "\n"
515
  printf "Using the AMiRo programming cable requires additional Linux udev rules (requires root).\n"
516
  printf "Please follow the instructions in ${amirobltdir}/README.txt file.\n"
517
  read -p "  Understood!"
518

    
519
  return 0
520
}
521

    
522
### IDE setup ##################################################################
523
# Enter the IDE setup.
524
#
525
# usage:      ideSetup
526
# arguments:  n/a
527
# return:     n/a
528
#
529
function ideSetup {
530
  printInfo "entering IDE setup\n"
531
  printf "\n"
532
  if [ -z "$LOG_FILE" ]; then
533
    $(dirname $(realpath ${BASH_SOURCE[0]}))/tools/ide/idesetup.sh --noinfo
534
  else
535
    $(dirname $(realpath ${BASH_SOURCE[0]}))/tools/ide/idesetup.sh --LOG="$LOG_FILE" --noinfo
536
  fi
537
}
538

    
539
### compiler setup #############################################################
540
# Enter the compiler setup.
541
#
542
# usage:      compilerSetup
543
# arguments:  n/a
544
# return:     n/a
545
#
546
function compilerSetup {
547
  printInfo "entering compiler setup\n"
548
  printf "\n"
549
  if [ -z "$LOG_FILE" ]; then
550
    $(dirname $(realpath ${BASH_SOURCE[0]}))/tools/compiler/compilersetup.sh --noinfo
551
  else
552
    $(dirname $(realpath ${BASH_SOURCE[0]}))/tools/compiler/compilersetup.sh --LOG="$LOG_FILE" --noinfo
553
  fi
554
}
555

    
556
### main function of this script ###############################################
557
# A setup to initialize dependencies, setup IDE projects and configure the
558
# compiler setup.
559
#
560
# usage:      see function printHelp
561
# arguments:  see function printHelp
562
# return:     0
563
#                 No error or warning occurred.
564
#
565
function main {
566
  # print welcome/info text if not suppressed
567
  if [[ $@ != *"--noinfo"* ]]; then
568
    printWelcomeText
569
  else
570
    printf "######################################################################\n"
571
  fi
572
  printf "\n"
573

    
574
  # if --help or -h was specified, print the help text and exit
575
  if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then
576
    printHelp
577
    printf "\n"
578
    quitScript
579
  fi
580

    
581
  # set log file if specified
582
  if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then
583
    # get the parameter (file name)
584
    local cmdidx=1
585
    while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do
586
      cmdidx=$[cmdidx + 1]
587
    done
588
    local cmd="${!cmdidx}"
589
    local logfile=""
590
    if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then
591
      logfile=${cmd#*=}
592
    else
593
      local filenameidx=$((cmdidx + 1))
594
      logfile="${!filenameidx}"
595
    fi
596
    # optionally force silent appending
597
    if [[ "$cmd" = "--LOG"* ]]; then
598
      setLogFile --option=c --quiet "$logfile" LOG_FILE
599
    else
600
      setLogFile "$logfile" LOG_FILE
601
      printf "\n"
602
    fi
603
  fi
604
  # log script name
605
  printLog "this is $(realpath ${BASH_SOURCE[0]})\n"
606

    
607
  # parse arguments
608
  local otherargs=()
609
  while [ $# -gt 0 ]; do
610
    if ( parseIsOption $1 ); then
611
      case "$1" in
612
        -h|--help) # already handled; ignore
613
          shift 1;;
614
        -f|--stm32flash)
615
          stm32flashSetup; printf "\n"; shift 1;;
616
        -s|--SerialBoot)
617
          serialBootSetup; printf "\n"; shift 1;;
618
        -e|--IDE)
619
          ideSetup; printf "\n"; shift 1;;
620
        -c|--compiler)
621
          compilerSetup; printf "\n"; shift 1;;
622
        -q|--quit)
623
          quitScript; shift 1;;
624
        --log=*|--LOG=*) # already handled; ignore
625
          shift 1;;
626
        --log|--LOG) # already handled; ignore
627
          shift 2;;
628
        --noinfo) # already handled; ignore
629
          shift 1;;
630
        *)
631
          printError "invalid option: $1\n"; shift 1;;
632
      esac
633
    else
634
      otherargs+=("$1")
635
      shift 1
636
    fi
637
  done
638

    
639
  # interactive menu
640
  while ( true ); do
641
    # main menu info prompt and selection
642
    printInfo "AMiRo-BLT setup main menu\n"
643
    printf "Please select one of the following actions:\n"
644
    printf "  [F] - get and build stm32flash tool\n"
645
    printf "  [S] - build SerialBoot tool\n"
646
    printf "  [E] - IDE project setup\n"
647
    printf "  [C] - enter compiler setup\n"
648
    printf "  [Q] - quit this setup\n"
649
    local userinput=""
650
    readUserInput "FfSsEeCcQq" userinput
651
    printf "\n"
652

    
653
    # evaluate user selection
654
    case "$userinput" in
655
      F|f)
656
        stm32flashSetup; printf "\n";;
657
      S|s)
658
        serialBootSetup; printf "\n";;
659
      E|e)
660
        ideSetup; printf "\n";;
661
      C|c)
662
        compilerSetup; printf "\n";;
663
      Q|q)
664
        quitScript;;
665
      *) # sanity check (exit with error)
666
        printError "unexpected argument: $userinput\n";;
667
    esac
668
  done
669

    
670
  exit 0
671
}
672

    
673
################################################################################
674
# SCRIPT ENTRY POINT                                                           #
675
################################################################################
676

    
677
main "$@"
678