ST-LINK: Difference between revisions

Latest revision as of 14:53, 12 December 2019↑

This article describes the ST-LINK hardware probes.

1. Introduction[edit source]↑

The ST-LINK^[1] is an in-circuit debugger and programmer for the STM8 and STM32 microcontroller families.

ST-LINK is a USB device and has to be connected to a PC host. It can be either embedded on ST boards or provided as standalone dongle.

ST-LINK can support different debug protocols depending on ST-LINK hardware version and on its embedded firmware version:

SWIM: debug protocol for STM8 microcontrollers
SWD/JTAG: debug protocol for STM32 microcontrollers and microprocessors

and communication interfaces:

UART
I2C
SPI
CAN
GPIO

2. Hardware versions[edit source]↑

Several versions of ST-LINK exist: ST-LINK/V1^[1], ST-LINK/V2^[2], ST-LINK/V2-A, ST-LINK/V2-B, ST-LINK/V2-1 and STLINK-V3SET^[3].

For details about the different versions, please refer to technical note^[4] of ST-LINK derivatives.

To find out the ST-LINK version that is embedded in your ST board, refer to the Category:STM32 MPU boards page, and then select your hardware board.

3. Getting started[edit source]↑

3.1. Installing the USB driver[edit source]↑

Two USB drivers are associated to ST-LINK, depending of ST-LINK version: one for the debugger itself, and one for the serial communication port from (ST-LINK/V2-1).
The serial communication port uses standard CDC ACM USB Class, which is usually present by default on all PC operating systems. The USB driver for the debugger can differ depending of the PC operating system:

MS Windows®

A driver must be installed before connecting ST-LINK to a Windows® 7, Windows® 7 8, or Windows® 10 PC via the USB.

The driver is automatically installed by the toolsets supporting ST-LINK. It is also available from www.st.com ^[5].

Linux®

Users must be granted with rights for accessing ST-Link USB devices. Rules must then be added into /etc/udev/rules.d.

All information and files for installing the udev rules are provided in the STSW-LINK007^[6] package available from www.st.com (see stsw-link007\AllPlatforms\StlinkRulesFilesForLinux\Readme.txt file).

Mac OS®

No specific installation is required.

3.2. Connecting JTAG/SWD for debugging[edit source]↑

Embedded ST-LINK

A JTAG/SWD link is available from the USB link provided by the ST-LINK. The USB device is mounted on the host PC and ready to be used.

Standalone ST-LINK

Pins are available on the ST-LINK to connect the JTAG/SWD signals. Refer to Hardware versions for connection details.

- JTAG: VCC, JTDI, JTMS, JCLK, JRCLK, JTDO, NRST and GDN signals must be connected to the JTAG/SWD connector.

- SWD: VCC, SWCLK, SWDIO, NRST, SWO and GND signals must be connected to the JTAG/SWD connector (on some ST-LINK hardware version, a dedicated SWD port can also be available).

3.3. Connecting UART port (from ST-LINK/V2-1)[edit source]↑

Embedded ST-LINK

A UART serial port is available from the USB link provided by the ST-LINK. The USB device is mounted on the host PC and ready to be used.

Standalone ST-LINK

Pins are available on the ST-LINK to connect the Rx/Tx and GND signals. Refer to Hardware versions for connection details.

4. To go further[edit source]↑

4.1. Updating the embedded firmware[edit source]↑

All information are given in the STSW-LINK007^[6] software package available from www.st.com.

Warning

The firmware update application embeds the latest firmware version, so do not hesitate to get the latest version of the executable STSW-LINK007^[6] software package

4.2. How to bypass the embedded ST-LINK[edit source]↑

To use a newest version of ST-LINK standalone probe or another debug probe, ST-LINK can be bypassed for ST boards that already embed it.

Deactivating the embedded ST-LINK

Please refer to the board description and schematic for how to put the embedded ST-LINK in reset mode if available.

Bypassing the embedded ST-LINK signals and connecting an external hardware probe

Connect the relevant signals depending on the interface available on the new hardware probe. Please refer to Connecting JTAG/SWD for debug and Connecting UART port for standalone external ST-LINK.

5. References[edit source]↑

[stlink-1] {Jump up to: 1.0} ^1.1 https://www.st.com/en/development-tools/st-link.html

[2] ttps://www.st.com/en/development-tools/st-link-v2.html

[3] ttps://www.st.com/en/development-tools/stlink-v3set.html

[4] ttps://www.st.com/resource/en/technical_note/dm00290229.pdf

[5] ttps://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-utilities/stsw-link009.html

[stswlink007-6] {Jump up to: 6.0} ^6.1 ^6.2 https://my.st.com/content/my_st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-programmers/stsw-link007.html

