bin/freeEMSloader.bash

   1 #!/bin/bash
   2
   3 #       freeEMSloader.bash
   4 #
   5 #       Copyright 2008 Fred Cooke
   6 #
   7 #       This file is part of the FreeEMS project.
   8 #
   9 #       FreeEMS software is free software: you can redistribute it and/or modify
  10 #       it under the terms of the GNU General Public License as published by
  11 #       the Free Software Foundation, either version 3 of the License, or
  12 #       (at your option) any later version.
  13 #
  14 #       FreeEMS software is distributed in the hope that it will be useful,
  15 #       but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 #       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 #       GNU General Public License for more details.
  18 #
  19 #       You should have received a copy of the GNU General Public License
  20 #       along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
  21 #
  22 #       We ask that if you make any changes to this file you send them upstream to us at admin@diyefi.org
  23 #
  24 #       Thank you for choosing FreeEMS to run your engine!
  25
  26
  27 # Set up the variables
  28 export EXPECTED_ARGS="2"
  29 export NUMBER_OF_ARGS="$#"
  30 export SERIAL_DEVICE="$1"
  31 export FIRMWARE_S19_PATH="$2"
  32 export SERIAL_BAUD="115200"
  33 export XDP512="mc9s12xdp512"
  34 export XEP100="mc9s12xep100"
  35 export DEVICE_TYPE=$XDP512
  36 export LOAD_TOOL=`which hcs12mem`
  37 #export ADDRESS_TYPE="non-banked"
  38 export ADDRESS_TYPE="banked-ppage"
  39 #export ADDRESS_TYPE="banked-linear"
  40 # Address type banked linear should be used WITHOUT lma/ppage references in the objcopy section of the Makefile
  41
  42 # Set up the files
  43 export TEMP_BASE="/tmp/"`date +date_%F_time_%Hh%Mm%Ss_%p`
  44 export TEMP_S19_COPY=$TEMP_BASE".freeEMS.firmware.copy.s19"
  45 export TEMP_S19_DIFF=$TEMP_BASE".freeEMS.firmware.s19.diff"
  46
  47 # Set up the messages
  48 export GOODBYE="Thank you for choosing the FreeEMS to run your engine, goodbye."
  49 export USAGE="Usage : freeEMSloader.bash /dev/yourTTY new-firmware.s19"
  50
  51 # Formalise the error codes
  52 export WRONG_EMS="-10"
  53
  54 export WRONG_NUMBER_OF_ARGS="-20"
  55 export SERIAL_DEVICE_DOES_NOT_EXIST="-21"
  56 export SERIAL_DEVICE_NOT_READABLE="-22"
  57 export SERIAL_DEVICE_NOT_WRITABLE="-23"
  58 export SERIAL_DEVICE_NOT_CHARACTER_DEVICE="-24"
  59
  60 export S19_FILE_DOES_NOT_EXIST="-30"
  61 export S19_FILE_NOT_READABLE="-31"
  62 export S19_FILE_NOT_REGULAR_FILE="-32"
  63
  64 export HCS12MEM_EXECUTABLE_DOES_NOT_EXIST="-40"
  65 export HCS12MEM_EXECUTABLE_NOT_READABLE="-41"
  66 export HCS12MEM_EXECUTABLE_NOT_EXECUTABLE="-42"
  67
  68 export ABORT_PRE_ERASE="-50"
  69 export ERASE_FAILED="-51"
  70
  71 export ABORT_PRE_LOAD="-60"
  72 export LOAD_FAILED="-61"
  73
  74 export VERIFY_FAILED="-70"
  75 export ABORT_PRE_DELETE_TMP="-71"
  76 export EXIT_WITHOUT_CLEANING_UP="-72"
  77
  78
  79 # continue() takes three arguments : affirmative meaning continue, negative meaning exit, and exit code
  80 continue ()
  81 {
  82         while [ true ]
  83         do
  84                 read ANSWER
  85
  86                 if [ "$ANSWER" == "$1" ]
  87                 then
  88                         break
  89
  90                 elif [ "$ANSWER" == "$2" ]
  91                 then
  92                         echo "$GOODBYE"
  93                         exit "$3"
  94                 else
  95                         echo "'$ANSWER' not recognised, $1 and $2 are valid, please re-enter"
  96                 fi
  97         done
  98 }
  99
 100
 101 # Display splash screen
 102 welcome ()
 103 {
 104         echo "Welcome to the FreeEMS firmware loader"
 105         echo
 106         echo "This program is released under the GPL V3"
 107         echo "Please see http://www.gnu.org/licenses/ for details"
 108         echo
 109         echo "This version is for $DEVICE_TYPE based FreeEMS's"
 110         echo
 111         echo "Do you have a $DEVICE_TYPE based FreeEMS? [ yes | quit ]"
 112
 113         continue "yes" "quit" "$WRONG_EMS"
 114 }
 115
 116
 117 # Ensure all is in order
 118 check_args ()
 119 {
 120         echo "Checking configuration and arguments..."
 121
 122         # Test for the correct number of arguments
 123         if [ $EXPECTED_ARGS -ne $NUMBER_OF_ARGS ]
 124         then
 125                 echo "$USAGE"
 126                 echo "Expected $EXPECTED_ARGS parameter(s), got $NUMBER_OF_ARGS, exiting..."
 127                 exit "$WRONG_NUMBER_OF_ARGS"
 128
 129         # Ensure serial device exists
 130         elif [ ! -e "$SERIAL_DEVICE" ]
 131         then
 132                 echo "Serial device $SERIAL_DEVICE does NOT exist! exiting..."
 133                 exit "$SERIAL_DEVICE_DOES_NOT_EXIST"
 134
 135         # Ensure serial device is readable
 136         elif [ ! -r "$SERIAL_DEVICE" ]
 137         then
 138                 echo "Serial device $SERIAL_DEVICE is NOT readable! exiting..."
 139                 exit "$SERIAL_DEVICE_NOT_READABLE"
 140
 141         # Ensure serial device is writable
 142         elif [ ! -w "$SERIAL_DEVICE" ]
 143         then
 144                 echo "Serial device $SERIAL_DEVICE is NOT writable! exiting..."
 145                 exit "$SERIAL_DEVICE_NOT_WRITABLE"
 146
 147         # Ensure serial device is a character device or symlink
 148         elif [ ! -c "$SERIAL_DEVICE" ] && [ ! -L "$SERIAL_DEVICE" ]
 149         then
 150                 echo "Serial device $SERIAL_DEVICE is NOT a valid character device or symlink! exiting..."
 151                 exit "$SERIAL_DEVICE_NOT_CHARACTER_DEVICE"
 152
 153         # Ensure the s19 file exists
 154         elif [ ! -e "$FIRMWARE_S19_PATH" ]
 155         then
 156                 echo "S19 file $FIRMWARE_S19_PATH does NOT exist! exiting..."
 157                 exit "$S19_FILE_DOES_NOT_EXIST"
 158
 159         # Ensure the s19 is readable
 160         elif [ ! -r "$FIRMWARE_S19_PATH" ]
 161         then
 162                 echo "S19 file $FIRMWARE_S19_PATH is NOT readable! exiting..."
 163                 exit "$S19_FILE_NOT_READABLE"
 164
 165         # Ensure the s19 is a regular file or symlink
 166         elif [ ! -f "$FIRMWARE_S19_PATH" ] && [ ! -L "$FIRMWARE_S19_PATH" ]
 167         then
 168                 echo "S19 file $FIRMWARE_S19_PATH is NOT a regular file or symlink! exiting..."
 169                 exit "$S19_FILE_NOT_REGULAR_FILE"
 170
 171         # Ensure the hcs12mem tool is available
 172         elif [ ! -e "$LOAD_TOOL" ]
 173         then
 174                 echo "hcs12mem does NOT appear to be available in the current path! exiting..."
 175                 exit "$HCS12MEM_EXECUTABLE_DOES_NOT_EXIST"
 176
 177         # Ensure the hcs12mem tool is readable
 178         elif [ ! -r "$LOAD_TOOL" ]
 179         then
 180                 echo "$LOAD_TOOL is NOT readable! exiting..."
 181                 exit "$HCS12MEM_EXECUTABLE_NOT_READABLE"
 182
 183         # Ensure the hcs12mem tool is executable
 184         elif [ ! -x "$LOAD_TOOL" ]
 185         then
 186                 echo "$LOAD_TOOL is NOT executable! exiting..."
 187                 exit "$HCS12MEM_EXECUTABLE_NOT_EXECUTABLE"
 188         fi
 189
 190         echo "Everything looks good!"
 191 }
 192
 193
 194 # Erase the flash blocks before trying to write our S19 in (this is required)
 195 erase_flash ()
 196 {
 197         echo "Erase the flash on your FreeEMS? (This is necessary to load new firmware) [ yes | abort ]"
 198         continue "yes" "abort" "$ABORT_PRE_ERASE"
 199
 200         echo "Erasing the FreeEMS flash without verification..."
 201         $LOAD_TOOL -b $SERIAL_BAUD -i sm -p $SERIAL_DEVICE -t $DEVICE_TYPE --flash-erase
 202
 203         if [ $? -ne 0 ]
 204         then
 205                 echo "Erasing flash failed! exiting..."
 206                 exit "$ERASE_FAILED"
 207         fi
 208
 209         echo "Erasing flash was successful!"
 210 }
 211
 212
 213 # Load the s19 into the FreeEMS without verification (verify unimplemented in hcs12mem)
 214 load_s19 ()
 215 {
 216         echo "Load the firmware to your FreeEMS? [ yes | abort ]"
 217         continue "yes" "abort" "$ABORT_PRE_LOAD"
 218
 219         echo "Loading $FIRMWARE_S19_PATH to FreeEMS flash without verification..."
 220         $LOAD_TOOL -b $SERIAL_BAUD -i sm -p $SERIAL_DEVICE -t $DEVICE_TYPE -a $ADDRESS_TYPE --flash-write "$FIRMWARE_S19_PATH"
 221
 222         if [ $? -ne 0 ]
 223         then
 224                 echo "Firmware load failed! exiting..."
 225                 exit "$LOAD_FAILED"
 226         fi
 227
 228         echo "Firmware load was successful!"
 229 }
 230
 231
 232 # Verify the load to flash manually
 233 verify_load ()
 234 {
 235         echo "Verifying firmware loaded to flash correctly..."
 236
 237         echo "Reading contents of FreeEMS flash back to $TEMP_S19_COPY ..."
 238         $LOAD_TOOL -b $SERIAL_BAUD -i sm -p $SERIAL_DEVICE -t $DEVICE_TYPE -a $ADDRESS_TYPE --flash-read "$TEMP_S19_COPY"
 239
 240         echo "Comparing $TEMP_S19_COPY with $FIRMWARE_S19_PATH , redirecting output to $TEMP_S19_DIFF ..."
 241         diff $FIRMWARE_S19_PATH $TEMP_S19_COPY > $TEMP_S19_DIFF
 242
 243         if [ $? -ne 0 ]
 244         then
 245                 echo "Verification failure! :-("
 246                 echo "The retrieved S19 can be found here : $TEMP_S19_COPY"
 247                 echo "The difference between that and the original can be found here : $TEMP_S19_DIFF"
 248
 249         else
 250                 echo "Verification successful!"
 251
 252                 echo "Removing $TEMP_S19_COPY ..."
 253                 rm "$TEMP_S19_COPY"
 254
 255                 echo "Removing $TEMP_S19_DIFF ..."
 256                 rm "$TEMP_S19_DIFF"
 257         fi
 258 }
 259
 260
 261 welcome
 262 check_args
 263 erase_flash
 264 load_s19
 265 # verify currently doesn't work. needs more finesse.
 266 #verify_load
 267 echo "It is strongly recommended that you re-extract the firmware and do a visual diff to confirm that the only change is the serial monitor being included."
 268 echo "$GOODBYE"
 269