Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The next API function is the AddrMulticastRemove() function used to remove an (IP-to-Ethernet) multicast hardware address from a device.

Files

Every device driver’s net_dev.c

Prototype

 

Note that since every device driver’s AddrMulticastRemove() function is accessed only by function pointer via the device driver’s API structure, it doesn’t need to be globally available and should therefore be declared as ‘static’.

Arguments

p_if

Pointer to the interface to remove a multicast address.

...

Pointer to variable that will receive the return error code from this function.

Returned Value

None.

Required Configuration

Necessary only if NET_IP_CFG_MULTICAST_SEL is configured for transmit and receive multicasting (see section D-9-2).

Notes / Warnings

Use same exact code as in NetDev_AddrMulticastAdd() to calculate the device’s CRC hash (see section B-1-6), but remove a multicast address by decrementing the device’s hash bit reference counters and clearing the appropriate bits in the device’s multicast registers.

 

Listing B-3 Example device multicast address removal