// --------------------------------------------------------------------------------
// Title       	: Comprehensive PMP (Physical Memory Protection) Verification
// Authors     	: Umer Shahid, Allen Baum, David Harris
//				  Muhammad Abdullah, Hamza Ali, Muhammad Zain
//
// Description : This test verifies the functionality and enforcement of
//               Physical Memory Protection (PMP) configurations in RISC-V
//               systems. It specifically tests the Read, Write, and Execute
//               permissions for a designated memory region, ensuring that
//               the PMP settings are correctly applied and that the system
//               behaves as expected when accessing this region.
//
// Notes       : - Ensure `model_test.h` is configured to match your PMP grain
//                 and PMP region count before running this test.
//               - Adjust PMP configurations for specific hardware if required.
//
// Coverpoints : cp_cfg_A_na4_all for PMPM is fully covered in this test file.
//
// Test Cases  : Checking A=NA4 works in each region with pmpcfg.L = 1, 
//				 pmpcfg.A=NA4, pmpcfg.XWR=000, standard regions and making lw,
//				 sw and jalr at that address, address - 4, and address + 4.
//
// Dependencies: model_test.h, arch_test.h
// --------------------------------------------------------------------------------

#define SKIP_MEPC
#include "model_test.h"
#include "arch_test.h"
RVTEST_ISA("RV32I_Zicsr")
# Test code region
.section .text.init
.globl rvtest_entry_point
rvtest_entry_point:
RVMODEL_BOOT
RVTEST_CODE_BEGIN

#ifndef RVMODEL_PMP_GRAIN
	#define RVMODEL_PMP_GRAIN 0
#endif

#ifndef RVMODEL_NUM_PMPS
	#define RVMODEL_NUM_PMPS 16
#endif

RVTEST_CASE(1,"//check ISA:=regex(.*32.*); check ISA:=regex(.*I[^S]*Zicsr.*); def rvtest_mtrap_routine=True;                                verify (PMP['implemented']); verify (PMP['pmp-grain'] == 0); def TEST_CASE_1=True; mac PMP_MACROS; mac PMP_helper_Coverpoints",cp_cfg_A_na4_all)
RVTEST_CASE(2,"//check ISA:=regex(.*32.*); check ISA:=regex(.*I.*S.*Zicsr.*); def rvtest_mtrap_routine=True; def rvtest_strap_routine=True; verify (PMP['implemented']); verify (PMP['pmp-grain'] == 0); def TEST_CASE_1=True; mac PMP_MACROS; mac PMP_helper_Coverpoints",cp_cfg_A_na4_all)

#ifdef TEST_CASE_1
RVTEST_SIGBASE( x13,signature_x13_1)
	.attribute unaligned_access, 0
	.attribute stack_align, 16
  	.align	3   
  	.option norvc
#define NOP 		0x13

.macro VERIFICATION_RWX ADDRESS 

    LA(a5, \ADDRESS)             							// Address to be ve
    lw a4, 0(a5)
    nop
    nop
    RVTEST_SIGUPD(x13, a4)       							// Signature update

	addi a5, a5, -4
    lw a4, 0(a5)
    nop
    nop
    RVTEST_SIGUPD(x13, a4)       							// Signature update

	addi a5, a5, 8
    lw a4, 0(a5)
    nop
    nop
    RVTEST_SIGUPD(x13, a4)       							// Signature update

.endm

main:
	// Loop to SET ALL pmpcfg REGs to zero
	.set pmpcfgi, CSR_PMPCFG0
	.rept RVMODEL_NUM_PMPS/4
	csrw pmpcfgi , x0
	.set pmpcfgi, pmpcfgi+1
	.endr

	// Loop to SET ALL pmpaddr REGs to zero
	.set pmpaddri, CSR_PMPADDR0
	.rept RVMODEL_NUM_PMPS
	csrw pmpaddri, x0
	.set pmpaddri, pmpaddri+1
	.endr

#define PMP_REGION_GLOBAL	 ((PMP_L|PMP_R|PMP_W|PMP_X|PMP_NAPOT)&0xFF)  // Background region with RWX enable.
#define PMPREGION0_XWR_000   (((PMP_L|PMP_NA4)&0xFF) << PMP0_CFG_SHIFT)
#define PMPREGION1_XWR_000   (((PMP_L|PMP_NA4)&0xFF) << PMP1_CFG_SHIFT)
#define PMPREGION2_XWR_000   (((PMP_L|PMP_NA4)&0xFF) << PMP2_CFG_SHIFT)
#define PMPREGION3_XWR_000   (((PMP_L|PMP_NA4)&0xFF) << PMP3_CFG_SHIFT)

#define PMPADDRESS_TOP_GLOBAL		-1												// All memory region
#define REGIONSTART		0x80002000		// RAM_BASE_ADDR + PROGRAM_SIZE	
#define NA4_REGION		(REGIONSTART >> PMP_SHIFT)
	
#ifdef rvtest_strap_routine
	csrw satp, zero                // Disable address translation.
#endif

	LA(x4, PMPADDRESS_TOP_GLOBAL)
	csrw 	pmpaddr15, x4

	//Lock the Background region.
	LI(x4, (PMP_REGION_GLOBAL << PMP3_CFG_SHIFT))
	csrw pmpcfg3, x4

