Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Grazfather committed Jan 29, 2024
1 parent 9a04ebe commit cd86bc8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
4 changes: 4 additions & 0 deletions docs/archs/arm-blackmagicprobe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# ARMBlackMagicProbe

The ARM BlackMagicProbe architecture is a special arcthtecture used with the `gef-bmp-remote`
command. Please read the [documentation](../commands/gef-bmp-remote.md) for the command.
17 changes: 8 additions & 9 deletions archs/README.md → docs/commands/gef-bmp-remote.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
## Additional architectures for GEF
# Command gef-bmp-remote

Experiments for adding support for new architectures in GEF
The `gef-bmp-command` is used with the [`ARMBlackMagicProbe`](../../archs/arm-blackmagicprobe.py]
architecture.

### Black Magic Probe

The [Black Magic Probe](https://black-magic.org/) isa JTAG/SWD debugging that handles communicating
The [Black Magic Probe](https://black-magic.org/) is a JTAG/SWD debugging that handles communicating
with your device and exposes a _gdbserver_. This allows you to connect to it via GDB with the
`remote` command. However, because this is exposed via a tty, GEF cannot handle it with its
`gef-remote` command (which assumes a host:port connection). The
[arm-blackmagicprobe.py](./arm-blackmagicprobe.py) script offers a way around this. It creates a
custom ARM-derived `Architecture`, as well as the `gef-bmp-remote` command, which lets you scan for
devices, power the target, and ultimately connect to the target device.
[arm-blackmagicprobe.py](../../archs/arm-blackmagicprobe.py) script offers a way around this. It
creates a custom ARM-derived `Architecture`, as well as the `gef-bmp-remote` command, which lets you
scan for devices, power the target, and ultimately connect to the target device.

#### Scan for devices
# Scan for devices

```bash
gef➤ gef-bmp-remote --scan /dev/ttyUSB1"
Expand Down

0 comments on commit cd86bc8

Please sign in to comment.