rsgdb/rsgdb.toml.example at main · DynamicDevices/rsgdb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# rsgdb Configuration File Example
# Copy this file to rsgdb.toml and customize as needed

[proxy]
# Port to listen on for GDB connections
listen_port = 3333

# Target host to connect to (debug probe backend)
target_host = "localhost"

# Target port to connect to
target_port = 3334

# Reserved for future RSP ack policy; proxy always forwards +/- today (see README)
enable_acks = true

# Backend TCP connect timeout in seconds (0 = wait indefinitely). Idle GDB sessions are not timed out.
timeout_secs = 30

[logging]
# Log level: trace, debug, info, warn, error
level = "info"

# Log format: text, json
format = "text"

# Output file path (omit for stdout)
# output = "rsgdb.log"

# Log all protocol traffic
log_protocol = true

# Include timestamps in logs
include_timestamps = true

# Include thread IDs in logs
include_thread_ids = false

[breakpoints]
# Automatically optimize hardware/software breakpoint usage
auto_optimize = true

# Maximum number of hardware breakpoints supported by target
max_hardware = 6

# Enable named breakpoints
enable_named = true

# Enable conditional breakpoints
enable_conditional = true

[backend]
# Label for logs / tooling (openocd, probe-rs, gdbserver, …)
backend_type = "openocd"
# tcp / native / remote_ssh: see README "Choosing tcp vs native vs remote_ssh"
# tcp = connect to existing stub on proxy.target_host:target_port
# native = spawn local stub via [backend.spawn] with {port}
# remote_ssh = ssh user@host and run remote gdbserver; see [backend.remote_ssh]
transport = "tcp"

# When transport = native: argv template; must contain {port} (ephemeral GDB port).
# Stub must listen on bind_host at that port (match your tool’s CLI).
# [backend.spawn]
# program = ["probe-rs", "gdb", "--chip", "nrf52840", "--gdb-port", "{port}"]
# bind_host = "127.0.0.1"
# ready_timeout_secs = 30
# poll_interval_ms = 50

# When transport = remote_ssh: `{port}` is replaced with proxy.target_port (gdbserver must bind).
# host empty = use proxy.target_host for SSH. Password: env RSGDB_SSH_PASSWORD + sshpass on PATH.
# [backend.remote_ssh]
# user = "fio"
# ssh_port = 22
# identity_file = "/home/me/.ssh/id_ed25519"
# upload_local = "examples/board_test_app/board_test_app"
# upload_remote = "/tmp/board_test_app"
# program = ["gdbserver", "0.0.0.0:{port}", "/tmp/board_test_app"]

# Backend-specific options
[backend.options]
# Example OpenOCD options:
# interface = "stlink"
# target = "stm32f4x"

[recording]
# Enable session recording
enabled = false

# Output directory for recordings
output_dir = "./recordings"

# Maximum recording size in MB
max_size_mb = 100

# Compress recordings
compress = true