boards: board<->debugger separation #7686

jnohlgard · 2017-10-06T13:42:39Z

The main goal of this PR is to reduce code duplication (look how many openocd.cfg files are almost identical in the repo). The unification of the debugger interface Makefiles will also make the debugger selection via USB serial number string available to all boards, instead of having different kludges in each board Makefile.
A secondary goal is to allow using any supported debug interface adapter (JTAG/SWD adapters etc.) to debug any supported board. This is especially useful when working with custom boards without integrated debug adapter or development boards which are installed in things where the original debug adapter connection (USB port) is physically inaccessible, but a JTAG header is available.

New environment variables for selecting debug adapter:

DEBUG_ADAPTER: select which type of debugger should be used for flash programming and for debugging
DEBUG_ADAPTER_ID: Use this identification to select which programmer to use when more than one device is connected to the same host machine. This is usually the USB serial number, found from list-ttys.sh or lsusb -v, but it is implementation specific to each debug adapter type.

~~So far only Segger J-Link, CMSIS DAP, and Eistec Mulle are supported via the DEBUG_ADAPTER_ID selection~~

TODO:

ST-Link adapter configuration
...

~~Depends on #7685~~

Testing status:

jnohlgard · 2017-10-08T06:27:03Z

Refactored USB serial handling for the edbg tool to match openocd

jnohlgard · 2017-10-11T15:16:31Z

All board Makefiles updated
All Nucleo OpenOCD configurations merged
Fixed some typos
Removed adapter configuration from all OpenOCD configurations

jnohlgard · 2017-10-13T08:49:26Z

