Lines Matching refs:debug
6 A *debug probe* is special hardware which allows you to control execution of a
10 also support other debug software and more advanced features such as
12 software supported by Zephyr, see :ref:`flash-debug-host-tools`.
21 an onboard debug probe, usb-to-serial adapter, and sometimes a drag-and-drop
22 flash programmer. This eliminates the need to purchase an external debug probe
23 and provides a variety of debug host tool options.
25 Several hardware vendors have their own branded onboard debug probe
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
30 the microcontroller the debug probe firmware runs on.
31 ST boards have the `ST-LINK probe <#stlink-v21-onboard-debug-probe>`_. Each
32 onboard debug probe microcontroller can support one or more types of firmware
33 that communicate with their respective debug host tools. For example, an
35 with pyOCD or OpenOCD debug host tools, or with J-Link firmware to communicate
36 with J-Link debug host tools.
64 Some supported boards in Zephyr do not include an onboard debug probe and
65 therefore require an external debug probe. In addition, boards that do include
66 an onboard debug probe often also have an SWD or JTAG header to enable the use
67 of an external debug probe instead. One reason this may be useful is that the
68 onboard debug probe may have limitations, such as lack of support for advanced
70 onboard debug probe from interfering with the external debug probe.
72 .. _nxp-onboard-debug-probes:
77 NXP boards may have one of several onboard debug probes. These probes include
78 the :ref:`mcu-link-onboard-debug-probe`, :ref:`lpc-link2-onboard-debug-probe`
79 and :ref:`opensda-onboard-debug-probe`. Each of these probes is implemented
81 debug probe type present on a given board can be determined based on the
82 debug microcontroller SOC:
84 - LPC55S69: :ref:`mcu-link-onboard-debug-probe`
85 - LPC4322: :ref:`lpc-link2-onboard-debug-probe`
86 - MK20: :ref:`opensda-onboard-debug-probe`
88 For example, the :ref:`frdm_k64f` board has an MK20 debug microcontroller,
89 so this board uses the :ref:`opensda-onboard-debug-probe`.
91 .. _mcu-link-onboard-debug-probe:
96 The MCU-Link onboard debug probe uses an LPC55S69 SOC. This probe supports
99 - :ref:`mcu-link-cmsis-onboard-debug-probe` (default firmware)
100 - :ref:`mcu-link-jlink-onboard-debug-probe`
103 with the :ref:`linkserver-debug-host-tools`. NXP recommends using NXP's
106 .. _mcu-link-cmsis-onboard-debug-probe:
111 This is the default firmware installed on MCU-Link debug probes. The CMSIS-DAP
112 debug probes allow debugging from any compatible toolchain, including IAR
114 addition to debug probe functionality, the MCU-Link probes may also provide:
123 This debug probe is compatible with the following debug host tools:
125 - :ref:`linkserver-debug-host-tools`
131 be done by installing :ref:`linkserver-debug-host-tools`.
134 jumper then connecting to the USB debug port on the board. This jumper may
143 .. _mcu-link-jlink-onboard-debug-probe:
148 This debug probe firmware provides a JLink compatible debug interface,
149 as well as a USB-Serial adapter. It is compatible with the following debug host
152 - :ref:`jlink-debug-host-tools`
159 be done by installing :ref:`linkserver-debug-host-tools`.
162 jumper then connecting to the USB debug port on the board. This jumper may
171 .. _lpc-link2-onboard-debug-probe:
176 The LPC-LINK2 onboard debug probe uses an LPC4322 SOC. This probe supports
179 - :ref:`lpclink2-cmsis-onboard-debug-probe`
180 - :ref:`lpclink2-jlink-onboard-debug-probe`
181 - :ref:`lpclink2-daplink-onboard-debug-probe` (default firmware)
184 with the :ref:`linkserver-debug-host-tools`. NXP recommends using NXP's
187 .. _lpclink2-cmsis-onboard-debug-probe:
192 The CMSIS-DAP debug probes allow debugging from any compatible toolchain,
195 As well as providing debug probe functionality, the LPC-Link2 probes also
203 This debug probe firmware is compatible with the following debug host tools:
205 - :ref:`linkserver-debug-host-tools`
210 be done by installing :ref:`linkserver-debug-host-tools`.
213 jumper, then connecting to the USB debug port on the board. This
221 .. _lpclink2-jlink-onboard-debug-probe:
227 board via the USB debug port. On these boards, an alternative method
230 This debug probe firmware provides a JLink compatible debug interface,
231 as well as a USB-Serial adapter. It is compatible with the following debug host
234 - :ref:`jlink-debug-host-tools`
241 be done by installing :ref:`linkserver-debug-host-tools`.
244 jumper, then connecting to the USB debug port on the board. This
252 .. _lpclink2-daplink-onboard-debug-probe:
259 the :ref:`lpclink2-cmsis-onboard-debug-probe` firmware following the
263 .. _opensda-onboard-debug-probe:
268 The OpenSDA onboard debug probe is based on the NXP MK20 SOC. It features
269 drag and drop programming supports, and supports the following debug firmwares:
271 - :ref:`opensda-daplink-onboard-debug-probe` (default firmware)
272 - :ref:`opensda-jlink-onboard-debug-probe`
274 .. _opensda-daplink-onboard-debug-probe:
279 This debug probe firmware is compatible with the following debug host tools:
281 - :ref:`pyocd-debug-host-tools`
282 - :ref:`openocd-debug-host-tools`
283 - :ref:`linkserver-debug-host-tools`
288 Install the debug host tools before you program the firmware.
290 As with all OpenSDA debug probes, the steps for programming the firmware are:
307 device (debug port), and a mass storage device (drag-and-drop flash
310 .. _opensda-jlink-onboard-debug-probe:
315 This debug probe is compatible with the following debug host tools:
317 - :ref:`jlink-debug-host-tools`
326 Install the debug host tools before you program the firmware.
328 As with all OpenSDA debug probes, the steps for programming the firmware are:
331 button while you plug a USB into the board's USB debug port. Note that
345 vendor-specific device (debug port).
347 .. _jlink-external-debug-probe:
352 `Segger J-Link`_ is a family of external debug probes, including J-Link EDU,
356 This debug probe is compatible with the following debug host tools:
358 - :ref:`jlink-debug-host-tools`
359 - :ref:`openocd-debug-host-tools`
361 Install the debug host tools before you program the firmware.
363 .. _stlink-v21-onboard-debug-probe:
368 ST-LINK/V2-1 is a serial and debug adapter built into all Nucleo and Discovery
373 It is compatible with the following host debug tools:
375 - :ref:`openocd-debug-host-tools`
376 - :ref:`jlink-debug-host-tools`
380 - :ref:`pyocd-debug-host-tools`
392 Flash and debug with ST-Link
400 and debug tool. Flash and debug can be done as follows:
408 :goals: debug
413 host computer, you can flash and debug as follows:
430 To attach a debugger to your board and open up a debug console with ``jlink``.
434 west debug --runner jlink
477 .. _nxp-s32-debug-probe:
483 debug port while connected to a developer's workstation via USB or remotely via
487 (S32DS) and NXP Automotive microcontrollers and processors. Install the debug
488 host tools as in indicated in :ref:`nxp-s32-debug-host-tools` before you program
495 https://www.segger.com/products/debug-probes/j-link/models/other-j-links/lpcxpresso-on-board/
507 https://www.segger.com/products/debug-probes/j-link/
510 https://www.segger.com/products/debug-probes/j-link/models/other-j-links/st-link-on-board/
522 https://www.nxp.com/design/software/automotive-software-and-tools/s32-debug-probe:S32-DP