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