[1]

[2]

[3]

[4]

[5]

[6]

@@ Line 1: / Line 1: @@
-<noinclude>
-{{ArticleMainWriter | Jean-PhilippeR}}
-{{ArticleProposedVersion | Jean-PhilippeR | Jean-ChristopheT(Not Done), AntonioB(Not Done), SylvainC(Not Done) | No previous approved version | Nobody | 11Feb'19 }}
-[[Category:HW probes]]
-</noinclude>
-'''SUMMARY '''<br/>
 This article describes the ST-LINK hardware probes.
@@ Line 15: / Line 6: @@
 ST-LINK is a USB device and has to be connected to a PC host. It can be either embedded on ST boards or provided as standalone dongle.
-Depending on the version of the ST-LINK hardware and on the version of its embedded firmware, it can support different debug protocols:
+ST-LINK can support different debug protocols depending on ST-LINK hardware version and on its embedded firmware version:
 * SWIM: debug protocol for STM8 microcontrollers
 * SWD/JTAG: debug protocol for STM32 microcontrollers and microprocessors
@@ Line 26: / Line 17: @@
 == Hardware versions ==
-Several versions of ST-LINK exists: ST-LINK/V1<ref name=stlink/>, ST-LINK/V2<ref>https://www.st.com/en/development-tools/st-link-v2.html</ref>, ST-LINK/V2-A, ST-LINK/V2-B, ST-LINK/V2-1 and STLINK-V3SET<ref>https://www.st.com/en/development-tools/stlink-v3set.html</ref>.
+Several versions of ST-LINK exist: ST-LINK/V1<ref name=stlink/>, ST-LINK/V2<ref>https://www.st.com/en/development-tools/st-link-v2.html</ref>, ST-LINK/V2-A, ST-LINK/V2-B, ST-LINK/V2-1 and STLINK-V3SET<ref>https://www.st.com/en/development-tools/stlink-v3set.html</ref>.
-For details about different versions , please refer to the technical note<ref>https://www.st.com/resource/en/technical_note/dm00290229.pdf</ref> of ST-LINK derivatives.
+For details about the different versions, please refer to technical note<ref>https://www.st.com/resource/en/technical_note/dm00290229.pdf</ref> of ST-LINK derivatives.
-To check for the ST-LINK version which is embedded in ST boards, you have to refer to the [[Getting started with ST boards]] page, and then select your current HW board.
+To find out the ST-LINK version that is embedded in your ST board, refer to the [[:Category:STM32 MPU boards]] page, and then select your hardware board.
 == Getting started ==
-=== Installing USB driver ===
+=== Installing the USB driver ===
-Depending of the ST-LINK version, two USB drivers are associated: one for the debugger itself, and one for the serial communication port from ({{highlight|''ST-LINK/V2-1''}}).<br/>
+Two USB drivers are associated to ST-LINK, depending of ST-LINK version: one for the debugger itself, and one for the serial communication port from ({{highlight|''ST-LINK/V2-1''}}).<br/>
-Serial communication port is using standard CDC ACM USB Class, which is usually present by default on all PC operating system.
+The serial communication port uses standard CDC ACM USB Class, which is usually present by default on all PC operating systems.
+The USB driver for the debugger can differ depending of the PC operating system:
-About USB driver for the debugger, this could differ depending of the PC operating system:
 * '''MS Windows&reg;'''
-A driver must be installed before connecting ST-LINK to a Windows&reg; 7, Windows 8, or Windows&reg; 10 PC via the USB.
+A driver must be installed before connecting ST-LINK to a Windows&reg; 7, Windows&reg; 7 8, or Windows&reg; 10 PC via the USB.
-The driver is automatically installed by the toolsets supporting ST-LINK. It is also available from the www.st.com website<ref>https://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-utilities/stsw-link009.html</ref>.
+The driver is automatically installed by the toolsets supporting ST-LINK. It is also available from www.st.com <ref>https://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-utilities/stsw-link009.html</ref>.
 * '''Linux&reg;'''
-Users must be granted with rights for accessing the ST-Link USB devices. It is then necessary to add rules into /etc/udev/rules.d.
+Users must be granted with rights for accessing ST-Link USB devices. Rules must then be added into /etc/udev/rules.d.
-All information and files for installing the udev rules are provided in the '''STSW-LINK007'''<ref name=stswlink007>https://my.st.com/content/my_st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-programmers/stsw-link007.html</ref> package in st.com (see ''stsw-link007\AllPlatforms\StlinkRulesFilesForLinux\Readme.txt'' file).
+All information and files for installing the udev rules are provided in the '''STSW-LINK007'''<ref name=stswlink007>https://my.st.com/content/my_st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-programmers/stsw-link007.html</ref> package available from www.st.com (see ''stsw-link007\AllPlatforms\StlinkRulesFilesForLinux\Readme.txt'' file).
 * '''Mac OS&reg;'''
-No specific install is required.
+No specific installation is required.
-=== Connecting JTAG/SWD for debug ===
+=== Connecting JTAG/SWD for debugging ===
 * Embedded ST-LINK
-JTAG/SWD link is available from the USB link provided by the ST-LINK. USB device is mounted on the host PC, and ready to be used.
+A JTAG/SWD link is available from the USB link provided by the ST-LINK. The USB device is mounted on the host PC and ready to be used.
 * Standalone ST-LINK
-Pins are available on the ST-LINK to connect the JTAG/SWD signals. Please see [[#Hardware versions|Hardware versions]] to check for the connection details.
+Pins are available on the ST-LINK to connect the JTAG/SWD signals. Refer to [[#Hardware versions|Hardware versions]] for connection details.
-:- '''JTAG''': please ensure these signals are connected to the JTAG/SWD connector: VCC, JTDI, JTMS, JCLK, JRCLK, JTDO, NRST and GDN
+:- '''JTAG''': VCC, JTDI, JTMS, JCLK, JRCLK, JTDO, NRST and GDN signals must be connected to the JTAG/SWD connector.
-:- '''SWD''': please ensure these signals are connected to the JTAG/SWD connector (on some ST-LINK hardware version, a dedicated SWD port can be available also): VCC, SWCLK, SWDIO, NRST, SWO and GND.
+:- '''SWD''': VCC, SWCLK, SWDIO, NRST, SWO and GND signals must be connected to the JTAG/SWD connector (on some ST-LINK hardware version, a dedicated SWD port can also be available).
 === Connecting UART port (from {{highlight|''ST-LINK/V2-1''}}) ===
 * Embedded ST-LINK
-UART serial port is available from the USB link provided by the ST-LINK. USB device is mounted on the host PC, and ready to be used.
+A UART serial port is available from the USB link provided by the ST-LINK. The USB device is mounted on the host PC and ready to be used.
 * Standalone ST-LINK
-Pins are available on the ST-LINK to connect the Rx/Tx and GND signals. Please see [[#Hardware versions|Hardware versions]] to check for the connection details.
+Pins are available on the ST-LINK to connect the Rx/Tx and GND signals. Refer to [[#Hardware versions|Hardware versions]] for connection details.
 == To go further ==
-=== Updating embedded firmware ===
+=== Updating the embedded firmware ===
-All information given in the STSW-LINK007<ref name=stswlink007/> software package in st.com.
+All information are given in the STSW-LINK007<ref name=stswlink007/> software package available from www.st.com.
-{{Warning|The firmware update application embeds the latest FW version, so do not hesitate to get latest version of the executable STSW-LINK007<ref name=stswlink007/> software package}}
+{{Warning|The firmware update application embeds the latest firmware version, so do not hesitate to get the latest version of the executable STSW-LINK007<ref name=stswlink007/> software package}}
-=== How to bypass embedded ST-LINK ===
+=== How to bypass the embedded ST-LINK ===
-For ST boards which embed a ST-LINK, it could be useful for user to bypass it, in order to use a newest version of ST-LINK standalone probe, or an other debug probe.
+To use a newest version of ST-LINK standalone probe or another debug probe, ST-LINK can be bypassed for ST boards that already embed it.
-* Deactivate the embedded ST-LINK
+* Deactivating the embedded ST-LINK
-Please refer to the board description and schematic to get the way to put the embedded ST-LINK in reset mode if available.
+Please refer to the board description and schematic for how to put the embedded ST-LINK in reset mode if available.
-* Bypass the embedded ST-LINK signals and connect external hardware probe
+* Bypassing the embedded ST-LINK signals and connecting an external hardware probe
-Following the interface available on the new hardware probe, you have to connect the relevant signals. Please refer to [[#Connecting JTAG/SWD for debug|Connecting JTAG/SWD for debug]] and [[#Connecting UART port (from ST-LINK/V2-1)|Connecting UART port]] for standalone external ST-LINK.
+Connect the relevant signals depending on the interface available on the new hardware probe. Please refer to [[#Connecting JTAG/SWD for debug|Connecting JTAG/SWD for debug]] and [[#Connecting UART port (from ST-LINK/V2-1)|Connecting UART port]] for standalone external ST-LINK.
 == References ==
 <references />
+<noinclude>
+{{PublicationRequestId | 14368| AnneJ| 2019-12-10}}
+[[Category:HW probes]]
+</noinclude>