MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  This file defines the EFI Domain Name Service Binding Protocol interface. It is split\r
  into the following two main sections:\r
  DNSv4 Service Binding Protocol (DNSv4SB)\r
  DNSv4 Protocol (DNSv4)\r
\r
  Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This Protocol is introduced in UEFI Specification 2.5\r
\r
**/\r
\r
#ifndef __EFI_DNS4_PROTOCOL_H__\r
#define __EFI_DNS4_PROTOCOL_H__\r
\r
#define EFI_DNS4_SERVICE_BINDING_PROTOCOL_GUID \\r
  { \\r
    0xb625b186, 0xe063, 0x44f7, {0x89, 0x5, 0x6a, 0x74, 0xdc, 0x6f, 0x52, 0xb4 } \\r
  }\r
\r
#define EFI_DNS4_PROTOCOL_GUID \\r
  { \\r
    0xae3d28cc, 0xe05b, 0x4fa1, {0xa0, 0x11, 0x7e, 0xb5, 0x5a, 0x3f, 0x14, 0x1 } \\r
  }\r
\r
typedef struct _EFI_DNS4_PROTOCOL EFI_DNS4_PROTOCOL;\r
\r
///\r
/// EFI_DNS4_CONFIG_DATA\r
///\r
typedef struct {\r
  ///\r
  /// Count of the DNS servers. When used with GetModeData(),\r
  /// this field is the count of originally configured servers when\r
  /// Configure() was called for this instance. When used with\r
  /// Configure() this is the count of caller-supplied servers. If the\r
  /// DnsServerListCount is zero, the DNS server configuration\r
  /// will be retrieved from DHCP server automatically.\r
  ///\r
  UINTN                         DnsServerListCount;\r
  ///\r
  /// Pointer to DNS server list containing DnsServerListCount entries or NULL\r
  /// if DnsServerListCountis 0. For Configure(), this will be NULL when there are\r
  /// no caller supplied server addresses, and, the DNS instance will retrieve\r
  /// DNS server from DHCP Server. The provided DNS server list is\r
  /// recommended to be filled up in the sequence of preference. When\r
  /// used with GetModeData(), the buffer containing the list will\r
  /// be allocated by the driver implementing this protocol and must be\r
  /// freed by the caller. When used with Configure(), the buffer\r
  /// containing the list will be allocated and released by the caller.\r
  ///\r
  EFI_IPv4_ADDRESS              *DnsServerList;\r
  ///\r
  /// Set to TRUE to use the default IP address/subnet mask and default routing table.\r
  ///\r
  BOOLEAN                       UseDefaultSetting;\r
  ///\r
  /// If TRUE, enable DNS cache function for this DNS instance. If FALSE, all DNS\r
  /// query will not lookup local DNS cache.\r
  ///\r
  BOOLEAN                       EnableDnsCache;\r
  ///\r
  /// Use the protocol number defined in "Links to UEFI-Related\r
  /// Documents"(http://uefi.org/uefi) under the heading "IANA\r
  /// Protocol Numbers". Only TCP or UDP are supported, and other\r
  /// protocol values are invalid. An implementation can choose to\r
  /// support only UDP, or both TCP and UDP.\r
  ///\r
  UINT8                         Protocol;\r
  ///\r
  /// If UseDefaultSetting is FALSE indicates the station address to use.\r
  ///\r
  EFI_IPv4_ADDRESS              StationIp;\r
  ///\r
  /// If UseDefaultSetting is FALSE indicates the subnet mask to use.\r
  ///\r
  EFI_IPv4_ADDRESS              SubnetMask;\r
  ///\r
  /// Local port number. Set to zero to use the automatically assigned port number.\r
  ///\r
  UINT16                        LocalPort;\r
  ///\r
  /// Retry number if no response received after RetryInterval.\r
  ///\r
  UINT32                        RetryCount;\r
  ///\r
  /// Minimum interval of retry is 2 second. If the retry interval is less than 2\r
  /// seconds, then use the 2 seconds.\r
  ///\r
  UINT32                        RetryInterval;\r
} EFI_DNS4_CONFIG_DATA;\r
\r
\r
///\r
/// EFI_DNS4_CACHE_ENTRY\r
///\r
typedef struct {\r
  ///\r
  /// Host name.\r
  ///\r
  CHAR16                        *HostName;\r
  ///\r
  /// IP address of this host.\r
  ///\r
  EFI_IPv4_ADDRESS              *IpAddress;\r
  ///\r
  /// Time in second unit that this entry will remain in DNS cache. A value of zero\r
  /// means that this entry is permanent. A nonzero value will override the existing\r
  /// one if this entry to be added is dynamic entry. Implementations may set its\r
  /// default timeout value for the dynamically created DNS cache entry after one DNS\r
  /// resolve succeeds.\r
  ///\r
  UINT32                        Timeout;\r
} EFI_DNS4_CACHE_ENTRY;\r
\r
///\r
/// EFI_DNS4_MODE_DATA\r
///\r
typedef struct {\r
  ///\r
  /// The configuration data of this instance.\r
  ///\r
  EFI_DNS4_CONFIG_DATA          DnsConfigData;\r
  ///\r
  /// Number of configured DNS server. Each DNS instance has its own DNS server\r
  /// configuration.\r
  ///\r
  UINT32                        DnsServerCount;\r
  ///\r
  /// Pointer to common list of addresses of all configured DNS server\r
  /// used by EFI_DNS4_PROTOCOL instances. List will include\r
  /// DNS servers configured by this or any other EFI_DNS4_PROTOCOL instance.\r
  /// The storage for this list is allocated by the driver publishing this\r
  /// protocol, and must be freed by the caller.\r
  ///\r
  EFI_IPv4_ADDRESS              *DnsServerList;\r
  ///\r
  /// Number of DNS Cache entries. The DNS Cache is shared among all DNS instances.\r
  ///\r
  UINT32                        DnsCacheCount;\r
  ///\r
  /// Pointer to a buffer containing DnsCacheCount DNS Cache\r
  /// entry structures. The storage for this list is allocated by the driver\r
  /// publishing this protocol and must be freed by caller.\r
  ///\r
  EFI_DNS4_CACHE_ENTRY          *DnsCacheList;\r
} EFI_DNS4_MODE_DATA;\r
\r
///\r
/// DNS_HOST_TO_ADDR_DATA\r
///\r
typedef struct {\r
  ///\r
  /// Number of the returned IP addresses.\r
  ///\r
  UINT32                        IpCount;\r
  ///\r
  /// Pointer to the all the returned IP addresses.\r
  ///\r
  EFI_IPv4_ADDRESS              *IpList;\r
} DNS_HOST_TO_ADDR_DATA;\r
\r
///\r
/// DNS_ADDR_TO_HOST_DATA\r
///\r
typedef struct {\r
  ///\r
  /// Pointer to the primary name for this host address. It's the caller's\r
  /// responsibility to free the response memory.\r
  ///\r
  CHAR16                        *HostName;\r
} DNS_ADDR_TO_HOST_DATA;\r
\r
///\r
/// DNS_RESOURCE_RECORD\r
///\r
typedef struct {\r
  ///\r
  /// The Owner name.\r
  ///\r
  CHAR8                         *QName;\r
  ///\r
  /// The Type Code of this RR.\r
  ///\r
  UINT16                        QType;\r
  ///\r
  /// The CLASS code of this RR.\r
  ///\r
  UINT16                        QClass;\r
  ///\r
  /// 32 bit integer which specify the time interval that the resource record may be\r
  /// cached before the source of the information should again be consulted. Zero means\r
  /// this RR can not be cached.\r
  ///\r
  UINT32                        TTL;\r
  ///\r
  /// 16 big integer which specify the length of RData.\r
  ///\r
  UINT16                        DataLength;\r
  ///\r
  /// A string of octets that describe the resource, the format of this information\r
  /// varies according to QType and QClass difference.\r
  ///\r
  CHAR8                         *RData;\r
} DNS_RESOURCE_RECORD;\r
\r
///\r
/// DNS_GENERAL_LOOKUP_DATA\r
///\r
typedef struct {\r
  ///\r
  /// Number of returned matching RRs.\r
  ///\r
  UINTN                         RRCount;\r
  ///\r
  /// Pointer to the all the returned matching RRs. It's caller responsibility to free\r
  /// the allocated memory to hold the returned RRs.\r
  ///\r
  DNS_RESOURCE_RECORD           *RRList;\r
} DNS_GENERAL_LOOKUP_DATA;\r
\r
///\r
/// EFI_DNS4_COMPLETION_TOKEN\r
///\r
typedef struct {\r
  ///\r
  /// This Event will be signaled after the Status field is updated by the EFI DNS\r
  /// protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.\r
  ///\r
  EFI_EVENT                               Event;\r
  ///\r
  /// Will be set to one of the following values:\r
  ///   EFI_SUCCESS:      The host name to address translation completed successfully.\r
  ///   EFI_NOT_FOUND:    No matching Resource Record (RR) is found.\r
  ///   EFI_TIMEOUT:      No DNS server reachable, or RetryCount was exhausted without\r
  ///                     response from all specified DNS servers.\r
  ///   EFI_DEVICE_ERROR: An unexpected system or network error occurred.\r
  ///   EFI_NO_MEDIA:     There was a media error.\r
  ///\r
  EFI_STATUS                              Status;\r
  ///\r
  /// Retry number if no response received after RetryInterval. If zero, use the\r
  /// parameter configured through Dns.Configure() interface.\r
  ///\r
  UINT32                                  RetryCount;\r
  ///\r
  /// Minimum interval of retry is 2 second. If the retry interval is less than 2\r
  /// seconds, then use the 2 seconds. If zero, use the parameter configured through\r
  /// Dns.Configure() interface.\r
  UINT32                                  RetryInterval;\r
  ///\r
  /// DNSv4 completion token data\r
  ///\r
  union {\r
    ///\r
    /// When the Token is used for host name to address translation, H2AData is a pointer\r
    /// to the DNS_HOST_TO_ADDR_DATA.\r
    ///\r
    DNS_HOST_TO_ADDR_DATA         *H2AData;\r
    ///\r
    /// When the Token is used for host address to host name translation, A2HData is a\r
    /// pointer to the DNS_ADDR_TO_HOST_DATA.\r
    ///\r
    DNS_ADDR_TO_HOST_DATA         *A2HData;\r
    ///\r
    /// When the Token is used for a general lookup function, GLookupDATA is a pointer to\r
    /// the DNS_GENERAL_LOOKUP_DATA.\r
    ///\r
    DNS_GENERAL_LOOKUP_DATA       *GLookupData;\r
  } RspData;\r
} EFI_DNS4_COMPLETION_TOKEN;\r
\r
/**\r
  Retrieve mode data of this DNS instance.\r
\r
  This function is used to retrieve DNS mode data for this DNS instance.\r
\r
  @param[in]   This               Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[out]  DnsModeData        Point to the mode data.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_NOT_STARTED         When DnsConfigData is queried, no configuration data\r
                                  is available because this instance has not been\r
                                  configured.\r
  @retval EFI_INVALID_PARAMETER   This is NULL or DnsModeData is NULL.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_GET_MODE_DATA) (\r
  IN  EFI_DNS4_PROTOCOL          *This,\r
  OUT EFI_DNS4_MODE_DATA         *DnsModeData\r
  );\r
\r
/**\r
  Configure this DNS instance.\r
\r
  This function is used to configure DNS mode data for this DNS instance.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[in]  DnsConfigData       Point to the Configuration data.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_UNSUPPORTED         The designated protocol is not supported.\r
  @retval EFI_INVALID_PARAMETER   This is NULL.\r
                                  The StationIp address provided in DnsConfigData is not a\r
                                  valid unicast.\r
                                  DnsServerList is NULL while DnsServerListCount\r
                                  is not ZERO.\r
                                  DnsServerListCount is ZERO while DnsServerList\r
                                  is not NULL\r
  @retval EFI_OUT_OF_RESOURCES    The DNS instance data or required space could not be\r
                                  allocated.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. The\r
                                  EFI DNSv4 Protocol instance is not configured.\r
  @retval EFI_ALREADY_STARTED     Second call to Configure() with DnsConfigData. To\r
                                  reconfigure the instance the caller must call Configure()\r
                                  with NULL first to return driver to unconfigured state.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_CONFIGURE) (\r
  IN EFI_DNS4_PROTOCOL          *This,\r
  IN EFI_DNS4_CONFIG_DATA       *DnsConfigData\r
  );\r
\r
/**\r
  Host name to host address translation.\r
\r
  The HostNameToIp () function is used to translate the host name to host IP address. A\r
  type A query is used to get the one or more IP addresses for this host.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[in]  HostName            Host name.\r
  @param[in]  Token               Point to the completion token to translate host name\r
                                  to host address.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  Token is NULL.\r
                                  Token.Event is NULL.\r
                                  HostName is NULL. HostName string is unsupported format.\r
  @retval EFI_NO_MAPPING          There's no source address is available for use.\r
  @retval EFI_NOT_STARTED         This instance has not been started.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_HOST_NAME_TO_IP) (\r
   IN EFI_DNS4_PROTOCOL         *This,\r
   IN CHAR16                    *HostName,\r
   IN EFI_DNS4_COMPLETION_TOKEN *Token\r
  );\r
\r
/**\r
  IPv4 address to host name translation also known as Reverse DNS lookup.\r
\r
  The IpToHostName() function is used to translate the host address to host name. A type PTR\r
  query is used to get the primary name of the host. Support of this function is optional.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[in]  IpAddress           Ip Address.\r
  @param[in]  Token               Point to the completion token to translate host\r
                                  address to host name.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_UNSUPPORTED         This function is not supported.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  Token is NULL.\r
                                  Token.Event is NULL.\r
                                  IpAddress is not valid IP address .\r
  @retval EFI_NO_MAPPING          There's no source address is available for use.\r
  @retval EFI_ALREADY_STARTED     This Token is being used in another DNS session.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_IP_TO_HOST_NAME) (\r
   IN EFI_DNS4_PROTOCOL         *This,\r
   IN EFI_IPv4_ADDRESS          IpAddress,\r
   IN EFI_DNS4_COMPLETION_TOKEN *Token\r
  );\r
\r
/**\r
  Retrieve arbitrary information from the DNS server.\r
\r
  This GeneralLookup() function retrieves arbitrary information from the DNS. The caller\r
  supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All\r
  RR content (e.g., TTL) was returned. The caller need parse the returned RR to get\r
  required information. The function is optional.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[in]  QName               Pointer to Query Name.\r
  @param[in]  QType               Query Type.\r
  @param[in]  QClass              Query Name.\r
  @param[in]  Token               Point to the completion token to retrieve arbitrary\r
                                  information.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_UNSUPPORTED         This function is not supported. Or the requested\r
                                  QType is not supported\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  Token is NULL.\r
                                  Token.Event is NULL.\r
                                  QName is NULL.\r
  @retval EFI_NO_MAPPING          There's no source address is available for use.\r
  @retval EFI_ALREADY_STARTED     This Token is being used in another DNS session.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_GENERAL_LOOKUP) (\r
  IN EFI_DNS4_PROTOCOL          *This,\r
  IN CHAR8                      *QName,\r
  IN UINT16                     QType,\r
  IN UINT16                     QClass,\r
  IN EFI_DNS4_COMPLETION_TOKEN  *Token\r
  );\r
\r
/**\r
  This function is to update the DNS Cache.\r
\r
  The UpdateDnsCache() function is used to add/delete/modify DNS cache entry. DNS cache\r
  can be normally dynamically updated after the DNS resolve succeeds. This function\r
  provided capability to manually add/delete/modify the DNS cache.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[in]  DeleteFlag          If FALSE, this function is to add one entry to the\r
                                  DNS Cahce. If TRUE, this function will delete\r
                                  matching DNS Cache entry.\r
  @param[in]  Override            If TRUE, the maching DNS cache entry will be\r
                                  overwritten with the supplied parameter. If FALSE,\r
                                  EFI_ACCESS_DENIED will be returned if the entry to\r
                                  be added is already existed.\r
  @param[in]  DnsCacheEntry       Pointer to DNS Cache entry.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  DnsCacheEntry.HostName is NULL.\r
                                  DnsCacheEntry.IpAddress is NULL.\r
                                  DnsCacheEntry.Timeout is zero.\r
  @retval EFI_ACCESS_DENIED       The DNS cache entry already exists and Override is\r
                                  not TRUE.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_UPDATE_DNS_CACHE) (\r
  IN EFI_DNS4_PROTOCOL          *This,\r
  IN BOOLEAN                    DeleteFlag,\r
  IN BOOLEAN                    Override,\r
  IN EFI_DNS4_CACHE_ENTRY       DnsCacheEntry\r
  );\r
\r
/**\r
  Polls for incoming data packets and processes outgoing data packets.\r
\r
  The Poll() function can be used by network drivers and applications to increase the\r
  rate that data packets are moved between the communications device and the transmit\r
  and receive queues.\r
  In some systems, the periodic timer event in the managed network driver may not poll\r
  the underlying communications device fast enough to transmit and/or receive all data\r
  packets without missing incoming packets or dropping outgoing packets. Drivers and\r
  applications that are experiencing packet loss should try calling the Poll()\r
  function more often.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS             Incoming or outgoing data was processed.\r
  @retval EFI_NOT_STARTED         This EFI DNS Protocol instance has not been started.\r
  @retval EFI_INVALID_PARAMETER   This is NULL.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.\r
  @retval EFI_TIMEOUT             Data was dropped out of the transmit and/or receive\r
                                  queue. Consider increasing the polling rate.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_POLL) (\r
  IN  EFI_DNS4_PROTOCOL         *This\r
  );\r
\r
/**\r
  Abort an asynchronous DNS operation, including translation between IP and Host, and\r
  general look up behavior.\r
\r
  The Cancel() function is used to abort a pending resolution request. After calling\r
  this function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r
  signaled. If the token is not in one of the queues, which usually means that the\r
  asynchronous operation has completed, this function will not signal the token and\r
  EFI_NOT_FOUND is returned.\r
\r
  @param[in]  This                Pointer to EFI_DNS4_PROTOCOL instance.\r
  @param[in]  Token               Pointer to a token that has been issued by\r
                                  EFI_DNS4_PROTOCOL.HostNameToIp (),\r
                                  EFI_DNS4_PROTOCOL.IpToHostName() or\r
                                  EFI_DNS4_PROTOCOL.GeneralLookup().\r
                                  If NULL, all pending tokens are aborted.\r
\r
  @retval EFI_SUCCESS             Incoming or outgoing data was processed.\r
  @retval EFI_NOT_STARTED         This EFI DNS4 Protocol instance has not been started.\r
  @retval EFI_INVALID_PARAMETER   This is NULL.\r
  @retval EFI_NOT_FOUND           When Token is not NULL, and the asynchronous DNS\r
                                  operation was not found in the transmit queue. It\r
                                  was either completed or was not issued by\r
                                  HostNameToIp(), IpToHostName() or GeneralLookup().\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DNS4_CANCEL) (\r
  IN  EFI_DNS4_PROTOCOL         *This,\r
  IN  EFI_DNS4_COMPLETION_TOKEN *Token\r
  );\r
\r
///\r
/// The EFI_DNS4_Protocol provides the function to get the host name and address\r
/// mapping, also provides pass through interface to retrieve arbitrary information\r
/// from DNS.\r
///\r
struct _EFI_DNS4_PROTOCOL {\r
  EFI_DNS4_GET_MODE_DATA        GetModeData;\r
  EFI_DNS4_CONFIGURE            Configure;\r
  EFI_DNS4_HOST_NAME_TO_IP      HostNameToIp;\r
  EFI_DNS4_IP_TO_HOST_NAME      IpToHostName;\r
  EFI_DNS4_GENERAL_LOOKUP       GeneralLookUp;\r
  EFI_DNS4_UPDATE_DNS_CACHE     UpdateDnsCache;\r
  EFI_DNS4_POLL                 Poll;\r
  EFI_DNS4_CANCEL               Cancel;\r
};\r
\r
extern EFI_GUID gEfiDns4ServiceBindingProtocolGuid;\r
extern EFI_GUID gEfiDns4ProtocolGuid;\r
\r
#endif\r