]> git.proxmox.com Git - mirror_edk2.git/blobdiff - NetworkPkg/DnsDxe/DnsImpl.h
OvmfPkg: raise PcdShellFileOperationSize to 128KB
[mirror_edk2.git] / NetworkPkg / DnsDxe / DnsImpl.h
index 90dc0549038428859190500088263a6f1d92affa..affbb4be8ded3d87a5d13112a552da8f46a4a3e6 100644 (file)
@@ -2,13 +2,7 @@
 DnsDxe support functions implementation.\r
 \r
 Copyright (c) 2015 - 2018, 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
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -131,7 +125,7 @@ typedef struct {
   EFI_DNS6_COMPLETION_TOKEN  *Token;\r
 } DNS6_TOKEN_ENTRY;\r
 \r
-union _DNS_FLAGS{\r
+union _DNS_FLAGS {\r
   struct {\r
     UINT16     RCode:4;\r
     UINT16     Zero:3;\r
@@ -188,7 +182,7 @@ typedef struct {
   @param[in] TokenMap          All DNSv4 Token entrys.\r
   @param[in] TokenEntry        TokenEntry need to be removed.\r
 \r
-  @retval EFI_SUCCESS          Remove TokenEntry from TokenMap sucessfully.\r
+  @retval EFI_SUCCESS          Remove TokenEntry from TokenMap successfully.\r
   @retval EFI_NOT_FOUND        TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -204,7 +198,7 @@ Dns4RemoveTokenEntry (
   @param[in] TokenMap           All DNSv6 Token entrys.\r
   @param[in] TokenEntry         TokenEntry need to be removed.\r
 \r
-  @retval EFI_SUCCESS           Remove TokenEntry from TokenMap sucessfully.\r
+  @retval EFI_SUCCESS           Remove TokenEntry from TokenMap successfully.\r
   @retval EFI_NOT_FOUND         TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -215,7 +209,7 @@ Dns6RemoveTokenEntry (
   );\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -239,7 +233,7 @@ Dns4CancelTokens (
   );\r
 \r
 /**\r
-  This function cancle the token specified by Arg in the Map.\r
+  This function cancel the token specified by Arg in the Map.\r
 \r
   @param[in]  Map             Pointer to the NET_MAP.\r
   @param[in]  Item            Pointer to the NET_MAP_ITEM.\r
@@ -269,7 +263,7 @@ Dns6CancelTokens (
   @param[in]  Token               Pointer to the token to be get.\r
   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.\r
 \r
-  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.\r
+  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap successfully.\r
   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -288,7 +282,7 @@ GetDns4TokenEntry (
   @param[in]  Token               Pointer to the token to be get.\r
   @param[out] TokenEntry          Pointer to TokenEntry corresponding Token.\r
 \r
-  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap sucessfully.\r
+  @retval EFI_SUCCESS             Get the TokenEntry from the TokensMap successfully.\r
   @retval EFI_NOT_FOUND           TokenEntry is not found in TokenMap.\r
 \r
 **/\r
@@ -416,7 +410,7 @@ DnsDummyExtFree (
   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO\r
 \r
   @retval TRUE                   The default address is retrieved and UDP is reconfigured.\r
-  @retval FALSE                  Some error occured.\r
+  @retval FALSE                  Some error occurred.\r
 \r
 **/\r
 BOOLEAN\r
@@ -435,7 +429,7 @@ Dns4GetMapping (
   @param  UdpCfgData             The UDP configure data to reconfigure the UDP_IO\r
 \r
   @retval TRUE                   Configure the Udp6 instance successfully.\r
-  @retval FALSE                  Some error occured.\r
+  @retval FALSE                  Some error occurred.\r
 \r
 **/\r
 BOOLEAN\r
@@ -583,6 +577,7 @@ IsValidDnsResponse (
 \r
   @param  Instance              The DNS instance\r
   @param  RxString              Received buffer.\r
+  @param  Length                Received buffer length.\r
   @param  Completed             Flag to indicate that Dns response is valid.\r
 \r
   @retval EFI_SUCCESS           Parse Dns Response successfully.\r
@@ -593,6 +588,7 @@ EFI_STATUS
 ParseDnsResponse (\r
   IN OUT DNS_INSTANCE              *Instance,\r
   IN     UINT8                     *RxString,\r
+  IN     UINT32                    Length,\r
      OUT BOOLEAN                   *Completed\r
   );\r
 \r
@@ -747,7 +743,7 @@ Dns4GetModeData (
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
   @retval EFI_UNSUPPORTED         The designated protocol is not supported.\r
-  @retval EFI_INVALID_PARAMTER    Thisis NULL.\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
@@ -873,9 +869,9 @@ Dns4GeneralLookUp (
 \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
+                                  DNS Cache. 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
+  @param[in]  Override            If TRUE, the matching 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
@@ -993,7 +989,7 @@ Dns6GetModeData (
                                   storage to be allocated and released by caller.\r
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
-  @retval EFI_INVALID_PARAMTER    This is NULL.\r
+  @retval EFI_INVALID_PARAMETER    This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r
                                   DnsServerList is NULL while DnsServerList Count is not ZERO.\r
                                   DnsServerList Count is ZERO while DnsServerList is not NULL.\r
@@ -1121,9 +1117,9 @@ Dns6GeneralLookUp (
 \r
   @param[in]  This                Pointer to EFI_DNS6_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
+                                  DNS Cache. 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
+  @param[in]  Override            If TRUE, the matching 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