sdrv_firewall.h

Go to the documentation of this file.

 
#ifndef SDRV_FIREWALL_H
#define SDRV_FIREWALL_H
 
/***************************************************************************************************
 *                                      Include header files
 **************************************************************************************************/
#include <firewall_hw.h>
#include <sdrv_common.h>
#include <spinlock.h>
 
/***************************************************************************************************
 *                                 Global Macro definition
 **************************************************************************************************/
 
#define FIREWALL_PERMISSION_RW   (0x00U)
#define FIREWALL_PERMISSION_RO   (0x01U)
#define FIREWALL_PERMISSION_WO   (0x02U)
#define FIREWALL_PERMISSION_NONE (0x03U)
 
#define FIREWALL_UNINIT          (0x00U)
#define FIREWALL_INIT            (0x01U)
 
#define FIREWALL_REG_VALUE_MIN   (0x00U)
#define FIREWALL_REG_VALUE_MAX   (0xFFFFFFFFU)
 
#define FIREWALL_APB_MAC_BASE    APB_MAC_BASE
 
/***************************************************************************************************
 *                                  Global Types definition
 **************************************************************************************************/
typedef enum sdrv_firewall_err_status
{
    FIREWALL_E_OK = SDRV_STATUS_OK, 
    FIREWALL_E_INIT = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        0U), 
    FIREWALL_E_UNINIT = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL, 1U), 
    FIREWALL_E_NULL_POINTER = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        3U), 
    FIREWALL_E_MAC_MASTER_ID = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL, 4U), 
    FIREWALL_E_MAC_DOMAIN_ID = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL, 5U), 
    FIREWALL_E_MAC_LOCKED = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        6U), 
    FIREWALL_E_MPC_PORT_NUM = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        7U), 
    FIREWALL_E_MPC_REGION_NUM = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        8U), 
    FIREWALL_E_PPC_IP_NUM = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        9U), 
    FIREWALL_E_PPC_REGION_NUM = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        10U), 
    FIREWALL_E_GPIO_CORE_ID = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL, 11U), 
    FIREWALL_E_GPIO_CHANNEL_ID = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        12U), 
    FIREWALL_E_GPIO_CORE_NUM =
        SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FIREWALL,
                          13U), 
    FIREWALL_E_GPIO_CHANNEL_NUM = SDRV_ERROR_STATUS(
        SDRV_STATUS_GROUP_FIREWALL,
        14U), 
} sdrv_firewall_err_status_e;
 
typedef const uint8_t *sdrv_mac_config_t;
 
typedef struct mpc_region_cfg
{
    uint32_t start_addr;        
    uint32_t end_addr;          
    uint32_t domain0_perms : 4; 
    uint32_t domain1_perms : 4; 
    uint32_t domain2_perms : 4; 
    uint32_t domain3_perms : 4; 
    uint32_t domain4_perms : 4; 
    uint32_t domain5_perms : 4; 
    uint32_t domain6_perms : 4; 
    uint32_t domain7_perms : 4; 
} sdrv_mpc_region_cfg_t;
 
typedef struct mpc_memport_cfg
{
    uint16_t region_nr;   
    uint16_t base_offset; 
    const sdrv_mpc_region_cfg_t *const region_config;
} sdrv_mpc_memport_cfg_t;
 
typedef struct ppc_addrconfig
{
    uint8_t domain7_user_permission : 2;       
    uint8_t domain7_privileged_permission : 2; 
    uint8_t domain2_user_permission : 2;       
    uint8_t domain2_privileged_permission : 2; 
    uint8_t domain3_user_permission : 2;       
    uint8_t domain3_privileged_permission : 2; 
    uint8_t domain4_user_permission : 2;       
    uint8_t domain4_privileged_permission : 2; 
    uint8_t domain5_user_permission : 2;       
    uint8_t domain5_privileged_permission : 2; 
    uint8_t domain6_permission : 2; 
    uint8_t ppc_apbmux_id : 4;      
    uint8_t ppc_region_index;       
    uint32_t ppc_start_addr;        
    uint32_t ppc_end_addr;          
} sdrv_ppc_region_config_t;
 
