Xtensa Memory Protection Unit (MPU) APIs

Data Structures
struct	xtensa_mpu_entry
	Foreground MPU Entry. More...
struct	xtensa_mpu_map
	Struct to hold foreground MPU map and its entries. More...
struct	xtensa_mpu_range
	Struct to describe a memory region [start, end). More...

Macros
#define	XTENSA_MPU_NUM_ENTRIES   XCHAL_MPU_ENTRIES
	Number of available entries in the MPU table.

Functions
void	xtensa_mpu_init (void)
	Initialize hardware MPU.

Variables
const struct xtensa_mpu_range	xtensa_soc_mpu_ranges []
	Additional memory regions required by SoC.
const int	xtensa_soc_mpu_ranges_num
	Number of SoC additional memory regions.

Memory domain and partitions
typedef uint32_t	k_mem_partition_attr_t
static bool	xtensa_mem_partition_is_executable (k_mem_partition_attr_t access_rights)
static bool	xtensa_mem_partition_is_writable (k_mem_partition_attr_t access_rights)
#define	K_MEM_PARTITION_IS_EXECUTABLE(access_rights)    (xtensa_mem_partition_is_executable(access_rights))
#define	K_MEM_PARTITION_IS_WRITABLE(access_rights)    (xtensa_mem_partition_is_writable(access_rights))
#define	K_MEM_PARTITION_P_RW_U_RW    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RW_U_RW})
#define	K_MEM_PARTITION_P_RW_U_NA    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RW_U_NA})
#define	K_MEM_PARTITION_P_RO_U_RO    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RO_U_RO})
#define	K_MEM_PARTITION_P_RO_U_NA    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RO_U_NA})
#define	K_MEM_PARTITION_P_NA_U_NA    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_NA_U_NA})
#define	K_MEM_PARTITION_P_RX_U_RX    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RX_U_RX})

MPU memory region access rights.
Note These are NOT bit masks, and must be used as whole value.
#define	XTENSA_MPU_ACCESS_P_NA_U_NA   (0)
	Kernel and user modes no access.
#define	XTENSA_MPU_ACCESS_P_X_U_NA   (2)
	Kernel mode execution only.
#define	XTENSA_MPU_ACCESS_P_NA_U_X   (3)
	User mode execution only.
#define	XTENSA_MPU_ACCESS_P_RO_U_NA   (4)
	Kernel mode read only.
#define	XTENSA_MPU_ACCESS_P_RX_U_NA   (5)
	Kernel mode read and execution.
#define	XTENSA_MPU_ACCESS_P_RW_U_NA   (6)
	Kernel mode read and write.
#define	XTENSA_MPU_ACCESS_P_RWX_U_NA   (7)
	Kernel mode read, write and execution.
#define	XTENSA_MPU_ACCESS_P_WO_U_WO   (8)
	Kernel and user modes write only.
#define	XTENSA_MPU_ACCESS_P_RW_U_RWX   (9)
	Kernel mode read, write.
#define	XTENSA_MPU_ACCESS_P_RW_U_RO   (10)
	Kernel mode read and write.
#define	XTENSA_MPU_ACCESS_P_RWX_U_RX   (11)
	Kernel mode read, write and execution.
#define	XTENSA_MPU_ACCESS_P_RO_U_RO   (12)
	Kernel and user modes read only.
#define	XTENSA_MPU_ACCESS_P_RX_U_RX   (13)
	Kernel and user modes read and execution.
#define	XTENSA_MPU_ACCESS_P_RW_U_RW   (14)
	Kernel and user modes read and write.
#define	XTENSA_MPU_ACCESS_P_RWX_U_RWX   (15)
	Kernel and user modes read, write and execution.

Detailed Description

Macro Definition Documentation

K_MEM_PARTITION_IS_EXECUTABLE

#define K_MEM_PARTITION_IS_EXECUTABLE

(

access_rights

)

(xtensa_mem_partition_is_executable(access_rights))

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_IS_WRITABLE

#define K_MEM_PARTITION_IS_WRITABLE

(

access_rights

)

(xtensa_mem_partition_is_writable(access_rights))

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_P_NA_U_NA

#define K_MEM_PARTITION_P_NA_U_NA    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_NA_U_NA})

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_P_RO_U_NA

#define K_MEM_PARTITION_P_RO_U_NA    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RO_U_NA})

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_P_RO_U_RO

#define K_MEM_PARTITION_P_RO_U_RO    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RO_U_RO})

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_P_RW_U_NA

#define K_MEM_PARTITION_P_RW_U_NA    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RW_U_NA})

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_P_RW_U_RW

#define K_MEM_PARTITION_P_RW_U_RW    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RW_U_RW})

