Add the detailed descriptions for the structure data member in these protocol.

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

diff --git a/MdePkg/Include/Protocol/ManagedNetwork.h b/MdePkg/Include/Protocol/ManagedNetwork.h
index 8aedc7f90d6ea449c37b0841734a8281a067a8ac..3f2d05ea7c1d75306e83d8dd72a85270d5b7f09b 100644 (file)
--- a/MdePkg/Include/Protocol/ManagedNetwork.h
+++ b/MdePkg/Include/Protocol/ManagedNetwork.h
@@ -31,15 +31,58 @@
 typedef struct _EFI_MANAGED_NETWORK_PROTOCOL EFI_MANAGED_NETWORK_PROTOCOL;\r
 \r
 typedef struct {\r
+  ///\r
+  /// Timeout value for a UEFI one-shot timer event. A packet that has not been removed\r
+  /// from the MNP receive queue will be dropped if its receive timeout expires.\r
+  ///\r
   UINT32     ReceivedQueueTimeoutValue;\r
+  ///\r
+  /// Timeout value for a UEFI one-shot timer event. A packet that has not been removed\r
+  /// from the MNP transmit queue will be dropped if its receive timeout expires.\r
+  ///\r
   UINT32     TransmitQueueTimeoutValue;\r
+  ///\r
+  /// Ethernet type II 16-bit protocol type in host byte order. Valid\r
+  /// values are zero and 1,500 to 65,535.\r
+  ///\r
   UINT16     ProtocolTypeFilter;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to the network\r
+  /// device MAC address. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableUnicastReceive;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to any of the\r
+  /// active multicast groups. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableMulticastReceive;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to the network\r
+  /// device broadcast address. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableBroadcastReceive;\r
+  ///\r
+  /// Set to TRUE to receive packets that are sent to any MAC address.\r
+  /// The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnablePromiscuousReceive;\r
+  ///\r
+  /// Set to TRUE to drop queued packets when the configuration\r
+  /// is changed. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    FlushQueuesOnReset;\r
+  ///\r
+  /// Set to TRUE to timestamp all packets when they are received\r
+  /// by the MNP. Note that timestamps may be unsupported in some\r
+  /// MNP implementations. The startup default value is FALSE.\r
+  ///\r
   BOOLEAN    EnableReceiveTimestamps;\r
+  ///\r
+  /// Set to TRUE to disable background polling in this MNP\r
+  /// instance. Note that background polling may not be supported in\r
+  /// all MNP implementations. The startup default value is FALSE,\r
+  /// unless background polling is not supported.\r
+  ///\r
   BOOLEAN    DisableBackgroundPolling;\r
 } EFI_MANAGED_NETWORK_CONFIG_DATA;\r
 \r
@@ -77,10 +120,26 @@ typedef struct {
 \r
 \r
 typedef struct {\r
+  ///\r
+  /// This Event will be signaled after the Status field is updated\r
+  /// by the MNP. The type of Event must be\r
+  /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r
+  /// Event must be lower than or equal to TPL_CALLBACK.\r
+  ///\r
   EFI_EVENT                             Event;\r
+  ///\r
+  /// The status that is returned to the caller at the end of the operation\r
+  /// to indicate whether this operation completed successfully.\r
+  ///\r
   EFI_STATUS                            Status;\r
   union {\r
+    ///\r
+    /// When this token is used for receiving, RxData is a pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+    ///\r
     EFI_MANAGED_NETWORK_RECEIVE_DATA    *RxData;\r
+    ///\r
+    /// When this token is used for transmitting, TxData is a pointer to the EFI_MANAGED_NETWORK_TRANSMIT_DATA.\r
+    ///\r
     EFI_MANAGED_NETWORK_TRANSMIT_DATA   *TxData;\r
   } Packet;\r
 } EFI_MANAGED_NETWORK_COMPLETION_TOKEN;\r