Core CSR Register Access

Functions to access the Core CSR Registers. More...

Macros
#define	__RV_CSR_SWAP(csr, val)
	CSR operation Macro for csrrw instruction. More...
#define	__RV_CSR_READ(csr)
	CSR operation Macro for csrr instruction. More...
#define	__RV_CSR_WRITE(csr, val)
	CSR operation Macro for csrw instruction. More...
#define	__RV_CSR_READ_SET(csr, val)
	CSR operation Macro for csrrs instruction. More...
#define	__RV_CSR_SET(csr, val)
	CSR operation Macro for csrs instruction. More...
#define	__RV_CSR_READ_CLEAR(csr, val)
	CSR operation Macro for csrrc instruction. More...
#define	__RV_CSR_CLEAR(csr, val)
	CSR operation Macro for csrc instruction. More...

Functions
__STATIC_FORCEINLINE void	__enable_irq (void)
	Enable IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__disable_irq (void)
	Disable IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__enable_ext_irq (void)
	Enable External IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__disable_ext_irq (void)
	Disable External IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__enable_timer_irq (void)
	Enable Timer IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__disable_timer_irq (void)
	Disable Timer IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__enable_sw_irq (void)
	Enable software IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__disable_sw_irq (void)
	Disable software IRQ Interrupts. More...
__STATIC_FORCEINLINE void	__disable_core_irq (uint32_t irq)
	Disable Core IRQ Interrupt. More...
__STATIC_FORCEINLINE void	__enable_core_irq (uint32_t irq)
	Enable Core IRQ Interrupt. More...
__STATIC_FORCEINLINE uint32_t	__get_core_irq_pending (uint32_t irq)
	Get Core IRQ Interrupt Pending status. More...
__STATIC_FORCEINLINE void	__clear_core_irq_pending (uint32_t irq)
	Clear Core IRQ Interrupt Pending status. More...
__STATIC_FORCEINLINE uint64_t	__get_rv_cycle (void)
	Read whole 64 bits value of mcycle counter. More...
__STATIC_FORCEINLINE uint64_t	__get_rv_instret (void)
	Read whole 64 bits value of machine instruction-retired counter. More...
__STATIC_FORCEINLINE uint64_t	__get_rv_time (void)
	Read whole 64 bits value of real-time clock. More...

Detailed Description

Functions to access the Core CSR Registers.

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

• Core CSR Encodings
• Core CSR Registers

Macro Definition Documentation

__RV_CSR_CLEAR

#define __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

Definition at line 337 of file core_feature_base.h.

__RV_CSR_READ

#define __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

Definition at line 245 of file core_feature_base.h.

__RV_CSR_READ_CLEAR

#define __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

Definition at line 319 of file core_feature_base.h.

__RV_CSR_READ_SET

#define __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

Definition at line 282 of file core_feature_base.h.

__RV_CSR_SET

#define __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

Definition at line 300 of file core_feature_base.h.

__RV_CSR_SWAP

#define __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

Definition at line 227 of file core_feature_base.h.

__RV_CSR_WRITE

#define __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

Definition at line 263 of file core_feature_base.h.

Function Documentation

__clear_core_irq_pending()

__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.

Remarks

Can only be executed in Privileged modes.

Definition at line 475 of file core_feature_base.h.

{
    __RV_CSR_SET(CSR_MIP, 1 << irq);
}

References __RV_CSR_SET, and CSR_MIP.

__disable_core_irq()

__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.

Remarks

Can only be executed in Privileged modes.

Definition at line 441 of file core_feature_base.h.

{
    __RV_CSR_CLEAR(CSR_MIE, 1 << irq);
}

References __RV_CSR_CLEAR, and CSR_MIE.

__disable_ext_irq()

__STATIC_FORCEINLINE void __disable_ext_irq

(

void

)

Disable External IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 386 of file core_feature_base.h.

{
    __RV_CSR_CLEAR(CSR_MIE, MIE_MEIE);
}

References __RV_CSR_CLEAR, CSR_MIE, and MIE_MEIE.

__disable_irq()

__STATIC_FORCEINLINE void __disable_irq

(

void

)

Disable IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 364 of file core_feature_base.h.

{
    __RV_CSR_CLEAR(CSR_MSTATUS, MSTATUS_MIE);
}

References __RV_CSR_CLEAR, CSR_MSTATUS, and MSTATUS_MIE.

__disable_sw_irq()

__STATIC_FORCEINLINE void __disable_sw_irq

(

void

)

Disable software IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 430 of file core_feature_base.h.

{
    __RV_CSR_CLEAR(CSR_MIE, MIE_MSIE);
}

References __RV_CSR_CLEAR, CSR_MIE, and MIE_MSIE.

__disable_timer_irq()

__STATIC_FORCEINLINE void __disable_timer_irq

(

void

)

Disable Timer IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 408 of file core_feature_base.h.

{
    __RV_CSR_CLEAR(CSR_MIE, MIE_MTIE);
}

References __RV_CSR_CLEAR, CSR_MIE, and MIE_MTIE.

__enable_core_irq()

__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.

