VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/NetworkPkg/UefiPxeBcDxe/PxeBcImpl.h@ 77664

Last change on this file since 77664 was 58466, checked in by vboxsync, 9 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette