NetworkPkg: Add warning message for PXE if failed to read system GUID from SMBIOS.
[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcImpl.c
CommitLineData
a3bcde70
HT
1/** @file\r
2 This implementation of EFI_PXE_BASE_CODE_PROTOCOL and EFI_LOAD_FILE_PROTOCOL.\r
3\r
bee14e9e 4 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
a3bcde70
HT
5\r
6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php.\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "PxeBcImpl.h"\r
17\r
18\r
19/**\r
20 Enables the use of the PXE Base Code Protocol functions.\r
21\r
22 This function enables the use of the PXE Base Code Protocol functions. If the\r
23 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then\r
24 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted\r
25 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted\r
26 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported\r
27 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will\r
28 be returned. If there is not enough memory or other resources to start the PXE\r
29 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the\r
30 PXE Base Code Protocol will be started.\r
31\r
32 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
33 @param[in] UseIpv6 Specifies the type of IP addresses that are to be\r
34 used during the session that is being started.\r
35 Set to TRUE for IPv6, and FALSE for IPv4.\r
36\r
37 @retval EFI_SUCCESS The PXE Base Code Protocol was started.\r
38 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
39 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the\r
40 EFI_PXE_BASE_CODE_MODE structure is FALSE.\r
41 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.\r
42 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
43 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
44 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the\r
45 PXE Base Code Protocol.\r
46\r
47**/\r
48EFI_STATUS\r
49EFIAPI\r
50EfiPxeBcStart (\r
51 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
52 IN BOOLEAN UseIpv6\r
53 )\r
54{\r
55 PXEBC_PRIVATE_DATA *Private;\r
56 EFI_PXE_BASE_CODE_MODE *Mode;\r
57 UINTN Index;\r
58 EFI_STATUS Status;\r
59\r
60 if (This == NULL) {\r
61 return EFI_INVALID_PARAMETER;\r
62 }\r
63\r
64 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
65 Mode = Private->PxeBc.Mode;\r
66\r
67 if (Mode->Started) {\r
68 return EFI_ALREADY_STARTED;\r
69 }\r
70\r
71 //\r
72 // Detect whether using IPv6 or not, and set it into mode data.\r
73 //\r
74 if (UseIpv6 && Mode->Ipv6Available && Mode->Ipv6Supported && Private->Ip6Nic != NULL) {\r
75 Mode->UsingIpv6 = TRUE;\r
76 } else if (!UseIpv6 && Private->Ip4Nic != NULL) {\r
77 Mode->UsingIpv6 = FALSE;\r
78 } else {\r
79 return EFI_UNSUPPORTED;\r
80 }\r
81\r
82 if (Mode->UsingIpv6) {\r
83 AsciiPrint ("\n>>Start PXE over IPv6");\r
ce280355 84 //\r
85 // Configure udp6 instance to receive data.\r
86 //\r
87 Status = Private->Udp6Read->Configure (\r
88 Private->Udp6Read,\r
89 &Private->Udp6CfgData\r
90 );\r
91 if (EFI_ERROR (Status)) {\r
92 goto ON_ERROR;\r
93 }\r
94 \r
a3bcde70
HT
95 //\r
96 // Configure block size for TFTP as a default value to handle all link layers.\r
97 //\r
ce5c3273
HW
98 Private->BlockSize = Private->Ip6MaxPacketSize -\r
99 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE;\r
a3bcde70
HT
100\r
101 //\r
102 // PXE over IPv6 starts here, initialize the fields and list header.\r
103 //\r
104 Private->Ip6Policy = PXEBC_IP6_POLICY_MAX;\r
632dcfd6
FS
105 Private->ProxyOffer.Dhcp6.Packet.Offer.Size = PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE;\r
106 Private->DhcpAck.Dhcp6.Packet.Ack.Size = PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE;\r
107 Private->PxeReply.Dhcp6.Packet.Ack.Size = PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE;\r
a3bcde70
HT
108\r
109 for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {\r
632dcfd6 110 Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE;\r
a3bcde70
HT
111 }\r
112\r
113 //\r
114 // Create event and set status for token to capture ICMP6 error message.\r
115 //\r
116 Private->Icmp6Token.Status = EFI_NOT_READY;\r
117 Status = gBS->CreateEvent (\r
118 EVT_NOTIFY_SIGNAL,\r
119 TPL_NOTIFY,\r
120 PxeBcIcmp6ErrorUpdate,\r
121 Private,\r
122 &Private->Icmp6Token.Event\r
123 );\r
124 if (EFI_ERROR (Status)) {\r
125 goto ON_ERROR;\r
126 }\r
ae97201c
FS
127\r
128 //\r
129 // Set Ip6 policy to Automatic to start the IP6 router discovery.\r
130 //\r
131 Status = PxeBcSetIp6Policy (Private);\r
132 if (EFI_ERROR (Status)) {\r
133 goto ON_ERROR;\r
134 }\r
a3bcde70
HT
135 } else {\r
136 AsciiPrint ("\n>>Start PXE over IPv4");\r
ce280355 137 //\r
138 // Configure udp4 instance to receive data.\r
139 //\r
140 Status = Private->Udp4Read->Configure (\r
141 Private->Udp4Read,\r
142 &Private->Udp4CfgData\r
143 );\r
144 if (EFI_ERROR (Status)) {\r
145 goto ON_ERROR;\r
146 }\r
147 \r
a3bcde70
HT
148 //\r
149 // Configure block size for TFTP as a default value to handle all link layers.\r
150 //\r
ce5c3273
HW
151 Private->BlockSize = Private->Ip4MaxPacketSize -\r
152 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE;\r
a3bcde70
HT
153\r
154 //\r
155 // PXE over IPv4 starts here, initialize the fields.\r
156 //\r
632dcfd6
FS
157 Private->ProxyOffer.Dhcp4.Packet.Offer.Size = PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE;\r
158 Private->DhcpAck.Dhcp4.Packet.Ack.Size = PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE;\r
159 Private->PxeReply.Dhcp4.Packet.Ack.Size = PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE;\r
a3bcde70
HT
160\r
161 for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {\r
632dcfd6 162 Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE;\r
a3bcde70
HT
163 }\r
164\r
165 PxeBcSeedDhcp4Packet (&Private->SeedPacket, Private->Udp4Read);\r
166\r
167 //\r
168 // Create the event for Arp cache update.\r
169 //\r
170 Status = gBS->CreateEvent (\r
171 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
172 TPL_CALLBACK,\r
173 PxeBcArpCacheUpdate,\r
174 Private,\r
175 &Private->ArpUpdateEvent\r
176 );\r
177 if (EFI_ERROR (Status)) {\r
178 goto ON_ERROR;\r
179 }\r
180\r
181 //\r
182 // Start a periodic timer by second to update Arp cache.\r
183 //\r
184 Status = gBS->SetTimer (\r
185 Private->ArpUpdateEvent,\r
186 TimerPeriodic,\r
187 TICKS_PER_SECOND\r
188 );\r
189 if (EFI_ERROR (Status)) {\r
190 goto ON_ERROR;\r
191 }\r
192\r
193 //\r
194 // Create event and set status for token to capture ICMP error message.\r
195 //\r
196 Private->Icmp6Token.Status = EFI_NOT_READY;\r
197 Status = gBS->CreateEvent (\r
198 EVT_NOTIFY_SIGNAL,\r
199 TPL_NOTIFY,\r
200 PxeBcIcmpErrorUpdate,\r
201 Private,\r
202 &Private->IcmpToken.Event\r
203 );\r
204 if (EFI_ERROR (Status)) {\r
205 goto ON_ERROR;\r
206 }\r
ac99793b
ZL
207\r
208 //\r
209 //DHCP4 service allows only one of its children to be configured in \r
210 //the active state, If the DHCP4 D.O.R.A started by IP4 auto \r
211 //configuration and has not been completed, the Dhcp4 state machine \r
212 //will not be in the right state for the PXE to start a new round D.O.R.A. \r
213 //so we need to switch it's policy to static.\r
214 //\r
215 Status = PxeBcSetIp4Policy (Private);\r
216 if (EFI_ERROR (Status)) {\r
217 goto ON_ERROR;\r
218 }\r
a3bcde70
HT
219 }\r
220\r
221 //\r
222 // If PcdTftpBlockSize is set to non-zero, override the default value.\r
223 //\r
224 if (PcdGet64 (PcdTftpBlockSize) != 0) {\r
225 Private->BlockSize = (UINTN) PcdGet64 (PcdTftpBlockSize);\r
226 }\r
227\r
228 //\r
229 // Create event for UdpRead/UdpWrite timeout since they are both blocking API.\r
230 //\r
231 Status = gBS->CreateEvent (\r
232 EVT_TIMER,\r
233 TPL_CALLBACK,\r
234 NULL,\r
235 NULL,\r
236 &Private->UdpTimeOutEvent\r
237 );\r
238 if (EFI_ERROR (Status)) {\r
239 goto ON_ERROR;\r
240 }\r
241\r
242 Private->IsAddressOk = FALSE;\r
243 Mode->Started = TRUE;\r
244\r
245 return EFI_SUCCESS;\r
246\r
247ON_ERROR:\r
248 if (Mode->UsingIpv6) {\r
249 if (Private->Icmp6Token.Event != NULL) {\r
250 gBS->CloseEvent (Private->Icmp6Token.Event);\r
251 Private->Icmp6Token.Event = NULL;\r
252 }\r
253 Private->Udp6Read->Configure (Private->Udp6Read, NULL);\r
254 Private->Ip6->Configure (Private->Ip6, NULL);\r
255 } else {\r
256 if (Private->ArpUpdateEvent != NULL) {\r
257 gBS->CloseEvent (Private->ArpUpdateEvent);\r
258 Private->ArpUpdateEvent = NULL;\r
259 }\r
260 if (Private->IcmpToken.Event != NULL) {\r
261 gBS->CloseEvent (Private->IcmpToken.Event);\r
262 Private->IcmpToken.Event = NULL;\r
263 }\r
264 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
265 Private->Ip4->Configure (Private->Ip4, NULL);\r
266 }\r
267 return Status;\r
268}\r
269\r
270\r
271/**\r
272 Disable the use of the PXE Base Code Protocol functions.\r
273\r
274 This function stops all activity on the network device. All the resources allocated\r
275 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is\r
276 set to FALSE, and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE\r
277 structure is already FALSE, then EFI_NOT_STARTED will be returned.\r
278\r
279 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
280\r
281 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r
282 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.\r
283 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
284 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
285 @retval Others\r
286\r
287**/\r
288EFI_STATUS\r
289EFIAPI\r
290EfiPxeBcStop (\r
291 IN EFI_PXE_BASE_CODE_PROTOCOL *This\r
292 )\r
293{\r
294 PXEBC_PRIVATE_DATA *Private;\r
295 EFI_PXE_BASE_CODE_MODE *Mode;\r
296 BOOLEAN Ipv6Supported;\r
297 BOOLEAN Ipv6Available;\r
298\r
299 if (This == NULL) {\r
300 return EFI_INVALID_PARAMETER;\r
301 }\r
302\r
303 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
304 Mode = Private->PxeBc.Mode;\r
305 Ipv6Supported = Mode->Ipv6Supported;\r
306 Ipv6Available = Mode->Ipv6Available;\r
307\r
308 if (!Mode->Started) {\r
309 return EFI_NOT_STARTED;\r
310 }\r
311\r
312 if (Mode->UsingIpv6) {\r
313 //\r
314 // Configure all the instances for IPv6 as NULL.\r
315 //\r
316 ZeroMem (&Private->Udp6CfgData.StationAddress, sizeof (EFI_IPv6_ADDRESS));\r
317 ZeroMem (&Private->Ip6CfgData.StationAddress, sizeof (EFI_IPv6_ADDRESS));\r
318 Private->Dhcp6->Stop (Private->Dhcp6);\r
319 Private->Dhcp6->Configure (Private->Dhcp6, NULL);\r
320 Private->Udp6Write->Configure (Private->Udp6Write, NULL);\r
321 Private->Udp6Read->Groups (Private->Udp6Read, FALSE, NULL);\r
322 Private->Udp6Read->Configure (Private->Udp6Read, NULL);\r
323 Private->Ip6->Cancel (Private->Ip6, &Private->Icmp6Token);\r
324 Private->Ip6->Configure (Private->Ip6, NULL);\r
325 PxeBcUnregisterIp6Address (Private);\r
326 if (Private->Icmp6Token.Event != NULL) {\r
327 gBS->CloseEvent (Private->Icmp6Token.Event);\r
328 Private->Icmp6Token.Event = NULL;\r
329 }\r
330 if (Private->Dhcp6Request != NULL) {\r
331 FreePool (Private->Dhcp6Request);\r
332 Private->Dhcp6Request = NULL;\r
333 }\r
334 if (Private->BootFileName != NULL) {\r
335 FreePool (Private->BootFileName);\r
336 Private->BootFileName = NULL;\r
337 }\r
338 } else {\r
339 //\r
340 // Configure all the instances for IPv4 as NULL.\r
341 //\r
342 ZeroMem (&Private->Udp4CfgData.StationAddress, sizeof (EFI_IPv4_ADDRESS));\r
343 ZeroMem (&Private->Udp4CfgData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
344 ZeroMem (&Private->Ip4CfgData.StationAddress, sizeof (EFI_IPv4_ADDRESS));\r
345 ZeroMem (&Private->Ip4CfgData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
346 Private->Dhcp4->Stop (Private->Dhcp4);\r
347 Private->Dhcp4->Configure (Private->Dhcp4, NULL);\r
348 Private->Udp4Write->Configure (Private->Udp4Write, NULL);\r
349 Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);\r
350 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
351 Private->Ip4->Cancel (Private->Ip4, &Private->IcmpToken);\r
352 Private->Ip4->Configure (Private->Ip4, NULL);\r
353 if (Private->ArpUpdateEvent != NULL) {\r
354 gBS->CloseEvent (Private->ArpUpdateEvent);\r
355 Private->ArpUpdateEvent = NULL;\r
356 }\r
357 if (Private->IcmpToken.Event != NULL) {\r
358 gBS->CloseEvent (Private->IcmpToken.Event);\r
359 Private->IcmpToken.Event = NULL;\r
360 }\r
e29fc502 361 Private->BootFileName = NULL;\r
a3bcde70
HT
362 }\r
363\r
364 gBS->CloseEvent (Private->UdpTimeOutEvent);\r
365 Private->CurSrcPort = 0;\r
366 Private->BootFileSize = 0;\r
129b8b09 367 Private->SolicitTimes = 0;\r
368 Private->ElapsedTime = 0;\r
620f846f
FS
369 ZeroMem (&Private->StationIp, sizeof (EFI_IP_ADDRESS));\r
370 ZeroMem (&Private->SubnetMask, sizeof (EFI_IP_ADDRESS));\r
371 ZeroMem (&Private->GatewayIp, sizeof (EFI_IP_ADDRESS));\r
372 ZeroMem (&Private->ServerIp, sizeof (EFI_IP_ADDRESS));\r
a3bcde70
HT
373\r
374 //\r
375 // Reset the mode data.\r
376 //\r
377 ZeroMem (Mode, sizeof (EFI_PXE_BASE_CODE_MODE));\r
378 Mode->Ipv6Available = Ipv6Available;\r
379 Mode->Ipv6Supported = Ipv6Supported;\r
380 Mode->AutoArp = TRUE;\r
381 Mode->TTL = DEFAULT_TTL;\r
382 Mode->ToS = DEFAULT_ToS;\r
383\r
384 return EFI_SUCCESS;\r
385}\r
386\r
387\r
388/**\r
389 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6\r
390 S.A.R.R (solicit / advertise / request / reply) sequence.\r
391\r
392 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before\r
393 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will\r
394 be tried in the order in which they are received. Please see the Preboot Execution\r
395 Environment (PXE) Specification and Unified Extensible Firmware Interface (UEFI)\r
396 Specification for additional details on the implementation of DHCP.\r
397 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
398 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.\r
399\r
400 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
401 @param[in] SortOffers TRUE if the offers received should be sorted. Set to FALSE to\r
402 try the offers in the order that they are received.\r
403\r
404 @retval EFI_SUCCESS Valid DHCP has completed.\r
405 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
406 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
407 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
408 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
409 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.\r
410 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.\r
411 @retval EFI_TIMEOUT The DHCP Protocol timed out.\r
412 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.\r
413 @retval EFI_NO_RESPONSE Valid PXE offer was not received.\r
414\r
415**/\r
416EFI_STATUS\r
417EFIAPI\r
418EfiPxeBcDhcp (\r
419 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
420 IN BOOLEAN SortOffers\r
421 )\r
422{\r
423 PXEBC_PRIVATE_DATA *Private;\r
424 EFI_PXE_BASE_CODE_MODE *Mode;\r
425 EFI_STATUS Status;\r
426 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
427\r
428 if (This == NULL) {\r
429 return EFI_INVALID_PARAMETER;\r
430 }\r
431\r
432 Status = EFI_SUCCESS;\r
433 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
434 Mode = Private->PxeBc.Mode;\r
435 Mode->IcmpErrorReceived = FALSE;\r
436 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;\r
437 Private->IsOfferSorted = SortOffers;\r
4496ff75 438 Private->SolicitTimes = 0;\r
439 Private->ElapsedTime = 0;\r
a3bcde70
HT
440\r
441 if (!Mode->Started) {\r
442 return EFI_NOT_STARTED;\r
443 }\r
444\r
445 if (Mode->UsingIpv6) {\r
446\r
447 //\r
448 // Stop Udp6Read instance\r
449 //\r
450 Private->Udp6Read->Configure (Private->Udp6Read, NULL);\r
451\r
452 //\r
453 // Start S.A.R.R. process to get a IPv6 address and other boot information.\r
454 //\r
455 Status = PxeBcDhcp6Sarr (Private, Private->Dhcp6);\r
456 } else {\r
457\r
458 //\r
459 // Stop Udp4Read instance\r
460 //\r
461 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
462\r
463 //\r
464 // Start D.O.R.A. process to get a IPv4 address and other boot information.\r
465 //\r
466 Status = PxeBcDhcp4Dora (Private, Private->Dhcp4);\r
467 }\r
1ac9cb8a 468\r
469 //\r
470 // Reconfigure the UDP instance with the default configuration.\r
471 //\r
357af285 472 if (Mode->UsingIpv6) {\r
473 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);\r
474 } else {\r
475 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
476 }\r
a3bcde70
HT
477 //\r
478 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP\r
479 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
480 //\r
481 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
482 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
483 This->SetIpFilter (This, &IpFilter);\r
484\r
485 return Status;\r
486}\r
487\r
488\r
489/**\r
490 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.\r
491\r
492 This function attempts to complete the PXE Boot Server and/or boot image discovery\r
493 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the\r
494 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the\r
495 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the\r
496 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure\r
497 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.\r
498 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],\r
499 has two uses: It is the Boot Server IP address list used for unicast discovery\r
500 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification\r
501 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure\r
502 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot\r
503 Server reply of that type will be accepted. If the AcceptAnyResponse field is\r
504 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.\r
505 This function can take at least 10 seconds to timeout and return control to the\r
506 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be\r
507 returned. Please see the Preboot Execution Environment (PXE) Specification for\r
508 additional details on the implementation of the Discovery sequence.\r
509 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
510 then the Discovery sequence is stopped and EFI_ABORTED will be returned.\r
511\r
512 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
513 @param[in] Type The type of bootstrap to perform.\r
514 @param[in] Layer Pointer to the boot server layer number to discover, which must be\r
515 PXE_BOOT_LAYER_INITIAL when a new server type is being\r
516 discovered.\r
517 @param[in] UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.\r
518 @param[in] Info Pointer to a data structure that contains additional information\r
519 on the type of discovery operation that is to be performed.\r
520 It is optional.\r
521\r
522 @retval EFI_SUCCESS The Discovery sequence has been completed.\r
523 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
524 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
525 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
526 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.\r
527 @retval EFI_ABORTED The callback function aborted the Discovery sequence.\r
528 @retval EFI_TIMEOUT The Discovery sequence timed out.\r
529 @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery\r
530 session.\r
531\r
532**/\r
533EFI_STATUS\r
534EFIAPI\r
535EfiPxeBcDiscover (\r
536 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
537 IN UINT16 Type,\r
538 IN UINT16 *Layer,\r
539 IN BOOLEAN UseBis,\r
540 IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL\r
541 )\r
542{\r
543 PXEBC_PRIVATE_DATA *Private;\r
544 EFI_PXE_BASE_CODE_MODE *Mode;\r
545 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo;\r
546 EFI_PXE_BASE_CODE_SRVLIST *SrvList;\r
547 PXEBC_BOOT_SVR_ENTRY *BootSvrEntry;\r
548 UINT16 Index;\r
549 EFI_STATUS Status;\r
550 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
9063c328 551 EFI_PXE_BASE_CODE_DISCOVER_INFO *NewCreatedInfo;\r
a3bcde70
HT
552\r
553 if (This == NULL) {\r
554 return EFI_INVALID_PARAMETER;\r
555 }\r
556\r
557 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
558 Mode = Private->PxeBc.Mode;\r
559 Mode->IcmpErrorReceived = FALSE;\r
560 BootSvrEntry = NULL;\r
561 SrvList = NULL;\r
562 Status = EFI_DEVICE_ERROR;\r
563 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;\r
9063c328 564 NewCreatedInfo = NULL;\r
a3bcde70
HT
565\r
566 if (!Mode->Started) {\r
567 return EFI_NOT_STARTED;\r
568 }\r
569\r
570 //\r
571 // Station address should be ready before do discover.\r
572 //\r
573 if (!Private->IsAddressOk) {\r
574 return EFI_INVALID_PARAMETER;\r
575 }\r
576\r
577 if (Mode->UsingIpv6) {\r
578\r
579 //\r
580 // Stop Udp6Read instance\r
581 //\r
582 Private->Udp6Read->Configure (Private->Udp6Read, NULL);\r
583 } else {\r
584\r
585 //\r
586 // Stop Udp4Read instance\r
587 //\r
588 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
589 }\r
590\r
591 //\r
592 // There are 3 methods to get the information for discover.\r
593 //\r
f402291b 594 ZeroMem (&DefaultInfo, sizeof (EFI_PXE_BASE_CODE_DISCOVER_INFO));\r
a3bcde70
HT
595 if (*Layer != EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL) {\r
596 //\r
597 // 1. Take the previous setting as the discover info.\r
598 //\r
599 if (!Mode->PxeDiscoverValid ||\r
600 !Mode->PxeReplyReceived ||\r
601 (!Mode->PxeBisReplyReceived && UseBis)) {\r
602 Status = EFI_INVALID_PARAMETER;\r
603 goto ON_EXIT;\r
604 }\r
605\r
606 Info = &DefaultInfo;\r
607 Info->IpCnt = 1;\r
608 Info->UseUCast = TRUE;\r
609 SrvList = Info->SrvList;\r
610 SrvList[0].Type = Type;\r
611 SrvList[0].AcceptAnyResponse = FALSE;\r
612\r
613 CopyMem (&SrvList->IpAddr, &Private->ServerIp, sizeof (EFI_IP_ADDRESS));\r
614\r
615 } else if (Info == NULL) {\r
616 //\r
617 // 2. Extract the discover information from the cached packets if unspecified.\r
618 //\r
9063c328 619 NewCreatedInfo = &DefaultInfo;\r
620 Status = PxeBcExtractDiscoverInfo (Private, Type, &NewCreatedInfo, &BootSvrEntry, &SrvList);\r
a3bcde70
HT
621 if (EFI_ERROR (Status)) {\r
622 goto ON_EXIT;\r
623 }\r
393a3169 624 ASSERT (NewCreatedInfo != NULL);\r
9063c328 625 Info = NewCreatedInfo;\r
a3bcde70
HT
626 } else {\r
627 //\r
628 // 3. Take the pass-in information as the discover info, and validate the server list.\r
629 //\r
630 SrvList = Info->SrvList;\r
631\r
632 if (!SrvList[0].AcceptAnyResponse) {\r
633 for (Index = 1; Index < Info->IpCnt; Index++) {\r
634 if (SrvList[Index].AcceptAnyResponse) {\r
635 break;\r
636 }\r
637 }\r
638 if (Index != Info->IpCnt) {\r
639 //\r
640 // It's invalid if the first server doesn't accecpt any response\r
928927dd 641 // but any of the other servers does accept any response.\r
a3bcde70
HT
642 //\r
643 Status = EFI_INVALID_PARAMETER;\r
644 goto ON_EXIT;\r
645 }\r
646 }\r
647 }\r
648\r
649 //\r
650 // Info and BootSvrEntry/SrvList are all ready by now, so execute discover by UniCast/BroadCast/MultiCast.\r
651 //\r
652 if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) ||\r
653 (Info->MustUseList && Info->IpCnt == 0)) {\r
654 Status = EFI_INVALID_PARAMETER;\r
655 goto ON_EXIT;\r
656 }\r
657\r
658 Private->IsDoDiscover = TRUE;\r
659\r
9063c328 660 if (Info->UseMCast) {\r
a3bcde70
HT
661 //\r
662 // Do discover by multicast.\r
663 //\r
664 Status = PxeBcDiscoverBootServer (\r
665 Private,\r
666 Type,\r
667 Layer,\r
668 UseBis,\r
669 &Info->ServerMCastIp,\r
9063c328 670 Info->IpCnt,\r
671 SrvList\r
a3bcde70
HT
672 );\r
673\r
674 } else if (Info->UseBCast) {\r
675 //\r
676 // Do discover by broadcast, but only valid for IPv4.\r
677 //\r
678 ASSERT (!Mode->UsingIpv6);\r
679 Status = PxeBcDiscoverBootServer (\r
680 Private,\r
681 Type,\r
682 Layer,\r
683 UseBis,\r
684 NULL,\r
685 Info->IpCnt,\r
686 SrvList\r
687 );\r
9063c328 688\r
689 } else if (Info->UseUCast) {\r
690 //\r
691 // Do discover by unicast.\r
692 //\r
693 for (Index = 0; Index < Info->IpCnt; Index++) {\r
694 if (BootSvrEntry == NULL) {\r
695 CopyMem (&Private->ServerIp, &SrvList[Index].IpAddr, sizeof (EFI_IP_ADDRESS));\r
696 } else {\r
697 ASSERT (!Mode->UsingIpv6);\r
698 ZeroMem (&Private->ServerIp, sizeof (EFI_IP_ADDRESS));\r
699 CopyMem (&Private->ServerIp, &BootSvrEntry->IpAddr[Index], sizeof (EFI_IPv4_ADDRESS));\r
700 }\r
701\r
702 Status = PxeBcDiscoverBootServer (\r
703 Private,\r
704 Type,\r
705 Layer,\r
706 UseBis,\r
707 &Private->ServerIp,\r
708 Info->IpCnt,\r
709 SrvList\r
710 );\r
711 }\r
a3bcde70
HT
712 }\r
713\r
1ac9cb8a 714 if (!EFI_ERROR (Status)) {\r
a3bcde70
HT
715 //\r
716 // Parse the cached PXE reply packet, and store it into mode data if valid.\r
717 //\r
718 if (Mode->UsingIpv6) {\r
719 Status = PxeBcParseDhcp6Packet (&Private->PxeReply.Dhcp6);\r
720 if (!EFI_ERROR (Status)) {\r
721 CopyMem (\r
722 &Mode->PxeReply.Dhcpv6,\r
9063c328 723 &Private->PxeReply.Dhcp6.Packet.Ack.Dhcp6,\r
724 Private->PxeReply.Dhcp6.Packet.Ack.Length\r
a3bcde70
HT
725 );\r
726 Mode->PxeReplyReceived = TRUE;\r
727 Mode->PxeDiscoverValid = TRUE;\r
728 }\r
729 } else {\r
730 Status = PxeBcParseDhcp4Packet (&Private->PxeReply.Dhcp4);\r
731 if (!EFI_ERROR (Status)) {\r
732 CopyMem (\r
733 &Mode->PxeReply.Dhcpv4,\r
9063c328 734 &Private->PxeReply.Dhcp4.Packet.Ack.Dhcp4,\r
735 Private->PxeReply.Dhcp4.Packet.Ack.Length\r
a3bcde70
HT
736 );\r
737 Mode->PxeReplyReceived = TRUE;\r
738 Mode->PxeDiscoverValid = TRUE;\r
739 }\r
740 }\r
741 }\r
742\r
743ON_EXIT:\r
744\r
9063c328 745 if (NewCreatedInfo != NULL && NewCreatedInfo != &DefaultInfo) {\r
746 FreePool (NewCreatedInfo);\r
747 }\r
748 \r
18127352 749 if (Mode->UsingIpv6) {\r
357af285 750 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);\r
18127352 751 } else {\r
357af285 752 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
18127352 753 }\r
754 \r
a3bcde70
HT
755 //\r
756 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP\r
757 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
758 //\r
759 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
760 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
761 This->SetIpFilter (This, &IpFilter);\r
762\r
763 return Status;\r
764}\r
765\r
766\r
767/**\r
768 Used to perform TFTP and MTFTP services.\r
769\r
770 This function is used to perform TFTP and MTFTP services. This includes the\r
771 TFTP operations to get the size of a file, read a directory, read a file, and\r
772 write a file. It also includes the MTFTP operations to get the size of a file,\r
773 read a directory, and read a file. The type of operation is specified by Operation.\r
774 If the callback function that is invoked during the TFTP/MTFTP operation does\r
775 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will\r
776 be returned.\r
777 For read operations, the return data will be placed in the buffer specified by\r
778 BufferPtr. If BufferSize is too small to contain the entire downloaded file,\r
779 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero,\r
780 or the size of the requested file. (NOTE: the size of the requested file is only returned\r
781 if the TFTP server supports TFTP options). If BufferSize is large enough for the\r
782 read operation, then BufferSize will be set to the size of the downloaded file,\r
783 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services\r
784 should use the get-file-size operations to determine the size of the downloaded\r
785 file prior to using the read-file operations-especially when downloading large\r
786 (greater than 64 MB) files-instead of making two calls to the read-file operation.\r
787 Following this recommendation will save time if the file is larger than expected\r
788 and the TFTP server does not support TFTP option extensions. Without TFTP option\r
789 extension support, the client must download the entire file, counting and discarding\r
790 the received packets, to determine the file size.\r
791 For write operations, the data to be sent is in the buffer specified by BufferPtr.\r
792 BufferSize specifies the number of bytes to send. If the write operation completes\r
793 successfully, then EFI_SUCCESS will be returned.\r
794 For TFTP "get file size" operations, the size of the requested file or directory\r
795 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server\r
796 does not support options, the file will be downloaded into a bit bucket and the\r
797 length of the downloaded file will be returned. For MTFTP "get file size" operations,\r
798 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED\r
799 will be returned.\r
800 This function can take up to 10 seconds to timeout and return control to the caller.\r
801 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.\r
802 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
803 then the TFTP sequence is stopped and EFI_ABORTED will be returned.\r
804\r
805 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
806 @param[in] Operation The type of operation to perform.\r
807 @param[in, out] BufferPtr A pointer to the data buffer.\r
808 @param[in] Overwrite Only used on write file operations. TRUE if a file on a remote\r
809 server can be overwritten.\r
810 @param[in, out] BufferSize For get-file-size operations, *BufferSize returns the size of the\r
811 requested file.\r
812 @param[in] BlockSize The requested block size to be used during a TFTP transfer.\r
813 @param[in] ServerIp The TFTP / MTFTP server IP address.\r
814 @param[in] Filename A Null-terminated ASCII string that specifies a directory name\r
815 or a file name.\r
816 @param[in] Info Pointer to the MTFTP information.\r
817 @param[in] DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.\r
818\r
819 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\r
820 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
821 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
822 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
823 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.\r
824 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.\r
825 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r
826 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.\r
827 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.\r
828\r
829**/\r
830EFI_STATUS\r
831EFIAPI\r
832EfiPxeBcMtftp (\r
833 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
834 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation,\r
835 IN OUT VOID *BufferPtr OPTIONAL,\r
836 IN BOOLEAN Overwrite,\r
837 IN OUT UINT64 *BufferSize,\r
838 IN UINTN *BlockSize OPTIONAL,\r
839 IN EFI_IP_ADDRESS *ServerIp,\r
840 IN UINT8 *Filename,\r
841 IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL,\r
842 IN BOOLEAN DontUseBuffer\r
843 )\r
844{\r
845 PXEBC_PRIVATE_DATA *Private;\r
846 EFI_PXE_BASE_CODE_MODE *Mode;\r
847 EFI_MTFTP4_CONFIG_DATA Mtftp4Config;\r
848 EFI_MTFTP6_CONFIG_DATA Mtftp6Config;\r
849 VOID *Config;\r
850 EFI_STATUS Status;\r
851 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
852\r
853\r
854 if ((This == NULL) ||\r
855 (Filename == NULL) ||\r
856 (BufferSize == NULL) ||\r
857 (ServerIp == NULL) ||\r
6c12fe63 858 ((BlockSize != NULL) && (*BlockSize < PXE_MTFTP_DEFAULT_BLOCK_SIZE))) {\r
a3bcde70
HT
859 return EFI_INVALID_PARAMETER;\r
860 }\r
861\r
cf9ff46b
FS
862 if (Operation == EFI_PXE_BASE_CODE_TFTP_READ_FILE ||\r
863 Operation == EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY ||\r
864 Operation == EFI_PXE_BASE_CODE_MTFTP_READ_FILE ||\r
865 Operation == EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY) {\r
866 if (BufferPtr == NULL && !DontUseBuffer) {\r
867 return EFI_INVALID_PARAMETER;\r
868 }\r
869 }\r
870\r
a3bcde70
HT
871 Config = NULL;\r
872 Status = EFI_DEVICE_ERROR;\r
873 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
874 Mode = Private->PxeBc.Mode;\r
875\r
6c12fe63
FS
876 if (Mode->UsingIpv6) {\r
877 if (!NetIp6IsValidUnicast (&ServerIp->v6)) {\r
878 return EFI_INVALID_PARAMETER;\r
879 }\r
880 } else {\r
881 if (IP4_IS_UNSPECIFIED (NTOHL (ServerIp->Addr[0])) || IP4_IS_LOCAL_BROADCAST (NTOHL (ServerIp->Addr[0]))) {\r
882 return EFI_INVALID_PARAMETER;\r
883 }\r
884 }\r
885\r
a3bcde70
HT
886 if (Mode->UsingIpv6) {\r
887 //\r
888 // Set configuration data for Mtftp6 instance.\r
889 //\r
890 ZeroMem (&Mtftp6Config, sizeof (EFI_MTFTP6_CONFIG_DATA));\r
891 Config = &Mtftp6Config;\r
892 Mtftp6Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;\r
893 Mtftp6Config.TryCount = PXEBC_MTFTP_RETRIES;\r
894 CopyMem (&Mtftp6Config.StationIp, &Private->StationIp.v6, sizeof (EFI_IPv6_ADDRESS));\r
895 CopyMem (&Mtftp6Config.ServerIp, &ServerIp->v6, sizeof (EFI_IPv6_ADDRESS));\r
896 //\r
897 // Stop Udp6Read instance\r
898 //\r
899 Private->Udp6Read->Configure (Private->Udp6Read, NULL);\r
900 } else {\r
901 //\r
902 // Set configuration data for Mtftp4 instance.\r
903 //\r
904 ZeroMem (&Mtftp4Config, sizeof (EFI_MTFTP4_CONFIG_DATA));\r
905 Config = &Mtftp4Config;\r
906 Mtftp4Config.UseDefaultSetting = FALSE;\r
907 Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;\r
908 Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;\r
909 CopyMem (&Mtftp4Config.StationIp, &Private->StationIp.v4, sizeof (EFI_IPv4_ADDRESS));\r
910 CopyMem (&Mtftp4Config.SubnetMask, &Private->SubnetMask.v4, sizeof (EFI_IPv4_ADDRESS));\r
911 CopyMem (&Mtftp4Config.GatewayIp, &Private->GatewayIp.v4, sizeof (EFI_IPv4_ADDRESS));\r
912 CopyMem (&Mtftp4Config.ServerIp, &ServerIp->v4, sizeof (EFI_IPv4_ADDRESS));\r
913 //\r
914 // Stop Udp4Read instance\r
915 //\r
916 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
917 }\r
918\r
919 Mode->TftpErrorReceived = FALSE;\r
920 Mode->IcmpErrorReceived = FALSE;\r
921\r
922 switch (Operation) {\r
923\r
924 case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE:\r
925 //\r
926 // Send TFTP request to get file size.\r
927 //\r
928 Status = PxeBcTftpGetFileSize (\r
929 Private,\r
930 Config,\r
931 Filename,\r
932 BlockSize,\r
933 BufferSize\r
934 );\r
935\r
936 break;\r
937\r
938 case EFI_PXE_BASE_CODE_TFTP_READ_FILE:\r
939 //\r
940 // Send TFTP request to read file.\r
941 //\r
942 Status = PxeBcTftpReadFile (\r
943 Private,\r
944 Config,\r
945 Filename,\r
946 BlockSize,\r
947 BufferPtr,\r
948 BufferSize,\r
949 DontUseBuffer\r
950 );\r
951\r
952 break;\r
953\r
954 case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE:\r
955 //\r
956 // Send TFTP request to write file.\r
957 //\r
958 Status = PxeBcTftpWriteFile (\r
959 Private,\r
960 Config,\r
961 Filename,\r
962 Overwrite,\r
963 BlockSize,\r
964 BufferPtr,\r
965 BufferSize\r
966 );\r
967\r
968 break;\r
969\r
970 case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY:\r
971 //\r
972 // Send TFTP request to read directory.\r
973 //\r
974 Status = PxeBcTftpReadDirectory (\r
975 Private,\r
976 Config,\r
977 Filename,\r
978 BlockSize,\r
979 BufferPtr,\r
980 BufferSize,\r
981 DontUseBuffer\r
982 );\r
983\r
984 break;\r
985\r
986 case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE:\r
987 case EFI_PXE_BASE_CODE_MTFTP_READ_FILE:\r
988 case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY:\r
989 Status = EFI_UNSUPPORTED;\r
990\r
991 break;\r
992\r
993 default:\r
994 Status = EFI_INVALID_PARAMETER;\r
995\r
996 break;\r
997 }\r
998\r
999 if (Status == EFI_ICMP_ERROR) {\r
1000 Mode->IcmpErrorReceived = TRUE;\r
1001 }\r
1002\r
1ac9cb8a 1003 //\r
1004 // Reconfigure the UDP instance with the default configuration.\r
1005 //\r
18127352 1006 if (Mode->UsingIpv6) {\r
357af285 1007 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);\r
18127352 1008 } else {\r
357af285 1009 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
18127352 1010 }\r
a3bcde70
HT
1011 //\r
1012 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP\r
1013 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1014 //\r
1015 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
1016 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
1017 This->SetIpFilter (This, &IpFilter);\r
1018\r
1019 return Status;\r
1020}\r
1021\r
1022\r
1023/**\r
1024 Writes a UDP packet to the network interface.\r
1025\r
1026 This function writes a UDP packet specified by the (optional HeaderPtr and)\r
1027 BufferPtr parameters to the network interface. The UDP header is automatically\r
1028 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,\r
1029 SrcIp, and SrcPort to build this header. If the packet is successfully built and\r
1030 transmitted through the network interface, then EFI_SUCCESS will be returned.\r
1031 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will\r
1032 be returned. If an ICMP error occurs during the transmission of the packet, then\r
1033 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and\r
1034 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r
1035 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r
1036\r
1037 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1038 @param[in] OpFlags The UDP operation flags.\r
1039 @param[in] DestIp The destination IP address.\r
1040 @param[in] DestPort The destination UDP port number.\r
1041 @param[in] GatewayIp The gateway IP address.\r
1042 @param[in] SrcIp The source IP address.\r
1043 @param[in, out] SrcPort The source UDP port number.\r
1044 @param[in] HeaderSize An optional field which may be set to the length of a header\r
1045 at HeaderPtr to be prefixed to the data at BufferPtr.\r
1046 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be\r
1047 prefixed to the data at BufferPtr.\r
1048 @param[in] BufferSize A pointer to the size of the data at BufferPtr.\r
1049 @param[in] BufferPtr A pointer to the data to be written.\r
1050\r
1051 @retval EFI_SUCCESS The UDP Write operation completed.\r
1052 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1053 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1054 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.\r
1055 @retval EFI_ABORTED The callback function aborted the UDP Write operation.\r
1056 @retval EFI_TIMEOUT The UDP Write operation timed out.\r
1057 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.\r
1058\r
1059**/\r
1060EFI_STATUS\r
1061EFIAPI\r
1062EfiPxeBcUdpWrite (\r
1063 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1064 IN UINT16 OpFlags,\r
1065 IN EFI_IP_ADDRESS *DestIp,\r
1066 IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,\r
1067 IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,\r
1068 IN EFI_IP_ADDRESS *SrcIp OPTIONAL,\r
1069 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r
1070 IN UINTN *HeaderSize OPTIONAL,\r
1071 IN VOID *HeaderPtr OPTIONAL,\r
1072 IN UINTN *BufferSize,\r
1073 IN VOID *BufferPtr\r
1074 )\r
1075{\r
1076 PXEBC_PRIVATE_DATA *Private;\r
1077 EFI_PXE_BASE_CODE_MODE *Mode;\r
1078 EFI_UDP4_SESSION_DATA Udp4Session;\r
1079 EFI_UDP6_SESSION_DATA Udp6Session;\r
1080 EFI_STATUS Status;\r
1081 BOOLEAN DoNotFragment;\r
1082\r
1083 if (This == NULL || DestIp == NULL || DestPort == NULL) {\r
1084 return EFI_INVALID_PARAMETER;\r
1085 }\r
1086\r
1087 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1088 Mode = Private->PxeBc.Mode;\r
1089\r
1090 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT) != 0) {\r
1091 DoNotFragment = FALSE;\r
1092 } else {\r
1093 DoNotFragment = TRUE;\r
1094 }\r
1095\r
ba025280
JW
1096 if (!Mode->UsingIpv6 && GatewayIp != NULL && Mode->SubnetMask.Addr[0] != 0 && \r
1097 !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), EFI_NTOHL(Mode->SubnetMask))) {\r
a3bcde70
HT
1098 //\r
1099 // Gateway is provided but it's not a unicast IPv4 address, while it will be ignored for IPv6.\r
1100 //\r
1101 return EFI_INVALID_PARAMETER;\r
1102 }\r
1103\r
1104 if (HeaderSize != NULL && (*HeaderSize == 0 || HeaderPtr == NULL)) {\r
1105 return EFI_INVALID_PARAMETER;\r
1106 }\r
1107\r
1108 if (BufferSize == NULL || (*BufferSize != 0 && BufferPtr == NULL)) {\r
1109 return EFI_INVALID_PARAMETER;\r
1110 }\r
1111\r
1112 if (!Mode->Started) {\r
1113 return EFI_NOT_STARTED;\r
1114 }\r
1115\r
1116 if (!Private->IsAddressOk && SrcIp == NULL) {\r
1117 return EFI_INVALID_PARAMETER;\r
1118 }\r
1119\r
1120 if (Private->CurSrcPort == 0 ||\r
1121 (SrcPort != NULL && *SrcPort != Private->CurSrcPort)) {\r
1122 //\r
1123 // Reconfigure UDPv4/UDPv6 for UdpWrite if the source port changed.\r
1124 //\r
1125 if (SrcPort != NULL) {\r
1126 Private->CurSrcPort = *SrcPort;\r
1127 }\r
1128 }\r
1129\r
1130 if (Mode->UsingIpv6) {\r
1131 Status = PxeBcConfigUdp6Write (\r
1132 Private->Udp6Write,\r
1133 &Private->StationIp.v6,\r
1134 &Private->CurSrcPort\r
1135 );\r
1136 } else {\r
1137 //\r
1138 // Configure the UDPv4 instance with gateway information from DHCP server as default.\r
1139 //\r
1140 Status = PxeBcConfigUdp4Write (\r
1141 Private->Udp4Write,\r
1142 &Private->StationIp.v4,\r
1143 &Private->SubnetMask.v4,\r
1144 &Private->GatewayIp.v4,\r
1145 &Private->CurSrcPort,\r
6f2f4116
FS
1146 DoNotFragment,\r
1147 Private->Mode.TTL,\r
1148 Private->Mode.ToS\r
a3bcde70
HT
1149 );\r
1150 }\r
1151\r
1152 if (EFI_ERROR (Status)) {\r
1153 Private->CurSrcPort = 0;\r
1154 return EFI_INVALID_PARAMETER;\r
1155 } else if (SrcPort != NULL) {\r
1156 *SrcPort = Private->CurSrcPort;\r
1157 }\r
1158\r
1159 //\r
1160 // Start a timer as timeout event for this blocking API.\r
1161 //\r
1162 gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);\r
1163\r
1164 if (Mode->UsingIpv6) {\r
1165 //\r
1166 // Construct UDPv6 session data.\r
1167 //\r
1168 ZeroMem (&Udp6Session, sizeof (EFI_UDP6_SESSION_DATA));\r
1169 CopyMem (&Udp6Session.DestinationAddress, DestIp, sizeof (EFI_IPv6_ADDRESS));\r
1170 Udp6Session.DestinationPort = *DestPort;\r
1171 if (SrcIp != NULL) {\r
1172 CopyMem (&Udp6Session.SourceAddress, SrcIp, sizeof (EFI_IPv6_ADDRESS));\r
1173 }\r
1174 if (SrcPort != NULL) {\r
1175 Udp6Session.SourcePort = *SrcPort;\r
1176 }\r
1177\r
1178 Status = PxeBcUdp6Write (\r
1179 Private->Udp6Write,\r
1180 &Udp6Session,\r
1181 Private->UdpTimeOutEvent,\r
1182 HeaderSize,\r
1183 HeaderPtr,\r
1184 BufferSize,\r
1185 BufferPtr\r
1186 );\r
1187 } else {\r
1188 //\r
1189 // Construct UDPv4 session data.\r
1190 //\r
1191 ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));\r
1192 CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));\r
1193 Udp4Session.DestinationPort = *DestPort;\r
1194 if (SrcIp != NULL) {\r
1195 CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));\r
1196 }\r
1197 if (SrcPort != NULL) {\r
1198 Udp4Session.SourcePort = *SrcPort;\r
1199 }\r
1200 //\r
1201 // Override the gateway information if user specified.\r
1202 //\r
1203 Status = PxeBcUdp4Write (\r
1204 Private->Udp4Write,\r
1205 &Udp4Session,\r
1206 Private->UdpTimeOutEvent,\r
1207 (EFI_IPv4_ADDRESS *) GatewayIp,\r
1208 HeaderSize,\r
1209 HeaderPtr,\r
1210 BufferSize,\r
1211 BufferPtr\r
1212 );\r
1213 }\r
1214\r
1215 gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);\r
1216\r
1217\r
1218 //\r
1219 // Reset the UdpWrite instance.\r
1220 //\r
1221 if (Mode->UsingIpv6) {\r
1222 Private->Udp6Write->Configure (Private->Udp6Write, NULL);\r
1223 } else {\r
1224 Private->Udp4Write->Configure (Private->Udp4Write, NULL);\r
1225 }\r
1226\r
1227 return Status;\r
1228}\r
1229\r
1230\r
1231/**\r
1232 Reads a UDP packet from the network interface.\r
1233+\r
1234 This function reads a UDP packet from a network interface. The data contents\r
1235 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r
1236 buffer received is returned in BufferSize . If the input BufferSize is smaller\r
1237 than the UDP packet received (less optional HeaderSize), it will be set to the\r
1238 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r
1239 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r
1240 successfully received, then EFI_SUCCESS will be returned, and the information\r
1241 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if\r
1242 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,\r
1243 SrcIp, and SrcPort input values, different types of UDP packet receive filtering\r
1244 will be performed. The following tables summarize these receive filter operations.\r
1245\r
1246 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1247 @param[in] OpFlags The UDP operation flags.\r
1248 @param[in, out] DestIp The destination IP address.\r
1249 @param[in, out] DestPort The destination UDP port number.\r
1250 @param[in, out] SrcIp The source IP address.\r
1251 @param[in, out] SrcPort The source UDP port number.\r
1252 @param[in] HeaderSize An optional field which may be set to the length of a\r
1253 header at HeaderPtr to be prefixed to the data at BufferPtr.\r
1254 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be\r
1255 prefixed to the data at BufferPtr.\r
1256 @param[in, out] BufferSize A pointer to the size of the data at BufferPtr.\r
1257 @param[in] BufferPtr A pointer to the data to be read.\r
1258\r
1259 @retval EFI_SUCCESS The UDP Read operation was completed.\r
1260 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1261 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1262 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
1263 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.\r
1264 @retval EFI_ABORTED The callback function aborted the UDP Read operation.\r
1265 @retval EFI_TIMEOUT The UDP Read operation timed out.\r
1266\r
1267**/\r
1268EFI_STATUS\r
1269EFIAPI\r
1270EfiPxeBcUdpRead (\r
1271 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1272 IN UINT16 OpFlags,\r
1273 IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,\r
1274 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,\r
1275 IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,\r
1276 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r
1277 IN UINTN *HeaderSize OPTIONAL,\r
1278 IN VOID *HeaderPtr OPTIONAL,\r
1279 IN OUT UINTN *BufferSize,\r
1280 IN VOID *BufferPtr\r
1281 )\r
1282{\r
1283 PXEBC_PRIVATE_DATA *Private;\r
1284 EFI_PXE_BASE_CODE_MODE *Mode;\r
1285 EFI_UDP4_COMPLETION_TOKEN Udp4Token;\r
1286 EFI_UDP6_COMPLETION_TOKEN Udp6Token;\r
1287 EFI_UDP4_RECEIVE_DATA *Udp4Rx;\r
1288 EFI_UDP6_RECEIVE_DATA *Udp6Rx;\r
1289 EFI_STATUS Status;\r
1290 BOOLEAN IsDone;\r
1291 BOOLEAN IsMatched;\r
1292 UINTN CopiedLen;\r
eb2710af 1293 UINTN HeaderLen;\r
1294 UINTN HeaderCopiedLen;\r
1295 UINTN BufferCopiedLen;\r
1296 UINT32 FragmentLength;\r
1297 UINTN FragmentIndex;\r
1298 UINT8 *FragmentBuffer;\r
a3bcde70 1299\r
903d1fa9 1300 if (This == NULL) {\r
a3bcde70
HT
1301 return EFI_INVALID_PARAMETER;\r
1302 }\r
1303\r
1304 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1305 Mode = Private->PxeBc.Mode;\r
1306 IsDone = FALSE;\r
1307 IsMatched = FALSE;\r
1308 Udp4Rx = NULL;\r
1309 Udp6Rx = NULL;\r
1310\r
903d1fa9
FS
1311 if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && DestPort == NULL) ||\r
1312 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) == 0 && SrcIp == NULL) ||\r
1313 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) == 0 && SrcPort == NULL)) {\r
a3bcde70
HT
1314 return EFI_INVALID_PARAMETER;\r
1315 }\r
1316\r
1317 if ((HeaderSize != NULL && *HeaderSize == 0) || (HeaderSize != NULL && HeaderPtr == NULL)) {\r
1318 return EFI_INVALID_PARAMETER;\r
1319 }\r
1320\r
1321 if ((BufferSize == NULL) || (BufferPtr == NULL)) {\r
1322 return EFI_INVALID_PARAMETER;\r
1323 }\r
1324\r
1325 if (!Mode->Started) {\r
1326 return EFI_NOT_STARTED;\r
1327 }\r
1328\r
1329 ZeroMem (&Udp6Token, sizeof (EFI_UDP6_COMPLETION_TOKEN));\r
1330 ZeroMem (&Udp4Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));\r
1331\r
1332 if (Mode->UsingIpv6) {\r
1333 Status = gBS->CreateEvent (\r
1334 EVT_NOTIFY_SIGNAL,\r
1335 TPL_NOTIFY,\r
1336 PxeBcCommonNotify,\r
1337 &IsDone,\r
1338 &Udp6Token.Event\r
1339 );\r
1340 if (EFI_ERROR (Status)) {\r
1341 return EFI_OUT_OF_RESOURCES;\r
1342 }\r
1343 } else {\r
1344 Status = gBS->CreateEvent (\r
1345 EVT_NOTIFY_SIGNAL,\r
1346 TPL_NOTIFY,\r
1347 PxeBcCommonNotify,\r
1348 &IsDone,\r
1349 &Udp4Token.Event\r
1350 );\r
1351 if (EFI_ERROR (Status)) {\r
1352 return EFI_OUT_OF_RESOURCES;\r
1353 }\r
1354 }\r
1355\r
1356 //\r
1357 // Start a timer as timeout event for this blocking API.\r
1358 //\r
1359 gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);\r
1360 Mode->IcmpErrorReceived = FALSE;\r
1361\r
1362 //\r
1363 // Read packet by Udp4Read/Udp6Read until matched or timeout.\r
1364 //\r
1365 while (!IsMatched && !EFI_ERROR (Status)) {\r
1366 if (Mode->UsingIpv6) {\r
1367 Status = PxeBcUdp6Read (\r
1368 Private->Udp6Read,\r
1369 &Udp6Token,\r
1370 Mode,\r
1371 Private->UdpTimeOutEvent,\r
1372 OpFlags,\r
1373 &IsDone,\r
1374 &IsMatched,\r
1375 DestIp,\r
1376 DestPort,\r
1377 SrcIp,\r
1378 SrcPort\r
1379 );\r
1380 } else {\r
1381 Status = PxeBcUdp4Read (\r
1382 Private->Udp4Read,\r
1383 &Udp4Token,\r
1384 Mode,\r
1385 Private->UdpTimeOutEvent,\r
1386 OpFlags,\r
1387 &IsDone,\r
1388 &IsMatched,\r
1389 DestIp,\r
1390 DestPort,\r
1391 SrcIp,\r
1392 SrcPort\r
1393 );\r
1394 }\r
1395 }\r
1396\r
1397 if (Status == EFI_ICMP_ERROR ||\r
1398 Status == EFI_NETWORK_UNREACHABLE ||\r
1399 Status == EFI_HOST_UNREACHABLE ||\r
1400 Status == EFI_PROTOCOL_UNREACHABLE ||\r
1401 Status == EFI_PORT_UNREACHABLE) {\r
1402 //\r
1403 // Get different return status for icmp error from Udp, refers to UEFI spec.\r
1404 //\r
1405 Mode->IcmpErrorReceived = TRUE;\r
1406 }\r
1407 gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);\r
1408\r
1409 if (IsMatched) {\r
1410 //\r
1411 // Copy the rececived packet to user if matched by filter.\r
1412 //\r
a3bcde70
HT
1413 if (Mode->UsingIpv6) {\r
1414 Udp6Rx = Udp6Token.Packet.RxData;\r
1415 ASSERT (Udp6Rx != NULL);\r
eb2710af 1416\r
1417 HeaderLen = 0;\r
a3bcde70 1418 if (HeaderSize != NULL) {\r
eb2710af 1419 HeaderLen = MIN (*HeaderSize, Udp6Rx->DataLength);\r
a3bcde70 1420 }\r
eb2710af 1421\r
1422 if (Udp6Rx->DataLength - HeaderLen > *BufferSize) {\r
a3bcde70
HT
1423 Status = EFI_BUFFER_TOO_SMALL;\r
1424 } else {\r
d40002ba 1425 if (HeaderSize != NULL) {\r
1426 *HeaderSize = HeaderLen;\r
1427 }\r
eb2710af 1428 *BufferSize = Udp6Rx->DataLength - HeaderLen;\r
1429\r
1430 HeaderCopiedLen = 0;\r
1431 BufferCopiedLen = 0;\r
1432 for (FragmentIndex = 0; FragmentIndex < Udp6Rx->FragmentCount; FragmentIndex++) {\r
1433 FragmentLength = Udp6Rx->FragmentTable[FragmentIndex].FragmentLength;\r
1434 FragmentBuffer = Udp6Rx->FragmentTable[FragmentIndex].FragmentBuffer;\r
1435 if (HeaderCopiedLen + FragmentLength < HeaderLen) {\r
1436 //\r
1437 // Copy the header part of received data.\r
1438 //\r
1439 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);\r
1440 HeaderCopiedLen += FragmentLength;\r
1441 } else if (HeaderCopiedLen < HeaderLen) {\r
1442 //\r
1443 // Copy the header part of received data.\r
1444 //\r
1445 CopiedLen = HeaderLen - HeaderCopiedLen;\r
1446 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);\r
1447 HeaderCopiedLen += CopiedLen;\r
1448\r
1449 //\r
1450 // Copy the other part of received data.\r
1451 //\r
1452 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);\r
1453 BufferCopiedLen += (FragmentLength - CopiedLen);\r
1454 } else {\r
1455 //\r
1456 // Copy the other part of received data.\r
1457 //\r
1458 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);\r
1459 BufferCopiedLen += FragmentLength;\r
1460 }\r
1461 }\r
a3bcde70
HT
1462 }\r
1463 //\r
1464 // Recycle the receiving buffer after copy to user.\r
1465 //\r
1466 gBS->SignalEvent (Udp6Rx->RecycleSignal);\r
1467 } else {\r
1468 Udp4Rx = Udp4Token.Packet.RxData;\r
1469 ASSERT (Udp4Rx != NULL);\r
eb2710af 1470\r
1471 HeaderLen = 0;\r
a3bcde70 1472 if (HeaderSize != NULL) {\r
eb2710af 1473 HeaderLen = MIN (*HeaderSize, Udp4Rx->DataLength);\r
a3bcde70 1474 }\r
eb2710af 1475\r
1476 if (Udp4Rx->DataLength - HeaderLen > *BufferSize) {\r
a3bcde70
HT
1477 Status = EFI_BUFFER_TOO_SMALL;\r
1478 } else {\r
d40002ba 1479 if (HeaderSize != NULL) {\r
1480 *HeaderSize = HeaderLen;\r
1481 }\r
eb2710af 1482 *BufferSize = Udp4Rx->DataLength - HeaderLen;\r
1483\r
1484 HeaderCopiedLen = 0;\r
1485 BufferCopiedLen = 0;\r
1486 for (FragmentIndex = 0; FragmentIndex < Udp4Rx->FragmentCount; FragmentIndex++) {\r
1487 FragmentLength = Udp4Rx->FragmentTable[FragmentIndex].FragmentLength;\r
1488 FragmentBuffer = Udp4Rx->FragmentTable[FragmentIndex].FragmentBuffer;\r
1489 if (HeaderCopiedLen + FragmentLength < HeaderLen) {\r
1490 //\r
1491 // Copy the header part of received data.\r
1492 //\r
1493 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);\r
1494 HeaderCopiedLen += FragmentLength;\r
1495 } else if (HeaderCopiedLen < HeaderLen) {\r
1496 //\r
1497 // Copy the header part of received data.\r
1498 //\r
1499 CopiedLen = HeaderLen - HeaderCopiedLen;\r
1500 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);\r
1501 HeaderCopiedLen += CopiedLen;\r
1502\r
1503 //\r
1504 // Copy the other part of received data.\r
1505 //\r
1506 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);\r
1507 BufferCopiedLen += (FragmentLength - CopiedLen);\r
1508 } else {\r
1509 //\r
1510 // Copy the other part of received data.\r
1511 //\r
1512 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);\r
1513 BufferCopiedLen += FragmentLength;\r
1514 }\r
1515 }\r
a3bcde70
HT
1516 }\r
1517 //\r
1518 // Recycle the receiving buffer after copy to user.\r
1519 //\r
1520 gBS->SignalEvent (Udp4Rx->RecycleSignal);\r
1521 }\r
1522 }\r
1523\r
1524 if (Mode->UsingIpv6) {\r
1525 Private->Udp6Read->Cancel (Private->Udp6Read, &Udp6Token);\r
1526 gBS->CloseEvent (Udp6Token.Event);\r
1527 } else {\r
1528 Private->Udp4Read->Cancel (Private->Udp4Read, &Udp4Token);\r
1529 gBS->CloseEvent (Udp4Token.Event);\r
1530 }\r
1531\r
1532 return Status;\r
1533}\r
1534\r
1535\r
1536/**\r
1537 Updates the IP receive filters of a network device and enables software filtering.\r
1538\r
1539 The NewFilter field is used to modify the network device's current IP receive\r
1540 filter settings and to enable a software filter. This function updates the IpFilter\r
1541 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.\r
1542 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().\r
1543 The current hardware filter remains in effect no matter what the settings of OpFlags.\r
1544 This is so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those\r
1545 packets whose reception is enabled in hardware-physical NIC address (unicast),\r
1546 broadcast address, logical address or addresses (multicast), or all (promiscuous).\r
1547 UdpRead() does not modify the IP filter settings.\r
1548 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive\r
1549 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1550 If an application or driver wishes to preserve the IP receive filter settings,\r
1551 it will have to preserve the IP receive filter settings before these calls, and\r
1552 use SetIpFilter() to restore them after the calls. If incompatible filtering is\r
1553 requested (for example, PROMISCUOUS with anything else), or if the device does not\r
1554 support a requested filter setting and it cannot be accommodated in software\r
1555 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\r
1556 The IPlist field is used to enable IPs other than the StationIP. They may be\r
1557 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r
1558 then both the StationIP and the IPs from the IPlist will be used.\r
1559\r
1560 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1561 @param[in] NewFilter Pointer to the new set of IP receive filters.\r
1562\r
1563 @retval EFI_SUCCESS The IP receive filter settings were updated.\r
1564 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1565 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1566\r
1567**/\r
1568EFI_STATUS\r
1569EFIAPI\r
1570EfiPxeBcSetIpFilter (\r
1571 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1572 IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter\r
1573 )\r
1574{\r
1575 EFI_STATUS Status;\r
1576 PXEBC_PRIVATE_DATA *Private;\r
1577 EFI_PXE_BASE_CODE_MODE *Mode;\r
18127352 1578 EFI_UDP4_CONFIG_DATA *Udp4Cfg;\r
1579 EFI_UDP6_CONFIG_DATA *Udp6Cfg;\r
a3bcde70
HT
1580 UINTN Index;\r
1581 BOOLEAN NeedPromiscuous;\r
18127352 1582 BOOLEAN AcceptPromiscuous;\r
1583 BOOLEAN AcceptBroadcast;\r
1584 BOOLEAN MultiCastUpdate;\r
a3bcde70
HT
1585\r
1586 if (This == NULL || NewFilter == NULL) {\r
1587 return EFI_INVALID_PARAMETER;\r
1588 }\r
1589\r
1590 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1591 Mode = Private->PxeBc.Mode;\r
1592 Status = EFI_SUCCESS;\r
1593 NeedPromiscuous = FALSE;\r
1594\r
1595 if (!Mode->Started) {\r
1596 return EFI_NOT_STARTED;\r
1597 }\r
1598\r
1599 for (Index = 0; Index < NewFilter->IpCnt; Index++) {\r
1600 ASSERT (Index < EFI_PXE_BASE_CODE_MAX_IPCNT);\r
1601 if (!Mode->UsingIpv6 &&\r
1602 IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {\r
1603 //\r
1604 // IPv4 broadcast address should not be in IP filter.\r
1605 //\r
1606 return EFI_INVALID_PARAMETER;\r
1607 }\r
6c12fe63
FS
1608 if (Mode->UsingIpv6) {\r
1609 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0 &&\r
1610 NetIp6IsValidUnicast (&NewFilter->IpList[Index].v6)) {\r
1611 NeedPromiscuous = TRUE;\r
1612 }\r
1613 } else if ((EFI_NTOHL(Mode->StationIp) != 0) &&\r
1614 (EFI_NTOHL(Mode->SubnetMask) != 0) &&\r
1615 IP4_NET_EQUAL(EFI_NTOHL(Mode->StationIp), EFI_NTOHL(NewFilter->IpList[Index].v4), EFI_NTOHL(Mode->SubnetMask.v4)) &&\r
1616 NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), EFI_NTOHL(Mode->SubnetMask)) &&\r
1617 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0)) {\r
a3bcde70
HT
1618 NeedPromiscuous = TRUE;\r
1619 }\r
1620 }\r
1621\r
18127352 1622 AcceptPromiscuous = FALSE;\r
1623 AcceptBroadcast = FALSE;\r
1624 MultiCastUpdate = FALSE;\r
a3bcde70
HT
1625\r
1626 if (NeedPromiscuous ||\r
1627 (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0 ||\r
1628 (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) {\r
1629 //\r
1630 // Configure UDPv4/UDPv6 as promiscuous mode to receive all packets.\r
1631 //\r
18127352 1632 AcceptPromiscuous = TRUE;\r
a3bcde70
HT
1633 } else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {\r
1634 //\r
1635 // Configure UDPv4 to receive all broadcast packets.\r
1636 //\r
18127352 1637 AcceptBroadcast = TRUE;\r
a3bcde70
HT
1638 }\r
1639\r
1640 //\r
18127352 1641 // In multicast condition when Promiscuous FALSE and IpCnt no-zero.\r
1642 // Here check if there is any update of the multicast ip address. If yes,\r
1643 // we need leave the old multicast group (by Config UDP instance to NULL),\r
1644 // and join the new multicast group.\r
a3bcde70 1645 //\r
18127352 1646 if (!AcceptPromiscuous) {\r
1647 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {\r
1648 if (Mode->IpFilter.IpCnt != NewFilter->IpCnt) {\r
1649 MultiCastUpdate = TRUE;\r
1650 } else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {\r
1651 MultiCastUpdate = TRUE;\r
1652 }\r
1653 }\r
a3bcde70
HT
1654 }\r
1655\r
18127352 1656 if (!Mode->UsingIpv6) {\r
1657 //\r
1658 // Check whether we need reconfigure the UDP4 instance.\r
1659 //\r
1660 Udp4Cfg = &Private->Udp4CfgData;\r
1661 if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||\r
1662 (AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {\r
1663 //\r
1664 // Clear the UDP4 instance configuration, all joined groups will be left\r
1665 // during the operation.\r
a3bcde70 1666 //\r
18127352 1667 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
1668 \r
a3bcde70 1669 //\r
18127352 1670 // Configure the UDP instance with the new configuration.\r
1671 //\r
1672 Udp4Cfg->AcceptPromiscuous = AcceptPromiscuous;\r
1673 Udp4Cfg->AcceptBroadcast = AcceptBroadcast;\r
1674 Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);\r
1675 if (EFI_ERROR (Status)) {\r
1676 return Status;\r
1677 }\r
1678 \r
1679 //\r
1680 // In not Promiscuous mode, need to join the new multicast group.\r
1681 //\r
1682 if (!AcceptPromiscuous) {\r
1683 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
1684 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {\r
1685 //\r
1686 // Join the mutilcast group.\r
1687 //\r
1688 Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);\r
1689 if (EFI_ERROR (Status)) {\r
1690 return Status;\r
1691 }\r
a3bcde70
HT
1692 }\r
1693 }\r
18127352 1694 }\r
1695 }\r
1696 } else {\r
1697 //\r
1698 // Check whether we need reconfigure the UDP6 instance.\r
1699 //\r
1700 Udp6Cfg = &Private->Udp6CfgData;\r
1701 if ((AcceptPromiscuous != Udp6Cfg->AcceptPromiscuous) || MultiCastUpdate) {\r
1702 //\r
1703 // Clear the UDP6 instance configuration, all joined groups will be left\r
1704 // during the operation.\r
1705 //\r
1706 Private->Udp6Read->Configure (Private->Udp6Read, NULL);\r
1707 \r
1708 //\r
1709 // Configure the UDP instance with the new configuration.\r
1710 //\r
1711 Udp6Cfg->AcceptPromiscuous = AcceptPromiscuous;\r
1712 Status = Private->Udp6Read->Configure (Private->Udp6Read, Udp6Cfg);\r
1713 if (EFI_ERROR (Status)) {\r
1714 return Status;\r
1715 }\r
1716 \r
1717 //\r
1718 // In not Promiscuous mode, need to join the new multicast group.\r
1719 //\r
1720 if (!AcceptPromiscuous) {\r
1721 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
1722 if (IP6_IS_MULTICAST (&NewFilter->IpList[Index].v6)) {\r
1723 //\r
1724 // Join the mutilcast group.\r
1725 //\r
1726 Status = Private->Udp6Read->Groups (Private->Udp6Read, TRUE, &NewFilter->IpList[Index].v6);\r
1727 if (EFI_ERROR (Status)) {\r
1728 return Status;\r
1729 }\r
a3bcde70
HT
1730 }\r
1731 }\r
1732 }\r
1733 }\r
1734 }\r
1735\r
1736 //\r
1737 // Save the new IP filter into mode data.\r
1738 //\r
1739 CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));\r
1740\r
a3bcde70
HT
1741 return Status;\r
1742}\r
1743\r
1744\r
1745/**\r
1746 Uses the ARP protocol to resolve a MAC address. It is not supported for IPv6.\r
1747\r
1748 This function uses the ARP protocol to resolve a MAC address. The IP address specified\r
1749 by IpAddr is used to resolve a MAC address. If the ARP protocol succeeds in resolving\r
1750 the specified address, then the ArpCacheEntries and ArpCache fields of the mode data\r
1751 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved\r
1752 MAC address is placed there as well. If the PXE Base Code protocol is in the\r
1753 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters\r
1754 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is\r
1755 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
1756 then EFI_ABORTED is returned.\r
1757\r
1758 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1759 @param[in] IpAddr Pointer to the IP address that is used to resolve a MAC address.\r
1760 @param[in] MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r
1761 ARP protocol.\r
1762\r
1763 @retval EFI_SUCCESS The IP or MAC address was resolved.\r
1764 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1765 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1766 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
1767 @retval EFI_ICMP_ERROR An error occur with the ICMP packet message.\r
1768\r
1769**/\r
1770EFI_STATUS\r
1771EFIAPI\r
1772EfiPxeBcArp (\r
1773 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1774 IN EFI_IP_ADDRESS *IpAddr,\r
1775 IN EFI_MAC_ADDRESS *MacAddr OPTIONAL\r
1776 )\r
1777{\r
1778 PXEBC_PRIVATE_DATA *Private;\r
1779 EFI_PXE_BASE_CODE_MODE *Mode;\r
1780 EFI_EVENT ResolvedEvent;\r
1781 EFI_STATUS Status;\r
1782 EFI_MAC_ADDRESS TempMac;\r
1783 EFI_MAC_ADDRESS ZeroMac;\r
1784 BOOLEAN IsResolved;\r
1785\r
1786 if (This == NULL || IpAddr == NULL) {\r
1787 return EFI_INVALID_PARAMETER;\r
1788 }\r
1789\r
1790 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1791 Mode = Private->PxeBc.Mode;\r
1792 ResolvedEvent = NULL;\r
1793 Status = EFI_SUCCESS;\r
1794 IsResolved = FALSE;\r
1795\r
1796 if (!Mode->Started) {\r
1797 return EFI_NOT_STARTED;\r
1798 }\r
1799\r
1800 if (Mode->UsingIpv6) {\r
1801 return EFI_UNSUPPORTED;\r
1802 }\r
1803\r
1804 //\r
1805 // Station address should be ready before do arp.\r
1806 //\r
1807 if (!Private->IsAddressOk) {\r
1808 return EFI_INVALID_PARAMETER;\r
1809 }\r
1810\r
1811 Mode->IcmpErrorReceived = FALSE;\r
1812 ZeroMem (&TempMac, sizeof (EFI_MAC_ADDRESS));\r
1813 ZeroMem (&ZeroMac, sizeof (EFI_MAC_ADDRESS));\r
1814\r
1815 if (!Mode->AutoArp) {\r
1816 //\r
1817 // If AutoArp is FALSE, only search in the current Arp cache.\r
1818 //\r
1819 PxeBcArpCacheUpdate (NULL, Private);\r
1820 if (!PxeBcCheckArpCache (Mode, &IpAddr->v4, &TempMac)) {\r
1821 Status = EFI_DEVICE_ERROR;\r
1822 goto ON_EXIT;\r
1823 }\r
1824 } else {\r
1825 Status = gBS->CreateEvent (\r
1826 EVT_NOTIFY_SIGNAL,\r
1827 TPL_NOTIFY,\r
1828 PxeBcCommonNotify,\r
1829 &IsResolved,\r
1830 &ResolvedEvent\r
1831 );\r
1832 if (EFI_ERROR (Status)) {\r
1833 goto ON_EXIT;\r
1834 }\r
1835\r
1836 //\r
1837 // If AutoArp is TRUE, try to send Arp request on initiative.\r
1838 //\r
1839 Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, ResolvedEvent, &TempMac);\r
1840 if (EFI_ERROR (Status) && Status != EFI_NOT_READY) {\r
1841 goto ON_EXIT;\r
1842 }\r
1843\r
1844 while (!IsResolved) {\r
1845 if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {\r
1846 break;\r
1847 }\r
1848 }\r
1849 if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {\r
1850 Status = EFI_SUCCESS;\r
1851 } else {\r
1852 Status = EFI_TIMEOUT;\r
1853 }\r
1854 }\r
1855\r
1856 //\r
1857 // Copy the Mac address to user if needed.\r
1858 //\r
1859 if (MacAddr != NULL && !EFI_ERROR (Status)) {\r
1860 CopyMem (MacAddr, &TempMac, sizeof (EFI_MAC_ADDRESS));\r
1861 }\r
1862\r
1863ON_EXIT:\r
1864 if (ResolvedEvent != NULL) {\r
1865 gBS->CloseEvent (ResolvedEvent);\r
1866 }\r
1867 return Status;\r
1868}\r
1869\r
1870\r
1871/**\r
1872 Updates the parameters that affect the operation of the PXE Base Code Protocol.\r
1873\r
1874 This function sets parameters that affect the operation of the PXE Base Code Protocol.\r
1875 The parameter specified by NewAutoArp is used to control the generation of ARP\r
1876 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated\r
1877 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP\r
1878 Protocol packets will be generated. In this case, the only mappings that are\r
1879 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.\r
1880 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol\r
1881 service, then the service will fail. This function updates the AutoArp field of\r
1882 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.\r
1883 The SetParameters() call must be invoked after a Callback Protocol is installed\r
1884 to enable the use of callbacks.\r
1885\r
1886 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1887 @param[in] NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r
1888 current value of AutoARP.\r
1889 @param[in] NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
1890 current value of SendGUID.\r
1891 @param[in] NewTTL If not NULL, a pointer to be used in place of the current value of TTL,\r
1892 the "time to live" field of the IP header.\r
1893 @param[in] NewToS If not NULL, a pointer to be used in place of the current value of ToS,\r
1894 the "type of service" field of the IP header.\r
1895 @param[in] NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the\r
1896 current value of the MakeCallback field of the Mode structure.\r
1897\r
1898 @retval EFI_SUCCESS The new parameters values were updated.\r
1899 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1900 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1901\r
1902**/\r
1903EFI_STATUS\r
1904EFIAPI\r
1905EfiPxeBcSetParameters (\r
1906 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1907 IN BOOLEAN *NewAutoArp OPTIONAL,\r
1908 IN BOOLEAN *NewSendGUID OPTIONAL,\r
1909 IN UINT8 *NewTTL OPTIONAL,\r
1910 IN UINT8 *NewToS OPTIONAL,\r
1911 IN BOOLEAN *NewMakeCallback OPTIONAL\r
1912 )\r
1913{\r
1914 PXEBC_PRIVATE_DATA *Private;\r
1915 EFI_PXE_BASE_CODE_MODE *Mode;\r
1916 EFI_GUID SystemGuid;\r
1917 EFI_STATUS Status;\r
1918\r
1919 if (This == NULL) {\r
1920 return EFI_INVALID_PARAMETER;\r
1921 }\r
1922\r
1923 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1924 Mode = Private->PxeBc.Mode;\r
1925\r
1926 if (!Mode->Started) {\r
1927 return EFI_NOT_STARTED;\r
1928 }\r
1929\r
1930 if (NewMakeCallback != NULL) {\r
1931 if (*NewMakeCallback) {\r
1932 //\r
1933 // Update the previous PxeBcCallback protocol.\r
1934 //\r
1935 Status = gBS->HandleProtocol (\r
09cddd08 1936 Mode->UsingIpv6 ? Private->Ip6Nic->Controller : Private->Ip4Nic->Controller,\r
a3bcde70
HT
1937 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
1938 (VOID **) &Private->PxeBcCallback\r
1939 );\r
1940\r
1941 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r
1942 return EFI_INVALID_PARAMETER;\r
1943 }\r
1944 } else {\r
1945 Private->PxeBcCallback = NULL;\r
1946 }\r
1947 Mode->MakeCallbacks = *NewMakeCallback;\r
1948 }\r
1949\r
1950 if (NewSendGUID != NULL) {\r
19ddbb25 1951 if (*NewSendGUID && EFI_ERROR (NetLibGetSystemGuid (&SystemGuid))) {\r
ccd05ddd 1952 DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));\r
a3bcde70
HT
1953 return EFI_INVALID_PARAMETER;\r
1954 }\r
1955 Mode->SendGUID = *NewSendGUID;\r
1956 }\r
1957\r
1958 if (NewAutoArp != NULL) {\r
1959 Mode->AutoArp = *NewAutoArp;\r
1960 }\r
1961\r
1962 if (NewTTL != NULL) {\r
1963 Mode->TTL = *NewTTL;\r
1964 }\r
1965\r
1966 if (NewToS != NULL) {\r
1967 Mode->ToS = *NewToS;\r
1968 }\r
1969\r
1970 return EFI_SUCCESS;\r
1971}\r
1972\r
1973\r
1974/**\r
1975 Updates the station IP address and/or subnet mask values of a network device.\r
1976\r
1977 This function updates the station IP address and/or subnet mask values of a network\r
1978 device. The NewStationIp field is used to modify the network device's current IP address.\r
1979 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,\r
1980 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure\r
1981 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet\r
1982 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.\r
1983 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
1984 structure with NewSubnetMask.\r
1985\r
1986 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1987 @param[in] NewStationIp Pointer to the new IP address to be used by the network device.\r
1988 @param[in] NewSubnetMask Pointer to the new subnet mask to be used by the network device.\r
1989\r
1990 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r
1991 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1992 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1993\r
1994**/\r
1995EFI_STATUS\r
1996EFIAPI\r
1997EfiPxeBcSetStationIP (\r
1998 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1999 IN EFI_IP_ADDRESS *NewStationIp OPTIONAL,\r
2000 IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL\r
2001 )\r
2002{\r
2003 EFI_STATUS Status;\r
2004 PXEBC_PRIVATE_DATA *Private;\r
2005 EFI_PXE_BASE_CODE_MODE *Mode;\r
2006 EFI_ARP_CONFIG_DATA ArpConfigData;\r
2007\r
2008 if (This == NULL) {\r
2009 return EFI_INVALID_PARAMETER;\r
2010 }\r
2011\r
6c12fe63 2012 if (NewStationIp != NULL && !NetIp6IsValidUnicast (&NewStationIp->v6)) {\r
a3bcde70
HT
2013 return EFI_INVALID_PARAMETER;\r
2014 }\r
2015\r
2016 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2017 Mode = Private->PxeBc.Mode;\r
2018 Status = EFI_SUCCESS;\r
2019\r
2020 if (!Mode->UsingIpv6 &&\r
2021 NewSubnetMask != NULL &&\r
2022 !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {\r
2023 return EFI_INVALID_PARAMETER;\r
2024 }\r
2025\r
b3400560
FS
2026 if (!Mode->UsingIpv6 && NewStationIp != NULL) {\r
2027 if (IP4_IS_UNSPECIFIED(NTOHL (NewStationIp->Addr[0])) || \r
2028 IP4_IS_LOCAL_BROADCAST(NTOHL (NewStationIp->Addr[0])) ||\r
ba025280 2029 (NewSubnetMask != NULL && NewSubnetMask->Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), NTOHL (NewSubnetMask->Addr[0])))) {\r
b3400560
FS
2030 return EFI_INVALID_PARAMETER;\r
2031 }\r
6c12fe63 2032 }\r
b3400560 2033 \r
a3bcde70
HT
2034 if (!Mode->Started) {\r
2035 return EFI_NOT_STARTED;\r
2036 }\r
2037\r
2038 if (Mode->UsingIpv6 && NewStationIp != NULL) {\r
2039 //\r
2040 // Set the IPv6 address by Ip6Config protocol.\r
2041 //\r
2042 Status = PxeBcRegisterIp6Address (Private, &NewStationIp->v6);\r
2043 if (EFI_ERROR (Status)) {\r
2044 goto ON_EXIT;\r
2045 }\r
2046 } else if (!Mode->UsingIpv6 && NewStationIp != NULL) {\r
2047 //\r
2048 // Configure the corresponding ARP with the IPv4 address.\r
2049 //\r
2050 ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));\r
2051\r
2052 ArpConfigData.SwAddressType = 0x0800;\r
2053 ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);\r
2054 ArpConfigData.StationAddress = &NewStationIp->v4;\r
2055\r
2056 Private->Arp->Configure (Private->Arp, NULL);\r
2057 Private->Arp->Configure (Private->Arp, &ArpConfigData);\r
2058\r
2059 if (NewSubnetMask != NULL) {\r
2060 Mode->RouteTableEntries = 1;\r
2061 Mode->RouteTable[0].IpAddr.Addr[0] = NewStationIp->Addr[0] & NewSubnetMask->Addr[0];\r
2062 Mode->RouteTable[0].SubnetMask.Addr[0] = NewSubnetMask->Addr[0];\r
2063 Mode->RouteTable[0].GwAddr.Addr[0] = 0;\r
2064 }\r
2065\r
2066 Private->IsAddressOk = TRUE;\r
2067 }\r
2068\r
2069 if (NewStationIp != NULL) {\r
2070 CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r
2071 CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r
2072 }\r
2073\r
2074 if (!Mode->UsingIpv6 && NewSubnetMask != NULL) {\r
2075 CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r
2076 CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r
2077 }\r
2078\r
0e7f6f50 2079 Status = PxeBcFlushStationIp (Private, NewStationIp, NewSubnetMask);\r
a3bcde70
HT
2080ON_EXIT:\r
2081 return Status;\r
2082}\r
2083\r
2084\r
2085/**\r
2086 Updates the contents of the cached DHCP and Discover packets.\r
2087\r
2088 The pointers to the new packets are used to update the contents of the cached\r
2089 packets in the EFI_PXE_BASE_CODE_MODE structure.\r
2090\r
2091 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2092 @param[in] NewDhcpDiscoverValid Pointer to a value that will replace the current\r
2093 DhcpDiscoverValid field.\r
2094 @param[in] NewDhcpAckReceived Pointer to a value that will replace the current\r
2095 DhcpAckReceived field.\r
2096 @param[in] NewProxyOfferReceived Pointer to a value that will replace the current\r
2097 ProxyOfferReceived field.\r
2098 @param[in] NewPxeDiscoverValid Pointer to a value that will replace the current\r
2099 ProxyOfferReceived field.\r
2100 @param[in] NewPxeReplyReceived Pointer to a value that will replace the current\r
2101 PxeReplyReceived field.\r
2102 @param[in] NewPxeBisReplyReceived Pointer to a value that will replace the current\r
2103 PxeBisReplyReceived field.\r
2104 @param[in] NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.\r
2105 @param[in] NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r
2106 @param[in] NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r
2107 @param[in] NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r
2108 @param[in] NewPxeReply Pointer to the new cached PXE Reply packet contents.\r
2109 @param[in] NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\r
2110\r
2111 @retval EFI_SUCCESS The cached packet contents were updated.\r
2112 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
2113 @retval EFI_INVALID_PARAMETER This is NULL or does not point to a valid\r
2114 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
2115\r
2116**/\r
2117EFI_STATUS\r
2118EFIAPI\r
2119EfiPxeBcSetPackets (\r
2120 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
2121 IN BOOLEAN *NewDhcpDiscoverValid OPTIONAL,\r
2122 IN BOOLEAN *NewDhcpAckReceived OPTIONAL,\r
2123 IN BOOLEAN *NewProxyOfferReceived OPTIONAL,\r
2124 IN BOOLEAN *NewPxeDiscoverValid OPTIONAL,\r
2125 IN BOOLEAN *NewPxeReplyReceived OPTIONAL,\r
2126 IN BOOLEAN *NewPxeBisReplyReceived OPTIONAL,\r
2127 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover OPTIONAL,\r
2128 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpAck OPTIONAL,\r
2129 IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer OPTIONAL,\r
2130 IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover OPTIONAL,\r
2131 IN EFI_PXE_BASE_CODE_PACKET *NewPxeReply OPTIONAL,\r
2132 IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL\r
2133 )\r
2134{\r
2135 PXEBC_PRIVATE_DATA *Private;\r
2136 EFI_PXE_BASE_CODE_MODE *Mode;\r
2137\r
2138 if (This == NULL) {\r
2139 return EFI_INVALID_PARAMETER;\r
2140 }\r
2141\r
2142 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2143 Mode = Private->PxeBc.Mode;\r
2144\r
2145 if (!Mode->Started) {\r
2146 return EFI_NOT_STARTED;\r
2147 }\r
2148\r
2149 if (NewDhcpDiscoverValid != NULL) {\r
2150 Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;\r
2151 }\r
2152\r
2153 if (NewDhcpAckReceived != NULL) {\r
2154 Mode->DhcpAckReceived = *NewDhcpAckReceived;\r
2155 }\r
2156\r
2157 if (NewProxyOfferReceived != NULL) {\r
2158 Mode->ProxyOfferReceived = *NewProxyOfferReceived;\r
2159 }\r
2160\r
2161 if (NewPxeDiscoverValid != NULL) {\r
2162 Mode->PxeDiscoverValid = *NewPxeDiscoverValid;\r
2163 }\r
2164\r
2165 if (NewPxeReplyReceived != NULL) {\r
2166 Mode->PxeReplyReceived = *NewPxeReplyReceived;\r
2167 }\r
2168\r
2169 if (NewPxeBisReplyReceived != NULL) {\r
2170 Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;\r
2171 }\r
2172\r
2173 if (NewDhcpDiscover != NULL) {\r
2174 CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2175 }\r
2176\r
2177 if (NewDhcpAck != NULL) {\r
2178 CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2179 }\r
2180\r
2181 if (NewProxyOffer != NULL) {\r
2182 CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2183 }\r
2184\r
2185 if (NewPxeDiscover != NULL) {\r
2186 CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2187 }\r
2188\r
2189 if (NewPxeReply != NULL) {\r
2190 CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2191 }\r
2192\r
2193 if (NewPxeBisReply != NULL) {\r
2194 CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2195 }\r
2196\r
2197 return EFI_SUCCESS;\r
2198}\r
2199\r
2200EFI_PXE_BASE_CODE_PROTOCOL gPxeBcProtocolTemplate = {\r
2201 EFI_PXE_BASE_CODE_PROTOCOL_REVISION,\r
2202 EfiPxeBcStart,\r
2203 EfiPxeBcStop,\r
2204 EfiPxeBcDhcp,\r
2205 EfiPxeBcDiscover,\r
2206 EfiPxeBcMtftp,\r
2207 EfiPxeBcUdpWrite,\r
2208 EfiPxeBcUdpRead,\r
2209 EfiPxeBcSetIpFilter,\r
2210 EfiPxeBcArp,\r
2211 EfiPxeBcSetParameters,\r
2212 EfiPxeBcSetStationIP,\r
2213 EfiPxeBcSetPackets,\r
2214 NULL\r
2215};\r
2216\r
2217\r
2218/**\r
2219 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r
2220 received, or is waiting to receive a packet.\r
2221\r
2222 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,\r
2223 or is waiting to receive a packet. Parameters Function and Received specify the type of event.\r
2224 Parameters PacketLen and Packet specify the packet that generated the event. If these fields\r
2225 are zero and NULL respectively, then this is a status update callback. If the operation specified\r
2226 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation\r
2227 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to\r
2228 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.\r
2229 The SetParameters() function must be called after a Callback Protocol is installed to enable the\r
2230 use of callbacks.\r
2231\r
2232 @param[in] This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
2233 @param[in] Function The PXE Base Code Protocol function that is waiting for an event.\r
2234 @param[in] Received TRUE if the callback is being invoked due to a receive event. FALSE if\r
2235 the callback is being invoked due to a transmit event.\r
2236 @param[in] PacketLength The length, in bytes, of Packet. This field will have a value of zero if\r
2237 this is a wait for receive event.\r
2238 @param[in] PacketPtr If Received is TRUE, a pointer to the packet that was just received;\r
2239 otherwise a pointer to the packet that is about to be transmitted.\r
2240\r
2241 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE If Function specifies a continue operation.\r
2242 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT If Function specifies an abort operation.\r
2243\r
2244**/\r
2245EFI_PXE_BASE_CODE_CALLBACK_STATUS\r
2246EFIAPI\r
2247EfiPxeLoadFileCallback (\r
2248 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This,\r
2249 IN EFI_PXE_BASE_CODE_FUNCTION Function,\r
2250 IN BOOLEAN Received,\r
2251 IN UINT32 PacketLength,\r
2252 IN EFI_PXE_BASE_CODE_PACKET *PacketPtr OPTIONAL\r
2253 )\r
2254{\r
2255 EFI_INPUT_KEY Key;\r
2256 EFI_STATUS Status;\r
2257\r
2258 //\r
2259 // Catch Ctrl-C or ESC to abort.\r
2260 //\r
2261 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2262\r
2263 if (!EFI_ERROR (Status)) {\r
2264\r
2265 if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {\r
2266\r
2267 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;\r
2268 }\r
2269 }\r
2270 //\r
2271 // No print if receive packet\r
2272 //\r
2273 if (Received) {\r
2274 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2275 }\r
2276 //\r
2277 // Print only for three functions\r
2278 //\r
2279 switch (Function) {\r
2280\r
2281 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:\r
2282 //\r
2283 // Print only for open MTFTP packets, not every MTFTP packets\r
2284 //\r
2285 if (PacketLength != 0 && PacketPtr != NULL) {\r
2286 if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {\r
2287 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2288 }\r
2289 }\r
2290 break;\r
2291\r
2292 case EFI_PXE_BASE_CODE_FUNCTION_DHCP:\r
2293 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:\r
2294 break;\r
2295\r
2296 default:\r
2297 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2298 }\r
2299\r
2300 if (PacketLength != 0 && PacketPtr != NULL) {\r
2301 //\r
2302 // Print '.' when transmit a packet\r
2303 //\r
2304 AsciiPrint (".");\r
2305 }\r
2306\r
2307 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2308}\r
2309\r
2310EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL gPxeBcCallBackTemplate = {\r
2311 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,\r
2312 EfiPxeLoadFileCallback\r
2313};\r
2314\r
2315\r
2316/**\r
2317 Causes the driver to load a specified file.\r
2318\r
2319 @param[in] This Protocol instance pointer.\r
2320 @param[in] FilePath The device specific path of the file to load.\r
2321 @param[in] BootPolicy If TRUE, indicates that the request originates from the\r
2322 boot manager is attempting to load FilePath as a boot\r
2323 selection. If FALSE, then FilePath must match an exact file\r
2324 to be loaded.\r
2325 @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return\r
2326 code of EFI_SUCCESS, the amount of data transferred to\r
2327 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r
2328 the size of Buffer required to retrieve the requested file.\r
2329 @param[in] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,\r
2330 then no the size of the requested file is returned in\r
2331 BufferSize.\r
2332\r
2333 @retval EFI_SUCCESS The file was loaded.\r
2334 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy.\r
2335 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r
2336 BufferSize is NULL.\r
2337 @retval EFI_NO_MEDIA No medium was present to load the file.\r
2338 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.\r
2339 @retval EFI_NO_RESPONSE The remote system did not respond.\r
2340 @retval EFI_NOT_FOUND The file was not found.\r
2341 @retval EFI_ABORTED The file load process was manually cancelled.\r
2342\r
2343**/\r
2344EFI_STATUS\r
2345EFIAPI\r
2346EfiPxeLoadFile (\r
2347 IN EFI_LOAD_FILE_PROTOCOL *This,\r
2348 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
2349 IN BOOLEAN BootPolicy,\r
2350 IN OUT UINTN *BufferSize,\r
2351 IN VOID *Buffer OPTIONAL\r
2352 )\r
2353{\r
2354 PXEBC_PRIVATE_DATA *Private;\r
2355 PXEBC_VIRTUAL_NIC *VirtualNic;\r
2356 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r
2357 BOOLEAN UsingIpv6;\r
2358 EFI_STATUS Status;\r
152f2d5e 2359 EFI_STATUS MediaStatus;\r
a3bcde70 2360\r
bee14e9e 2361 if (This == NULL || BufferSize == NULL || FilePath == NULL || !IsDevicePathEnd (FilePath)) {\r
94d449f5
ZL
2362 return EFI_INVALID_PARAMETER;\r
2363 }\r
2364 \r
a3bcde70
HT
2365 //\r
2366 // Only support BootPolicy\r
2367 //\r
2368 if (!BootPolicy) {\r
2369 return EFI_UNSUPPORTED;\r
2370 }\r
bee14e9e
FS
2371 \r
2372 VirtualNic = PXEBC_VIRTUAL_NIC_FROM_LOADFILE (This);\r
2373 Private = VirtualNic->Private;\r
2374 PxeBc = &Private->PxeBc;\r
2375 UsingIpv6 = FALSE;\r
2376 Status = EFI_DEVICE_ERROR;\r
a3bcde70
HT
2377\r
2378 //\r
2379 // Check media status before PXE start\r
2380 //\r
152f2d5e 2381 MediaStatus = EFI_SUCCESS;\r
2382 NetLibDetectMediaWaitTimeout (Private->Controller, PXEBC_CHECK_MEDIA_WAITING_TIME, &MediaStatus);\r
2383 if (MediaStatus != EFI_SUCCESS) {\r
a3bcde70
HT
2384 return EFI_NO_MEDIA;\r
2385 }\r
2386\r
2387 //\r
2388 // Check whether the virtual nic is using IPv6 or not.\r
2389 //\r
2390 if (VirtualNic == Private->Ip6Nic) {\r
2391 UsingIpv6 = TRUE;\r
2392 }\r
2393\r
2394 //\r
2395 // Start Pxe Base Code to initialize PXE boot.\r
2396 //\r
2397 Status = PxeBc->Start (PxeBc, UsingIpv6);\r
75dce340 2398 if (Status == EFI_ALREADY_STARTED && UsingIpv6 != PxeBc->Mode->UsingIpv6) {\r
2399 //\r
2400 // PxeBc protocol has already been started but not on the required IP version, restart it.\r
2401 //\r
2402 Status = PxeBc->Stop (PxeBc);\r
2403 if (!EFI_ERROR (Status)) {\r
2404 Status = PxeBc->Start (PxeBc, UsingIpv6);\r
2405 }\r
2406 }\r
a3bcde70
HT
2407 if (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED) {\r
2408 Status = PxeBcLoadBootFile (Private, BufferSize, Buffer);\r
2409 }\r
2410\r
2411 if (Status != EFI_SUCCESS &&\r
2412 Status != EFI_UNSUPPORTED &&\r
2413 Status != EFI_BUFFER_TOO_SMALL) {\r
2414 //\r
2415 // There are three cases, which needn't stop pxebc here.\r
2416 // 1. success to download file.\r
2417 // 2. success to get file size.\r
2418 // 3. unsupported.\r
2419 //\r
2420 PxeBc->Stop (PxeBc);\r
c4764504
FS
2421 } else {\r
2422 //\r
2423 // The DHCP4 can have only one configured child instance so we need to stop\r
2424 // reset the DHCP4 child before we return. Otherwise these programs which \r
2425 // also need to use DHCP4 will be impacted.\r
2426 //\r
2427 if (!PxeBc->Mode->UsingIpv6) {\r
2428 Private->Dhcp4->Stop (Private->Dhcp4);\r
2429 Private->Dhcp4->Configure (Private->Dhcp4, NULL);\r
2430 }\r
a3bcde70
HT
2431 }\r
2432\r
2433 return Status;\r
2434}\r
2435\r
2436EFI_LOAD_FILE_PROTOCOL gLoadFileProtocolTemplate = { EfiPxeLoadFile };\r
2437\r