#include <include/zephyr/arch/xtensa/mpu.h>

K_MEM_PARTITION_P_RX_U_RX

#define K_MEM_PARTITION_P_RX_U_RX    ((k_mem_partition_attr_t) {XTENSA_MPU_ACCESS_P_RX_U_RX})

#include <include/zephyr/arch/xtensa/mpu.h>

XTENSA_MPU_ACCESS_P_NA_U_NA

#define XTENSA_MPU_ACCESS_P_NA_U_NA   (0)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel and user modes no access.

XTENSA_MPU_ACCESS_P_NA_U_X

#define XTENSA_MPU_ACCESS_P_NA_U_X   (3)

#include <include/zephyr/arch/xtensa/mpu.h>

User mode execution only.

XTENSA_MPU_ACCESS_P_RO_U_NA

#define XTENSA_MPU_ACCESS_P_RO_U_NA   (4)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read only.

XTENSA_MPU_ACCESS_P_RO_U_RO

#define XTENSA_MPU_ACCESS_P_RO_U_RO   (12)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel and user modes read only.

XTENSA_MPU_ACCESS_P_RW_U_NA

#define XTENSA_MPU_ACCESS_P_RW_U_NA   (6)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read and write.

XTENSA_MPU_ACCESS_P_RW_U_RO

#define XTENSA_MPU_ACCESS_P_RW_U_RO   (10)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read and write.

User mode read only.

XTENSA_MPU_ACCESS_P_RW_U_RW

#define XTENSA_MPU_ACCESS_P_RW_U_RW   (14)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel and user modes read and write.

XTENSA_MPU_ACCESS_P_RW_U_RWX

#define XTENSA_MPU_ACCESS_P_RW_U_RWX   (9)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read, write.

User mode read, write and execution.

XTENSA_MPU_ACCESS_P_RWX_U_NA

#define XTENSA_MPU_ACCESS_P_RWX_U_NA   (7)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read, write and execution.

XTENSA_MPU_ACCESS_P_RWX_U_RWX

#define XTENSA_MPU_ACCESS_P_RWX_U_RWX   (15)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel and user modes read, write and execution.

XTENSA_MPU_ACCESS_P_RWX_U_RX

#define XTENSA_MPU_ACCESS_P_RWX_U_RX   (11)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read, write and execution.

User mode read and execution.

XTENSA_MPU_ACCESS_P_RX_U_NA

#define XTENSA_MPU_ACCESS_P_RX_U_NA   (5)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode read and execution.

XTENSA_MPU_ACCESS_P_RX_U_RX

#define XTENSA_MPU_ACCESS_P_RX_U_RX   (13)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel and user modes read and execution.

XTENSA_MPU_ACCESS_P_WO_U_WO

#define XTENSA_MPU_ACCESS_P_WO_U_WO   (8)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel and user modes write only.

XTENSA_MPU_ACCESS_P_X_U_NA

#define XTENSA_MPU_ACCESS_P_X_U_NA   (2)

#include <include/zephyr/arch/xtensa/mpu.h>

Kernel mode execution only.

XTENSA_MPU_NUM_ENTRIES

#define XTENSA_MPU_NUM_ENTRIES   XCHAL_MPU_ENTRIES

#include <include/zephyr/arch/xtensa/mpu.h>

Number of available entries in the MPU table.

Typedef Documentation

k_mem_partition_attr_t

typedef uint32_t k_mem_partition_attr_t

#include <include/zephyr/arch/xtensa/mpu.h>

Function Documentation

xtensa_mem_partition_is_executable()

static bool xtensa_mem_partition_is_executable ( k_mem_partition_attr_t  access_rights )

inlinestatic

#include <include/zephyr/arch/xtensa/mpu.h>

xtensa_mem_partition_is_writable()

static bool xtensa_mem_partition_is_writable ( k_mem_partition_attr_t  access_rights )

inlinestatic

#include <include/zephyr/arch/xtensa/mpu.h>

xtensa_mpu_init()

void xtensa_mpu_init

(

void

)

#include <include/zephyr/arch/xtensa/mpu.h>

Initialize hardware MPU.

This initializes the MPU hardware and setup the memory regions at boot.

Variable Documentation

xtensa_soc_mpu_ranges

const struct xtensa_mpu_range xtensa_soc_mpu_ranges[]

extern

#include <include/zephyr/arch/xtensa/mpu.h>

Additional memory regions required by SoC.

These memory regions will be setup by MPU initialization code at boot.

Must be defined in the SoC layer.

xtensa_soc_mpu_ranges_num

const int xtensa_soc_mpu_ranges_num

extern

#include <include/zephyr/arch/xtensa/mpu.h>

Number of SoC additional memory regions.

Must be defined in the SoC layer.