Zilog EZ80F91GA - Manual (Page 94)

ZGATE API Reference UM024502-1012
82
ZGATE Embedded Security Development Kit
User Manual
ZGATE_remove_ip_addr
Function Prototype
INT16 ZGATE_remove_ip_addr ( INT32 IP_Addr );
Parameters
IP_Addr IP address to be removed from the IP source address static filter-
ing list.
IP_Addr must be a 32-bit IPv4 address in little-endian
(presentation mode) format (e.g., 192.68.1.15 would be repre-
sented by the value
0xC0A8010F which, on the eZ80F91 MCU,
would be stored in memory as 0x0F , 0x01 , 0xA8 , 0xC0 ).
Return Value
TRUE IP_Addr was successfully removed from the IP Address static
filtering list.
FALSE IP_Addr does not exist in the IP Address static filtering list, or
the IP Address filter is disabled.
Description
When the IP Address filter is operating in WHITELIST (forwarding) or BLACKLIST
(blocking) Mode, it extracts the source IP address from inbound IP packets and compares
the IP address to entries in the IP Address filtering list. If a match is found, the frame is
forwarded to ZTP if the filter operates in WHITELIST Mode and blocked from TCP if the
filter operates in BLACKLIST Mode.
This API is used to remove an entry from the IP Address static filtering list. Entries cannot
be removed from the list if the IP Address filter is disabled.