Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Grazfather committed Feb 15, 2024
1 parent b5a2fba commit 975604c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/archs/arm-openocd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## ARMOpenOCD

The ARM OpenOCD architecture is a special arcthtecture used with the `gef-openocd-remote` command.
Please read the [documentation](../commands/gef-openocd-remote.md) for the command.
14 changes: 14 additions & 0 deletions docs/commands/gef-openocd-remote.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Command gef-openocd-remote

The `gef-openocd-command` is used with the [`ARMOpenOCD`](../../archs/arm-openocd.py] architecture.

The [arm-openocd.py](../../archs/arm-openocd.py) script adds an easy way to extend the `gef-remote`
functionality to easily debug ARM targets using a OpenOCD gdbserver. It creates a custom ARM-derived
`Architecture`, as well as the `gef-openocd-remote` command, which lets you easily connect to the
target, optionally loading the accompanying ELF binary.

### Usage

```bash
gef-openocd-remote localhost 3333 --file /path/to/elf
```

0 comments on commit 975604c

Please sign in to comment.