NetworkPkg/UefiPxeBcDxe: handle competing DHCP servers (more) gracefully

[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcSupport.h

diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h b/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
index b8519ae8c8de6b7d4bf00d4304fb11b1f7eaa6d5..312572129e787063ef2af09ad54e1cad212e5e44 100644 (file)
--- a/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
+++ b/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
@@ -1,15 +1,9 @@
 /** @file\r
   Support functions declaration for UefiPxeBc Driver.\r
 \r
-  Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \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
@@ -27,7 +21,7 @@
 \r
 \r
 /**\r
-  Flush the previous configration using the new station Ip address.\r
+  Flush the previous configuration using the new station Ip address.\r
 \r
   @param[in]   Private        Pointer to PxeBc private data.\r
   @param[in]   StationIp      Pointer to the station Ip address.\r
@@ -40,7 +34,7 @@
 EFI_STATUS\r
 PxeBcFlushStationIp (\r
   PXEBC_PRIVATE_DATA       *Private,\r
-  EFI_IP_ADDRESS           *StationIp,\r
+  EFI_IP_ADDRESS           *StationIp,     OPTIONAL\r
   EFI_IP_ADDRESS           *SubnetMask     OPTIONAL\r
   );\r
 \r
@@ -65,7 +59,7 @@ PxeBcCommonNotify (
 \r
   @param  Mode           Pointer to EFI_PXE_BASE_CODE_MODE.\r
   @param  Ip4Addr        The Ip4 address for resolution.\r
-  @param  MacAddress     The resoluted MAC address if the resolution is successful.\r
+  @param  MacAddress     The resolved MAC address if the resolution is successful.\r
                          The value is undefined if resolution fails.\r
 \r
   @retval TRUE           Found a matched entry.\r
@@ -135,7 +129,7 @@ PxeBcIcmp6ErrorUpdate (
   @param[in, out]  SrcPort              The pointer to the source port.\r
   @param[in]       DoNotFragment        If TRUE, fragment is not enabled.\r
                                         Otherwise, fragment is enabled.\r
-  @param[in]       Ttl                  The time to live field of the IP header. \r
+  @param[in]       Ttl                  The time to live field of the IP header.\r
   @param[in]       ToS                  The type of service field of the IP header.\r
 \r
   @retval          EFI_SUCCESS          Successfully configured this instance.\r
@@ -162,7 +156,7 @@ PxeBcConfigUdp4Write (
   @param[in]       StationIp            Pointer to the station address.\r
   @param[in, out]  SrcPort              Pointer to the source port.\r
 \r
-  @retval          EFI_SUCCESS          Successfuly configured this instance.\r
+  @retval          EFI_SUCCESS          Successfully configured this instance.\r
   @retval          Others               Failed to configure this instance.\r
 \r
 **/\r
@@ -240,7 +234,7 @@ PxeBcUdp6Write (
   @param[in]  Session             Pointer to the current UDPv4 session.\r
   @param[in]  OpFlags             Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the Ip filter.\r
+  @retval     TRUE                Successfully passed the Ip filter.\r
   @retval     FALSE               Failed to pass the Ip filter.\r
 \r
 **/\r
@@ -260,7 +254,7 @@ PxeBcCheckByIpFilter (
   @param[in, out]  DestIp         Pointer to the dest Ip address.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -281,7 +275,7 @@ PxeBcCheckByDestIp (
   @param[in, out]  DestPort       Pointer to the destination port.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -302,7 +296,7 @@ PxeBcCheckByDestPort (
   @param[in, out]  SrcIp          Pointer to the source Ip address.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -323,7 +317,7 @@ PxeBcFilterBySrcIp (
   @param[in, out]  SrcPort        Pointer to the source port.\r
   @param[in]       OpFlags        Operation flag for UdpRead/UdpWrite.\r
 \r
-  @retval     TRUE                Succesfully passed the IPv4 filter.\r
+  @retval     TRUE                Successfully passed the IPv4 filter.\r
   @retval     FALSE               Failed to pass the IPv4 filter.\r
 \r
 **/\r
@@ -453,7 +447,7 @@ PxeBcUintnToAscDecWithFormat (
   @param[in]  Number         Numeric value to be converted.\r
   @param[in]  Buffer         Pointer to the buffer for ASCII string.\r
   @param[in]  BufferSize     The maxsize of the buffer.\r
-  \r
+\r
   @return     Length         The actual length of the ASCII string.\r
 \r
 **/\r