From 63c72f0bfe8c7d92c50ebdba73eb6f12beb8b0ae Mon Sep 17 00:00:00 2001 From: ConnorBP Date: Tue, 29 Apr 2025 10:01:56 -0400 Subject: [PATCH] added additional documentation about device arguments to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index a39d125..121a5e9 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,8 @@ The following arguments can be used when loading the connector: - `memmap` - A file that contains a custom memory map in TOML format (optional) - `auto-clear` - Enables auto-clear of status registers in LeechCore (Auto-clear is only available for bitstreams 4.7 and newer.) +Passing arguments which use the `:` character to pcileech itself requires quotes to escape them. here is an example of using the "driver" mode on pcileech as well as using a memory map file: `:device="fpga://driver=1":memmap="memmap.toml"`. Pcileech takes device arguments by appending `://` to the device name, followed by comma-separated device arguments. + The memory map file must contain a mapping table in the following format: ```toml