I would very much like this PR to be merged early in the next release cycle to avoid having to rebase this for every new board`that is added during the cycle. @kYc0o Do you think you will have time to review this during next two weeks?

kYc0o · 2017-10-13T10:10:39Z

Yes! I need it for my OTA stuff, expect a review very soon!

jnohlgard · 2017-10-19T14:14:19Z

rebased after dependency was merged

kYc0o · 2017-10-19T16:34:32Z

Thanks for rebasing.

I think the commit list is quite long. Can you maybe add only one commit for all the boards? The change is the same so I think a commit is enough and self-explanatory.

kYc0o

Well this seems to improve the situation mostly for "common" boards, like nucleo or kinetis. However I don't see too much improvement when the files were moved (and simplified, that's nice) from the board directory to the common one.

Is there maybe a way to get rid completely of the config files and (even if it's somehow ugly) unify the definitions in a single file?

kYc0o · 2017-10-19T16:43:12Z

boards/msbiot/dist/openocd.cfg

+
+source [find target/stm32f4x.cfg]
+
+reset_config srst_only


Can you explain this change?

I copied the stm32f4discovery board configuration and stripped the interface configuration.
http://repo.or.cz/openocd.git/blob/refs/heads/master:/tcl/board/stm32f4discovery.cfg

Unfortunately I don't have the board to test it, but I observed this change somewhere else. I will try to test it.

The stm32 discovery boards have the same kind of change, if you have any of those?

kYc0o · 2017-10-19T17:03:17Z

dist/tools/openocd/openocd.sh

-    sh -c "${OPENOCD} -f '${OPENOCD_CONFIG}' \
+    sh -c "${OPENOCD} \
+            ${OPENOCD_ADAPTER_INIT} \
+            -f '${OPENOCD_CONFIG}' \


Isn't possible to factorise these 3 repeated commands?

hmm, I don't see the benefit of concatenating three variables into one when it's only in 3-4 places. It would make the script less readable though in my opinion.

kYc0o · 2017-10-19T17:05:30Z

makefiles/tools/edbg.inc.mk

@@ -3,6 +3,14 @@ EDBG ?= $(RIOT_EDBG)
 FLASHER ?= $(EDBG)
 OFLAGS ?= -O binary
 HEXFILE = $(ELFFILE:.elf=.bin)


Haven't this already been fixed in the previous PR? Or it was only done for OpenOCD?

oops, this should be IMAGE_FILE

hmm, actually, it's still HEXFILE because that is the target of the OBJCOPY make rule

I see, it's just that it looks wrong and needs to be fixed. I wouldn't mind to fix it in this PR but if you prefer it can be a following PR.

I would prefer to keep this PR focused on separating the openocd configuration from the board Makefiles and do any other improvements in separate pulls.

jnohlgard · 2017-10-20T12:47:46Z

It would be possible to remove the configuration files completely for some of the boards by introducing something at the CPU level for a default basic config. Some boards may need some more elaborate configuration so it won't eliminate them completely.
I suggest we do that in a separate PR though, to keep this one clean and to the point.

jnohlgard · 2017-11-07T12:08:30Z

ping @kYc0o
Do you have any of the st-link boards available?

kYc0o · 2017-11-07T13:03:42Z

Oops, sorry, this slipped in the queue. Yes, I have some ST-Link boards, I'll test asap.

kYc0o · 2017-11-07T16:43:34Z

I guess testing most of the adaptors should be enough?

jnohlgard · 2017-11-07T16:58:47Z

Yes, I don't think we need to test all boards for this.

kYc0o · 2017-11-07T18:42:34Z

For mulle I have this:

embedded:startup.tcl:60: Error: Can't find /Users/facosta/git/RIOT2/RIOT/board/mulle/dist/openocd/mulle-programmer-0.70.cfg

Otherwise I still don't like the things about HEXFILE. When I use JLink I have this:

### Flashing Target ###
### Flashing at address 0x0 ###
HEXFILE found

which should use an ELF file...

jnohlgard · 2017-11-10T09:52:11Z

@kYc0o fixed typo in the openocd config file name for mulle. Will test this PR with actual mulle programmer hardware later today.

jnohlgard · 2017-11-10T09:53:57Z

@kYc0o this PR does not touch the jlink.sh script (JLinkGDBServer launcher), it only touches the boards which use a jlink adapter with openocd.sh.

jnohlgard · 2017-11-10T09:58:14Z

@kYc0o A suggestion for a future improvement is to implement some kind of debug tool selection, like DEBUG_TOOL=openocd for using openocd.sh or DEBUG_TOOL=jlink for JLinkGDBServer. Others are also possible, like DEBUG_TOOL=avrdude. But this PR is large enough already in my opinion, and I don't have any experience with those other tools, only openocd.

kYc0o · 2017-11-15T18:39:21Z

Tested and working on mulle.

kYc0o

ACK. Please squash.

jnohlgard · 2017-11-15T19:12:00Z

squashed, need to check if there have been any new boards since last rebase..

jnohlgard · 2017-11-15T19:16:03Z

Added a config change for the bluepill board which was added after this PR was opened.

kYc0o · 2017-11-16T15:14:22Z

makefiles/tools/openocd-adapters/mulle.inc.mk

+# programmer board serial number.
+
+# Fall back to PROGRAMMER_SERIAL for backwards compatibility
+export DEBUG_ADAPTER_ID ?= $(PROGRAMMER_SERIAL)


I don't know if for this just an announce that it changed would be enough... but let's keep it for now...

kYc0o · 2017-11-16T15:16:13Z

Murdock agreed, please squash again.

Attempt to decouple board configuration from debugger interface configuration by specifying the DEBUG_IFACE variable for the debug hardware interface to use.

jnohlgard · 2017-11-17T09:04:15Z

squashed

kYc0o · 2017-11-17T12:48:00Z

Excellent! Then go!

jnohlgard assigned kYc0o Oct 6, 2017

jnohlgard mentioned this pull request Oct 6, 2017

mulle: Remove second flash bank declaration from OpenOCD configuration #7673

Merged

kYc0o mentioned this pull request Oct 6, 2017

openocd: Refactor openocd.sh script #7685

Merged

jnohlgard added the State: WIP State: The PR is still work-in-progress and its code is not in its final presentable form yet label Oct 6, 2017

jnohlgard force-pushed the pr/board-debugger-separation branch 2 times, most recently from 891fec2 to 4df35d2 Compare October 8, 2017 06:17

jnohlgard mentioned this pull request Oct 8, 2017

makefiles: Provide USB UART device serial number matching #7695

Closed

jnohlgard force-pushed the pr/board-debugger-separation branch 2 times, most recently from 44294cd to cd9bb85 Compare October 11, 2017 13:53

jnohlgard added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Oct 11, 2017

jnohlgard added the State: waiting for other PR State: The PR requires another PR to be merged first label Oct 11, 2017

jnohlgard force-pushed the pr/board-debugger-separation branch from a34a166 to a09c3ef Compare October 13, 2017 08:39

jnohlgard added Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR and removed State: WIP State: The PR is still work-in-progress and its code is not in its final presentable form yet labels Oct 13, 2017

jnohlgard changed the title ~~[WIP] boards: board<->debugger separation~~ RFC: boards: board<->debugger separation Oct 13, 2017

jnohlgard force-pushed the pr/board-debugger-separation branch 2 times, most recently from 81c5d3e to 47a2acc Compare October 19, 2017 14:13

jnohlgard removed the State: waiting for other PR State: The PR requires another PR to be merged first label Oct 19, 2017

kYc0o requested changes Oct 19, 2017

View reviewed changes

jnohlgard removed the Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR label Nov 7, 2017

jnohlgard changed the title ~~RFC: boards: board<->debugger separation~~ boards: board<->debugger separation Nov 7, 2017

jnohlgard force-pushed the pr/board-debugger-separation branch from 34eee31 to 89b1214 Compare November 10, 2017 09:51

jnohlgard force-pushed the pr/board-debugger-separation branch 2 times, most recently from 6bbd902 to c045198 Compare November 13, 2017 13:58

kYc0o approved these changes Nov 15, 2017

View reviewed changes

jnohlgard force-pushed the pr/board-debugger-separation branch from c045198 to 6ccbf07 Compare November 15, 2017 19:11

kYc0o reviewed Nov 16, 2017

View reviewed changes

Joakim Nohlgård added 3 commits November 17, 2017 10:03

makefiles: Refactor openocd tool handling

57de166

Attempt to decouple board configuration from debugger interface configuration by specifying the DEBUG_IFACE variable for the debug hardware interface to use.

edbg: Use DEBUG_ADAPTER_ID to select which USB programmer to use

697f0b0

boards: Separate boards from debug adapter configuration

f4e9cad

jnohlgard force-pushed the pr/board-debugger-separation branch from 2d90c52 to f4e9cad Compare November 17, 2017 09:03

kYc0o merged commit 3ec7ca4 into RIOT-OS:master Nov 17, 2017

haukepetersen mentioned this pull request Nov 17, 2017

cpu+board: Add support for NXP Kinetis KW41Z and FRDM-KW41Z development board #6995

Merged

kYc0o mentioned this pull request Nov 17, 2017

boards: add initial support for ST b-l475e-iot01a #7584

Merged

jnohlgard deleted the pr/board-debugger-separation branch November 28, 2017 10:42

boards: board<->debugger separation #7686

boards: board<->debugger separation #7686

Uh oh!

Conversation

jnohlgard commented Oct 6, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jnohlgard commented Oct 8, 2017

Uh oh!

jnohlgard commented Oct 11, 2017

Uh oh!

jnohlgard commented Oct 13, 2017

Uh oh!

kYc0o commented Oct 13, 2017

Uh oh!

jnohlgard commented Oct 19, 2017

Uh oh!

kYc0o commented Oct 19, 2017

Uh oh!

kYc0o left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jnohlgard commented Oct 20, 2017

Uh oh!

jnohlgard commented Nov 7, 2017

Uh oh!

kYc0o commented Nov 7, 2017

Uh oh!

kYc0o commented Nov 7, 2017

Uh oh!

jnohlgard commented Nov 7, 2017

Uh oh!

kYc0o commented Nov 7, 2017

Uh oh!

jnohlgard commented Nov 10, 2017

Uh oh!

jnohlgard commented Nov 10, 2017

Uh oh!

jnohlgard commented Nov 10, 2017

Uh oh!

kYc0o commented Nov 15, 2017

Uh oh!

kYc0o left a comment

Choose a reason for hiding this comment

Uh oh!

jnohlgard commented Nov 15, 2017

Uh oh!

jnohlgard commented Nov 15, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kYc0o commented Nov 16, 2017

Uh oh!

jnohlgard commented Nov 17, 2017

Uh oh!

kYc0o commented Nov 17, 2017

Uh oh!

Uh oh!

jnohlgard commented Oct 6, 2017 •

edited

Loading