Filter
Top Products
Protocols — Network Support
Version 1.10 12/01/02 15-11
EFI_SIMPLE_NETWORK.ReceiveFilters()
Summary
Manages the multicast receive filters of a network interface.
Prototype
EFI_STATUS
(EFIAPI *EFI_SIMPLE_NETWORK_RECEIVE_FILTERS) (
IN EFI_SIMPLE_NETWORK *This,
IN UINT32 Enable,
IN UINT32 Disable,
IN BOOLEAN ResetMCastFilter,
IN UINTN MCastFilterCnt OPTIONAL,
IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL,
);
Parameters
This A pointer to the EFI_SIMPLE_NETWORK instance.
Enable A bit mask of receive filters to enable on the network interface.
Disable A bit mask of receive filters to disable on the network interface.
ResetMCastFilter Set to TRUE to reset the contents of the multicast receive filters
on the network interface to their default values.
MCastFilterCnt Number of multicast HW MAC addresses in the new
MCastFilter list. This value must be less than or equal to the
MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE
.
This field is optional if ResetMCastFilter is TRUE.
MCastFilter A pointer to a list of new multicast receive filter HW MAC
addresses. This list will replace any existing multicast HW
MAC address list. This field is optional if
ResetMCastFilter is TRUE.
Description
This function modifies the current receive filter mask on a network interface. The bits set in
Enable are set on the current receive filter mask. The bits set in Disable are cleared from the
current receive filter mask. If the same bit is set in both Enable and Disable, then the bit will
be disabled. The receive filter mask is updated on the network interface, and the new receive filter
mask can be read from the ReceiveFilterSetting field of
EFI_SIMPLE_NETWORK_MODE. If an attempt is made to enable a bit that is not supported on the
network interface, then EFI_INVALID_PARAMETER will be returned. The
ReceiveFilterMask field of EFI_SIMPLE_NETWORK_MODE specifies the supported receive
filters settings. See “Bit Mask Values for ReceiveFilterSetting” in “Related Definitions”
in Section 15.1 for the list of the supported receive filter bit mask values.