NetworkPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / NetworkPkg / Ip6Dxe / Ip6Output.h

/** @file\r
  The internal functions and routines to transmit the IP6 packet.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EFI_IP6_OUTPUT_H__\r
#define __EFI_IP6_OUTPUT_H__\r
\r
extern UINT32 mIp6Id;\r
\r
/**\r
  Output all the available source addresses to the list entry head SourceList. The\r
  number of source addresses are also returned.\r
\r
  @param[in]       IpSb             Points to a IP6 service binding instance.\r
  @param[in]       Destination      The IPv6 destination address.\r
  @param[out]      Source           The selected IPv6 source address according to\r
                                    the Destination.\r
\r
  @retval EFI_SUCCESS           The source addresses were copied to the list entry\r
                                head SourceList.\r
  @retval EFI_NO_MAPPING        The IPv6 stack is not auto configured.\r
\r
**/\r
EFI_STATUS\r
Ip6SelectSourceAddress (\r
  IN IP6_SERVICE            *IpSb,\r
  IN EFI_IPv6_ADDRESS       *Destination,\r
  OUT EFI_IPv6_ADDRESS      *Source\r
  );\r
\r
/**\r
  The default callback function for system generated packet.\r
  It will free the packet.\r
\r
  @param[in]  Packet        The packet that transmitted.\r
  @param[in]  IoStatus      The result of the transmission: succeeded or failed.\r
  @param[in]  LinkFlag      Not used when transmission. Check IP6_FRAME_CALLBACK\r
                            for reference.\r
  @param[in]  Context       The context provided by us.\r
\r
**/\r
VOID\r
Ip6SysPacketSent (\r
  NET_BUF                   *Packet,\r
  EFI_STATUS                IoStatus,\r
  UINT32                    LinkFlag,\r
  VOID                      *Context\r
  );\r
\r
/**\r
  Transmit an IP6 packet. The packet comes either from the IP6\r
  child's consumer (IpInstance != NULL) or the IP6 driver itself\r
  (IpInstance == NULL). It will route the packet, fragment it,\r
  then transmit all the fragments through an interface.\r
\r
  @param[in]  IpSb             The IP6 service instance to transmit the packet.\r
  @param[in]  Interface        The IP6 interface to transmit the packet. Ignored\r
                               if NULL.\r
  @param[in]  IpInstance       The IP6 child that issues the transmission.  It is\r
                               NULL if the packet is from the system.\r
  @param[in]  Packet           The user data to send, excluding the IP header.\r
  @param[in]  Head             The caller supplied header. The caller should set\r
                               the  following header fields: NextHeader, HopLimit,\r
                               Src, Dest, FlowLabel, PayloadLength. This function\r
                               will fill in the Ver, TrafficClass.\r
  @param[in]  ExtHdrs          The extension headers to append to the IPv6 basic\r
                               header.\r
  @param[in]  ExtHdrsLen       The length of the extension headers.\r
  @param[in]  Callback         The callback function to issue when transmission\r
                               completed.\r
  @param[in]  Context          The opaque context for the callback.\r
\r
  @retval EFI_INVALID_PARAMETER Any input parameter or the packet is invalid.\r
  @retval EFI_NO_MAPPING        There is no interface to the destination.\r
  @retval EFI_NOT_FOUND         There is no route to the destination.\r
  @retval EFI_SUCCESS           The packet successfully transmitted.\r
  @retval EFI_OUT_OF_RESOURCES  Failed to finish the operation due to lack of\r
                                resources.\r
  @retval Others                Failed to transmit the packet.\r
\r
**/\r
EFI_STATUS\r
Ip6Output (\r
  IN IP6_SERVICE            *IpSb,\r
  IN IP6_INTERFACE          *Interface   OPTIONAL,\r
  IN IP6_PROTOCOL           *IpInstance  OPTIONAL,\r
  IN NET_BUF                *Packet,\r
  IN EFI_IP6_HEADER         *Head,\r
  IN UINT8                  *ExtHdrs,\r
  IN UINT32                 ExtHdrsLen,\r
  IN IP6_FRAME_CALLBACK     Callback,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  Remove all the frames on the interface that pass the FrameToCancel,\r
  either queued on ARP queues, or that have already been delivered to\r
  MNP and not yet recycled.\r
\r
  @param[in]  Interface     Interface to remove the frames from.\r
  @param[in]  IoStatus      The transmit status returned to the frames' callback.\r
  @param[in]  FrameToCancel Function to select the frame to cancel; NULL to select all.\r
  @param[in]  Context       Opaque parameters passed to FrameToCancel. Ignored if\r
                            FrameToCancel is NULL.\r
\r
**/\r
VOID\r
Ip6CancelFrames (\r
  IN IP6_INTERFACE          *Interface,\r
  IN EFI_STATUS             IoStatus,\r
  IN IP6_FRAME_TO_CANCEL    FrameToCancel   OPTIONAL,\r
  IN VOID                   *Context        OPTIONAL\r
  );\r
\r
/**\r
  Cancel the Packet and all its fragments.\r
\r
  @param[in]  IpIf                 The interface from which the Packet is sent.\r
  @param[in]  Packet               The Packet to cancel.\r
  @param[in]  IoStatus             The status returns to the sender.\r
\r
**/\r
VOID\r
Ip6CancelPacket (\r
  IN IP6_INTERFACE    *IpIf,\r
  IN NET_BUF          *Packet,\r
  IN EFI_STATUS       IoStatus\r
  );\r
\r
#endif\r