//											Verification Section
// Test Case: 1 : L -> 1 and No Permissions given to the PMP Region 14

	LA(x5, NA4_REGION)
	csrw pmpaddr14, x5

    LI(x4, (PMPREGION2_XWR_000))
	csrw pmpcfg3, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 2 : L -> 1 and No Permissions given to the PMP Region 13

	LA(x5, NA4_REGION)
	csrw pmpaddr13, x5

    LI(x4, (PMPREGION1_XWR_000))
	csrw pmpcfg3, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 3 : L -> 1 and No Permissions given to the PMP Region 12

	LA(x5, NA4_REGION)
	csrw pmpaddr12, x5

    LI(x4, (PMPREGION0_XWR_000))
	csrw pmpcfg3, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 4 : L -> 1 and No Permissions given to the PMP Region 11

	LA(x5, NA4_REGION)
	csrw pmpaddr11, x5

    LI(x4, (PMPREGION3_XWR_000))
	csrw pmpcfg2, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 5 : L -> 1 and No Permissions given to the PMP Region 10

	LA(x5, NA4_REGION)
	csrw pmpaddr10, x5

    LI(x4, (PMPREGION2_XWR_000))
	csrw pmpcfg2, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 6 : L -> 1 and No Permissions given to the PMP Region 9

	LA(x5, NA4_REGION)
	csrw pmpaddr9, x5

    LI(x4, (PMPREGION1_XWR_000))
	csrw pmpcfg2, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 7 : L -> 1 and No Permissions given to the PMP Region 8

	LA(x5, NA4_REGION)
	csrw pmpaddr8, x5

    LI(x4, (PMPREGION0_XWR_000))
	csrw pmpcfg2, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 8 : L -> 1 and No Permissions given to the PMP Region 7

	LA(x5, NA4_REGION)
	csrw pmpaddr7, x5

    LI(x4, (PMPREGION3_XWR_000))
	csrw pmpcfg1, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 9 : L -> 1 and No Permissions given to the PMP Region 6

	LA(x5, NA4_REGION)
	csrw pmpaddr6, x5

    LI(x4, (PMPREGION2_XWR_000))
	csrw pmpcfg1, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 10 : L -> 1 and No Permissions given to the PMP Region 5

	LA(x5, NA4_REGION)
	csrw pmpaddr5, x5

    LI(x4, (PMPREGION1_XWR_000))
	csrw pmpcfg1, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 11 : L -> 1 and No Permissions given to the PMP Region 4

	LA(x5, NA4_REGION)
	csrw pmpaddr4, x5

    LI(x4, (PMPREGION0_XWR_000))
	csrw pmpcfg1, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 12 : L -> 1 and No Permissions given to the PMP Region 3

	LA(x5, NA4_REGION)
	csrw pmpaddr3, x5

    LI(x4, (PMPREGION3_XWR_000))
	csrw pmpcfg0, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 13 : L -> 1 and No Permissions given to the PMP Region 2

	LA(x5, NA4_REGION)
	csrw pmpaddr2, x5

    LI(x4, (PMPREGION2_XWR_000))
	csrw pmpcfg0, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 14 : L -> 1 and No Permissions given to the PMP Region 1

	LA(x5, NA4_REGION)
	csrw pmpaddr1, x5

    LI(x4, (PMPREGION1_XWR_000))
	csrw pmpcfg0, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

// Test Case: 15 : L -> 1 and No Permissions given to the PMP Region 0

	LA(x5, NA4_REGION)
	csrw pmpaddr0, x5

    LI(x4, (PMPREGION0_XWR_000))
	csrw pmpcfg0, x4

	VERIFICATION_RWX	TEST_FOR_EXECUTION

	li a4, 0xbeefcafe											// Clean Test exit verification signature.
    RVTEST_SIGUPD(x13, a4)       								// Signature update
	j exit														// Verification Complete, exit the test

.align 13
.align (RVMODEL_PMP_GRAIN+2)
TEST_FOR_EXECUTION:
	.rept (1<<RVMODEL_PMP_GRAIN)
	nop
	.endr

RETURN_INSTRUCTION:
	nop
	nop
	jr ra														// Get back to the point from where TEST_FOR_EXECUTION was called.

exit:
#endif
RVTEST_CODE_END
RVMODEL_HALT
RVTEST_DATA_BEGIN
.align 4

rvtest_data:
.word 0xbabecafe
.word 0xbabecafe
.word 0xbabecafe
.word 0xbabecafe
RVTEST_DATA_END

RVMODEL_DATA_BEGIN
rvtest_sig_begin:
sig_begin_canary:
CANARY;
signature_x13_1:
    .fill 64*(XLEN/32),4,0xdeadbeef

#ifdef rvtest_mtrap_routine

tsig_begin_canary:
CANARY;
mtrap_sigptr:
    .fill 256*(XLEN/32),4,0xdeadbeef
tsig_end_canary:
CANARY;

#endif

#ifdef rvtest_gpr_save

gpr_save:
    .fill 32*(XLEN/32),4,0xdeadbeef

#endif

sig_end_canary:
CANARY;
rvtest_sig_end:
RVMODEL_DATA_END