]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/UefiPxeBcDxe/PxeBcImpl.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
NetworkPkg: Refine codes related to Dhcpv4 and Dhcpv6 configuration.
[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcImpl.h
CommitLineData
a3bcde70
HT		 1/** @file\r
2 This EFI_PXE_BASE_CODE_PROTOCOL and EFI_LOAD_FILE_PROTOCOL.\r
3 interfaces declaration.\r
4\r
142c00c3 5 Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
a3bcde70
HT		 6\r
7 This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php.\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16\r
17#ifndef __EFI_PXEBC_IMPL_H__\r
18#define __EFI_PXEBC_IMPL_H__\r
19\r
20#include <Uefi.h>\r
21\r
22#include <Guid/SmBios.h>\r
23#include <IndustryStandard/SmBios.h>\r
142c00c3 24#include <IndustryStandard/Dhcp.h>\r
a3bcde70
HT		 25#include <Protocol/NetworkInterfaceIdentifier.h>\r
26#include <Protocol/Arp.h>\r
27#include <Protocol/Ip4.h>\r
ac99793b 28#include <Protocol/Ip4Config2.h>\r
a3bcde70
HT		 29#include <Protocol/Ip6.h>\r
30#include <Protocol/Ip6Config.h>\r
31#include <Protocol/Udp4.h>\r
32#include <Protocol/Udp6.h>\r
33#include <Protocol/Dhcp4.h>\r
34#include <Protocol/Dhcp6.h>\r
35#include <Protocol/Mtftp4.h>\r
36#include <Protocol/Mtftp6.h>\r
37#include <Protocol/PxeBaseCode.h>\r
38#include <Protocol/LoadFile.h>\r
39#include <Protocol/PxeBaseCodeCallBack.h>\r
40#include <Protocol/ServiceBinding.h>\r
41#include <Protocol/DriverBinding.h>\r
2bbe9553 42#include <Protocol/AdapterInformation.h>\r
a3bcde70
HT		 43\r
44#include <Library/DebugLib.h>\r
45#include <Library/BaseMemoryLib.h>\r
46#include <Library/MemoryAllocationLib.h>\r
47#include <Library/UefiDriverEntryPoint.h>\r
48#include <Library/UefiBootServicesTableLib.h>\r
129b8b09 49#include <Library/UefiRuntimeServicesTableLib.h>\r
a3bcde70
HT		 50#include <Library/UefiLib.h>\r
51#include <Library/BaseLib.h>\r
52#include <Library/NetLib.h>\r
53#include <Library/DpcLib.h>\r
54#include <Library/DevicePathLib.h>\r
55#include <Library/PcdLib.h>\r
56\r
57typedef struct _PXEBC_PRIVATE_DATA PXEBC_PRIVATE_DATA;\r
15f3fc85 58typedef struct _PXEBC_PRIVATE_PROTOCOL PXEBC_PRIVATE_PROTOCOL;\r
a3bcde70
HT		 59typedef struct _PXEBC_VIRTUAL_NIC PXEBC_VIRTUAL_NIC;\r
60\r
61#include "PxeBcDriver.h"\r
62#include "PxeBcDhcp4.h"\r
63#include "PxeBcDhcp6.h"\r
64#include "PxeBcMtftp.h"\r
65#include "PxeBcBoot.h"\r
66#include "PxeBcSupport.h"\r
67\r
68#define PXEBC_DEFAULT_HOPLIMIT 64\r
69#define PXEBC_DEFAULT_LIFETIME 50000 // 50 ms, unit is microsecond\r
70#define PXEBC_UDP_TIMEOUT 30000000 // 3 seconds, unit is 100nanosecond\r
ed2bfecb 71#define PXEBC_DAD_ADDITIONAL_DELAY 30000000 // 3 seconds\r
a3bcde70
HT		 72#define PXEBC_MTFTP_TIMEOUT 4\r
73#define PXEBC_MTFTP_RETRIES 6\r
74#define PXEBC_DHCP_RETRIES 4 // refers to mPxeDhcpTimeout, also by PXE2.1 spec.\r
75#define PXEBC_MENU_MAX_NUM 24\r
76#define PXEBC_OFFER_MAX_NUM 16\r
77\r
78#define PXEBC_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'X', 'E', 'P')\r
79#define PXEBC_VIRTUAL_NIC_SIGNATURE SIGNATURE_32 ('P', 'X', 'E', 'V')\r
80#define PXEBC_PRIVATE_DATA_FROM_PXEBC(a) CR (a, PXEBC_PRIVATE_DATA, PxeBc, PXEBC_PRIVATE_DATA_SIGNATURE)\r
15f3fc85 81#define PXEBC_PRIVATE_DATA_FROM_ID(a) CR (a, PXEBC_PRIVATE_DATA, Id, PXEBC_PRIVATE_DATA_SIGNATURE)\r
a3bcde70
HT		 82#define PXEBC_VIRTUAL_NIC_FROM_LOADFILE(a) CR (a, PXEBC_VIRTUAL_NIC, LoadFile, PXEBC_VIRTUAL_NIC_SIGNATURE)\r
83\r
84typedef union {\r
85 PXEBC_DHCP4_PACKET_CACHE Dhcp4;\r
86 PXEBC_DHCP6_PACKET_CACHE Dhcp6;\r
87} PXEBC_DHCP_PACKET_CACHE;\r
88\r
15f3fc85 89struct _PXEBC_PRIVATE_PROTOCOL {\r
90 UINT64 Reserved;\r
91};\r
92\r
a3bcde70
HT		 93struct _PXEBC_VIRTUAL_NIC {\r
94 UINT32 Signature;\r
95 EFI_HANDLE Controller;\r
96 EFI_LOAD_FILE_PROTOCOL LoadFile;\r
97 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
98 PXEBC_PRIVATE_DATA *Private;\r
99};\r
100\r
101struct _PXEBC_PRIVATE_DATA {\r
102 UINT32 Signature;\r
103 EFI_HANDLE Controller;\r
104 EFI_HANDLE Image;\r
105\r
15f3fc85 106 PXEBC_PRIVATE_PROTOCOL Id;\r
107 EFI_SIMPLE_NETWORK_PROTOCOL *Snp; \r
108\r
a3bcde70
HT		 109 PXEBC_VIRTUAL_NIC *Ip4Nic;\r
110 PXEBC_VIRTUAL_NIC *Ip6Nic;\r
111\r
112 EFI_HANDLE ArpChild;\r
113 EFI_HANDLE Ip4Child;\r
114 EFI_HANDLE Dhcp4Child;\r
115 EFI_HANDLE Mtftp4Child;\r
116 EFI_HANDLE Udp4ReadChild;\r
117 EFI_HANDLE Udp4WriteChild;\r
118\r
119 EFI_ARP_PROTOCOL *Arp;\r
120 EFI_IP4_PROTOCOL *Ip4;\r
ac99793b 121 EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2;\r
a3bcde70
HT		 122 EFI_DHCP4_PROTOCOL *Dhcp4;\r
123 EFI_MTFTP4_PROTOCOL *Mtftp4;\r
124 EFI_UDP4_PROTOCOL *Udp4Read;\r
125 EFI_UDP4_PROTOCOL *Udp4Write;\r
126\r
127 EFI_HANDLE Ip6Child;\r
128 EFI_HANDLE Dhcp6Child;\r
129 EFI_HANDLE Mtftp6Child;\r
130 EFI_HANDLE Udp6ReadChild;\r
131 EFI_HANDLE Udp6WriteChild;\r
132\r
133 EFI_IP6_PROTOCOL *Ip6;\r
134 EFI_IP6_CONFIG_PROTOCOL *Ip6Cfg;\r
135 EFI_DHCP6_PROTOCOL *Dhcp6;\r
136 EFI_MTFTP6_PROTOCOL *Mtftp6;\r
137 EFI_UDP6_PROTOCOL *Udp6Read;\r
138 EFI_UDP6_PROTOCOL *Udp6Write;\r
139\r
140 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii;\r
141 EFI_PXE_BASE_CODE_PROTOCOL PxeBc;\r
142 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL LoadFileCallback;\r
143 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *PxeBcCallback;\r
144 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
145\r
146 EFI_PXE_BASE_CODE_MODE Mode;\r
147 EFI_PXE_BASE_CODE_FUNCTION Function;\r
148 UINT32 Ip6Policy;\r
129b8b09 149 UINT32 SolicitTimes;\r
150 UINT64 ElapsedTime;\r
a3bcde70
HT		 151\r
152 EFI_UDP4_CONFIG_DATA Udp4CfgData;\r
153 EFI_UDP6_CONFIG_DATA Udp6CfgData;\r
154 EFI_IP4_CONFIG_DATA Ip4CfgData;\r
155 EFI_IP6_CONFIG_DATA Ip6CfgData;\r
156\r
157 EFI_EVENT UdpTimeOutEvent;\r
158 EFI_EVENT ArpUpdateEvent;\r
159 EFI_IP4_COMPLETION_TOKEN IcmpToken;\r
160 EFI_IP6_COMPLETION_TOKEN Icmp6Token;\r
161\r
162 BOOLEAN IsAddressOk;\r
163 BOOLEAN IsOfferSorted;\r
164 BOOLEAN IsProxyRecved;\r
165 BOOLEAN IsDoDiscover;\r
166\r
ae97201c 167 EFI_IP_ADDRESS TmpStationIp;\r
a3bcde70
HT		 168 EFI_IP_ADDRESS StationIp;\r
169 EFI_IP_ADDRESS SubnetMask;\r
170 EFI_IP_ADDRESS GatewayIp;\r
171 EFI_IP_ADDRESS ServerIp;\r
172 UINT16 CurSrcPort;\r
75dce340 173 UINT32 IaId;\r
a3bcde70
HT		 174\r
175 UINT32 Ip4MaxPacketSize;\r
176 UINT32 Ip6MaxPacketSize;\r
177 UINT8 *BootFileName;\r
178 UINTN BootFileSize;\r
179 UINTN BlockSize;\r
180\r
181 PXEBC_DHCP_PACKET_CACHE ProxyOffer;\r
182 PXEBC_DHCP_PACKET_CACHE DhcpAck;\r
183 PXEBC_DHCP_PACKET_CACHE PxeReply;\r
184 EFI_DHCP6_PACKET *Dhcp6Request;\r
185 EFI_DHCP4_PACKET SeedPacket;\r
186\r
187 //\r
188 // OfferIndex records the index of DhcpOffer[] buffer, and OfferCount records the num of each type of offer.\r
189 //\r
190 // It supposed that\r
191 //\r
192 // OfferNum: 8\r
193 // OfferBuffer: [ProxyBinl, ProxyBinl, DhcpOnly, ProxyPxe10, DhcpOnly, DhcpPxe10, DhcpBinl, ProxyBinl]\r
194 // (OfferBuffer is 0-based.)\r
195 //\r
196 // And assume that (DhcpPxe10 is the first priority actually.)\r
197 //\r
198 // SelectIndex: 2\r
199 // SelectProxyType: PXEBC_OFFER_TYPE_PROXY_BINL\r
200 // (SelectIndex is 1-based, and 0 means no one is selected.)\r
201 //\r
202 // So it should be\r
203 //\r
204 // DhcpOnly DhcpPxe10 DhcpWfm11a DhcpBinl ProxyPxe10 ProxyWfm11a ProxyBinl Bootp\r
205 // OfferCount: [ 2(n), 1(n), 0(n), 1(n), 1(1), 0(1), 3(n), 1(1)]\r
206 //\r
207 // OfferIndex: {[ 2, 5, 0, 6, 3, 0, *0, 0]\r
208 // [ 4, 0, 0, 0, 0, 0, 1, 0]\r
209 // [ 0, 0, 0, 0, 0, 0, 7, 0]\r
210 // ... ]}\r
211 // (OfferIndex is 0-based.)\r
212 //\r
213 //\r
214 UINT32 SelectIndex;\r
215 UINT32 SelectProxyType;\r
216 PXEBC_DHCP_PACKET_CACHE OfferBuffer[PXEBC_OFFER_MAX_NUM];\r
217 UINT32 OfferNum;\r
218 UINT32 OfferCount[PxeOfferTypeMax];\r
219 UINT32 OfferIndex[PxeOfferTypeMax][PXEBC_OFFER_MAX_NUM];\r
220};\r
221\r
222extern EFI_PXE_BASE_CODE_PROTOCOL gPxeBcProtocolTemplate;\r
223extern EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL gPxeBcCallBackTemplate;\r
224extern EFI_LOAD_FILE_PROTOCOL gLoadFileProtocolTemplate;\r
225\r
226#endif\r
EFI Development Kit II mirror for PVE