PIO Unified Debugger¶

Atmel-ICE¶

Configuration:

debug_tool = atmel-ice

Picture:

Description:

Atmel-ICE is a powerful development tool for debugging and programming ARM® Cortex®-M based SAM and AVR microcontrollers with on-chip debug capability. Vendor information…

Compatible Platforms:

• Atmel SAM

Black Magic Probe¶

Configuration:

debug_tool = blackmagic

Picture:

Description:

The Black Magic Probe is a modern, in-application debugging tool for embedded microprocessors. It is able to control and examine the state of the target microprocessor using a JTAG or Serial Wire Debugging (SWD) port and on-chip debug logic provided by the microprocessor. The probe connects to a host computer using a standard USB interface. Vendor information…

Also, see Custom debugging configuration with Black Magic Probe.

Compatible Platforms:

• Atmel SAM

• Freescale Kinetis

• Nordic nRF51

• Nordic nRF52

• NXP LPC

• Silicon Labs EFM32

• ST STM32

CMSIS-DAP¶

Configuration:

debug_tool = cmsis-dap

Picture:

Description:

CMSIS-DAP is generally implemented as an on-board interface chip, providing direct USB connection from a development board to a debugger running on a host computer on one side, and over JTAG (Joint Test Action Group) or SWD (Serial Wire Debug) to the target device to access the Coresight DAP on the other. Vendor information…

Compatible Platforms:

• Atmel SAM

• Freescale Kinetis

• Maxim 32

• Nordic nRF51

• Nordic nRF52

• NXP LPC

• ST STM32

• WIZNet W7500

FTDI Chip¶

Configuration:

debug_tool = ftdi

Picture:

Description:

FTDI Chip develops innovative silicon solutions that enhance interaction with today’s technology. When a designer needs to add a USB port, rest assured that FTDI Chip has a full range of USB solutions to get the job done… <http://www.ftdichip.com/USB.html?utm_source=platformio&utm_medium=docs>`__

Drivers:

Windows:

See https://community.platformio.org/t/esp32-pio-unified-debugger/4541/20

Mac:

You don’t need to install extra drivers. Nevertheless, please check official documentation.

Linux:

Please install “udev” rules 99-platformio-udev.rules.

Compatible Platforms:

• Espressif 32

• RISC-V

• Samsung ARTIK

J-LINK¶

Configuration:

debug_tool = jlink

Picture:

Description:

SEGGER J-Links are the most widely used line of debug probes available today. They’ve proven their value for more than 10 years with over 400,000 units sold, including OEM versions and on-board solutions. This popularity stems from the unparalleled performance, extensive feature set, large number of supported CPUs, and compatibility with all popular development environments. Vendor information…

• Install J-Link GDB Server

• J-Link Supported Devices

Also, see Custom debugging configuration with J-Link GDB Server.

Compatible Platforms:

• Atmel SAM

• Freescale Kinetis

• Infineon XMC

• Nordic nRF51

• Nordic nRF52

• NXP LPC

• Silicon Labs EFM32

• ST STM32

• Teensy

• WIZNet W7500

Mini-Module FT2232H¶

Configuration:

debug_tool = minimodule

Picture:

Description:

The FT2232H Mini Module is a USB to dual channel serial/MPSSE/FIFO interface converter module based on the FT2232H USB Hi-Speed IC. The FT2232H handles all the USB signalling and protocol handling. The module provides access to device I/O interfaces via 2 double row 0.1” pitch male connectors. The module is ideal for development purposes to quickly prove functionality of adding USB to a target design. Vendor information…

Wiring Connections:

FT2232H Mini-Module Pin	Board JTAG Pin
AD0 [CN2-7]	TCK
AD1 [CN2-10]	TDI
AD2 [CN2-9]	TDO
AD3 [CN2-12]	TMS
AC2 [CN2-20]	RST
GND [CN2-2]	GND

You will also need to connect Vbus [CN3-1] to Vcc [CN3-3] of FT2232H Mini-Module to power the FTDI chip. See FT2232H Mini-Module Datasheet

Drivers:

Windows:

See https://community.platformio.org/t/esp32-pio-unified-debugger/4541/20

Mac:

You don’t need to install extra drivers. Nevertheless, please check official documentation.

Linux:

Please install “udev” rules 99-platformio-udev.rules.

Compatible Platforms:

