probe-rs driver¶

driver: jumpstarter_driver_probe_rs.driver.ProbeRs

The ProbeRs driver enables remote debugging and flashing of embedded devices using the probe-rs tools.

Driver configuration¶

export:
  probe:
    type: "jumpstarter_driver_probe_rs.driver.ProbeRs"
    config:
      probe: "2e8a:000c:5798DE5E500ACB60"
      probe_rs_path: "/home/majopela/.cargo/bin/probe-rs"
      chip: "RP2350"
      protocol: "swd"
      connect_under_reset: false
    

Config parameters¶

Parameter	Description	Type	Required	Default
probe	The probe id, can be in VID:PID format or VID:PID:SERIALNUMBER	str	no
probe_rs_path	The path to the probe-rs binary	str	no	probe-rs
chip	The target chip	str	no
protocol	The target protocol	“swd” or “jtag”	no
connect_under_reset	Connect to the target while asserting reset	bool	no	false

ProbeRs API¶

class jumpstarter_driver_probe_rs.client.ProbeRsClient¶

Client interface for probe-rs driver.

This client provides methods to use probe-rs remotely.

download(operator: Operator, path: str) → str¶: Download a file to the device

download_file(filepath) → str¶: Download a local file to the device

erase() → str¶: Erase the target memory, this is generally a slow operation.

info() → str¶: Get probe-rs information about the target

read(width: int, address: int, words: int) → list[int]¶

Read from memory

Args:

width: the width of the data to read, 8, 16, 32 or 64
address: the address to read from
words: the number of words to read

reset() → str¶: Reset the target, must be used after download to start the target

CLI¶

The probe driver client comes with a CLI tool that can be used to interact with the target device.

jumpstarter ⚡ local ➤ j probe
Usage: j probe [OPTIONS] COMMAND [ARGS]...

  probe-rs client

Options:
  --help  Show this message and exit.

Commands:
  download  Download a file to the target
  erase     Erase the target, this is a slow operation.
  info      Get target information
  read      read from target memory
  reset     Reset the target