]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
Grammatical and disclaimer changes (does not follow internal C coding stds.)
[mirror_edk2.git] / MdePkg / Include / Protocol / NetworkInterfaceIdentifier.h
index 64c2f7349e42188be67cb377f5fc8582c0f3e1d5..3e70a0fb366ba01def4eaca18254a06d84e34480 100644 (file)
@@ -1,15 +1,17 @@
 /** @file\r
-  EFI Network Interface Identifier Protocol\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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
+  @par Revision Reference:          \r
+  This Protocol is introduced in EFI Specification 1.10.\r
 \r
 **/\r
 \r
@@ -30,7 +32,7 @@
 #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION\r
 \r
 ///\r
-/// Forward reference for pure ANSI compatability\r
+/// Forward reference for pure ANSI compatability.\r
 ///\r
 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;\r
 \r
@@ -39,70 +41,41 @@ typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE
 /// \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
-  @par Protocol Description:\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
+///\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
+  UINT64    Revision;   ///< The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.\r
+  UINT64    Id;         ///< The 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
+  UINT64    ImageAddr;  ///< The 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
+  UINT32    ImageSize;  ///< The size of unrelocated network interface image.\r
+  CHAR8     StringId[4];///< 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
+  UINT8     Type;       ///< Network interface type. This will be set to one of the values \r
+                        ///< in EFI_NETWORK_INTERFACE_TYPE.\r
+  UINT8     MajorVer;   ///< Major version number.\r
+  UINT8     MinorVer;   ///< Minor version number.\r
+  BOOLEAN   Ipv6Supported; ///< TRUE if the network interface supports IPv6; otherwise FALSE.\r
+  UINT8     IfNum;      ///< 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
-  ///\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
+///\r
+///*******************************************************\r
+/// EFI_NETWORK_INTERFACE_TYPE\r
+///*******************************************************\r
+///\r
+typedef enum {\r
+  EfiNetworkInterfaceUndi = 1\r
+} EFI_NETWORK_INTERFACE_TYPE;\r
+\r
 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;\r
 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;\r
 \r
-#endif // _EFI_NII_H\r
+#endif\r