Add protocol and related definitions defined in the UEFI 2.3 spec chapter 31 “User...

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

/** @file\r
  UEFI Dynamic Host Configuration Protocol 6 Definition, which is used to get IPv6\r
  addresses and other configuration parameters from DHCPv6 servers.\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_DHCP6_PROTOCOL_H__\r
#define __EFI_DHCP6_PROTOCOL_H__\r
\r
#define EFI_DHCP6_PROTOCOL_GUID \\r
  { \\r
    0x87c8bad7, 0x595, 0x4053, {0x82, 0x97, 0xde, 0xde, 0x39, 0x5f, 0x5d, 0x5b } \\r
  }\r
\r
#define EFI_DHCP6_SERVICE_BINDING_PROTOCOL_GUID \\r
  { \\r
    0x9fb9a8a1, 0x2f4a, 0x43a6, {0x88, 0x9c, 0xd0, 0xf7, 0xb6, 0xc4, 0x7a, 0xd5 } \\r
  }\r
\r
typedef struct _EFI_DHCP6_PROTOCOL EFI_DHCP6_PROTOCOL;\r
\r
typedef enum { \r
  ///\r
  /// The EFI DHCPv6 Protocol instance is configured, and start() needs \r
  /// to be called\r
  ///\r
  Dhcp6Init                    = 0x0,\r
  ///\r
  /// A Solicit packet is sent out to discover DHCPv6 server, and the EFI\r
  /// DHCPv6 Protocol instance is collecting Advertise packets.\r
  ///\r
  Dhcp6Selecting               = 0x1,\r
  ///\r
  /// A Request is sent out to the DHCPv6 server, and the EFI DHCPv6 \r
  /// Protocol instance is waiting for Reply packet.\r
  ///\r
  Dhcp6Requesting              = 0x2,\r
  ///\r
  /// A Decline packet is sent out to indicate one or more addresses of the\r
  /// configured IA are in use by another node, and the EFI DHCPv6.\r
  /// Protocol instance is waiting for Reply packet.\r
  ///\r
  Dhcp6Declining               = 0x3,\r
  ///\r
  /// A Confirm packet is sent out to confirm the IPv6 addresses of the \r
  /// configured IA, and the EFI DHCPv6 Protocol instance is waiting for Reply packet.\r
  ///\r
  Dhcp6Confirming              = 0x4,\r
  ///\r
  /// A Release packet is sent out to release one or more IPv6 addresses of\r
  /// the configured IA, and the EFI DHCPv6 Protocol instance is waiting for Reply packet.\r
  ///\r
  Dhcp6Releasing               = 0x5,\r
  ///\r
  /// The DHCPv6 S.A.R.R process is completed for the configured IA.\r
  ///\r
  Dhcp6Bound                   = 0x6,\r
  ///\r
  /// A Renew packet is sent out to extend lifetime for the IPv6 addresses of\r
  /// the configured IA, and the EFI DHCPv6 Protocol instance is waiting for Reply packet.\r
  ///\r
  Dhcp6Renewing                = 0x7,\r
  ///\r
  /// A Rebind packet is sent out to extend lifetime for the IPv6 addresses of\r
  /// the configured IA, and the EFI DHCPv6 Protocol instance is waiting for Reply packet.\r
  ///\r
  Dhcp6Rebinding               = 0x8\r
} EFI_DHCP6_STATE;\r
\r
typedef enum {\r
  ///     \r
  /// A Solicit packet is about to be sent. The packet is passed to Dhcp6Callback and\r
  /// can be modified or replaced in Dhcp6Callback.\r
  ///\r
  Dhcp6SendSolicit             = 0x0,\r
  ///     \r
  /// An Advertise packet is received and will be passed to Dhcp6Callback.\r
  ///\r
  Dhcp6RcvdAdvertise           = 0x1,\r
  ///     \r
  /// It is time for Dhcp6Callback to determine whether select the default Advertise\r
  /// packet by RFC 3315 policy, or overwrite it by specific user policy.\r
  ///\r
  Dhcp6SelectAdvertise         = 0x2,\r
  ///     \r
  /// A Request packet is about to be sent. The packet is passed to Dhcp6Callback and\r
  /// can be modified or replaced in Dhcp6Callback.\r
  ///\r
  Dhcp6SendRequest             = 0x3,\r
  ///     \r
  /// A Reply packet is received and will be passed to Dhcp6Callback.\r
  ///\r
  Dhcp6RcvdReply               = 0x4,\r
  ///     \r
  /// A Reconfigure packet is received and will be passed to Dhcp6Callback.\r
  ///\r
  Dhcp6RcvdReconfigure         = 0x5,\r
  ///     \r
  /// A Decline packet is about to be sent. The packet is passed to Dhcp6Callback and\r
  /// can be modified or replaced in Dhcp6Callback.\r
  ///\r
  Dhcp6SendDecline             = 0x6,\r
  ///     \r
  /// A Confirm packet is about to be sent. The packet is passed to Dhcp6Callback and\r
  /// can be modified or replaced in Dhcp6Callback.\r
  ///\r
  Dhcp6SendConfirm             = 0x7,\r
  ///     \r
  /// A Release packet is about to be sent. The packet is passed to Dhcp6Callback and\r
  /// can be modified or replaced in Dhcp6Callback.\r
  ///\r
  Dhcp6SendRelease             = 0x8,\r
  ///     \r
  /// A Renew packet is about to be sent. The packet is passed to Dhcp6Callback and\r
  /// can be modified or replaced in Dhcp6Callback. \r
  ///\r
  Dhcp6EnterRenewing           = 0x9,\r
  ///     \r
  /// A Rebind packet is about to be sent. The packet is passed to Dhcp6Callback and \r
  /// can be modified or replaced in Dhcp6Callback.\r
  ///\r
  Dhcp6EnterRebinding          = 0xa\r
} EFI_DHCP6_EVENT;\r
\r
///\r
/// An IA which carries assigned not temporary address.\r
///\r
#define EFI_DHCP6_IA_TYPE_NA   3\r
///\r
/// An IA which carries assigned temporary address.\r
///\r
#define EFI_DHCP6_IA_TYPE_TA   4\r
\r
#pragma pack(1)\r
typedef struct {\r
  ///\r
  /// The DHCPv6 option code.\r
  ///\r
  UINT16                       OpCode;\r
  ///\r
  /// Length of the DHCPv6 option data. From the first byte to the last byte of the Data field.\r
  ///\r
  UINT16                       OpLen;\r
  ///\r
  /// The data for the DHCPv6 option.\r
  ///\r
  UINT8                        Data[1];\r
} EFI_DHCP6_PACKET_OPTION;\r
\r
typedef struct{\r
  ///\r
  /// The DHCPv6 transaction ID.\r
  ///\r
  UINT32                       MessageType:8;\r
  ///\r
  /// The DHCPv6 message type.\r
  ///\r
  UINT32                       TransactionId:24;\r
} EFI_DHCP6_HEADER;\r
\r
typedef struct {\r
  ///\r
  /// Size of the EFI_DHCP6_PACKET buffer.\r
  ///\r
  UINT32                       Size;\r
  ///\r
  /// Length of the EFI_DHCP6_PACKET from the first byte of the Header field to the last\r
  /// byte of the Option[] field.\r
  ///\r
  UINT32                       Length;\r
  struct{\r
    ///\r
    /// The DHCPv6 packet header.\r
    ///\r
    EFI_DHCP6_HEADER           Header;\r
    ///\r
    /// Start of the DHCPv6 packed option data.\r
    ///\r
    UINT8                      Option[1];\r
  } Dhcp6;\r
} EFI_DHCP6_PACKET;\r
\r
#pragma pack()\r
\r
typedef struct {\r
  ///\r
  /// Length of DUID in octects.\r
  ///\r
  UINT16                       Length;\r
  ///\r
  /// Array of DUID octects.\r
  ///\r
  UINT8                        Duid[1];\r
} EFI_DHCP6_DUID;\r
\r
typedef struct {\r
  ///\r
  /// Initial retransmission timeout.\r
  ///\r
  UINT32                       Irt;\r
  ///\r