beautypg.com

Zgate_add_eth_addr – Zilog EZ80F91GA User Manual

Page 89

background image

UM024502-1012

ZGATE Logging Page

ZGATE Embedded Security Development Kit

User Manual

77

ZGATE_add_eth_addr

Function Prototype

INT16 ZGATE_add_eth_addr( ether_addr_t EthAddr );

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 added to the list.

Return Value

TRUE

EthAddr

was successfully added to the Ethernet address static

filtering list.

FALSE

EthAddr

already exists in the Ethernet address static filtering

list, the list is full 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 add an entry to the Ethernet Address static filtering list. Entries cannot
be added to the list if the Ethernet Address filter is disabled.