summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilippe Bergheaud <felix@linux.ibm.com>2019-01-15 11:30:49 +0100
committerAlastair D'Silva <deece@users.noreply.github.com>2019-01-16 01:38:43 +1100
commit05d58c740951e0739d838c86cb9f32f8c7b459bb (patch)
tree6d265a08dfa3e4e6d0a377f8f1af3e9603a2de23
parent8ea4b9abe7e2e547fb8e7fb27abb75ce5deebce4 (diff)
Turn afutests README usage text into code block.
This fixes issue #24. Signed-off-by: Philippe Bergheaud <felix@linux.ibm.com>
-rw-r--r--afutests/afp/README.md57
-rw-r--r--afutests/memcpy/README.md3
2 files changed, 31 insertions, 29 deletions
diff --git a/afutests/afp/README.md b/afutests/afp/README.md
index ddddbfc..86f9a71 100644
--- a/afutests/afp/README.md
+++ b/afutests/afp/README.md
@@ -14,31 +14,32 @@ Usage
$ ../../afuobj/ocxl_afp3
-Usage: ocxl_afp3 [ options ]
- --tags_ld Number of tags for loads. Default=0
- --tags_st Number of tags for stores. Default=0
- 0 - 0 tags (disabled)
- 1 - 1 tag
- 2 - 2 tags
- 3 - 4 tags
- 4 - 16 tags
- 5 - 64 tags
- 6 - 256 tags
- 7 - 512 tags
- --size_ld Data size, in Bytes, for loads.
- Supported values: 64, 128, 256. Default=128
- --size_st Data size, in Bytes, for stores.
- Supported values: 64, 128, 256. Default=128
- --npu_ld Use rd_wnitc.n for loads. Default is rd_wnitc
- --npu_st Use dma_w.n for stores. Default is dma_w
- --num Number of times to check perf counts. Default is 3
- --wait Amount of seconds to wait between perf count reads.
- Default is 2
- --prefetch Initialize buffer memory
- --offsetmask Determines how much of buffer to use.
- Default 512kB. Valid Range: 4K-512M.
- Format: NumberLetter, e.g. 4K, 512K, 1M, 512M
- --timeout Default=1 seconds
- --verbose Verbose output
- --help Print this message
-
+```
+ Usage: ocxl_afp3 [ options ]
+ --tags_ld Number of tags for loads. Default=0
+ --tags_st Number of tags for stores. Default=0
+ 0 - 0 tags (disabled)
+ 1 - 1 tag
+ 2 - 2 tags
+ 3 - 4 tags
+ 4 - 16 tags
+ 5 - 64 tags
+ 6 - 256 tags
+ 7 - 512 tags
+ --size_ld Data size, in Bytes, for loads.
+ Supported values: 64, 128, 256. Default=128
+ --size_st Data size, in Bytes, for stores.
+ Supported values: 64, 128, 256. Default=128
+ --npu_ld Use rd_wnitc.n for loads. Default is rd_wnitc
+ --npu_st Use dma_w.n for stores. Default is dma_w
+ --num Number of times to check perf counts. Default is 3
+ --wait Amount of seconds to wait between perf count reads.
+ Default is 2
+ --prefetch Initialize buffer memory
+ --offsetmask Determines how much of buffer to use.
+ Default 512kB. Valid Range: 4K-512M.
+ Format: NumberLetter, e.g. 4K, 512K, 1M, 512M
+ --timeout Default=1 seconds
+ --verbose Verbose output
+ --help Print this message
+```
diff --git a/afutests/memcpy/README.md b/afutests/memcpy/README.md
index 701bc1f..1bc5a0d 100644
--- a/afutests/memcpy/README.md
+++ b/afutests/memcpy/README.md
@@ -16,6 +16,7 @@ Usage
$ ../../afuobj/ocxl_memcpy -A # Test memcpy AFU atomic compare and swap
$ ../../afuobj/ocxl_memcpy -a # Test memcpy AFU increment
+```
Usage: ocxl_memcpy [ options ]
Options:
-A Run the atomic compare and swap test
@@ -27,4 +28,4 @@ Usage
-r Reallocate the destination buffer in between 2 loops
-s <bufsize> Copy this number of bytes (default 2048)
-t <timeout> Seconds to wait for the AFU to signal completion
-
+```