Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/SimpleNetwork.h b/MdePkg/Include/Protocol/SimpleNetwork.h
index a1a9224704534c357319d759685846b677b49518..74c5163fbb9006940412d33a13e23f62e502c186 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleNetwork.h
+++ b/MdePkg/Include/Protocol/SimpleNetwork.h
@@ -8,7 +8,7 @@
   MCast - MultiCast\r
   ...\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
@@ -565,6 +565,75 @@ EFI_STATUS
 // \r
 #define EFI_SIMPLE_NETWORK_INTERFACE_REVISION   EFI_SIMPLE_NETWORK_PROTOCOL_REVISION\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access \r
+  to a network adapter. Once the network adapter initializes, \r
+  the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that \r
+  allow packets to be transmitted and received.\r
+  \r
+  @param Revision\r
+  Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must \r
+  be backwards compatible. If a future version is not backwards compatible \r
+  it is not the same GUID.\r
+\r
+  @param Start\r
+  Prepares the network interface for further command operations. \r
+  No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate \r
+  until this call is made. \r
+\r
+  @param Stop\r
+  Stops further network interface command processing. \r
+  No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate \r
+  after this call is made until another Start() call is made. \r
+\r
+  @param Initialize\r
+  Resets the network adapter and allocates the transmit and receive buffers. \r
+\r
+  @param Reset\r
+  Resets the network adapter and reinitializes it with the parameters \r
+  provided in the previous call to Initialize(). \r
+\r
+  @param Shutdown\r
+  Resets the network adapter and leaves it in a state safe for another driver \r
+  to initialize. The memory buffers assigned in the Initialize() call are released. \r
+  After this call, only the Initialize() or Stop() calls may be used. \r
+\r
+  @param ReceiveFilters\r
+  Enables and disables the receive filters for the network interface and, \r
+  if supported, manages the filtered multicast \r
+  HW MAC (Hardware Media Access Control) address list. \r
+\r
+  @param StationAddress\r
+  Modifies or resets the current station address, if supported. \r
+\r
+  @param Statistics\r
+  Collects statistics from the network interface and allows the statistics to be reset. \r
+\r
+  @param MCastIpToMac\r
+  Maps a multicast IP address to a multicast HW MAC address. \r
+\r
+  @param NvData\r
+  Reads and writes the contents of the NVRAM devices attached to the network interface. \r
+\r
+  @param GetStatus\r
+  Reads the current interrupt status and the list of recycled transmit \r
+  buffers from the network interface. \r
+\r
+  @param Transmit\r
+  Places a packet in the transmit queue. \r
+\r
+  @param Receive\r
+  Retrieves a packet from the receive queue, along with the status \r
+  flags that describe the packet type. \r
+\r
+  @param WaitForPacket\r
+  Event used with WaitForEvent() to wait for a packet to be received.\r
+\r
+  @param Mode\r
+  Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device. \r
+\r
+**/\r
 struct _EFI_SIMPLE_NETWORK_PROTOCOL {\r
   UINT64                              Revision;\r
   EFI_SIMPLE_NETWORK_START            Start;\r