mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2025-01-18 12:52:44 +01:00
dist: added common JLink script for flashing
This commit is contained in:
Hauke Petersen
parent
c78fd9f4ed
commit
4b62a4902f
214
dist/tools/jlink/jlink.sh
vendored
Executable file
214
dist/tools/jlink/jlink.sh
vendored
Executable file
@ -0,0 +1,214 @@
|
||||
#!/bin/sh
|
||||
#
|
||||
# Unified Segger JLink script for RIOT
|
||||
#
|
||||
# This script is supposed to be called from RIOTs make system,
|
||||
# as it depends on certain environment variables. An
|
||||
#
|
||||
# Global environment variables used:
|
||||
# JLINK: JLink command name, default: "JLinkExe"
|
||||
# JLINK_SERVER: JLink GCB server command name, default: "JLinkGDBDerver"
|
||||
# JLINK_DEVICE: Device identifier used by JLink
|
||||
# JLINK_IF: Interface used by JLink, default: "SWD"
|
||||
# JLINK_SPEED: Interface clock speed to use (in kHz), default "2000"
|
||||
# JLINK_FLASH_ADDR: Starting address of the target's flash memory, default: "0"
|
||||
# JLINK_PRE_FLASH: Additional JLink commands to execute before flashing
|
||||
# JLINK_POST_FLASH: Additional JLink commands to execute after flashing
|
||||
#
|
||||
# The script supports the following actions:
|
||||
#
|
||||
# flash: flash a given hex file to the target.
|
||||
# hexfile is expected in ihex format and is pointed to
|
||||
# by BINFILE environment variable
|
||||
#
|
||||
# options:
|
||||
# BINFILE: path to the binary file that is flashed
|
||||
#
|
||||
# debug: starts OpenOCD as GDB server in the background and
|
||||
# connects to the server with the GDB client specified by
|
||||
# the board (DBG environment variable)
|
||||
#
|
||||
# options:
|
||||
# GDB_PORT: port opened for GDB connections
|
||||
# TELNET_PORT: port opened for telnet connections
|
||||
# TUI: if TUI!=null, the -tui option will be used
|
||||
# ELFFILE: path to the ELF file to debug
|
||||
#
|
||||
# debug-server: starts OpenOCD as GDB server, but does not connect to
|
||||
# to it with any frontend. This might be useful when using
|
||||
# IDEs.
|
||||
#
|
||||
# options:
|
||||
# GDB_PORT: port opened for GDB connections
|
||||
# TELNET_PORT: port opened for telnet connections
|
||||
#
|
||||
# reset: triggers a hardware reset of the target board
|
||||
#
|
||||
#
|
||||
# @author Hauke Peteresen <hauke.petersen@fu-berlin.de>
|
||||
|
||||
# default GDB port
|
||||
_GDB_PORT=3333
|
||||
# default telnet port
|
||||
_TELNET_PORT=4444
|
||||
# default JLink command, interface and speed
|
||||
_JLINK=JLinkExe
|
||||
_JLINK_SERVER=JLinkGDBServer
|
||||
_JLINK_IF=SWD
|
||||
_JLINK_SPEED=2000
|
||||
# default starting address of the devices flash memory
|
||||
_FLASH_ADDR=0
|
||||
|
||||
#
|
||||
# a couple of tests for certain configuration options
|
||||
#
|
||||
test_config() {
|
||||
|
||||
if [ -z "${HEXFILE}" ]; then
|
||||
echo "no hexfile"
|
||||
else
|
||||
echo "HEXFILE found"
|
||||
fi
|
||||
|
||||
if [ -z "${JLINK}" ]; then
|
||||
JLINK=${_JLINK}
|
||||
fi
|
||||
if [ -z "${JLINK_SERVER}" ]; then
|
||||
JLINK_SERVER=${_JLINK_SERVER}
|
||||
fi
|
||||
if [ -z "${JLINK_IF}" ]; then
|
||||
JLINK_IF=${_JLINK_IF}
|
||||
fi
|
||||
if [ -z "${JLINK_SPEED}" ]; then
|
||||
JLINK_SPEED=${_JLINK_SPEED}
|
||||
fi
|
||||
if [ -z "${JLINK_DEVICE}" ]; then
|
||||
echo "Error: No target device defined in JLINK_DEVICE env var"
|
||||
exit 1
|
||||
fi
|
||||
if [ -z "${JLINK_FLASH_ADDR}" ]; then
|
||||
JLINK_FLASH_ADDR=${_FLASH_ADDR}
|
||||
fi
|
||||
}
|
||||
|
||||
test_hexfile() {
|
||||
if [ ! -f "${HEXFILE}" ]; then
|
||||
echo "Error: Unable to locate HEXFILE"
|
||||
echo " (${HEXFILE})"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
test_ports() {
|
||||
if [ -z "${GDB_PORT}" ]; then
|
||||
GDB_PORT=${_GDB_PORT}
|
||||
fi
|
||||
if [ -z "${TELNET_PORT}" ]; then
|
||||
TELNET_PORT=${_TELNET_PORT}
|
||||
fi
|
||||
}
|
||||
|
||||
test_elffile() {
|
||||
if [ ! -f "${ELFFILE}" ]; then
|
||||
echo "Error: Unable to locate ELFFILE"
|
||||
echo " (${ELFFILE})"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
test_tui() {
|
||||
if [ -n "${TUI}" ]; then
|
||||
TUI=-tui
|
||||
fi
|
||||
}
|
||||
|
||||
#
|
||||
# now comes the actual actions
|
||||
#
|
||||
do_flash() {
|
||||
test_config
|
||||
test_hexfile
|
||||
# clear any existing contents in burn file
|
||||
/bin/echo -n "" > ${BINDIR}/burn.seg
|
||||
# create temporary burn file
|
||||
if [ ! -z "${JLINK_PRE_FLASH}" ]; then
|
||||
echo "${JLINK_PRE_FLASH}" >> ${BINDIR}/burn.segg
|
||||
fi
|
||||
echo "loadbin ${HEXFILE} ${JLINK_FLASH_ADDR}" >> ${BINDIR}/burn.seg
|
||||
if [ ! -z "${JLINK_POST_FLASH}" ]; then
|
||||
echo "${JLINK_POST_FLASH}" >> ${BINDIR}/burn.seg
|
||||
fi
|
||||
cat ${RIOTBASE}/dist/tools/jlink/reset.seg >> ${BINDIR}/burn.seg
|
||||
# flash device
|
||||
sh -c "${JLINK} -device '${JLINK_DEVICE}' \
|
||||
-speed '${JLINK_SPEED}' \
|
||||
-if '${JLINK_IF}' \
|
||||
-commandfile '${BINDIR}/burn.seg'"
|
||||
}
|
||||
|
||||
do_debug() {
|
||||
test_config
|
||||
test_elffile
|
||||
test_ports
|
||||
test_tui
|
||||
# start the JLink GDB server
|
||||
sh -c "${JLINK_SERVER} -device '${JLINK_DEVICE}' \
|
||||
-speed '${JLINK_SPEED}' \
|
||||
-if '${JLINK_IF}' \
|
||||
-port '${GDB_PORT}' \
|
||||
-telnetport '${TELNET_PORT}'" &
|
||||
# save PID for terminating the server afterwards
|
||||
DBG_PID=$?
|
||||
# connect to the GDB server
|
||||
${DBG} ${TUI} -ex "tar ext :${GDB_PORT}" ${ELFFILE}
|
||||
# clean up
|
||||
kill ${DBG_PID}
|
||||
}
|
||||
|
||||
do_debugserver() {
|
||||
test_ports
|
||||
test_config
|
||||
# start the JLink GDB server
|
||||
sh -c "${JLINK_SERVER} -device '${JLINK_DEVICE}' \
|
||||
-speed '${JLINK_SPEED}' \
|
||||
-if '${JLINK_IF}' \
|
||||
-port '${GDB_PORT}' \
|
||||
-telnetport '${TELNET_PORT}'"
|
||||
}
|
||||
|
||||
do_reset() {
|
||||
test_config
|
||||
# reset the board
|
||||
sh -c "${JLINK} -device '${JLINK_DEVICE}' \
|
||||
-speed '${JLINK_SPEED}' \
|
||||
-if '${JLINK_IF}' \
|
||||
-commandfile '${RIOTBASE}/dist/tools/jlink/reset.seg'"
|
||||
}
|
||||
|
||||
#
|
||||
# parameter dispatching
|
||||
#
|
||||
ACTION="$1"
|
||||
shift # pop $1 from $@
|
||||
|
||||
case "${ACTION}" in
|
||||
flash)
|
||||
echo "### Flashing Target ###"
|
||||
do_flash "$@"
|
||||
;;
|
||||
debug)
|
||||
echo "### Starting Debugging ###"
|
||||
do_debug "$@"
|
||||
;;
|
||||
debug-server)
|
||||
echo "### Starting GDB Server ###"
|
||||
do_debugserver "$@"
|
||||
;;
|
||||
reset)
|
||||
echo "### Resetting Target ###"
|
||||
do_reset "$@"
|
||||
;;
|
||||
*)
|
||||
echo "Usage: $0 {flash|debug|debug-server|reset}"
|
||||
;;
|
||||
esac
|
||||
3
dist/tools/jlink/reset.seg
vendored
Normal file
3
dist/tools/jlink/reset.seg
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
r
|
||||
g
|
||||
exit
|
||||
Loading…
Reference in New Issue
Block a user