Sciclient Firewall API Interface

Introduction

The DMSC firmware Firewall Management system manages SoC Firewall resources. Each firewall in the system is assigned an owner. Ownership is assigned using Host ID. Only a owner of a firewall can:

• Configure the firewall permissions
• Query the firewall permissions
• Transfer the firewall ownership to another owner(host)

Files
file	sciclient_firewall.h
	This file contains the definition of all the message IDs, message formats to be able to interact with the System Controller firmware for firewall management.

Functions
int32_t	Sciclient_firewallChangeOwnerInfo (const struct tisci_msg_fwl_change_owner_info_req *req, struct tisci_msg_fwl_change_owner_info_resp *resp, uint32_t timeout)
	Request for configuring the firewall permissions. More...
int32_t	Sciclient_firewallSetRegion (const struct tisci_msg_fwl_set_firewall_region_req *req, struct tisci_msg_fwl_set_firewall_region_resp *resp, uint32_t timeout)
	Request for configuring the firewall permissions. More...
int32_t	Sciclient_firewallGetRegion (const struct tisci_msg_fwl_get_firewall_region_req *req, struct tisci_msg_fwl_get_firewall_region_resp *resp, uint32_t timeout)
	Request for getting the firewall permissions. More...

Function Documentation

Sciclient_firewallChangeOwnerInfo()

int32_t Sciclient_firewallChangeOwnerInfo	(	const struct tisci_msg_fwl_change_owner_info_req *	req,
		struct tisci_msg_fwl_change_owner_info_resp *	resp,
		uint32_t	timeout
	)

Request for configuring the firewall permissions.

Message: TISCI_MSG_CHANGE_FWL_OWNER
Request: tisci_msg_fwl_change_owner_info_req
Response: tisci_msg_fwl_change_owner_info_resp

Parameters

req	Pointer to firewall change owner payload
resp	Pointer to firewall change owner response payload
timeout	Gives a sense of how long to wait for the operation. Refer SystemP_Timeout.

Returns

SystemP_SUCCESS on success, else failure

Sciclient_firewallSetRegion()

int32_t Sciclient_firewallSetRegion	(	const struct tisci_msg_fwl_set_firewall_region_req *	req,
		struct tisci_msg_fwl_set_firewall_region_resp *	resp,
		uint32_t	timeout
	)

Request for configuring the firewall permissions.

Message: TISCI_MSG_SET_FWL_REGION
Request: tisci_msg_fwl_set_firewall_region_req
Response: tisci_msg_fwl_set_firewall_region_resp

Parameters

req	Pointer to firewall region set payload
resp	Pointer to firewall region set response payload
timeout	Gives a sense of how long to wait for the operation. Refer SystemP_Timeout.

Returns

SystemP_SUCCESS on success, else failure

Sciclient_firewallGetRegion()

int32_t Sciclient_firewallGetRegion	(	const struct tisci_msg_fwl_get_firewall_region_req *	req,
		struct tisci_msg_fwl_get_firewall_region_resp *	resp,
		uint32_t	timeout
	)

Request for getting the firewall permissions.

Message: TISCI_MSG_GET_FWL_REGION
Request: tisci_msg_fwl_get_firewall_region_req
Response: tisci_msg_fwl_get_firewall_region_resp

Parameters

req	Pointer to firewall region get payload
resp	Pointer to firewall region get response payload
timeout	Gives a sense of how long to wait for the operation. Refer SystemP_Timeout.

Returns

SystemP_SUCCESS on success, else failure