boards: remove exports of jlink related variables #13567

aabadie · 2020-03-06T07:11:16Z

Contribution description

This PR removes all uses of export with JLink related variables and move the export in jlink.inc.mk. The variables are also now only exported with jlink related targets.

Static tests are also added to prevent future unwanted exports of theses variables.

Testing procedure

Verify that flash, reset, debug still works on affected boards.

nrf52840dk

flash:

$ PROGRAMMER=jlink make BOARD=nrf52840dk -C examples/hello-world --no-print-directory flash
Building application "hello-world" for "nrf52840dk" with MCU "nrf52".

"make" -C /work/riot/RIOT/boards/nrf52840dk
"make" -C /work/riot/RIOT/boards/common/nrf52xxxdk
"make" -C /work/riot/RIOT/core
"make" -C /work/riot/RIOT/cpu/nrf52
"make" -C /work/riot/RIOT/cpu/cortexm_common
"make" -C /work/riot/RIOT/cpu/cortexm_common/periph
"make" -C /work/riot/RIOT/cpu/nrf52/periph
"make" -C /work/riot/RIOT/cpu/nrf5x_common
"make" -C /work/riot/RIOT/cpu/nrf5x_common/periph
"make" -C /work/riot/RIOT/drivers
"make" -C /work/riot/RIOT/drivers/periph_common
"make" -C /work/riot/RIOT/sys
"make" -C /work/riot/RIOT/sys/auto_init
"make" -C /work/riot/RIOT/sys/newlib_syscalls_default
"make" -C /work/riot/RIOT/sys/stdio_uart
   text	   data	    bss	    dec	    hex	filename
   8408	    108	   2564	  11080	   2b48	/work/riot/RIOT/examples/hello-world/bin/nrf52840dk/hello-world.elf
/work/riot/RIOT/dist/tools/jlink/jlink.sh flash /work/riot/RIOT/examples/hello-world/bin/nrf52840dk/hello-world.bin
### Flashing Target ###
### Flashing at base address 0x0 with offset 0 ###
SEGGER J-Link Commander V6.56d (Compiled Dec 12 2019 13:05:00)
DLL version V6.56d, compiled Dec 12 2019 13:04:51

J-Link Commander will now exit on Error

J-Link Command File read successfully.
Processing script file...

J-Link connection not established yet but required for command.
Connecting to J-Link via USB...O.K.
Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Jan  7 2019 14:07:15
Hardware version: V1.00
S/N: 683540885
VTref=3.300V
Target connection not established yet but required for command.
Device "NRF52" selected.


Connecting to target via SWD
InitTarget() start
InitTarget() end
Found SW-DP with ID 0x2BA01477
Scanning AP map to find all available APs
AP[2]: Stopped AP scan as end of AP map has been reached
AP[0]: AHB-AP (IDR: 0x24770011)
AP[1]: JTAG-AP (IDR: 0x02880000)
Iterating through AP map to find AHB-AP to use
AP[0]: Core found
AP[0]: AHB-AP ROM base: 0xE00FF000
CPUID register: 0x410FC241. Implementer code: 0x41 (ARM)
Found Cortex-M4 r0p1, Little endian.
FPUnit: 6 code (BP) slots and 2 literal slots
CoreSight components:
ROMTbl[0] @ E00FF000
ROMTbl[0][0]: E000E000, CID: B105E00D, PID: 000BB00C SCS-M7
ROMTbl[0][1]: E0001000, CID: B105E00D, PID: 003BB002 DWT
ROMTbl[0][2]: E0002000, CID: B105E00D, PID: 002BB003 FPB
ROMTbl[0][3]: E0000000, CID: B105E00D, PID: 003BB001 ITM
ROMTbl[0][4]: E0040000, CID: B105900D, PID: 000BB9A1 TPIU
ROMTbl[0][5]: E0041000, CID: B105900D, PID: 000BB925 ETM
Cortex-M4 identified.
Halting CPU for downloading file.
Downloading file [/work/riot/RIOT/examples/hello-world/bin/nrf52840dk/hello-world.bin]...
Comparing flash   [100%] Done.
Erasing flash     [100%] Done.
Programming flash [100%] Done.
Verifying flash   [100%] Done.
J-Link: Flash download: Bank 0 @ 0x00000000: 1 range affected (12288 bytes)
J-Link: Flash download: Total time needed: 0.464s (Prepare: 0.040s, Compare: 0.004s, Erase: 0.254s, Program: 0.155s, Verify: 0.000s, Restore: 0.008s)
O.K.

