etiss/Encoding_8h_source.html

/*


        @copyright


        <pre>


        Copyright 2018 Chair of Electronic Design Automation, TUM


        This file is part of ETISS tool, see <https://github.com/tum-ei-eda/etiss>.


        The initial version of this software has been created with the funding support by the German Federal

        Ministry of Education and Research (BMBF) in the project EffektiV under grant 01IS13022.


        Redistribution and use in source and binary forms, with or without modification, are permitted

        provided that the following conditions are met:


        1. Redistributions of source code must retain the above copyright notice, this list of conditions and

        the following disclaimer.


        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions

        and the following disclaimer in the documentation and/or other materials provided with the distribution.


        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse

        or promote products derived from this software without specific prior written permission.


        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED

        WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

        PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY

        DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

        PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

        NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

        POSSIBILITY OF SUCH DAMAGE.


        </pre>


        @author Chair of Electronic Design Automation, TUM


        @version 0.1


*/


#ifndef RISCV_CSR_ENCODING_H

#define RISCV_CSR_ENCODING_H


#define MSTATUS_UIE 0x00000001

#define MSTATUS_SIE 0x00000002

#define MSTATUS_HIE 0x00000004

#define MSTATUS_MIE 0x00000008

#define MSTATUS_UPIE 0x00000010

#define MSTATUS_SPIE 0x00000020

#define MSTATUS_HPIE 0x00000040

#define MSTATUS_MPIE 0x00000080

#define MSTATUS_SPP 0x00000100

#define MSTATUS_HPP 0x00000600

#define MSTATUS_MPP 0x00001800

#define MSTATUS_FS 0x00006000

#define MSTATUS_XS 0x00018000

#define MSTATUS_MPRV 0x00020000

#define MSTATUS_SUM 0x00040000

#define MSTATUS_MXR 0x00080000

#define MSTATUS_TVM 0x00100000

#define MSTATUS_TW 0x00200000

#define MSTATUS_TSR 0x00400000

#define MSTATUS32_SD 0x80000000

#define MSTATUS_UXL 0x0000000300000000

#define MSTATUS_SXL 0x0000000C00000000

#define MSTATUS64_SD 0x8000000000000000


#define SSTATUS_UIE 0x00000001

#define SSTATUS_SIE 0x00000002

#define SSTATUS_UPIE 0x00000010

#define SSTATUS_SPIE 0x00000020

#define SSTATUS_SPP 0x00000100

#define SSTATUS_FS 0x00006000

#define SSTATUS_XS 0x00018000

#define SSTATUS_SUM 0x00040000

#define SSTATUS_MXR 0x00080000

#define SSTATUS32_SD 0x80000000

#define SSTATUS_UXL 0x0000000300000000

#define SSTATUS64_SD 0x8000000000000000


#define MIP_SSIP (1 << IRQ_S_SOFT)

#define MIP_HSIP (1 << IRQ_H_SOFT)

#define MIP_MSIP (1 << IRQ_M_SOFT)

#define MIP_STIP (1 << IRQ_S_TIMER)

#define MIP_HTIP (1 << IRQ_H_TIMER)

#define MIP_MTIP (1 << IRQ_M_TIMER)

#define MIP_SEIP (1 << IRQ_S_EXT)

#define MIP_HEIP (1 << IRQ_H_EXT)

#define MIP_MEIP (1 << IRQ_M_EXT)


#define SIP_SSIP MIP_SSIP

#define SIP_STIP MIP_STIP


#define PRV_U 0

#define PRV_S 1

#define PRV_H 2

#define PRV_M 3


#define PAGE_OFFSET 12

#define OFFSET_MASK ((1 << PAGE_OFFSET) - 1)

#define PAGE_SIZE 1 << PAGE_OFFSET

#define LEVELS 3

#define VPN_OFFSET 9

#define PTESIZE 8

#define SATP_PPN_MASK ((0x1ULL << 44ULL) - 1ULL)


