mpu.h

#pragma once
 
/************************************************************************************************
 * @file   mpu.h
 *
 * @brief  MPU Library Header file
 *
 * @date   2024-11-03
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "status.h"
 
typedef enum { MPU_REGION_0, MPU_REGION_1, MPU_REGION_2, MPU_REGION_3, MPU_REGION_4, MPU_REGION_5, MPU_REGION_6, MPU_REGION_7, NUM_MPU_REGIONS } MPURegionNumber;
 
typedef enum {
  MPU_ACCESS_NONE,
  MPU_ACCESS_PRIV_RW,
  MPU_ACCESS_PRIV_RW_URO,
  MPU_ACCESS_FULL,
  MPU_ACCESS_PRIV_RO = 0x05,
  MPU_ACCESS_PRIV_RO_URO,
} MPUAccessPerm;
 
typedef struct {
  bool enable;
  MPURegionNumber number;
  uint32_t base_address;
  uint32_t size;
} MPURegion;
 
typedef struct {
  MPUAccessPerm access_permission;
  bool disable_code_exec;
  bool is_cacheable;
  bool is_bufferable;
} MPURegionSettings;
 
StatusCode mpu_configure_region(MPURegion *region, MPURegionSettings *settings);
 
StatusCode mpu_enable_region(MPURegionNumber region_number);
 
StatusCode mpu_disable_region(MPURegionNumber region_number);
 
StatusCode mpu_init(void);