ra8_mpu.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_ra8_mpu_perm_none = 0U, 
  k_ra8_mpu_perm_ro   = 1U, 
  k_ra8_mpu_perm_rw   = 2U, 
} ra8_mpu_perm_t;

typedef enum : uint8_t {
  k_ra8_mpu_share_non   = 0U, 
  k_ra8_mpu_share_outer = 2U, 
  k_ra8_mpu_share_inner = 3U, 
} ra8_mpu_share_t;

typedef enum : uint8_t {
  k_ra8_mpu_attr_idx_0 = 0U, 
  k_ra8_mpu_attr_idx_1 = 1U, 
  k_ra8_mpu_attr_idx_2 = 2U, 
  k_ra8_mpu_attr_idx_3 = 3U, 
  k_ra8_mpu_attr_idx_4 = 4U, 
  k_ra8_mpu_attr_idx_5 = 5U, 
  k_ra8_mpu_attr_idx_6 = 6U, 
  k_ra8_mpu_attr_idx_7 = 7U, 
} ra8_mpu_attr_idx_t;

typedef enum : uint32_t {
  k_ra8_mpu_min_region_size = 32U, 
} ra8_mpu_size_limits_t;

typedef enum : uint8_t {
  k_ra8_mpu_boot_region_count = 5U, 
} ra8_mpu_boot_layout_t;

typedef enum : uint32_t {
  k_ra8_mpu_boot_mair0 = 0x000444FFUL, 
  k_ra8_mpu_boot_mair1 = 0x00000000UL, 
} ra8_mpu_boot_mair_t;

typedef struct {
  uintptr_t          base;       
  uint32_t           size;       
  ra8_mpu_perm_t     priv;       
  ra8_mpu_perm_t     unpriv;     
  bool               executable; 
  ra8_mpu_share_t    shareable;  
  ra8_mpu_attr_idx_t attr_idx;   
} ra8_mpu_region_t;

typedef struct {
  const ra8_mpu_region_t* regions;      
  uint8_t                 region_count; 
  uint32_t                mair0;        
  uint32_t                mair1;        
  bool                    privdefena;   
  bool                    hfnmiena;     
} ra8_mpu_cfg_t;

[[nodiscard]] ra8_err_t ra8_mpu_configure(const ra8_mpu_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_mpu_enable(void);

[[nodiscard]] ra8_err_t ra8_mpu_disable(void);

[[nodiscard]] ra8_err_t ra8_mpu_set_region(uint8_t region, const ra8_mpu_region_t* region_cfg);

[[nodiscard]] ra8_err_t ra8_mpu_apply_boot_map(void);

const ra8_mpu_region_t* ra8_mpu_boot_map(uint8_t* out_count);

[[nodiscard]] bool ra8_mpu_is_enabled(void);
 
#ifdef __cplusplus
}
#endif