• Espressif 32

MSP Debug¶

Configuration:

debug_tool = mspdebug

Description:

The MSP debug stack (MSPDS) for all MSP430™ microcontrollers (MCUs) and SimpleLink™ MSP432™ devices consists of a static library on the host system side as well as an embedded firmware that runs on debug tools including the MSP-FET, MSP-FET430UIF or on-board eZ debuggers. It is the bridging element between all PC software and all MSP430 and SimpleLink MSP432 microcontroller derivatives and handles tasks such as code download, stepping through code or break points. Vendor information…

Compatible Platforms:

• TI MSP430

Olimex ARM-USB-OCD¶

Configuration:

debug_tool = olimex-arm-usb-ocd

Picture:

Description:

3-IN-1 fast USB ARM/ESP32 JTAG, USB-to-RS232 virtual port and power supply 5-9-12VDC device (supported by OpenOCD ARM debugger software). Vendor information…

Wiring Connections:

Olimex ARM-USB-OCD Pin	Board JTAG Pin
11	TCK
5	TDI
13	TDO
7	TMS
3	RST
4	GND

Drivers:

Windows:

See https://community.platformio.org/t/esp32-pio-unified-debugger/4541/20

Mac:

You don’t need to install extra drivers. Nevertheless, please check official documentation.

Linux:

Please install “udev” rules 99-platformio-udev.rules.

Compatible Platforms:

• Espressif 32

Olimex ARM-USB-OCD-H¶

Configuration:

debug_tool = olimex-arm-usb-ocd-h

Picture:

Description:

High-speed 3-IN-1 fast USB ARM/ESP32 JTAG, USB-to-RS232 virtual port and power supply 5VDC device. Vendor information…

Wiring Connections:

Olimex ARM-USB-OCD-H Pin	Board JTAG Pin
11	TCK
5	TDI
13	TDO
7	TMS
3	RST
4	GND

Drivers:

Windows:

See https://community.platformio.org/t/esp32-pio-unified-debugger/4541/20

Mac:

You don’t need to install extra drivers. Nevertheless, please check official documentation.

Linux:

Please install “udev” rules 99-platformio-udev.rules.

Compatible Platforms:

• Espressif 32

Olimex ARM-USB-TINY¶

Configuration:

debug_tool = olimex-jtag-tiny

Picture:

Description:

Low-cost and high-speed ARM/ESP32 USB JTAG. Vendor information…

Wiring Connections:

Olimex ARM-USB-TINY Pin	Board JTAG Pin
11	TCK
5	TDI
13	TDO
7	TMS
3	RST
4	GND

Drivers:

Windows:

See https://community.platformio.org/t/esp32-pio-unified-debugger/4541/20

Mac:

You don’t need to install extra drivers. Nevertheless, please check official documentation.

Linux:

Please install “udev” rules 99-platformio-udev.rules.

Compatible Platforms:

• Espressif 32

Olimex ARM-USB-TINY-H¶

Configuration:

debug_tool = olimex-arm-usb-tiny-h

Picture:

Description:

Low-cost and high-speed ARM/ESP32 USB JTAG. Vendor information…

Wiring Connections:

Olimex ARM-USB-TINY-H Pin	Board JTAG Pin
11	TCK
5	TDI
13	TDO
7	TMS
3	RST
4	GND

Drivers:

Windows:

See https://community.platformio.org/t/esp32-pio-unified-debugger/4541/20

Mac:

You don’t need to install extra drivers. Nevertheless, please check official documentation.

Linux:

Please install “udev” rules 99-platformio-udev.rules.

Compatible Platforms:

• Espressif 32

• RISC-V

TI-ICDI¶

Configuration:

debug_tool = ti-icdi

Description:

Tiva™ C Series evaluation and reference design kits provide an integrated In-Circuit Debug Interface (ICDI) which allows programming and debugging of the onboard C Series microcontroller. Vendor information…

Compatible Platforms:

• TI TIVA

ST-LINK¶

Configuration:

debug_tool = stlink

Picture:

Description:

The ST-LINK is an in-circuit debugger and programmer for the STM8 and STM32 microcontroller families. The single wire interface module (SWIM) and JTAG/serial wire debugging (SWD) interfaces are used to communicate with any STM8 or STM32 microcontroller located on an application board. Vendor information…

Compatible Platforms:

