How to select builtin debug probe for multiple ESP S3?

joba-1 · November 19, 2024, 12:24pm

Hi,

I connected 2 ESP32 S3 (via USB/JTAG port only) and select the active one with upload_port and monitor_port.
After a lot of confusion about which board got flashed and debugged I found out upload_port is not used for esp-builtin type?
So JTAG adapter is probably chosen by serial. But how?
I’m using linux, in case it is relevant.

maxgerhardt · November 19, 2024, 7:20pm

For that, you first of all need the serial numbers for each connected ESPS3.

Disconnect all ESP32S3 boards execpt one. Then, by for example executing

cd "C:\Users\<user>\.platformio\packages\tool-openocd-esp32"
.\bin\openocd.exe -f "board/esp32s3-builtin.cfg"

in a regular terminal, OpenOCD will try to connect and show you the serial number: (Here doing that for an ESP32C3)

Open On-Chip Debugger  v0.11.0-esp32-20220706 (2022-07-06-15:48)
Licensed under GNU GPL v2
For bug reports, read
        http://openocd.org/doc/doxygen/bugs.html
Info : only one transport option; autoselect 'jtag'
Info : esp_usb_jtag: VID set to 0x303a and PID to 0x1001
Info : esp_usb_jtag: capabilities descriptor set to 0x2000
Warn : Transport "jtag" was already selected
Info : Listening on port 6666 for tcl connections
Info : Listening on port 4444 for telnet connections
Error: libusb_open() failed with LIBUSB_ERROR_NOT_SUPPORTED
Info : esp_usb_jtag: serial (34:B4:72:87:47:50)
Info : esp_usb_jtag: Device found. Base speed 40000KHz, div range 1 to 255
[..]

Then, OpenOCD can be told to only accept the adapter that matches this serial string by using e.g.

-c "adapter serial 34:B4:72:87:47:50"

as an additional command parameter.

Thus we can add to our platformio.ini

upload_flags =
  -c
  adapter serial 34:B4:72:87:47:50

E.g. full

[env:esp32-c3-devkitc-02]
platform = espressif32@6.9.0
board = esp32-c3-devkitc-02
framework = arduino
build_flags = 
  -D ARDUINO_USB_CDC_ON_BOOT=1 ; serial port via USB CDC
  -D ARDUINO_USB_MODE=1  ; hardware USB, no TinyUSB
upload_protocol = esp-builtin
debug_tool = esp-builtin
; only upload and debug ESP32 with specific serial
upload_flags =
  -c
  adapter serial 34:B4:72:87:47:50

maxgerhardt · November 19, 2024, 7:43pm

Sadly, this way debugging a specific ESP32S3 does not work. We would have to be able to inject a -c "adpater serial .." into the OpenOCD arguments, but there’s no way to configure it, and I also didn’t find a way to modify that with a script.

So there, only opening an issue at Issues · platformio/platform-espressif32 · GitHub helps.

github.com

platformio/platform-espressif32/blob/1874b093d10ad2d35a35161d125d187e0f3ae9b2/platform.py#L275-L306


      
          def configure_debug_session(self, debug_config):
              build_extra_data = debug_config.build_data.get("extra", {})
              flash_images = build_extra_data.get("flash_images", [])
          
              if "openocd" in (debug_config.server or {}).get("executable", ""):
                  debug_config.server["arguments"].extend(
                      ["-c", "adapter speed %s" % (debug_config.speed or "5000")]
                  )
          
              ignore_conds = [
                  debug_config.load_cmds != ["load"],
                  not flash_images,
                  not all([os.path.isfile(item["path"]) for item in flash_images]),
              ]
          
              if any(ignore_conds):
                  return
          
              load_cmds = [
                  'monitor program_esp "{{{path}}}" {offset} verify'.format(

This file has been truncated. show original

Also slightly related, but does not work for fixing debugging in this case:

github.com/platformio/platform-ststm32

Add support for multiple ST-Link adapters

opened 12:27PM - 18 Aug 21 UTC

jcw

feature

I've set up a Raspberry Pi as build farm for STM32 µC boards. The problem is tha…t the ST-Link interfaces on these boards all look the same, apart from the serial number, exposed in the USB descriptors. For OpenOCD, which is the default upload tool, an extra parameter needs to be specified (`hla_serial <serialnum>`). Attached is a `platformio.ini` file which properly uploads and connect to the matching serial port. It works, but it's messy, and I need to specify the board type again, even though PIO already has that info in its board definition file. Also included is a `main.cpp`, to test the builds / uploads (which will obviously fail at some point, without these exact same boards present). [blink.zip](https://github.com/platformio/platformio-core/files/7007132/blink.zip) It would be useful to streamline this all a bit more, perhaps with a new `upload_serial` config parameter. For the serial connection, a second simplification would be to use this same serial number to match the proper port (in `minicom`?) when `monitor_port` is not set. That way, all you'd need to pick a _specific_ ST-Link would be to add `upload serial = ...`. (see also [my forum post](https://community.platformio.org/t/choosing-stlink-v2-programmer/10716/4) on this topic)

joba-1 · November 19, 2024, 8:18pm

Thanks for the upload solution!

Unfortunately this already works as I use an udev rule to setup a tty:

SUBSYSTEM=="tty", ATTRS{idVendor}=="303a", ATTRS{idProduct}=="1001", ATTRS{serial}=="F4:12:FA:E9:93:60", MODE:="0660", GROUP:="dialout", SYMLINK+="ttyACM_s3_1_jtag"

Any advantages over the udev solution?

I mean, except yours being project specific and not requiring root, which is already nice.

joba-1 · November 19, 2024, 8:32pm

Opened issue How to select builtin debug probe for multiple ESP S3? · Issue #1490 · platformio/platform-espressif32 · GitHub

Thanks!

jason2866 · November 19, 2024, 8:51pm

Hello together. If you provide a PR here I am happy to integrate this possibility

joba-1 · November 20, 2024, 3:41am

I have a hack now that works for me: debug_speed can have a second token, which is the serial, like

debug_speed = 40000 F4:12:FA:CA:A4:B8

You can have a look in my fork of your pioarduino

EDIT:
Just to clarify: it works for debug and upload, upload_flags not needed.
Tested to accept correct serial and reject wrong serial for debug and flash. Without given serial it works as before: some kind of first come, first serve.

jason2866 · November 28, 2024, 10:40am

Got the idea and it works. It is a hack since it hijacks the debug speed entry
Maybe I add a new entry in boards json for this.
How about debug_port?

maxgerhardt · November 28, 2024, 11:31am

I think other platforms would benefit if the PlatformIO core added a debug_sernum / debug_id / debug_adapter_num or similiar in the base debug configuration. debug_port is already taken and might be interpreted by PlatformIO as “what GDB should connect to”, e.g., localhost:3333 (OpenOCD’s GDB server port), so debug_port should not be equal to the adapter’s serial number.

jason2866 · November 28, 2024, 1:42pm

Thx Max for heads up not using my suggestion for the name. Honestly i doubt there will be changes done in Pio core for this. Overall I have the impression development is stalled at all… Don’t want to fork the core and modify “just” for this. This will be needed when actual espressif Tools and Toolchains are not in there registry. So going to add the debug port whatever name we find for in the espressif32 platform