MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h

   1 /** @file
   2   EFI Network Interface Identifier Protocol.
   3
   4 Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>
   5 This program and the accompanying materials are licensed and made available under
   6 the terms and conditions of the BSD License that accompanies this distribution.
   7 The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php.
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   @par Revision Reference:
  14   This Protocol is introduced in EFI Specification 1.10.
  15
  16 **/
  17
  18 #ifndef __EFI_NETWORK_INTERFACE_IDENTIFER_H__
  19 #define __EFI_NETWORK_INTERFACE_IDENTIFER_H__
  20
  21
  22 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID \
  23   { \
  24     0xE18541CD, 0xF755, 0x4f73, {0x92, 0x8D, 0x64, 0x3C, 0x8A, 0x79, 0xB2, 0x29 } \
  25   }
  26
  27 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00010000
  28
  29 ///
  30 /// Revision defined in EFI1.1.
  31 ///
  32 #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION
  33
  34 ///
  35 /// Forward reference for pure ANSI compatability.
  36 ///
  37 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
  38
  39 ///
  40 /// Protocol defined in EFI1.1.
  41 ///
  42 typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL   EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;
  43
  44 ///
  45 /// An optional protocol that is used to describe details about the software
  46 /// layer that is used to produce the Simple Network Protocol.
  47 ///
  48 struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
  49   UINT64    Revision;   ///< The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.
  50   UINT64    Id;         ///< The address of the first byte of the identifying structure for this network
  51                         ///< interface. This is only valid when the network interface is started
  52                         ///< (see Start()). When the network interface is not started, this field is set to zero.
  53   UINT64    ImageAddr;  ///< The address of the first byte of the identifying structure for this
  54                         ///< network interface.  This is set to zero if there is no structure.
  55   UINT32    ImageSize;  ///< The size of unrelocated network interface image.
  56   CHAR8     StringId[4];///< A four-character ASCII string that is sent in the class identifier field of
  57                         ///< option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.
  58   UINT8     Type;       ///< Network interface type. This will be set to one of the values
  59                         ///< in EFI_NETWORK_INTERFACE_TYPE.
  60   UINT8     MajorVer;   ///< Major version number.
  61   UINT8     MinorVer;   ///< Minor version number.
  62   BOOLEAN   Ipv6Supported; ///< TRUE if the network interface supports IPv6; otherwise FALSE.
  63   UINT8     IfNum;      ///< The network interface number that is being identified by this Network
  64                         ///< Interface Identifier Protocol. This field must be less than or equal
  65                         ///< to the IFcnt field in the !PXE structure.
  66
  67 };
  68
  69 ///
  70 ///*******************************************************
  71 /// EFI_NETWORK_INTERFACE_TYPE
  72 ///*******************************************************
  73 ///
  74 typedef enum {
  75   EfiNetworkInterfaceUndi = 1
  76 } EFI_NETWORK_INTERFACE_TYPE;
  77
  78 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;
  79 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;
  80
  81 #endif