clean up the un-suitable ';' location when declaring the functions.

[mirror_edk2.git] / MdePkg / Include / Protocol / Udp4.h

diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h
index 7ac3c80f6c67be8b426673bda79ce9defd7d8344..8e2511faabe3fde258a9a306ae55c19cf39f9a7d 100644 (file)
--- a/MdePkg/Include/Protocol/Udp4.h
+++ b/MdePkg/Include/Protocol/Udp4.h
@@ -1,5 +1,10 @@
 /** @file\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  UDP4 Service Binding Protocol as defined in UEFI specification.\r
+\r
+  The EFI UDPv4 Protocol provides simple packet-oriented services \r
+  to transmit and receive UDP packets.  \r
+\r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -8,13 +13,12 @@
   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
 \r
-  Module Name:  Udp4.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_UDP4_PROTOCOL_H__\r
 #define __EFI_UDP4_PROTOCOL_H__\r
 \r
+#include <Protocol/Ip4.h>\r
 //\r
 //GUID definitions\r
 //\r
@@ -135,14 +139,13 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_GET_MODE_DATA) (\r
+(EFIAPI *EFI_UDP4_GET_MODE_DATA)(\r
   IN  EFI_UDP4_PROTOCOL                *This,\r
   OUT EFI_UDP4_CONFIG_DATA             *Udp4ConfigData OPTIONAL,\r
   OUT EFI_IP4_MODE_DATA                *Ip4ModeData    OPTIONAL,\r
   OUT EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData  OPTIONAL,\r
   OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData    OPTIONAL\r
-  )\r
-;  \r
+  );  \r
   \r
 \r
 /**\r
@@ -169,11 +172,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_CONFIGURE) (\r
+(EFIAPI *EFI_UDP4_CONFIGURE)(\r
   IN EFI_UDP4_PROTOCOL      *This,\r
   IN EFI_UDP4_CONFIG_DATA   *UdpConfigData OPTIONAL\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Joins and leaves multicast groups.\r
@@ -202,12 +204,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_GROUPS) (\r
+(EFIAPI *EFI_UDP4_GROUPS)(\r
   IN EFI_UDP4_PROTOCOL      *This,\r
   IN BOOLEAN                JoinFlag,\r
   IN EFI_IPv4_ADDRESS       *MulticastAddress    OPTIONAL\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Adds and deletes routing table entries.\r
@@ -231,14 +232,13 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_ROUTES) (\r
+(EFIAPI *EFI_UDP4_ROUTES)(\r
   IN EFI_UDP4_PROTOCOL      *This,\r
   IN BOOLEAN                DeleteRoute,\r
   IN EFI_IPv4_ADDRESS       *SubnetAddress,\r
   IN EFI_IPv4_ADDRESS       *SubnetMask,\r
   IN EFI_IPv4_ADDRESS       *GatewayAddress\r
-  )\r
-;     \r
+  );     \r
 \r
 /**\r
   Polls for incoming data packets and processes outgoing data packets.\r
@@ -253,10 +253,9 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_POLL) (\r
+(EFIAPI *EFI_UDP4_POLL)(\r
   IN EFI_UDP4_PROTOCOL      *This\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Places an asynchronous receive request into the receiving queue.\r
@@ -280,11 +279,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_RECEIVE) (\r
+(EFIAPI *EFI_UDP4_RECEIVE)(\r
   IN EFI_UDP4_PROTOCOL          *This,\r
   IN EFI_UDP4_COMPLETION_TOKEN  *Token\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Queues outgoing data packets into the transmit queue.\r
@@ -311,11 +309,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_UDP4_TRANSMIT) (\r
+(EFIAPI *EFI_UDP4_TRANSMIT)(\r
   IN EFI_UDP4_PROTOCOL           *This,\r
   IN EFI_UDP4_COMPLETION_TOKEN   *Token\r
-  )\r
-;     \r
+  );     \r
 \r
 /**\r
   Aborts an asynchronous transmit or receive request.\r
@@ -343,9 +340,40 @@ EFI_STATUS
 (EFIAPI *EFI_UDP4_CANCEL)(\r
   IN EFI_UDP4_PROTOCOL          *This,\r
   IN EFI_UDP4_COMPLETION_TOKEN  *Token  OPTIONAL\r
-  )\r
-;       \r
+  );       \r
+\r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used \r
+  by any network drivers, applications, or daemons to transmit or receive UDP packets. \r
+  This protocol instance can either be bound to a specified port as a service or \r
+  connected to some remote peer as an active client. Each instance has its own settings, \r
+  such as the routing table and group table, which are independent from each other.\r
+\r
+  @param GetModeData\r
+  Reads the current operational settings. \r
+\r
+  @param Configure\r
+  Initializes, changes, or resets operational settings for the EFI UDPv4 Protocol. \r
 \r
+  @param Groups\r
+  Joins and leaves multicast groups. \r
+\r
+  @param Routes\r
+  Add and deletes routing table entries. \r
+\r
+  @param Transmit\r
+  Queues outgoing data packets into the transmit queue. This function is a nonblocked operation. \r
+\r
+  @param Receive\r
+  Places a receiving request token into the receiving queue. This function is a nonblocked operation. \r
+\r
+  @param Cancel\r
+  Aborts a pending transmit or receive request. \r
+\r
+  @param Poll\r
+  Polls for incoming data packets and processes outgoing data packets.   \r
+**/\r
 struct _EFI_UDP4_PROTOCOL {\r
   EFI_UDP4_GET_MODE_DATA        GetModeData;\r
   EFI_UDP4_CONFIGURE            Configure;\r