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