]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Dns6.h
MdePkg: Add new MM MP Protocol definition.
[mirror_edk2.git] / MdePkg / Include / Protocol / Dns6.h
index 813893addd6b060ca6ac9badfcede3b9dd1a1b8e..ebf368f36facedadee604d4953aaa87db66773b2 100644 (file)
@@ -4,14 +4,8 @@
   DNSv6 Service Binding Protocol (DNSv6SB)\r
   DNSv6 Protocol (DNSv6)\r
 \r
-  Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
-  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
+  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
@@ -49,8 +43,8 @@ typedef struct {
   ///\r
   UINT8                         Protocol;\r
   ///\r
-  /// The local IP address to use. Set to zero to let the underlying IPv6 \r
-  /// driver choose a source address. If not zero it must be one of the \r
+  /// The local IP address to use. Set to zero to let the underlying IPv6\r
+  /// driver choose a source address. If not zero it must be one of the\r
   /// configured IP addresses in the underlying IPv6 driver.\r
   ///\r
   EFI_IPv6_ADDRESS              StationIp;\r
@@ -59,23 +53,23 @@ typedef struct {
   ///\r
   UINT16                        LocalPort;\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
+  /// 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
   UINT32                        DnsServerCount;\r
   ///\r
   /// Pointer to DNS server list containing DnsServerListCount\r
-  /// entries or NULL if DnsServerListCount is 0. For Configure(), \r
-  /// this will be NULL when there are no caller supplied server addresses \r
-  /// and the DNS instance will retrieve DNS server from DHCP Server. \r
-  /// The provided DNS server list is recommended to be filled up in the sequence \r
-  /// of preference. When used with GetModeData(), the buffer containing the list \r
-  /// will be allocated by the driver implementing this protocol and must be \r
-  /// freed by the caller. When used with Configure(), the buffer \r
+  /// entries or NULL if DnsServerListCount is 0. For Configure(),\r
+  /// this will be NULL when there are no caller supplied server addresses\r
+  /// and the DNS instance will retrieve DNS server from DHCP Server.\r
+  /// The provided DNS server list is recommended to be filled up in the sequence\r
+  /// of preference. When used with GetModeData(), the buffer containing the list\r
+  /// will 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_IPv6_ADDRESS              *DnsServerList;\r
@@ -121,21 +115,21 @@ typedef struct {
   ///\r
   /// Number of configured DNS6 servers.\r
   ///\r
-  UINT32                               DnsServerCount;\r
+  UINT32                         DnsServerCount;\r
   ///\r
-  /// Pointer to common list of addresses of all configured DNS server used by EFI_DNS6_PROTOCOL \r
-  /// instances. List will include DNS servers configured by this or any other EFI_DNS6_PROTOCOL \r
-  /// instance. The storage for this list is allocated by the driver publishing this protocol, \r
+  /// Pointer to common list of addresses of all configured DNS server used by EFI_DNS6_PROTOCOL\r
+  /// instances. List will include DNS servers configured by this or any other EFI_DNS6_PROTOCOL\r
+  /// instance. The storage for this list is allocated by the driver publishing this protocol,\r
   /// and must be freed by the caller.\r
   ///\r
-  EFI_IPv6_ADDRESS                     *DnsServerList;\r
+  EFI_IPv6_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 thislist is allocated by the driver \r
+  /// Pointer to a buffer containing DnsCacheCount DNS Cache\r
+  /// entry structures. The storage for thislist is allocated by the driver\r
   /// publishing this protocol and must be freed by caller.\r
   ///\r
   EFI_DNS6_CACHE_ENTRY          *DnsCacheList;\r
@@ -272,7 +266,7 @@ typedef struct {
   This function is used to retrieve DNS mode data for this DNS instance.\r
 \r
   @param[in]   This                Pointer to EFI_DNS6_PROTOCOL instance.\r
-  @param[out]  DnsModeData         Pointer to the caller-allocated storage for the \r
+  @param[out]  DnsModeData         Pointer to the caller-allocated storage for the\r
                                    EFI_DNS6_MODE_DATA data.\r
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
@@ -296,7 +290,7 @@ EFI_STATUS
   EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL.\r
 \r
   @param[in]  This                Pointer to EFI_DNS6_PROTOCOL instance.\r
-  @param[in]  DnsConfigData       Pointer to the configuration data structure. All associated \r
+  @param[in]  DnsConfigData       Pointer to the configuration data structure. All associated\r
                                   storage to be allocated and released by caller.\r
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
@@ -308,8 +302,8 @@ EFI_STATUS
   @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred. The\r
                                   EFI DNSv6 Protocol instance is not configured.\r
   @retval EFI_UNSUPPORTED         The designated protocol is not supported.\r
-  @retval EFI_ALREADY_STARTED     Second call to Configure() with DnsConfigData. To \r
-                                  reconfigure the instance the caller must call Configure() with \r
+  @retval EFI_ALREADY_STARTED     Second call to Configure() with DnsConfigData. To\r
+                                  reconfigure the instance the caller must call Configure() with\r
                                   NULL first to return driver to unconfigured state.\r
 **/\r
 typedef\r