beautypg.com

Zgate_remove_eth_addr – Zilog EZ80F91GA User Manual

Page 90

background image

ZGATE API Reference

UM024502-1012

78

ZGATE Embedded Security Development Kit
User Manual

ZGATE_remove_eth_addr

Function Prototype

INT16 ZGATE_remove_eth_addr( ether_addr_t value );

Parameters

EthAddr

MAC Address to be added to the Ethernet address static filtering
list.

EthAddr

must be an array of 6 hexadecimal bytes (canonical

format) representing the 48-bit IEE Ethernet MAC address of the
device to be removed from the list.

Return Value

TRUE

EthAddr

was successfully removed from the Ethernet address

static filtering list.

FALSE

EthAddr

does not exist in the Ethernet address static filtering

list, or Ethernet address filtering is disabled.

Description

When the Ethernet Address filter is operating in WHITELIST (forwarding) or BLACK-
LIST (blocking) Mode, it extracts the source MAC address from inbound Ethernet frames
and compares the address to entries in the Ethernet 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 Ethernet Address static filtering list. Entries
cannot be removed from the list if the Ethernet Address filter is disabled.