firewall/v0/firewall.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022-23 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 FIREWALL_H_
#define FIREWALL_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <string.h>
#include <drivers/soc.h>
#include <kernel/dpl/HwiP.h>
#include <kernel/dpl/SemaphoreP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define FWL_MAX_PRIVID_SLOTS                    (3U)
 
#define FWL_MAX_ID                              (35U)
#define FWL_MAX_REGION                          (16U)
 
#define PRIVID_NONE                             (0U)
#define PRIVID_ALLOW_EVERYONE                   (195U)
#define PRIVID_DMSC                             (202U)
#define PRIVID_BLOCK_EVERYONE                   (197U)
#define PRIVID_SPROXY_PRIVATE                   (11U)
#define PRIVID_A53_NON_SECURE                   (1U)
#define PRIVID_A53_SECURE                       (1U)
#define PRIVID_M4_0_NON_SECURE                  (100U)
#define PRIVID_MAIN_0_R5_0_NONSECURE            (212U)
#define PRIVID_MAIN_0_R5_0_SECURE               (212U)
#define PRIVID_MAIN_0_R5_1_NONSECURE            (213U)
#define PRIVID_MAIN_0_R5_1_SECURE               (213U)
#define PRIVID_MAIN_1_R5_0_NONSECURE            (214U)
#define PRIVID_MAIN_1_R5_0_SECURE               (214U)
#define PRIVID_MAIN_1_R5_1_NONSECURE            (215U)
#define PRIVID_MAIN_1_R5_1_SECURE               (215U)
#define PRIVID_MAIN_0_ICSSG_0                   (136U)
 
#define FWL_CONTROL_ENABLE_MASK                (0xFU)
#define FWL_CONTROL_DISABLE                    (0x0U)
#define FWL_CONTROL_ENABLE                     (0xAU)
#define FWL_CONTROL_LOCK                       (0x10U)
#define FWL_CONTROL_BG                         (0x100U)
#define FWL_CONTROL_CACHE_MODE                 (0x200U)
 
#define FWL_PERM_SEC_MASK                     (0x00FFU)
#define FWL_PERM_NSEC_MASK                    (0xFF00U)
#define FWL_PERM_PRIV_MASK                    (0x0F0FU)
#define FWL_PERM_USER_MASK                    (0xF0F0U)
 
#define FWL_PERM_WRITE_MASK                   (0x1111U)
#define FWL_PERM_READ_MASK                    (0x2222U)
#define FWL_PERM_CACHE_MASK                   (0x4444U)
#define FWL_PERM_DEBUG_MASK                   (0x8888U)
#define FWL_PERM_DENY_ALL                     (0x0000U)
 
#define FWL_PERM_RW_ALL                        (FWL_PERM_WRITE_MASK | \
                        FWL_PERM_READ_MASK | \
                        FWL_PERM_CACHE_MASK | \
                        FWL_PERM_DEBUG_MASK)
 
#define FWL_PERM_RO_ALL                        (FWL_PERM_READ_MASK | \
                        FWL_PERM_CACHE_MASK | \
                        FWL_PERM_DEBUG_MASK)
 
#define FWL_PERM_WO_ALL                        (FWL_PERM_WRITE_MASK | \
                        FWL_PERM_CACHE_MASK | \
                        FWL_PERM_DEBUG_MASK)
 
#define FWL_PERM_SEC_RW                        (FWL_PERM_SEC_MASK & \
                        FWL_PERM_RW_ALL)
 
#define FWL_PERM_NSEC_RW                       (FWL_PERM_NSEC_MASK & \
                        FWL_PERM_RW_ALL)
 
#define FWL_PERM_PRIV_RW                       (FWL_PERM_PRIV_MASK & \
                        FWL_PERM_RW_ALL)
 
#define FWL_PERM_USER_RW                       (FWL_PERM_USER_MASK & \
                        FWL_PERM_RW_ALL)
 
#define FWL_PERM_SEC_RO                        (FWL_PERM_SEC_MASK & \
                        FWL_PERM_RO_ALL)
 
#define FWL_PERM_NSEC_RO                       (FWL_PERM_NSEC_MASK & \
                        FWL_PERM_RO_ALL)
 
#define FWL_PERM_PRIV_RO                       (FWL_PERM_PRIV_MASK & \
                        FWL_PERM_RO_ALL)
 
#define FWL_PERM_USER_RO                       (FWL_PERM_USER_MASK & \
                        FWL_PERM_RO_ALL)
 
/* ========================================================================== */
/*                             Structure Definitions                          */
/* ========================================================================== */
 
 
typedef struct
{
    uint16_t        regionIndex;
    uint32_t        control;
    uint32_t        permissions[FWL_MAX_PRIVID_SLOTS];
    uint64_t        startAddr;
    uint64_t        endAddr;
} Firewall_RegionCfg;
 
typedef struct {
    /* Id of Firewall to be used */
    uint32_t    firewallId;
    /* Number of regions in the firewall */
    uint32_t    totalRegions;
    /* Number of regions initialized */
    uint32_t    initRegions;
    /* Region configuration */
    Firewall_RegionCfg *regionInfo;
}Firewall_Attrs;
 
 
typedef void *Firewall_Handle;
 
typedef struct
{
    Firewall_Handle handle;
    uint32_t cfgDone;
} Firewall_Object;
 
typedef struct
{
    Firewall_Attrs       *attrs;
    Firewall_Object      *object;
 
} Firewall_Config;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void Firewall_init(void);
 
void Firewall_deinit(void);
 
int32_t Firewall_open(Firewall_Handle handle);
 
void Firewall_close(Firewall_Handle handle);
 
int32_t Firewall_configureSingleRegion(uint32_t firewallId, Firewall_RegionCfg *region);
 
int32_t Firewall_configureRegion(Firewall_Handle handle);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef FIREWALL_H_ */