MpuP_armv7.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef MPUP_ARM_V7_H
#define MPUP_ARM_V7_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
typedef enum MpuP_AccessPerm_
{
    MpuP_AP_ALL_BLOCK = (0x0u), 
    MpuP_AP_S_RW      = (0x1u), 
    MpuP_AP_S_RW_U_R  = (0x2u), 
    MpuP_AP_ALL_RW    = (0x3u), 
    MpuP_AP_S_R       = (0x5u), 
    MpuP_AP_ALL_R     = (0x6u)  
} MpuP_AccessPerm;
 
typedef enum MpuP_RegionPerm_ {
    MpuP_RP_R  = 1U, 
    MpuP_RP_RW = 2U  
} MpuP_RegionPerm;
    
typedef enum MpuP_RegionSize_ {
    MpuP_RegionSize_32 = 0x4,
    MpuP_RegionSize_64,
    MpuP_RegionSize_128,
    MpuP_RegionSize_256,
    MpuP_RegionSize_512,
    MpuP_RegionSize_1K,
    MpuP_RegionSize_2K,
    MpuP_RegionSize_4K,
    MpuP_RegionSize_8K,
    MpuP_RegionSize_16K,
    MpuP_RegionSize_32K,
    MpuP_RegionSize_64K,
    MpuP_RegionSize_128K,
    MpuP_RegionSize_256K,
    MpuP_RegionSize_512K,
    MpuP_RegionSize_1M,
    MpuP_RegionSize_2M,
    MpuP_RegionSize_4M,
    MpuP_RegionSize_8M,
    MpuP_RegionSize_16M,
    MpuP_RegionSize_32M,
    MpuP_RegionSize_64M,
    MpuP_RegionSize_128M,
    MpuP_RegionSize_256M,
    MpuP_RegionSize_512M,
    MpuP_RegionSize_1G,
    MpuP_RegionSize_2G,
    MpuP_RegionSize_4G
} MpuP_RegionSize;
 
typedef struct MpuP_RegionAttrs_ {
 
    uint8_t isEnable; 
    uint8_t isCacheable; 
    uint8_t isBufferable; 
    uint8_t isSharable; 
    uint8_t isExecuteNever; 
    uint8_t tex; 
    uint8_t accessPerm; 
    uint8_t subregionDisableMask; 
} MpuP_RegionAttrs;
 
typedef struct MpuP_RegionConfig_ {
 
    uint32_t baseAddr;  
    uint32_t size; 
    MpuP_RegionAttrs attrs; 
} MpuP_RegionConfig;
 
typedef struct MpuP_Config_ {
 
    uint32_t numRegions;             
    uint32_t enableBackgroundRegion; 
    uint32_t enableMpu;              
} MpuP_Config;
 
void MpuP_RegionAttrs_init(MpuP_RegionAttrs *region);
 
void MpuP_setRegion(uint32_t regionNum, void * addr, uint32_t size, MpuP_RegionAttrs *attrs);
 
void MpuP_enable(void);
 
void MpuP_disable(void);
 
uint32_t MpuP_isEnable(void);
 
void MpuP_init(void);
 
uint32_t MpuP_isUserAuthorizedToAccessMemory(uint32_t memAddr, uint32_t memLength, MpuP_RegionPerm perm);
 
#ifdef __cplusplus
}
#endif
 
#endif /* MPUP_ARM_V7_H */