cpu.yaml

%TAG !py! tag:yaml.org,2002:python/object/apply:builtins.

---

templates:
  controller: controller.mlog.jinja
  worker: worker.mlog.jinja
  debugger: ../peripherals/debugger.mlog.jinja
  display: ../peripherals/scrolling_display.mlog.jinja

schematics:
  lookups: ../../schematics/lookup_procs.msch
  ram: ../../schematics/ram_proc.msch
  sortkb: ../../schematics/sortKB.msch

configs: ../config/configs.yaml

inputs:
  LOOKUP_PROC_SIZE: 260 # number of variables per lookup proc
  ROM_BYTE_OFFSET: 174 # start character for ROM string byte data
  ROM_PROC_BYTES: 16384 # number of bytes per ROM proc
  RAM_PROC_BYTES: 16384 # number of bytes per RAM proc
  RAM_PROC_VARS: 4096 # number of variables per RAM proc

  # ROM starts at 0x00000000, so we don't need a variable for it
  RAM_START:  '0x80000000'
  MMIO_START: '0xf0000000'
  SYSCON:     '0xfffffff0'

  # offsets from MMIO_START
  UART_RX_OFFSET: '0x10'
  UART_TX_OFFSET: '0x14'
  UART_STATUS_OFFSET:  '0x18'
  UART_CONTROL_OFFSET: '0x1c'

  # combined register size for one UART
  UART_MMIO_SIZE: '0x10'

  # bank addresses
  UART_RX_READ:  254
  UART_RX_WRITE: 255
  UART_TX_START: 256
  UART_TX_READ:  510
  UART_TX_WRITE: 511

instructions:
  # decoders
  - label: decode_LOAD
    align: 4
  - label: decode_illegal_instruction # LOAD-FP
    align: 4
  - label: decode_custom-0
    align: 4
  - label: decode_MISC-MEM
    align: 4
  - label: decode_OP-IMM
    align: 4
  - label: decode_AUIPC
    align: 4
  - label: decode_illegal_instruction # OP-IMM-32
    align: 4
  - label: decode_illegal_instruction # 48b
    align: 4
  - label: decode_STORE
    align: 4
  - label: decode_illegal_instruction # STORE-FP
    align: 4
  - label: decode_illegal_instruction # custom-1
    align: 4
  - label: decode_AMO
    align: 4
  - label: decode_OP
    align: 4
  - label: decode_LUI
    align: 4
  - label: decode_illegal_instruction
    align: 4
    count: 10
    # OP-32
    # 64b
    # MADD
    # MSUB
    # NMSUB
    # NMADD
    # OP-FP
    # OP-V
    # custom-2/rv128
    # 48b
  - label: decode_BRANCH
    align: 4
  - label: decode_JALR
    align: 4
  - label: decode_illegal_instruction # reserved
    align: 4
  - label: decode_JAL
    align: 4
  - label: decode_SYSTEM
    align: 4
  - label: decode_illegal_instruction
    align: 4
    count: 3
    # OP-VE
    # custom-3/rv128
    # >=80b

  # runtime handlers
  - label: BEQ
    address: 128
  - label: BNE
  - label: JAL
  - label: JALR
  - label: BLT
  - label: BGE
  - label: BLTU
  - label: BGEU
  - label: LB
  - label: LH
  - label: LW
  - label: LUI
  - label: LBU
  - label: LHU
  - label: SB
  - label: SH
  - label: SW
  - label: AMOADD.W
  - label: AMOSWAP.W
  - label: LR.W
  - label: SC.W
  - label: AMOXOR.W
  - label: AMOOR.W
  - label: AMOAND.W
  - label: AMOMIN.W
  - label: AMOMAX.W
  - label: AMOMINU.W
  - label: AMOMAXU.W
  - label: ADDI
  - label: SUB
  - label: SLTI
  - label: SLTIU
  - label: XORI
  - label: SRA
  - label: ORI
  - label: ANDI
  - label: ADD
  - label: SLL
  - label: SLT
  - label: SLTU
  - label: XOR
  - label: SRL
  - label: OR
  - label: AND
  - label: MUL
  - label: MULH
  - label: MULHSU
  - label: MULHU
  - label: DIV
  - label: DIVU
  - label: REM
  - label: REMU
  - label: PRIV
  - label: CSRRW
  - label: CSRRS
  - label: CSRRC
  - label: AUIPC
  - label: CSRRWI
  - label: CSRRSI
  - label: CSRRCI
  - label: FENCE
  - label: SLLI
  - label: SRLI
  - label: SRAI
  - label: ILLEGAL_OP
  - label: MLOGSYS
  - label: ILLEGAL_OP
    up_to: 255

