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