Core CSR Register Access

group NMSIS_Core_CSR_Register_Access

Functions to access the Core CSR Registers.

The following functions or macros provide access to Core CSR registers.

• Core CSR Encodings

• Core CSR Registers

Defines

__RV_CSR_SWAP(csr, val)

CSR operation Macro for csrrw instruction.

Read the content of csr register to __v, then write content of val into csr register, then return __v

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

• val – value to store into the CSR register

Returns

the CSR register value before written

__RV_CSR_READ(csr)

CSR operation Macro for csrr instruction.

Read the content of csr register to __v and return it

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

Returns

the CSR register value

__RV_CSR_WRITE(csr, val)

CSR operation Macro for csrw instruction.

Write the content of val to csr register

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

• val – value to store into the CSR register

__RV_CSR_READ_SET(csr, val)

CSR operation Macro for csrrs instruction.

Read the content of csr register to __v, then set csr register to be __v | val, then return __v

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

• val – Mask value to be used wih csrrs instruction

Returns

the CSR register value before written

__RV_CSR_SET(csr, val)

CSR operation Macro for csrs instruction.

Set csr register to be csr_content | val

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

• val – Mask value to be used wih csrs instruction

__RV_CSR_READ_CLEAR(csr, val)

CSR operation Macro for csrrc instruction.

Read the content of csr register to __v, then set csr register to be __v & ~val, then return __v

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

• val – Mask value to be used wih csrrc instruction

Returns

the CSR register value before written

__RV_CSR_CLEAR(csr, val)

CSR operation Macro for csrc instruction.

Set csr register to be csr_content & ~val

Parameters

• csr – CSR macro definition defined in Core CSR Registers, eg. CSR_MSTATUS

• val – Mask value to be used wih csrc instruction

Functions

__STATIC_FORCEINLINE void __enable_irq (void)

Enable IRQ Interrupts.

Enables IRQ interrupts by setting the MIE-bit in the MSTATUS Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __disable_irq (void)

Disable IRQ Interrupts.

Disables IRQ interrupts by clearing the MIE-bit in the MSTATUS Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __enable_ext_irq (void)

Enable External IRQ Interrupts.

Enables External IRQ interrupts by setting the MEIE-bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __disable_ext_irq (void)

Disable External IRQ Interrupts.

Disables External IRQ interrupts by clearing the MEIE-bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __enable_timer_irq (void)

Enable Timer IRQ Interrupts.

Enables Timer IRQ interrupts by setting the MTIE-bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __disable_timer_irq (void)

Disable Timer IRQ Interrupts.

Disables Timer IRQ interrupts by clearing the MTIE-bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __enable_sw_irq (void)

Enable software IRQ Interrupts.

Enables software IRQ interrupts by setting the MSIE-bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __disable_sw_irq (void)

Disable software IRQ Interrupts.

Disables software IRQ interrupts by clearing the MSIE-bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __disable_core_irq (uint32_t irq)

Disable Core IRQ Interrupt.

Disable Core IRQ interrupt by clearing the irq bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __enable_core_irq (uint32_t irq)

Enable Core IRQ Interrupt.

Enable Core IRQ interrupt by setting the irq bit in the MIE Register.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE uint32_t __get_core_irq_pending (uint32_t irq)

Get Core IRQ Interrupt Pending status.

Get Core IRQ interrupt pending status of irq bit.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE void __clear_core_irq_pending (uint32_t irq)

Clear Core IRQ Interrupt Pending status.

Clear Core IRQ interrupt pending status of irq bit.

Remark

Can only be executed in Privileged modes.

__STATIC_FORCEINLINE uint64_t __get_rv_cycle (void)

Read whole 64 bits value of mcycle counter.

This function will read the whole 64 bits of MCYCLE register

Remark

It will work for both RV32 and RV64 to get full 64bits value of MCYCLE

Returns

The whole 64 bits value of MCYCLE

__STATIC_FORCEINLINE uint64_t __get_rv_instret (void)

Read whole 64 bits value of machine instruction-retired counter.

This function will read the whole 64 bits of MINSTRET register

Remark

It will work for both RV32 and RV64 to get full 64bits value of MINSTRET

Returns

The whole 64 bits value of MINSTRET

__STATIC_FORCEINLINE uint64_t __get_rv_time (void)

Read whole 64 bits value of real-time clock.

This function will read the whole 64 bits of TIME register

Remark

It will work for both RV32 and RV64 to get full 64bits value of TIME

Attention

only available when user mode available

Returns

The whole 64 bits value of TIME CSR