Reset delay: 0 ms
Reset type NORMAL: Resets core & peripherals via SYSRESETREQ & VECTRESET bit.
Reset: Halt core after reset via DEMCR.VC_CORERESET.
Reset: Reset device via AIRCR.SYSRESETREQ.



Script processing completed.

reset:

$ PROGRAMMER=jlink make BOARD=nrf52840dk -C examples/hello-world --no-print-directory reset
/work/riot/RIOT/dist/tools/jlink/jlink.sh reset
### Resetting Target ###
SEGGER J-Link Commander V6.56d (Compiled Dec 12 2019 13:05:00)
DLL version V6.56d, compiled Dec 12 2019 13:04:51

J-Link Commander will now exit on Error

J-Link Command File read successfully.
Processing script file...

J-Link connection not established yet but required for command.
Connecting to J-Link via USB...O.K.
Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Jan  7 2019 14:07:15
Hardware version: V1.00
S/N: 683540885
VTref=3.300V
Target connection not established yet but required for command.
Device "NRF52" selected.


Connecting to target via SWD
InitTarget() start
InitTarget() end
Found SW-DP with ID 0x2BA01477
Scanning AP map to find all available APs
AP[2]: Stopped AP scan as end of AP map has been reached
AP[0]: AHB-AP (IDR: 0x24770011)
AP[1]: JTAG-AP (IDR: 0x02880000)
Iterating through AP map to find AHB-AP to use
AP[0]: Core found
AP[0]: AHB-AP ROM base: 0xE00FF000
CPUID register: 0x410FC241. Implementer code: 0x41 (ARM)
Found Cortex-M4 r0p1, Little endian.
FPUnit: 6 code (BP) slots and 2 literal slots
CoreSight components:
ROMTbl[0] @ E00FF000
ROMTbl[0][0]: E000E000, CID: B105E00D, PID: 000BB00C SCS-M7
ROMTbl[0][1]: E0001000, CID: B105E00D, PID: 003BB002 DWT
ROMTbl[0][2]: E0002000, CID: B105E00D, PID: 002BB003 FPB
ROMTbl[0][3]: E0000000, CID: B105E00D, PID: 003BB001 ITM
ROMTbl[0][4]: E0040000, CID: B105900D, PID: 000BB9A1 TPIU
ROMTbl[0][5]: E0041000, CID: B105900D, PID: 000BB925 ETM
Cortex-M4 identified.
Reset delay: 0 ms
Reset type NORMAL: Resets core & peripherals via SYSRESETREQ & VECTRESET bit.
Reset: Halt core after reset via DEMCR.VC_CORERESET.
Reset: Reset device via AIRCR.SYSRESETREQ.



Script processing completed.

debug:

$ PROGRAMMER=jlink make BOARD=nrf52840dk -C examples/hello-world --no-print-directory debug
/work/riot/RIOT/dist/tools/jlink/jlink.sh debug /work/riot/RIOT/examples/hello-world/bin/nrf52840dk/hello-world.elf
### Starting Debugging ###
SEGGER J-Link GDB Server V6.56d Command Line Version

JLinkARM.dll V6.56d (DLL compiled Dec 12 2019 13:04:51)

Command line: -device nrf52 -speed 2000 -if SWD -port 3333 -telnetport 4444
-----GDB Server start settings-----
GDBInit file:                  none
GDB Server Listening port:     3333
SWO raw output listening port: 2332
Terminal I/O port:             4444
Accept remote connection:      yes
Generate logfile:              off
Verify download:               off
Init regs on start:            off
Silent mode:                   off
Single run mode:               off
Target connection timeout:     0 ms
------J-Link related settings------
J-Link Host interface:         USB
J-Link script:                 none
J-Link settings file:          none
------Target related settings------
Target device:                 nrf52
Target interface:              SWD
Target interface speed:        2000kHz
Target endian:                 little

Connecting to J-Link...
Reading symbols from /work/riot/RIOT/examples/hello-world/bin/nrf52840dk/hello-world.elf...
J-Link is connected.
Firmware: J-Link OB-SAM3U128-V2-NordicSemi compiled Jan  7 2019 14:07:15
Hardware: V1.00
S/N: 683540885
Checking target voltage...
Target voltage: 3.30 V
Listening on TCP/IP port 3333
Connecting to target...Remote debugging using :3333
Connected to target
Waiting for GDB connection...Connected to 127.0.0.1
Reading all registers
Read 4 bytes @ address 0x0000089E (Data = 0x4008E8BD)
pm_set_lowest () at /work/riot/RIOT/cpu/cortexm_common/include/cpu.h:177
177	    irq_restore(state);
(gdb) quit
A debugging session is active.

	Inferior 1 [Remote target] will be killed.

