2
EFI Network Interface Identifier Protocol.
4
Copyright (c) 2006 - 2013, 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.
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.
13
@par Revision Reference:
14
This Protocol is introduced in EFI Specification 1.10.
18
#ifndef __EFI_NETWORK_INTERFACE_IDENTIFER_H__
19
#define __EFI_NETWORK_INTERFACE_IDENTIFER_H__
21
FILE_LICENCE ( BSD3 );
24
// GUID retired from UEFI Specification 2.1b
26
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID \
28
0xE18541CD, 0xF755, 0x4f73, {0x92, 0x8D, 0x64, 0x3C, 0x8A, 0x79, 0xB2, 0x29 } \
32
// GUID intruduced in UEFI Specification 2.1b
34
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID_31 \
36
0x1ACED566, 0x76ED, 0x4218, {0xBC, 0x81, 0x76, 0x7F, 0x1F, 0x97, 0x7A, 0x89 } \
40
// Revision defined in UEFI Specification 2.4
42
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION 0x00020000
46
/// Revision defined in EFI1.1.
48
#define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION
51
/// Forward reference for pure ANSI compatability.
53
typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
56
/// Protocol defined in EFI1.1.
58
typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;
61
/// An optional protocol that is used to describe details about the software
62
/// layer that is used to produce the Simple Network Protocol.
64
struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
65
UINT64 Revision; ///< The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.
66
UINT64 Id; ///< The address of the first byte of the identifying structure for this network
67
///< interface. This is only valid when the network interface is started
68
///< (see Start()). When the network interface is not started, this field is set to zero.
69
UINT64 ImageAddr; ///< The address of the first byte of the identifying structure for this
70
///< network interface. This is set to zero if there is no structure.
71
UINT32 ImageSize; ///< The size of unrelocated network interface image.
72
CHAR8 StringId[4];///< A four-character ASCII string that is sent in the class identifier field of
73
///< option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.
74
UINT8 Type; ///< Network interface type. This will be set to one of the values
75
///< in EFI_NETWORK_INTERFACE_TYPE.
76
UINT8 MajorVer; ///< Major version number.
77
UINT8 MinorVer; ///< Minor version number.
78
BOOLEAN Ipv6Supported; ///< TRUE if the network interface supports IPv6; otherwise FALSE.
79
UINT16 IfNum; ///< The network interface number that is being identified by this Network
80
///< Interface Identifier Protocol. This field must be less than or
81
///< equal to the (IFcnt | IFcntExt <<8 ) fields in the !PXE structure.
86
///*******************************************************
87
/// EFI_NETWORK_INTERFACE_TYPE
88
///*******************************************************
91
EfiNetworkInterfaceUndi = 1
92
} EFI_NETWORK_INTERFACE_TYPE;
95
/// Forward reference for pure ANSI compatability.
97
typedef struct undiconfig_table UNDI_CONFIG_TABLE;
100
/// The format of the configuration table for UNDI
102
struct undiconfig_table {
103
UINT32 NumberOfInterfaces; ///< The number of NIC devices
104
///< that this UNDI controls.
106
UNDI_CONFIG_TABLE *nextlink; ///< A pointer to the next UNDI
107
///< configuration table.
109
/// The length of this array is given in the NumberOfInterfaces field.
112
VOID *NII_InterfacePointer; ///< Pointer to the NII interface structure.
113
VOID *DevicePathPointer; ///< Pointer to the device path for this NIC.
117
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;
118
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;