Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/ManagedNetwork.h b/MdePkg/Include/Protocol/ManagedNetwork.h
index 92a41dd1835272fa0034780cccec39a5390fc0db..8aedc7f90d6ea449c37b0841734a8281a067a8ac 100644 (file)
--- a/MdePkg/Include/Protocol/ManagedNetwork.h
+++ b/MdePkg/Include/Protocol/ManagedNetwork.h
@@ -2,7 +2,7 @@
   EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
   EFI_MANAGED_NETWORK_PROTOCOL as defined in UEFI 2.0.\r
 \r
-  Copyright (c) 2006, Intel Corporation\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
@@ -13,8 +13,8 @@
 \r
 **/\r
 \r
-#ifndef _EFI_MANAGED_NETWORK_PROTOCOL_H\r
-#define _EFI_MANAGED_NETWORK_PROTOCOL_H\r
+#ifndef __EFI_MANAGED_NETWORK_PROTOCOL_H__\r
+#define __EFI_MANAGED_NETWORK_PROTOCOL_H__\r
 \r
 #include <Protocol/SimpleNetwork.h>\r
 \r
@@ -102,12 +102,11 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_GET_MODE_DATA) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_GET_MODE_DATA)(\r
   IN  EFI_MANAGED_NETWORK_PROTOCOL     *This,\r
   OUT EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData  OPTIONAL,\r
   OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData    OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets or clears the operational parameters for the MNP child driver.\r
@@ -130,11 +129,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_CONFIGURE) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_CONFIGURE)(\r
   IN EFI_MANAGED_NETWORK_PROTOCOL     *This,\r
   IN EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Translates an IP multicast address to a hardware (MAC) multicast address.\r
@@ -159,13 +157,12 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_MCAST_IP_TO_MAC) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_MCAST_IP_TO_MAC)(\r
   IN  EFI_MANAGED_NETWORK_PROTOCOL  *This,\r
   IN  BOOLEAN                       Ipv6Flag,\r
   IN  EFI_IP_ADDRESS                *IpAddress,\r
   OUT EFI_MAC_ADDRESS               *MacAddress\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Enables and disables receive filters for multicast address.\r
@@ -190,12 +187,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_GROUPS) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_GROUPS)(\r
   IN EFI_MANAGED_NETWORK_PROTOCOL  *This,\r
   IN BOOLEAN                       JoinFlag,\r
   IN EFI_MAC_ADDRESS               *MacAddress  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Places asynchronous outgoing data packets into the transmit queue.\r
@@ -215,11 +211,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_TRANSMIT) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_TRANSMIT)(\r
   IN EFI_MANAGED_NETWORK_PROTOCOL          *This,\r
   IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Places an asynchronous receiving request into the receiving queue.\r
@@ -242,11 +237,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_RECEIVE) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_RECEIVE)(\r
   IN EFI_MANAGED_NETWORK_PROTOCOL          *This,\r
   IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -270,11 +264,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_CANCEL) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_CANCEL)(\r
   IN EFI_MANAGED_NETWORK_PROTOCOL          *This,\r
   IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Polls for incoming data packets and processes outgoing data packets.\r
@@ -292,11 +285,14 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_POLL) (\r
+(EFIAPI *EFI_MANAGED_NETWORK_POLL)(\r
   IN EFI_MANAGED_NETWORK_PROTOCOL    *This\r
-  )\r
-;\r
+  );\r
 \r
+///\r
+/// The MNP is used by network applications (and drivers) to \r
+/// perform raw (unformatted) asynchronous network packet I/O.\r
+///\r
 struct _EFI_MANAGED_NETWORK_PROTOCOL {\r
   EFI_MANAGED_NETWORK_GET_MODE_DATA       GetModeData;\r
   EFI_MANAGED_NETWORK_CONFIGURE           Configure;\r