]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
1. Support netboot6 tftp URL format like tftp://[aaaa::bbbb]/myfile.efi;mode=octet...
[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcImpl.c
CommitLineData
dc361cc5 1/** @file\r
f737cfb9 2 Interface routines for PxeBc.\r
e2851998 3\r
c82291bc 4Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
e5eed7d3 5This program and the accompanying materials\r
dc361cc5 6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
dc361cc5 13**/\r
14\r
15\r
16#include "PxeBcImpl.h"\r
17\r
434ce3fe 18UINT32 mPxeDhcpTimeout[4] = { 4, 8, 16, 32 };\r
f737cfb9 19\r
982a9eae 20/**\r
f737cfb9 21 Get and record the arp cache.\r
982a9eae 22\r
23 @param This Pointer to EFI_PXE_BC_PROTOCOL\r
24\r
25 @retval EFI_SUCCESS Arp cache updated successfully\r
f737cfb9 26 @retval others If error occurs when getting arp cache\r
982a9eae 27\r
28**/\r
982a9eae 29EFI_STATUS\r
30UpdateArpCache (\r
31 IN EFI_PXE_BASE_CODE_PROTOCOL * This\r
32 )\r
33{\r
34 PXEBC_PRIVATE_DATA *Private;\r
35 EFI_PXE_BASE_CODE_MODE *Mode;\r
36 EFI_STATUS Status;\r
37 UINT32 EntryLength;\r
38 UINT32 EntryCount;\r
39 EFI_ARP_FIND_DATA *Entries;\r
40 UINT32 Index;\r
41\r
42 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
43 Mode = Private->PxeBc.Mode;\r
44\r
f737cfb9 45 Status = Private->Arp->Find (\r
46 Private->Arp,\r
47 TRUE,\r
48 NULL,\r
49 &EntryLength,\r
50 &EntryCount,\r
51 &Entries,\r
52 TRUE\r
53 );\r
982a9eae 54 if (EFI_ERROR (Status)) {\r
55 return Status;\r
56 }\r
57\r
f737cfb9 58 Mode->ArpCacheEntries = MIN (\r
59 EntryCount,\r
60 EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES\r
61 );\r
982a9eae 62 for (Index = 0; Index < Mode->ArpCacheEntries; Index ++) {\r
f737cfb9 63 CopyMem (\r
e2851998 64 &Mode->ArpCache[Index].IpAddr,\r
65 Entries + 1,\r
f737cfb9 66 Entries->SwAddressLength\r
67 );\r
68 CopyMem (\r
69 &Mode->ArpCache[Index].MacAddr,\r
70 (UINT8 *) (Entries + 1) + Entries->SwAddressLength,\r
71 Entries->HwAddressLength\r
72 );\r
982a9eae 73 //\r
74 // Slip to the next FindData.\r
75 //\r
f737cfb9 76 Entries = (EFI_ARP_FIND_DATA *) ((UINT8 *) Entries + EntryLength);\r
982a9eae 77 }\r
78\r
79 return EFI_SUCCESS;\r
80}\r
81\r
82/**\r
f737cfb9 83 Timeout routine to update arp cache.\r
982a9eae 84\r
85 @param Event Pointer to EFI_PXE_BC_PROTOCOL\r
86 @param Context Context of the timer event\r
87\r
88**/\r
982a9eae 89VOID\r
90EFIAPI\r
91ArpCacheUpdateTimeout (\r
92 IN EFI_EVENT Event,\r
93 IN VOID *Context\r
94 )\r
95{\r
96 UpdateArpCache ((EFI_PXE_BASE_CODE_PROTOCOL *) Context);\r
97}\r
98\r
99/**\r
f737cfb9 100 Do arp resolution from arp cache in PxeBcMode.\r
e2851998 101\r
f737cfb9 102 @param PxeBcMode The PXE BC mode to look into.\r
103 @param Ip4Addr The Ip4 address for resolution.\r
104 @param MacAddress The resoluted MAC address if the resolution is successful.\r
105 The value is undefined if resolution fails.\r
e2851998 106\r
f737cfb9 107 @retval TRUE The resolution is successful.\r
108 @retval FALSE Otherwise.\r
982a9eae 109\r
110**/\r
982a9eae 111BOOLEAN\r
112FindInArpCache (\r
f737cfb9 113 IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,\r
114 IN EFI_IPv4_ADDRESS *Ip4Addr,\r
115 OUT EFI_MAC_ADDRESS *MacAddress\r
982a9eae 116 )\r
117{\r
118 UINT32 Index;\r
119\r
120 for (Index = 0; Index < PxeBcMode->ArpCacheEntries; Index ++) {\r
121 if (EFI_IP4_EQUAL (&PxeBcMode->ArpCache[Index].IpAddr.v4, Ip4Addr)) {\r
f737cfb9 122 CopyMem (\r
123 MacAddress,\r
124 &PxeBcMode->ArpCache[Index].MacAddr,\r
125 sizeof (EFI_MAC_ADDRESS)\r
126 );\r
982a9eae 127 return TRUE;\r
128 }\r
129 }\r
130\r
131 return FALSE;\r
132}\r
133\r
134/**\r
135 Notify function for the ICMP receive token, used to process\r
136 the received ICMP packets.\r
137\r
f737cfb9 138 @param Context The PXEBC private data.\r
982a9eae 139\r
982a9eae 140**/\r
982a9eae 141VOID\r
142EFIAPI\r
143IcmpErrorListenHandlerDpc (\r
144 IN VOID *Context\r
145 )\r
146{\r
147 EFI_STATUS Status;\r
148 EFI_IP4_RECEIVE_DATA *RxData;\r
149 EFI_IP4_PROTOCOL *Ip4;\r
150 PXEBC_PRIVATE_DATA *Private;\r
151 EFI_PXE_BASE_CODE_MODE *Mode;\r
152 UINTN Index;\r
153 UINT32 CopiedLen;\r
154 UINT8 *CopiedPointer;\r
155\r
156 Private = (PXEBC_PRIVATE_DATA *) Context;\r
157 Mode = &Private->Mode;\r
158 Status = Private->IcmpErrorRcvToken.Status;\r
159 RxData = Private->IcmpErrorRcvToken.Packet.RxData;\r
160 Ip4 = Private->Ip4;\r
161\r
f737cfb9 162 if (Status == EFI_ABORTED) {\r
982a9eae 163 //\r
164 // The reception is actively aborted by the consumer, directly return.\r
165 //\r
166 return;\r
167 }\r
168\r
f737cfb9 169 if (EFI_ERROR (Status) || (RxData == NULL)) {\r
982a9eae 170 //\r
171 // Only process the normal packets and the icmp error packets, if RxData is NULL\r
172 // with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although\r
173 // this should be a bug of the low layer (IP).\r
174 //\r
175 goto Resume;\r
176 }\r
177\r
f737cfb9 178 if (EFI_IP4 (RxData->Header->SourceAddress) != 0 &&\r
f6b7393c 179 !NetIp4IsUnicast (EFI_NTOHL (RxData->Header->SourceAddress), 0)) {\r
982a9eae 180 //\r
181 // The source address is not zero and it's not a unicast IP address, discard it.\r
182 //\r
183 goto CleanUp;\r
184 }\r
185\r
186 if (!EFI_IP4_EQUAL (&RxData->Header->DestinationAddress, &Mode->StationIp.v4)) {\r
187 //\r
188 // The dest address is not equal to Station Ip address, discard it.\r
189 //\r
190 goto CleanUp;\r
191 }\r
192\r
193 //\r
194 // Constructor ICMP error packet\r
195 //\r
196 CopiedLen = 0;\r
197 CopiedPointer = (UINT8 *) &Mode->IcmpError;\r
198\r
199 for (Index = 0; Index < RxData->FragmentCount; Index ++) {\r
200 CopiedLen += RxData->FragmentTable[Index].FragmentLength;\r
201 if (CopiedLen <= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)) {\r
f737cfb9 202 CopyMem (\r
203 CopiedPointer,\r
204 RxData->FragmentTable[Index].FragmentBuffer,\r
205 RxData->FragmentTable[Index].FragmentLength\r
206 );\r
982a9eae 207 } else {\r
f737cfb9 208 CopyMem (\r
209 CopiedPointer,\r
210 RxData->FragmentTable[Index].FragmentBuffer,\r
211 CopiedLen - sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)\r
212 );\r
982a9eae 213 }\r
214 CopiedPointer += CopiedLen;\r
215 }\r
216\r
217 goto Resume;\r
218\r
219CleanUp:\r
220 gBS->SignalEvent (RxData->RecycleSignal);\r
221\r
222Resume:\r
223 Ip4->Receive (Ip4, &(Private->IcmpErrorRcvToken));\r
224}\r
225\r
226/**\r
227 Request IcmpErrorListenHandlerDpc as a DPC at TPL_CALLBACK\r
228\r
229 @param Event The event signaled.\r
230 @param Context The context passed in by the event notifier.\r
231\r
982a9eae 232**/\r
982a9eae 233VOID\r
234EFIAPI\r
235IcmpErrorListenHandler (\r
236 IN EFI_EVENT Event,\r
237 IN VOID *Context\r
238 )\r
239{\r
240 //\r
241 // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK\r
242 //\r
d8d26fb2 243 QueueDpc (TPL_CALLBACK, IcmpErrorListenHandlerDpc, Context);\r
982a9eae 244}\r
dc361cc5 245\r
e2851998 246/**\r
f737cfb9 247 Enables the use of the PXE Base Code Protocol functions.\r
248\r
249 This function enables the use of the PXE Base Code Protocol functions. If the\r
250 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then\r
251 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted\r
252 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted\r
253 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported\r
254 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will\r
255 be returned. If there is not enough memory or other resources to start the PXE\r
256 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the\r
257 PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE\r
258 structure will be initialized as follows:\r
259 StartedSet to TRUE.\r
260 Ipv6SupportedUnchanged.\r
261 Ipv6AvailableUnchanged.\r
262 UsingIpv6Set to UseIpv6.\r
263 BisSupportedUnchanged.\r
264 BisDetectedUnchanged.\r
265 AutoArpSet to TRUE.\r
266 SendGUIDSet to FALSE.\r
267 TTLSet to DEFAULT_TTL.\r
268 ToSSet to DEFAULT_ToS.\r
269 DhcpCompletedSet to FALSE.\r
270 ProxyOfferReceivedSet to FALSE.\r
271 StationIpSet to an address of all zeros.\r
272 SubnetMaskSet to a subnet mask of all zeros.\r
273 DhcpDiscoverZero-filled.\r
274 DhcpAckZero-filled.\r
275 ProxyOfferZero-filled.\r
276 PxeDiscoverValidSet to FALSE.\r
277 PxeDiscoverZero-filled.\r
278 PxeReplyValidSet to FALSE.\r
279 PxeReplyZero-filled.\r
280 PxeBisReplyValidSet to FALSE.\r
281 PxeBisReplyZero-filled.\r
282 IpFilterSet the Filters field to 0 and the IpCnt field to 0.\r
283 ArpCacheEntriesSet to 0.\r
284 ArpCacheZero-filled.\r
285 RouteTableEntriesSet to 0.\r
286 RouteTableZero-filled.\r
287 IcmpErrorReceivedSet to FALSE.\r
288 IcmpErrorZero-filled.\r
289 TftpErroReceivedSet to FALSE.\r
290 TftpErrorZero-filled.\r
291 MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.\r
292 Set to FALSE if the PXE Base Code Callback Protocol is not available.\r
e2851998 293\r
f737cfb9 294 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
295 @param UseIpv6 Specifies the type of IP addresses that are to be used during the session\r
e2851998 296 that is being started. Set to TRUE for IPv6 addresses, and FALSE for\r
297 IPv4 addresses.\r
298\r
f737cfb9 299 @retval EFI_SUCCESS The PXE Base Code Protocol was started.\r
e2851998 300 @retval EFI_DEVICE_ERROR The network device encountered an error during this oper\r
f737cfb9 301 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the\r
e2851998 302 EFI_PXE_BASE_CODE_MODE structure is FALSE.\r
303 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.\r
f737cfb9 304 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
e2851998 305 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
306 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the\r
307 PXE Base Code Protocol.\r
308\r
dc361cc5 309**/\r
310EFI_STATUS\r
311EFIAPI\r
312EfiPxeBcStart (\r
313 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
314 IN BOOLEAN UseIpv6\r
315 )\r
316{\r
317 PXEBC_PRIVATE_DATA *Private;\r
318 EFI_PXE_BASE_CODE_MODE *Mode;\r
319 EFI_STATUS Status;\r
320\r
321 if (This == NULL) {\r
322 return EFI_INVALID_PARAMETER;\r
323 }\r
324\r
325 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
326 Mode = Private->PxeBc.Mode;\r
327\r
328 if (Mode->Started) {\r
329 return EFI_ALREADY_STARTED;\r
330 }\r
331\r
332 if (UseIpv6) {\r
333 //\r
334 // IPv6 is not supported now.\r
335 //\r
336 return EFI_UNSUPPORTED;\r
337 }\r
338\r
339 //\r
340 // Configure the udp4 instance to let it receive data\r
341 //\r
f737cfb9 342 Status = Private->Udp4Read->Configure (\r
e2851998 343 Private->Udp4Read,\r
f737cfb9 344 &Private->Udp4CfgData\r
345 );\r
dc361cc5 346 if (EFI_ERROR (Status)) {\r
347 return Status;\r
348 }\r
349\r
cfbc1a75 350\r
351 //\r
352 // Configure block size for TFTP as a default value to handle all link layers.\r
353 // \r
354 Private->BlockSize = (UINTN) (MIN (Private->Ip4MaxPacketSize, PXEBC_DEFAULT_PACKET_SIZE) - \r
355 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE);\r
356 //\r
357 // If PcdTftpBlockSize is set to non-zero, override the default value.\r
358 //\r
359 if (PcdGet64 (PcdTftpBlockSize) != 0) {\r
360 Private->BlockSize = (UINTN) PcdGet64 (PcdTftpBlockSize);\r
361 }\r
362 \r
dc361cc5 363 Private->AddressIsOk = FALSE;\r
364\r
365 ZeroMem (Mode, sizeof (EFI_PXE_BASE_CODE_MODE));\r
366\r
367 Mode->Started = TRUE;\r
368 Mode->TTL = DEFAULT_TTL;\r
369 Mode->ToS = DEFAULT_ToS;\r
370 Mode->AutoArp = TRUE;\r
371\r
982a9eae 372 //\r
373 // Create the event for Arp Cache checking.\r
374 //\r
375 Status = gBS->CreateEvent (\r
376 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
377 TPL_CALLBACK,\r
378 ArpCacheUpdateTimeout,\r
379 This,\r
380 &Private->GetArpCacheEvent\r
381 );\r
382 if (EFI_ERROR (Status)) {\r
383 goto ON_EXIT;\r
384 }\r
385\r
386 //\r
387 // Start the timeout timer event.\r
388 //\r
389 Status = gBS->SetTimer (\r
390 Private->GetArpCacheEvent,\r
391 TimerPeriodic,\r
392 TICKS_PER_SECOND\r
393 );\r
394\r
395 if (EFI_ERROR (Status)) {\r
396 goto ON_EXIT;\r
397 }\r
398\r
399 //\r
400 // Create ICMP error receiving event\r
401 //\r
402 Status = gBS->CreateEvent (\r
403 EVT_NOTIFY_SIGNAL,\r
404 TPL_NOTIFY,\r
405 IcmpErrorListenHandler,\r
406 Private,\r
407 &(Private->IcmpErrorRcvToken.Event)\r
408 );\r
409 if (EFI_ERROR (Status)) {\r
410 goto ON_EXIT;\r
411 }\r
412\r
413 Status = Private->Ip4->Configure (Private->Ip4, &Private->Ip4ConfigData);\r
414 if (EFI_ERROR (Status)) {\r
415 goto ON_EXIT;\r
416 }\r
417\r
418 //\r
419 // start to listen incoming packet\r
420 //\r
421 Status = Private->Ip4->Receive (Private->Ip4, &Private->IcmpErrorRcvToken);\r
422 if (!EFI_ERROR (Status)) {\r
423 return Status;\r
424 }\r
425\r
426ON_EXIT:\r
427 Private->Ip4->Configure (Private->Ip4, NULL);\r
428\r
429 if (Private->IcmpErrorRcvToken.Event != NULL) {\r
430 gBS->CloseEvent (Private->IcmpErrorRcvToken.Event);\r
431 }\r
432\r
433 if (Private->GetArpCacheEvent != NULL) {\r
434 gBS->SetTimer (Private->GetArpCacheEvent, TimerCancel, 0);\r
435 gBS->CloseEvent (Private->GetArpCacheEvent);\r
436 }\r
437\r
438 Mode->Started = FALSE;\r
439 Mode->TTL = 0;\r
440 Mode->ToS = 0;\r
441 Mode->AutoArp = FALSE;\r
442\r
443 return Status;\r
dc361cc5 444}\r
445\r
446\r
e2851998 447/**\r
f737cfb9 448 Disables the use of the PXE Base Code Protocol functions.\r
449\r
450 This function stops all activity on the network device. All the resources allocated\r
451 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is\r
452 set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE\r
453 structure is already FALSE, then EFI_NOT_STARTED will be returned.\r
e2851998 454\r
f737cfb9 455 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
e2851998 456\r
f737cfb9 457 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r
e2851998 458 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.\r
f737cfb9 459 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
e2851998 460 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
461 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
462\r
dc361cc5 463**/\r
464EFI_STATUS\r
465EFIAPI\r
466EfiPxeBcStop (\r
467 IN EFI_PXE_BASE_CODE_PROTOCOL *This\r
468 )\r
469{\r
470 PXEBC_PRIVATE_DATA *Private;\r
471 EFI_PXE_BASE_CODE_MODE *Mode;\r
472\r
473 if (This == NULL) {\r
474 return EFI_INVALID_PARAMETER;\r
475 }\r
476\r
477 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
478 Mode = Private->PxeBc.Mode;\r
479\r
480 if (!Mode->Started) {\r
481 return EFI_NOT_STARTED;\r
482 }\r
483\r
982a9eae 484 Private->Ip4->Cancel (Private->Ip4, NULL);\r
485 //\r
486 // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r
487 // events.\r
488 //\r
d8d26fb2 489 DispatchDpc ();\r
982a9eae 490\r
491 Private->Ip4->Configure (Private->Ip4, NULL);\r
492\r
493 //\r
494 // Close the ICMP error receiving event.\r
495 //\r
496 gBS->CloseEvent (Private->IcmpErrorRcvToken.Event);\r
497\r
498 //\r
499 // Cancel the TimeoutEvent timer.\r
500 //\r
501 gBS->SetTimer (Private->GetArpCacheEvent, TimerCancel, 0);\r
502\r
503 //\r
504 // Close the TimeoutEvent event.\r
505 //\r
506 gBS->CloseEvent (Private->GetArpCacheEvent);\r
507\r
dc361cc5 508 Mode->Started = FALSE;\r
509\r
8792362f 510 Private->CurrentUdpSrcPort = 0;\r
511 Private->Udp4Write->Configure (Private->Udp4Write, NULL);\r
434ce3fe 512 Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);\r
8792362f 513 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
dc361cc5 514\r
515 Private->Dhcp4->Stop (Private->Dhcp4);\r
516 Private->Dhcp4->Configure (Private->Dhcp4, NULL);\r
517\r
518 Private->FileSize = 0;\r
519\r
520 return EFI_SUCCESS;\r
521}\r
522\r
523\r
e2851998 524/**\r
f737cfb9 525 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6\r
526 S.A.R.R (solicit / advertise / request / reply) sequence.\r
527\r
528 This function attempts to complete the DHCP sequence. If this sequence is completed,\r
529 then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp,\r
530 SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE\r
531 structure are filled in.\r
532 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before\r
533 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will\r
534 be tried in the order in which they are received. Please see the Preboot Execution\r
535 Environment (PXE) Specification for additional details on the implementation of DHCP.\r
536 This function can take at least 31 seconds to timeout and return control to the\r
537 caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.\r
538 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
539 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.\r
e2851998 540\r
f737cfb9 541 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
542 @param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the\r
e2851998 543 offers in the order that they are received.\r
544\r
f737cfb9 545 @retval EFI_SUCCESS Valid DHCP has completed.\r
546 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
547 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
e2851998 548 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
549 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
f737cfb9 550 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.\r
551 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.\r
552 @retval EFI_TIMEOUT The DHCP Protocol timed out.\r
553 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.\r
554 @retval EFI_NO_RESPONSE Valid PXE offer was not received.\r
e2851998 555\r
dc361cc5 556**/\r
557EFI_STATUS\r
558EFIAPI\r
559EfiPxeBcDhcp (\r
560 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
561 IN BOOLEAN SortOffers\r
562 )\r
563{\r
8730386e 564 PXEBC_PRIVATE_DATA *Private;\r
565 EFI_PXE_BASE_CODE_MODE *Mode;\r
566 EFI_DHCP4_PROTOCOL *Dhcp4;\r
567 EFI_DHCP4_CONFIG_DATA Dhcp4CfgData;\r
568 EFI_DHCP4_MODE_DATA Dhcp4Mode;\r
569 EFI_DHCP4_PACKET_OPTION *OptList[PXEBC_DHCP4_MAX_OPTION_NUM];\r
570 UINT32 OptCount;\r
571 EFI_STATUS Status;\r
572 EFI_ARP_CONFIG_DATA ArpConfigData;\r
573 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
dc361cc5 574\r
575 if (This == NULL) {\r
576 return EFI_INVALID_PARAMETER;\r
577 }\r
578\r
579 Status = EFI_SUCCESS;\r
580 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
581 Mode = Private->PxeBc.Mode;\r
582 Dhcp4 = Private->Dhcp4;\r
583 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;\r
584 Private->SortOffers = SortOffers;\r
585\r
586 if (!Mode->Started) {\r
587 return EFI_NOT_STARTED;\r
588 }\r
982a9eae 589\r
590 Mode->IcmpErrorReceived = FALSE;\r
591\r
8730386e 592 //\r
593 // Stop Udp4Read instance\r
594 //\r
595 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
596\r
dc361cc5 597 //\r
598 // Initialize the DHCP options and build the option list\r
599 //\r
600 OptCount = PxeBcBuildDhcpOptions (Private, OptList, TRUE);\r
601\r
602 //\r
603 // Set the DHCP4 config data.\r
434ce3fe 604 // The four discovery timeouts are 4, 8, 16, 32 seconds respectively.\r
dc361cc5 605 //\r
e48e37fc 606 ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));\r
dc361cc5 607 Dhcp4CfgData.OptionCount = OptCount;\r
608 Dhcp4CfgData.OptionList = OptList;\r
609 Dhcp4CfgData.Dhcp4Callback = PxeBcDhcpCallBack;\r
610 Dhcp4CfgData.CallbackContext = Private;\r
434ce3fe 611 Dhcp4CfgData.DiscoverTryCount = 4;\r
612 Dhcp4CfgData.DiscoverTimeout = mPxeDhcpTimeout;\r
dc361cc5 613\r
434ce3fe 614 Status = Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);\r
615 if (EFI_ERROR (Status)) {\r
616 goto ON_EXIT;\r
617 }\r
e2851998 618\r
434ce3fe 619 //\r
620 // Zero those arrays to record the varies numbers of DHCP OFFERS.\r
621 //\r
622 Private->GotProxyOffer = FALSE;\r
623 Private->NumOffers = 0;\r
624 Private->BootpIndex = 0;\r
625 ZeroMem (Private->ServerCount, sizeof (Private->ServerCount));\r
626 ZeroMem (Private->ProxyIndex, sizeof (Private->ProxyIndex));\r
dc361cc5 627\r
434ce3fe 628 Status = Dhcp4->Start (Dhcp4, NULL);\r
629 if (EFI_ERROR (Status)) {\r
630 if (Status == EFI_ICMP_ERROR) {\r
631 Mode->IcmpErrorReceived = TRUE;\r
dc361cc5 632 }\r
434ce3fe 633 goto ON_EXIT;\r
634 }\r
dc361cc5 635\r
434ce3fe 636 Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4Mode);\r
637 if (EFI_ERROR (Status)) {\r
638 goto ON_EXIT;\r
639 }\r
dc361cc5 640\r
434ce3fe 641 ASSERT (Dhcp4Mode.State == Dhcp4Bound);\r
dc361cc5 642\r
434ce3fe 643 CopyMem (&Private->StationIp, &Dhcp4Mode.ClientAddress, sizeof (EFI_IPv4_ADDRESS));\r
644 CopyMem (&Private->SubnetMask, &Dhcp4Mode.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
645 CopyMem (&Private->GatewayIp, &Dhcp4Mode.RouterAddress, sizeof (EFI_IPv4_ADDRESS));\r
319075ff 646\r
434ce3fe 647 CopyMem (&Mode->StationIp, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r
648 CopyMem (&Mode->SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 649\r
434ce3fe 650 //\r
651 // Check the selected offer to see whether BINL is required, if no or BINL is\r
652 // finished, set the various Mode members.\r
653 //\r
654 Status = PxeBcCheckSelectedOffer (Private);\r
655 if (!EFI_ERROR (Status)) {\r
656 goto ON_EXIT;\r
dc361cc5 657 }\r
658\r
434ce3fe 659ON_EXIT:\r
dc361cc5 660 if (EFI_ERROR (Status)) {\r
661 Dhcp4->Stop (Dhcp4);\r
662 Dhcp4->Configure (Dhcp4, NULL);\r
663 } else {\r
664 //\r
665 // Remove the previously configured option list and callback function\r
666 //\r
e48e37fc 667 ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));\r
dc361cc5 668 Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);\r
669\r
670 Private->AddressIsOk = TRUE;\r
8d285ec0 671\r
672 if (!Mode->UsingIpv6) {\r
673 //\r
674 // If in IPv4 mode, configure the corresponding ARP with this new\r
675 // station IP address.\r
676 //\r
677 ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));\r
678\r
679 ArpConfigData.SwAddressType = 0x0800;\r
c9325700 680 ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);\r
8d285ec0 681 ArpConfigData.StationAddress = &Private->StationIp.v4;\r
682\r
683 Private->Arp->Configure (Private->Arp, NULL);\r
684 Private->Arp->Configure (Private->Arp, &ArpConfigData);\r
982a9eae 685\r
686 //\r
687 // Updated the route table. Fill the first entry.\r
688 //\r
689 Mode->RouteTableEntries = 1;\r
690 Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];\r
691 Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];\r
692 Mode->RouteTable[0].GwAddr.Addr[0] = 0;\r
693\r
694 //\r
695 // Create the default route entry if there is a default router.\r
696 //\r
697 if (Private->GatewayIp.Addr[0] != 0) {\r
698 Mode->RouteTableEntries = 2;\r
699 Mode->RouteTable[1].IpAddr.Addr[0] = 0;\r
700 Mode->RouteTable[1].SubnetMask.Addr[0] = 0;\r
701 Mode->RouteTable[1].GwAddr.Addr[0] = Private->GatewayIp.Addr[0];\r
702 }\r
8730386e 703\r
704 //\r
705 // Flush new station IP address into Udp4CfgData and Ip4ConfigData\r
706 //\r
707 CopyMem (&Private->Udp4CfgData.StationAddress, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r
708 CopyMem (&Private->Udp4CfgData.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
709 CopyMem (&Private->Ip4ConfigData.StationAddress, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r
710 CopyMem (&Private->Ip4ConfigData.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
711 \r
712 //\r
713 // Reconfigure the Ip4 instance to capture background ICMP packets with new station Ip address.\r
714 //\r
715 Private->Ip4->Cancel (Private->Ip4, &Private->IcmpErrorRcvToken);\r
716 Private->Ip4->Configure (Private->Ip4, NULL);\r
717 \r
718 Status = Private->Ip4->Configure (Private->Ip4, &Private->Ip4ConfigData);\r
719 if (EFI_ERROR (Status)) {\r
720 goto ON_EXIT;\r
721 }\r
722 \r
723 Status = Private->Ip4->Receive (Private->Ip4, &Private->IcmpErrorRcvToken);\r
724 if (EFI_ERROR (Status)) {\r
725 goto ON_EXIT;\r
726 } \r
8d285ec0 727 }\r
dc361cc5 728 }\r
729\r
c82291bc 730 Status = Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
731\r
8730386e 732 //\r
733 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r
734 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
735 //\r
736 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
737 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
738 This->SetIpFilter (This, &IpFilter);\r
739 \r
dc361cc5 740 return Status;\r
741}\r
742\r
743\r
e2851998 744/**\r
f737cfb9 745 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.\r
746\r
747 This function attempts to complete the PXE Boot Server and/or boot image discovery\r
748 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the\r
749 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the\r
750 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the\r
751 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure\r
752 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.\r
753 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],\r
754 has two uses: It is the Boot Server IP address list used for unicast discovery\r
755 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification\r
756 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure\r
757 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot\r
758 Server reply of that type will be accepted. If the AcceptAnyResponse field is\r
759 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.\r
760 This function can take at least 10 seconds to timeout and return control to the\r
761 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be\r
762 returned. Please see the Preboot Execution Environment (PXE) Specification for\r
763 additional details on the implementation of the Discovery sequence.\r
764 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
765 then the Discovery sequence is stopped and EFI_ABORTED will be returned.\r
e2851998 766\r
f737cfb9 767 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
768 @param Type The type of bootstrap to perform.\r
769 @param Layer Pointer to the boot server layer number to discover, which must be\r
e2851998 770 PXE_BOOT_LAYER_INITIAL when a new server type is being\r
771 discovered.\r
772 @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.\r
f737cfb9 773 @param Info Pointer to a data structure that contains additional information on the\r
e2851998 774 type of discovery operation that is to be performed.\r
775\r
f737cfb9 776 @retval EFI_SUCCESS The Discovery sequence has been completed.\r
777 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 778 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
779 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
f737cfb9 780 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.\r
781 @retval EFI_ABORTED The callback function aborted the Discovery sequence.\r
782 @retval EFI_TIMEOUT The Discovery sequence timed out.\r
783 @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery\r
e2851998 784 session.\r
785\r
dc361cc5 786**/\r
787EFI_STATUS\r
788EFIAPI\r
789EfiPxeBcDiscover (\r
790 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
791 IN UINT16 Type,\r
792 IN UINT16 *Layer,\r
793 IN BOOLEAN UseBis,\r
794 IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL\r
795 )\r
796{\r
797 PXEBC_PRIVATE_DATA *Private;\r
798 EFI_PXE_BASE_CODE_MODE *Mode;\r
799 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo;\r
29a4f92d 800 EFI_PXE_BASE_CODE_DISCOVER_INFO *CreatedInfo;\r
dc361cc5 801 EFI_PXE_BASE_CODE_SRVLIST *SrvList;\r
802 EFI_PXE_BASE_CODE_SRVLIST DefaultSrvList;\r
803 PXEBC_CACHED_DHCP4_PACKET *Packet;\r
f737cfb9 804 PXEBC_VENDOR_OPTION *VendorOpt;\r
dc361cc5 805 UINT16 Index;\r
806 EFI_STATUS Status;\r
807 PXEBC_BOOT_SVR_ENTRY *BootSvrEntry;\r
8730386e 808 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
dc361cc5 809\r
810 if (This == NULL) {\r
811 return EFI_INVALID_PARAMETER;\r
812 }\r
813\r
814 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
815 Mode = Private->PxeBc.Mode;\r
816 BootSvrEntry = NULL;\r
817 SrvList = NULL;\r
29a4f92d 818 CreatedInfo = NULL;\r
dc361cc5 819 Status = EFI_DEVICE_ERROR;\r
820 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;\r
821\r
822 if (!Private->AddressIsOk) {\r
823 return EFI_INVALID_PARAMETER;\r
824 }\r
825\r
826 if (!Mode->Started) {\r
827 return EFI_NOT_STARTED;\r
828 }\r
829\r
8730386e 830 //\r
831 // Stop Udp4Read instance\r
832 //\r
833 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
834\r
982a9eae 835 Mode->IcmpErrorReceived = FALSE;\r
836\r
dc361cc5 837 //\r
838 // If layer isn't EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL,\r
839 // use the previous setting;\r
840 // If info isn't offered,\r
841 // use the cached DhcpAck and ProxyOffer packets.\r
842 //\r
843 if (*Layer != EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL) {\r
844\r
845 if (!Mode->PxeDiscoverValid || !Mode->PxeReplyReceived || (!Mode->PxeBisReplyReceived && UseBis)) {\r
846\r
8730386e 847 Status = EFI_INVALID_PARAMETER;\r
848 goto ON_EXIT; \r
dc361cc5 849 }\r
850\r
851 DefaultInfo.IpCnt = 1;\r
852 DefaultInfo.UseUCast = TRUE;\r
853\r
854 DefaultSrvList.Type = Type;\r
855 DefaultSrvList.AcceptAnyResponse = FALSE;\r
856 DefaultSrvList.IpAddr.Addr[0] = Private->ServerIp.Addr[0];\r
857\r
858 SrvList = &DefaultSrvList;\r
859 Info = &DefaultInfo;\r
860 } else if (Info == NULL) {\r
861 //\r
862 // Create info by the cached packet before\r
863 //\r
864 Packet = (Mode->ProxyOfferReceived) ? &Private->ProxyOffer : &Private->Dhcp4Ack;\r
865 VendorOpt = &Packet->PxeVendorOption;\r
866\r
867 if (!Mode->DhcpAckReceived || !IS_VALID_DISCOVER_VENDOR_OPTION (VendorOpt->BitMap)) {\r
868 //\r
869 // Address is not acquired or no discovery options.\r
870 //\r
8730386e 871 Status = EFI_INVALID_PARAMETER;\r
872 goto ON_EXIT; \r
dc361cc5 873 }\r
874\r
875 DefaultInfo.UseMCast = (BOOLEAN)!IS_DISABLE_MCAST_DISCOVER (VendorOpt->DiscoverCtrl);\r
876 DefaultInfo.UseBCast = (BOOLEAN)!IS_DISABLE_BCAST_DISCOVER (VendorOpt->DiscoverCtrl);\r
877 DefaultInfo.MustUseList = (BOOLEAN) IS_ENABLE_USE_SERVER_LIST (VendorOpt->DiscoverCtrl);\r
878 DefaultInfo.UseUCast = DefaultInfo.MustUseList;\r
879\r
880 if (DefaultInfo.UseMCast) {\r
881 //\r
882 // Get the multicast discover ip address from vendor option.\r
883 //\r
f737cfb9 884 CopyMem (\r
e2851998 885 &DefaultInfo.ServerMCastIp.Addr,\r
886 &VendorOpt->DiscoverMcastIp,\r
f737cfb9 887 sizeof (EFI_IPv4_ADDRESS)\r
888 );\r
dc361cc5 889 }\r
890\r
891 DefaultInfo.IpCnt = 0;\r
29a4f92d 892 Info = &DefaultInfo;\r
893 SrvList = Info->SrvList;\r
dc361cc5 894\r
895 if (DefaultInfo.MustUseList) {\r
896 BootSvrEntry = VendorOpt->BootSvr;\r
897 Status = EFI_INVALID_PARAMETER;\r
898\r
899 while (((UINT8) (BootSvrEntry - VendorOpt->BootSvr)) < VendorOpt->BootSvrLen) {\r
900\r
901 if (BootSvrEntry->Type == HTONS (Type)) {\r
902 Status = EFI_SUCCESS;\r
903 break;\r
904 }\r
905\r
906 BootSvrEntry = GET_NEXT_BOOT_SVR_ENTRY (BootSvrEntry);\r
907 }\r
908\r
909 if (EFI_ERROR (Status)) {\r
8730386e 910 goto ON_EXIT;\r
dc361cc5 911 }\r
912\r
913 DefaultInfo.IpCnt = BootSvrEntry->IpCnt;\r
29a4f92d 914\r
915 if (DefaultInfo.IpCnt >= 1) {\r
916 CreatedInfo = AllocatePool (sizeof (DefaultInfo) + (DefaultInfo.IpCnt - 1) * sizeof (*SrvList));\r
917 if (CreatedInfo == NULL) {\r
8730386e 918 Status = EFI_OUT_OF_RESOURCES;\r
919 goto ON_EXIT;\r
920 \r
29a4f92d 921 } \r
922 \r
923 CopyMem (CreatedInfo, &DefaultInfo, sizeof (DefaultInfo));\r
924 Info = CreatedInfo;\r
925 SrvList = Info->SrvList;\r
926 }\r
927\r
928 for (Index = 0; Index < DefaultInfo.IpCnt; Index++) {\r
929 CopyMem (&SrvList[Index].IpAddr, &BootSvrEntry->IpAddr[Index], sizeof (EFI_IPv4_ADDRESS));\r
930 SrvList[Index].AcceptAnyResponse = FALSE;\r
931 SrvList[Index].Type = BootSvrEntry->Type;\r
932 }\r
dc361cc5 933 }\r
934\r
dc361cc5 935 } else {\r
936\r
937 SrvList = Info->SrvList;\r
938\r
939 if (!SrvList[0].AcceptAnyResponse) {\r
940\r
941 for (Index = 1; Index < Info->IpCnt; Index++) {\r
942 if (SrvList[Index].AcceptAnyResponse) {\r
943 break;\r
944 }\r
945 }\r
946\r
947 if (Index != Info->IpCnt) {\r
8730386e 948 Status = EFI_INVALID_PARAMETER;\r
949 goto ON_EXIT; \r
dc361cc5 950 }\r
951 }\r
952 }\r
953\r
954 if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) || (Info->MustUseList && Info->IpCnt == 0)) {\r
955\r
8730386e 956 Status = EFI_INVALID_PARAMETER;\r
957 goto ON_EXIT;\r
dc361cc5 958 }\r
959 //\r
960 // Execute discover by UniCast/BroadCast/MultiCast\r
961 //\r
962 if (Info->UseUCast) {\r
963\r
964 for (Index = 0; Index < Info->IpCnt; Index++) {\r
965\r
966 if (BootSvrEntry == NULL) {\r
967 Private->ServerIp.Addr[0] = SrvList[Index].IpAddr.Addr[0];\r
968 } else {\r
f737cfb9 969 CopyMem (\r
e2851998 970 &Private->ServerIp,\r
971 &BootSvrEntry->IpAddr[Index],\r
f737cfb9 972 sizeof (EFI_IPv4_ADDRESS)\r
973 );\r
dc361cc5 974 }\r
975\r
976 Status = PxeBcDiscvBootService (\r
977 Private,\r
978 Type,\r
979 Layer,\r
980 UseBis,\r
981 &SrvList[Index].IpAddr,\r
982 0,\r
983 NULL,\r
984 TRUE,\r
985 &Private->PxeReply.Packet.Ack\r
986 );\r
29a4f92d 987 if (!EFI_ERROR (Status)) {\r
988 break;\r
989 } \r
dc361cc5 990 }\r
991\r
992 } else if (Info->UseMCast) {\r
993\r
994 Status = PxeBcDiscvBootService (\r
995 Private,\r
996 Type,\r
997 Layer,\r
998 UseBis,\r
999 &Info->ServerMCastIp,\r
1000 0,\r
1001 NULL,\r
1002 TRUE,\r
1003 &Private->PxeReply.Packet.Ack\r
1004 );\r
1005\r
1006 } else if (Info->UseBCast) {\r
1007\r
1008 Status = PxeBcDiscvBootService (\r
1009 Private,\r
1010 Type,\r
1011 Layer,\r
1012 UseBis,\r
1013 NULL,\r
1014 Info->IpCnt,\r
1015 SrvList,\r
1016 TRUE,\r
1017 &Private->PxeReply.Packet.Ack\r
1018 );\r
1019 }\r
1020\r
1021 if (EFI_ERROR (Status) || !Mode->PxeReplyReceived || (!Mode->PxeBisReplyReceived && UseBis)) {\r
982a9eae 1022 if (Status == EFI_ICMP_ERROR) {\r
1023 Mode->IcmpErrorReceived = TRUE;\r
1024 } else {\r
1025 Status = EFI_DEVICE_ERROR;\r
1026 }\r
0bc17488 1027 return Status;\r
dc361cc5 1028 } else {\r
1029 PxeBcParseCachedDhcpPacket (&Private->PxeReply);\r
1030 }\r
1031\r
1032 if (Mode->PxeBisReplyReceived) {\r
f737cfb9 1033 CopyMem (\r
e2851998 1034 &Private->ServerIp,\r
1035 &Mode->PxeReply.Dhcpv4.BootpSiAddr,\r
f737cfb9 1036 sizeof (EFI_IPv4_ADDRESS)\r
1037 );\r
dc361cc5 1038 }\r
1039\r
29a4f92d 1040 if (CreatedInfo != NULL) {\r
1041 FreePool (CreatedInfo);\r
1042 }\r
8730386e 1043\r
1044ON_EXIT:\r
1045\r
c82291bc 1046 Status = Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
1047 \r
8730386e 1048 //\r
1049 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r
1050 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1051 //\r
1052 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
1053 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
1054 This->SetIpFilter (This, &IpFilter);\r
29a4f92d 1055 \r
dc361cc5 1056 return Status;\r
1057}\r
1058\r
1059\r
e2851998 1060/**\r
f737cfb9 1061 Used to perform TFTP and MTFTP services.\r
1062\r
1063 This function is used to perform TFTP and MTFTP services. This includes the\r
1064 TFTP operations to get the size of a file, read a directory, read a file, and\r
1065 write a file. It also includes the MTFTP operations to get the size of a file,\r
1066 read a directory, and read a file. The type of operation is specified by Operation.\r
1067 If the callback function that is invoked during the TFTP/MTFTP operation does\r
1068 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will\r
1069 be returned.\r
1070 For read operations, the return data will be placed in the buffer specified by\r
1071 BufferPtr. If BufferSize is too small to contain the entire downloaded file,\r
1072 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero\r
1073 or the size of the requested file (the size of the requested file is only returned\r
1074 if the TFTP server supports TFTP options). If BufferSize is large enough for the\r
1075 read operation, then BufferSize will be set to the size of the downloaded file,\r
1076 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services\r
1077 should use the get-file-size operations to determine the size of the downloaded\r
1078 file prior to using the read-file operations-especially when downloading large\r
1079 (greater than 64 MB) files-instead of making two calls to the read-file operation.\r
1080 Following this recommendation will save time if the file is larger than expected\r
1081 and the TFTP server does not support TFTP option extensions. Without TFTP option\r
1082 extension support, the client has to download the entire file, counting and discarding\r
1083 the received packets, to determine the file size.\r
1084 For write operations, the data to be sent is in the buffer specified by BufferPtr.\r
1085 BufferSize specifies the number of bytes to send. If the write operation completes\r
1086 successfully, then EFI_SUCCESS will be returned.\r
1087 For TFTP "get file size" operations, the size of the requested file or directory\r
1088 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server\r
1089 does not support options, the file will be downloaded into a bit bucket and the\r
1090 length of the downloaded file will be returned. For MTFTP "get file size" operations,\r
1091 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED\r
1092 will be returned.\r
1093 This function can take up to 10 seconds to timeout and return control to the caller.\r
1094 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.\r
1095 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
1096 then the TFTP sequence is stopped and EFI_ABORTED will be returned.\r
1097 The format of the data returned from a TFTP read directory operation is a null-terminated\r
1098 filename followed by a null-terminated information string, of the form\r
1099 "size year-month-day hour:minute:second" (i.e. %d %d-%d-%d %d:%d:%f - note that\r
1100 the seconds field can be a decimal number), where the date and time are UTC. For\r
1101 an MTFTP read directory command, there is additionally a null-terminated multicast\r
1102 IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final\r
1103 entry is itself null-terminated, so that the final information string is terminated\r
1104 with two null octets.\r
e2851998 1105\r
f737cfb9 1106 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1107 @param Operation The type of operation to perform.\r
e2851998 1108 @param BufferPtr A pointer to the data buffer.\r
f737cfb9 1109 @param Overwrite Only used on write file operations. TRUE if a file on a remote server can\r
e2851998 1110 be overwritten.\r
f737cfb9 1111 @param BufferSize For get-file-size operations, *BufferSize returns the size of the\r
e2851998 1112 requested file.\r
f737cfb9 1113 @param BlockSize The requested block size to be used during a TFTP transfer.\r
1114 @param ServerIp The TFTP / MTFTP server IP address.\r
1115 @param Filename A Null-terminated ASCII string that specifies a directory name or a file\r
e2851998 1116 name.\r
f737cfb9 1117 @param Info Pointer to the MTFTP information.\r
e2851998 1118 @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.\r
1119\r
f737cfb9 1120 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\r
1121 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 1122 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1123 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
1124 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.\r
f737cfb9 1125 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.\r
1126 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r
1127 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.\r
1128 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.\r
e2851998 1129\r
dc361cc5 1130**/\r
1131EFI_STATUS\r
1132EFIAPI\r
1133EfiPxeBcMtftp (\r
1134 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1135 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation,\r
1136 IN OUT VOID *BufferPtr,\r
1137 IN BOOLEAN Overwrite,\r
1138 IN OUT UINT64 *BufferSize,\r
1139 IN UINTN *BlockSize OPTIONAL,\r
1140 IN EFI_IP_ADDRESS *ServerIp,\r
1141 IN UINT8 *Filename,\r
1142 IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL,\r
1143 IN BOOLEAN DontUseBuffer\r
1144 )\r
1145{\r
8730386e 1146 PXEBC_PRIVATE_DATA *Private;\r
1147 EFI_MTFTP4_CONFIG_DATA Mtftp4Config;\r
1148 EFI_STATUS Status;\r
1149 EFI_PXE_BASE_CODE_MODE *Mode;\r
1150 EFI_MAC_ADDRESS TempMacAddr;\r
1151 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
dc361cc5 1152\r
f6b7393c 1153 if ((This == NULL) ||\r
1154 (Filename == NULL) ||\r
1155 (BufferSize == NULL) ||\r
1156 ((ServerIp == NULL) || !NetIp4IsUnicast (NTOHL (ServerIp->Addr[0]), 0)) ||\r
1157 ((BufferPtr == NULL) && DontUseBuffer) ||\r
dc361cc5 1158 ((BlockSize != NULL) && (*BlockSize < 512))) {\r
1159\r
1160 return EFI_INVALID_PARAMETER;\r
1161 }\r
1162\r
1163 Status = EFI_DEVICE_ERROR;\r
1164 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
982a9eae 1165 Mode = &Private->Mode;\r
1166\r
1167 if (!Mode->AutoArp) {\r
1168 //\r
1169 // If AutoArp is set false, check arp cache\r
1170 //\r
1171 UpdateArpCache (This);\r
1172 if (!FindInArpCache (Mode, &ServerIp->v4, &TempMacAddr)) {\r
1173 return EFI_DEVICE_ERROR;\r
1174 }\r
1175 }\r
1176\r
8730386e 1177 //\r
1178 // Stop Udp4Read instance\r
1179 //\r
1180 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
1181\r
982a9eae 1182 Mode->TftpErrorReceived = FALSE;\r
1183 Mode->IcmpErrorReceived = FALSE;\r
dc361cc5 1184\r
1185 Mtftp4Config.UseDefaultSetting = FALSE;\r
1186 Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;\r
1187 Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;\r
1188\r
f737cfb9 1189 CopyMem (\r
e2851998 1190 &Mtftp4Config.StationIp,\r
1191 &Private->StationIp,\r
f737cfb9 1192 sizeof (EFI_IPv4_ADDRESS)\r
1193 );\r
1194 CopyMem (\r
e2851998 1195 &Mtftp4Config.SubnetMask,\r
1196 &Private->SubnetMask,\r
f737cfb9 1197 sizeof (EFI_IPv4_ADDRESS)\r
1198 );\r
1199 CopyMem (\r
e2851998 1200 &Mtftp4Config.GatewayIp,\r
1201 &Private->GatewayIp,\r
f737cfb9 1202 sizeof (EFI_IPv4_ADDRESS)\r
1203 );\r
1204 CopyMem (\r
e2851998 1205 &Mtftp4Config.ServerIp,\r
1206 ServerIp,\r
f737cfb9 1207 sizeof (EFI_IPv4_ADDRESS)\r
1208 );\r
dc361cc5 1209\r
1210 switch (Operation) {\r
1211\r
1212 case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE:\r
1213\r
1214 Status = PxeBcTftpGetFileSize (\r
1215 Private,\r
1216 &Mtftp4Config,\r
1217 Filename,\r
1218 BlockSize,\r
1219 BufferSize\r
1220 );\r
1221\r
dc361cc5 1222 break;\r
1223\r
1224 case EFI_PXE_BASE_CODE_TFTP_READ_FILE:\r
1225\r
1226 Status = PxeBcTftpReadFile (\r
1227 Private,\r
1228 &Mtftp4Config,\r
1229 Filename,\r
1230 BlockSize,\r
1231 BufferPtr,\r
1232 BufferSize,\r
1233 DontUseBuffer\r
1234 );\r
1235\r
1236 break;\r
1237\r
1238 case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE:\r
1239\r
1240 Status = PxeBcTftpWriteFile (\r
1241 Private,\r
1242 &Mtftp4Config,\r
1243 Filename,\r
1244 Overwrite,\r
1245 BlockSize,\r
1246 BufferPtr,\r
1247 BufferSize\r
1248 );\r
1249\r
1250 break;\r
1251\r
1252 case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY:\r
1253\r
1254 Status = PxeBcTftpReadDirectory (\r
1255 Private,\r
1256 &Mtftp4Config,\r
1257 Filename,\r
1258 BlockSize,\r
1259 BufferPtr,\r
1260 BufferSize,\r
1261 DontUseBuffer\r
1262 );\r
1263\r
1264 break;\r
1265\r
1266 case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE:\r
1267 case EFI_PXE_BASE_CODE_MTFTP_READ_FILE:\r
1268 case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY:\r
1269 Status = EFI_UNSUPPORTED;\r
1270 break;\r
1271\r
1272 default:\r
1273\r
1274 Status = EFI_INVALID_PARAMETER;\r
1275 break;\r
1276 }\r
1277\r
982a9eae 1278 if (Status == EFI_ICMP_ERROR) {\r
1279 Mode->IcmpErrorReceived = TRUE;\r
1280 }\r
1281\r
0bc17488 1282 if (EFI_ERROR (Status)) {\r
1283 return Status;\r
1284 }\r
1285\r
c82291bc 1286 Status = Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
8730386e 1287 //\r
1288 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r
1289 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1290 //\r
1291 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
1292 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
1293 This->SetIpFilter (This, &IpFilter);\r
1294\r
dc361cc5 1295 return Status;\r
1296}\r
1297\r
1298\r
e2851998 1299/**\r
f737cfb9 1300 Writes a UDP packet to the network interface.\r
1301\r
1302 This function writes a UDP packet specified by the (optional HeaderPtr and)\r
1303 BufferPtr parameters to the network interface. The UDP header is automatically\r
1304 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,\r
1305 SrcIp, and SrcPort to build this header. If the packet is successfully built and\r
1306 transmitted through the network interface, then EFI_SUCCESS will be returned.\r
1307 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will\r
1308 be returned. If an ICMP error occurs during the transmission of the packet, then\r
1309 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and\r
1310 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r
1311 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r
e2851998 1312\r
f737cfb9 1313 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
e2851998 1314 @param OpFlags The UDP operation flags.\r
f737cfb9 1315 @param DestIp The destination IP address.\r
e2851998 1316 @param DestPort The destination UDP port number.\r
1317 @param GatewayIp The gateway IP address.\r
f737cfb9 1318 @param SrcIp The source IP address.\r
1319 @param SrcPort The source UDP port number.\r
1320 @param HeaderSize An optional field which may be set to the length of a header at\r
e2851998 1321 HeaderPtr to be prefixed to the data at BufferPtr.\r
f737cfb9 1322 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
e2851998 1323 data at BufferPtr.\r
f737cfb9 1324 @param BufferSize A pointer to the size of the data at BufferPtr.\r
1325 @param BufferPtr A pointer to the data to be written.\r
e2851998 1326\r
f737cfb9 1327 @retval EFI_SUCCESS The UDP Write operation was completed.\r
1328 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 1329 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1330 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.\r
f737cfb9 1331 @retval EFI_ABORTED The callback function aborted the UDP Write operation.\r
1332 @retval EFI_TIMEOUT The UDP Write operation timed out.\r
e2851998 1333 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.\r
1334\r
dc361cc5 1335**/\r
1336EFI_STATUS\r
1337EFIAPI\r
1338EfiPxeBcUdpWrite (\r
1339 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1340 IN UINT16 OpFlags,\r
1341 IN EFI_IP_ADDRESS *DestIp,\r
1342 IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,\r
1343 IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,\r
1344 IN EFI_IP_ADDRESS *SrcIp OPTIONAL,\r
1345 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r
1346 IN UINTN *HeaderSize OPTIONAL,\r
1347 IN VOID *HeaderPtr OPTIONAL,\r
1348 IN UINTN *BufferSize,\r
1349 IN VOID *BufferPtr\r
1350 )\r
1351{\r
1352 PXEBC_PRIVATE_DATA *Private;\r
1353 EFI_UDP4_PROTOCOL *Udp4;\r
1354 EFI_UDP4_COMPLETION_TOKEN Token;\r
1355 EFI_UDP4_TRANSMIT_DATA *Udp4TxData;\r
1356 UINT32 FragCount;\r
1357 UINT32 DataLength;\r
1358 EFI_UDP4_SESSION_DATA Udp4Session;\r
1359 EFI_STATUS Status;\r
1360 BOOLEAN IsDone;\r
982a9eae 1361 EFI_PXE_BASE_CODE_MODE *Mode;\r
1362 EFI_MAC_ADDRESS TempMacAddr;\r
dc361cc5 1363\r
1364 IsDone = FALSE;\r
1365\r
1366 if ((This == NULL) || (DestIp == NULL) || (DestPort == NULL)) {\r
1367 return EFI_INVALID_PARAMETER;\r
1368 }\r
1369\r
f6b7393c 1370 if ((GatewayIp != NULL) && !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), 0)) {\r
dc361cc5 1371 //\r
1372 // Gateway is provided but it's not a unicast IP address.\r
1373 //\r
1374 return EFI_INVALID_PARAMETER;\r
1375 }\r
1376\r
1377 if ((HeaderSize != NULL) && ((*HeaderSize == 0) || (HeaderPtr == NULL))) {\r
1378 //\r
1379 // The HeaderSize ptr isn't NULL and: 1. the value is zero; or 2. the HeaderPtr\r
1380 // is NULL.\r
1381 //\r
1382 return EFI_INVALID_PARAMETER;\r
1383 }\r
1384\r
1385 if ((BufferSize == NULL) || ((*BufferSize != 0) && (BufferPtr == NULL))) {\r
1386 return EFI_INVALID_PARAMETER;\r
1387 }\r
1388\r
1389 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
8792362f 1390 Udp4 = Private->Udp4Write;\r
982a9eae 1391 Mode = &Private->Mode;\r
8792362f 1392 if (!Mode->Started) {\r
1393 return EFI_NOT_STARTED;\r
1394 }\r
dc361cc5 1395\r
1396 if (!Private->AddressIsOk && (SrcIp == NULL)) {\r
1397 return EFI_INVALID_PARAMETER;\r
1398 }\r
1399\r
982a9eae 1400 if (!Mode->AutoArp) {\r
1401 //\r
1402 // If AutoArp is set false, check arp cache\r
1403 //\r
1404 UpdateArpCache (This);\r
1405 if (!FindInArpCache (Mode, &DestIp->v4, &TempMacAddr)) {\r
1406 return EFI_DEVICE_ERROR;\r
1407 }\r
1408 }\r
1409\r
1410 Mode->IcmpErrorReceived = FALSE;\r
1411\r
8792362f 1412 if ((Private->CurrentUdpSrcPort == 0) ||\r
f737cfb9 1413 ((SrcPort != NULL) && (*SrcPort != Private->CurrentUdpSrcPort))) {\r
8792362f 1414 //\r
1415 // Port is changed, (re)configure the Udp4Write instance\r
1416 //\r
1417 if (SrcPort != NULL) {\r
1418 Private->CurrentUdpSrcPort = *SrcPort;\r
dc361cc5 1419 }\r
dc361cc5 1420 }\r
1421\r
2e4c2a04 1422 Status = PxeBcConfigureUdpWriteInstance (\r
1423 Udp4,\r
1424 &Private->StationIp.v4,\r
1425 &Private->SubnetMask.v4,\r
1426 &Private->GatewayIp.v4,\r
1427 &Private->CurrentUdpSrcPort\r
1428 );\r
1429 if (EFI_ERROR (Status)) {\r
1430 Private->CurrentUdpSrcPort = 0;\r
1431 return EFI_INVALID_PARAMETER;\r
1432 }\r
1433 \r
dc361cc5 1434 ZeroMem (&Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));\r
1435 ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));\r
1436\r
e48e37fc 1437 CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1438 Udp4Session.DestinationPort = *DestPort;\r
8792362f 1439 if (SrcIp != NULL) {\r
1440 CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));\r
1441 }\r
1442 if (SrcPort != NULL) {\r
1443 Udp4Session.SourcePort = *SrcPort;\r
1444 }\r
dc361cc5 1445\r
1446 FragCount = (HeaderSize != NULL) ? 2 : 1;\r
05c0e3cb 1447 Udp4TxData = (EFI_UDP4_TRANSMIT_DATA *) AllocateZeroPool (sizeof (EFI_UDP4_TRANSMIT_DATA) + (FragCount - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA));\r
dc361cc5 1448 if (Udp4TxData == NULL) {\r
1449 return EFI_OUT_OF_RESOURCES;\r
1450 }\r
1451\r
1452 Udp4TxData->FragmentCount = FragCount;\r
1453 Udp4TxData->FragmentTable[FragCount - 1].FragmentLength = (UINT32) *BufferSize;\r
1454 Udp4TxData->FragmentTable[FragCount - 1].FragmentBuffer = BufferPtr;\r
1455 DataLength = (UINT32) *BufferSize;\r
1456\r
1457 if (FragCount == 2) {\r
1458\r
1459 Udp4TxData->FragmentTable[0].FragmentLength = (UINT32) *HeaderSize;\r
1460 Udp4TxData->FragmentTable[0].FragmentBuffer = HeaderPtr;\r
1461 DataLength += (UINT32) *HeaderSize;\r
1462 }\r
1463\r
8792362f 1464 if (GatewayIp != NULL) {\r
1465 Udp4TxData->GatewayAddress = (EFI_IPv4_ADDRESS *) GatewayIp;\r
1466 }\r
dc361cc5 1467 Udp4TxData->UdpSessionData = &Udp4Session;\r
1468 Udp4TxData->DataLength = DataLength;\r
1469 Token.Packet.TxData = Udp4TxData;\r
1470\r
1471 Status = gBS->CreateEvent (\r
1472 EVT_NOTIFY_SIGNAL,\r
e48e37fc 1473 TPL_NOTIFY,\r
dc361cc5 1474 PxeBcCommonNotify,\r
1475 &IsDone,\r
1476 &Token.Event\r
1477 );\r
1478 if (EFI_ERROR (Status)) {\r
1479 goto ON_EXIT;\r
1480 }\r
1481\r
1482 Status = Udp4->Transmit (Udp4, &Token);\r
1483 if (EFI_ERROR (Status)) {\r
982a9eae 1484 if (Status == EFI_ICMP_ERROR) {\r
1485 Mode->IcmpErrorReceived = TRUE;\r
1486 }\r
dc361cc5 1487 goto ON_EXIT;\r
1488 }\r
1489\r
1490 while (!IsDone) {\r
1491\r
1492 Udp4->Poll (Udp4);\r
1493 }\r
1494\r
1495 Status = Token.Status;\r
1496\r
1497ON_EXIT:\r
1498\r
1499 if (Token.Event != NULL) {\r
1500 gBS->CloseEvent (Token.Event);\r
1501 }\r
1502\r
766c7483 1503 FreePool (Udp4TxData);\r
dc361cc5 1504\r
2e4c2a04 1505 //\r
1506 // Reset the instance.\r
1507 //\r
1508 Udp4->Configure (Udp4, NULL);\r
dc361cc5 1509 return Status;\r
1510}\r
1511\r
8d285ec0 1512/**\r
f737cfb9 1513 Decide whether the incoming UDP packet is acceptable per IP filter settings\r
1514 in provided PxeBcMode.\r
8d285ec0 1515\r
f737cfb9 1516 @param PxeBcMode Pointer to EFI_PXE_BASE_CODE_MODE.\r
1517 @param Session Received UDP session.\r
8d285ec0 1518\r
f737cfb9 1519 @retval TRUE The UDP package matches IP filters.\r
1520 @retval FALSE The UDP package doesn't matches IP filters.\r
8d285ec0 1521\r
1522**/\r
8d285ec0 1523BOOLEAN\r
1524CheckIpByFilter (\r
f737cfb9 1525 IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,\r
1526 IN EFI_UDP4_SESSION_DATA *Session\r
8d285ec0 1527 )\r
1528{\r
1529 UINTN Index;\r
1530 EFI_IPv4_ADDRESS Ip4Address;\r
1531 EFI_IPv4_ADDRESS DestIp4Address;\r
1532\r
f737cfb9 1533 if ((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) {\r
8d285ec0 1534 return TRUE;\r
1535 }\r
1536\r
1537 CopyMem (&DestIp4Address, &Session->DestinationAddress, sizeof (DestIp4Address));\r
e2851998 1538 if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) &&\r
982a9eae 1539 IP4_IS_MULTICAST (EFI_NTOHL (DestIp4Address))\r
8d285ec0 1540 ) {\r
1541 return TRUE;\r
1542 }\r
1543\r
e2851998 1544 if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) &&\r
8d285ec0 1545 IP4_IS_LOCAL_BROADCAST (EFI_NTOHL (DestIp4Address))\r
1546 ) {\r
1547 return TRUE;\r
1548 }\r
1549\r
1550 CopyMem (&Ip4Address, &PxeBcMode->StationIp.v4, sizeof (Ip4Address));\r
e2851998 1551 if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) &&\r
982a9eae 1552 EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)\r
8d285ec0 1553 ) {\r
1554 return TRUE;\r
1555 }\r
1556\r
894d038a 1557 ASSERT (PxeBcMode->IpFilter.IpCnt < EFI_PXE_BASE_CODE_MAX_IPCNT);\r
1558\r
f737cfb9 1559 for (Index = 0; Index < PxeBcMode->IpFilter.IpCnt; Index++) {\r
1560 CopyMem (\r
e2851998 1561 &Ip4Address,\r
1562 &PxeBcMode->IpFilter.IpList[Index].v4,\r
f737cfb9 1563 sizeof (Ip4Address)\r
1564 );\r
8d285ec0 1565 if (EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)) {\r
1566 return TRUE;\r
1567 }\r
1568 }\r
1569\r
1570 return FALSE;\r
1571}\r
dc361cc5 1572\r
e2851998 1573/**\r
f737cfb9 1574 Reads a UDP packet from the network interface.\r
1575\r
1576 This function reads a UDP packet from a network interface. The data contents\r
1577 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r
1578 buffer received is returned in BufferSize . If the input BufferSize is smaller\r
1579 than the UDP packet received (less optional HeaderSize), it will be set to the\r
1580 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r
1581 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r
1582 successfully received, then EFI_SUCCESS will be returned, and the information\r
1583 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if\r
e2851998 1584 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,\r
1585 SrcIp, and SrcPort input values, different types of UDP packet receive filtering\r
f737cfb9 1586 will be performed. The following tables summarize these receive filter operations.\r
e2851998 1587\r
f737cfb9 1588 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
e2851998 1589 @param OpFlags The UDP operation flags.\r
f737cfb9 1590 @param DestIp The destination IP address.\r
1591 @param DestPort The destination UDP port number.\r
1592 @param SrcIp The source IP address.\r
1593 @param SrcPort The source UDP port number.\r
1594 @param HeaderSize An optional field which may be set to the length of a header at\r
e2851998 1595 HeaderPtr to be prefixed to the data at BufferPtr.\r
f737cfb9 1596 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
e2851998 1597 data at BufferPtr.\r
f737cfb9 1598 @param BufferSize A pointer to the size of the data at BufferPtr.\r
1599 @param BufferPtr A pointer to the data to be read.\r
e2851998 1600\r
f737cfb9 1601 @retval EFI_SUCCESS The UDP Read operation was completed.\r
1602 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 1603 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
f737cfb9 1604 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
1605 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.\r
1606 @retval EFI_ABORTED The callback function aborted the UDP Read operation.\r
e2851998 1607 @retval EFI_TIMEOUT The UDP Read operation timed out.\r
1608\r
dc361cc5 1609**/\r
1610EFI_STATUS\r
1611EFIAPI\r
1612EfiPxeBcUdpRead (\r
f737cfb9 1613 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1614 IN UINT16 OpFlags,\r
1615 IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,\r
1616 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,\r
1617 IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,\r
1618 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r
1619 IN UINTN *HeaderSize OPTIONAL,\r
1620 IN VOID *HeaderPtr OPTIONAL,\r
1621 IN OUT UINTN *BufferSize,\r
1622 IN VOID *BufferPtr\r
dc361cc5 1623 )\r
1624{\r
1625 PXEBC_PRIVATE_DATA *Private;\r
1626 EFI_PXE_BASE_CODE_MODE *Mode;\r
1627 EFI_UDP4_PROTOCOL *Udp4;\r
1628 EFI_UDP4_COMPLETION_TOKEN Token;\r
1629 EFI_UDP4_RECEIVE_DATA *RxData;\r
1630 EFI_UDP4_SESSION_DATA *Session;\r
1631 EFI_STATUS Status;\r
1632 BOOLEAN IsDone;\r
1633 BOOLEAN Matched;\r
1634 UINTN CopyLen;\r
1635\r
1636 if (This == NULL || DestIp == NULL || DestPort == NULL) {\r
1637 return EFI_INVALID_PARAMETER;\r
1638 }\r
1639\r
f737cfb9 1640 if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (DestPort == NULL)) ||\r
1641 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (SrcIp == NULL)) ||\r
1642 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) == 0 && (SrcPort == NULL))) {\r
dc361cc5 1643 return EFI_INVALID_PARAMETER;\r
1644 }\r
1645\r
8792362f 1646 if (((HeaderSize != NULL) && (*HeaderSize == 0)) || ((HeaderSize != NULL) && (HeaderPtr == NULL))) {\r
dc361cc5 1647 return EFI_INVALID_PARAMETER;\r
1648 }\r
1649\r
29a4f92d 1650 if ((BufferSize == NULL) || (BufferPtr == NULL)) {\r
dc361cc5 1651 return EFI_INVALID_PARAMETER;\r
1652 }\r
1653\r
1654 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1655 Mode = Private->PxeBc.Mode;\r
8792362f 1656 Udp4 = Private->Udp4Read;\r
dc361cc5 1657\r
1658 if (!Mode->Started) {\r
1659 return EFI_NOT_STARTED;\r
1660 }\r
1661\r
982a9eae 1662 Mode->IcmpErrorReceived = FALSE;\r
1663\r
dc361cc5 1664 Status = gBS->CreateEvent (\r
1665 EVT_NOTIFY_SIGNAL,\r
e48e37fc 1666 TPL_NOTIFY,\r
dc361cc5 1667 PxeBcCommonNotify,\r
1668 &IsDone,\r
1669 &Token.Event\r
1670 );\r
1671 if (EFI_ERROR (Status)) {\r
1672 return EFI_OUT_OF_RESOURCES;\r
1673 }\r
1674\r
8792362f 1675TRY_AGAIN:\r
1676\r
dc361cc5 1677 IsDone = FALSE;\r
1678 Status = Udp4->Receive (Udp4, &Token);\r
1679 if (EFI_ERROR (Status)) {\r
982a9eae 1680 if (Status == EFI_ICMP_ERROR) {\r
1681 Mode->IcmpErrorReceived = TRUE;\r
1682 }\r
dc361cc5 1683 goto ON_EXIT;\r
1684 }\r
1685\r
1686 Udp4->Poll (Udp4);\r
1687\r
1688 if (!IsDone) {\r
1689 Status = EFI_TIMEOUT;\r
1690 } else {\r
1691\r
1692 //\r
1693 // check whether this packet matches the filters\r
1694 //\r
1695 if (EFI_ERROR (Token.Status)){\r
1696 goto ON_EXIT;\r
1697 }\r
1698\r
1699 RxData = Token.Packet.RxData;\r
1700 Session = &RxData->UdpSession;\r
1701\r
319075ff 1702 Matched = TRUE;\r
dc361cc5 1703\r
f737cfb9 1704 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER) != 0) {\r
319075ff 1705 Matched = FALSE;\r
8d285ec0 1706 //\r
1707 // Check UDP package by IP filter settings\r
1708 //\r
1709 if (CheckIpByFilter (Mode, Session)) {\r
1710 Matched = TRUE;\r
dc361cc5 1711 }\r
8d285ec0 1712 }\r
1713\r
1714 if (Matched) {\r
8792362f 1715 Matched = FALSE;\r
1716\r
8d285ec0 1717 //\r
1718 // Match the destination ip of the received udp dgram\r
1719 //\r
f737cfb9 1720 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP) != 0) {\r
8d285ec0 1721 Matched = TRUE;\r
1722\r
1723 if (DestIp != NULL) {\r
1724 CopyMem (DestIp, &Session->DestinationAddress, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1725 }\r
1726 } else {\r
8d285ec0 1727 if (DestIp != NULL) {\r
1728 if (EFI_IP4_EQUAL (DestIp, &Session->DestinationAddress)) {\r
1729 Matched = TRUE;\r
1730 }\r
1731 } else {\r
1732 if (EFI_IP4_EQUAL (&Private->StationIp, &Session->DestinationAddress)) {\r
1733 Matched = TRUE;\r
1734 }\r
dc361cc5 1735 }\r
1736 }\r
1737 }\r
1738\r
1739 if (Matched) {\r
1740 //\r
1741 // Match the destination port of the received udp dgram\r
1742 //\r
f737cfb9 1743 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) != 0) {\r
dc361cc5 1744\r
1745 if (DestPort != NULL) {\r
1746 *DestPort = Session->DestinationPort;\r
1747 }\r
1748 } else {\r
1749\r
1750 if (*DestPort != Session->DestinationPort) {\r
1751 Matched = FALSE;\r
1752 }\r
1753 }\r
1754 }\r
1755\r
1756 if (Matched) {\r
1757 //\r
1758 // Match the source ip of the received udp dgram\r
1759 //\r
f737cfb9 1760 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) != 0) {\r
dc361cc5 1761\r
1762 if (SrcIp != NULL) {\r
e48e37fc 1763 CopyMem (SrcIp, &Session->SourceAddress, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1764 }\r
1765 } else {\r
1766\r
1767 if (!EFI_IP4_EQUAL (SrcIp, &Session->SourceAddress)) {\r
1768 Matched = FALSE;\r
1769 }\r
1770 }\r
1771 }\r
1772\r
1773 if (Matched) {\r
1774 //\r
1775 // Match the source port of the received udp dgram\r
1776 //\r
f737cfb9 1777 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) != 0) {\r
dc361cc5 1778\r
1779 if (SrcPort != NULL) {\r
1780 *SrcPort = Session->SourcePort;\r
1781 }\r
1782 } else {\r
1783\r
1784 if (*SrcPort != Session->SourcePort) {\r
1785 Matched = FALSE;\r
1786 }\r
1787 }\r
1788 }\r
1789\r
1790 if (Matched) {\r
1791\r
1792 CopyLen = 0;\r
1793\r
1794 if (HeaderSize != NULL) {\r
1795 CopyLen = MIN (*HeaderSize, RxData->DataLength);\r
e48e37fc 1796 CopyMem (HeaderPtr, RxData->FragmentTable[0].FragmentBuffer, CopyLen);\r
dc361cc5 1797 *HeaderSize = CopyLen;\r
1798 }\r
1799\r
1800 if (RxData->DataLength - CopyLen > *BufferSize) {\r
1801\r
1802 Status = EFI_BUFFER_TOO_SMALL;\r
1803 } else {\r
1804\r
1805 *BufferSize = RxData->DataLength - CopyLen;\r
f737cfb9 1806 CopyMem (\r
e2851998 1807 BufferPtr,\r
1808 (UINT8 *) RxData->FragmentTable[0].FragmentBuffer + CopyLen,\r
f737cfb9 1809 *BufferSize\r
1810 );\r
dc361cc5 1811 }\r
1812 } else {\r
1813\r
1814 Status = EFI_TIMEOUT;\r
1815 }\r
1816\r
1817 //\r
1818 // Recycle the RxData\r
1819 //\r
1820 gBS->SignalEvent (RxData->RecycleSignal);\r
8792362f 1821\r
1822 if (!Matched) {\r
1823 goto TRY_AGAIN;\r
1824 }\r
dc361cc5 1825 }\r
1826\r
1827ON_EXIT:\r
1828\r
1829 Udp4->Cancel (Udp4, &Token);\r
1830\r
1831 gBS->CloseEvent (Token.Event);\r
1832\r
1833 return Status;\r
1834}\r
1835\r
e2851998 1836/**\r
f737cfb9 1837 Updates the IP receive filters of a network device and enables software filtering.\r
e2851998 1838\r
f737cfb9 1839 The NewFilter field is used to modify the network device's current IP receive\r
1840 filter settings and to enable a software filter. This function updates the IpFilter\r
1841 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.\r
1842 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().\r
1843 The current hardware filter remains in effect no matter what the settings of OpFlags\r
1844 are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those\r
1845 packets whose reception is enabled in hardware-physical NIC address (unicast),\r
1846 broadcast address, logical address or addresses (multicast), or all (promiscuous).\r
1847 UdpRead() does not modify the IP filter settings.\r
1848 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive\r
1849 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1850 If an application or driver wishes to preserve the IP receive filter settings,\r
1851 it will have to preserve the IP receive filter settings before these calls, and\r
1852 use SetIpFilter() to restore them after the calls. If incompatible filtering is\r
1853 requested (for example, PROMISCUOUS with anything else) or if the device does not\r
1854 support a requested filter setting and it cannot be accommodated in software\r
1855 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\r
1856 The IPlist field is used to enable IPs other than the StationIP. They may be\r
1857 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r
1858 then both the StationIP and the IPs from the IPlist will be used.\r
e2851998 1859\r
f737cfb9 1860 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1861 @param NewFilter Pointer to the new set of IP receive filters.\r
e2851998 1862\r
f737cfb9 1863 @retval EFI_SUCCESS The IP receive filter settings were updated.\r
1864 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 1865 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1866\r
dc361cc5 1867**/\r
1868EFI_STATUS\r
1869EFIAPI\r
1870EfiPxeBcSetIpFilter (\r
1871 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1872 IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter\r
1873 )\r
1874{\r
8d285ec0 1875 EFI_STATUS Status;\r
1876 PXEBC_PRIVATE_DATA *Private;\r
1877 EFI_PXE_BASE_CODE_MODE *Mode;\r
1878 UINTN Index;\r
c82291bc 1879 EFI_UDP4_CONFIG_DATA *Udp4Cfg;\r
8d285ec0 1880 BOOLEAN PromiscuousNeed;\r
c82291bc 1881 BOOLEAN AcceptPromiscuous;\r
1882 BOOLEAN AcceptBroadcast;\r
1883 BOOLEAN MultiCastUpdate;\r
8d285ec0 1884\r
1885 if (This == NULL) {\r
894d038a 1886 DEBUG ((EFI_D_ERROR, "This == NULL.\n"));\r
8d285ec0 1887 return EFI_INVALID_PARAMETER;\r
1888 }\r
1889\r
1890 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1891 Mode = Private->PxeBc.Mode;\r
1892\r
894d038a 1893 if (NewFilter == NULL) {\r
1894 DEBUG ((EFI_D_ERROR, "NewFilter == NULL.\n"));\r
8d285ec0 1895 return EFI_INVALID_PARAMETER;\r
1896 }\r
1897\r
894d038a 1898 if (NewFilter->IpCnt > EFI_PXE_BASE_CODE_MAX_IPCNT) {\r
1899 DEBUG ((EFI_D_ERROR, "NewFilter->IpCnt > %d.\n", EFI_PXE_BASE_CODE_MAX_IPCNT));\r
8d285ec0 1900 return EFI_INVALID_PARAMETER;\r
1901 }\r
1902\r
1903 if (!Mode->Started) {\r
1904 DEBUG ((EFI_D_ERROR, "BC was not started.\n"));\r
1905 return EFI_NOT_STARTED;\r
1906 }\r
1907\r
c82291bc 1908 if (Mode->UsingIpv6) {\r
1909 DEBUG ((EFI_D_ERROR, "This driver is PXE for IPv4 Only.\n"));\r
1910 return EFI_INVALID_PARAMETER;\r
1911 }\r
1912\r
8d285ec0 1913 PromiscuousNeed = FALSE;\r
894d038a 1914\r
8d285ec0 1915 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
1916 if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {\r
1917 //\r
1918 // The IP is a broadcast address.\r
1919 //\r
1920 DEBUG ((EFI_D_ERROR, "There is broadcast address in NewFilter.\n"));\r
1921 return EFI_INVALID_PARAMETER;\r
1922 }\r
f6b7393c 1923 if (NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), 0) &&\r
e2851998 1924 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0)\r
8d285ec0 1925 ) {\r
1926 //\r
1927 // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IP4 address is in IpList,\r
1928 // promiscuous mode is needed.\r
1929 //\r
1930 PromiscuousNeed = TRUE;\r
1931 }\r
1932 }\r
1933\r
c82291bc 1934 AcceptPromiscuous = FALSE;\r
1935 AcceptBroadcast = FALSE;\r
1936 MultiCastUpdate = FALSE;\r
8d285ec0 1937\r
1938 if (PromiscuousNeed ||\r
e2851998 1939 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) ||\r
1940 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0)\r
8d285ec0 1941 ) {\r
1942 //\r
c82291bc 1943 // Configure the udp4 filter to receive all packages.\r
8d285ec0 1944 //\r
c82291bc 1945 AcceptPromiscuous = TRUE;\r
1946 } else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {\r
8d285ec0 1947 //\r
c82291bc 1948 // Configure the udp4 filter to receive all broadcast packages.\r
8d285ec0 1949 //\r
c82291bc 1950 AcceptBroadcast = TRUE;\r
1951 }\r
8d285ec0 1952\r
c82291bc 1953 //\r
1954 // In multicast condition when Promiscuous FALSE and IpCnt no-zero.\r
1955 // Here check if there is any update of the multicast ip address. If yes,\r
1956 // we need leave the old multicast group (by Config UDP instance to NULL),\r
1957 // and join the new multicast group.\r
1958 //\r
1959 if (!AcceptPromiscuous) {\r
1960 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {\r
1961 if (Mode->IpFilter.IpCnt != NewFilter->IpCnt) {\r
1962 MultiCastUpdate = TRUE;\r
1963 } else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {\r
1964 MultiCastUpdate = TRUE;\r
1965 }\r
8d285ec0 1966 }\r
c82291bc 1967 }\r
1968 \r
1969 //\r
1970 // Check whether we need reconfigure the UDP instance.\r
1971 //\r
1972 Udp4Cfg = &Private->Udp4CfgData;\r
1973 if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||\r
1974 (AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {\r
1975 //\r
1976 // Clear the UDP instance configuration, all joined groups will be left\r
1977 // during the operation.\r
1978 //\r
1979 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
8d285ec0 1980\r
1981 //\r
1982 // Configure the UDP instance with the new configuration.\r
1983 //\r
c82291bc 1984 Udp4Cfg->AcceptPromiscuous = AcceptPromiscuous;\r
1985 Udp4Cfg->AcceptBroadcast = AcceptBroadcast;\r
1986 Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);\r
8d285ec0 1987 if (EFI_ERROR (Status)) {\r
1988 return Status;\r
1989 }\r
1990\r
c82291bc 1991 //\r
1992 // In not Promiscuous mode, need to join the new multicast group.\r
1993 //\r
1994 if (!AcceptPromiscuous) {\r
8d285ec0 1995 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
1996 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {\r
1997 //\r
c82291bc 1998 // Join the mutilcast group.\r
8d285ec0 1999 //\r
8792362f 2000 Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);\r
8d285ec0 2001 if (EFI_ERROR (Status)) {\r
2002 return Status;\r
2003 }\r
2004 }\r
2005 }\r
2006 }\r
2007 }\r
2008\r
2009\r
2010 //\r
2011 // Save the new filter.\r
2012 //\r
2013 CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));\r
2014\r
2015 return EFI_SUCCESS;\r
dc361cc5 2016}\r
2017\r
2018\r
e2851998 2019/**\r
f737cfb9 2020 Uses the ARP protocol to resolve a MAC address.\r
e2851998 2021\r
f737cfb9 2022 This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field\r
2023 of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6\r
2024 addresses are being used. The IP address specified by IpAddr is used to resolve\r
2025 a MAC address. If the ARP protocol succeeds in resolving the specified address,\r
2026 then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure\r
2027 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved\r
e2851998 2028 MAC address is placed there as well. If the PXE Base Code protocol is in the\r
2029 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters\r
2030 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is\r
2031 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
f737cfb9 2032 then EFI_ABORTED is returned.\r
e2851998 2033\r
f737cfb9 2034 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2035 @param IpAddr Pointer to the IP address that is used to resolve a MAC address.\r
2036 @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r
e2851998 2037 ARP protocol.\r
2038\r
f737cfb9 2039 @retval EFI_SUCCESS The IP or MAC address was resolved.\r
2040 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 2041 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
2042 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
2043 @retval EFI_ICMP_ERROR Something error occur with the ICMP packet message.\r
2044\r
dc361cc5 2045**/\r
2046EFI_STATUS\r
2047EFIAPI\r
2048EfiPxeBcArp (\r
2049 IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r
2050 IN EFI_IP_ADDRESS * IpAddr,\r
2051 IN EFI_MAC_ADDRESS * MacAddr OPTIONAL\r
2052 )\r
2053{\r
8d285ec0 2054 PXEBC_PRIVATE_DATA *Private;\r
2055 EFI_PXE_BASE_CODE_MODE *Mode;\r
2056 EFI_STATUS Status;\r
2057 EFI_MAC_ADDRESS TempMacAddr;\r
2058\r
2059 if (This == NULL || IpAddr == NULL) {\r
2060 return EFI_INVALID_PARAMETER;\r
2061 }\r
2062\r
2063 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2064 Mode = Private->PxeBc.Mode;\r
2065\r
2066 if (!Mode->Started) {\r
2067 return EFI_NOT_STARTED;\r
2068 }\r
2069\r
2070 if (!Private->AddressIsOk || Mode->UsingIpv6) {\r
2071 //\r
2072 // We can't resolve the IP address if we don't have a local address now.\r
2073 // Don't have ARP for IPv6.\r
2074 //\r
2075 return EFI_INVALID_PARAMETER;\r
2076 }\r
2077\r
982a9eae 2078 Mode->IcmpErrorReceived = FALSE;\r
2079\r
2080 if (!Mode->AutoArp) {\r
2081 //\r
2082 // If AutoArp is set false, check arp cache\r
2083 //\r
2084 UpdateArpCache (This);\r
2085 if (!FindInArpCache (Mode, &IpAddr->v4, &TempMacAddr)) {\r
2086 return EFI_DEVICE_ERROR;\r
2087 }\r
2088 } else {\r
2089 Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, NULL, &TempMacAddr);\r
2090 if (EFI_ERROR (Status)) {\r
2091 if (Status == EFI_ICMP_ERROR) {\r
2092 Mode->IcmpErrorReceived = TRUE;\r
2093 }\r
2094 return Status;\r
2095 }\r
8d285ec0 2096 }\r
2097\r
2098 if (MacAddr != NULL) {\r
2099 CopyMem (MacAddr, &TempMacAddr, sizeof (EFI_MAC_ADDRESS));\r
2100 }\r
2101\r
2102 return EFI_SUCCESS;\r
dc361cc5 2103}\r
2104\r
e2851998 2105/**\r
f737cfb9 2106 Updates the parameters that affect the operation of the PXE Base Code Protocol.\r
e2851998 2107\r
f737cfb9 2108 This function sets parameters that affect the operation of the PXE Base Code Protocol.\r
2109 The parameter specified by NewAutoArp is used to control the generation of ARP\r
2110 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated\r
2111 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP\r
2112 Protocol packets will be generated. In this case, the only mappings that are\r
2113 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.\r
2114 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol\r
2115 service, then the service will fail. This function updates the AutoArp field of\r
2116 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.\r
2117 The SetParameters() call must be invoked after a Callback Protocol is installed\r
2118 to enable the use of callbacks.\r
e2851998 2119\r
f737cfb9 2120 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2121 @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r
e2851998 2122 current value of AutoARP.\r
f737cfb9 2123 @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
e2851998 2124 current value of SendGUID.\r
f737cfb9 2125 @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,\r
e2851998 2126 the "time to live" field of the IP header.\r
f737cfb9 2127 @param NewToS If not NULL, a pointer to be used in place of the current value of ToS,\r
e2851998 2128 the "type of service" field of the IP header.\r
f737cfb9 2129 @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the\r
e2851998 2130 current value of the MakeCallback field of the Mode structure.\r
2131\r
f737cfb9 2132 @retval EFI_SUCCESS The new parameters values were updated.\r
2133 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 2134 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
2135\r
dc361cc5 2136**/\r
2137EFI_STATUS\r
2138EFIAPI\r
2139EfiPxeBcSetParameters (\r
2140 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
f737cfb9 2141 IN BOOLEAN *NewAutoArp OPTIONAL,\r
2142 IN BOOLEAN *NewSendGUID OPTIONAL,\r
2143 IN UINT8 *NewTTL OPTIONAL,\r
2144 IN UINT8 *NewToS OPTIONAL,\r
dc361cc5 2145 IN BOOLEAN *NewMakeCallback // OPTIONAL\r
2146 )\r
2147{\r
2148 PXEBC_PRIVATE_DATA *Private;\r
2149 EFI_PXE_BASE_CODE_MODE *Mode;\r
2150 EFI_STATUS Status;\r
2151\r
2152 Status = EFI_SUCCESS;\r
2153\r
2154 if (This == NULL) {\r
2155 Status = EFI_INVALID_PARAMETER;\r
2156 goto ON_EXIT;\r
2157 }\r
2158\r
2159 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2160 Mode = Private->PxeBc.Mode;\r
2161\r
f737cfb9 2162 if (NewSendGUID != NULL && *NewSendGUID) {\r
dc361cc5 2163 //\r
2164 // FixMe, cann't locate SendGuid\r
2165 //\r
2166 }\r
2167\r
f737cfb9 2168 if (NewMakeCallback != NULL && *NewMakeCallback) {\r
dc361cc5 2169\r
2170 Status = gBS->HandleProtocol (\r
2171 Private->Controller,\r
2172 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2173 (VOID **) &Private->PxeBcCallback\r
2174 );\r
2175 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r
2176\r
2177 Status = EFI_INVALID_PARAMETER;\r
2178 goto ON_EXIT;\r
2179 }\r
2180 }\r
2181\r
2182 if (!Mode->Started) {\r
2183 Status = EFI_NOT_STARTED;\r
2184 goto ON_EXIT;\r
2185 }\r
2186\r
2187 if (NewMakeCallback != NULL) {\r
2188\r
2189 if (*NewMakeCallback) {\r
2190 //\r
2191 // Update the Callback protocol.\r
2192 //\r
2193 Status = gBS->HandleProtocol (\r
2194 Private->Controller,\r
2195 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2196 (VOID **) &Private->PxeBcCallback\r
2197 );\r
2198\r
2199 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r
2200 Status = EFI_INVALID_PARAMETER;\r
2201 goto ON_EXIT;\r
2202 }\r
2203 } else {\r
2204 Private->PxeBcCallback = NULL;\r
2205 }\r
2206\r
2207 Mode->MakeCallbacks = *NewMakeCallback;\r
2208 }\r
2209\r
2210 if (NewAutoArp != NULL) {\r
2211 Mode->AutoArp = *NewAutoArp;\r
2212 }\r
2213\r
2214 if (NewSendGUID != NULL) {\r
2215 Mode->SendGUID = *NewSendGUID;\r
2216 }\r
2217\r
2218 if (NewTTL != NULL) {\r
2219 Mode->TTL = *NewTTL;\r
2220 }\r
2221\r
2222 if (NewToS != NULL) {\r
2223 Mode->ToS = *NewToS;\r
2224 }\r
2225\r
2226ON_EXIT:\r
2227 return Status;\r
2228}\r
2229\r
e2851998 2230/**\r
f737cfb9 2231 Updates the station IP address and/or subnet mask values of a network device.\r
e2851998 2232\r
f737cfb9 2233 This function updates the station IP address and/or subnet mask values of a network\r
2234 device. The NewStationIp field is used to modify the network device's current IP address.\r
2235 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,\r
2236 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure\r
2237 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet\r
2238 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.\r
2239 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
2240 structure with NewSubnetMask.\r
e2851998 2241\r
f737cfb9 2242 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
e2851998 2243 @param NewStationIp Pointer to the new IP address to be used by the network device.\r
2244 @param NewSubnetMask Pointer to the new subnet mask to be used by the network device.\r
2245\r
f737cfb9 2246 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r
2247 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
e2851998 2248 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
2249\r
dc361cc5 2250**/\r
2251EFI_STATUS\r
2252EFIAPI\r
2253EfiPxeBcSetStationIP (\r
2254 IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r
f737cfb9 2255 IN EFI_IP_ADDRESS * NewStationIp OPTIONAL,\r
dc361cc5 2256 IN EFI_IP_ADDRESS * NewSubnetMask OPTIONAL\r
2257 )\r
2258{\r
2259 PXEBC_PRIVATE_DATA *Private;\r
2260 EFI_PXE_BASE_CODE_MODE *Mode;\r
8d285ec0 2261 EFI_ARP_CONFIG_DATA ArpConfigData;\r
dc361cc5 2262\r
2263 if (This == NULL) {\r
2264 return EFI_INVALID_PARAMETER;\r
2265 }\r
2266\r
f6b7393c 2267 if (NewStationIp != NULL && !NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), 0)) {\r
dc361cc5 2268 return EFI_INVALID_PARAMETER;\r
2269 }\r
2270\r
2271 if (NewSubnetMask != NULL && !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {\r
2272 return EFI_INVALID_PARAMETER;\r
2273 }\r
2274\r
2275 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2276 Mode = Private->PxeBc.Mode;\r
2277\r
2278 if (!Mode->Started) {\r
2279 return EFI_NOT_STARTED;\r
2280 }\r
2281\r
2282 if (NewStationIp != NULL) {\r
555e76f8 2283 CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r
2284 CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r
dc361cc5 2285 }\r
2286\r
2287 if (NewSubnetMask != NULL) {\r
555e76f8 2288 CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r
2289 CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r
dc361cc5 2290 }\r
2291\r
2292 Private->AddressIsOk = TRUE;\r
2293\r
8d285ec0 2294 if (!Mode->UsingIpv6) {\r
2295 //\r
2296 // If in IPv4 mode, configure the corresponding ARP with this new\r
2297 // station IP address.\r
2298 //\r
2299 ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));\r
2300\r
2301 ArpConfigData.SwAddressType = 0x0800;\r
c9325700 2302 ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);\r
8d285ec0 2303 ArpConfigData.StationAddress = &Private->StationIp.v4;\r
2304\r
2305 Private->Arp->Configure (Private->Arp, NULL);\r
2306 Private->Arp->Configure (Private->Arp, &ArpConfigData);\r
982a9eae 2307\r
2308 //\r
2309 // Update the route table.\r
2310 //\r
2311 Mode->RouteTableEntries = 1;\r
2312 Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];\r
2313 Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];\r
2314 Mode->RouteTable[0].GwAddr.Addr[0] = 0;\r
8d285ec0 2315 }\r
2316\r
dc361cc5 2317 return EFI_SUCCESS;\r
2318}\r
2319\r
e2851998 2320/**\r
f737cfb9 2321 Updates the contents of the cached DHCP and Discover packets.\r
e2851998 2322\r
f737cfb9 2323 The pointers to the new packets are used to update the contents of the cached\r
2324 packets in the EFI_PXE_BASE_CODE_MODE structure.\r
e2851998 2325\r
f737cfb9 2326 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2327 @param NewDhcpDiscoverValid Pointer to a value that will replace the current\r
e2851998 2328 DhcpDiscoverValid field.\r
f737cfb9 2329 @param NewDhcpAckReceived Pointer to a value that will replace the current\r
e2851998 2330 DhcpAckReceived field.\r
f737cfb9 2331 @param NewProxyOfferReceived Pointer to a value that will replace the current\r
e2851998 2332 ProxyOfferReceived field.\r
2333 @param NewPxeDiscoverValid Pointer to a value that will replace the current\r
2334 ProxyOfferReceived field.\r
f737cfb9 2335 @param NewPxeReplyReceived Pointer to a value that will replace the current\r
e2851998 2336 PxeReplyReceived field.\r
f737cfb9 2337 @param NewPxeBisReplyReceived Pointer to a value that will replace the current\r
e2851998 2338 PxeBisReplyReceived field.\r
2339 @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.\r
f737cfb9 2340 @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r
2341 @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r
2342 @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r
2343 @param NewPxeReply Pointer to the new cached PXE Reply packet contents.\r
2344 @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\r
e2851998 2345\r
f737cfb9 2346 @retval EFI_SUCCESS The cached packet contents were updated.\r
2347 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
2348 @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.\r
e2851998 2349\r
dc361cc5 2350**/\r
2351EFI_STATUS\r
2352EFIAPI\r
2353EfiPxeBcSetPackets (\r
2354 IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r
f737cfb9 2355 IN BOOLEAN * NewDhcpDiscoverValid OPTIONAL,\r
2356 IN BOOLEAN * NewDhcpAckReceived OPTIONAL,\r
2357 IN BOOLEAN * NewProxyOfferReceived OPTIONAL,\r
2358 IN BOOLEAN * NewPxeDiscoverValid OPTIONAL,\r
2359 IN BOOLEAN * NewPxeReplyReceived OPTIONAL,\r
2360 IN BOOLEAN * NewPxeBisReplyReceived OPTIONAL,\r
2361 IN EFI_PXE_BASE_CODE_PACKET * NewDhcpDiscover OPTIONAL,\r
2362 IN EFI_PXE_BASE_CODE_PACKET * NewDhcpAck OPTIONAL,\r
2363 IN EFI_PXE_BASE_CODE_PACKET * NewProxyOffer OPTIONAL,\r
2364 IN EFI_PXE_BASE_CODE_PACKET * NewPxeDiscover OPTIONAL,\r
2365 IN EFI_PXE_BASE_CODE_PACKET * NewPxeReply OPTIONAL,\r
dc361cc5 2366 IN EFI_PXE_BASE_CODE_PACKET * NewPxeBisReply OPTIONAL\r
2367 )\r
2368{\r
2369 PXEBC_PRIVATE_DATA *Private;\r
2370 EFI_PXE_BASE_CODE_MODE *Mode;\r
2371\r
2372 if (This == NULL) {\r
2373 return EFI_INVALID_PARAMETER;\r
2374 }\r
2375\r
2376 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2377 Mode = Private->PxeBc.Mode;\r
2378\r
2379 if (!Mode->Started) {\r
2380 return EFI_NOT_STARTED;\r
2381 }\r
2382\r
dc361cc5 2383 if (NewDhcpDiscoverValid != NULL) {\r
2384 Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;\r
2385 }\r
2386\r
2387 if (NewDhcpAckReceived != NULL) {\r
2388 Mode->DhcpAckReceived = *NewDhcpAckReceived;\r
2389 }\r
2390\r
2391 if (NewProxyOfferReceived != NULL) {\r
2392 Mode->ProxyOfferReceived = *NewProxyOfferReceived;\r
2393 }\r
2394\r
2395 if (NewPxeDiscoverValid != NULL) {\r
2396 Mode->PxeDiscoverValid = *NewPxeDiscoverValid;\r
2397 }\r
2398\r
2399 if (NewPxeReplyReceived != NULL) {\r
2400 Mode->PxeReplyReceived = *NewPxeReplyReceived;\r
2401 }\r
2402\r
2403 if (NewPxeBisReplyReceived != NULL) {\r
2404 Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;\r
2405 }\r
2406\r
2407 if (NewDhcpDiscover != NULL) {\r
e48e37fc 2408 CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
dc361cc5 2409 }\r
2410\r
2411 if (NewDhcpAck != NULL) {\r
e48e37fc 2412 CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
dc361cc5 2413 }\r
2414\r
2415 if (NewProxyOffer != NULL) {\r
e48e37fc 2416 CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
dc361cc5 2417 }\r
2418\r
2419 if (NewPxeDiscover != NULL) {\r
e48e37fc 2420 CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
dc361cc5 2421 }\r
2422\r
2423 if (NewPxeReply != NULL) {\r
e48e37fc 2424 CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
dc361cc5 2425 }\r
2426\r
2427 if (NewPxeBisReply != NULL) {\r
e48e37fc 2428 CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
dc361cc5 2429 }\r
2430\r
2431 return EFI_SUCCESS;\r
2432}\r
2433\r
2434EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate = {\r
2435 EFI_PXE_BASE_CODE_PROTOCOL_REVISION,\r
2436 EfiPxeBcStart,\r
2437 EfiPxeBcStop,\r
2438 EfiPxeBcDhcp,\r
2439 EfiPxeBcDiscover,\r
2440 EfiPxeBcMtftp,\r
2441 EfiPxeBcUdpWrite,\r
2442 EfiPxeBcUdpRead,\r
2443 EfiPxeBcSetIpFilter,\r
2444 EfiPxeBcArp,\r
2445 EfiPxeBcSetParameters,\r
2446 EfiPxeBcSetStationIP,\r
2447 EfiPxeBcSetPackets,\r
2448 NULL\r
2449};\r
2450\r
e2851998 2451/**\r
f737cfb9 2452 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r
e2851998 2453 received, or is waiting to receive a packet.\r
2454\r
f737cfb9 2455 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,\r
2456 or is waiting to receive a packet. Parameters Function and Received specify the type of event.\r
2457 Parameters PacketLen and Packet specify the packet that generated the event. If these fields\r
2458 are zero and NULL respectively, then this is a status update callback. If the operation specified\r
2459 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation\r
2460 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to\r
2461 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.\r
2462 The SetParameters() function must be called after a Callback Protocol is installed to enable the\r
2463 use of callbacks.\r
e2851998 2464\r
f737cfb9 2465 @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
e2851998 2466 @param Function The PXE Base Code Protocol function that is waiting for an event.\r
f737cfb9 2467 @param Received TRUE if the callback is being invoked due to a receive event. FALSE if\r
e2851998 2468 the callback is being invoked due to a transmit event.\r
f737cfb9 2469 @param PacketLength The length, in bytes, of Packet. This field will have a value of zero if\r
e2851998 2470 this is a wait for receive event.\r
f737cfb9 2471 @param PacketPtr If Received is TRUE, a pointer to the packet that was just received;\r
e2851998 2472 otherwise a pointer to the packet that is about to be transmitted.\r
2473\r
2474 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation\r
f737cfb9 2475 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation\r
e2851998 2476\r
dc361cc5 2477**/\r
2478EFI_PXE_BASE_CODE_CALLBACK_STATUS\r
2479EFIAPI\r
2480EfiPxeLoadFileCallback (\r
2481 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL * This,\r
2482 IN EFI_PXE_BASE_CODE_FUNCTION Function,\r
2483 IN BOOLEAN Received,\r
2484 IN UINT32 PacketLength,\r
2485 IN EFI_PXE_BASE_CODE_PACKET * PacketPtr OPTIONAL\r
2486 )\r
2487{\r
2488 EFI_INPUT_KEY Key;\r
2489 EFI_STATUS Status;\r
2490\r
2491 //\r
2492 // Catch Ctrl-C or ESC to abort.\r
2493 //\r
2494 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2495\r
2496 if (!EFI_ERROR (Status)) {\r
2497\r
2498 if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {\r
2499\r
2500 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;\r
2501 }\r
2502 }\r
2503 //\r
2504 // No print if receive packet\r
2505 //\r
2506 if (Received) {\r
2507 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2508 }\r
2509 //\r
2510 // Print only for three functions\r
2511 //\r
2512 switch (Function) {\r
2513\r
2514 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:\r
2515 //\r
2516 // Print only for open MTFTP packets, not every MTFTP packets\r
2517 //\r
2518 if (PacketLength != 0 && PacketPtr != NULL) {\r
2519 if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {\r
2520 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2521 }\r
2522 }\r
2523 break;\r
2524\r
2525 case EFI_PXE_BASE_CODE_FUNCTION_DHCP:\r
2526 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:\r
2527 break;\r
2528\r
2529 default:\r
2530 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2531 }\r
2532\r
2533 if (PacketLength != 0 && PacketPtr != NULL) {\r
2534 //\r
2535 // Print '.' when transmit a packet\r
2536 //\r
2537 AsciiPrint (".");\r
2538\r
2539 }\r
2540\r
2541 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2542}\r
2543\r
2544EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL mPxeBcCallBackTemplate = {\r
2545 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,\r
2546 EfiPxeLoadFileCallback\r
2547};\r
2548\r
2549\r
2550/**\r
f737cfb9 2551 Find the boot file.\r
dc361cc5 2552\r
e2851998 2553 @param Private Pointer to PxeBc private data.\r
2554 @param BufferSize Pointer to buffer size.\r
2555 @param Buffer Pointer to buffer.\r
dc361cc5 2556\r
f737cfb9 2557 @retval EFI_SUCCESS Discover the boot file successfully.\r
2558 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r
2559 @retval EFI_ABORTED PXE bootstrap server, so local boot need abort.\r
2560 @retval EFI_BUFFER_TOO_SMALL The buffer is too small to load the boot file.\r
e2851998 2561\r
dc361cc5 2562**/\r
2563EFI_STATUS\r
2564DiscoverBootFile (\r
2565 IN PXEBC_PRIVATE_DATA *Private,\r
2566 IN OUT UINT64 *BufferSize,\r
2567 IN VOID *Buffer\r
2568 )\r
2569{\r
2570 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r
2571 EFI_PXE_BASE_CODE_MODE *Mode;\r
2572 EFI_STATUS Status;\r
2573 UINT16 Type;\r
2574 UINT16 Layer;\r
2575 BOOLEAN UseBis;\r
dc361cc5 2576 PXEBC_CACHED_DHCP4_PACKET *Packet;\r
2577 UINT16 Value;\r
2578\r
2579 PxeBc = &Private->PxeBc;\r
2580 Mode = PxeBc->Mode;\r
2581 Type = EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP;\r
2582 Layer = EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL;\r
2583\r
2584 //\r
2585 // do DHCP.\r
2586 //\r
2587 Status = PxeBc->Dhcp (PxeBc, TRUE);\r
2588 if (EFI_ERROR (Status)) {\r
2589 return Status;\r
2590 }\r
2591\r
2592 //\r
2593 // Select a boot server\r
2594 //\r
2595 Status = PxeBcSelectBootPrompt (Private);\r
2596\r
2597 if (Status == EFI_SUCCESS) {\r
2598 Status = PxeBcSelectBootMenu (Private, &Type, TRUE);\r
2599 } else if (Status == EFI_TIMEOUT) {\r
2600 Status = PxeBcSelectBootMenu (Private, &Type, FALSE);\r
2601 }\r
2602\r
2603 if (!EFI_ERROR (Status)) {\r
2604\r
2605 if (Type == EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP) {\r
2606 //\r
2607 // Local boot(PXE bootstrap server) need abort\r
2608 //\r
2609 return EFI_ABORTED;\r
2610 }\r
2611\r
2612 UseBis = (BOOLEAN) (Mode->BisSupported && Mode->BisDetected);\r
2613 Status = PxeBc->Discover (PxeBc, Type, &Layer, UseBis, NULL);\r
2614 if (EFI_ERROR (Status)) {\r
2615 return Status;\r
2616 }\r
2617 }\r
2618\r
2619 *BufferSize = 0;\r
dc361cc5 2620\r
2621 //\r
2622 // Get bootfile name and (m)tftp server ip addresss\r
2623 //\r
2624 if (Mode->PxeReplyReceived) {\r
2625 Packet = &Private->PxeReply;\r
2626 } else if (Mode->ProxyOfferReceived) {\r
2627 Packet = &Private->ProxyOffer;\r
2628 } else {\r
2629 Packet = &Private->Dhcp4Ack;\r
2630 }\r
2631\r
319075ff 2632 //\r
2ce5c88a 2633 // Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)\r
2634 // in DHCPOFFER packet.\r
2635 // (It does not comply with PXE Spec, Ver2.1)\r
319075ff 2636 //\r
2ce5c88a 2637 if (EFI_IP4_EQUAL (&Packet->Packet.Offer.Dhcp4.Header.ServerAddr, &mZeroIp4Addr)) {\r
e48e37fc 2638 CopyMem (\r
dc361cc5 2639 &Private->ServerIp,\r
2640 Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID]->Data,\r
2641 sizeof (EFI_IPv4_ADDRESS)\r
2642 );\r
319075ff 2643 } else {\r
2644 CopyMem (\r
e2851998 2645 &Private->ServerIp,\r
2646 &Packet->Packet.Offer.Dhcp4.Header.ServerAddr,\r
319075ff 2647 sizeof (EFI_IPv4_ADDRESS)\r
2648 );\r
2649 }\r
2650 if (Private->ServerIp.Addr[0] == 0) {\r
2651 return EFI_DEVICE_ERROR;\r
dc361cc5 2652 }\r
2653\r
2654 ASSERT (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL);\r
2655\r
2656 //\r
2657 // bootlfile name\r
2658 //\r
2659 Private->BootFileName = (CHAR8 *) (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE]->Data);\r
2660\r
2661 if (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN] != NULL) {\r
2662 //\r
2663 // Already have the bootfile length option, compute the file size\r
2664 //\r
e48e37fc 2665 CopyMem (&Value, Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN]->Data, sizeof (Value));\r
dc361cc5 2666 Value = NTOHS (Value);\r
2667 *BufferSize = 512 * Value;\r
2668 Status = EFI_BUFFER_TOO_SMALL;\r
2669 } else {\r
2670 //\r
2671 // Get the bootfile size from tftp\r
2672 //\r
2673 Status = PxeBc->Mtftp (\r
2674 PxeBc,\r
2675 EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,\r
2676 Buffer,\r
2677 FALSE,\r
2678 BufferSize,\r
fa6d3ee4 2679 &Private->BlockSize,\r
dc361cc5 2680 &Private->ServerIp,\r
2681 (UINT8 *) Private->BootFileName,\r
2682 NULL,\r
2683 FALSE\r
2684 );\r
2685 }\r
2686\r
2687 Private->FileSize = (UINTN) *BufferSize;\r
2688\r
2689 return Status;\r
2690}\r
2691\r
dc361cc5 2692/**\r
f737cfb9 2693 Causes the driver to load a specified file.\r
2694\r
2695 @param This Protocol instance pointer.\r
2696 @param FilePath The device specific path of the file to load.\r
e2851998 2697 @param BootPolicy If TRUE, indicates that the request originates from the\r
f737cfb9 2698 boot manager is attempting to load FilePath as a boot\r
2699 selection. If FALSE, then FilePath must match as exact file\r
2700 to be loaded.\r
2701 @param BufferSize On input the size of Buffer in bytes. On output with a return\r
e2851998 2702 code of EFI_SUCCESS, the amount of data transferred to\r
f737cfb9 2703 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r
2704 the size of Buffer required to retrieve the requested file.\r
2705 @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,\r
e2851998 2706 then no the size of the requested file is returned in\r
f737cfb9 2707 BufferSize.\r
2708\r
2709 @retval EFI_SUCCESS The file was loaded.\r
2710 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy\r
e2851998 2711 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r
f737cfb9 2712 BufferSize is NULL.\r
2713 @retval EFI_NO_MEDIA No medium was present to load the file.\r
2714 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.\r
2715 @retval EFI_NO_RESPONSE The remote system did not respond.\r
2716 @retval EFI_NOT_FOUND The file was not found.\r
2717 @retval EFI_ABORTED The file load process was manually cancelled.\r
dc361cc5 2718\r
2719**/\r
2720EFI_STATUS\r
2721EFIAPI\r
2722EfiPxeLoadFile (\r
2723 IN EFI_LOAD_FILE_PROTOCOL * This,\r
2724 IN EFI_DEVICE_PATH_PROTOCOL * FilePath,\r
2725 IN BOOLEAN BootPolicy,\r
2726 IN OUT UINTN *BufferSize,\r
2727 IN VOID *Buffer OPTIONAL\r
2728 )\r
2729{\r
2730 PXEBC_PRIVATE_DATA *Private;\r
2731 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r
2732 BOOLEAN NewMakeCallback;\r
dc361cc5 2733 EFI_STATUS Status;\r
2734 UINT64 TmpBufSize;\r
dd29f3ed 2735 BOOLEAN MediaPresent;\r
dc361cc5 2736\r
2737 Private = PXEBC_PRIVATE_DATA_FROM_LOADFILE (This);\r
2738 PxeBc = &Private->PxeBc;\r
2739 NewMakeCallback = FALSE;\r
dc361cc5 2740 Status = EFI_DEVICE_ERROR;\r
2741\r
2742 if (This == NULL || BufferSize == NULL) {\r
2743\r
2744 return EFI_INVALID_PARAMETER;\r
2745 }\r
2746\r
2747 //\r
2748 // Only support BootPolicy\r
2749 //\r
2750 if (!BootPolicy) {\r
2751 return EFI_UNSUPPORTED;\r
2752 }\r
2753\r
dd29f3ed 2754 //\r
2755 // Check media status before PXE start\r
2756 //\r
2757 MediaPresent = TRUE;\r
2758 NetLibDetectMedia (Private->Controller, &MediaPresent);\r
2759 if (!MediaPresent) {\r
2760 return EFI_NO_MEDIA;\r
2761 }\r
2762\r
dc361cc5 2763 Status = PxeBc->Start (PxeBc, FALSE);\r
2764 if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r
2765 return Status;\r
2766 }\r
2767\r
2768 Status = gBS->HandleProtocol (\r
2769 Private->Controller,\r
2770 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2771 (VOID **) &Private->PxeBcCallback\r
2772 );\r
2773 if (Status == EFI_UNSUPPORTED) {\r
2774\r
2775 CopyMem (&Private->LoadFileCallback, &mPxeBcCallBackTemplate, sizeof (Private->LoadFileCallback));\r
2776\r
2777 Status = gBS->InstallProtocolInterface (\r
2778 &Private->Controller,\r
2779 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2780 EFI_NATIVE_INTERFACE,\r
2781 &Private->LoadFileCallback\r
2782 );\r
2783\r
2784 NewMakeCallback = (BOOLEAN) (Status == EFI_SUCCESS);\r
2785\r
2786 Status = PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);\r
2787 if (EFI_ERROR (Status)) {\r
2788 PxeBc->Stop (PxeBc);\r
2789 return Status;\r
2790 }\r
2791 }\r
2792\r
2793 if (Private->FileSize == 0) {\r
2794 TmpBufSize = 0;\r
2795 Status = DiscoverBootFile (Private, &TmpBufSize, Buffer);\r
2796\r
2797 if (sizeof (UINTN) < sizeof (UINT64) && (TmpBufSize > 0xFFFFFFFF)) {\r
2798 Status = EFI_DEVICE_ERROR;\r
39941daf 2799 } else if (TmpBufSize > 0 && *BufferSize >= (UINTN) TmpBufSize && Buffer != NULL) {\r
319075ff 2800 *BufferSize = (UINTN) TmpBufSize;\r
2801 Status = PxeBc->Mtftp (\r
2802 PxeBc,\r
2803 EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r
2804 Buffer,\r
2805 FALSE,\r
2806 &TmpBufSize,\r
fa6d3ee4 2807 &Private->BlockSize,\r
319075ff 2808 &Private->ServerIp,\r
2809 (UINT8 *) Private->BootFileName,\r
2810 NULL,\r
2811 FALSE\r
2812 );\r
39941daf 2813 } else if (TmpBufSize > 0) {\r
dc361cc5 2814 *BufferSize = (UINTN) TmpBufSize;\r
319075ff 2815 Status = EFI_BUFFER_TOO_SMALL;\r
dc361cc5 2816 }\r
319075ff 2817 } else if (Buffer == NULL || Private->FileSize > *BufferSize) {\r
dc361cc5 2818 *BufferSize = Private->FileSize;\r
2819 Status = EFI_BUFFER_TOO_SMALL;\r
2820 } else {\r
2821 //\r
2822 // Download the file.\r
2823 //\r
2824 TmpBufSize = (UINT64) (*BufferSize);\r
2825 Status = PxeBc->Mtftp (\r
2826 PxeBc,\r
2827 EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r
2828 Buffer,\r
2829 FALSE,\r
2830 &TmpBufSize,\r
fa6d3ee4 2831 &Private->BlockSize,\r
dc361cc5 2832 &Private->ServerIp,\r
2833 (UINT8 *) Private->BootFileName,\r
2834 NULL,\r
2835 FALSE\r
2836 );\r
2837 }\r
2838 //\r
2839 // If we added a callback protocol, now is the time to remove it.\r
2840 //\r
2841 if (NewMakeCallback) {\r
2842\r
2843 NewMakeCallback = FALSE;\r
2844\r
2845 PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);\r
2846\r
2847 gBS->UninstallProtocolInterface (\r
2848 Private->Controller,\r
2849 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2850 &Private->LoadFileCallback\r
2851 );\r
2852 }\r
619eff3f 2853\r
dc361cc5 2854 //\r
2855 // Check download status\r
2856 //\r
619eff3f 2857 if (Status == EFI_SUCCESS) {\r
6ee21b60 2858 //\r
2859 // The functionality of PXE Base Code protocol will not be stopped,\r
2860 // when downloading is successfully.\r
2861 //\r
8792362f 2862 return EFI_SUCCESS;\r
dc361cc5 2863\r
619eff3f 2864 } else if (Status == EFI_BUFFER_TOO_SMALL) {\r
dc361cc5 2865 if (Buffer != NULL) {\r
2866 AsciiPrint ("PXE-E05: Download buffer is smaller than requested file.\n");\r
2867 } else {\r
ee6e8714 2868 //\r
2869 // The functionality of PXE Base Code protocol will not be stopped.\r
2870 //\r
dc361cc5 2871 return Status;\r
2872 }\r
dc361cc5 2873\r
619eff3f 2874 } else if (Status == EFI_DEVICE_ERROR) {\r
dc361cc5 2875 AsciiPrint ("PXE-E07: Network device error.\n");\r
dc361cc5 2876\r
619eff3f 2877 } else if (Status == EFI_OUT_OF_RESOURCES) {\r
dc361cc5 2878 AsciiPrint ("PXE-E09: Could not allocate I/O buffers.\n");\r
dc361cc5 2879\r
619eff3f 2880 } else if (Status == EFI_NO_MEDIA) {\r
dc361cc5 2881 AsciiPrint ("PXE-E12: Could not detect network connection.\n");\r
dc361cc5 2882\r
619eff3f 2883 } else if (Status == EFI_NO_RESPONSE) {\r
dc361cc5 2884 AsciiPrint ("PXE-E16: No offer received.\n");\r
dc361cc5 2885\r
619eff3f 2886 } else if (Status == EFI_TIMEOUT) {\r
dc361cc5 2887 AsciiPrint ("PXE-E18: Server response timeout.\n");\r
dc361cc5 2888\r
619eff3f 2889 } else if (Status == EFI_ABORTED) {\r
dc361cc5 2890 AsciiPrint ("PXE-E21: Remote boot cancelled.\n");\r
dc361cc5 2891\r
619eff3f 2892 } else if (Status == EFI_ICMP_ERROR) {\r
dc361cc5 2893 AsciiPrint ("PXE-E22: Client received ICMP error from server.\n");\r
dc361cc5 2894\r
619eff3f 2895 } else if (Status == EFI_TFTP_ERROR) {\r
dc361cc5 2896 AsciiPrint ("PXE-E23: Client received TFTP error from server.\n");\r
dc361cc5 2897\r
619eff3f 2898 } else {\r
dc361cc5 2899 AsciiPrint ("PXE-E99: Unexpected network error.\n");\r
dc361cc5 2900 }\r
2901\r
2902 PxeBc->Stop (PxeBc);\r
2903\r
2904 return Status;\r
2905}\r
2906\r
434ce3fe 2907EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate = { EfiPxeLoadFile };\r
2908\r
EFI Development Kit II mirror for PVE