Code Scrub for Protocol and Ppi Definition

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5564 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 37 insertions, 2 deletions

diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h
index 4e158a2..bc95bc7 100644
--- a/MdePkg/Include/Protocol/Udp4.h
+++ b/MdePkg/Include/Protocol/Udp4.h
@@ -1,7 +1,10 @@
 /** @file

-  UDP4 Service Binding Protocol

+  UDP4 Service Binding Protocol as defined in UEFI specification.

 

-  Copyright (c) 2006, Intel Corporation                                                         

+  The EFI UDPv4 Protocol provides simple packet-oriented services 

+  to transmit and receive UDP packets.  

+

+  Copyright (c) 2006 - 2008, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -347,6 +350,38 @@ EFI_STATUS
   )

 ;       

 

+/**  

+  @par Protocol Description:

+  The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used 

+  by any network drivers, applications, or daemons to transmit or receive UDP packets. 

+  This protocol instance can either be bound to a specified port as a service or 

+  connected to some remote peer as an active client. Each instance has its own settings, 

+  such as the routing table and group table, which are independent from each other.

+

+  @param GetModeData

+  Reads the current operational settings. 

+

+  @param Configure

+  Initializes, changes, or resets operational settings for the EFI UDPv4 Protocol. 

+

+  @param Groups

+  Joins and leaves multicast groups. 

+

+  @param Routes

+  Add and deletes routing table entries. 

+

+  @param Transmit

+  Queues outgoing data packets into the transmit queue. This function is a nonblocked operation. 

+

+  @param Receive

+  Places a receiving request token into the receiving queue. This function is a nonblocked operation. 

+

+  @param Cancel

+  Aborts a pending transmit or receive request. 

+

+  @param Poll

+  Polls for incoming data packets and processes outgoing data packets.   

+**/

 struct _EFI_UDP4_PROTOCOL {

   EFI_UDP4_GET_MODE_DATA        GetModeData;

   EFI_UDP4_CONFIGURE            Configure;