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 // GUID retired from UEFI Specification 2.1b
  23 //
  24 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID \
  25   { \
  26     0xE18541CD, 0xF755, 0x4f73, {0x92, 0x8D, 0x64, 0x3C, 0x8A, 0x79, 0xB2, 0x29 } \
  27   }
  28
  29 //
  30 // GUID intruduced in UEFI Specification 2.1b
  31 //
  32 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID_31 \
  33   { \
  34     0x1ACED566, 0x76ED, 0x4218, {0xBC, 0x81, 0x76, 0x7F, 0x1F, 0x97, 0x7A, 0x89 } \
  35   }
  36
  37 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00010000
  38
  39 ///
  40 /// Revision defined in EFI1.1.
  41 ///
  42 #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION
  43
  44 ///
  45 /// Forward reference for pure ANSI compatability.
  46 ///
  47 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
  48
  49 ///
  50 /// Protocol defined in EFI1.1.
  51 ///
  52 typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL   EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;
  53
  54 ///
  55 /// An optional protocol that is used to describe details about the software
  56 /// layer that is used to produce the Simple Network Protocol.
  57 ///
  58 struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
  59   UINT64    Revision;   ///< The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.
  60   UINT64    Id;         ///< The address of the first byte of the identifying structure for this network
  61                         ///< interface. This is only valid when the network interface is started
  62                         ///< (see Start()). When the network interface is not started, this field is set to zero.
  63   UINT64    ImageAddr;  ///< The address of the first byte of the identifying structure for this
  64                         ///< network interface.  This is set to zero if there is no structure.
  65   UINT32    ImageSize;  ///< The size of unrelocated network interface image.
  66   CHAR8     StringId[4];///< A four-character ASCII string that is sent in the class identifier field of
  67                         ///< option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.
  68   UINT8     Type;       ///< Network interface type. This will be set to one of the values
  69                         ///< in EFI_NETWORK_INTERFACE_TYPE.
  70   UINT8     MajorVer;   ///< Major version number.
  71   UINT8     MinorVer;   ///< Minor version number.
  72   BOOLEAN   Ipv6Supported; ///< TRUE if the network interface supports IPv6; otherwise FALSE.
  73   UINT8     IfNum;      ///< The network interface number that is being identified by this Network
  74                         ///< Interface Identifier Protocol. This field must be less than or equal
  75                         ///< to the IFcnt field in the !PXE structure.
  76
  77 };
  78
  79 ///
  80 ///*******************************************************
  81 /// EFI_NETWORK_INTERFACE_TYPE
  82 ///*******************************************************
  83 ///
  84 typedef enum {
  85   EfiNetworkInterfaceUndi = 1
  86 } EFI_NETWORK_INTERFACE_TYPE;
  87
  88 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;
  89 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;
  90
  91 #endif