MmuP_armv8.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 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 MMUP_ARMV8_H
#define MMUP_ARMV8_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
typedef enum MmuP_AccessPerm_ {
    MMUP_ACCESS_PERM_PRIV_RW_USER_NONE = 0x0, 
    MMUP_ACCESS_PERM_PRIV_RW_USER_RW = 0x1, 
    MMUP_ACCESS_PERM_PRIV_RO_USER_NONE = 0x2, 
    MMUP_ACCESS_PERM_PRIV_RO_USER_RO = 0x3 
} MmuP_AccessPerm;
 
typedef enum MmuP_Shareable_ {
    MMUP_SHARABLE_NONE = 0x0, 
    MMUP_SHARABLE_OUTER = 0x2, 
    MMUP_SHARABLE_INNER = 0x3 
} MmuP_Shareable;
 
typedef enum MmuP_AttrIndx_ {
    MMUP_ATTRINDX_MAIR0 = 0,
    MMUP_ATTRINDX_MAIR1,
    MMUP_ATTRINDX_MAIR2,
    MMUP_ATTRINDX_MAIR3,
    MMUP_ATTRINDX_MAIR4,
    MMUP_ATTRINDX_MAIR5,
    MMUP_ATTRINDX_MAIR6,
    MMUP_ATTRINDX_MAIR7
} MmuP_AttrIndx;
 
typedef struct MmuP_MapAttrs_ {
    MmuP_AccessPerm accessPerm; 
    uint8_t privExecute; 
    uint8_t userExecute; 
    MmuP_Shareable shareable; 
    MmuP_AttrIndx attrIndx; 
    uint8_t global; 
} MmuP_MapAttrs;
 
typedef struct MmuP_Config_ {
    uint32_t numRegions;    
    uint8_t enableMmu;      
} MmuP_Config;
 
typedef struct MmuP_RegionConfig_ {
    uint64_t vaddr;     
    uint64_t paddr;     
    uint32_t size;      
    MmuP_MapAttrs attr; 
} MmuP_RegionConfig;
 
void MmuP_MapAttrs_init(MmuP_MapAttrs *attrs);
 
void MmuP_enable();
 
void MmuP_disable(void);
 
uint32_t MmuP_isEnabled();
 
/* Memory map */
 
int32_t MmuP_map(uintptr_t vaddr, uintptr_t paddr, uint32_t size, MmuP_MapAttrs *mapAttrs);
 
void MmuP_init();
 
#ifdef __cplusplus
}
#endif
 
#endif /* MMUP_ARMV8_H */