Formalize comments for Protocols and PPIs.

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

/** @file\r
  EFI Network Interface Identifier Protocol\r
\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
\r
**/\r
\r
#ifndef __EFI_NETWORK_INTERFACE_IDENTIFER_H__\r
#define __EFI_NETWORK_INTERFACE_IDENTIFER_H__\r
\r
\r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID \\r
  { \\r
    0xE18541CD, 0xF755, 0x4f73, {0x92, 0x8D, 0x64, 0x3C, 0x8A, 0x79, 0xB2, 0x29 } \\r
  }\r
\r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00010000\r
\r
///\r
/// Revision defined in EFI1.1.\r
/// \r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION\r
\r
///\r
/// Forward reference for pure ANSI compatability\r
///\r
typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;\r
\r
///\r
/// Protocol defined in EFI1.1.\r
/// \r
typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL   EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;\r
\r
typedef enum {\r
  EfiNetworkInterfaceUndi = 1\r
} EFI_NETWORK_PROTOCOL_TYPE;\r
\r
///\r
/// An optional protocol that is used to describe details about the software \r
/// layer that is used to produce the Simple Network Protocol. \r
///\r
struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {\r
  ///\r
  /// The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.\r
  ///\r
  UINT64  Revision;\r
  \r
  ///\r
  /// Address of the first byte of the identifying structure for this network \r
  /// interface. This is only valid when the network interface is started \r
  /// (see Start()). When the network interface is not started, this field is set to zero.\r
  ///\r
  UINT64  ID;\r
  \r
  ///\r
  /// Address of the first byte of the identifying structure for this\r
  /// network interface.  This is set to zero if there is no structure.\r
  ///\r
  /// For PXE/UNDI this is the first byte of the !PXE structure.\r
  ///\r
  UINT64  ImageAddr;\r
  \r
  ///\r
  /// Size of unrelocated network interface image.\r
  ///\r
  UINT32  ImageSize;\r
  \r
  ///\r
  /// A four-character ASCII string that is sent in the class identifier field of\r
  /// option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.\r
  ///\r
  CHAR8   StringId[4];\r
  \r
  ///\r
  /// Network interface type. This will be set to one of the values \r
  /// in EFI_NETWORK_INTERFACE_TYPE.\r
  ///\r
  UINT8   Type;\r
  \r
  UINT8   MajorVer;     ///< Major version number.\r
  UINT8   MinorVer;     ///< Minor version number.\r
  \r
  ///\r
  /// TRUE if the network interface supports IPv6; otherwise FALSE.\\r
  ///\r
  BOOLEAN Ipv6Supported;\r
\r
  ///\r
  /// The network interface number that is being identified by this Network \r
  /// Interface Identifier Protocol. This field must be less than or equal \r
  /// to the IFcnt field in the !PXE structure.\r
  ///\r
  UINT8   IfNum;\r
};\r
\r
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;\r
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;\r
\r
#endif // _EFI_NII_H\r