130 lines
5.4 KiB
Bash
Executable File
130 lines
5.4 KiB
Bash
Executable File
#!/bin/bash
|
|
#
|
|
# Version 1.0.1 Build 12
|
|
#
|
|
# progmem.sh - multi-language support script
|
|
# Examine content of progmem sections (default is progmem1).
|
|
#
|
|
# Input files:
|
|
# $OUTDIR/Firmware.ino.elf
|
|
# $OUTDIR/sketch/*.o (all object files)
|
|
#
|
|
# Output files:
|
|
# text.sym - formated symbol listing of section '.text'
|
|
# $PROGMEM.sym - formated symbol listing of section '.progmemX'
|
|
# $PROGMEM.lss - disassembly listing file
|
|
# $PROGMEM.hex - variables - hex
|
|
# $PROGMEM.chr - variables - char escape
|
|
# $PROGMEM.var - variables - strings
|
|
# $PROGMEM.txt - text data only (not used)
|
|
#
|
|
#############################################################################
|
|
# Change log:
|
|
# 31 May 2018, XPila, Initial
|
|
# 9 June 2020, 3d-gussner, Added version and Change log
|
|
# 9 June 2020, 3d-gussner, colored output
|
|
# 2 Apr. 2021, 3d-gussner, Use `git rev-list --count HEAD progmem.sh`
|
|
# to get Build Nr
|
|
#############################################################################
|
|
#
|
|
# Config:
|
|
if [ -z "$CONFIG_OK" ]; then eval "$(cat config.sh)"; fi
|
|
if [ -z "$OUTDIR" ]; then echo "$(tput setaf 1)variable OUTDIR not set!$(tput sgr0)" >&2; exit 1; fi
|
|
if [ -z "$OBJDIR" ]; then echo "$(tput setaf 1)variable OBJDIR not set!$(tput sgr0)" >&2; exit 1; fi
|
|
if [ -z "$INOELF" ]; then echo "$(tput setaf 1)variable INOELF not set!$(tput sgr0)" >&2; exit 1; fi
|
|
if [ -z "$OBJDUMP" ]; then echo "$(tput setaf 1)variable OBJDUMP not set!$(tput sgr0)" >&2; exit 1; fi
|
|
if [ -z "$CONFIG_OK" ] | [ $CONFIG_OK -eq 0 ]; then echo "$(tput setaf 1)Config NG!$(tput sgr0)" >&2; exit 1; fi
|
|
#
|
|
# Program memory used
|
|
PROGMEM=progmem$1
|
|
if [ -z "$1" ]; then PROGMEM=progmem1; fi
|
|
#
|
|
# Description of process:
|
|
# 0. check input files
|
|
# 1. remove output files
|
|
# 2. list symbol table of section '.text' from output elf file to text.sym (sorted by address)
|
|
# 3. calculate start and stop address of section '.$PROGMEM'
|
|
# 4. extract string data from elf file to $PROGMEM.hex
|
|
# 5. prepare string data for character check and conversion (output to $PROGMEM.chr)
|
|
# 6. perform character check and conversion (output to $PROGMEM.var and $PROGMEM.txt)
|
|
#
|
|
|
|
echo "$(tput setaf 2)progmem.sh started$(tput sgr0)" >&2
|
|
|
|
# (0)
|
|
echo " progmem.sh (0) - checking input files" >&2
|
|
if [ ! -e $OUTDIR ]; then echo "progmem.sh - file $(tput setaf 2)"$INOELF"$(tput sgr 0) not found!" >&2; exit 1; fi
|
|
|
|
# (1)
|
|
echo " progmem.sh (1) - removing output files" >&2
|
|
#remove output files if exists
|
|
if [ -e text.sym ]; then rm text.sym; fi
|
|
if [ -e $PROGMEM.sym ]; then rm $PROGMEM.sym; fi
|
|
if [ -e $PROGMEM.lss ]; then rm $PROGMEM.lss; fi
|
|
if [ -e $PROGMEM.hex ]; then rm $PROGMEM.hex; fi
|
|
if [ -e $PROGMEM.chr ]; then rm $PROGMEM.chr; fi
|
|
if [ -e $PROGMEM.var ]; then rm $PROGMEM.var; fi
|
|
if [ -e $PROGMEM.txt ]; then rm $PROGMEM.txt; fi
|
|
|
|
# (2)
|
|
echo " progmem.sh (2) - listing symbol table of section '.text'" >&2
|
|
#list symbols from section '.text' into file text.sym (only address, size and name)
|
|
#$OBJDUMP -t -j ".text" $INOELF | sort > text.sym
|
|
$OBJDUMP -t -j ".text" $INOELF | tail -n +5 | grep -E "^[0-9a-f]{8} [gl] [O ]" | cut -c1-9,28-36,37- | sed "/^$/d" | sort > text.sym
|
|
|
|
# (3)
|
|
echo " progmem.sh (3) - calculating start and end address" >&2
|
|
#calculate start addres of section ".$PROGMEM"
|
|
PROGMEM_BEG=$(cat text.sym | grep "__loc_pri_start" | while read offs size name; do echo "0x"$offs; done)
|
|
#calculate stop addres of section ".$PROGMEM"
|
|
PROGMEM_END=$(cat text.sym | grep "__loc_pri_end" | while read offs size name; do echo "0x"$offs; done)
|
|
echo " START address = "$PROGMEM_BEG >&2
|
|
echo " STOP address = "$PROGMEM_END >&2
|
|
|
|
# (4)
|
|
echo " progmem.sh (4) - extracting string data from elf" >&2
|
|
#dump $PROGMEM data in hex format, cut disassembly (keep hex data only)
|
|
$OBJDUMP -D -j ".text" -w -z --start-address=$PROGMEM_BEG --stop-address=$PROGMEM_END $INOELF |\
|
|
tail -n +7 | sed "s/ \t.*$//" > $PROGMEM.lss
|
|
#convert $PROGMEM.lss to $PROGMEM.hex:
|
|
# replace empty lines with '|' (variables separated by empty lines)
|
|
# remove address from multiline variables (keep address at first variable line only)
|
|
# remove '<' and '>:', remove whitespace at end of lines
|
|
# remove line-endings, replace separator with '\n' (join hex data lines - each line will contain single variable)
|
|
cat $PROGMEM.lss | sed -E 's/^$/|/;s/^ ....:\t//;s/[ ]*$/ /' | tr -d '\n' | tr '|' '\n' |\
|
|
sed "s/^ //;s/<//;s/>:/ /;s/00 [1-9a-f][1-9a-f] $/00 /; s/ $//" > $PROGMEM.hex
|
|
|
|
# (5)
|
|
echo " progmem.sh (5) - preparing string data" >&2
|
|
#convert $PROGMEM.hex to $PROGMEM.chr (prepare string data for character check and conversion)
|
|
# replace first space with tab
|
|
# replace second and third space with tab and space
|
|
# replace all remaining spaces with '\x'
|
|
# replace all tabs with spaces
|
|
cat $PROGMEM.hex | sed 's/ /\t/;s/ /\t /;s/ /\\x/g;s/\t/ /g' > $PROGMEM.chr
|
|
|
|
# (6)
|
|
#convert $PROGMEM.chr to $PROGMEM.var (convert data to text)
|
|
echo " progmem.sh (6) - converting string data" >&2
|
|
(\
|
|
echo "/bin\/echo -e \\"; \
|
|
cat $PROGMEM.chr | \
|
|
sed 's/ \\xff\\xff/ /;' | \
|
|
sed 's/\\x22/\\\\\\x22/g;' | \
|
|
sed 's/\\x1b/\\\\\\x1b/g;' | \
|
|
sed 's/\\x01/\\\\\\x01/g;' | \
|
|
sed 's/\\xf8/\\\\\\xf8/g;' | \
|
|
sed 's/\\x0a/\\\\\\x0a/g;' | \
|
|
sed 's/\\x04/\\\\\\x04/g;' | \
|
|
sed 's/\\xe4/\\\\\\xe4/g;' | \
|
|
sed 's/\\n/\\\\\\0a/g;' | \
|
|
sed 's/\\x00$/\n/;s/^/\"/;s/$/\"\\/'; \
|
|
) | sh > $PROGMEM.var
|
|
|
|
#this step can be omitted because .txt file is not used
|
|
cat $PROGMEM.var | sed 's/\r/\n/g' | sed -E 's/^[0-9a-f]{8} [^ ]* //' >$PROGMEM.txt
|
|
|
|
echo "$(tput setaf 2)progmem.sh finished$(tput sgr0)" >&2
|
|
|
|
exit 0
|