]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/ManagedNetwork.h
clean up the un-suitable ';' location when declaring the functions.
[mirror_edk2.git] / MdePkg / Include / Protocol / ManagedNetwork.h
index 1bf9a1305af52db755bbe864d6e2f502d7b6d1c1..f397b6b627832d576fa4d6e8d6e71e0d6a5f5e21 100644 (file)
@@ -2,21 +2,21 @@
   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
-  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
-  http://opensource.org/licenses/bsd-license.php                                            \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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  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:  ManagedNetwork.h\r
+  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
 **/\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
 #define EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL_GUID \\r
   { \\r
@@ -25,7 +25,7 @@
 \r
 #define EFI_MANAGED_NETWORK_PROTOCOL_GUID \\r
   { \\r
-    0x3b95aa31, 0x3793, 0x434b, {0x86, 0x67, 0xc8, 0x7, 0x8, 0x92, 0xe0, 0x5e } \\r
+    0x7ab33a91, 0xace5, 0x4326, { 0xb5, 0x72, 0xe7, 0xee, 0x33, 0xd3, 0x9f, 0x16 } \\r
   }\r
 \r
 typedef struct _EFI_MANAGED_NETWORK_PROTOCOL EFI_MANAGED_NETWORK_PROTOCOL;\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
+  OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData    OPTIONAL\r
+  );\r
 \r
 /**\r
   Sets or clears the operational parameters for the MNP child driver.\r
@@ -130,12 +129,11 @@ 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
+  IN EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData  OPTIONAL\r
+  );\r
+\r
 /**\r
   Translates an IP multicast address to a hardware (MAC) multicast address.\r
 \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
+  OUT EFI_MAC_ADDRESS               *MacAddress\r
+  );\r
 \r
 /**\r
   Enables and disables receive filters for multicast address.\r
@@ -183,20 +180,19 @@ EFI_STATUS
   @retval EFI_NOT_STARTED       This MNP child driver instance has not been configured.\r
   @retval EFI_ALREADY_STARTED   The supplied multicast group is already joined.\r
   @retval EFI_NOT_FOUND         The supplied multicast group is not joined.\r
-  @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred.  \r
+  @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred.\r
   @retval EFI_UNSUPPORTED       The requested feature is unsupported in this MNP implementation.\r
   @retval Other                 The requested operation could not be completed.\r
 \r
 **/\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
+  IN EFI_MAC_ADDRESS               *MacAddress  OPTIONAL\r
+  );\r
+\r
 /**\r
   Places asynchronous outgoing data packets into the transmit queue.\r
 \r
@@ -215,12 +211,11 @@ 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
+  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token\r
+  );\r
+\r
 /**\r
   Places an asynchronous receiving request into the receiving queue.\r
 \r
@@ -242,12 +237,11 @@ 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
+  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token\r
+  );\r
+\r
 \r
 /**\r
   Aborts an asynchronous transmit or receive request.\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
+  IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token  OPTIONAL\r
+  );\r
 \r
 /**\r
   Polls for incoming data packets and processes outgoing data packets.\r
@@ -292,11 +285,43 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_MANAGED_NETWORK_POLL) (\r
-  IN EFI_MANAGED_NETWORK_PROTOCOL    *This \r
-  )\r
-;     \r
+(EFIAPI *EFI_MANAGED_NETWORK_POLL)(\r
+  IN EFI_MANAGED_NETWORK_PROTOCOL    *This\r
+  );\r
+\r
+/**  \r
+  @par Protocol Description:\r
+  The MNP is used by network applications (and drivers) to \r
+  perform raw (unformatted) asynchronous network packet I/O.\r
\r
+  @param GetModeData\r
+  Returns the current MNP child driver operational parameters. \r
+  May also support returning underlying Simple Network Protocol (SNP) driver mode data. \r
 \r
+  @param Configure\r
+  Sets and clears operational parameters for an MNP child driver. \r
+\r
+  @param McastIpToMac\r
+  Translates a software (IP) multicast address to a hardware (MAC) multicast address. \r
+  This function may be unsupported in some MNP implementations. \r
+\r
+  @param Groups\r
+  Enables and disables receive filters for multicast addresses. \r
+  This function may be unsupported in some MNP implementations. \r
+\r
+  @param Transmit\r
+  Places asynchronous outgoing data packets into the transmit queue. \r
+\r
+  @param Receive\r
+  Places an asynchronous receiving request into the receiving queue. \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
+**/\r
 struct _EFI_MANAGED_NETWORK_PROTOCOL {\r
   EFI_MANAGED_NETWORK_GET_MODE_DATA       GetModeData;\r
   EFI_MANAGED_NETWORK_CONFIGURE           Configure;\r