4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Common definition and functions for IP6 driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP6_LINK_EQUAL(Mac1, Mac2) (CompareMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)) == 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Convert the Microsecond to second. IP transmit/receive time is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// in the unit of microsecond. IP ticks once per second.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define IP6_US_TO_SEC(Us) (((Us) + 999999) / 1000000)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Make it to 64 since all 54 bits are zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The packet is received as link level broadcast/multicast/promiscuous.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Build a array of EFI_IP6_ADDRESS_INFO to be returned to the caller. The number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of EFI_IP6_ADDRESS_INFO is also returned. If AddressList is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync only the address count is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb The IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AddressCount The number of returned addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AddressList The pointer to the array of EFI_IP6_ADDRESS_INFO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The address array is successfully build
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the address info.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Generate the multicast addresses identify the group of all IPv6 nodes or IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync routers defined in RFC4291.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All Nodes Addresses: FF01::1, FF02::1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All Router Addresses: FF01::2, FF02::2, FF05::2.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Router If TRUE, generate all routers addresses,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync else generate all node addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Scope interface-local(1), link-local(2), or site-local(5)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip6Addr The generated multicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The address is generated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function converts MAC address to 64 bits interface ID according to RFC4291
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and returns the interface ID. Currently only 48-bit MAC address is supported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] IpSb The IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL The operation fails.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Pointer to the generated interface ID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates link-local address from interface identifier. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface identifier is normally created from MAC address. It might be manually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured by administrator if the link-local address created from MAC address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is a duplicate address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] IpSb The IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL If the operation fails.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The generated Link Local address, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compute the solicited-node multicast address for an unicast or anycast address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by taking the low-order 24 bits of this address, and appending those bits to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the prefix FF02:0:0:0:0:1:FF00::/104.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ip6Addr The unicast or anycast address, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MulticastAddr The generated solicited-node multicast address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the incoming Ipv6 address is a solicited-node multicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip6 Ip6 address, in network order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Yes, solicited-node multicast address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE No
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the incoming IPv6 address is one of the maintained address in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb Points to a IP6 service binding instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Address The IP6 address to be checked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Interface If not NULL, output the IP6 interface which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync maintains the Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AddressInfo If not NULL, output the IP6 address information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Yes, it is one of the maintained addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE No, it is not one of the maintained addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check whether the incoming MAC address is valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb Points to a IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] LinkAddress The MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Yes, it is valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE No, it is not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copy the PrefixLength bits from Src to Dest.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Dest A pointer to the buffer to copy to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Src A pointer to the buffer to copy from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PrefixLength The number of bits to copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Insert a node IP6_ADDRESS_INFO to an IP6 interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] IpIf Points to an IP6 interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AddrInfo Points to an IP6_ADDRESS_INFO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the IPv6 address from the address list node points to IP6_ADDRESS_INFO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function removes the matching IPv6 addresses from the address list and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync adjusts the address count of the address list. If IpSb is not NULL, this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync calls Ip6LeaveGroup to see whether it should call Mnp->Groups() to remove the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync its solicited-node multicast MAC address from the filter list and sends out
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a Multicast Listener Done. If Prefix is NULL, all address in the address list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be removed. If Prefix is not NULL, the address that matching the Prefix
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with PrefixLength in the address list will be removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb NULL or points to IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] AddressList address list array
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] AddressCount the count of addresses in address list array
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Prefix NULL or an IPv6 address prefix
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PrefixLength the length of Prefix
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The address matching the Prefix with PrefixLength
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cannot be found in address list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set the Ip6 variable data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb Points to an IP6 service binding instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval other Set variable failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Clear the variable and free the resource.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb Ip6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the MAC address for a multicast IP address. Call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Mnp's McastIpToMac to find the MAC address instead of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hard-coding the NIC to be Ethernet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Mnp The Mnp instance to get the MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Multicast The multicast IP address to translate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Mac The buffer to hold the translated address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The multicast IP is successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync translated to a multicast MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Other The address is not converted because an error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert the multibyte field in IP header's byter order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In spite of its name, it can also be used to convert from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync host to network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Head The IP head to convert.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Point to the converted IP head.