• Nordic nRF51

• Nordic nRF52

• ST STM32

Custom¶

Configuration:

debug_tool = custom

Custom debugging configuration:

• debug_init_break

• debug_init_cmds

• debug_extra_cmds (conditional project breakpoints, extra configuration, etc.)

• debug_load_cmd

• debug_server

• debug_port

[env:debug]
platform = ...
board = ...
framework = ...
debug_tool = custom
; set here a valid port...
debug_port = /dev/cu.usbmodem7BB07991
debug_init_cmds =
  target extended-remote $DEBUG_PORT
  monitor swdp_scan
  attach 1
  set mem inaccessible-by-default off
  $INIT_BREAK
  $LOAD_CMD

[env:debug_jlink]
platform = ststm32
framework = mbed
board = nucleo_f446re
debug_tool = custom
debug_server =
  /full/path/to/JLinkGDBServerCL
  -singlerun
  -if
  SWD
  -select
  USB
  -port
  2331
  -device
  STM32F446RE

[env:jlink_debug_and_upload]
platform = teensy
framework = arduino
board = teensy31
extra_scripts = extra_script.py
upload_protocol = custom
debug_tool = custom
debug_server =
  /full/path/to/JLinkGDBServerCL
  -singlerun
  -if
  SWD
  -select
  USB
  -port
  2331
  -device
  MK20DX256xxx7

from os import makedirs
from os.path import isdir, join
Import('env')


# Optional block, only for Teensy
env.AddPostAction(
    "$BUILD_DIR/firmware.hex",
    env.VerboseAction(" ".join([
        "sed", "-i.bak",
        "s/:10040000FFFFFFFFFFFFFFFFFFFFFFFFDEF9FFFF23/:10040000FFFFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFD/",
        "$BUILD_DIR/firmware.hex"
    ]), "Fixing $BUILD_DIR/firmware.hex secure flash flags"))


def _jlink_cmd_script(env, source):
    build_dir = env.subst("$BUILD_DIR")
    if not isdir(build_dir):
        makedirs(build_dir)
    script_path = join(build_dir, "upload.jlink")
    commands = ["h", "loadbin %s,0x0" % source, "r", "q"]
    with open(script_path, "w") as fp:
        fp.write("\n".join(commands))
    return script_path

env.Replace(
    __jlink_cmd_script=_jlink_cmd_script,
    UPLOADER="/full/path/to/JLink",
    UPLOADERFLAGS=[
        "-device", "MK20DX256xxx7",
        "-speed", "4000",
        "-if", "swd",
        "-autoconnect", "1"
    ],
    UPLOADCMD='"$UPLOADER" $UPLOADERFLAGS -CommanderScript ${__jlink_cmd_script(__env__, SOURCE)}'
)

[env:debug]
platform = ststm32
framework = mbed
board = ...
debug_tool = custom
debug_port = :4242
debug_server = $PLATFORMIO_HOME_DIR/packages/tool-stlink/bin/st-util

[env:debug]
platform = ststm32
framework = mbed
board = ...
debug_tool = custom
debug_server =
  $PLATFORMIO_HOME_DIR/packages/tool-openocd/bin/openocd
  -f
  $PLATFORMIO_HOME_DIR/packages/tool-openocd/scripts/board/st_nucleo_f4.cfg

[env:debug]
platform = ...
board = ...
framework = mbed
debug_tool = custom
debug_server = pyocd-gdbserver

1BitSquared¶

96Boards¶

Adafruit¶

Aiyarafun¶

Arduino¶

Armstrap¶

Atmel¶

BBC¶

BluzDK¶

CQ Publishing¶

DFRobot¶

DOIT¶

Delta¶

Digistump¶

Dongsen Technology¶

DycodeX¶

ESP32vn¶

Elektor Labs¶

Embedded Artists¶

Espotel¶

Espressif¶

Freescale¶

Generic¶

Hornbill¶

Infineon¶

JKSoft¶

LeafLabs¶

MH-ET Live¶

MXChip¶

Macchina¶

Maxim¶

Micromint¶

MikroElektronika¶

MultiTech¶

NGX Technologies¶

NXP¶

NodeMCU¶

Nordic¶

OLIMEX¶

OSHChip¶

RFduino¶

RedBearLab¶

RoboticsBrno¶

RushUp¶

SODAQ¶

ST¶