soc_ifc_status_interface.yaml

uvmf:
  interfaces:
    ############## SOC-facing Status Interface ##############
    soc_ifc_status:
      clock: clk
      reset: dummy
      reset_assertion_level: 'False'

      config_constraints: []
      config_vars: []

      hdl_typedefs: []
      hvl_typedefs: []

      parameters: []

      # NOTE: Ports are 'output' instead of 'input' because this agent
      #       will be in RESPONDER mode, which inverts all port's polarities
      ports:
      # Ready indicators
      - name: ready_for_fuses
        dir: output
        width: '1'
      - name: ready_for_fw_push
        dir: output
        width: '1'
      - name: ready_for_runtime
        dir: output
        width: '1'

      # Command indicators
      - name: mailbox_data_avail
        dir: output
        width: '1'
      - name: mailbox_flow_done
        dir: output
        width: '1'

      #SoC Interrupts
      - name: cptra_error_fatal
        dir: output
        width: '1'
      - name: cptra_error_non_fatal
        dir: output
        width: '1'
      - name: trng_req
        dir: output
        width: '1'

      # Generic signals
      - name: generic_output_wires
        dir: output
        width: '64'

      transaction_constraints: []
      transaction_vars:
      # Ready indicators
      - name: ready_for_fuses
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: ready_for_fw_push
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: ready_for_runtime
        type: bit
        iscompare: 'True'
        isrand: 'False'

      # Command indicators
      - name: mailbox_data_avail
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: mailbox_flow_done
        type: bit
        iscompare: 'True'
        isrand: 'False'

      # Caliptra Internal Interrupts
      - name: cptra_error_fatal_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: cptra_error_non_fatal_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: trng_req_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'

      # Generic signals
      - name: generic_output_val
        type: bit [63:0]
        iscompare: 'True'
        isrand: 'False'

    ############## Caliptra Internal Status Interface ##############
    cptra_status:
      clock: clk
      reset: dummy
      reset_assertion_level: 'False'

      config_constraints: []
      config_vars: []

      hdl_typedefs: []
      hvl_typedefs: []

      parameters: []

      # NOTE: Ports are 'output' instead of 'input' because this agent
      #       will be in RESPONDER mode, which inverts all port's polarities
      ports:
      #uC reset
      - name: cptra_noncore_rst_b
        dir: output
        width: '1'
      - name: cptra_uc_rst_b
        dir: output
        width: '1'
      - name: fw_update_rst_window
        dir: output
        width: '1'

      #Obfuscated UDS and FE
      - name: cptra_obf_key_reg
        dir: output
        width: ["`CLP_OBF_KEY_DWORDS","32"]
      - name: obf_field_entropy
        dir: output
        width: ["`CLP_OBF_FE_DWORDS","32"]
      - name: obf_uds_seed
        dir: output
        width: ["`CLP_OBF_UDS_DWORDS","32"]

      #uC Interrupts
      - name: soc_ifc_error_intr
        dir: output
        width: '1'
      - name: soc_ifc_notif_intr
        dir: output
        width: '1'
      - name: sha_error_intr
        dir: output
        width: '1'
      - name: sha_notif_intr
        dir: output
        width: '1'
      - name: timer_intr
        dir: output
        width: '1'

      # NMI Vector
      - name: nmi_vector
        dir: output
        width: '32'
      - name: nmi_intr
        dir: output
        width: '1'

      # ICCM Lock
      - name: iccm_lock
        dir: output
        width: '1'

      transaction_constraints: []
      transaction_vars:
      # Caliptra Internal Interrupts
      - name: soc_ifc_err_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: soc_ifc_notif_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: sha_err_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: sha_notif_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: timer_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'

      # Subsystem reset
      - name: noncore_rst_asserted
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: uc_rst_asserted
        type: bit
        iscompare: 'True'
        isrand: 'False'
      - name: fw_update_rst_window
        type: bit
        iscompare: 'True'
        isrand: 'False'

      #Obfuscated UDS and FE
      - name: cptra_obf_key_reg
        type: bit [`CLP_OBF_KEY_DWORDS-1:0] [31:0]
        iscompare: 'True'
        isrand: 'False'
      - name: obf_field_entropy
        type: bit [`CLP_OBF_FE_DWORDS-1:0] [31:0]
        iscompare: 'True'
        isrand: 'False'
      - name: obf_uds_seed
        type: bit [`CLP_OBF_UDS_DWORDS-1:0] [31:0]
        iscompare: 'True'
        isrand: 'False'

      # NMI Vector
      - name: nmi_vector
        type: bit [31:0]
        iscompare: 'True'
        isrand: 'False'
      - name: nmi_intr_pending
        type: bit
        iscompare: 'True'
        isrand: 'False'

      # ICCM Lock
      - name: iccm_locked
        type: bit
        iscompare: 'True'
        isrand: 'False'