update dec file to reflect newly introduced protocols.

[mirror_edk2.git] / MdePkg / Include / Protocol / Udp6.h

/** @file\r
  The EFI UDPv6 (User Datagram Protocol version 6) Protocol Definition, which is built upon\r
  the EFI IPv6 Protocol and provides simple packet-oriented services to transmit and receive\r
  UDP packets.\r
\r
Copyright (c) 2008 - 2009, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
**/\r
\r
#ifndef __EFI_UDP6_PROTOCOL_H__\r
#define __EFI_UDP6_PROTOCOL_H__\r
\r
#include <Protocol/Ip6.h>\r
\r
#define EFI_UDP6_SERVICE_BINDING_PROTOCOL_GUID \\r
  { \\r
    0x66ed4721, 0x3c98, 0x4d3e, {0x81, 0xe3, 0xd0, 0x3d, 0xd3, 0x9a, 0x72, 0x54 } \\r
  }\r
\r
#define EFI_UDP6_PROTOCOL_GUID \\r
  { \\r
    0x4f948815, 0xb4b9, 0x43cb, {0x8a, 0x33, 0x90, 0xe0, 0x60, 0xb3, 0x49, 0x55 } \\r
  }\r
\r
typedef struct {\r
  ///\r
  /// The EFI UDPv6 Protocol instance handle that is using this address/port pair.\r
  ///\r
  EFI_HANDLE          InstanceHandle;\r
  ///\r
  /// The IPv6 address to which this instance of the EFI UDPv6 Protocol is bound.\r
  /// Set to 0::/128, if this instance is used to listen all packets from any\r
  /// source address.\r
  ///\r
  EFI_IPv6_ADDRESS    LocalAddress;\r
  ///\r
  /// The port number in host byte order on which the service is listening.\r
  ///\r
  UINT16              LocalPort;\r
  ///\r
  /// The IPv6 address of the remote host. May be 0::/128 if it is not connected\r
  /// to any remote host or connected with more than one remote host.\r
  ///\r
  EFI_IPv6_ADDRESS    RemoteAddress;\r
  ///\r
  /// The port number in host byte order on which the remote host is \r
  /// listening. Maybe zero if it is not connected to any remote host.\r
  ///\r
  UINT16              RemotePort;\r
} EFI_UDP6_SERVICE_POINT;\r
\r
typedef struct {\r
  ///\r
  /// The handle of the driver that creates this entry.\r
  ///\r
  EFI_HANDLE              DriverHandle;\r
  ///\r
  /// The number of address/port pairs that follow this data structure.\r
  ///\r
  UINT32                  ServiceCount;\r
  ///\r
  /// List of address/port pairs that are currently in use.\r
  ///\r
  EFI_UDP6_SERVICE_POINT  Services[1];\r
} EFI_UDP6_VARIABLE_DATA;\r
\r
typedef struct _EFI_UDP6_PROTOCOL EFI_UDP6_PROTOCOL;\r
\r
///\r
/// EFI_UDP6_FRAGMENT_DATA allows multiple receive or transmit buffers to be specified.\r
/// The purpose of this structure is to avoid copying the same packet multiple times.\r
///\r
typedef struct {\r
  UINT32        FragmentLength;  ///< Length of the fragment data buffer.\r
  VOID          *FragmentBuffer; ///< Pointer to the fragment data buffer.\r
} EFI_UDP6_FRAGMENT_DATA;\r
\r
///\r
/// The EFI_UDP6_SESSION_DATA is used to retrieve the settings when receiving packets or\r
/// to override the existing settings (only DestinationAddress and DestinationPort can\r
/// be overridden) of this EFI UDPv6 Protocol instance when sending packets.\r
///\r
typedef struct {\r
  ///\r
  /// Address from which this packet is sent. This field should not be used when\r
  /// sending packets.\r
  ///\r
  EFI_IPv6_ADDRESS   SourceAddress;\r
  ///\r
  /// Port from which this packet is sent. It is in host byte order. This field should\r
  /// not be used when sending packets.\r
  ///\r
  UINT16             SourcePort;\r
  ///\r