mpu_firewall/v0/mpu_firewall.h

Go to the documentation of this file.

/*
 *  Copyright (C) 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 MPU_FIREWALL_H_
#define MPU_FIREWALL_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <drivers/hw_include/cslr_soc.h>
#include <drivers/mpu_firewall/v0/cslr_mpu.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef enum Fwl_Return_e
{
    FWL_DRV_RETURN_SUCCESS                  = 0xBA14D51BU, 
    FWL_DRV_RETURN_FAILURE                  = 0xAADF4AFAU, 
}Fwl_Return_t;
 
typedef struct
{
    uint32_t  startAddr ;
    uint32_t regionSize ;
 
}Firewall_Target;
 
typedef struct
{
    uint32_t  baseAddr ;
    uint32_t  numRegions ;
    uint32_t targetCount ;
    Firewall_Target *target;
 
}MPU_FIREWALL_Config;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t  id ;
    uint32_t  regionNumber ;
    uint32_t startAddress ;
    uint32_t endAddress ;
    uint32_t aidConfig ;
    uint8_t aidxConfig ;
    uint8_t supervisorReadConfig ;
    uint8_t supervisorWriteConfig ;
    uint8_t supervisorExecConfig ;
    uint8_t userReadConfig ;
    uint8_t userWriteConfig ;
    uint8_t userExecConfig ;
    uint8_t nonSecureConfig ;
    uint8_t debugConfig ;
 
}MPU_FIREWALL_RegionParams;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
Fwl_Return_t MPU_FIREWALL_getRegion(MPU_FIREWALL_RegionParams* mpuParams);
 
Fwl_Return_t MPU_FIREWALL_getFirewallConfig(uint32_t firewallId, MPU_FIREWALL_Config** firewallConfig);
 
Fwl_Return_t MPU_FIREWALL_readFaultAddress (uint32_t firewallId, uint32_t* faultAddress);
 
Fwl_Return_t MPU_FIREWALL_readFaultStatus (uint32_t firewallId, uint32_t* faultStatus);
 
Fwl_Return_t MPU_FIREWALL_getInterruptStatus (uint32_t firewallId, uint32_t* interruptStatus);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef MPU_FIREWALL_H_ */