MdeModulePkg: Clean up source files

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

diff --git a/MdeModulePkg/Include/Library/UdpIoLib.h b/MdeModulePkg/Include/Library/UdpIoLib.h
index 03618f61bb2faa40d12ca96affa38ec70f9d7a6d..ca65622adf7afec4534bb58375a3b868d330dcc8 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 - 2010, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 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<BR>\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -49,7 +49,7 @@ 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, \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
@@ -60,7 +60,7 @@ typedef struct {
 **/\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,7 +97,7 @@ 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 \r
+/// the CallBack will be called. There can be several transmit requests. All transmit\r
 /// requests are linked in a list.\r
 ///\r
 \r
@@ -137,7 +137,7 @@ struct _UDP_IO {
   UINT8                     UdpVersion;\r
 \r
   //\r
-  // Handle used to create/destory UDP child\r
+  // Handle used to create/destroy UDP child\r
   //\r
   EFI_HANDLE                Controller;\r
   EFI_HANDLE                Image;\r
@@ -173,7 +173,7 @@ struct _UDP_IO {
 **/\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
@@ -190,14 +190,16 @@ EFI_STATUS
 **/\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
 \r
 /**\r
   Cancel all the sent datagram that pass the selection criteria of ToCancel.\r
+\r
   If ToCancel is NULL, all the datagrams are cancelled.\r
+  If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
 \r
   @param[in]  UdpIo                 The UDP_IO to cancel packet.\r
   @param[in]  IoStatus              The IoStatus to return to the packet owners.\r
@@ -212,13 +214,16 @@ UdpIoCancelDgrams (
   IN UDP_IO                 *UdpIo,\r
   IN EFI_STATUS             IoStatus,\r
   IN UDP_IO_TO_CANCEL       ToCancel,        OPTIONAL\r
-  IN VOID                   *Context\r
+  IN VOID                   *Context         OPTIONAL\r
   );\r
 \r
 /**\r
   Creates a UDP_IO to access the UDP service. It creates and configures\r
   a UDP child.\r
 \r
+  If Configure is NULL, then ASSERT().\r
+  If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
   It locates the UDP service binding prototype on the Controller parameter\r
   uses the UDP service binding prototype to create a UDP child (also known as\r
   a UDP instance) configures the UDP child by calling Configure function prototype.\r
@@ -247,11 +252,14 @@ UdpIoCreateIo (
 /**\r
   Free the UDP_IO and all its related resources.\r
 \r
+  If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
   The function cancels all sent datagrams and receive requests.\r
 \r
   @param[in]  UdpIo             The UDP_IO to free.\r
 \r
   @retval EFI_SUCCESS           The UDP_IO is freed.\r
+  @retval Others                Failed to free UDP_IO.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -264,6 +272,8 @@ UdpIoFreeIo (
   Cleans up the UDP_IO without freeing it. Call this function\r
   if you intend to later re-use the UDP_IO.\r
 \r
+  If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
   This function releases all transmitted datagrams and receive requests and configures NULL for the UDP instance.\r
 \r
   @param[in]  UdpIo                 The UDP_IO to clean up.\r
@@ -278,6 +288,8 @@ UdpIoCleanIo (
 /**\r
   Send a packet through the UDP_IO.\r
 \r
+  If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
   The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called\r
   when the packet is sent. The optional parameter EndPoint overrides the default\r
   address pair if specified.\r
@@ -324,6 +336,8 @@ UdpIoCancelSentDatagram (
 /**\r
   Issue a receive request to the UDP_IO.\r
 \r
+  If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
   This function is called when upper-layer needs packet from UDP for processing.\r
   Only one receive request is acceptable at a time. Therefore, one common usage model is\r
   to invoke this function inside its Callback function when the former packet\r