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