XCrypto: specification

Acting as a component part of the wider SCARV project, XCrypto is a general-purpose Instruction Set Extension (ISE) for RISC-V that supports software-based cryptographic workloads. The main repository acts as a general container for associated resources; this specific submodule houses the XCrypto specification.

Organisation

├── bin                     - scripts (e.g., environment configuration)
├── build                   - working directory for build
├── doc                     - documentation
│   └── tex                   - LaTeX content
└── extern                  - external resources (e.g., submodules)
    ├── riscv-opcodes         - submodule: scarv/riscv-opcodes
    └── texmf                 - submodule: scarv/texmf

Quickstart

• The releases page houses pre-built content.

• You can build the content yourself:

  1. Install any associated pre-requisites, e.g.,

     • a modern LaTeX distributation, such as TeX Live, including any required packages.

  2. Execute

     git clone https://github.com/scarv/xcrypto-spec.git
     cd ./xcrypto-spec
     git submodule update --init --recursive
     source ./bin/conf.sh

     to clone and initialise the repository, then configure the environment; for example, you should find that the environment variable REPO_HOME is set appropriately.

  3. Use targets in the top-level Makefile to drive a set of common tasks, e.g.,

     • execute

       make doc

       to build the documentation,

     • execute

       make clean

       to clean-up (e.g., remove everything built in ${REPO_HOME}/build).

Acknowledgements

This work has been supported in part by EPSRC via grant EP/R012288/1, under the RISE programme.