]> git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/UefiPxeBcDxe/PxeBcImpl.c
projects / mirror_edk2.git / blob
? search:


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