Remarks

Can only be executed in Privileged modes.

Definition at line 452 of file core_feature_base.h.

{
    __RV_CSR_SET(CSR_MIE, 1 << irq);
}

References __RV_CSR_SET, and CSR_MIE.

__enable_ext_irq()

__STATIC_FORCEINLINE void __enable_ext_irq

(

void

)

Enable External IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 375 of file core_feature_base.h.

{
    __RV_CSR_SET(CSR_MIE, MIE_MEIE);
}

References __RV_CSR_SET, CSR_MIE, and MIE_MEIE.

Referenced by PLIC_Register_IRQ().

__enable_irq()

__STATIC_FORCEINLINE void __enable_irq

(

void

)

Enable IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 353 of file core_feature_base.h.

{
    __RV_CSR_SET(CSR_MSTATUS, MSTATUS_MIE);
}

References __RV_CSR_SET, CSR_MSTATUS, and MSTATUS_MIE.

__enable_sw_irq()

__STATIC_FORCEINLINE void __enable_sw_irq

(

void

)

Enable software IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 419 of file core_feature_base.h.

{
    __RV_CSR_SET(CSR_MIE, MIE_MSIE);
}

References __RV_CSR_SET, CSR_MIE, and MIE_MSIE.

Referenced by Core_Register_IRQ().

__enable_timer_irq()

__STATIC_FORCEINLINE void __enable_timer_irq

(

void

)

Enable Timer IRQ Interrupts.

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

Remarks

Can only be executed in Privileged modes.

Definition at line 397 of file core_feature_base.h.

{
    __RV_CSR_SET(CSR_MIE, MIE_MTIE);
}

References __RV_CSR_SET, CSR_MIE, and MIE_MTIE.

Referenced by Core_Register_IRQ(), and SysTick_Config().

__get_core_irq_pending()

__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.

Remarks

Can only be executed in Privileged modes.

Definition at line 463 of file core_feature_base.h.

{
    return ((__RV_CSR_READ(CSR_MIP) >> irq) & 0x1);
}

References __RV_CSR_READ, and CSR_MIP.

__get_rv_cycle()

__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

Returns

The whole 64 bits value of MCYCLE

Remarks

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

Definition at line 486 of file core_feature_base.h.

{
#if __RISCV_XLEN == 32
    volatile uint32_t high0, low, high;
    uint64_t full;
 
    high0 = __RV_CSR_READ(CSR_MCYCLEH);
    low = __RV_CSR_READ(CSR_MCYCLE);
    high = __RV_CSR_READ(CSR_MCYCLEH);
    if (high0 != high) {
        low = __RV_CSR_READ(CSR_MCYCLE);
    }
    full = (((uint64_t)high) << 32) | low;
    return full;
#elif __RISCV_XLEN == 64
    return (uint64_t)__RV_CSR_READ(CSR_MCYCLE);
#else // TODO Need cover for XLEN=128 case in future
    return (uint64_t)__RV_CSR_READ(CSR_MCYCLE);
#endif
}

References __RV_CSR_READ, CSR_MCYCLE, and CSR_MCYCLEH.

__get_rv_instret()

__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

Returns

The whole 64 bits value of MINSTRET

Remarks

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

Definition at line 513 of file core_feature_base.h.

{
#if __RISCV_XLEN == 32
    volatile uint32_t high0, low, high;
    uint64_t full;
 
    high0 = __RV_CSR_READ(CSR_MINSTRETH);
    low = __RV_CSR_READ(CSR_MINSTRET);
    high = __RV_CSR_READ(CSR_MINSTRETH);
    if (high0 != high) {
        low = __RV_CSR_READ(CSR_MINSTRET);
    }
    full = (((uint64_t)high) << 32) | low;
    return full;
#elif __RISCV_XLEN == 64
    return (uint64_t)__RV_CSR_READ(CSR_MINSTRET);
#else // TODO Need cover for XLEN=128 case in future
    return (uint64_t)__RV_CSR_READ(CSR_MINSTRET);
#endif
}

References __RV_CSR_READ, CSR_MINSTRET, and CSR_MINSTRETH.

__get_rv_time()

__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

Returns

The whole 64 bits value of TIME CSR

Remarks

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

Attention

only available when user mode available

Definition at line 541 of file core_feature_base.h.

{
#if __RISCV_XLEN == 32
    volatile uint32_t high0, low, high;
    uint64_t full;
 
    high0 = __RV_CSR_READ(CSR_TIMEH);
    low = __RV_CSR_READ(CSR_TIME);
    high = __RV_CSR_READ(CSR_TIMEH);
    if (high0 != high) {
        low = __RV_CSR_READ(CSR_TIME);
    }
    full = (((uint64_t)high) << 32) | low;
    return full;
#elif __RISCV_XLEN == 64
    return (uint64_t)__RV_CSR_READ(CSR_TIME);
#else // TODO Need cover for XLEN=128 case in future
    return (uint64_t)__RV_CSR_READ(CSR_TIME);
#endif
}

References __RV_CSR_READ, CSR_TIME, and CSR_TIMEH.