MdeModulePkg: Update PXE driver to follow edk2 coding standards.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcSupport.h

diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h
index 1458fde2bb195354cd93dec9011e39fd072bd0dc..16ac05ec82ae363d235673932b4698a41ac1cd2f 100644 (file)
--- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h
+++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h
@@ -1,7 +1,7 @@
 /** @file\r
   Support routines for PxeBc.\r
-Copyright (c) 2007 - 2008, Intel Corporation.<BR>                                                         \r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 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
@@ -14,23 +14,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __EFI_PXEBC_SUPPORT_H__\r
 #define __EFI_PXEBC_SUPPORT_H__\r
 \r
-/**\r
-  This function gets system guid and serial number from the smbios table.\r
-\r
-  @param  SystemGuid          The pointer of returned system guid.\r
-  @param  SystemSerialNumber  The pointer of returned system serial number.\r
-\r
-  @retval EFI_SUCCESS         Successfully get the system guid and system serial\r
-                              number.\r
-  @retval EFI_NOT_FOUND       Not find the SMBIOS table.\r
-\r
-**/\r
-EFI_STATUS\r
-GetSmbiosSystemGuidAndSerialNumber (\r
-  IN  EFI_GUID  *SystemGuid,\r
-  OUT CHAR8     **SystemSerialNumber\r
-  );\r
-\r
 \r
 /**\r
   The common notify function associated with various PxeBc events. \r
@@ -38,26 +21,26 @@ GetSmbiosSystemGuidAndSerialNumber (
   @param  Event     The event signaled.\r
   @param  Context   The context.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
+EFIAPI\r
 PxeBcCommonNotify (\r
   IN EFI_EVENT           Event,\r
   IN VOID                *Context\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
   This function initialize(or configure) the Udp4Write instance.\r
-  \r
+\r
   @param  Udp4       Pointer to the EFI_UDP4_PROTOCOL instance.\r
   @param  StationIp  Pointer to the station ip address.\r
   @param  SubnetMask Pointer to the subnetmask of the station ip address.\r
   @param  Gateway    Pointer to the gateway ip address.\r
   @param  SrcPort    Pointer to the srouce port of the station.\r
-  \r
+  @param  Ttl        The time to live field of the IP header. \r
+  @param  ToS        The type of service field of the IP header.\r
+\r
   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
@@ -72,7 +55,7 @@ PxeBcCommonNotify (
   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred and this instance\r
                                 was not opened.\r
   @retval Others                Please examine the function Udp4->Routes(Udp4, FALSE, &mZeroIp4Addr, &mZeroIp4Addr, Gateway) returns.\r
-  \r
+\r
 **/\r
 EFI_STATUS\r
 PxeBcConfigureUdpWriteInstance (\r
@@ -80,17 +63,17 @@ PxeBcConfigureUdpWriteInstance (
   IN EFI_IPv4_ADDRESS   *StationIp,\r
   IN EFI_IPv4_ADDRESS   *SubnetMask,\r
   IN EFI_IPv4_ADDRESS   *Gateway,\r
-  IN OUT UINT16         *SrcPort\r
+  IN OUT UINT16         *SrcPort,\r
+  IN     UINT8          Ttl,\r
+  IN     UINT8          ToS\r
   );\r
 /**\r
   Convert number to ASCII value.\r
 \r
   @param  Number              Numeric value to convert to decimal ASCII value.\r
-  @param  Buffer              Buffer to place ASCII version of the Number\r
+  @param  Buffer              Buffer to place ASCII version of the Number.\r
   @param  Length              Length of Buffer.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 CvtNum (\r
@@ -103,33 +86,34 @@ CvtNum (
 /**\r
   Convert unsigned int number to decimal number.\r
 \r
-  @param  Number      The unsigned int number will be converted.\r
-  @param  Buffer      Pointer to the buffer to store the decimal number after transform.\r
-\r
+  @param      Number         The unsigned int number will be converted.\r
+  @param      Buffer         Pointer to the buffer to store the decimal number after transform.\r
+  @param[in]  BufferSize     The maxsize of the buffer.\r
+  \r
   @return the length of the number after transform.\r
 \r
 **/\r
 UINTN\r
 UtoA10 (\r
   IN UINTN Number,\r
-  IN CHAR8 *Buffer\r
-  )\r
-;\r
+  IN CHAR8 *Buffer,\r
+  IN UINTN BufferSize\r
+  \r
+  );\r
 \r
 \r
 /**\r
   Convert ASCII numeric string to a UINTN value.\r
 \r
   @param  Buffer  Pointer to the 8-byte unsigned int value.\r
-  \r
+\r
   @return UINTN value of the ASCII string.\r
 \r
 **/\r
 UINT64\r
 AtoU64 (\r
   IN UINT8 *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 \r
 #endif\r