mpu.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Loci Controls Inc.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MPU_NUM_REGIONS ( (MPU->TYPE & MPU_TYPE_DREGION_Msk) >> MPU_TYPE_DREGION_Pos )
 
enum {
    AP_NO_NO = 0, 
    AP_RW_NO = 1, 
    AP_RW_RO = 2, 
    AP_RW_RW = 3, 
    AP_RO_NO = 5, 
    AP_RO_RO = 6, 
};
 
enum {
    MPU_SIZE_32B  =  4, 
    MPU_SIZE_64B  =  5, 
    MPU_SIZE_128B =  6, 
    MPU_SIZE_256B =  7, 
    MPU_SIZE_512B =  8, 
    MPU_SIZE_1K   =  9, 
    MPU_SIZE_2K   = 10, 
    MPU_SIZE_4K   = 11, 
    MPU_SIZE_8K   = 12, 
    MPU_SIZE_16K  = 13, 
    MPU_SIZE_32K  = 14, 
    MPU_SIZE_64K  = 15, 
    MPU_SIZE_128K = 16, 
    MPU_SIZE_256K = 17, 
    MPU_SIZE_512K = 18, 
    MPU_SIZE_1M   = 19, 
    MPU_SIZE_2M   = 20, 
    MPU_SIZE_4M   = 21, 
    MPU_SIZE_8M   = 22, 
    MPU_SIZE_16M  = 23, 
    MPU_SIZE_32M  = 24, 
    MPU_SIZE_64M  = 25, 
    MPU_SIZE_128M = 26, 
    MPU_SIZE_256M = 27, 
    MPU_SIZE_512M = 28, 
    MPU_SIZE_1G   = 29, 
    MPU_SIZE_2G   = 30, 
    MPU_SIZE_4G   = 31, 
};
 
#define MPU_SIZE_TO_BYTES(size) ( (uintptr_t)1 << ((size) + 1) )
 
static inline uint32_t MPU_ATTR(
    uint32_t xn,
    uint32_t ap,
    uint32_t tex,
    uint32_t c,
    uint32_t b,
    uint32_t s,
    uint32_t size)
{
    return
        (xn   << 28) |
        (ap   << 24) |
        (tex  << 19) |
        (s    << 18) |
        (c    << 17) |
        (b    << 16) |
        (size <<  1);
}
 
int mpu_disable(void);
 
int mpu_enable(void);
 
bool mpu_enabled(void);
 
int mpu_configure(uint_fast8_t region, uintptr_t base, uint_fast32_t attr);
 
#ifdef __cplusplus
}
#endif