arch.h File Reference

RISCV specific kernel interface header. More...

#include <zephyr/arch/riscv/thread.h>
#include <zephyr/arch/exception.h>
#include <zephyr/arch/riscv/irq.h>
#include <zephyr/arch/riscv/sys_io.h>
#include <zephyr/arch/common/sys_bitops.h>
#include <zephyr/arch/common/ffs.h>
#include <zephyr/arch/riscv/syscall.h>
#include <zephyr/irq.h>
#include <zephyr/sw_isr_table.h>
#include <zephyr/devicetree.h>
#include <zephyr/arch/riscv/csr.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/slist.h>
#include <zephyr/arch/riscv/error.h>

Go to the source code of this file.

Data Structures
struct	k_mem_partition_attr_t
struct	arch_mem_domain

Macros
#define	ARCH_STACK_PTR_ALIGN   16
#define	ARCH_THREAD_STACK_RESERVED
#define	ARCH_THREAD_STACK_SIZE_ADJUST(size)
#define	ARCH_THREAD_STACK_OBJ_ALIGN(size)
#define	RV_REGSIZE   4
#define	RV_REGSHIFT   2
#define	MSTATUS_IEN   (1UL << 3)
#define	MSTATUS_MPP_U   (PRV_U << 11)
	mstatus MPP field value for User mode
#define	MSTATUS_MPP_S   (PRV_S << 11)
	mstatus MPP field value for Supervisor mode
#define	MSTATUS_MPP_M   (PRV_M << 11)
	mstatus MPP field value for Machine mode
#define	MSTATUS_MPIE_EN   (1UL << 7)
#define	MSTATUS_FS_OFF   (0UL << 13)
#define	MSTATUS_FS_INIT   (1UL << 13)
#define	MSTATUS_FS_CLEAN   (2UL << 13)
#define	MSTATUS_FS_DIRTY   (3UL << 13)
#define	RV_STATUS_DEF_RESTORE   (MSTATUS_MPP_M | MSTATUS_MPIE_EN)
	Default status register value to restore when starting a new thread.
#define	RV_STATUS_PP   MSTATUS_MPP
	Previous-privilege field mask in the status CSR (M-mode: MPP).
#define	RV_STATUS_PP_U   PRV_U
	Previous-privilege field value representing User mode (M-mode).
#define	K_MEM_PARTITION_P_RW_U_RW
#define	K_MEM_PARTITION_P_RW_U_RO
#define	K_MEM_PARTITION_P_RW_U_NA
#define	K_MEM_PARTITION_P_RO_U_RO
#define	K_MEM_PARTITION_P_RO_U_NA
#define	K_MEM_PARTITION_P_NA_U_NA
#define	K_MEM_PARTITION_P_RWX_U_RWX
#define	K_MEM_PARTITION_P_RX_U_RX
#define	RV_STATUS_CSR   "mstatus"
	Name of the interrupt-status CSR as a string literal (M-mode).
#define	RV_STATUS_IE   MSTATUS_IEN
	Interrupt-enable bit in the status CSR (M-mode: MIE).
#define	RV_STATUS_PIE   MSTATUS_MPIE_EN
	Previous interrupt-enable bit in the status CSR (M-mode: MPIE).

Functions
static ALWAYS_INLINE unsigned int	arch_irq_lock (void)
static ALWAYS_INLINE void	arch_irq_unlock (unsigned int key)
static ALWAYS_INLINE bool	arch_irq_unlocked (unsigned int key)
static ALWAYS_INLINE bool	arch_cpu_irqs_are_enabled (void)
	Implementation of arch_cpu_irqs_are_enabled.
static ALWAYS_INLINE void	arch_nop (void)
uint32_t	sys_clock_cycle_get_32 (void)
static uint32_t	arch_k_cycle_get_32 (void)
uint64_t	sys_clock_cycle_get_64 (void)
static uint64_t	arch_k_cycle_get_64 (void)

Detailed Description

RISCV specific kernel interface header.

This header contains the RISCV specific kernel interface. It is included by the kernel interface architecture-abstraction header (include/zephyr/arch/cpu.h).

Macro Definition Documentation

ARCH_STACK_PTR_ALIGN

#define ARCH_STACK_PTR_ALIGN   16

ARCH_THREAD_STACK_OBJ_ALIGN

#define ARCH_THREAD_STACK_OBJ_ALIGN

(

size

)

Value:

Z_RISCV_STACK_PMP_ALIGN

ARCH_THREAD_STACK_RESERVED

#define ARCH_THREAD_STACK_RESERVED

Value:

ROUND_UP(Z_RISCV_STACK_GUARD_SIZE + CONFIG_PRIVILEGED_STACK_SIZE, \
         Z_RISCV_STACK_PMP_ALIGN)

ARCH_THREAD_STACK_SIZE_ADJUST

#define ARCH_THREAD_STACK_SIZE_ADJUST

(

size

)

Value:

ROUND_UP(size, Z_RISCV_STACK_PMP_ALIGN)

K_MEM_PARTITION_P_NA_U_NA

#define K_MEM_PARTITION_P_NA_U_NA

