freertos_mpu.h

Go to the documentation of this file.

#ifndef NEXUS_OS_FREERTOS_MPU_H
#define NEXUS_OS_FREERTOS_MPU_H
 
#include "FreeRTOS.h"
#include "nexus/core/status.h"
#include "nexus/os/freertos_user.h"
#include "task.h"
 
#if configENABLE_MPU != 1 || portUSING_MPU_WRAPPERS != 1
#error "MPU task lifecycle requires an explicit maintained MPU kernel profile"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    NX_FREERTOS_MPU_READ_ONLY = 0,
    NX_FREERTOS_MPU_READ_WRITE = 1
} nx_freertos_mpu_access_t;

typedef struct {
    void* address;
    size_t bytes;
    nx_freertos_mpu_access_t access;
} nx_freertos_mpu_region_t;

typedef struct {
    StaticTask_t control;
    TaskHandle_t handle;
} nx_freertos_mpu_task_t;

typedef struct {
    TaskFunction_t entry;
    void* context;
    size_t context_bytes;
    const char* name;
    StackType_t* stack;
    size_t stack_words;
    UBaseType_t priority;
    const nx_freertos_mpu_region_t* regions;
    size_t region_count;
} nx_freertos_mpu_config_t;

nx_result_t nx_freertos_mpu_task_start(nx_freertos_mpu_task_t* task,
                                       const nx_freertos_mpu_config_t* config)
    PRIVILEGED_FUNCTION;

nx_result_t
nx_freertos_mpu_task_delete(nx_freertos_mpu_task_t* task) PRIVILEGED_FUNCTION;
 
#ifdef __cplusplus
}
#endif
 
#endif /* NEXUS_OS_FREERTOS_MPU_H */