Ip6Output.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The internal functions and routines to transmit the IP6 packet.
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 Output all the available source addresses to the list entry head SourceList. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of source addresses are also returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb Points to a IP6 service binding instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Destination The IPv6 destination address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Source The selected IPv6 source address according to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Destination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The source addresses were copied to the list entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync head SourceList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING The IPv6 stack is not auto configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default callback function for system generated packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It will free the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The packet that transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IoStatus The result of the transmission: succeeded or failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] LinkFlag Not used when transmission. Check IP6_FRAME_CALLBACK
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for reference.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The context provided by us.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transmit an IP6 packet. The packet comes either from the IP6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync child's consumer (IpInstance != NULL) or the IP6 driver itself
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (IpInstance == NULL). It will route the packet, fragment it,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then transmit all the fragments through an interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb The IP6 service instance to transmit the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Interface The IP6 interface to transmit the packet. Ignored
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpInstance The IP6 child that issues the transmission. It is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL if the packet is from the system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The user data to send, excluding the IP header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Head The caller supplied header. The caller should set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the following header fields: NextHeader, HopLimit,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Src, Dest, FlowLabel, PayloadLength. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will fill in the Ver, TrafficClass.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ExtHdrs The extension headers to append to the IPv6 basic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ExtHdrsLen The length of the extension headers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Callback The callback function to issue when transmission
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque context for the callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter or the packet is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING There is no interface to the destination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There is no route to the destination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The packet successfully transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to finish the operation due to lack of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to transmit the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove all the frames on the interface that pass the FrameToCancel,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync either queued on ARP queues, or that have already been delivered to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MNP and not yet recycled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Interface Interface to remove the frames from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IoStatus The transmit status returned to the frames' callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FrameToCancel Function to select the frame to cancel; NULL to select all.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context Opaque parameters passed to FrameToCancel. Ignored if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FrameToCancel is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cancel the Packet and all its fragments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpIf The interface from which the Packet is sent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The Packet to cancel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IoStatus The status returns to the sender.