Value:

((k_mem_partition_attr_t) \
{0})

K_MEM_PARTITION_P_RO_U_NA

#define K_MEM_PARTITION_P_RO_U_NA

Value:

((k_mem_partition_attr_t) \
{0})

K_MEM_PARTITION_P_RO_U_RO

#define K_MEM_PARTITION_P_RO_U_RO

Value:

((k_mem_partition_attr_t) \
{PMP_R})

K_MEM_PARTITION_P_RW_U_NA

#define K_MEM_PARTITION_P_RW_U_NA

Value:

((k_mem_partition_attr_t) \
{0})

K_MEM_PARTITION_P_RW_U_RO

#define K_MEM_PARTITION_P_RW_U_RO

Value:

((k_mem_partition_attr_t) \
{PMP_R})

K_MEM_PARTITION_P_RW_U_RW

#define K_MEM_PARTITION_P_RW_U_RW

Value:

((k_mem_partition_attr_t) \
{PMP_R | PMP_W})

K_MEM_PARTITION_P_RWX_U_RWX

#define K_MEM_PARTITION_P_RWX_U_RWX

Value:

((k_mem_partition_attr_t) \
{PMP_R | PMP_W | PMP_X})

K_MEM_PARTITION_P_RX_U_RX

#define K_MEM_PARTITION_P_RX_U_RX

Value:

((k_mem_partition_attr_t) \
{PMP_R | PMP_X})

MSTATUS_FS_CLEAN

#define MSTATUS_FS_CLEAN   (2UL << 13)

MSTATUS_FS_DIRTY

#define MSTATUS_FS_DIRTY   (3UL << 13)

MSTATUS_FS_INIT

#define MSTATUS_FS_INIT   (1UL << 13)

MSTATUS_FS_OFF

#define MSTATUS_FS_OFF   (0UL << 13)

MSTATUS_IEN

#define MSTATUS_IEN   (1UL << 3)

MSTATUS_MPIE_EN

#define MSTATUS_MPIE_EN   (1UL << 7)

MSTATUS_MPP_M

#define MSTATUS_MPP_M   (PRV_M << 11)

mstatus MPP field value for Machine mode

MSTATUS_MPP_S

#define MSTATUS_MPP_S   (PRV_S << 11)

mstatus MPP field value for Supervisor mode

MSTATUS_MPP_U

#define MSTATUS_MPP_U   (PRV_U << 11)

mstatus MPP field value for User mode

RV_REGSHIFT

#define RV_REGSHIFT   2

RV_REGSIZE

#define RV_REGSIZE   4

RV_STATUS_CSR

#define RV_STATUS_CSR   "mstatus"

Name of the interrupt-status CSR as a string literal (M-mode).

RV_STATUS_DEF_RESTORE

#define RV_STATUS_DEF_RESTORE   (MSTATUS_MPP_M | MSTATUS_MPIE_EN)

Default status register value to restore when starting a new thread.

This comes from openisa_rv32m1, but doesn't seem to hurt on other platforms:

• Preserve machine privileges in MPP. If you see any documentation telling you that MPP is read-only on this SoC, don't believe its lies.
• Enable interrupts when exiting from exception into a new thread by setting MPIE now, so it will be copied into IE on mret.

In S-mode (CONFIG_RISCV_S_MODE), use the sstatus equivalents:

• SPP=1 so that sret returns to S-mode (not U-mode)
• SPIE=1 so that interrupts are enabled after sret

RV_STATUS_IE

#define RV_STATUS_IE   MSTATUS_IEN

Interrupt-enable bit in the status CSR (M-mode: MIE).

RV_STATUS_PIE

#define RV_STATUS_PIE   MSTATUS_MPIE_EN

Previous interrupt-enable bit in the status CSR (M-mode: MPIE).

RV_STATUS_PP

#define RV_STATUS_PP   MSTATUS_MPP

Previous-privilege field mask in the status CSR (M-mode: MPP).

RV_STATUS_PP_U

#define RV_STATUS_PP_U   PRV_U

Previous-privilege field value representing User mode (M-mode).

Function Documentation

arch_cpu_irqs_are_enabled()

ALWAYS_INLINE bool arch_cpu_irqs_are_enabled ( void )

static

Implementation of arch_cpu_irqs_are_enabled.

arch_irq_lock()

ALWAYS_INLINE unsigned int arch_irq_lock ( void )

static

arch_irq_unlock()

ALWAYS_INLINE void arch_irq_unlock ( unsigned int key )

static

arch_irq_unlocked()

ALWAYS_INLINE bool arch_irq_unlocked ( unsigned int key )

static

arch_k_cycle_get_32()

uint32_t arch_k_cycle_get_32 ( void )

inlinestatic

arch_k_cycle_get_64()

uint64_t arch_k_cycle_get_64 ( void )

inlinestatic

arch_nop()

ALWAYS_INLINE void arch_nop ( void )

static

sys_clock_cycle_get_32()

uint32_t sys_clock_cycle_get_32 ( void )

extern

sys_clock_cycle_get_64()

uint64_t sys_clock_cycle_get_64 ( void )

extern