typedef struct ppc_ipconfig
{
    uint8_t domain7_user_permission : 2;       
    uint8_t domain7_privileged_permission : 2; 
    uint8_t domain2_user_permission : 2;       
    uint8_t domain2_privileged_permission : 2; 
    uint8_t domain3_user_permission : 2;       
    uint8_t domain3_privileged_permission : 2; 
    uint8_t domain4_user_permission : 2;       
    uint8_t domain4_privileged_permission : 2; 
    uint8_t domain5_user_permission : 2;       
    uint8_t domain5_privileged_permission : 2; 
    uint8_t domain6_permission : 2; 
    uint8_t ppc_apbmux_id : 4; 
    uint8_t ppc_apbmux_ip_id;  
} sdrv_ppc_ip_config_t;
 
typedef struct gpio_channel_cfg
{
    const uint16_t *gpio_channel_id; 
    uint16_t gpio_channel_num;       
} sdrv_gpio_channel_cfg_t;
 
typedef struct gpio_core_cfg
{
    uint8_t gpio_user_permission : 2;               
    uint8_t gpio_privileged_permission : 2;         
    uint8_t gpio_core_id : 4;                       
    const sdrv_gpio_channel_cfg_t gpio_channel_cfg; 
} sdrv_gpio_core_cfg_t;
 
typedef struct
{
    uint32_t mpc_memport_id : 16; 
    uint32_t mpc_intr_sta : 16;   
} sdrv_mpc_irqsta_t;
 
typedef struct
{
    uint32_t ppc_apbmux_ip_id : 16; 
    uint32_t ppc_intr_sta : 16;     
} sdrv_ppc_irqsta_t;
 
typedef struct
{
    sdrv_ppc_irqsta_t
        ppc_errinfo[FIREWALL_PPC_APBMUX_MAXNUM]; 
    sdrv_mpc_irqsta_t
        mpc_errinfo[FIREWALL_MPC_MEMPORT_MAXNUM]; 
} sdrv_firewall_err_t;
 
typedef struct sdrv_firewall sdrv_firewall_t;
 
typedef void (*sdrv_firewall_callback_t)(sdrv_firewall_t *ctrl, void *userdata);
 
typedef struct
{
    const sdrv_mac_config_t
        *mac_cfg; 
    const sdrv_mpc_memport_cfg_t *mpc_cfg; 
    uint32_t memport_num;                  
    const sdrv_ppc_ip_config_t *ppc_ip_cfg; 
    uint16_t ip_num;                        
    const sdrv_ppc_region_config_t
        *ppc_region_cfg; 
    uint16_t region_num; 
    const sdrv_gpio_core_cfg_t
        *io_cfg;       
    uint16_t core_num; 
} sdrv_firewall_cfg_t;
 
struct sdrv_firewall
{
    uint32_t base;        
    int irq;              
    spin_lock_t spinlock; /* firewall spin lock. */
    uint8_t init_status;  
    sdrv_firewall_callback_t callback; 
    void *userdata;                 
    sdrv_firewall_err_t error_info; 
    const sdrv_firewall_cfg_t
        *config; 
};
 
/***************************************************************************************************
 *                                  Global Function Declarations
 **************************************************************************************************/
status_t sdrv_firewall_init(sdrv_firewall_t *ctrl,
                            const sdrv_firewall_cfg_t *cfg);
 
status_t sdrv_firewall_assign_domain(sdrv_firewall_t *ctrl, uint8_t master_id,
                                     uint8_t domain_id);
 
status_t sdrv_firewall_lock_domain_assignment(sdrv_firewall_t *ctrl);
 
status_t sdrv_firewall_set_callback(sdrv_firewall_t *ctrl,
                                    sdrv_firewall_callback_t callback,
                                    void *userdata);
 
int sdrv_firewall_irq_handler(uint32_t irq, void *ctrl);
 
status_t sdrv_firewall_get_error_info(sdrv_firewall_t *ctrl,
                                      sdrv_firewall_err_t *firewall_err_info);
 
#endif /* SDRV_FIREWALL_H */
 
/* End of file */