From cd86bc8fef6661205a918b10fd258b41b751c74d Mon Sep 17 00:00:00 2001 From: Grazfather Date: Sun, 28 Jan 2024 15:14:35 -0500 Subject: [PATCH] Fix docs --- docs/archs/arm-blackmagicprobe.md | 4 ++++ .../commands/gef-bmp-remote.md | 17 ++++++++--------- 2 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 docs/archs/arm-blackmagicprobe.md rename archs/README.md => docs/commands/gef-bmp-remote.md (67%) diff --git a/docs/archs/arm-blackmagicprobe.md b/docs/archs/arm-blackmagicprobe.md new file mode 100644 index 0000000..f935dfc --- /dev/null +++ b/docs/archs/arm-blackmagicprobe.md @@ -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. diff --git a/archs/README.md b/docs/commands/gef-bmp-remote.md similarity index 67% rename from archs/README.md rename to docs/commands/gef-bmp-remote.md index bc7843b..69a6f35 100644 --- a/archs/README.md +++ b/docs/commands/gef-bmp-remote.md @@ -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"