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