cva6/docs/01_cva6_user
Munail Waqar f7dd49efa5
Some checks are pending
bender-up-to-date / bender-up-to-date (push) Waiting to run
ci / build-riscv-tests (push) Waiting to run
ci / execute-riscv64-tests (push) Blocked by required conditions
ci / execute-riscv32-tests (push) Blocked by required conditions
Adding support for Scalar Crypto Extension (Bitmanip instructions for Cryptography, Zbkb) (#2653)
Introduction
This PR adds support for Zbkb extension in the CVA6 core. It also adds the documentation for this extension. These changes have been tested with self-written single instruction tests and with the riscv-arch-tests. This PR will be followed by other PRs that will add complete support for the Zkn - NIST Algorithm Suite extension.

Implementation
Zbkb Extension:
Added support for the Zbkb instruction set. It essentially expands the Zbb extension with additional instructions useful in cryptography. These instructions are pack, packh, packw, brev8, unzip and zip.

Modifications
1. A new bit ZKN was added. The complete Zkn extension will be added under this bit for ease of use. This configuration will also require the RVB (bitmanip) bit to be set.
2. Updated the ALU and decoder to recognize and handle Zbkb instructions.

Documentation and Reference
The official RISC-V Cryptography Extensions Volume I was followed to ensure alignment with ratification. The relevant documentation for the Zbkb instruction was also added.

Verification
Assembly Tests:
The instructions were tested and verified with the K module of both 32 bit and 64 bit versions of the riscv-arch-tests to ensure proper functionality. These tests check for ISA compliance, edge cases and use assertions to ensure expected behavior. The tests include:
pack-01.S
packh-01.S
packw-01.S
brev8-01.S
unzip-01.S
zip-01.S
2024-12-18 22:35:41 +01:00
..
images transfer CSR specification from design document to user manual (#1088) 2023-03-03 23:13:24 +01:00
AXI_Interface.rst Fixed wrong axi signal (#2614) 2024-11-20 10:45:21 +01:00
Compiler_Command_Lines.rst Updated user manual to address several configuration (first pass) (#1685) 2023-12-13 10:08:40 +01:00
Core_Integration.rst Updated user manual to address several configuration (second pass) (#1696) 2023-12-13 10:10:31 +01:00
CSR_Cache_Control.rst Updated user manual to address several configuration (first pass) (#1685) 2023-12-13 10:08:40 +01:00
CSR_CV32A60AX.rst Adding configuration-specific CSR doc (#1766) 2024-02-09 13:39:48 +01:00
CSR_CV32A60AX_list.rst Adding configuration-specific CSR doc (#1766) 2024-02-09 13:39:48 +01:00
CSR_CV32A60X.rst Adding configuration-specific CSR doc (#1766) 2024-02-09 13:39:48 +01:00
CSR_CV32A60X_list.rst Adding configuration-specific CSR doc (#1766) 2024-02-09 13:39:48 +01:00
CSR_CV64A6_MMU.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
CSR_CV64A6_MMU_list.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
CSR_Performance_Counters.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
Custom_Instructions.rst Updated user manual to address several configuration (first pass) (#1685) 2023-12-13 10:08:40 +01:00
CV32A6_Control_Status_Registers.rst CSR user manual: add precise trap description (fix #1217) (#1646) 2023-11-21 19:05:50 +01:00
CV64A6_Control_Status_Registers.rst Individual files for each chapter of CVA6 User Manual (#1076) 2023-02-22 09:22:20 +01:00
CVA6_user_guide.rst Updated user manual to address several configuration (first pass) (#1685) 2023-12-13 10:08:40 +01:00
CVX_Interface_Coprocessor.rst New tutorial for coprocessor modification. (#2518) 2024-11-07 13:45:10 +01:00
index.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
Interfaces.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
Introduction.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
Parameters_Configuration.rst update port and config docs (#2363) 2024-07-12 17:00:36 +02:00
PMA.rst Updated user manual to address several configuration (first pass) (#1685) 2023-12-13 10:08:40 +01:00
PMP.rst Clarify pmpcfgX on illegal write combination (fixes #1694) (#1711) 2023-12-14 15:48:40 +01:00
Programmer_View.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions.rst [Docs] Add Zcmp Instructions in CVA6 user guide and requirement specifications (#1927) 2024-03-13 22:52:44 +01:00
RISCV_Instructions_RV32A.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RV32C.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RV32I.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RV32M.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RV32ZCb.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZba.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZbb.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZbc.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZbkb.rst Adding support for Scalar Crypto Extension (Bitmanip instructions for Cryptography, Zbkb) (#2653) 2024-12-18 22:35:41 +01:00
RISCV_Instructions_RVZbs.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZcmp.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZicond.rst Add CV64A6_MMU core in user manual (#2324) 2024-07-09 16:49:31 +02:00
RISCV_Instructions_RVZicsr.rst Updated user manual to address several configuration (second pass) (#1696) 2023-12-13 10:10:31 +01:00
RISCV_Instructions_RVZifencei.rst Updated user manual to address several configuration (second pass) (#1696) 2023-12-13 10:10:31 +01:00
rtype_format.png New tutorial for coprocessor modification. (#2518) 2024-11-07 13:45:10 +01:00
Traps_Interrupts_Exceptions.rst Rename cva6 (#1723) 2024-01-02 12:05:07 +01:00
user_cfg_doc.rst update port and config docs (#2363) 2024-07-12 17:00:36 +02:00