csrs:
  # -- unprivileged --

  # counter/timers
  cycle:
    read: mcycle
  time:
    read: LABEL
  instret:
    read: minstret
  hpmcounter{}:
    args: !py!range [3, 32]
    read: hpmcounter
  cycleh:
    read: LABEL
  timeh:
    read: LABEL
  instreth:
    read: minstreth
  hpmcounter{}h:
    args: !py!range [3, 32]
    read: hpmcounter

  # -- supervisor --

  # trap setup
  sstatus:
    read: LABEL
    write: LABEL
    # MXR               -
    # SUM                -
    # SPP                          -
    # SPIE                            -
    # SIE                                 -
    mask: 0b00000000000011000000000100100010
  sie:
    read: LABEL
    write: LABEL
  stvec:
    read: csrs
    write: csrs
    mask: &align_4B 0xfffffffc
  scounteren:
    read: csrs
    write: csrs
  stimecmp:
    read: LABEL
    write: LABEL
  stimecmph:
    read: LABEL
    write: LABEL

  # configuration
  senvcfg:
    read: zero
    write: readonly

  # counter setup
  scountinhibit:
    read: zero
    write: readonly

  # trap handling
  sscratch:
    read: csrs
    write: csrs
  sepc:
    read: csrs
    write: csrs
    mask: *align_4B
  scause:
    read: csrs
    write: csrs
  stval:
    read: csrs
    write: csrs
  sip:
    read: LABEL
    write: LABEL

  # protection and translation
  satp:
    read: LABEL
    write: LABEL

  # -- machine --

  # information
  mvendorid:
    read: zero
  marchid:
    read: zero
  mimpid:
    read: zero
  mhartid:
    read: zero
  mconfigptr:
    read: zero

  # trap setup
  mstatus:
    read: LABEL
    write: LABEL
    # state  -              ----  --
    # WPRI    --------                  - - -
    # UBE                             -
    mask:  0b00000000011111100001100110101010
  misa:
    read: csrs
    write: readonly
  medeleg:
    read: csrs
    write: csrs
    # custom    --------
    # reserved          ----  -- -   -
    # M-call                        -
    mask:     0b00000000000011001011001111111111
  mideleg:
    read: csrs
    write: csrs
    # MEI                       -
    # SEI                         -
    # MTI                           -
    # STI                             -
    # SSI                                 -
    mask: 0b00000000000000000000101010100010
  mie:
    read: LABEL
    write: LABEL
  mtvec:
    read: csrs
    write: csrs
    mask: *align_4B
  mcounteren:
    read: csrs
    write: csrs
  mstatush:
    read: zero
    write: readonly
  medelegh:
    read: zero
    write: readonly

  # trap handling
  mscratch:
    read: csrs
    write: csrs
  mepc:
    read: csrs
    write: csrs
    mask: *align_4B
  mcause:
    read: csrs
    write: csrs
  mtval:
    read: csrs
    write: csrs
  mip:
    read: LABEL
    write: LABEL
    # SEIP                        -
    # SSIP                                -
    mask: 0b00000000000000000000001000000010

  # configuration
  menvcfg:
    read: zero
    write: readonly
  menvcfgh:
    read: zero
    write: readonly

  # counter/timers
  mcycle:
    read: LABEL
    write: LABEL
  minstret:
    read: LABEL
    write: LABEL
  mhpmcounter{}:
    args: !py!range [3, 32]
    read: zero
    write: readonly
  mcycleh:
    read: csrs
    write: csrs
  minstreth:
    read: LABEL
    write: LABEL
  mhpmcounter{}h:
    args: !py!range [3, 32]
    read: zero
    write: readonly

  # counter setup
  # mhpmevent{}h is defined only if the Sscofpmf extension is implemented
  mcountinhibit:
    read: zero
    write: readonly
  mhpmevent{}:
    args: !py!range [3, 32]
    read: zero
    write: readonly