Update the GUID value to be consist with the one in DEC file.

[mirror_edk2.git] / MdeModulePkg / Include / Library / UdpIoLib.h

diff --git a/MdeModulePkg/Include/Library/UdpIoLib.h b/MdeModulePkg/Include/Library/UdpIoLib.h
index a680cc6179afae4e03f6d4899938bba9004c5bf7..32d61e505a3f1eee4414880ca10a36954b28d55d 100644 (file)
--- a/MdeModulePkg/Include/Library/UdpIoLib.h
+++ b/MdeModulePkg/Include/Library/UdpIoLib.h
@@ -2,8 +2,8 @@
   This library is used to share code between UEFI network stack modules.\r
   It provides the helper routines to access UDP service. It is used by both DHCP and MTFTP.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, 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<BR>\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -49,18 +49,18 @@ typedef struct {
 \r
   This prototype is used by both receive and sending when calling\r
   UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the\r
-  UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then\r
-  provided to the callback as a reference.\r
-\r
-  @param[in] Packet       Packet received or sent\r
-  @param[in] EndPoint     The UDP address pair corresponds to the UDP IO\r
-  @param[in] IoStatus     Packet receiving or sending status\r
-  @param[in] Context      User-defined data when calling UdpIoRecvDatagram() or\r
-                          UdpIoSendDatagram()\r
+  UDP access point and released by the user. When sending, the user allocates the the NetBuf, \r
+  which is then provided to the callback as a reference.\r
+\r
+  @param[in] Packet       The packet received or sent.\r
+  @param[in] EndPoint     The UDP address pair corresponds to the UDP IO.\r
+  @param[in] IoStatus     The packet receiving or sending status.\r
+  @param[in] Context      The user-defined data when calling UdpIoRecvDatagram() or\r
+                          UdpIoSendDatagram().\r
 **/\r
 typedef\r
 VOID\r
-(*UDP_IO_CALLBACK) (\r
+(EFIAPI *UDP_IO_CALLBACK) (\r
   IN NET_BUF                *Packet,\r
   IN UDP_END_POINT          *EndPoint,\r
   IN EFI_STATUS             IoStatus,\r
@@ -97,8 +97,8 @@ typedef struct {
 /// This structure is used internally by UdpIo Library.\r
 ///\r
 /// Each transmit request is wrapped in an UDP_TX_TOKEN. Upon completion,\r
-/// the CallBack will be called. There can be several transmit requests. All transmit requests\r
-/// are linked in a list.\r
+/// the CallBack will be called. There can be several transmit requests. All transmit \r
+/// requests are linked in a list.\r
 ///\r
 \r
 typedef union {\r
@@ -160,20 +160,20 @@ struct _UDP_IO {
 };\r
 \r
 /**\r
-  Prototype called when UdpIo Library configures a UDP instance.\r
+  The prototype called when UdpIo Library configures a UDP instance.\r
 \r
   The prototype is set and called when creating a UDP_IO in UdpIoCreatePort().\r
 \r
-  @param[in] UdpIo         The UDP_IO to configure\r
-  @param[in] Context       User-defined data when calling UdpIoCreatePort()\r
+  @param[in] UdpIo         The UDP_IO to configure.\r
+  @param[in] Context       The user-defined data when calling UdpIoCreatePort().\r
 \r
-  @retval EFI_SUCCESS  The configuration succeeded\r
+  @retval EFI_SUCCESS  The configuration succeeded.\r
   @retval Others       The UDP_IO fails to configure indicating\r
-                       UdpIoCreatePort() should fail\r
+                       UdpIoCreatePort() should fail.\r
 **/\r
 typedef\r
 EFI_STATUS\r
-(*UDP_IO_CONFIG) (\r
+(EFIAPI *UDP_IO_CONFIG) (\r
   IN UDP_IO                 *UdpIo,\r
   IN VOID                   *Context\r
   );\r
@@ -181,16 +181,16 @@ EFI_STATUS
 /**\r
   The select function to decide whether to cancel the UDP_TX_TOKEN.\r
 \r
-  @param[in] Token        The UDP_TX_TOKEN to decide whether to cancel\r
-  @param[in] Context      User-defined data in UdpIoCancelDgrams()\r
+  @param[in] Token        The UDP_TX_TOKEN to decide whether to cancel.\r
+  @param[in] Context      User-defined data in UdpIoCancelDgrams().\r
 \r
-  @retval TRUE        Cancel the UDP_TX_TOKEN\r
-  @retval FALSE       Do not cancel this UDP_TX_TOKEN\r
+  @retval TRUE        Cancel the UDP_TX_TOKEN.\r
+  @retval FALSE       Do not cancel this UDP_TX_TOKEN.\r
 \r
 **/\r
 typedef\r
 BOOLEAN\r
-(*UDP_IO_TO_CANCEL) (\r
+(EFIAPI *UDP_IO_TO_CANCEL) (\r
   IN UDP_TX_TOKEN           *Token,\r
   IN VOID                   *Context\r
   );\r
@@ -231,7 +231,7 @@ UdpIoCancelDgrams (
   @param[in]  UdpVersion            The UDP protocol version, UDP4 or UDP6.\r
   @param[in]  Context               The opaque parameter for the Configure funtion.\r
 \r
-  @return Newly-created UDP_IO or NULL if failed.\r
+  @return The newly-created UDP_IO, or NULL if failed.\r
 \r
 **/\r
 UDP_IO *\r
@@ -292,7 +292,7 @@ UdpIoCleanIo (
   @param[in]  Context               The opaque parameter passed to CallBack.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource for the packet.\r
-  @retval EFI_SUCCESS           The packet is successfully delivered to UDP  for\r
+  @retval EFI_SUCCESS           The packet is successfully delivered to UDP for\r
                                 transmission.\r
 \r
 **/\r
@@ -338,7 +338,7 @@ UdpIoCancelSentDatagram (
   @retval EFI_ALREADY_STARTED   There is already a pending receive request. Only\r
                                 one receive request is supported at a time.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate needed resources.\r
-  @retval EFI_SUCCESS           The receive request is issued successfully.\r
+  @retval EFI_SUCCESS           The receive request was issued successfully.\r
   @retval EFI_UNSUPPORTED       The UDP version in UDP_IO is not supported.\r
 \r
 **/\r