Quit anyway? (y or n) EOF [assumed Y]
GDB closed TCP/IP connection

hifive1b

flash:

$ PROGRAMMER=jlink make BOARD=hifive1b -C examples/hello-world --no-print-directory flash
Building application "hello-world" for "hifive1b" with MCU "fe310".

"make" -C /work/riot/RIOT/boards/hifive1b
"make" -C /work/riot/RIOT/core
"make" -C /work/riot/RIOT/cpu/fe310
"make" -C /work/riot/RIOT/cpu/fe310/nano
"make" -C /work/riot/RIOT/cpu/fe310/periph
"make" -C /work/riot/RIOT/cpu/fe310/vendor
"make" -C /work/riot/RIOT/drivers
"make" -C /work/riot/RIOT/drivers/periph_common
"make" -C /work/riot/RIOT/sys
"make" -C /work/riot/RIOT/sys/auto_init
"make" -C /work/riot/RIOT/sys/stdio_uart
   text	   data	    bss	    dec	    hex	filename
   8940	    104	   2408	  11452	   2cbc	/work/riot/RIOT/examples/hello-world/bin/hifive1b/hello-world.elf
/work/riot/RIOT/dist/tools/jlink/jlink.sh flash /work/riot/RIOT/examples/hello-world/bin/hifive1b/hello-world.bin
### Flashing Target ###
### Flashing at base address 0x20010000 with offset 0 ###
SEGGER J-Link Commander V6.56d (Compiled Dec 12 2019 13:05:00)
DLL version V6.56d, compiled Dec 12 2019 13:04:51

J-Link Commander will now exit on Error

J-Link Command File read successfully.
Processing script file...

J-Link connection not established yet but required for command.
Connecting to J-Link via USB...O.K.
Firmware: J-Link OB-K22-SiFive compiled Dec 12 2019 16:26:28
Hardware version: V1.00
S/N: 979001207
VTref=3.300V
Target connection not established yet but required for command.
Device "FE310" selected.


Connecting to target via JTAG
ConfigTargetSettings() start
ConfigTargetSettings() end
TotalIRLen = 5, IRPrint = 0x01
JTAG chain detection found 1 devices:
 #0 Id: 0x20000913, IRLen: 05, Unknown device
Debug architecture:
  RISC-V debug: 0.13
  AddrBits: 7
  DataBits: 32
  IdleClks: 5
Memory access:
  Via system bus: No
  Via ProgBuf: Yes (16 ProgBuf entries)
DataBuf: 1 entries
  autoexec[0] implemented: Yes
Detected: RV32 core
CSR access via abs. commands: No
Temp. halted CPU for NumHWBP detection
HW instruction/data BPs: 8
Support set/clr BPs while running: No
HW data BPs trigger before execution of inst
RISC-V identified.
Halting CPU for downloading file.
Downloading file [/work/riot/RIOT/examples/hello-world/bin/hifive1b/hello-world.bin]...
Comparing flash   [100%] Done.
Erasing flash     [100%] Done.
Programming flash [100%] Done.
Verifying flash   [100%] Done.
J-Link: Flash download: Bank 0 @ 0x20000000: 1 range affected (65536 bytes)
J-Link: Flash download: Total time needed: 0.507s (Prepare: 0.103s, Compare: 0.034s, Erase: 0.146s, Program: 0.169s, Verify: 0.036s, Restore: 0.017s)
O.K.

Reset delay: 0 ms
Reset type Normal: Resets core & peripherals using <ndmreset> bit in <dmcontrol> debug register.



Script processing completed.

reset:

$ PROGRAMMER=jlink make BOARD=hifive1b -C examples/hello-world --no-print-directory reset
/work/riot/RIOT/dist/tools/jlink/jlink.sh reset
### Resetting Target ###
SEGGER J-Link Commander V6.56d (Compiled Dec 12 2019 13:05:00)
DLL version V6.56d, compiled Dec 12 2019 13:04:51

J-Link Commander will now exit on Error

J-Link Command File read successfully.
Processing script file...

J-Link connection not established yet but required for command.
Connecting to J-Link via USB...O.K.
Firmware: J-Link OB-K22-SiFive compiled Dec 12 2019 16:26:28
Hardware version: V1.00
S/N: 979001207
VTref=3.300V
Target connection not established yet but required for command.
Device "FE310" selected.


