4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2005 - 2006, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __EFI_IP4_OUTPUT_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __EFI_IP4_OUTPUT_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default callback function for system generated packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It will free the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ip4Instance The IP4 child that issued the transmission. It most
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync like is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet The packet that transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IoStatus The result of the transmission, succeeded or failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param LinkFlag Not used when transmission. check IP4_FRAME_CALLBACK
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for reference.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context The context provided by us
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncIp4SysPacketSent (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IP4_PROTOCOL *Ip4Instance,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_BUF *Packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS IoStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LinkFlag,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transmit an IP4 packet. The packet comes either from the IP4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync child's consumer (IpInstance != NULL) or the IP4 driver itself
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (IpInstance == NULL). It will route the packet, fragment it,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then transmit all the fragments through some interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpSb The IP4 service instance to transmit the packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpInstance The IP4 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: Tos, TotalLen, Id, tl,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Fragment, Protocol, Src and Dst. All the fields are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in host byte order. This function will fill in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ver, HeadLen, Fragment, and checksum. The Fragment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync only need to include the DF flag. Ip4Output will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync compute the MF and offset for you.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Option The original option to append to the IP headers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptLen The length of the option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] GateWay The next hop address to transmit packet to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 255.255.255.255 means broadcast.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Callback The callback function to issue when transmission
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque context for the callback
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
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 is successfully transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Failed to transmit the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncIp4Output (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_SERVICE *IpSb,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_PROTOCOL *IpInstance OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN NET_BUF *Packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_HEAD *Head,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 *Option,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 OptLen,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_ADDR GateWay,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_FRAME_CALLBACK Callback,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cancel the Packet and all its fragments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IpIf The interface from which the Packet is sent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet The Packet to cancel
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IoStatus The status returns to the sender.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncIp4CancelPacket (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_INTERFACE *IpIf,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN NET_BUF *Packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_STATUS IoStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Prepend an IP4 head to the Packet. It will copy the options and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync build the IP4 header fields. Used for IP4 fragmentation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet The packet to prepend IP4 header to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Head The caller supplied header. The caller should set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the following header fields: Tos, TotalLen, Id,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Fragment, Ttl, Protocol, Src and Dst. All the fields
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are in host byte order. This function will fill in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Ver, HeadLen, and checksum.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Option The orginal IP4 option to copy from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OptLen The length of the IP4 option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE There is no enought room in the head space of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The IP4 header is successfully added to the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncIp4PrependHead (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT NET_BUF *Packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN IP4_HEAD *Head,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 *Option,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 OptLen
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern UINT16 mIp4Id;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif