Skip to content

Commit a837117

Browse files
danieldegrassenashif
authored andcommitted
doc: flash_debug: fix some issues with probes documentation
Fix a few issues with the probes documentation for NXP boards: - fix references to debug probe type in probes page introduction - add an explicit "Install the host tools" step for the LPC-Link and MCU-Link based debug probe update steps. Signed-off-by: Daniel DeGrasse <[email protected]>
1 parent 470dc3d commit a837117

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

doc/develop/flash_debug/probes.rst

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ and provides a variety of debug host tool options.
2424

2525
Several hardware vendors have their own branded onboard debug probe
2626
implementations: NXP boards may use
27-
`OpenSDA <#opensda-daplink-onboard-debug-probe>`_,
28-
`LPC-Link2 <#lpclink2-jlink-onboard-debug-probe>`_, or
29-
`MCU-Link <#mcu-link-cmsis-onboard-debug-probe>`_, probes depending on
27+
`OpenSDA <#opensda-onboard-debug-probe>`_,
28+
`LPC-Link2 <#lpc-link2-onboard-debug-probe>`_, or
29+
`MCU-Link <#mcu-link-onboard-debug-probe>`_, probes depending on
3030
the microcontroller the debug probe firmware runs on.
3131
ST boards have the `ST-LINK probe <#stlink-v21-onboard-debug-probe>`_. Each
3232
onboard debug probe microcontroller can support one or more types of firmware
@@ -127,7 +127,10 @@ This debug probe is compatible with the following debug host tools:
127127
Once the MCU-Link host tools are installed, the following steps are
128128
required to program the CMSIS-DAP firmware:
129129

130-
1. Put the MCU-Link microcontroller into DFU boot mode by attaching the DFU
130+
1. Make sure the MCU-Link utility is present on your host machine. This can
131+
be done by installing :ref:`linkserver-debug-host-tools`.
132+
133+
#. Put the MCU-Link microcontroller into DFU boot mode by attaching the DFU
131134
jumper then connecting to the USB debug port on the board. This jumper may
132135
also be referred to as the ISP jumper, and will be connected to ``PIO0_5``
133136
on the LPC55S69.
@@ -152,7 +155,10 @@ These probes do not have JLink firmware installed by default, and must be
152155
updated. Once the MCU-Link host tools are installed, the following steps are
153156
required to program the JLink firmware:
154157

155-
1. Put the MCU-Link microcontroller into DFU boot mode by attaching the DFU
158+
1. Make sure the MCU-Link utility is present on your host machine. This can
159+
be done by installing :ref:`linkserver-debug-host-tools`.
160+
161+
#. Put the MCU-Link microcontroller into DFU boot mode by attaching the DFU
156162
jumper then connecting to the USB debug port on the board. This jumper may
157163
also be referred to as the ISP jumper, and will be connected to ``PIO0_5``
158164
on the LPC55S69.
@@ -198,10 +204,12 @@ This debug probe firmware is compatible with the following debug host tools:
198204

199205
- :ref:`linkserver-debug-host-tools`
200206

201-
After installing the LPCScrypt host tools, the firmware may be updated to
202-
use CMSIS-DAP firmware with the following steps:
207+
The probe may be updated to use CMSIS-DAP firmware with the following steps:
203208

204-
1. Put the LPC-Link2 microcontroller into DFU boot mode by attaching the DFU
209+
1. Make sure the LPCScrypt utility is present on your host machine. This can
210+
be done by installing :ref:`linkserver-debug-host-tools`.
211+
212+
#. Put the LPC-Link2 microcontroller into DFU boot mode by attaching the DFU
205213
jumper, then then connecting to the USB debug port on the board. This
206214
jumper is connected to ``P2_6`` on the LPC4322 SOC.
207215

@@ -225,12 +233,14 @@ tools:
225233

226234
- :ref:`jlink-debug-host-tools`
227235

228-
After installing the LPCScrypt host tools, the firmware may be updated to
229-
use CMSIS-DAP firmware with the following steps:
236+
The probe may be updated to use the J-Link firmware with the following steps:
230237

231238
.. note:: Verify the firmware supports your board by visiting `Firmware for LPCXpresso`_
232239

233-
1. Put the LPC-Link2 microcontroller into DFU boot mode by attaching the DFU
240+
1. Make sure the LPCScrypt utility is present on your host machine. This can
241+
be done by installing :ref:`linkserver-debug-host-tools`.
242+
243+
#. Put the LPC-Link2 microcontroller into DFU boot mode by attaching the DFU
234244
jumper, then then connecting to the USB debug port on the board. This
235245
jumper is connected to ``P2_6`` on the LPC4322 SOC.
236246

0 commit comments

Comments
 (0)