Connecting to target via JTAG
ConfigTargetSettings() start
ConfigTargetSettings() end
TotalIRLen = 5, IRPrint = 0x01
JTAG chain detection found 1 devices:
 #0 Id: 0x20000913, IRLen: 05, Unknown device
Debug architecture:
  RISC-V debug: 0.13
  AddrBits: 7
  DataBits: 32
  IdleClks: 5
Memory access:
  Via system bus: No
  Via ProgBuf: Yes (16 ProgBuf entries)
DataBuf: 1 entries
  autoexec[0] implemented: Yes
Detected: RV32 core
CSR access via abs. commands: No
Temp. halted CPU for NumHWBP detection
HW instruction/data BPs: 8
Support set/clr BPs while running: No
HW data BPs trigger before execution of inst
RISC-V identified.
Reset delay: 0 ms
Reset type Normal: Resets core & peripherals using <ndmreset> bit in <dmcontrol> debug register.



Script processing completed.

debug:

$ PROGRAMMER=jlink make BOARD=hifive1b -C examples/hello-world --no-print-directory debug
/work/riot/RIOT/dist/tools/jlink/jlink.sh debug /work/riot/RIOT/examples/hello-world/bin/hifive1b/hello-world.elf
### Starting Debugging ###
SEGGER J-Link GDB Server V6.56d Command Line Version

JLinkARM.dll V6.56d (DLL compiled Dec 12 2019 13:04:51)

Command line: -device FE310 -speed 2000 -if JTAG -port 3333 -telnetport 4444
-----GDB Server start settings-----
GDBInit file:                  none
GDB Server Listening port:     3333
SWO raw output listening port: 2332
Terminal I/O port:             4444
Accept remote connection:      yes
Generate logfile:              off
Verify download:               off
Init regs on start:            off
Silent mode:                   off
Single run mode:               off
Target connection timeout:     0 ms
------J-Link related settings------
J-Link Host interface:         USB
J-Link script:                 none
J-Link settings file:          none
------Target related settings------
Target device:                 FE310
Target interface:              JTAG
Target interface speed:        2000kHz
Target endian:                 little

Connecting to J-Link...
Reading symbols from /work/riot/RIOT/examples/hello-world/bin/hifive1b/hello-world.elf...
J-Link is connected.
Firmware: J-Link OB-K22-SiFive compiled Dec 12 2019 16:26:28
Hardware: V1.00
S/N: 979001207
Checking target voltage...
Target voltage: 3.30 V
Listening on TCP/IP port 3333
Connecting to target...
J-Link found 1 JTAG device, Total IRLen = 5
JTAG ID: 0x20000913 (RISC-V)
Remote debugging using :3333
Connected to target
Waiting for GDB connection...Connected to 127.0.0.1
Reading all registers
0x20010820 in pm_set_lowest () at /work/riot/RIOT/cpu/fe310/periph/pm.c:26
26	    __asm__ volatile ("wfi");
(gdb) quit
A debugging session is active.

	Inferior 1 [Remote target] will be killed.

Quit anyway? (y or n) EOF [assumed Y]
GDB closed TCP/IP connection

verify that make term still works with board using stdio_rtt (could not test this)

Issues/PRs references

Related to #10850

leandrolanzieri

Changes look good. I tested on the following boards, and everything works like in current master:

sensebox
ruuvitag (tested RTT terminal)
nrf52dk
slstk3402a

Maybe it would be nice to have further testing before merging.

makefiles/mcuboot.mk

fjmolinas

Good cleanup, there is an unrelated change in here though. @leandrolanzieri provided testing, I think there is no need for testing all the boards and the variables are still exported for all debugger related targets, IMO this is good to go. Please remove the unrelated changes and squash.

fjmolinas · 2020-03-10T11:02:34Z

makefiles/tools/jlink.inc.mk

@@ -12,6 +12,24 @@ RESET_FLAGS ?= reset

 JLINK_SERIAL ?= $(DEBUG_ADAPTER_ID)

+JLINK_IF ?= SWD


why this default value? wasn't the case before

This is the default in jlink.sh:

RIOT/dist/tools/jlink/jlink.sh

Line 70 in 741b9d3

_JLINK_IF=SWD

Missed that thanks.

although why set it again then?

I found it was simpler this way but I'll change that.

fjmolinas

tested:

hifiv1b
nrf52dk
nrf52840dk
slstk3402a

While all connected on the same machine.
ACK! Please squash @aabadie.

This variable is already export in vars.inc.mk

