Difference between revisions of "UM08001 J-Link / J-Trace User Guide"

From SEGGER Wiki
Jump to: navigation, search
Line 2: Line 2:
 
This manual documents the software which with the J-Link Software and Documentation Package as well as advanced features of J-Link and J-Trace, like Real Time Transfer ([[RTT | RTT]]), J-Link Script Files or Trace.
 
This manual documents the software which with the J-Link Software and Documentation Package as well as advanced features of J-Link and J-Trace, like Real Time Transfer ([[RTT | RTT]]), J-Link Script Files or Trace.
   
'''Note''': This wiki page is work in progress. Until this wiki page is finished, please refer to [https://www.segger.com/downloads/jlink/UM08001 UM08001.pdf].
+
'''Note''': This wiki page is work in progress. Until this wiki page is finished, please refer to [https://www.segger.com/downloads/jlink/UM08001 UM08001.pdf] for additional information.
   
  +
<div class="toclimit-2">
 
__TOC__
 
__TOC__
  +
</div>
 
'''J-Link User Guide'''
 
   
 
= J-Link software and documentation package =
 
= J-Link software and documentation package =
   
  +
This Section describes the contents of the J-Link Software and Documentation Pack, available for download on the [https://www.segger.com/downloads/jlink#J-LinkSoftwareAndDocumentationPack SEGGER homepage].
== Software overview ==
 
   
  +
== Software overview ==
 
The J-Link Software and Documentation Package, which is available for download from [https://www.segger.com/jlink-software.html segger.com], includes some applications to be used with J-Link. <br>
 
The J-Link Software and Documentation Package, which is available for download from [https://www.segger.com/jlink-software.html segger.com], includes some applications to be used with J-Link. <br>
It also comes with USB-drivers for J-Link and documentations in pdf format.
+
It also comes with USB-drivers for J-Link and documentations in PDF format.
   
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Software !! Description
+
! Software !! Description
 
|-
 
|-
| [[J-Link_Commander | J-Link Commander]] || Command-line tool with basic functionality for target analysis.
+
| [[J-Link Commander]] || Command-line tool with basic functionality for target analysis.
 
|-
 
|-
| J-Link GDB Server || The J-Link GDB Server is a server connecting to the GNU Debugger (GDB) via TCP/IP. <br> It is required for toolchains using the GDB protocol to connect to J-Link.
+
| [[J-Link GDB Server]] || The J-Link GDB Server is a server connecting to the GNU Debugger (GDB) via TCP/IP. It is required for toolchains using the GDB protocol to connect to J-Link.
 
|-
 
|-
| J-Link GDB Server command line version || Command line version of the J-Link GDB Server. Same functionality as the GUI version.
+
| [[J-Link GDB Server#J-Link GDB Server CL | J-Link GDB Server CL]] || Command line version of the J-Link GDB Server. Same functionality as the GUI version.
 
|-
 
|-
| [[J-Link_Remote_Server | J-Link Remote Server]] || Utility which provides the possibility to use J-Link / J-Trace remotely via TCP/IP.
+
| [[J-Link Remote Server]] || Utility which provides the possibility to use J-Link / J-Trace remotely via TCP/IP.
 
|-
 
|-
| J-Mem || Target memory viewer. Shows the memory content of a running target and allows editing as well.
+
| [[J-Mem]] || Target memory viewer. Shows the memory content of a running target and allows editing as well.
 
|-
 
|-
| [[J-Flash | J-Flash]] <sup>[1]</sup> || Stand-alone flash programming application. <br> For more information about J-Flash please refer to [[UM08003 | J-Flash ARM User’s Guide (UM08003)]].
+
| [[J-Flash]]<sup>1</sup> || Stand-alone flash programming application.
 
|-
 
|-
| J-Flash Lite || Stand-alone flash programming application. Reduced feature set of J-Flash.
+
| [[J-Flash Lite]] || Stand-alone flash programming application with reduced feature set of J-Flash.
 
|-
 
|-
| J-Link RTT Viewer || Free-of-charge utility for J-Link. Displays the terminal output of the target using [[RTT | RTT]]. <br> Can be used in parallel with a debugger or stand-alone.
+
| [[J-Link RTT Viewer]] || Displays the terminal output of the target using [[RTT]]. Can be used in parallel with a debugger or stand-alone.
 
|-
 
|-
| J-Link SWO Viewer || Free-of-charge utility for J-Link. Displays the terminal output of the target using the SWO pin. <br> Can be used in parallel with a debugger or stand-alone.
+
| [[J-Link SWO Viewer]] || Displays the terminal output of the target using the SWO pin. Can be used in parallel with a debugger or stand-alone.
 
|-
 
|-
| J-Link SWO Analyzer || Command line tool that analyzes SWO RAW output and stores it into a file.
+
| [[J-Link SWO Analyzer]] || Command line tool that analyzes SWO RAW output and stores it into a file.
 
|-
 
|-
| JTAGLoad || Command line tool that opens an svf file and sends the data init via J-Link / J-Trace to the target.
+
| [[JTAGLoad]] || Command line tool that opens an svf file and sends the data in it via J-Link / J-Trace to the target.
 
|-
 
|-
| J-Link Configurator || GUI-based configuration tool for J-Link. Allows configuration of USB identification as well as TCP/IP identification of J-Link.
+
| [[J-Link Configurator]] || GUI-based configuration tool for J-Link. Allows configuration of USB identification as well as TCP/IP identification of J-Link debug probes.
 
|-
 
|-
| RDI support<sup>[1]</sup> || Provides Remote Debug Interface (RDI) support. This allows the user to use J-Link with any RDI-compliant debugger.
+
|| RDI support (JLinkRDI.dll)<sup>1</sup> || Provides Remote Debug Interface (RDI) support. This allows the user to use J-Link with any RDI-compliant debugger.
 
|-
 
|-
| Processor specific tools || Free command-line tools for handling specific processors. Included are: STR9 Commander and STM32 Unlock.
+
|| [[J-Link STR91x Commander]] || Command line tool for handling specific STR91x processors.
  +
|-
  +
|| [[J-Link STM32 Unlock]] || Command line tool for handling specific STM32 processors.
  +
|-
  +
|| [[J-Run]] || Command line utility for automated tests.
 
|}
 
|}
  +
<sup>1</sup>: Full-featured J-Link (PLUS, PRO, ULTRA+) or an additional license for J-Link Base model required.
   
  +
== Troubleshooting ==
<sup>1</sup>: Full-featured J-Link (PLUS, PRO, ULTRA+) or an additional license for J-Link base model
 
  +
If you have troubles downloading or installing the J-Link Software and Documentation pack, please refer to the following section.
required.
 
 
== JRun ==
 
TBD
 
   
=== Command line options ===
+
=== Windows Defender under Windows 10 ===
  +
For some versions of the J-Link Software Pack, Windows Defender under Windows 10 triggered a false positive alarm for "Trojan:Win32/Tulim.C!plock" which disabled the download of the software package. This has been recently fixed by Microsoft via new virus definitions. Please make sure that Windows Defender virus definitions are up to date when downloading the package and are at least at the following version:
TBD
 
  +
Antivirus definition: 1.213.5588.0
   
 
= Working with J-Link and J-Trace =
 
= Working with J-Link and J-Trace =

Revision as of 14:13, 28 May 2020

This is the user documentation for owners of SEGGER debug probes, J-Link and J-Trace. This manual documents the software which with the J-Link Software and Documentation Package as well as advanced features of J-Link and J-Trace, like Real Time Transfer ( RTT), J-Link Script Files or Trace.

Note: This wiki page is work in progress. Until this wiki page is finished, please refer to UM08001.pdf for additional information.

J-Link software and documentation package

This Section describes the contents of the J-Link Software and Documentation Pack, available for download on the SEGGER homepage.

Software overview

The J-Link Software and Documentation Package, which is available for download from segger.com, includes some applications to be used with J-Link.
It also comes with USB-drivers for J-Link and documentations in PDF format.

Software Description
J-Link Commander Command-line tool with basic functionality for target analysis.
J-Link GDB Server The J-Link GDB Server is a server connecting to the GNU Debugger (GDB) via TCP/IP. It is required for toolchains using the GDB protocol to connect to J-Link.
J-Link GDB Server CL Command line version of the J-Link GDB Server. Same functionality as the GUI version.
J-Link Remote Server Utility which provides the possibility to use J-Link / J-Trace remotely via TCP/IP.
J-Mem Target memory viewer. Shows the memory content of a running target and allows editing as well.
J-Flash1 Stand-alone flash programming application.
J-Flash Lite Stand-alone flash programming application with reduced feature set of J-Flash.
J-Link RTT Viewer Displays the terminal output of the target using RTT. Can be used in parallel with a debugger or stand-alone.
J-Link SWO Viewer Displays the terminal output of the target using the SWO pin. Can be used in parallel with a debugger or stand-alone.
J-Link SWO Analyzer Command line tool that analyzes SWO RAW output and stores it into a file.
JTAGLoad Command line tool that opens an svf file and sends the data in it via J-Link / J-Trace to the target.
J-Link Configurator GUI-based configuration tool for J-Link. Allows configuration of USB identification as well as TCP/IP identification of J-Link debug probes.
RDI support (JLinkRDI.dll)1 Provides Remote Debug Interface (RDI) support. This allows the user to use J-Link with any RDI-compliant debugger.
J-Link STR91x Commander Command line tool for handling specific STR91x processors.
J-Link STM32 Unlock Command line tool for handling specific STM32 processors.
J-Run Command line utility for automated tests.

1: Full-featured J-Link (PLUS, PRO, ULTRA+) or an additional license for J-Link Base model required.

Troubleshooting

If you have troubles downloading or installing the J-Link Software and Documentation pack, please refer to the following section.

Windows Defender under Windows 10

For some versions of the J-Link Software Pack, Windows Defender under Windows 10 triggered a false positive alarm for "Trojan:Win32/Tulim.C!plock" which disabled the download of the software package. This has been recently fixed by Microsoft via new virus definitions. Please make sure that Windows Defender virus definitions are up to date when downloading the package and are at least at the following version: Antivirus definition: 1.213.5588.0

Working with J-Link and J-Trace

J-Link WiFi setup

J-Link WiFi can be set up in multiple ways.

1) Using J-Link Commander:

  • Connect J-Link WiFi to your computer via USB
  • Start J-Link Commander (JLink.exe)
  • Set up the SSID of your wireless network with the following command: SetWifi SSID <your_wifi_ssid>
  • Set up the password to your wireleass network with the following command: SetWifi Pass <your_wifi_password>
  • After a few seconds, J-Link WiFi should be connected to your wireless network (the green WiFi LED should be always on).

To get the IP address:

  • After performing the steps listed above, issue the following command in J-Link Commander: USB
  • J-Link WiFi will reconnect via USB and provide its IP address, e.g.: IP-Addr: 10.1.1.114 (DHCP)
  • When connecting to J-Link WiFi later on via IP, use this IP address to establish the connection

2) Using J-Link Configurator:

  • Connect J-Link WiFi to your computer via USB
  • Start J-Link Configurator (JLinkConfig.exe)
  • Right-click on the J-Link WiFi in the list of connected J-Links and select 'Configure'
  • In the WiFi configuration section, enter the SSID and the password of your wireless network
  • Click OK
  • Unplug and reconnect your J-Link WiFi
  • Click OK
  • After a few seconds, J-Link WiFi should be connected to your wireless network (the green WiFi LED should be always on).

To get the IP address:

  • Start J-Link Commander (JLink.exe)
  • J-Link WiFi will connect via USB and provide its IP address, e.g.: IP-Addr: 10.1.1.114 (DHCP)
  • When connecting to J-Link WiFi later on via IP, use this IP address to establish the connection

J-Link WiFi in J-Link Configurator

JLink WiFi will only be shown in the Configurator if connected via USB. This is because the Configurator uses UDP broadcast packets to find J-Links in the network. However, most routers have UDP broadcast and UDP multicast packets disabled for WiFi networks.

JTAG interface

Determining values for scan chain configuration

TBD

J-Link script files

TBD

Semihosting

TBD

Enabling semihosting in J-Link GDBServer

TBD