diff options
Diffstat (limited to 'gdb/cheri-compressed-cap/README.md')
| -rw-r--r-- | gdb/cheri-compressed-cap/README.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/gdb/cheri-compressed-cap/README.md b/gdb/cheri-compressed-cap/README.md new file mode 100644 index 00000000000..b29a105058a --- /dev/null +++ b/gdb/cheri-compressed-cap/README.md @@ -0,0 +1,7 @@ +# cheri-compressed-cap  +A C library to compress/decompress CHERI capabilities + +See Section 3.4.4 and 3.4.5 of [the instruction set architecture document](https://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-927.pdf) for an explanation of how the compression works. + +## Usage instructions +Simply include `cheri_compressed_cap.h` in your C project and you can use the provided functions to compress and decompress your capabilities. |