]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
1. Fix a bug in PXE driver that the PXE boot do not restart if a new boot option...
[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcImpl.c
... / ...
CommitLineData
1/** @file\r
2 Interface routines for PxeBc.\r
3\r
4Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
5This program and the accompanying materials\r
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
13**/\r
14\r
15\r
16#include "PxeBcImpl.h"\r
17\r
18UINT32 mPxeDhcpTimeout[4] = { 4, 8, 16, 32 };\r
19\r
20/**\r
21 Get and record the arp cache.\r
22\r
23 @param This Pointer to EFI_PXE_BC_PROTOCOL\r
24\r
25 @retval EFI_SUCCESS Arp cache updated successfully\r
26 @retval others If error occurs when getting arp cache\r
27\r
28**/\r
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
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
54 if (EFI_ERROR (Status)) {\r
55 return Status;\r
56 }\r
57\r
58 Mode->ArpCacheEntries = MIN (\r
59 EntryCount,\r
60 EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES\r
61 );\r
62 for (Index = 0; Index < Mode->ArpCacheEntries; Index ++) {\r
63 CopyMem (\r
64 &Mode->ArpCache[Index].IpAddr,\r
65 Entries + 1,\r
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
73 //\r
74 // Slip to the next FindData.\r
75 //\r
76 Entries = (EFI_ARP_FIND_DATA *) ((UINT8 *) Entries + EntryLength);\r
77 }\r
78\r
79 return EFI_SUCCESS;\r
80}\r
81\r
82/**\r
83 Timeout routine to update arp cache.\r
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
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
100 Do arp resolution from arp cache in PxeBcMode.\r
101\r
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
106\r
107 @retval TRUE The resolution is successful.\r
108 @retval FALSE Otherwise.\r
109\r
110**/\r
111BOOLEAN\r
112FindInArpCache (\r
113 IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,\r
114 IN EFI_IPv4_ADDRESS *Ip4Addr,\r
115 OUT EFI_MAC_ADDRESS *MacAddress\r
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
122 CopyMem (\r
123 MacAddress,\r
124 &PxeBcMode->ArpCache[Index].MacAddr,\r
125 sizeof (EFI_MAC_ADDRESS)\r
126 );\r
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
138 @param Context The PXEBC private data.\r
139\r
140**/\r
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
162 if (Status == EFI_ABORTED) {\r
163 //\r
164 // The reception is actively aborted by the consumer, directly return.\r
165 //\r
166 return;\r
167 }\r
168\r
169 if (EFI_ERROR (Status) || (RxData == NULL)) {\r
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
178 if (EFI_IP4 (RxData->Header->SourceAddress) != 0 &&\r
179 !NetIp4IsUnicast (EFI_NTOHL (RxData->Header->SourceAddress), 0)) {\r
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
202 CopyMem (\r
203 CopiedPointer,\r
204 RxData->FragmentTable[Index].FragmentBuffer,\r
205 RxData->FragmentTable[Index].FragmentLength\r
206 );\r
207 } else {\r
208 CopyMem (\r
209 CopiedPointer,\r
210 RxData->FragmentTable[Index].FragmentBuffer,\r
211 CopiedLen - sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)\r
212 );\r
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
232**/\r
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
243 QueueDpc (TPL_CALLBACK, IcmpErrorListenHandlerDpc, Context);\r
244}\r
245\r
246/**\r
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
293\r
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
296 that is being started. Set to TRUE for IPv6 addresses, and FALSE for\r
297 IPv4 addresses.\r
298\r
299 @retval EFI_SUCCESS The PXE Base Code Protocol was started.\r
300 @retval EFI_DEVICE_ERROR The network device encountered an error during this oper\r
301 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the\r
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
304 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
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
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
342 Status = Private->Udp4Read->Configure (\r
343 Private->Udp4Read,\r
344 &Private->Udp4CfgData\r
345 );\r
346 if (EFI_ERROR (Status)) {\r
347 return Status;\r
348 }\r
349\r
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
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
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
444}\r
445\r
446\r
447/**\r
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
454\r
455 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
456\r
457 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r
458 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.\r
459 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r
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
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
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
489 DispatchDpc ();\r
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
508 Mode->Started = FALSE;\r
509\r
510 Private->CurrentUdpSrcPort = 0;\r
511 Private->Udp4Write->Configure (Private->Udp4Write, NULL);\r
512 Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);\r
513 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
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
524/**\r
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
540\r
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
543 offers in the order that they are received.\r
544\r
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
548 EFI_PXE_BASE_CODE_PROTOCOL structure.\r
549 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
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
555\r
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
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
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
589\r
590 Mode->IcmpErrorReceived = FALSE;\r
591\r
592 //\r
593 // Stop Udp4Read instance\r
594 //\r
595 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
596\r
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
604 // The four discovery timeouts are 4, 8, 16, 32 seconds respectively.\r
605 //\r
606 ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));\r
607 Dhcp4CfgData.OptionCount = OptCount;\r
608 Dhcp4CfgData.OptionList = OptList;\r
609 Dhcp4CfgData.Dhcp4Callback = PxeBcDhcpCallBack;\r
610 Dhcp4CfgData.CallbackContext = Private;\r
611 Dhcp4CfgData.DiscoverTryCount = 4;\r
612 Dhcp4CfgData.DiscoverTimeout = mPxeDhcpTimeout;\r
613\r
614 Status = Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);\r
615 if (EFI_ERROR (Status)) {\r
616 goto ON_EXIT;\r
617 }\r
618\r
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
627\r
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
632 }\r
633 goto ON_EXIT;\r
634 }\r
635\r
636 Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4Mode);\r
637 if (EFI_ERROR (Status)) {\r
638 goto ON_EXIT;\r
639 }\r
640\r
641 ASSERT (Dhcp4Mode.State == Dhcp4Bound);\r
642\r
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
646\r
647 CopyMem (&Mode->StationIp, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r
648 CopyMem (&Mode->SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
649\r
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
657 }\r
658\r
659ON_EXIT:\r
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
667 ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));\r
668 Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);\r
669\r
670 Private->AddressIsOk = TRUE;\r
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
680 ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);\r
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
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
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
727 }\r
728 }\r
729\r
730 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
731\r
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
740 return Status;\r
741}\r
742\r
743\r
744/**\r
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
766\r
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
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
773 @param Info Pointer to a data structure that contains additional information on the\r
774 type of discovery operation that is to be performed.\r
775\r
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
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
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
784 session.\r
785\r
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
800 EFI_PXE_BASE_CODE_DISCOVER_INFO *CreatedInfo;\r
801 EFI_PXE_BASE_CODE_SRVLIST *SrvList;\r
802 EFI_PXE_BASE_CODE_SRVLIST DefaultSrvList;\r
803 PXEBC_CACHED_DHCP4_PACKET *Packet;\r
804 PXEBC_VENDOR_OPTION *VendorOpt;\r
805 UINT16 Index;\r
806 EFI_STATUS Status;\r
807 PXEBC_BOOT_SVR_ENTRY *BootSvrEntry;\r
808 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r
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
818 CreatedInfo = NULL;\r
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
830 //\r
831 // Stop Udp4Read instance\r
832 //\r
833 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
834\r
835 Mode->IcmpErrorReceived = FALSE;\r
836\r
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
847 Status = EFI_INVALID_PARAMETER;\r
848 goto ON_EXIT; \r
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
871 Status = EFI_INVALID_PARAMETER;\r
872 goto ON_EXIT; \r
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
884 CopyMem (\r
885 &DefaultInfo.ServerMCastIp.Addr,\r
886 &VendorOpt->DiscoverMcastIp,\r
887 sizeof (EFI_IPv4_ADDRESS)\r
888 );\r
889 }\r
890\r
891 DefaultInfo.IpCnt = 0;\r
892 Info = &DefaultInfo;\r
893 SrvList = Info->SrvList;\r
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
910 goto ON_EXIT;\r
911 }\r
912\r
913 DefaultInfo.IpCnt = BootSvrEntry->IpCnt;\r
914\r
915 if (DefaultInfo.IpCnt >= 1) {\r
916 CreatedInfo = AllocatePool (sizeof (DefaultInfo) + (DefaultInfo.IpCnt - 1) * sizeof (*SrvList));\r
917 if (CreatedInfo == NULL) {\r
918 Status = EFI_OUT_OF_RESOURCES;\r
919 goto ON_EXIT;\r
920 \r
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
933 }\r
934\r
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
948 Status = EFI_INVALID_PARAMETER;\r
949 goto ON_EXIT; \r
950 }\r
951 }\r
952 }\r
953\r
954 if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) || (Info->MustUseList && Info->IpCnt == 0)) {\r
955\r
956 Status = EFI_INVALID_PARAMETER;\r
957 goto ON_EXIT;\r
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
969 CopyMem (\r
970 &Private->ServerIp,\r
971 &BootSvrEntry->IpAddr[Index],\r
972 sizeof (EFI_IPv4_ADDRESS)\r
973 );\r
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
987 if (!EFI_ERROR (Status)) {\r
988 break;\r
989 } \r
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
1022 if (Status == EFI_ICMP_ERROR) {\r
1023 Mode->IcmpErrorReceived = TRUE;\r
1024 } else {\r
1025 Status = EFI_DEVICE_ERROR;\r
1026 }\r
1027 goto ON_EXIT;\r
1028 } else {\r
1029 PxeBcParseCachedDhcpPacket (&Private->PxeReply);\r
1030 }\r
1031\r
1032 if (Mode->PxeBisReplyReceived) {\r
1033 CopyMem (\r
1034 &Private->ServerIp,\r
1035 &Mode->PxeReply.Dhcpv4.BootpSiAddr,\r
1036 sizeof (EFI_IPv4_ADDRESS)\r
1037 );\r
1038 }\r
1039\r
1040 if (CreatedInfo != NULL) {\r
1041 FreePool (CreatedInfo);\r
1042 }\r
1043\r
1044ON_EXIT:\r
1045\r
1046 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
1047 \r
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
1055 \r
1056 return Status;\r
1057}\r
1058\r
1059\r
1060/**\r
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
1105\r
1106 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1107 @param Operation The type of operation to perform.\r
1108 @param BufferPtr A pointer to the data buffer.\r
1109 @param Overwrite Only used on write file operations. TRUE if a file on a remote server can\r
1110 be overwritten.\r
1111 @param BufferSize For get-file-size operations, *BufferSize returns the size of the\r
1112 requested file.\r
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
1116 name.\r
1117 @param Info Pointer to the MTFTP information.\r
1118 @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.\r
1119\r
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
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
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
1129\r
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
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
1152\r
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
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
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
1177 //\r
1178 // Stop Udp4Read instance\r
1179 //\r
1180 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
1181\r
1182 Mode->TftpErrorReceived = FALSE;\r
1183 Mode->IcmpErrorReceived = FALSE;\r
1184\r
1185 Mtftp4Config.UseDefaultSetting = FALSE;\r
1186 Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;\r
1187 Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;\r
1188\r
1189 CopyMem (\r
1190 &Mtftp4Config.StationIp,\r
1191 &Private->StationIp,\r
1192 sizeof (EFI_IPv4_ADDRESS)\r
1193 );\r
1194 CopyMem (\r
1195 &Mtftp4Config.SubnetMask,\r
1196 &Private->SubnetMask,\r
1197 sizeof (EFI_IPv4_ADDRESS)\r
1198 );\r
1199 CopyMem (\r
1200 &Mtftp4Config.GatewayIp,\r
1201 &Private->GatewayIp,\r
1202 sizeof (EFI_IPv4_ADDRESS)\r
1203 );\r
1204 CopyMem (\r
1205 &Mtftp4Config.ServerIp,\r
1206 ServerIp,\r
1207 sizeof (EFI_IPv4_ADDRESS)\r
1208 );\r
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
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
1278 if (Status == EFI_ICMP_ERROR) {\r
1279 Mode->IcmpErrorReceived = TRUE;\r
1280 }\r
1281\r
1282 if (EFI_ERROR (Status)) {\r
1283 goto ON_EXIT;\r
1284 }\r
1285\r
1286ON_EXIT:\r
1287 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r
1288 //\r
1289 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r
1290 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1291 //\r
1292 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r
1293 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r
1294 This->SetIpFilter (This, &IpFilter);\r
1295\r
1296 return Status;\r
1297}\r
1298\r
1299\r
1300/**\r
1301 Writes a UDP packet to the network interface.\r
1302\r
1303 This function writes a UDP packet specified by the (optional HeaderPtr and)\r
1304 BufferPtr parameters to the network interface. The UDP header is automatically\r
1305 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,\r
1306 SrcIp, and SrcPort to build this header. If the packet is successfully built and\r
1307 transmitted through the network interface, then EFI_SUCCESS will be returned.\r
1308 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will\r
1309 be returned. If an ICMP error occurs during the transmission of the packet, then\r
1310 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and\r
1311 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r
1312 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r
1313\r
1314 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1315 @param OpFlags The UDP operation flags.\r
1316 @param DestIp The destination IP address.\r
1317 @param DestPort The destination UDP port number.\r
1318 @param GatewayIp The gateway IP address.\r
1319 @param SrcIp The source IP address.\r
1320 @param SrcPort The source UDP port number.\r
1321 @param HeaderSize An optional field which may be set to the length of a header at\r
1322 HeaderPtr to be prefixed to the data at BufferPtr.\r
1323 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
1324 data at BufferPtr.\r
1325 @param BufferSize A pointer to the size of the data at BufferPtr.\r
1326 @param BufferPtr A pointer to the data to be written.\r
1327\r
1328 @retval EFI_SUCCESS The UDP Write operation was completed.\r
1329 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1330 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1331 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.\r
1332 @retval EFI_ABORTED The callback function aborted the UDP Write operation.\r
1333 @retval EFI_TIMEOUT The UDP Write operation timed out.\r
1334 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.\r
1335\r
1336**/\r
1337EFI_STATUS\r
1338EFIAPI\r
1339EfiPxeBcUdpWrite (\r
1340 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1341 IN UINT16 OpFlags,\r
1342 IN EFI_IP_ADDRESS *DestIp,\r
1343 IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,\r
1344 IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,\r
1345 IN EFI_IP_ADDRESS *SrcIp OPTIONAL,\r
1346 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r
1347 IN UINTN *HeaderSize OPTIONAL,\r
1348 IN VOID *HeaderPtr OPTIONAL,\r
1349 IN UINTN *BufferSize,\r
1350 IN VOID *BufferPtr\r
1351 )\r
1352{\r
1353 PXEBC_PRIVATE_DATA *Private;\r
1354 EFI_UDP4_PROTOCOL *Udp4;\r
1355 EFI_UDP4_COMPLETION_TOKEN Token;\r
1356 EFI_UDP4_TRANSMIT_DATA *Udp4TxData;\r
1357 UINT32 FragCount;\r
1358 UINT32 DataLength;\r
1359 EFI_UDP4_SESSION_DATA Udp4Session;\r
1360 EFI_STATUS Status;\r
1361 BOOLEAN IsDone;\r
1362 EFI_PXE_BASE_CODE_MODE *Mode;\r
1363 EFI_MAC_ADDRESS TempMacAddr;\r
1364\r
1365 IsDone = FALSE;\r
1366\r
1367 if ((This == NULL) || (DestIp == NULL) || (DestPort == NULL)) {\r
1368 return EFI_INVALID_PARAMETER;\r
1369 }\r
1370\r
1371 if ((GatewayIp != NULL) && !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), 0)) {\r
1372 //\r
1373 // Gateway is provided but it's not a unicast IP address.\r
1374 //\r
1375 return EFI_INVALID_PARAMETER;\r
1376 }\r
1377\r
1378 if ((HeaderSize != NULL) && ((*HeaderSize == 0) || (HeaderPtr == NULL))) {\r
1379 //\r
1380 // The HeaderSize ptr isn't NULL and: 1. the value is zero; or 2. the HeaderPtr\r
1381 // is NULL.\r
1382 //\r
1383 return EFI_INVALID_PARAMETER;\r
1384 }\r
1385\r
1386 if ((BufferSize == NULL) || ((*BufferSize != 0) && (BufferPtr == NULL))) {\r
1387 return EFI_INVALID_PARAMETER;\r
1388 }\r
1389\r
1390 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1391 Udp4 = Private->Udp4Write;\r
1392 Mode = &Private->Mode;\r
1393 if (!Mode->Started) {\r
1394 return EFI_NOT_STARTED;\r
1395 }\r
1396\r
1397 if (!Private->AddressIsOk && (SrcIp == NULL)) {\r
1398 return EFI_INVALID_PARAMETER;\r
1399 }\r
1400\r
1401 if (!Mode->AutoArp) {\r
1402 //\r
1403 // If AutoArp is set false, check arp cache\r
1404 //\r
1405 UpdateArpCache (This);\r
1406 if (!FindInArpCache (Mode, &DestIp->v4, &TempMacAddr)) {\r
1407 return EFI_DEVICE_ERROR;\r
1408 }\r
1409 }\r
1410\r
1411 Mode->IcmpErrorReceived = FALSE;\r
1412\r
1413 if ((Private->CurrentUdpSrcPort == 0) ||\r
1414 ((SrcPort != NULL) && (*SrcPort != Private->CurrentUdpSrcPort))) {\r
1415 //\r
1416 // Port is changed, (re)configure the Udp4Write instance\r
1417 //\r
1418 if (SrcPort != NULL) {\r
1419 Private->CurrentUdpSrcPort = *SrcPort;\r
1420 }\r
1421 }\r
1422\r
1423 Status = PxeBcConfigureUdpWriteInstance (\r
1424 Udp4,\r
1425 &Private->StationIp.v4,\r
1426 &Private->SubnetMask.v4,\r
1427 &Private->GatewayIp.v4,\r
1428 &Private->CurrentUdpSrcPort\r
1429 );\r
1430 if (EFI_ERROR (Status)) {\r
1431 Private->CurrentUdpSrcPort = 0;\r
1432 return EFI_INVALID_PARAMETER;\r
1433 }\r
1434 \r
1435 ZeroMem (&Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));\r
1436 ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));\r
1437\r
1438 CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));\r
1439 Udp4Session.DestinationPort = *DestPort;\r
1440 if (SrcIp != NULL) {\r
1441 CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));\r
1442 }\r
1443 if (SrcPort != NULL) {\r
1444 Udp4Session.SourcePort = *SrcPort;\r
1445 }\r
1446\r
1447 FragCount = (HeaderSize != NULL) ? 2 : 1;\r
1448 Udp4TxData = (EFI_UDP4_TRANSMIT_DATA *) AllocateZeroPool (sizeof (EFI_UDP4_TRANSMIT_DATA) + (FragCount - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA));\r
1449 if (Udp4TxData == NULL) {\r
1450 return EFI_OUT_OF_RESOURCES;\r
1451 }\r
1452\r
1453 Udp4TxData->FragmentCount = FragCount;\r
1454 Udp4TxData->FragmentTable[FragCount - 1].FragmentLength = (UINT32) *BufferSize;\r
1455 Udp4TxData->FragmentTable[FragCount - 1].FragmentBuffer = BufferPtr;\r
1456 DataLength = (UINT32) *BufferSize;\r
1457\r
1458 if (FragCount == 2) {\r
1459\r
1460 Udp4TxData->FragmentTable[0].FragmentLength = (UINT32) *HeaderSize;\r
1461 Udp4TxData->FragmentTable[0].FragmentBuffer = HeaderPtr;\r
1462 DataLength += (UINT32) *HeaderSize;\r
1463 }\r
1464\r
1465 if (GatewayIp != NULL) {\r
1466 Udp4TxData->GatewayAddress = (EFI_IPv4_ADDRESS *) GatewayIp;\r
1467 }\r
1468 Udp4TxData->UdpSessionData = &Udp4Session;\r
1469 Udp4TxData->DataLength = DataLength;\r
1470 Token.Packet.TxData = Udp4TxData;\r
1471\r
1472 Status = gBS->CreateEvent (\r
1473 EVT_NOTIFY_SIGNAL,\r
1474 TPL_NOTIFY,\r
1475 PxeBcCommonNotify,\r
1476 &IsDone,\r
1477 &Token.Event\r
1478 );\r
1479 if (EFI_ERROR (Status)) {\r
1480 goto ON_EXIT;\r
1481 }\r
1482\r
1483 Status = Udp4->Transmit (Udp4, &Token);\r
1484 if (EFI_ERROR (Status)) {\r
1485 if (Status == EFI_ICMP_ERROR) {\r
1486 Mode->IcmpErrorReceived = TRUE;\r
1487 }\r
1488 goto ON_EXIT;\r
1489 }\r
1490\r
1491 while (!IsDone) {\r
1492\r
1493 Udp4->Poll (Udp4);\r
1494 }\r
1495\r
1496 Status = Token.Status;\r
1497\r
1498ON_EXIT:\r
1499\r
1500 if (Token.Event != NULL) {\r
1501 gBS->CloseEvent (Token.Event);\r
1502 }\r
1503\r
1504 FreePool (Udp4TxData);\r
1505\r
1506 //\r
1507 // Reset the instance.\r
1508 //\r
1509 Udp4->Configure (Udp4, NULL);\r
1510 return Status;\r
1511}\r
1512\r
1513/**\r
1514 Decide whether the incoming UDP packet is acceptable per IP filter settings\r
1515 in provided PxeBcMode.\r
1516\r
1517 @param PxeBcMode Pointer to EFI_PXE_BASE_CODE_MODE.\r
1518 @param Session Received UDP session.\r
1519\r
1520 @retval TRUE The UDP package matches IP filters.\r
1521 @retval FALSE The UDP package doesn't matches IP filters.\r
1522\r
1523**/\r
1524BOOLEAN\r
1525CheckIpByFilter (\r
1526 IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,\r
1527 IN EFI_UDP4_SESSION_DATA *Session\r
1528 )\r
1529{\r
1530 UINTN Index;\r
1531 EFI_IPv4_ADDRESS Ip4Address;\r
1532 EFI_IPv4_ADDRESS DestIp4Address;\r
1533\r
1534 if ((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) {\r
1535 return TRUE;\r
1536 }\r
1537\r
1538 CopyMem (&DestIp4Address, &Session->DestinationAddress, sizeof (DestIp4Address));\r
1539 if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) &&\r
1540 IP4_IS_MULTICAST (EFI_NTOHL (DestIp4Address))\r
1541 ) {\r
1542 return TRUE;\r
1543 }\r
1544\r
1545 if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) &&\r
1546 IP4_IS_LOCAL_BROADCAST (EFI_NTOHL (DestIp4Address))\r
1547 ) {\r
1548 return TRUE;\r
1549 }\r
1550\r
1551 CopyMem (&Ip4Address, &PxeBcMode->StationIp.v4, sizeof (Ip4Address));\r
1552 if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) &&\r
1553 EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)\r
1554 ) {\r
1555 return TRUE;\r
1556 }\r
1557\r
1558 ASSERT (PxeBcMode->IpFilter.IpCnt < EFI_PXE_BASE_CODE_MAX_IPCNT);\r
1559\r
1560 for (Index = 0; Index < PxeBcMode->IpFilter.IpCnt; Index++) {\r
1561 CopyMem (\r
1562 &Ip4Address,\r
1563 &PxeBcMode->IpFilter.IpList[Index].v4,\r
1564 sizeof (Ip4Address)\r
1565 );\r
1566 if (EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)) {\r
1567 return TRUE;\r
1568 }\r
1569 }\r
1570\r
1571 return FALSE;\r
1572}\r
1573\r
1574/**\r
1575 Reads a UDP packet from the network interface.\r
1576\r
1577 This function reads a UDP packet from a network interface. The data contents\r
1578 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r
1579 buffer received is returned in BufferSize . If the input BufferSize is smaller\r
1580 than the UDP packet received (less optional HeaderSize), it will be set to the\r
1581 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r
1582 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r
1583 successfully received, then EFI_SUCCESS will be returned, and the information\r
1584 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if\r
1585 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,\r
1586 SrcIp, and SrcPort input values, different types of UDP packet receive filtering\r
1587 will be performed. The following tables summarize these receive filter operations.\r
1588\r
1589 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1590 @param OpFlags The UDP operation flags.\r
1591 @param DestIp The destination IP address.\r
1592 @param DestPort The destination UDP port number.\r
1593 @param SrcIp The source IP address.\r
1594 @param SrcPort The source UDP port number.\r
1595 @param HeaderSize An optional field which may be set to the length of a header at\r
1596 HeaderPtr to be prefixed to the data at BufferPtr.\r
1597 @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r
1598 data at BufferPtr.\r
1599 @param BufferSize A pointer to the size of the data at BufferPtr.\r
1600 @param BufferPtr A pointer to the data to be read.\r
1601\r
1602 @retval EFI_SUCCESS The UDP Read operation was completed.\r
1603 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1604 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1605 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
1606 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.\r
1607 @retval EFI_ABORTED The callback function aborted the UDP Read operation.\r
1608 @retval EFI_TIMEOUT The UDP Read operation timed out.\r
1609\r
1610**/\r
1611EFI_STATUS\r
1612EFIAPI\r
1613EfiPxeBcUdpRead (\r
1614 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1615 IN UINT16 OpFlags,\r
1616 IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,\r
1617 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,\r
1618 IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,\r
1619 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r
1620 IN UINTN *HeaderSize OPTIONAL,\r
1621 IN VOID *HeaderPtr OPTIONAL,\r
1622 IN OUT UINTN *BufferSize,\r
1623 IN VOID *BufferPtr\r
1624 )\r
1625{\r
1626 PXEBC_PRIVATE_DATA *Private;\r
1627 EFI_PXE_BASE_CODE_MODE *Mode;\r
1628 EFI_UDP4_PROTOCOL *Udp4;\r
1629 EFI_UDP4_COMPLETION_TOKEN Token;\r
1630 EFI_UDP4_RECEIVE_DATA *RxData;\r
1631 EFI_UDP4_SESSION_DATA *Session;\r
1632 EFI_STATUS Status;\r
1633 BOOLEAN IsDone;\r
1634 BOOLEAN Matched;\r
1635 UINTN CopiedLen;\r
1636 UINTN HeaderLen;\r
1637 UINTN HeaderCopiedLen;\r
1638 UINTN BufferCopiedLen;\r
1639 UINT32 FragmentLength;\r
1640 UINTN FragmentIndex;\r
1641 UINT8 *FragmentBuffer;\r
1642\r
1643 if (This == NULL || DestIp == NULL || DestPort == NULL) {\r
1644 return EFI_INVALID_PARAMETER;\r
1645 }\r
1646\r
1647 if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (DestPort == NULL)) ||\r
1648 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (SrcIp == NULL)) ||\r
1649 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) == 0 && (SrcPort == NULL))) {\r
1650 return EFI_INVALID_PARAMETER;\r
1651 }\r
1652\r
1653 if (((HeaderSize != NULL) && (*HeaderSize == 0)) || ((HeaderSize != NULL) && (HeaderPtr == NULL))) {\r
1654 return EFI_INVALID_PARAMETER;\r
1655 }\r
1656\r
1657 if ((BufferSize == NULL) || (BufferPtr == NULL)) {\r
1658 return EFI_INVALID_PARAMETER;\r
1659 }\r
1660\r
1661 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1662 Mode = Private->PxeBc.Mode;\r
1663 Udp4 = Private->Udp4Read;\r
1664\r
1665 if (!Mode->Started) {\r
1666 return EFI_NOT_STARTED;\r
1667 }\r
1668\r
1669 Mode->IcmpErrorReceived = FALSE;\r
1670\r
1671 Status = gBS->CreateEvent (\r
1672 EVT_NOTIFY_SIGNAL,\r
1673 TPL_NOTIFY,\r
1674 PxeBcCommonNotify,\r
1675 &IsDone,\r
1676 &Token.Event\r
1677 );\r
1678 if (EFI_ERROR (Status)) {\r
1679 return EFI_OUT_OF_RESOURCES;\r
1680 }\r
1681\r
1682TRY_AGAIN:\r
1683\r
1684 IsDone = FALSE;\r
1685 Status = Udp4->Receive (Udp4, &Token);\r
1686 if (EFI_ERROR (Status)) {\r
1687 if (Status == EFI_ICMP_ERROR) {\r
1688 Mode->IcmpErrorReceived = TRUE;\r
1689 }\r
1690 goto ON_EXIT;\r
1691 }\r
1692\r
1693 Udp4->Poll (Udp4);\r
1694\r
1695 if (!IsDone) {\r
1696 Status = EFI_TIMEOUT;\r
1697 } else {\r
1698\r
1699 //\r
1700 // check whether this packet matches the filters\r
1701 //\r
1702 if (EFI_ERROR (Token.Status)){\r
1703 goto ON_EXIT;\r
1704 }\r
1705\r
1706 RxData = Token.Packet.RxData;\r
1707 Session = &RxData->UdpSession;\r
1708\r
1709 Matched = TRUE;\r
1710\r
1711 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER) != 0) {\r
1712 Matched = FALSE;\r
1713 //\r
1714 // Check UDP package by IP filter settings\r
1715 //\r
1716 if (CheckIpByFilter (Mode, Session)) {\r
1717 Matched = TRUE;\r
1718 }\r
1719 }\r
1720\r
1721 if (Matched) {\r
1722 Matched = FALSE;\r
1723\r
1724 //\r
1725 // Match the destination ip of the received udp dgram\r
1726 //\r
1727 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP) != 0) {\r
1728 Matched = TRUE;\r
1729\r
1730 if (DestIp != NULL) {\r
1731 CopyMem (DestIp, &Session->DestinationAddress, sizeof (EFI_IPv4_ADDRESS));\r
1732 }\r
1733 } else {\r
1734 if (DestIp != NULL) {\r
1735 if (EFI_IP4_EQUAL (DestIp, &Session->DestinationAddress)) {\r
1736 Matched = TRUE;\r
1737 }\r
1738 } else {\r
1739 if (EFI_IP4_EQUAL (&Private->StationIp, &Session->DestinationAddress)) {\r
1740 Matched = TRUE;\r
1741 }\r
1742 }\r
1743 }\r
1744 }\r
1745\r
1746 if (Matched) {\r
1747 //\r
1748 // Match the destination port of the received udp dgram\r
1749 //\r
1750 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) != 0) {\r
1751\r
1752 if (DestPort != NULL) {\r
1753 *DestPort = Session->DestinationPort;\r
1754 }\r
1755 } else {\r
1756\r
1757 if (*DestPort != Session->DestinationPort) {\r
1758 Matched = FALSE;\r
1759 }\r
1760 }\r
1761 }\r
1762\r
1763 if (Matched) {\r
1764 //\r
1765 // Match the source ip of the received udp dgram\r
1766 //\r
1767 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) != 0) {\r
1768\r
1769 if (SrcIp != NULL) {\r
1770 CopyMem (SrcIp, &Session->SourceAddress, sizeof (EFI_IPv4_ADDRESS));\r
1771 }\r
1772 } else {\r
1773\r
1774 if (!EFI_IP4_EQUAL (SrcIp, &Session->SourceAddress)) {\r
1775 Matched = FALSE;\r
1776 }\r
1777 }\r
1778 }\r
1779\r
1780 if (Matched) {\r
1781 //\r
1782 // Match the source port of the received udp dgram\r
1783 //\r
1784 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) != 0) {\r
1785\r
1786 if (SrcPort != NULL) {\r
1787 *SrcPort = Session->SourcePort;\r
1788 }\r
1789 } else {\r
1790\r
1791 if (*SrcPort != Session->SourcePort) {\r
1792 Matched = FALSE;\r
1793 }\r
1794 }\r
1795 }\r
1796\r
1797 if (Matched) {\r
1798 ASSERT (RxData != NULL);\r
1799\r
1800 HeaderLen = 0;\r
1801 if (HeaderSize != NULL) {\r
1802 HeaderLen = MIN (*HeaderSize, RxData->DataLength);\r
1803 }\r
1804\r
1805 if (RxData->DataLength - HeaderLen > *BufferSize) {\r
1806 Status = EFI_BUFFER_TOO_SMALL;\r
1807 } else {\r
1808 *HeaderSize = HeaderLen;\r
1809 *BufferSize = RxData->DataLength - HeaderLen;\r
1810\r
1811 HeaderCopiedLen = 0;\r
1812 BufferCopiedLen = 0;\r
1813 for (FragmentIndex = 0; FragmentIndex < RxData->FragmentCount; FragmentIndex++) {\r
1814 FragmentLength = RxData->FragmentTable[FragmentIndex].FragmentLength;\r
1815 FragmentBuffer = RxData->FragmentTable[FragmentIndex].FragmentBuffer;\r
1816 if (HeaderCopiedLen + FragmentLength < HeaderLen) {\r
1817 //\r
1818 // Copy the header part of received data.\r
1819 //\r
1820 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);\r
1821 HeaderCopiedLen += FragmentLength;\r
1822 } else if (HeaderCopiedLen < HeaderLen) {\r
1823 //\r
1824 // Copy the header part of received data.\r
1825 //\r
1826 CopiedLen = HeaderLen - HeaderCopiedLen;\r
1827 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);\r
1828 HeaderCopiedLen += CopiedLen;\r
1829\r
1830 //\r
1831 // Copy the other part of received data.\r
1832 //\r
1833 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);\r
1834 BufferCopiedLen += (FragmentLength - CopiedLen);\r
1835 } else {\r
1836 //\r
1837 // Copy the other part of received data.\r
1838 //\r
1839 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);\r
1840 BufferCopiedLen += FragmentLength;\r
1841 }\r
1842 }\r
1843 }\r
1844 } else {\r
1845\r
1846 Status = EFI_TIMEOUT;\r
1847 }\r
1848\r
1849 //\r
1850 // Recycle the RxData\r
1851 //\r
1852 gBS->SignalEvent (RxData->RecycleSignal);\r
1853\r
1854 if (!Matched) {\r
1855 goto TRY_AGAIN;\r
1856 }\r
1857 }\r
1858\r
1859ON_EXIT:\r
1860\r
1861 Udp4->Cancel (Udp4, &Token);\r
1862\r
1863 gBS->CloseEvent (Token.Event);\r
1864\r
1865 return Status;\r
1866}\r
1867\r
1868/**\r
1869 Updates the IP receive filters of a network device and enables software filtering.\r
1870\r
1871 The NewFilter field is used to modify the network device's current IP receive\r
1872 filter settings and to enable a software filter. This function updates the IpFilter\r
1873 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.\r
1874 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().\r
1875 The current hardware filter remains in effect no matter what the settings of OpFlags\r
1876 are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those\r
1877 packets whose reception is enabled in hardware-physical NIC address (unicast),\r
1878 broadcast address, logical address or addresses (multicast), or all (promiscuous).\r
1879 UdpRead() does not modify the IP filter settings.\r
1880 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive\r
1881 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r
1882 If an application or driver wishes to preserve the IP receive filter settings,\r
1883 it will have to preserve the IP receive filter settings before these calls, and\r
1884 use SetIpFilter() to restore them after the calls. If incompatible filtering is\r
1885 requested (for example, PROMISCUOUS with anything else) or if the device does not\r
1886 support a requested filter setting and it cannot be accommodated in software\r
1887 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\r
1888 The IPlist field is used to enable IPs other than the StationIP. They may be\r
1889 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r
1890 then both the StationIP and the IPs from the IPlist will be used.\r
1891\r
1892 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
1893 @param NewFilter Pointer to the new set of IP receive filters.\r
1894\r
1895 @retval EFI_SUCCESS The IP receive filter settings were updated.\r
1896 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
1897 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
1898\r
1899**/\r
1900EFI_STATUS\r
1901EFIAPI\r
1902EfiPxeBcSetIpFilter (\r
1903 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
1904 IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter\r
1905 )\r
1906{\r
1907 EFI_STATUS Status;\r
1908 PXEBC_PRIVATE_DATA *Private;\r
1909 EFI_PXE_BASE_CODE_MODE *Mode;\r
1910 UINTN Index;\r
1911 EFI_UDP4_CONFIG_DATA *Udp4Cfg;\r
1912 BOOLEAN PromiscuousNeed;\r
1913 BOOLEAN AcceptPromiscuous;\r
1914 BOOLEAN AcceptBroadcast;\r
1915 BOOLEAN MultiCastUpdate;\r
1916\r
1917 if (This == NULL) {\r
1918 DEBUG ((EFI_D_ERROR, "This == NULL.\n"));\r
1919 return EFI_INVALID_PARAMETER;\r
1920 }\r
1921\r
1922 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
1923 Mode = Private->PxeBc.Mode;\r
1924\r
1925 if (NewFilter == NULL) {\r
1926 DEBUG ((EFI_D_ERROR, "NewFilter == NULL.\n"));\r
1927 return EFI_INVALID_PARAMETER;\r
1928 }\r
1929\r
1930 if (NewFilter->IpCnt > EFI_PXE_BASE_CODE_MAX_IPCNT) {\r
1931 DEBUG ((EFI_D_ERROR, "NewFilter->IpCnt > %d.\n", EFI_PXE_BASE_CODE_MAX_IPCNT));\r
1932 return EFI_INVALID_PARAMETER;\r
1933 }\r
1934\r
1935 if (!Mode->Started) {\r
1936 DEBUG ((EFI_D_ERROR, "BC was not started.\n"));\r
1937 return EFI_NOT_STARTED;\r
1938 }\r
1939\r
1940 if (Mode->UsingIpv6) {\r
1941 DEBUG ((EFI_D_ERROR, "This driver is PXE for IPv4 Only.\n"));\r
1942 return EFI_INVALID_PARAMETER;\r
1943 }\r
1944\r
1945 PromiscuousNeed = FALSE;\r
1946\r
1947 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
1948 if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {\r
1949 //\r
1950 // The IP is a broadcast address.\r
1951 //\r
1952 DEBUG ((EFI_D_ERROR, "There is broadcast address in NewFilter.\n"));\r
1953 return EFI_INVALID_PARAMETER;\r
1954 }\r
1955 if (NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), 0) &&\r
1956 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0)\r
1957 ) {\r
1958 //\r
1959 // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IP4 address is in IpList,\r
1960 // promiscuous mode is needed.\r
1961 //\r
1962 PromiscuousNeed = TRUE;\r
1963 }\r
1964 }\r
1965\r
1966 AcceptPromiscuous = FALSE;\r
1967 AcceptBroadcast = FALSE;\r
1968 MultiCastUpdate = FALSE;\r
1969\r
1970 if (PromiscuousNeed ||\r
1971 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) ||\r
1972 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0)\r
1973 ) {\r
1974 //\r
1975 // Configure the udp4 filter to receive all packages.\r
1976 //\r
1977 AcceptPromiscuous = TRUE;\r
1978 } else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {\r
1979 //\r
1980 // Configure the udp4 filter to receive all broadcast packages.\r
1981 //\r
1982 AcceptBroadcast = TRUE;\r
1983 }\r
1984\r
1985 //\r
1986 // In multicast condition when Promiscuous FALSE and IpCnt no-zero.\r
1987 // Here check if there is any update of the multicast ip address. If yes,\r
1988 // we need leave the old multicast group (by Config UDP instance to NULL),\r
1989 // and join the new multicast group.\r
1990 //\r
1991 if (!AcceptPromiscuous) {\r
1992 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {\r
1993 if (Mode->IpFilter.IpCnt != NewFilter->IpCnt) {\r
1994 MultiCastUpdate = TRUE;\r
1995 } else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {\r
1996 MultiCastUpdate = TRUE;\r
1997 }\r
1998 }\r
1999 }\r
2000 \r
2001 //\r
2002 // Check whether we need reconfigure the UDP instance.\r
2003 //\r
2004 Udp4Cfg = &Private->Udp4CfgData;\r
2005 if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||\r
2006 (AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {\r
2007 //\r
2008 // Clear the UDP instance configuration, all joined groups will be left\r
2009 // during the operation.\r
2010 //\r
2011 Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r
2012\r
2013 //\r
2014 // Configure the UDP instance with the new configuration.\r
2015 //\r
2016 Udp4Cfg->AcceptPromiscuous = AcceptPromiscuous;\r
2017 Udp4Cfg->AcceptBroadcast = AcceptBroadcast;\r
2018 Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);\r
2019 if (EFI_ERROR (Status)) {\r
2020 return Status;\r
2021 }\r
2022\r
2023 //\r
2024 // In not Promiscuous mode, need to join the new multicast group.\r
2025 //\r
2026 if (!AcceptPromiscuous) {\r
2027 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r
2028 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {\r
2029 //\r
2030 // Join the mutilcast group.\r
2031 //\r
2032 Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);\r
2033 if (EFI_ERROR (Status)) {\r
2034 return Status;\r
2035 }\r
2036 }\r
2037 }\r
2038 }\r
2039 }\r
2040\r
2041\r
2042 //\r
2043 // Save the new filter.\r
2044 //\r
2045 CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));\r
2046\r
2047 return EFI_SUCCESS;\r
2048}\r
2049\r
2050\r
2051/**\r
2052 Uses the ARP protocol to resolve a MAC address.\r
2053\r
2054 This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field\r
2055 of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6\r
2056 addresses are being used. The IP address specified by IpAddr is used to resolve\r
2057 a MAC address. If the ARP protocol succeeds in resolving the specified address,\r
2058 then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure\r
2059 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved\r
2060 MAC address is placed there as well. If the PXE Base Code protocol is in the\r
2061 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters\r
2062 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is\r
2063 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
2064 then EFI_ABORTED is returned.\r
2065\r
2066 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2067 @param IpAddr Pointer to the IP address that is used to resolve a MAC address.\r
2068 @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r
2069 ARP protocol.\r
2070\r
2071 @retval EFI_SUCCESS The IP or MAC address was resolved.\r
2072 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
2073 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
2074 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r
2075 @retval EFI_ICMP_ERROR Something error occur with the ICMP packet message.\r
2076\r
2077**/\r
2078EFI_STATUS\r
2079EFIAPI\r
2080EfiPxeBcArp (\r
2081 IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r
2082 IN EFI_IP_ADDRESS * IpAddr,\r
2083 IN EFI_MAC_ADDRESS * MacAddr OPTIONAL\r
2084 )\r
2085{\r
2086 PXEBC_PRIVATE_DATA *Private;\r
2087 EFI_PXE_BASE_CODE_MODE *Mode;\r
2088 EFI_STATUS Status;\r
2089 EFI_MAC_ADDRESS TempMacAddr;\r
2090\r
2091 if (This == NULL || IpAddr == NULL) {\r
2092 return EFI_INVALID_PARAMETER;\r
2093 }\r
2094\r
2095 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2096 Mode = Private->PxeBc.Mode;\r
2097\r
2098 if (!Mode->Started) {\r
2099 return EFI_NOT_STARTED;\r
2100 }\r
2101\r
2102 if (!Private->AddressIsOk || Mode->UsingIpv6) {\r
2103 //\r
2104 // We can't resolve the IP address if we don't have a local address now.\r
2105 // Don't have ARP for IPv6.\r
2106 //\r
2107 return EFI_INVALID_PARAMETER;\r
2108 }\r
2109\r
2110 Mode->IcmpErrorReceived = FALSE;\r
2111\r
2112 if (!Mode->AutoArp) {\r
2113 //\r
2114 // If AutoArp is set false, check arp cache\r
2115 //\r
2116 UpdateArpCache (This);\r
2117 if (!FindInArpCache (Mode, &IpAddr->v4, &TempMacAddr)) {\r
2118 return EFI_DEVICE_ERROR;\r
2119 }\r
2120 } else {\r
2121 Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, NULL, &TempMacAddr);\r
2122 if (EFI_ERROR (Status)) {\r
2123 if (Status == EFI_ICMP_ERROR) {\r
2124 Mode->IcmpErrorReceived = TRUE;\r
2125 }\r
2126 return Status;\r
2127 }\r
2128 }\r
2129\r
2130 if (MacAddr != NULL) {\r
2131 CopyMem (MacAddr, &TempMacAddr, sizeof (EFI_MAC_ADDRESS));\r
2132 }\r
2133\r
2134 return EFI_SUCCESS;\r
2135}\r
2136\r
2137/**\r
2138 Updates the parameters that affect the operation of the PXE Base Code Protocol.\r
2139\r
2140 This function sets parameters that affect the operation of the PXE Base Code Protocol.\r
2141 The parameter specified by NewAutoArp is used to control the generation of ARP\r
2142 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated\r
2143 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP\r
2144 Protocol packets will be generated. In this case, the only mappings that are\r
2145 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.\r
2146 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol\r
2147 service, then the service will fail. This function updates the AutoArp field of\r
2148 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.\r
2149 The SetParameters() call must be invoked after a Callback Protocol is installed\r
2150 to enable the use of callbacks.\r
2151\r
2152 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2153 @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r
2154 current value of AutoARP.\r
2155 @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
2156 current value of SendGUID.\r
2157 @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,\r
2158 the "time to live" field of the IP header.\r
2159 @param NewToS If not NULL, a pointer to be used in place of the current value of ToS,\r
2160 the "type of service" field of the IP header.\r
2161 @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the\r
2162 current value of the MakeCallback field of the Mode structure.\r
2163\r
2164 @retval EFI_SUCCESS The new parameters values were updated.\r
2165 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
2166 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
2167\r
2168**/\r
2169EFI_STATUS\r
2170EFIAPI\r
2171EfiPxeBcSetParameters (\r
2172 IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r
2173 IN BOOLEAN *NewAutoArp OPTIONAL,\r
2174 IN BOOLEAN *NewSendGUID OPTIONAL,\r
2175 IN UINT8 *NewTTL OPTIONAL,\r
2176 IN UINT8 *NewToS OPTIONAL,\r
2177 IN BOOLEAN *NewMakeCallback // OPTIONAL\r
2178 )\r
2179{\r
2180 PXEBC_PRIVATE_DATA *Private;\r
2181 EFI_PXE_BASE_CODE_MODE *Mode;\r
2182 EFI_STATUS Status;\r
2183\r
2184 Status = EFI_SUCCESS;\r
2185\r
2186 if (This == NULL) {\r
2187 Status = EFI_INVALID_PARAMETER;\r
2188 goto ON_EXIT;\r
2189 }\r
2190\r
2191 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2192 Mode = Private->PxeBc.Mode;\r
2193\r
2194 if (NewSendGUID != NULL && *NewSendGUID) {\r
2195 //\r
2196 // FixMe, cann't locate SendGuid\r
2197 //\r
2198 }\r
2199\r
2200 if (NewMakeCallback != NULL && *NewMakeCallback) {\r
2201\r
2202 Status = gBS->HandleProtocol (\r
2203 Private->Controller,\r
2204 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2205 (VOID **) &Private->PxeBcCallback\r
2206 );\r
2207 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r
2208\r
2209 Status = EFI_INVALID_PARAMETER;\r
2210 goto ON_EXIT;\r
2211 }\r
2212 }\r
2213\r
2214 if (!Mode->Started) {\r
2215 Status = EFI_NOT_STARTED;\r
2216 goto ON_EXIT;\r
2217 }\r
2218\r
2219 if (NewMakeCallback != NULL) {\r
2220\r
2221 if (*NewMakeCallback) {\r
2222 //\r
2223 // Update the Callback protocol.\r
2224 //\r
2225 Status = gBS->HandleProtocol (\r
2226 Private->Controller,\r
2227 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2228 (VOID **) &Private->PxeBcCallback\r
2229 );\r
2230\r
2231 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r
2232 Status = EFI_INVALID_PARAMETER;\r
2233 goto ON_EXIT;\r
2234 }\r
2235 } else {\r
2236 Private->PxeBcCallback = NULL;\r
2237 }\r
2238\r
2239 Mode->MakeCallbacks = *NewMakeCallback;\r
2240 }\r
2241\r
2242 if (NewAutoArp != NULL) {\r
2243 Mode->AutoArp = *NewAutoArp;\r
2244 }\r
2245\r
2246 if (NewSendGUID != NULL) {\r
2247 Mode->SendGUID = *NewSendGUID;\r
2248 }\r
2249\r
2250 if (NewTTL != NULL) {\r
2251 Mode->TTL = *NewTTL;\r
2252 }\r
2253\r
2254 if (NewToS != NULL) {\r
2255 Mode->ToS = *NewToS;\r
2256 }\r
2257\r
2258ON_EXIT:\r
2259 return Status;\r
2260}\r
2261\r
2262/**\r
2263 Updates the station IP address and/or subnet mask values of a network device.\r
2264\r
2265 This function updates the station IP address and/or subnet mask values of a network\r
2266 device. The NewStationIp field is used to modify the network device's current IP address.\r
2267 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,\r
2268 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure\r
2269 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet\r
2270 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.\r
2271 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
2272 structure with NewSubnetMask.\r
2273\r
2274 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2275 @param NewStationIp Pointer to the new IP address to be used by the network device.\r
2276 @param NewSubnetMask Pointer to the new subnet mask to be used by the network device.\r
2277\r
2278 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r
2279 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
2280 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
2281\r
2282**/\r
2283EFI_STATUS\r
2284EFIAPI\r
2285EfiPxeBcSetStationIP (\r
2286 IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r
2287 IN EFI_IP_ADDRESS * NewStationIp OPTIONAL,\r
2288 IN EFI_IP_ADDRESS * NewSubnetMask OPTIONAL\r
2289 )\r
2290{\r
2291 PXEBC_PRIVATE_DATA *Private;\r
2292 EFI_PXE_BASE_CODE_MODE *Mode;\r
2293 EFI_ARP_CONFIG_DATA ArpConfigData;\r
2294\r
2295 if (This == NULL) {\r
2296 return EFI_INVALID_PARAMETER;\r
2297 }\r
2298\r
2299 if (NewStationIp != NULL && !NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), 0)) {\r
2300 return EFI_INVALID_PARAMETER;\r
2301 }\r
2302\r
2303 if (NewSubnetMask != NULL && !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {\r
2304 return EFI_INVALID_PARAMETER;\r
2305 }\r
2306\r
2307 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2308 Mode = Private->PxeBc.Mode;\r
2309\r
2310 if (!Mode->Started) {\r
2311 return EFI_NOT_STARTED;\r
2312 }\r
2313\r
2314 if (NewStationIp != NULL) {\r
2315 CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r
2316 CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r
2317 }\r
2318\r
2319 if (NewSubnetMask != NULL) {\r
2320 CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r
2321 CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r
2322 }\r
2323\r
2324 Private->AddressIsOk = TRUE;\r
2325\r
2326 if (!Mode->UsingIpv6) {\r
2327 //\r
2328 // If in IPv4 mode, configure the corresponding ARP with this new\r
2329 // station IP address.\r
2330 //\r
2331 ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));\r
2332\r
2333 ArpConfigData.SwAddressType = 0x0800;\r
2334 ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);\r
2335 ArpConfigData.StationAddress = &Private->StationIp.v4;\r
2336\r
2337 Private->Arp->Configure (Private->Arp, NULL);\r
2338 Private->Arp->Configure (Private->Arp, &ArpConfigData);\r
2339\r
2340 //\r
2341 // Update the route table.\r
2342 //\r
2343 Mode->RouteTableEntries = 1;\r
2344 Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];\r
2345 Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];\r
2346 Mode->RouteTable[0].GwAddr.Addr[0] = 0;\r
2347 }\r
2348\r
2349 return EFI_SUCCESS;\r
2350}\r
2351\r
2352/**\r
2353 Updates the contents of the cached DHCP and Discover packets.\r
2354\r
2355 The pointers to the new packets are used to update the contents of the cached\r
2356 packets in the EFI_PXE_BASE_CODE_MODE structure.\r
2357\r
2358 @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
2359 @param NewDhcpDiscoverValid Pointer to a value that will replace the current\r
2360 DhcpDiscoverValid field.\r
2361 @param NewDhcpAckReceived Pointer to a value that will replace the current\r
2362 DhcpAckReceived field.\r
2363 @param NewProxyOfferReceived Pointer to a value that will replace the current\r
2364 ProxyOfferReceived field.\r
2365 @param NewPxeDiscoverValid Pointer to a value that will replace the current\r
2366 ProxyOfferReceived field.\r
2367 @param NewPxeReplyReceived Pointer to a value that will replace the current\r
2368 PxeReplyReceived field.\r
2369 @param NewPxeBisReplyReceived Pointer to a value that will replace the current\r
2370 PxeBisReplyReceived field.\r
2371 @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.\r
2372 @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r
2373 @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r
2374 @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r
2375 @param NewPxeReply Pointer to the new cached PXE Reply packet contents.\r
2376 @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\r
2377\r
2378 @retval EFI_SUCCESS The cached packet contents were updated.\r
2379 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
2380 @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.\r
2381\r
2382**/\r
2383EFI_STATUS\r
2384EFIAPI\r
2385EfiPxeBcSetPackets (\r
2386 IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r
2387 IN BOOLEAN * NewDhcpDiscoverValid OPTIONAL,\r
2388 IN BOOLEAN * NewDhcpAckReceived OPTIONAL,\r
2389 IN BOOLEAN * NewProxyOfferReceived OPTIONAL,\r
2390 IN BOOLEAN * NewPxeDiscoverValid OPTIONAL,\r
2391 IN BOOLEAN * NewPxeReplyReceived OPTIONAL,\r
2392 IN BOOLEAN * NewPxeBisReplyReceived OPTIONAL,\r
2393 IN EFI_PXE_BASE_CODE_PACKET * NewDhcpDiscover OPTIONAL,\r
2394 IN EFI_PXE_BASE_CODE_PACKET * NewDhcpAck OPTIONAL,\r
2395 IN EFI_PXE_BASE_CODE_PACKET * NewProxyOffer OPTIONAL,\r
2396 IN EFI_PXE_BASE_CODE_PACKET * NewPxeDiscover OPTIONAL,\r
2397 IN EFI_PXE_BASE_CODE_PACKET * NewPxeReply OPTIONAL,\r
2398 IN EFI_PXE_BASE_CODE_PACKET * NewPxeBisReply OPTIONAL\r
2399 )\r
2400{\r
2401 PXEBC_PRIVATE_DATA *Private;\r
2402 EFI_PXE_BASE_CODE_MODE *Mode;\r
2403\r
2404 if (This == NULL) {\r
2405 return EFI_INVALID_PARAMETER;\r
2406 }\r
2407\r
2408 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r
2409 Mode = Private->PxeBc.Mode;\r
2410\r
2411 if (!Mode->Started) {\r
2412 return EFI_NOT_STARTED;\r
2413 }\r
2414\r
2415 if (NewDhcpDiscoverValid != NULL) {\r
2416 Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;\r
2417 }\r
2418\r
2419 if (NewDhcpAckReceived != NULL) {\r
2420 Mode->DhcpAckReceived = *NewDhcpAckReceived;\r
2421 }\r
2422\r
2423 if (NewProxyOfferReceived != NULL) {\r
2424 Mode->ProxyOfferReceived = *NewProxyOfferReceived;\r
2425 }\r
2426\r
2427 if (NewPxeDiscoverValid != NULL) {\r
2428 Mode->PxeDiscoverValid = *NewPxeDiscoverValid;\r
2429 }\r
2430\r
2431 if (NewPxeReplyReceived != NULL) {\r
2432 Mode->PxeReplyReceived = *NewPxeReplyReceived;\r
2433 }\r
2434\r
2435 if (NewPxeBisReplyReceived != NULL) {\r
2436 Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;\r
2437 }\r
2438\r
2439 if (NewDhcpDiscover != NULL) {\r
2440 CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2441 }\r
2442\r
2443 if (NewDhcpAck != NULL) {\r
2444 CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2445 }\r
2446\r
2447 if (NewProxyOffer != NULL) {\r
2448 CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2449 }\r
2450\r
2451 if (NewPxeDiscover != NULL) {\r
2452 CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2453 }\r
2454\r
2455 if (NewPxeReply != NULL) {\r
2456 CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2457 }\r
2458\r
2459 if (NewPxeBisReply != NULL) {\r
2460 CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r
2461 }\r
2462\r
2463 return EFI_SUCCESS;\r
2464}\r
2465\r
2466EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate = {\r
2467 EFI_PXE_BASE_CODE_PROTOCOL_REVISION,\r
2468 EfiPxeBcStart,\r
2469 EfiPxeBcStop,\r
2470 EfiPxeBcDhcp,\r
2471 EfiPxeBcDiscover,\r
2472 EfiPxeBcMtftp,\r
2473 EfiPxeBcUdpWrite,\r
2474 EfiPxeBcUdpRead,\r
2475 EfiPxeBcSetIpFilter,\r
2476 EfiPxeBcArp,\r
2477 EfiPxeBcSetParameters,\r
2478 EfiPxeBcSetStationIP,\r
2479 EfiPxeBcSetPackets,\r
2480 NULL\r
2481};\r
2482\r
2483/**\r
2484 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r
2485 received, or is waiting to receive a packet.\r
2486\r
2487 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,\r
2488 or is waiting to receive a packet. Parameters Function and Received specify the type of event.\r
2489 Parameters PacketLen and Packet specify the packet that generated the event. If these fields\r
2490 are zero and NULL respectively, then this is a status update callback. If the operation specified\r
2491 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation\r
2492 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to\r
2493 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.\r
2494 The SetParameters() function must be called after a Callback Protocol is installed to enable the\r
2495 use of callbacks.\r
2496\r
2497 @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
2498 @param Function The PXE Base Code Protocol function that is waiting for an event.\r
2499 @param Received TRUE if the callback is being invoked due to a receive event. FALSE if\r
2500 the callback is being invoked due to a transmit event.\r
2501 @param PacketLength The length, in bytes, of Packet. This field will have a value of zero if\r
2502 this is a wait for receive event.\r
2503 @param PacketPtr If Received is TRUE, a pointer to the packet that was just received;\r
2504 otherwise a pointer to the packet that is about to be transmitted.\r
2505\r
2506 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation\r
2507 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation\r
2508\r
2509**/\r
2510EFI_PXE_BASE_CODE_CALLBACK_STATUS\r
2511EFIAPI\r
2512EfiPxeLoadFileCallback (\r
2513 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL * This,\r
2514 IN EFI_PXE_BASE_CODE_FUNCTION Function,\r
2515 IN BOOLEAN Received,\r
2516 IN UINT32 PacketLength,\r
2517 IN EFI_PXE_BASE_CODE_PACKET * PacketPtr OPTIONAL\r
2518 )\r
2519{\r
2520 EFI_INPUT_KEY Key;\r
2521 EFI_STATUS Status;\r
2522\r
2523 //\r
2524 // Catch Ctrl-C or ESC to abort.\r
2525 //\r
2526 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
2527\r
2528 if (!EFI_ERROR (Status)) {\r
2529\r
2530 if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {\r
2531\r
2532 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;\r
2533 }\r
2534 }\r
2535 //\r
2536 // No print if receive packet\r
2537 //\r
2538 if (Received) {\r
2539 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2540 }\r
2541 //\r
2542 // Print only for three functions\r
2543 //\r
2544 switch (Function) {\r
2545\r
2546 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:\r
2547 //\r
2548 // Print only for open MTFTP packets, not every MTFTP packets\r
2549 //\r
2550 if (PacketLength != 0 && PacketPtr != NULL) {\r
2551 if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {\r
2552 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2553 }\r
2554 }\r
2555 break;\r
2556\r
2557 case EFI_PXE_BASE_CODE_FUNCTION_DHCP:\r
2558 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:\r
2559 break;\r
2560\r
2561 default:\r
2562 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2563 }\r
2564\r
2565 if (PacketLength != 0 && PacketPtr != NULL) {\r
2566 //\r
2567 // Print '.' when transmit a packet\r
2568 //\r
2569 AsciiPrint (".");\r
2570\r
2571 }\r
2572\r
2573 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r
2574}\r
2575\r
2576EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL mPxeBcCallBackTemplate = {\r
2577 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,\r
2578 EfiPxeLoadFileCallback\r
2579};\r
2580\r
2581\r
2582/**\r
2583 Find the boot file.\r
2584\r
2585 @param Private Pointer to PxeBc private data.\r
2586 @param BufferSize Pointer to buffer size.\r
2587 @param Buffer Pointer to buffer.\r
2588\r
2589 @retval EFI_SUCCESS Discover the boot file successfully.\r
2590 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r
2591 @retval EFI_ABORTED PXE bootstrap server, so local boot need abort.\r
2592 @retval EFI_BUFFER_TOO_SMALL The buffer is too small to load the boot file.\r
2593\r
2594**/\r
2595EFI_STATUS\r
2596DiscoverBootFile (\r
2597 IN PXEBC_PRIVATE_DATA *Private,\r
2598 IN OUT UINT64 *BufferSize,\r
2599 IN VOID *Buffer\r
2600 )\r
2601{\r
2602 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r
2603 EFI_PXE_BASE_CODE_MODE *Mode;\r
2604 EFI_STATUS Status;\r
2605 UINT16 Type;\r
2606 UINT16 Layer;\r
2607 BOOLEAN UseBis;\r
2608 PXEBC_CACHED_DHCP4_PACKET *Packet;\r
2609 UINT16 Value;\r
2610\r
2611 PxeBc = &Private->PxeBc;\r
2612 Mode = PxeBc->Mode;\r
2613 Type = EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP;\r
2614 Layer = EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL;\r
2615\r
2616 //\r
2617 // do DHCP.\r
2618 //\r
2619 Status = PxeBc->Dhcp (PxeBc, TRUE);\r
2620 if (EFI_ERROR (Status)) {\r
2621 return Status;\r
2622 }\r
2623\r
2624 //\r
2625 // Select a boot server\r
2626 //\r
2627 Status = PxeBcSelectBootPrompt (Private);\r
2628\r
2629 if (Status == EFI_SUCCESS) {\r
2630 Status = PxeBcSelectBootMenu (Private, &Type, TRUE);\r
2631 } else if (Status == EFI_TIMEOUT) {\r
2632 Status = PxeBcSelectBootMenu (Private, &Type, FALSE);\r
2633 }\r
2634\r
2635 if (!EFI_ERROR (Status)) {\r
2636\r
2637 if (Type == EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP) {\r
2638 //\r
2639 // Local boot(PXE bootstrap server) need abort\r
2640 //\r
2641 return EFI_ABORTED;\r
2642 }\r
2643\r
2644 UseBis = (BOOLEAN) (Mode->BisSupported && Mode->BisDetected);\r
2645 Status = PxeBc->Discover (PxeBc, Type, &Layer, UseBis, NULL);\r
2646 if (EFI_ERROR (Status)) {\r
2647 return Status;\r
2648 }\r
2649 }\r
2650\r
2651 *BufferSize = 0;\r
2652\r
2653 //\r
2654 // Get bootfile name and (m)tftp server ip addresss\r
2655 //\r
2656 if (Mode->PxeReplyReceived) {\r
2657 Packet = &Private->PxeReply;\r
2658 } else if (Mode->ProxyOfferReceived) {\r
2659 Packet = &Private->ProxyOffer;\r
2660 } else {\r
2661 Packet = &Private->Dhcp4Ack;\r
2662 }\r
2663\r
2664 //\r
2665 // Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)\r
2666 // in DHCPOFFER packet.\r
2667 // (It does not comply with PXE Spec, Ver2.1)\r
2668 //\r
2669 if (EFI_IP4_EQUAL (&Packet->Packet.Offer.Dhcp4.Header.ServerAddr, &mZeroIp4Addr)) {\r
2670 CopyMem (\r
2671 &Private->ServerIp,\r
2672 Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID]->Data,\r
2673 sizeof (EFI_IPv4_ADDRESS)\r
2674 );\r
2675 } else {\r
2676 CopyMem (\r
2677 &Private->ServerIp,\r
2678 &Packet->Packet.Offer.Dhcp4.Header.ServerAddr,\r
2679 sizeof (EFI_IPv4_ADDRESS)\r
2680 );\r
2681 }\r
2682 if (Private->ServerIp.Addr[0] == 0) {\r
2683 return EFI_DEVICE_ERROR;\r
2684 }\r
2685\r
2686 ASSERT (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL);\r
2687\r
2688 //\r
2689 // bootlfile name\r
2690 //\r
2691 Private->BootFileName = (CHAR8 *) (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE]->Data);\r
2692\r
2693 if (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN] != NULL) {\r
2694 //\r
2695 // Already have the bootfile length option, compute the file size\r
2696 //\r
2697 CopyMem (&Value, Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN]->Data, sizeof (Value));\r
2698 Value = NTOHS (Value);\r
2699 *BufferSize = 512 * Value;\r
2700 Status = EFI_BUFFER_TOO_SMALL;\r
2701 } else {\r
2702 //\r
2703 // Get the bootfile size from tftp\r
2704 //\r
2705 Status = PxeBc->Mtftp (\r
2706 PxeBc,\r
2707 EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,\r
2708 Buffer,\r
2709 FALSE,\r
2710 BufferSize,\r
2711 &Private->BlockSize,\r
2712 &Private->ServerIp,\r
2713 (UINT8 *) Private->BootFileName,\r
2714 NULL,\r
2715 FALSE\r
2716 );\r
2717 }\r
2718\r
2719 Private->FileSize = (UINTN) *BufferSize;\r
2720\r
2721 return Status;\r
2722}\r
2723\r
2724/**\r
2725 Causes the driver to load a specified file.\r
2726\r
2727 @param This Protocol instance pointer.\r
2728 @param FilePath The device specific path of the file to load.\r
2729 @param BootPolicy If TRUE, indicates that the request originates from the\r
2730 boot manager is attempting to load FilePath as a boot\r
2731 selection. If FALSE, then FilePath must match as exact file\r
2732 to be loaded.\r
2733 @param BufferSize On input the size of Buffer in bytes. On output with a return\r
2734 code of EFI_SUCCESS, the amount of data transferred to\r
2735 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r
2736 the size of Buffer required to retrieve the requested file.\r
2737 @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,\r
2738 then no the size of the requested file is returned in\r
2739 BufferSize.\r
2740\r
2741 @retval EFI_SUCCESS The file was loaded.\r
2742 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy\r
2743 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r
2744 BufferSize is NULL.\r
2745 @retval EFI_NO_MEDIA No medium was present to load the file.\r
2746 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.\r
2747 @retval EFI_NO_RESPONSE The remote system did not respond.\r
2748 @retval EFI_NOT_FOUND The file was not found.\r
2749 @retval EFI_ABORTED The file load process was manually cancelled.\r
2750\r
2751**/\r
2752EFI_STATUS\r
2753EFIAPI\r
2754EfiPxeLoadFile (\r
2755 IN EFI_LOAD_FILE_PROTOCOL * This,\r
2756 IN EFI_DEVICE_PATH_PROTOCOL * FilePath,\r
2757 IN BOOLEAN BootPolicy,\r
2758 IN OUT UINTN *BufferSize,\r
2759 IN VOID *Buffer OPTIONAL\r
2760 )\r
2761{\r
2762 PXEBC_PRIVATE_DATA *Private;\r
2763 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r
2764 BOOLEAN NewMakeCallback;\r
2765 EFI_STATUS Status;\r
2766 UINT64 TmpBufSize;\r
2767 BOOLEAN MediaPresent;\r
2768\r
2769 Private = PXEBC_PRIVATE_DATA_FROM_LOADFILE (This);\r
2770 PxeBc = &Private->PxeBc;\r
2771 NewMakeCallback = FALSE;\r
2772 Status = EFI_DEVICE_ERROR;\r
2773\r
2774 if (This == NULL || BufferSize == NULL) {\r
2775\r
2776 return EFI_INVALID_PARAMETER;\r
2777 }\r
2778\r
2779 //\r
2780 // Only support BootPolicy\r
2781 //\r
2782 if (!BootPolicy) {\r
2783 return EFI_UNSUPPORTED;\r
2784 }\r
2785\r
2786 //\r
2787 // Check media status before PXE start\r
2788 //\r
2789 MediaPresent = TRUE;\r
2790 NetLibDetectMedia (Private->Controller, &MediaPresent);\r
2791 if (!MediaPresent) {\r
2792 return EFI_NO_MEDIA;\r
2793 }\r
2794\r
2795 Status = PxeBc->Start (PxeBc, FALSE);\r
2796 if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r
2797 return Status;\r
2798 }\r
2799\r
2800 Status = gBS->HandleProtocol (\r
2801 Private->Controller,\r
2802 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2803 (VOID **) &Private->PxeBcCallback\r
2804 );\r
2805 if (Status == EFI_UNSUPPORTED) {\r
2806\r
2807 CopyMem (&Private->LoadFileCallback, &mPxeBcCallBackTemplate, sizeof (Private->LoadFileCallback));\r
2808\r
2809 Status = gBS->InstallProtocolInterface (\r
2810 &Private->Controller,\r
2811 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2812 EFI_NATIVE_INTERFACE,\r
2813 &Private->LoadFileCallback\r
2814 );\r
2815\r
2816 NewMakeCallback = (BOOLEAN) (Status == EFI_SUCCESS);\r
2817\r
2818 Status = PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);\r
2819 if (EFI_ERROR (Status)) {\r
2820 PxeBc->Stop (PxeBc);\r
2821 return Status;\r
2822 }\r
2823 }\r
2824\r
2825 if (Private->FileSize == 0) {\r
2826 TmpBufSize = 0;\r
2827 Status = DiscoverBootFile (Private, &TmpBufSize, Buffer);\r
2828\r
2829 if (sizeof (UINTN) < sizeof (UINT64) && (TmpBufSize > 0xFFFFFFFF)) {\r
2830 Status = EFI_DEVICE_ERROR;\r
2831 } else if (TmpBufSize > 0 && *BufferSize >= (UINTN) TmpBufSize && Buffer != NULL) {\r
2832 *BufferSize = (UINTN) TmpBufSize;\r
2833 Status = PxeBc->Mtftp (\r
2834 PxeBc,\r
2835 EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r
2836 Buffer,\r
2837 FALSE,\r
2838 &TmpBufSize,\r
2839 &Private->BlockSize,\r
2840 &Private->ServerIp,\r
2841 (UINT8 *) Private->BootFileName,\r
2842 NULL,\r
2843 FALSE\r
2844 );\r
2845 } else if (TmpBufSize > 0) {\r
2846 *BufferSize = (UINTN) TmpBufSize;\r
2847 Status = EFI_BUFFER_TOO_SMALL;\r
2848 }\r
2849 } else if (Buffer == NULL || Private->FileSize > *BufferSize) {\r
2850 *BufferSize = Private->FileSize;\r
2851 Status = EFI_BUFFER_TOO_SMALL;\r
2852 } else {\r
2853 //\r
2854 // Download the file.\r
2855 //\r
2856 TmpBufSize = (UINT64) (*BufferSize);\r
2857 Status = PxeBc->Mtftp (\r
2858 PxeBc,\r
2859 EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r
2860 Buffer,\r
2861 FALSE,\r
2862 &TmpBufSize,\r
2863 &Private->BlockSize,\r
2864 &Private->ServerIp,\r
2865 (UINT8 *) Private->BootFileName,\r
2866 NULL,\r
2867 FALSE\r
2868 );\r
2869 }\r
2870 //\r
2871 // If we added a callback protocol, now is the time to remove it.\r
2872 //\r
2873 if (NewMakeCallback) {\r
2874\r
2875 NewMakeCallback = FALSE;\r
2876\r
2877 PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);\r
2878\r
2879 gBS->UninstallProtocolInterface (\r
2880 Private->Controller,\r
2881 &gEfiPxeBaseCodeCallbackProtocolGuid,\r
2882 &Private->LoadFileCallback\r
2883 );\r
2884 }\r
2885\r
2886 //\r
2887 // Check download status\r
2888 //\r
2889 if (Status == EFI_SUCCESS) {\r
2890 //\r
2891 // The functionality of PXE Base Code protocol will not be stopped,\r
2892 // when downloading is successfully.\r
2893 //\r
2894 return EFI_SUCCESS;\r
2895\r
2896 } else if (Status == EFI_BUFFER_TOO_SMALL) {\r
2897 if (Buffer != NULL) {\r
2898 AsciiPrint ("PXE-E05: Download buffer is smaller than requested file.\n");\r
2899 } else {\r
2900 //\r
2901 // The functionality of PXE Base Code protocol will not be stopped.\r
2902 //\r
2903 return Status;\r
2904 }\r
2905\r
2906 } else if (Status == EFI_DEVICE_ERROR) {\r
2907 AsciiPrint ("PXE-E07: Network device error.\n");\r
2908\r
2909 } else if (Status == EFI_OUT_OF_RESOURCES) {\r
2910 AsciiPrint ("PXE-E09: Could not allocate I/O buffers.\n");\r
2911\r
2912 } else if (Status == EFI_NO_MEDIA) {\r
2913 AsciiPrint ("PXE-E12: Could not detect network connection.\n");\r
2914\r
2915 } else if (Status == EFI_NO_RESPONSE) {\r
2916 AsciiPrint ("PXE-E16: No offer received.\n");\r
2917\r
2918 } else if (Status == EFI_TIMEOUT) {\r
2919 AsciiPrint ("PXE-E18: Server response timeout.\n");\r
2920\r
2921 } else if (Status == EFI_ABORTED) {\r
2922 AsciiPrint ("PXE-E21: Remote boot cancelled.\n");\r
2923\r
2924 } else if (Status == EFI_ICMP_ERROR) {\r
2925 AsciiPrint ("PXE-E22: Client received ICMP error from server.\n");\r
2926\r
2927 } else if (Status == EFI_TFTP_ERROR) {\r
2928 AsciiPrint ("PXE-E23: Client received TFTP error from server.\n");\r
2929\r
2930 } else {\r
2931 AsciiPrint ("PXE-E99: Unexpected network error.\n");\r
2932 }\r
2933\r
2934 PxeBc->Stop (PxeBc);\r
2935\r
2936 return Status;\r
2937}\r
2938\r
2939EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate = { EfiPxeLoadFile };\r
2940\r
EFI Development Kit II mirror for PVE