]> git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/UefiPxeBcDxe/PxeBcImpl.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
NetworkPkg/UefiPxeBcDxe: Use the specified MTFTP windowsize.
[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 - 2018, 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 = 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_CACHED_DHCP6_PACKET_MAX_SIZE;
106 Private->DhcpAck.Dhcp6.Packet.Ack.Size = PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE;
107 Private->PxeReply.Dhcp6.Packet.Ack.Size = PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE;
108
109 for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {
110 Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = PXEBC_CACHED_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 = 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_CACHED_DHCP4_PACKET_MAX_SIZE;
158 Private->DhcpAck.Dhcp4.Packet.Ack.Size = PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE;
159 Private->PxeReply.Dhcp4.Packet.Ack.Size = PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE;
160
161 for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {
162 Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = PXEBC_CACHED_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 UINTN WindowSize;
853
854 if ((This == NULL) ||
855 (Filename == NULL) ||
856 (BufferSize == NULL) ||
857 (ServerIp == NULL) ||
858 ((BlockSize != NULL) && (*BlockSize < PXE_MTFTP_DEFAULT_BLOCK_SIZE))) {
859 return EFI_INVALID_PARAMETER;
860 }
861
862 if (Operation == EFI_PXE_BASE_CODE_TFTP_READ_FILE ||
863 Operation == EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY ||
864 Operation == EFI_PXE_BASE_CODE_MTFTP_READ_FILE ||
865 Operation == EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY) {
866 if (BufferPtr == NULL && !DontUseBuffer) {
867 return EFI_INVALID_PARAMETER;
868 }
869 }
870
871 Config = NULL;
872 Status = EFI_DEVICE_ERROR;
873 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
874 Mode = Private->PxeBc.Mode;
875
876 //
877 // Get PcdPxeTftpWindowSize.
878 //
879 WindowSize = (UINTN) PcdGet64 (PcdPxeTftpWindowSize);
880
881 if (Mode->UsingIpv6) {
882 if (!NetIp6IsValidUnicast (&ServerIp->v6)) {
883 return EFI_INVALID_PARAMETER;
884 }
885 } else {
886 if (IP4_IS_UNSPECIFIED (NTOHL (ServerIp->Addr[0])) || IP4_IS_LOCAL_BROADCAST (NTOHL (ServerIp->Addr[0]))) {
887 return EFI_INVALID_PARAMETER;
888 }
889 }
890
891 if (Mode->UsingIpv6) {
892 //
893 // Set configuration data for Mtftp6 instance.
894 //
895 ZeroMem (&Mtftp6Config, sizeof (EFI_MTFTP6_CONFIG_DATA));
896 Config = &Mtftp6Config;
897 Mtftp6Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;
898 Mtftp6Config.TryCount = PXEBC_MTFTP_RETRIES;
899 CopyMem (&Mtftp6Config.StationIp, &Private->StationIp.v6, sizeof (EFI_IPv6_ADDRESS));
900 CopyMem (&Mtftp6Config.ServerIp, &ServerIp->v6, sizeof (EFI_IPv6_ADDRESS));
901 //
902 // Stop Udp6Read instance
903 //
904 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
905 } else {
906 //
907 // Set configuration data for Mtftp4 instance.
908 //
909 ZeroMem (&Mtftp4Config, sizeof (EFI_MTFTP4_CONFIG_DATA));
910 Config = &Mtftp4Config;
911 Mtftp4Config.UseDefaultSetting = FALSE;
912 Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;
913 Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;
914 CopyMem (&Mtftp4Config.StationIp, &Private->StationIp.v4, sizeof (EFI_IPv4_ADDRESS));
915 CopyMem (&Mtftp4Config.SubnetMask, &Private->SubnetMask.v4, sizeof (EFI_IPv4_ADDRESS));
916 CopyMem (&Mtftp4Config.GatewayIp, &Private->GatewayIp.v4, sizeof (EFI_IPv4_ADDRESS));
917 CopyMem (&Mtftp4Config.ServerIp, &ServerIp->v4, sizeof (EFI_IPv4_ADDRESS));
918 //
919 // Stop Udp4Read instance
920 //
921 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
922 }
923
924 Mode->TftpErrorReceived = FALSE;
925 Mode->IcmpErrorReceived = FALSE;
926
927 switch (Operation) {
928
929 case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE:
930 //
931 // Send TFTP request to get file size.
932 //
933 Status = PxeBcTftpGetFileSize (
934 Private,
935 Config,
936 Filename,
937 BlockSize,
938 (WindowSize > 1) ? &WindowSize : NULL,
939 BufferSize
940 );
941
942 break;
943
944 case EFI_PXE_BASE_CODE_TFTP_READ_FILE:
945 //
946 // Send TFTP request to read file.
947 //
948 Status = PxeBcTftpReadFile (
949 Private,
950 Config,
951 Filename,
952 BlockSize,
953 (WindowSize > 1) ? &WindowSize : NULL,
954 BufferPtr,
955 BufferSize,
956 DontUseBuffer
957 );
958
959 break;
960
961 case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE:
962 //
963 // Send TFTP request to write file.
964 //
965 Status = PxeBcTftpWriteFile (
966 Private,
967 Config,
968 Filename,
969 Overwrite,
970 BlockSize,
971 BufferPtr,
972 BufferSize
973 );
974
975 break;
976
977 case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY:
978 //
979 // Send TFTP request to read directory.
980 //
981 Status = PxeBcTftpReadDirectory (
982 Private,
983 Config,
984 Filename,
985 BlockSize,
986 (WindowSize > 1) ? &WindowSize : NULL,
987 BufferPtr,
988 BufferSize,
989 DontUseBuffer
990 );
991
992 break;
993
994 case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE:
995 case EFI_PXE_BASE_CODE_MTFTP_READ_FILE:
996 case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY:
997 Status = EFI_UNSUPPORTED;
998
999 break;
1000
1001 default:
1002 Status = EFI_INVALID_PARAMETER;
1003
1004 break;
1005 }
1006
1007 if (Status == EFI_ICMP_ERROR) {
1008 Mode->IcmpErrorReceived = TRUE;
1009 }
1010
1011 //
1012 // Reconfigure the UDP instance with the default configuration.
1013 //
1014 if (Mode->UsingIpv6) {
1015 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
1016 } else {
1017 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
1018 }
1019 //
1020 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
1021 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1022 //
1023 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
1024 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
1025 This->SetIpFilter (This, &IpFilter);
1026
1027 return Status;
1028 }
1029
1030
1031 /**
1032 Writes a UDP packet to the network interface.
1033
1034 This function writes a UDP packet specified by the (optional HeaderPtr and)
1035 BufferPtr parameters to the network interface. The UDP header is automatically
1036 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
1037 SrcIp, and SrcPort to build this header. If the packet is successfully built and
1038 transmitted through the network interface, then EFI_SUCCESS will be returned.
1039 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
1040 be returned. If an ICMP error occurs during the transmission of the packet, then
1041 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
1042 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
1043 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
1044
1045 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1046 @param[in] OpFlags The UDP operation flags.
1047 @param[in] DestIp The destination IP address.
1048 @param[in] DestPort The destination UDP port number.
1049 @param[in] GatewayIp The gateway IP address.
1050 @param[in] SrcIp The source IP address.
1051 @param[in, out] SrcPort The source UDP port number.
1052 @param[in] HeaderSize An optional field which may be set to the length of a header
1053 at HeaderPtr to be prefixed to the data at BufferPtr.
1054 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
1055 prefixed to the data at BufferPtr.
1056 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
1057 @param[in] BufferPtr A pointer to the data to be written.
1058
1059 @retval EFI_SUCCESS The UDP Write operation completed.
1060 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1061 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1062 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
1063 @retval EFI_ABORTED The callback function aborted the UDP Write operation.
1064 @retval EFI_TIMEOUT The UDP Write operation timed out.
1065 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
1066
1067 **/
1068 EFI_STATUS
1069 EFIAPI
1070 EfiPxeBcUdpWrite (
1071 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1072 IN UINT16 OpFlags,
1073 IN EFI_IP_ADDRESS *DestIp,
1074 IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,
1075 IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,
1076 IN EFI_IP_ADDRESS *SrcIp OPTIONAL,
1077 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
1078 IN UINTN *HeaderSize OPTIONAL,
1079 IN VOID *HeaderPtr OPTIONAL,
1080 IN UINTN *BufferSize,
1081 IN VOID *BufferPtr
1082 )
1083 {
1084 PXEBC_PRIVATE_DATA *Private;
1085 EFI_PXE_BASE_CODE_MODE *Mode;
1086 EFI_UDP4_SESSION_DATA Udp4Session;
1087 EFI_UDP6_SESSION_DATA Udp6Session;
1088 EFI_STATUS Status;
1089 BOOLEAN DoNotFragment;
1090
1091 if (This == NULL || DestIp == NULL || DestPort == NULL) {
1092 return EFI_INVALID_PARAMETER;
1093 }
1094
1095 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1096 Mode = Private->PxeBc.Mode;
1097
1098 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT) != 0) {
1099 DoNotFragment = FALSE;
1100 } else {
1101 DoNotFragment = TRUE;
1102 }
1103
1104 if (!Mode->UsingIpv6 && GatewayIp != NULL && Mode->SubnetMask.Addr[0] != 0 &&
1105 !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), EFI_NTOHL(Mode->SubnetMask))) {
1106 //
1107 // Gateway is provided but it's not a unicast IPv4 address, while it will be ignored for IPv6.
1108 //
1109 return EFI_INVALID_PARAMETER;
1110 }
1111
1112 if (HeaderSize != NULL && (*HeaderSize == 0 || HeaderPtr == NULL)) {
1113 return EFI_INVALID_PARAMETER;
1114 }
1115
1116 if (BufferSize == NULL || (*BufferSize != 0 && BufferPtr == NULL)) {
1117 return EFI_INVALID_PARAMETER;
1118 }
1119
1120 if (!Mode->Started) {
1121 return EFI_NOT_STARTED;
1122 }
1123
1124 if (!Private->IsAddressOk && SrcIp == NULL) {
1125 return EFI_INVALID_PARAMETER;
1126 }
1127
1128 if (Private->CurSrcPort == 0 ||
1129 (SrcPort != NULL && *SrcPort != Private->CurSrcPort)) {
1130 //
1131 // Reconfigure UDPv4/UDPv6 for UdpWrite if the source port changed.
1132 //
1133 if (SrcPort != NULL) {
1134 Private->CurSrcPort = *SrcPort;
1135 }
1136 }
1137
1138 if (Mode->UsingIpv6) {
1139 Status = PxeBcConfigUdp6Write (
1140 Private->Udp6Write,
1141 &Private->StationIp.v6,
1142 &Private->CurSrcPort
1143 );
1144 } else {
1145 //
1146 // Configure the UDPv4 instance with gateway information from DHCP server as default.
1147 //
1148 Status = PxeBcConfigUdp4Write (
1149 Private->Udp4Write,
1150 &Private->StationIp.v4,
1151 &Private->SubnetMask.v4,
1152 &Private->GatewayIp.v4,
1153 &Private->CurSrcPort,
1154 DoNotFragment,
1155 Private->Mode.TTL,
1156 Private->Mode.ToS
1157 );
1158 }
1159
1160 if (EFI_ERROR (Status)) {
1161 Private->CurSrcPort = 0;
1162 return EFI_INVALID_PARAMETER;
1163 } else if (SrcPort != NULL) {
1164 *SrcPort = Private->CurSrcPort;
1165 }
1166
1167 //
1168 // Start a timer as timeout event for this blocking API.
1169 //
1170 gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);
1171
1172 if (Mode->UsingIpv6) {
1173 //
1174 // Construct UDPv6 session data.
1175 //
1176 ZeroMem (&Udp6Session, sizeof (EFI_UDP6_SESSION_DATA));
1177 CopyMem (&Udp6Session.DestinationAddress, DestIp, sizeof (EFI_IPv6_ADDRESS));
1178 Udp6Session.DestinationPort = *DestPort;
1179 if (SrcIp != NULL) {
1180 CopyMem (&Udp6Session.SourceAddress, SrcIp, sizeof (EFI_IPv6_ADDRESS));
1181 }
1182 if (SrcPort != NULL) {
1183 Udp6Session.SourcePort = *SrcPort;
1184 }
1185
1186 Status = PxeBcUdp6Write (
1187 Private->Udp6Write,
1188 &Udp6Session,
1189 Private->UdpTimeOutEvent,
1190 HeaderSize,
1191 HeaderPtr,
1192 BufferSize,
1193 BufferPtr
1194 );
1195 } else {
1196 //
1197 // Construct UDPv4 session data.
1198 //
1199 ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));
1200 CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));
1201 Udp4Session.DestinationPort = *DestPort;
1202 if (SrcIp != NULL) {
1203 CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));
1204 }
1205 if (SrcPort != NULL) {
1206 Udp4Session.SourcePort = *SrcPort;
1207 }
1208 //
1209 // Override the gateway information if user specified.
1210 //
1211 Status = PxeBcUdp4Write (
1212 Private->Udp4Write,
1213 &Udp4Session,
1214 Private->UdpTimeOutEvent,
1215 (EFI_IPv4_ADDRESS *) GatewayIp,
1216 HeaderSize,
1217 HeaderPtr,
1218 BufferSize,
1219 BufferPtr
1220 );
1221 }
1222
1223 gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);
1224
1225
1226 //
1227 // Reset the UdpWrite instance.
1228 //
1229 if (Mode->UsingIpv6) {
1230 Private->Udp6Write->Configure (Private->Udp6Write, NULL);
1231 } else {
1232 Private->Udp4Write->Configure (Private->Udp4Write, NULL);
1233 }
1234
1235 return Status;
1236 }
1237
1238
1239 /**
1240 Reads a UDP packet from the network interface.
1241 +
1242 This function reads a UDP packet from a network interface. The data contents
1243 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
1244 buffer received is returned in BufferSize . If the input BufferSize is smaller
1245 than the UDP packet received (less optional HeaderSize), it will be set to the
1246 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
1247 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
1248 successfully received, then EFI_SUCCESS will be returned, and the information
1249 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
1250 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,
1251 SrcIp, and SrcPort input values, different types of UDP packet receive filtering
1252 will be performed. The following tables summarize these receive filter operations.
1253
1254 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1255 @param[in] OpFlags The UDP operation flags.
1256 @param[in, out] DestIp The destination IP address.
1257 @param[in, out] DestPort The destination UDP port number.
1258 @param[in, out] SrcIp The source IP address.
1259 @param[in, out] SrcPort The source UDP port number.
1260 @param[in] HeaderSize An optional field which may be set to the length of a
1261 header at HeaderPtr to be prefixed to the data at BufferPtr.
1262 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
1263 prefixed to the data at BufferPtr.
1264 @param[in, out] BufferSize A pointer to the size of the data at BufferPtr.
1265 @param[in] BufferPtr A pointer to the data to be read.
1266
1267 @retval EFI_SUCCESS The UDP Read operation was completed.
1268 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1269 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1270 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1271 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
1272 @retval EFI_ABORTED The callback function aborted the UDP Read operation.
1273 @retval EFI_TIMEOUT The UDP Read operation timed out.
1274
1275 **/
1276 EFI_STATUS
1277 EFIAPI
1278 EfiPxeBcUdpRead (
1279 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1280 IN UINT16 OpFlags,
1281 IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
1282 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
1283 IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
1284 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
1285 IN UINTN *HeaderSize OPTIONAL,
1286 IN VOID *HeaderPtr OPTIONAL,
1287 IN OUT UINTN *BufferSize,
1288 IN VOID *BufferPtr
1289 )
1290 {
1291 PXEBC_PRIVATE_DATA *Private;
1292 EFI_PXE_BASE_CODE_MODE *Mode;
1293 EFI_UDP4_COMPLETION_TOKEN Udp4Token;
1294 EFI_UDP6_COMPLETION_TOKEN Udp6Token;
1295 EFI_UDP4_RECEIVE_DATA *Udp4Rx;
1296 EFI_UDP6_RECEIVE_DATA *Udp6Rx;
1297 EFI_STATUS Status;
1298 BOOLEAN IsDone;
1299 BOOLEAN IsMatched;
1300 UINTN CopiedLen;
1301 UINTN HeaderLen;
1302 UINTN HeaderCopiedLen;
1303 UINTN BufferCopiedLen;
1304 UINT32 FragmentLength;
1305 UINTN FragmentIndex;
1306 UINT8 *FragmentBuffer;
1307
1308 if (This == NULL) {
1309 return EFI_INVALID_PARAMETER;
1310 }
1311
1312 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1313 Mode = Private->PxeBc.Mode;
1314 IsDone = FALSE;
1315 IsMatched = FALSE;
1316 Udp4Rx = NULL;
1317 Udp6Rx = NULL;
1318
1319 if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && DestPort == NULL) ||
1320 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) == 0 && SrcIp == NULL) ||
1321 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) == 0 && SrcPort == NULL)) {
1322 return EFI_INVALID_PARAMETER;
1323 }
1324
1325 if ((HeaderSize != NULL && *HeaderSize == 0) || (HeaderSize != NULL && HeaderPtr == NULL)) {
1326 return EFI_INVALID_PARAMETER;
1327 }
1328
1329 if ((BufferSize == NULL) || (BufferPtr == NULL)) {
1330 return EFI_INVALID_PARAMETER;
1331 }
1332
1333 if (!Mode->Started) {
1334 return EFI_NOT_STARTED;
1335 }
1336
1337 ZeroMem (&Udp6Token, sizeof (EFI_UDP6_COMPLETION_TOKEN));
1338 ZeroMem (&Udp4Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));
1339
1340 if (Mode->UsingIpv6) {
1341 Status = gBS->CreateEvent (
1342 EVT_NOTIFY_SIGNAL,
1343 TPL_NOTIFY,
1344 PxeBcCommonNotify,
1345 &IsDone,
1346 &Udp6Token.Event
1347 );
1348 if (EFI_ERROR (Status)) {
1349 return EFI_OUT_OF_RESOURCES;
1350 }
1351 } else {
1352 Status = gBS->CreateEvent (
1353 EVT_NOTIFY_SIGNAL,
1354 TPL_NOTIFY,
1355 PxeBcCommonNotify,
1356 &IsDone,
1357 &Udp4Token.Event
1358 );
1359 if (EFI_ERROR (Status)) {
1360 return EFI_OUT_OF_RESOURCES;
1361 }
1362 }
1363
1364 //
1365 // Start a timer as timeout event for this blocking API.
1366 //
1367 gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);
1368 Mode->IcmpErrorReceived = FALSE;
1369
1370 //
1371 // Read packet by Udp4Read/Udp6Read until matched or timeout.
1372 //
1373 while (!IsMatched && !EFI_ERROR (Status)) {
1374 if (Mode->UsingIpv6) {
1375 Status = PxeBcUdp6Read (
1376 Private->Udp6Read,
1377 &Udp6Token,
1378 Mode,
1379 Private->UdpTimeOutEvent,
1380 OpFlags,
1381 &IsDone,
1382 &IsMatched,
1383 DestIp,
1384 DestPort,
1385 SrcIp,
1386 SrcPort
1387 );
1388 } else {
1389 Status = PxeBcUdp4Read (
1390 Private->Udp4Read,
1391 &Udp4Token,
1392 Mode,
1393 Private->UdpTimeOutEvent,
1394 OpFlags,
1395 &IsDone,
1396 &IsMatched,
1397 DestIp,
1398 DestPort,
1399 SrcIp,
1400 SrcPort
1401 );
1402 }
1403 }
1404
1405 if (Status == EFI_ICMP_ERROR ||
1406 Status == EFI_NETWORK_UNREACHABLE ||
1407 Status == EFI_HOST_UNREACHABLE ||
1408 Status == EFI_PROTOCOL_UNREACHABLE ||
1409 Status == EFI_PORT_UNREACHABLE) {
1410 //
1411 // Get different return status for icmp error from Udp, refers to UEFI spec.
1412 //
1413 Mode->IcmpErrorReceived = TRUE;
1414 }
1415 gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);
1416
1417 if (IsMatched) {
1418 //
1419 // Copy the rececived packet to user if matched by filter.
1420 //
1421 if (Mode->UsingIpv6) {
1422 Udp6Rx = Udp6Token.Packet.RxData;
1423 ASSERT (Udp6Rx != NULL);
1424
1425 HeaderLen = 0;
1426 if (HeaderSize != NULL) {
1427 HeaderLen = MIN (*HeaderSize, Udp6Rx->DataLength);
1428 }
1429
1430 if (Udp6Rx->DataLength - HeaderLen > *BufferSize) {
1431 Status = EFI_BUFFER_TOO_SMALL;
1432 } else {
1433 if (HeaderSize != NULL) {
1434 *HeaderSize = HeaderLen;
1435 }
1436 *BufferSize = Udp6Rx->DataLength - HeaderLen;
1437
1438 HeaderCopiedLen = 0;
1439 BufferCopiedLen = 0;
1440 for (FragmentIndex = 0; FragmentIndex < Udp6Rx->FragmentCount; FragmentIndex++) {
1441 FragmentLength = Udp6Rx->FragmentTable[FragmentIndex].FragmentLength;
1442 FragmentBuffer = Udp6Rx->FragmentTable[FragmentIndex].FragmentBuffer;
1443 if (HeaderCopiedLen + FragmentLength < HeaderLen) {
1444 //
1445 // Copy the header part of received data.
1446 //
1447 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
1448 HeaderCopiedLen += FragmentLength;
1449 } else if (HeaderCopiedLen < HeaderLen) {
1450 //
1451 // Copy the header part of received data.
1452 //
1453 CopiedLen = HeaderLen - HeaderCopiedLen;
1454 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
1455 HeaderCopiedLen += CopiedLen;
1456
1457 //
1458 // Copy the other part of received data.
1459 //
1460 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
1461 BufferCopiedLen += (FragmentLength - CopiedLen);
1462 } else {
1463 //
1464 // Copy the other part of received data.
1465 //
1466 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
1467 BufferCopiedLen += FragmentLength;
1468 }
1469 }
1470 }
1471 //
1472 // Recycle the receiving buffer after copy to user.
1473 //
1474 gBS->SignalEvent (Udp6Rx->RecycleSignal);
1475 } else {
1476 Udp4Rx = Udp4Token.Packet.RxData;
1477 ASSERT (Udp4Rx != NULL);
1478
1479 HeaderLen = 0;
1480 if (HeaderSize != NULL) {
1481 HeaderLen = MIN (*HeaderSize, Udp4Rx->DataLength);
1482 }
1483
1484 if (Udp4Rx->DataLength - HeaderLen > *BufferSize) {
1485 Status = EFI_BUFFER_TOO_SMALL;
1486 } else {
1487 if (HeaderSize != NULL) {
1488 *HeaderSize = HeaderLen;
1489 }
1490 *BufferSize = Udp4Rx->DataLength - HeaderLen;
1491
1492 HeaderCopiedLen = 0;
1493 BufferCopiedLen = 0;
1494 for (FragmentIndex = 0; FragmentIndex < Udp4Rx->FragmentCount; FragmentIndex++) {
1495 FragmentLength = Udp4Rx->FragmentTable[FragmentIndex].FragmentLength;
1496 FragmentBuffer = Udp4Rx->FragmentTable[FragmentIndex].FragmentBuffer;
1497 if (HeaderCopiedLen + FragmentLength < HeaderLen) {
1498 //
1499 // Copy the header part of received data.
1500 //
1501 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
1502 HeaderCopiedLen += FragmentLength;
1503 } else if (HeaderCopiedLen < HeaderLen) {
1504 //
1505 // Copy the header part of received data.
1506 //
1507 CopiedLen = HeaderLen - HeaderCopiedLen;
1508 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
1509 HeaderCopiedLen += CopiedLen;
1510
1511 //
1512 // Copy the other part of received data.
1513 //
1514 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
1515 BufferCopiedLen += (FragmentLength - CopiedLen);
1516 } else {
1517 //
1518 // Copy the other part of received data.
1519 //
1520 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
1521 BufferCopiedLen += FragmentLength;
1522 }
1523 }
1524 }
1525 //
1526 // Recycle the receiving buffer after copy to user.
1527 //
1528 gBS->SignalEvent (Udp4Rx->RecycleSignal);
1529 }
1530 }
1531
1532 if (Mode->UsingIpv6) {
1533 Private->Udp6Read->Cancel (Private->Udp6Read, &Udp6Token);
1534 gBS->CloseEvent (Udp6Token.Event);
1535 } else {
1536 Private->Udp4Read->Cancel (Private->Udp4Read, &Udp4Token);
1537 gBS->CloseEvent (Udp4Token.Event);
1538 }
1539
1540 return Status;
1541 }
1542
1543
1544 /**
1545 Updates the IP receive filters of a network device and enables software filtering.
1546
1547 The NewFilter field is used to modify the network device's current IP receive
1548 filter settings and to enable a software filter. This function updates the IpFilter
1549 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
1550 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
1551 The current hardware filter remains in effect no matter what the settings of OpFlags.
1552 This is so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
1553 packets whose reception is enabled in hardware-physical NIC address (unicast),
1554 broadcast address, logical address or addresses (multicast), or all (promiscuous).
1555 UdpRead() does not modify the IP filter settings.
1556 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
1557 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1558 If an application or driver wishes to preserve the IP receive filter settings,
1559 it will have to preserve the IP receive filter settings before these calls, and
1560 use SetIpFilter() to restore them after the calls. If incompatible filtering is
1561 requested (for example, PROMISCUOUS with anything else), or if the device does not
1562 support a requested filter setting and it cannot be accommodated in software
1563 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
1564 The IPlist field is used to enable IPs other than the StationIP. They may be
1565 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
1566 then both the StationIP and the IPs from the IPlist will be used.
1567
1568 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1569 @param[in] NewFilter Pointer to the new set of IP receive filters.
1570
1571 @retval EFI_SUCCESS The IP receive filter settings were updated.
1572 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1573 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1574
1575 **/
1576 EFI_STATUS
1577 EFIAPI
1578 EfiPxeBcSetIpFilter (
1579 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1580 IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter
1581 )
1582 {
1583 EFI_STATUS Status;
1584 PXEBC_PRIVATE_DATA *Private;
1585 EFI_PXE_BASE_CODE_MODE *Mode;
1586 EFI_UDP4_CONFIG_DATA *Udp4Cfg;
1587 EFI_UDP6_CONFIG_DATA *Udp6Cfg;
1588 UINTN Index;
1589 BOOLEAN NeedPromiscuous;
1590 BOOLEAN AcceptPromiscuous;
1591 BOOLEAN AcceptBroadcast;
1592 BOOLEAN MultiCastUpdate;
1593
1594 if (This == NULL || NewFilter == NULL) {
1595 return EFI_INVALID_PARAMETER;
1596 }
1597
1598 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1599 Mode = Private->PxeBc.Mode;
1600 Status = EFI_SUCCESS;
1601 NeedPromiscuous = FALSE;
1602
1603 if (!Mode->Started) {
1604 return EFI_NOT_STARTED;
1605 }
1606
1607 for (Index = 0; Index < NewFilter->IpCnt; Index++) {
1608 ASSERT (Index < EFI_PXE_BASE_CODE_MAX_IPCNT);
1609 if (!Mode->UsingIpv6 &&
1610 IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {
1611 //
1612 // IPv4 broadcast address should not be in IP filter.
1613 //
1614 return EFI_INVALID_PARAMETER;
1615 }
1616 if (Mode->UsingIpv6) {
1617 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0 &&
1618 NetIp6IsValidUnicast (&NewFilter->IpList[Index].v6)) {
1619 NeedPromiscuous = TRUE;
1620 }
1621 } else if ((EFI_NTOHL(Mode->StationIp) != 0) &&
1622 (EFI_NTOHL(Mode->SubnetMask) != 0) &&
1623 IP4_NET_EQUAL(EFI_NTOHL(Mode->StationIp), EFI_NTOHL(NewFilter->IpList[Index].v4), EFI_NTOHL(Mode->SubnetMask.v4)) &&
1624 NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), EFI_NTOHL(Mode->SubnetMask)) &&
1625 ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0)) {
1626 NeedPromiscuous = TRUE;
1627 }
1628 }
1629
1630 AcceptPromiscuous = FALSE;
1631 AcceptBroadcast = FALSE;
1632 MultiCastUpdate = FALSE;
1633
1634 if (NeedPromiscuous ||
1635 (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0 ||
1636 (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) {
1637 //
1638 // Configure UDPv4/UDPv6 as promiscuous mode to receive all packets.
1639 //
1640 AcceptPromiscuous = TRUE;
1641 } else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {
1642 //
1643 // Configure UDPv4 to receive all broadcast packets.
1644 //
1645 AcceptBroadcast = TRUE;
1646 }
1647
1648 //
1649 // In multicast condition when Promiscuous FALSE and IpCnt no-zero.
1650 // Here check if there is any update of the multicast ip address. If yes,
1651 // we need leave the old multicast group (by Config UDP instance to NULL),
1652 // and join the new multicast group.
1653 //
1654 if (!AcceptPromiscuous) {
1655 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {
1656 if (Mode->IpFilter.IpCnt != NewFilter->IpCnt) {
1657 MultiCastUpdate = TRUE;
1658 } else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {
1659 MultiCastUpdate = TRUE;
1660 }
1661 }
1662 }
1663
1664 if (!Mode->UsingIpv6) {
1665 //
1666 // Check whether we need reconfigure the UDP4 instance.
1667 //
1668 Udp4Cfg = &Private->Udp4CfgData;
1669 if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||
1670 (AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {
1671 //
1672 // Clear the UDP4 instance configuration, all joined groups will be left
1673 // during the operation.
1674 //
1675 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
1676
1677 //
1678 // Configure the UDP instance with the new configuration.
1679 //
1680 Udp4Cfg->AcceptPromiscuous = AcceptPromiscuous;
1681 Udp4Cfg->AcceptBroadcast = AcceptBroadcast;
1682 Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);
1683 if (EFI_ERROR (Status)) {
1684 return Status;
1685 }
1686
1687 //
1688 // In not Promiscuous mode, need to join the new multicast group.
1689 //
1690 if (!AcceptPromiscuous) {
1691 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
1692 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {
1693 //
1694 // Join the mutilcast group.
1695 //
1696 Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);
1697 if (EFI_ERROR (Status)) {
1698 return Status;
1699 }
1700 }
1701 }
1702 }
1703 }
1704 } else {
1705 //
1706 // Check whether we need reconfigure the UDP6 instance.
1707 //
1708 Udp6Cfg = &Private->Udp6CfgData;
1709 if ((AcceptPromiscuous != Udp6Cfg->AcceptPromiscuous) || MultiCastUpdate) {
1710 //
1711 // Clear the UDP6 instance configuration, all joined groups will be left
1712 // during the operation.
1713 //
1714 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
1715
1716 //
1717 // Configure the UDP instance with the new configuration.
1718 //
1719 Udp6Cfg->AcceptPromiscuous = AcceptPromiscuous;
1720 Status = Private->Udp6Read->Configure (Private->Udp6Read, Udp6Cfg);
1721 if (EFI_ERROR (Status)) {
1722 return Status;
1723 }
1724
1725 //
1726 // In not Promiscuous mode, need to join the new multicast group.
1727 //
1728 if (!AcceptPromiscuous) {
1729 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
1730 if (IP6_IS_MULTICAST (&NewFilter->IpList[Index].v6)) {
1731 //
1732 // Join the mutilcast group.
1733 //
1734 Status = Private->Udp6Read->Groups (Private->Udp6Read, TRUE, &NewFilter->IpList[Index].v6);
1735 if (EFI_ERROR (Status)) {
1736 return Status;
1737 }
1738 }
1739 }
1740 }
1741 }
1742 }
1743
1744 //
1745 // Save the new IP filter into mode data.
1746 //
1747 CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));
1748
1749 return Status;
1750 }
1751
1752
1753 /**
1754 Uses the ARP protocol to resolve a MAC address. It is not supported for IPv6.
1755
1756 This function uses the ARP protocol to resolve a MAC address. The IP address specified
1757 by IpAddr is used to resolve a MAC address. If the ARP protocol succeeds in resolving
1758 the specified address, then the ArpCacheEntries and ArpCache fields of the mode data
1759 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
1760 MAC address is placed there as well. If the PXE Base Code protocol is in the
1761 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters
1762 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is
1763 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
1764 then EFI_ABORTED is returned.
1765
1766 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1767 @param[in] IpAddr Pointer to the IP address that is used to resolve a MAC address.
1768 @param[in] MacAddr If not NULL, a pointer to the MAC address that was resolved with the
1769 ARP protocol.
1770
1771 @retval EFI_SUCCESS The IP or MAC address was resolved.
1772 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1773 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1774 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1775 @retval EFI_ICMP_ERROR An error occur with the ICMP packet message.
1776
1777 **/
1778 EFI_STATUS
1779 EFIAPI
1780 EfiPxeBcArp (
1781 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1782 IN EFI_IP_ADDRESS *IpAddr,
1783 IN EFI_MAC_ADDRESS *MacAddr OPTIONAL
1784 )
1785 {
1786 PXEBC_PRIVATE_DATA *Private;
1787 EFI_PXE_BASE_CODE_MODE *Mode;
1788 EFI_EVENT ResolvedEvent;
1789 EFI_STATUS Status;
1790 EFI_MAC_ADDRESS TempMac;
1791 EFI_MAC_ADDRESS ZeroMac;
1792 BOOLEAN IsResolved;
1793
1794 if (This == NULL || IpAddr == NULL) {
1795 return EFI_INVALID_PARAMETER;
1796 }
1797
1798 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1799 Mode = Private->PxeBc.Mode;
1800 ResolvedEvent = NULL;
1801 Status = EFI_SUCCESS;
1802 IsResolved = FALSE;
1803
1804 if (!Mode->Started) {
1805 return EFI_NOT_STARTED;
1806 }
1807
1808 if (Mode->UsingIpv6) {
1809 return EFI_UNSUPPORTED;
1810 }
1811
1812 //
1813 // Station address should be ready before do arp.
1814 //
1815 if (!Private->IsAddressOk) {
1816 return EFI_INVALID_PARAMETER;
1817 }
1818
1819 Mode->IcmpErrorReceived = FALSE;
1820 ZeroMem (&TempMac, sizeof (EFI_MAC_ADDRESS));
1821 ZeroMem (&ZeroMac, sizeof (EFI_MAC_ADDRESS));
1822
1823 if (!Mode->AutoArp) {
1824 //
1825 // If AutoArp is FALSE, only search in the current Arp cache.
1826 //
1827 PxeBcArpCacheUpdate (NULL, Private);
1828 if (!PxeBcCheckArpCache (Mode, &IpAddr->v4, &TempMac)) {
1829 Status = EFI_DEVICE_ERROR;
1830 goto ON_EXIT;
1831 }
1832 } else {
1833 Status = gBS->CreateEvent (
1834 EVT_NOTIFY_SIGNAL,
1835 TPL_NOTIFY,
1836 PxeBcCommonNotify,
1837 &IsResolved,
1838 &ResolvedEvent
1839 );
1840 if (EFI_ERROR (Status)) {
1841 goto ON_EXIT;
1842 }
1843
1844 //
1845 // If AutoArp is TRUE, try to send Arp request on initiative.
1846 //
1847 Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, ResolvedEvent, &TempMac);
1848 if (EFI_ERROR (Status) && Status != EFI_NOT_READY) {
1849 goto ON_EXIT;
1850 }
1851
1852 while (!IsResolved) {
1853 if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {
1854 break;
1855 }
1856 }
1857 if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {
1858 Status = EFI_SUCCESS;
1859 } else {
1860 Status = EFI_TIMEOUT;
1861 }
1862 }
1863
1864 //
1865 // Copy the Mac address to user if needed.
1866 //
1867 if (MacAddr != NULL && !EFI_ERROR (Status)) {
1868 CopyMem (MacAddr, &TempMac, sizeof (EFI_MAC_ADDRESS));
1869 }
1870
1871 ON_EXIT:
1872 if (ResolvedEvent != NULL) {
1873 gBS->CloseEvent (ResolvedEvent);
1874 }
1875 return Status;
1876 }
1877
1878
1879 /**
1880 Updates the parameters that affect the operation of the PXE Base Code Protocol.
1881
1882 This function sets parameters that affect the operation of the PXE Base Code Protocol.
1883 The parameter specified by NewAutoArp is used to control the generation of ARP
1884 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
1885 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
1886 Protocol packets will be generated. In this case, the only mappings that are
1887 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
1888 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
1889 service, then the service will fail. This function updates the AutoArp field of
1890 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
1891 The SetParameters() call must be invoked after a Callback Protocol is installed
1892 to enable the use of callbacks.
1893
1894 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1895 @param[in] NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
1896 current value of AutoARP.
1897 @param[in] NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
1898 current value of SendGUID.
1899 @param[in] NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
1900 the "time to live" field of the IP header.
1901 @param[in] NewToS If not NULL, a pointer to be used in place of the current value of ToS,
1902 the "type of service" field of the IP header.
1903 @param[in] NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
1904 current value of the MakeCallback field of the Mode structure.
1905
1906 @retval EFI_SUCCESS The new parameters values were updated.
1907 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1908 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1909
1910 **/
1911 EFI_STATUS
1912 EFIAPI
1913 EfiPxeBcSetParameters (
1914 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1915 IN BOOLEAN *NewAutoArp OPTIONAL,
1916 IN BOOLEAN *NewSendGUID OPTIONAL,
1917 IN UINT8 *NewTTL OPTIONAL,
1918 IN UINT8 *NewToS OPTIONAL,
1919 IN BOOLEAN *NewMakeCallback OPTIONAL
1920 )
1921 {
1922 PXEBC_PRIVATE_DATA *Private;
1923 EFI_PXE_BASE_CODE_MODE *Mode;
1924 EFI_GUID SystemGuid;
1925 EFI_STATUS Status;
1926
1927 if (This == NULL) {
1928 return EFI_INVALID_PARAMETER;
1929 }
1930
1931 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1932 Mode = Private->PxeBc.Mode;
1933
1934 if (!Mode->Started) {
1935 return EFI_NOT_STARTED;
1936 }
1937
1938 if (NewMakeCallback != NULL) {
1939 if (*NewMakeCallback) {
1940 //
1941 // Update the previous PxeBcCallback protocol.
1942 //
1943 Status = gBS->HandleProtocol (
1944 Mode->UsingIpv6 ? Private->Ip6Nic->Controller : Private->Ip4Nic->Controller,
1945 &gEfiPxeBaseCodeCallbackProtocolGuid,
1946 (VOID **) &Private->PxeBcCallback
1947 );
1948
1949 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {
1950 return EFI_INVALID_PARAMETER;
1951 }
1952 } else {
1953 Private->PxeBcCallback = NULL;
1954 }
1955 Mode->MakeCallbacks = *NewMakeCallback;
1956 }
1957
1958 if (NewSendGUID != NULL) {
1959 if (*NewSendGUID && EFI_ERROR (NetLibGetSystemGuid (&SystemGuid))) {
1960 DEBUG ((EFI_D_WARN, "PXE: Failed to read system GUID from the smbios table!\n"));
1961 return EFI_INVALID_PARAMETER;
1962 }
1963 Mode->SendGUID = *NewSendGUID;
1964 }
1965
1966 if (NewAutoArp != NULL) {
1967 Mode->AutoArp = *NewAutoArp;
1968 }
1969
1970 if (NewTTL != NULL) {
1971 Mode->TTL = *NewTTL;
1972 }
1973
1974 if (NewToS != NULL) {
1975 Mode->ToS = *NewToS;
1976 }
1977
1978 return EFI_SUCCESS;
1979 }
1980
1981
1982 /**
1983 Updates the station IP address and/or subnet mask values of a network device.
1984
1985 This function updates the station IP address and/or subnet mask values of a network
1986 device. The NewStationIp field is used to modify the network device's current IP address.
1987 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
1988 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
1989 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet
1990 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
1991 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
1992 structure with NewSubnetMask.
1993
1994 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1995 @param[in] NewStationIp Pointer to the new IP address to be used by the network device.
1996 @param[in] NewSubnetMask Pointer to the new subnet mask to be used by the network device.
1997
1998 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
1999 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2000 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
2001
2002 **/
2003 EFI_STATUS
2004 EFIAPI
2005 EfiPxeBcSetStationIP (
2006 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
2007 IN EFI_IP_ADDRESS *NewStationIp OPTIONAL,
2008 IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL
2009 )
2010 {
2011 EFI_STATUS Status;
2012 PXEBC_PRIVATE_DATA *Private;
2013 EFI_PXE_BASE_CODE_MODE *Mode;
2014
2015 if (This == NULL) {
2016 return EFI_INVALID_PARAMETER;
2017 }
2018
2019 if (NewStationIp != NULL && !NetIp6IsValidUnicast (&NewStationIp->v6)) {
2020 return EFI_INVALID_PARAMETER;
2021 }
2022
2023 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
2024 Mode = Private->PxeBc.Mode;
2025 Status = EFI_SUCCESS;
2026
2027 if (!Mode->UsingIpv6 &&
2028 NewSubnetMask != NULL &&
2029 !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {
2030 return EFI_INVALID_PARAMETER;
2031 }
2032
2033 if (!Mode->UsingIpv6 && NewStationIp != NULL) {
2034 if (IP4_IS_UNSPECIFIED(NTOHL (NewStationIp->Addr[0])) ||
2035 IP4_IS_LOCAL_BROADCAST(NTOHL (NewStationIp->Addr[0])) ||
2036 (NewSubnetMask != NULL && NewSubnetMask->Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), NTOHL (NewSubnetMask->Addr[0])))) {
2037 return EFI_INVALID_PARAMETER;
2038 }
2039 }
2040
2041 if (!Mode->Started) {
2042 return EFI_NOT_STARTED;
2043 }
2044
2045 if (Mode->UsingIpv6 && NewStationIp != NULL) {
2046 //
2047 // Set the IPv6 address by Ip6Config protocol.
2048 //
2049 Status = PxeBcRegisterIp6Address (Private, &NewStationIp->v6);
2050 if (EFI_ERROR (Status)) {
2051 goto ON_EXIT;
2052 }
2053 }
2054
2055 if (NewStationIp != NULL) {
2056 CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
2057 CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
2058 }
2059
2060 if (!Mode->UsingIpv6 && NewSubnetMask != NULL) {
2061 CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));
2062 CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));
2063 }
2064
2065 Status = PxeBcFlushStationIp (Private, NewStationIp, NewSubnetMask);
2066 if (!EFI_ERROR (Status)) {
2067 Private->IsAddressOk = TRUE;
2068 }
2069
2070 ON_EXIT:
2071 return Status;
2072 }
2073
2074
2075 /**
2076 Updates the contents of the cached DHCP and Discover packets.
2077
2078 The pointers to the new packets are used to update the contents of the cached
2079 packets in the EFI_PXE_BASE_CODE_MODE structure.
2080
2081 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
2082 @param[in] NewDhcpDiscoverValid Pointer to a value that will replace the current
2083 DhcpDiscoverValid field.
2084 @param[in] NewDhcpAckReceived Pointer to a value that will replace the current
2085 DhcpAckReceived field.
2086 @param[in] NewProxyOfferReceived Pointer to a value that will replace the current
2087 ProxyOfferReceived field.
2088 @param[in] NewPxeDiscoverValid Pointer to a value that will replace the current
2089 ProxyOfferReceived field.
2090 @param[in] NewPxeReplyReceived Pointer to a value that will replace the current
2091 PxeReplyReceived field.
2092 @param[in] NewPxeBisReplyReceived Pointer to a value that will replace the current
2093 PxeBisReplyReceived field.
2094 @param[in] NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
2095 @param[in] NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
2096 @param[in] NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
2097 @param[in] NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
2098 @param[in] NewPxeReply Pointer to the new cached PXE Reply packet contents.
2099 @param[in] NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
2100
2101 @retval EFI_SUCCESS The cached packet contents were updated.
2102 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2103 @retval EFI_INVALID_PARAMETER This is NULL or does not point to a valid
2104 EFI_PXE_BASE_CODE_PROTOCOL structure.
2105
2106 **/
2107 EFI_STATUS
2108 EFIAPI
2109 EfiPxeBcSetPackets (
2110 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
2111 IN BOOLEAN *NewDhcpDiscoverValid OPTIONAL,
2112 IN BOOLEAN *NewDhcpAckReceived OPTIONAL,
2113 IN BOOLEAN *NewProxyOfferReceived OPTIONAL,
2114 IN BOOLEAN *NewPxeDiscoverValid OPTIONAL,
2115 IN BOOLEAN *NewPxeReplyReceived OPTIONAL,
2116 IN BOOLEAN *NewPxeBisReplyReceived OPTIONAL,
2117 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover OPTIONAL,
2118 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpAck OPTIONAL,
2119 IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer OPTIONAL,
2120 IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover OPTIONAL,
2121 IN EFI_PXE_BASE_CODE_PACKET *NewPxeReply OPTIONAL,
2122 IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL
2123 )
2124 {
2125 PXEBC_PRIVATE_DATA *Private;
2126 EFI_PXE_BASE_CODE_MODE *Mode;
2127
2128 if (This == NULL) {
2129 return EFI_INVALID_PARAMETER;
2130 }
2131
2132 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
2133 Mode = Private->PxeBc.Mode;
2134
2135 if (!Mode->Started) {
2136 return EFI_NOT_STARTED;
2137 }
2138
2139 if (NewDhcpDiscoverValid != NULL) {
2140 Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;
2141 }
2142
2143 if (NewDhcpAckReceived != NULL) {
2144 Mode->DhcpAckReceived = *NewDhcpAckReceived;
2145 }
2146
2147 if (NewProxyOfferReceived != NULL) {
2148 Mode->ProxyOfferReceived = *NewProxyOfferReceived;
2149 }
2150
2151 if (NewPxeDiscoverValid != NULL) {
2152 Mode->PxeDiscoverValid = *NewPxeDiscoverValid;
2153 }
2154
2155 if (NewPxeReplyReceived != NULL) {
2156 Mode->PxeReplyReceived = *NewPxeReplyReceived;
2157 }
2158
2159 if (NewPxeBisReplyReceived != NULL) {
2160 Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;
2161 }
2162
2163 if (NewDhcpDiscover != NULL) {
2164 CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
2165 }
2166
2167 if (NewDhcpAck != NULL) {
2168 CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));
2169 }
2170
2171 if (NewProxyOffer != NULL) {
2172 CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));
2173 }
2174
2175 if (NewPxeDiscover != NULL) {
2176 CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
2177 }
2178
2179 if (NewPxeReply != NULL) {
2180 CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
2181 }
2182
2183 if (NewPxeBisReply != NULL) {
2184 CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
2185 }
2186
2187 return EFI_SUCCESS;
2188 }
2189
2190 EFI_PXE_BASE_CODE_PROTOCOL gPxeBcProtocolTemplate = {
2191 EFI_PXE_BASE_CODE_PROTOCOL_REVISION,
2192 EfiPxeBcStart,
2193 EfiPxeBcStop,
2194 EfiPxeBcDhcp,
2195 EfiPxeBcDiscover,
2196 EfiPxeBcMtftp,
2197 EfiPxeBcUdpWrite,
2198 EfiPxeBcUdpRead,
2199 EfiPxeBcSetIpFilter,
2200 EfiPxeBcArp,
2201 EfiPxeBcSetParameters,
2202 EfiPxeBcSetStationIP,
2203 EfiPxeBcSetPackets,
2204 NULL
2205 };
2206
2207
2208 /**
2209 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
2210 received, or is waiting to receive a packet.
2211
2212 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,
2213 or is waiting to receive a packet. Parameters Function and Received specify the type of event.
2214 Parameters PacketLen and Packet specify the packet that generated the event. If these fields
2215 are zero and NULL respectively, then this is a status update callback. If the operation specified
2216 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation
2217 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to
2218 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.
2219 The SetParameters() function must be called after a Callback Protocol is installed to enable the
2220 use of callbacks.
2221
2222 @param[in] This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
2223 @param[in] Function The PXE Base Code Protocol function that is waiting for an event.
2224 @param[in] Received TRUE if the callback is being invoked due to a receive event. FALSE if
2225 the callback is being invoked due to a transmit event.
2226 @param[in] PacketLength The length, in bytes, of Packet. This field will have a value of zero if
2227 this is a wait for receive event.
2228 @param[in] PacketPtr If Received is TRUE, a pointer to the packet that was just received;
2229 otherwise a pointer to the packet that is about to be transmitted.
2230
2231 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE If Function specifies a continue operation.
2232 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT If Function specifies an abort operation.
2233
2234 **/
2235 EFI_PXE_BASE_CODE_CALLBACK_STATUS
2236 EFIAPI
2237 EfiPxeLoadFileCallback (
2238 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This,
2239 IN EFI_PXE_BASE_CODE_FUNCTION Function,
2240 IN BOOLEAN Received,
2241 IN UINT32 PacketLength,
2242 IN EFI_PXE_BASE_CODE_PACKET *PacketPtr OPTIONAL
2243 )
2244 {
2245 EFI_INPUT_KEY Key;
2246 EFI_STATUS Status;
2247
2248 //
2249 // Catch Ctrl-C or ESC to abort.
2250 //
2251 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
2252
2253 if (!EFI_ERROR (Status)) {
2254
2255 if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {
2256
2257 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;
2258 }
2259 }
2260 //
2261 // No print if receive packet
2262 //
2263 if (Received) {
2264 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2265 }
2266 //
2267 // Print only for three functions
2268 //
2269 switch (Function) {
2270
2271 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:
2272 //
2273 // Print only for open MTFTP packets, not every MTFTP packets
2274 //
2275 if (PacketLength != 0 && PacketPtr != NULL) {
2276 if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {
2277 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2278 }
2279 }
2280 break;
2281
2282 case EFI_PXE_BASE_CODE_FUNCTION_DHCP:
2283 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:
2284 break;
2285
2286 default:
2287 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2288 }
2289
2290 if (PacketLength != 0 && PacketPtr != NULL) {
2291 //
2292 // Print '.' when transmit a packet
2293 //
2294 AsciiPrint (".");
2295 }
2296
2297 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2298 }
2299
2300 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL gPxeBcCallBackTemplate = {
2301 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,
2302 EfiPxeLoadFileCallback
2303 };
2304
2305
2306 /**
2307 Causes the driver to load a specified file.
2308
2309 @param[in] This Protocol instance pointer.
2310 @param[in] FilePath The device specific path of the file to load.
2311 @param[in] BootPolicy If TRUE, indicates that the request originates from the
2312 boot manager is attempting to load FilePath as a boot
2313 selection. If FALSE, then FilePath must match an exact file
2314 to be loaded.
2315 @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return
2316 code of EFI_SUCCESS, the amount of data transferred to
2317 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
2318 the size of Buffer required to retrieve the requested file.
2319 @param[in] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
2320 then no the size of the requested file is returned in
2321 BufferSize.
2322
2323 @retval EFI_SUCCESS The file was loaded.
2324 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy.
2325 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
2326 BufferSize is NULL.
2327 @retval EFI_NO_MEDIA No medium was present to load the file.
2328 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
2329 @retval EFI_NO_RESPONSE The remote system did not respond.
2330 @retval EFI_NOT_FOUND The file was not found.
2331 @retval EFI_ABORTED The file load process was manually cancelled.
2332
2333 **/
2334 EFI_STATUS
2335 EFIAPI
2336 EfiPxeLoadFile (
2337 IN EFI_LOAD_FILE_PROTOCOL *This,
2338 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
2339 IN BOOLEAN BootPolicy,
2340 IN OUT UINTN *BufferSize,
2341 IN VOID *Buffer OPTIONAL
2342 )
2343 {
2344 PXEBC_PRIVATE_DATA *Private;
2345 PXEBC_VIRTUAL_NIC *VirtualNic;
2346 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;
2347 BOOLEAN UsingIpv6;
2348 EFI_STATUS Status;
2349 EFI_STATUS MediaStatus;
2350
2351 if (This == NULL || BufferSize == NULL || FilePath == NULL || !IsDevicePathEnd (FilePath)) {
2352 return EFI_INVALID_PARAMETER;
2353 }
2354
2355 //
2356 // Only support BootPolicy
2357 //
2358 if (!BootPolicy) {
2359 return EFI_UNSUPPORTED;
2360 }
2361
2362 VirtualNic = PXEBC_VIRTUAL_NIC_FROM_LOADFILE (This);
2363 Private = VirtualNic->Private;
2364 PxeBc = &Private->PxeBc;
2365 UsingIpv6 = FALSE;
2366 Status = EFI_DEVICE_ERROR;
2367
2368 //
2369 // Check media status before PXE start
2370 //
2371 MediaStatus = EFI_SUCCESS;
2372 NetLibDetectMediaWaitTimeout (Private->Controller, PXEBC_CHECK_MEDIA_WAITING_TIME, &MediaStatus);
2373 if (MediaStatus != EFI_SUCCESS) {
2374 return EFI_NO_MEDIA;
2375 }
2376
2377 //
2378 // Check whether the virtual nic is using IPv6 or not.
2379 //
2380 if (VirtualNic == Private->Ip6Nic) {
2381 UsingIpv6 = TRUE;
2382 }
2383
2384 //
2385 // Start Pxe Base Code to initialize PXE boot.
2386 //
2387 Status = PxeBc->Start (PxeBc, UsingIpv6);
2388 if (Status == EFI_ALREADY_STARTED && UsingIpv6 != PxeBc->Mode->UsingIpv6) {
2389 //
2390 // PxeBc protocol has already been started but not on the required IP version, restart it.
2391 //
2392 Status = PxeBc->Stop (PxeBc);
2393 if (!EFI_ERROR (Status)) {
2394 Status = PxeBc->Start (PxeBc, UsingIpv6);
2395 }
2396 }
2397 if (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED) {
2398 Status = PxeBcLoadBootFile (Private, BufferSize, Buffer);
2399 }
2400
2401 if (Status != EFI_SUCCESS &&
2402 Status != EFI_UNSUPPORTED &&
2403 Status != EFI_BUFFER_TOO_SMALL) {
2404 //
2405 // There are three cases, which needn't stop pxebc here.
2406 // 1. success to download file.
2407 // 2. success to get file size.
2408 // 3. unsupported.
2409 //
2410 PxeBc->Stop (PxeBc);
2411 } else {
2412 //
2413 // The DHCP4 can have only one configured child instance so we need to stop
2414 // reset the DHCP4 child before we return. Otherwise these programs which
2415 // also need to use DHCP4 will be impacted.
2416 //
2417 if (!PxeBc->Mode->UsingIpv6) {
2418 Private->Dhcp4->Stop (Private->Dhcp4);
2419 Private->Dhcp4->Configure (Private->Dhcp4, NULL);
2420 }
2421 }
2422
2423 return Status;
2424 }
2425
2426 EFI_LOAD_FILE_PROTOCOL gLoadFileProtocolTemplate = { EfiPxeLoadFile };
2427
EFI Development Kit II mirror for PVE