APIs for MPU Firewall

Introduction

This module contains APIs to program the MPU Firewall module.

Files
file	mpu_firewall/v0/mpu_firewall.h
	MPU Firewall Driver API/interface file.

Data Structures
struct	MPU_FIREWALL_RegionParams
	MPU Region Parameters. More...
struct	MPU_FIREWALL_Config
	MPU Firewall Parameters. More...

Functions
void	MPU_FIREWALL_init ()
	This function initializes the MPU Firewall module. More...
int32_t	MPU_FIREWALL_setRegion (MPU_FIREWALL_RegionParams *mpuParams)
	Function to configure a Firewall region. More...
int32_t	MPU_FIREWALL_getFirewallConfig (uint32_t firewallId, MPU_FIREWALL_Config **firewallConfig)
	Function to get parameters of a firewall. More...
void	MPU_FIREWALL_RegionParams_init (MPU_FIREWALL_RegionParams *mpuParams)
	Function to initialize the parameters of a region. More...
uint32_t	MPU_FIREWALL_readFaultAddress (uint32_t baseAddr)
	Function to read the fault address that created the firewall violation. More...
uint32_t	MPU_FIREWALL_readFaultStatus (uint32_t baseAddr)
	Function to read the fault status register. It contains information on the kind of firewall violation that had occurred. More...
void	MPU_FIREWALL_clearFault (uint32_t baseAddr)
	Function to clear MPU Firewall fault address and fault status register . More...
void	MPU_FIREWALL_interruptEnable (uint32_t baseAddr, uint32_t flag)
	Function to enable MPU Firewall interrupt. More...
void	MPU_FIREWALL_clearInterruptEnable (uint32_t baseAddr, uint32_t flag)
	Function to disable MPU Firewall interrupt. More...
void	MPU_FIREWALL_setInterruptStatus (uint32_t baseAddr, uint32_t flag)
	Function to set interrupt. This can be used for testing interrupts. More...
uint32_t	MPU_FIREWALL_getInterruptStatus (uint32_t baseAddr)
	Function to read interrupt status. More...
void	MPU_FIREWALL_clearInterruptStatus (uint32_t baseAddr, uint32_t flag)
	Function to clear interrupt status. More...

Function Documentation

MPU_FIREWALL_init()

void MPU_FIREWALL_init

(

)

This function initializes the MPU Firewall module.

MPU_FIREWALL_setRegion()

int32_t MPU_FIREWALL_setRegion

(

MPU_FIREWALL_RegionParams *

mpuParams

)

Function to configure a Firewall region.

Parameters

mpuParams

Structure containing all region configuration parameters.

Returns

SystemP_SUCCESS on successful region configuration; else error on failure

MPU_FIREWALL_getFirewallConfig()

int32_t MPU_FIREWALL_getFirewallConfig	(	uint32_t	firewallId,
		MPU_FIREWALL_Config **	firewallConfig
	)

Function to get parameters of a firewall.

Parameters

firewallId	Firewall ID.
firewallConfig	Structure to save firewall config.

Returns

SystemP_SUCCESS on successful config read; else error on failure

MPU_FIREWALL_RegionParams_init()

void MPU_FIREWALL_RegionParams_init

(

MPU_FIREWALL_RegionParams *

mpuParams

)

Function to initialize the parameters of a region.

Parameters

mpuParams

Region parameter structure to be initialized.

MPU_FIREWALL_readFaultAddress()

uint32_t MPU_FIREWALL_readFaultAddress

(

uint32_t

baseAddr

)

Function to read the fault address that created the firewall violation.

Parameters

baseAddr

MPU Firewall base address

Returns

Fault address

MPU_FIREWALL_readFaultStatus()

uint32_t MPU_FIREWALL_readFaultStatus

(

uint32_t

baseAddr

)

Function to read the fault status register. It contains information on the kind of firewall violation that had occurred.

Parameters

baseAddr

MPU Firewall base address

Returns

Value of fault status register

MPU_FIREWALL_clearFault()

void MPU_FIREWALL_clearFault

(

uint32_t

baseAddr

)

Function to clear MPU Firewall fault address and fault status register .

Parameters

baseAddr

MPU Firewall base address

MPU_FIREWALL_interruptEnable()

void MPU_FIREWALL_interruptEnable	(	uint32_t	baseAddr,
		uint32_t	flag
	)

Function to enable MPU Firewall interrupt.

Parameters

baseAddr	MPU Firewall base address
flag	Flag to denote the different firewall interrupts to be enabled.

MPU_FIREWALL_clearInterruptEnable()

void MPU_FIREWALL_clearInterruptEnable	(	uint32_t	baseAddr,
		uint32_t	flag
	)

Function to disable MPU Firewall interrupt.

Parameters

baseAddr	MPU Firewall base address
flag	Flag to denote the different firewall interrupts to be disabled.

MPU_FIREWALL_setInterruptStatus()

void MPU_FIREWALL_setInterruptStatus	(	uint32_t	baseAddr,
		uint32_t	flag
	)

Function to set interrupt. This can be used for testing interrupts.

Parameters

baseAddr	MPU Firewall base address
flag	Flag to denote the different firewall interrupts to be set.

MPU_FIREWALL_getInterruptStatus()

uint32_t MPU_FIREWALL_getInterruptStatus

(

uint32_t

baseAddr

)

Function to read interrupt status.

Parameters

baseAddr

MPU Firewall base address

Returns

Value of interrupt status register.

MPU_FIREWALL_clearInterruptStatus()

void MPU_FIREWALL_clearInterruptStatus	(	uint32_t	baseAddr,
		uint32_t	flag
	)

Function to clear interrupt status.

Parameters

baseAddr	MPU Firewall base address
flag	Flag to denote the different firewall interrupts to be cleared.