MdePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  EFI Network Interface Identifier Protocol.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This Protocol is introduced in EFI Specification 1.10.\r
\r
**/\r
\r
#ifndef __EFI_NETWORK_INTERFACE_IDENTIFER_H__\r
#define __EFI_NETWORK_INTERFACE_IDENTIFER_H__\r
\r
//\r
// GUID retired from UEFI Specification 2.1b\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
//\r
// GUID intruduced in UEFI Specification 2.1b\r
//\r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID_31 \\r
  { \\r
    0x1ACED566, 0x76ED, 0x4218, {0xBC, 0x81, 0x76, 0x7F, 0x1F, 0x97, 0x7A, 0x89 } \\r
  }\r
\r
//\r
// Revision defined in UEFI Specification 2.4\r
//\r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00020000\r
\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
///\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
  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
  UINT16    IfNum;      ///< The network interface number that is being identified by this Network\r
                        ///< Interface Identifier Protocol. This field must be less than or\r
                        ///< equal to the (IFcnt | IFcntExt <<8 ) fields in the !PXE structure.\r
\r
};\r
\r
///\r
///*******************************************************\r
/// EFI_NETWORK_INTERFACE_TYPE\r
///*******************************************************\r
///\r
typedef enum {\r
  EfiNetworkInterfaceUndi = 1\r
} EFI_NETWORK_INTERFACE_TYPE;\r
\r
///\r
/// Forward reference for pure ANSI compatability.\r
///\r
typedef struct undiconfig_table  UNDI_CONFIG_TABLE;\r
\r
///\r
/// The format of the configuration table for UNDI\r
///\r
struct undiconfig_table {\r
  UINT32             NumberOfInterfaces;    ///< The number of NIC devices\r
                                            ///< that this UNDI controls.\r
  UINT32             reserved;\r
  UNDI_CONFIG_TABLE  *nextlink;             ///< A pointer to the next UNDI\r
                                            ///< configuration table.\r
  ///\r
  /// The length of this array is given in the NumberOfInterfaces field.\r
  ///\r
  struct {\r
    VOID             *NII_InterfacePointer; ///< Pointer to the NII interface structure.\r
    VOID             *DevicePathPointer;    ///< Pointer to the device path for this NIC.\r
  } NII_entry[1];\r
};\r
\r
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;\r
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;\r
\r
#endif\r