aabadie · 2020-03-10T15:33:18Z

Please squash

Done (this one was not easy!)

aabadie requested a review from fjmolinas as a code owner March 6, 2020 07:11

aabadie force-pushed the pr/boards/jlink_export_cleanup branch 2 times, most recently from c6117da to 3bffd4b Compare March 6, 2020 19:25

aabadie requested review from cgundogan, haukepetersen, leandrolanzieri, MichelRottleuthner, miri64, PeterKietzmann and smlng as code owners March 6, 2020 19:25

aabadie force-pushed the pr/boards/jlink_export_cleanup branch from 3bffd4b to 6cfe1e9 Compare March 7, 2020 19:56

aabadie mentioned this pull request Mar 9, 2020

boards/pyocd: cleanup use of export keyword #13593

Merged

leandrolanzieri reviewed Mar 9, 2020

View reviewed changes

fjmolinas reviewed Mar 10, 2020

View reviewed changes

makefiles/mcuboot.mk Outdated Show resolved Hide resolved

fjmolinas reviewed Mar 10, 2020

View reviewed changes

fjmolinas self-assigned this Mar 10, 2020

aabadie force-pushed the pr/boards/jlink_export_cleanup branch from 6cfe1e9 to 1b0b2c2 Compare March 10, 2020 11:49

fjmolinas approved these changes Mar 10, 2020

View reviewed changes

aabadie added 13 commits March 10, 2020 16:28

makefiles/jlink: only export JLINK_DEVICE when required

40e754c

boards: unexport JLINK_DEVICE variable

1e9879f

ci/buildsystem_check: ensure JLINK_DEVICE is not exported

9c2e5c9

makefiles/jlink: export JLINK_IF to required targets

04d32e9

boards: don't export JLINK_IF

8400589

ci/buildsystem_check: ensure JLINK_IF is not exported

c586db5

makefiles/jlink: export JLINK_RESET_FILE to required targets

5458f4d

boards/openmote-b: don't export JLINK_RESET_FILE

92bbe75

ci/buildsystem_check: force no export of JLINK_RESET_FILE

5e85994

boards: don't export FLASH_ADDR

8489a0a

This variable is already export in vars.inc.mk

makefiles/jlink: export JLINK_PRE_FLASH to flash targets

6560a1f

boards: don't export JLINK_PRE_FLASH

c49ad27

ci/buildsystem_check: force no export of JLINK_PRE_FLASH

ad5b9d7

aabadie force-pushed the pr/boards/jlink_export_cleanup branch from 8aceb6e to ad5b9d7 Compare March 10, 2020 15:32

fjmolinas merged commit db04522 into RIOT-OS:master Mar 10, 2020

aabadie deleted the pr/boards/jlink_export_cleanup branch March 10, 2020 19:50

leandrolanzieri added this to the Release 2020.04 milestone Mar 13, 2020

crasbe mentioned this pull request Jul 5, 2024

cpu/nrf52: Add Make Option to Enable Pinreset #20775

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

boards: remove exports of jlink related variables #13567

boards: remove exports of jlink related variables #13567

aabadie commented Mar 6, 2020

leandrolanzieri left a comment

fjmolinas left a comment

fjmolinas Mar 10, 2020

aabadie Mar 10, 2020

fjmolinas Mar 10, 2020

fjmolinas Mar 10, 2020

aabadie Mar 10, 2020

aabadie Mar 10, 2020

fjmolinas left a comment

aabadie commented Mar 10, 2020

		@@ -12,6 +12,24 @@ RESET_FLAGS ?= reset

		JLINK_SERIAL ?= $(DEBUG_ADAPTER_ID)

		JLINK_IF ?= SWD

boards: remove exports of jlink related variables #13567

boards: remove exports of jlink related variables #13567

Conversation

aabadie commented Mar 6, 2020

Contribution description

Testing procedure

Issues/PRs references

leandrolanzieri left a comment

Choose a reason for hiding this comment

fjmolinas left a comment

Choose a reason for hiding this comment

fjmolinas Mar 10, 2020

Choose a reason for hiding this comment

aabadie Mar 10, 2020

Choose a reason for hiding this comment

fjmolinas Mar 10, 2020

Choose a reason for hiding this comment

fjmolinas Mar 10, 2020

Choose a reason for hiding this comment

aabadie Mar 10, 2020

Choose a reason for hiding this comment

aabadie Mar 10, 2020

Choose a reason for hiding this comment

fjmolinas left a comment

Choose a reason for hiding this comment

aabadie commented Mar 10, 2020