arm_mpu.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Linaro Limited.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_ARCH_ARM_MPU_ARM_MPU_H_
#define ZEPHYR_INCLUDE_ARCH_ARM_MPU_ARM_MPU_H_
 
#if defined(CONFIG_ARMV8_M_MAINLINE) || defined(CONFIG_ARMV8_M_BASELINE) ||                        \
        defined(CONFIG_AARCH32_ARMV8_R)
/* PMSAv8 MPU */
#define Z_ARM_CPU_HAS_PMSAV8_MPU 1
#include <zephyr/arch/arm/mpu/arm_mpu_v8.h>
#else
/* PMSAv6 / PMSAv7 (MPU is identical) */
#define Z_ARM_CPU_HAS_PMSAV8_MPU 0
#include <zephyr/arch/arm/mpu/arm_mpu_v7m.h>
#endif
 
#if defined(CONFIG_ARMV7_M_ARMV8_M_MAINLINE) || defined(CONFIG_ARMV8_M_MAINLINE)
#define Z_ARM_MPU_MAX_REGIONS 16U
#else
#define Z_ARM_MPU_MAX_REGIONS 8U
#endif
 
 
#ifndef _ASMLANGUAGE
#include <stdint.h>
 
/* Region definition data structure */
struct arm_mpu_region {
        /* Region Base Address */
        uint32_t base;
        /* Region Name */
        const char *name;
#if defined(CONFIG_CPU_AARCH32_CORTEX_R)
        /* Region Size */
        uint32_t size;
#endif
        /* Region Attributes */
        arm_mpu_region_attr_t attr;
};
 
/* MPU configuration data structure */
struct arm_mpu_config {
        /* Number of regions */
        uint32_t num_regions;
        /* Regions */
        const struct arm_mpu_region *mpu_regions;
};
 
#if defined(CONFIG_ARMV7_R)
#define MPU_REGION_ENTRY(_name, _base, _size, _attr)                                               \
        {                                                                                          \
                .name = _name,                                                                     \
                .base = _base,                                                                     \
                .size = _size,                                                                     \
                .attr = _attr,                                                                     \
        }
#else
#define MPU_REGION_ENTRY(_name, _base, _attr)                                                      \
        {                                                                                          \
                .name = _name,                                                                     \
                .base = _base,                                                                     \
                .attr = _attr,                                                                     \
        }
#endif
 
/* Reference to the MPU configuration.
 *
 * This struct is defined and populated for each SoC (in the SoC definition),
 * and holds the build-time configuration information for the fixed MPU
 * regions enabled during kernel initialization. Dynamic MPU regions (e.g.
 * for Thread Stack, Stack Guards, etc.) are programmed during runtime, thus,
 * not kept here.
 */
extern const struct arm_mpu_config mpu_config;
 
#if defined(CONFIG_CPU_CORTEX_M)
struct z_mpu_context_retained {
        uint32_t rbar[Z_ARM_MPU_MAX_REGIONS];
        uint32_t rasr_rlar[Z_ARM_MPU_MAX_REGIONS];
#if Z_ARM_CPU_HAS_PMSAV8_MPU
        uint32_t mair[2];
#endif
        uint32_t ctrl;
        uint32_t num_valid_regions;
};

void z_arm_save_mpu_context(struct z_mpu_context_retained *ctx);

void z_arm_restore_mpu_context(const struct z_mpu_context_retained *ctx);
 
#endif /* CONFIG_CPU_CORTEX_M */
#endif /* _ASMLANGUAGE */
 
#endif /* ZEPHYR_INCLUDE_ARCH_ARM_MPU_ARM_MPU_H_ */