roms/ipxe/src/include/ipxe/efi/Protocol/NetworkInterfaceIdentifier.h

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