#define SATP32_MODE 0x80000000

#define SATP32_ASID 0x7FC00000

#define SATP32_PPN 0x003FFFFF

#define SATP64_MODE 0xF000000000000000

#define SATP64_ASID 0x0FFFF00000000000

#define SATP64_PPN 0x00000FFFFFFFFFFF


#define SATP_MODE_OFF 0

#define SATP_MODE_SV32 1

#define SATP_MODE_SV39 8

#define SATP_MODE_SV48 9

#define SATP_MODE_SV57 10

#define SATP_MODE_SV64 11


#define PMP_R 0x01

#define PMP_W 0x02

#define PMP_X 0x04

#define PMP_A 0x18

#define PMP_L 0x80

#define PMP_SHIFT 2


#define PMP_TOR 0x08

#define PMP_NA4 0x10

#define PMP_NAPOT 0x18


#define IRQ_S_SOFT 1

#define IRQ_H_SOFT 2

#define IRQ_M_SOFT 3

#define IRQ_S_TIMER 5

#define IRQ_H_TIMER 6

#define IRQ_M_TIMER 7

#define IRQ_S_EXT 9

#define IRQ_H_EXT 10

#define IRQ_M_EXT 11

#define IRQ_COP 12

#define IRQ_HOST 13


#define DEFAULT_RSTVEC 0x00001000

#define CLINT_BASE 0x02000000

#define CLINT_SIZE 0x000c0000

#define EXT_IO_BASE 0x40000000

#define DRAM_BASE 0x80000000


// page table entry (PTE) fields

#define PTE_V 0x001    // Valid

#define PTE_R 0x002    // Read

#define PTE_W 0x004    // Write

#define PTE_X 0x008    // Execute

#define PTE_U 0x010    // User

#define PTE_G 0x020    // Global

#define PTE_A 0x040    // Accessed

#define PTE_D 0x080    // Dirty

#define PTE_SOFT 0x300 // Reserved for Software


#define PTE_TABLE(PTE) (((PTE) & (PTE_V | PTE_R | PTE_W | PTE_X)) == PTE_V)


#define CSR_SSTATUS 0x100

#define CSR_SIE 0x104

#define CSR_STVEC 0x105

#define CSR_SCOUNTEREN 0x106

#define CSR_SSCRATCH 0x140

#define CSR_SEPC 0x141

#define CSR_SCAUSE 0x142

#define CSR_STVAL 0x143

#define CSR_SIP 0x144

#define CSR_SATP 0x180

#define CSR_MSTATUS 0x300

#define CSR_MISA 0x301

#define CSR_MEDELEG 0x302

#define CSR_MIDELEG 0x303

#define CSR_MIE 0x304

#define CSR_MTVEC 0x305

#define CSR_MCOUNTEREN 0x306

#define CSR_MSCRATCH 0x340

#define CSR_MEPC 0x341

#define CSR_MCAUSE 0x342

#define CSR_MTVAL 0x343

#define CSR_MIP 0x344


#define CAUSE_MISALIGNED_FETCH 0x0

#define CAUSE_FETCH_ACCESS 0x1

#define CAUSE_ILLEGAL_INSTRUCTION 0x2

#define CAUSE_BREAKPOINT 0x3

#define CAUSE_MISALIGNED_LOAD 0x4

#define CAUSE_LOAD_ACCESS 0x5

#define CAUSE_MISALIGNED_STORE 0x6

#define CAUSE_STORE_ACCESS 0x7

#define CAUSE_USER_ECALL 0x8

#define CAUSE_SUPERVISOR_ECALL 0x9

#define CAUSE_HYPERVISOR_ECALL 0xa

#define CAUSE_MACHINE_ECALL 0xb

#define CAUSE_FETCH_PAGE_FAULT 0xc

#define CAUSE_LOAD_PAGE_FAULT 0xd

#define CAUSE_STORE_PAGE_FAULT 0xf

#endif